Class DocumentParameter
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DocumentParameter.Builder,
DocumentParameter>
Parameters specified in a Systems Manager document that run on the server when the command is run.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic DocumentParameter.Builder
builder()
final String
If specified, the default values for the parameters.final String
A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
name()
The name of the parameter.static Class
<? extends DocumentParameter.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final DocumentParameterType
type()
The type of parameter.final String
The type of parameter.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the parameter.
- Returns:
- The name of the parameter.
-
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:
-
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:
-
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<DocumentParameter.Builder,
DocumentParameter> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-