Class DocumentParameter
- java.lang.Object
-
- software.amazon.awssdk.services.ssm.model.DocumentParameter
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DocumentParameter.Builder,DocumentParameter>
@Generated("software.amazon.awssdk:codegen") public final class DocumentParameter extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DocumentParameter.Builder,DocumentParameter>
Parameters specified in a Systems Manager document that run on the server when the command is run.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
DocumentParameter.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DocumentParameter.Builder
builder()
String
defaultValue()
If specified, the default values for the parameters.String
description()
A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
String
name()
The name of the parameter.List<SdkField<?>>
sdkFields()
static Class<? extends DocumentParameter.Builder>
serializableBuilderClass()
DocumentParameter.Builder
toBuilder()
String
toString()
Returns a string representation of this object.DocumentParameterType
type()
The type of parameter.String
typeAsString()
The type of parameter.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
name
public final String name()
The name of the parameter.
- Returns:
- The name of the parameter.
-
type
public final DocumentParameterType type()
The type of parameter. The type can be either String or StringList.
If the service returns an enum value that is not available in the current SDK version,
type
will returnDocumentParameterType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of parameter. The type can be either String or StringList.
- See Also:
DocumentParameterType
-
typeAsString
public final String typeAsString()
The type of parameter. The type can be either String or StringList.
If the service returns an enum value that is not available in the current SDK version,
type
will returnDocumentParameterType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of parameter. The type can be either String or StringList.
- See Also:
DocumentParameterType
-
description
public final String description()
A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.
- Returns:
- A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.
-
defaultValue
public final String defaultValue()
If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.
- Returns:
- If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.
-
toBuilder
public DocumentParameter.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<DocumentParameter.Builder,DocumentParameter>
-
builder
public static DocumentParameter.Builder builder()
-
serializableBuilderClass
public static Class<? extends DocumentParameter.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
-