software.amazon.awssdk.services.ssm.model

Class DocumentParameter

java.lang.Object

software.amazon.awssdk.services.ssm.model.DocumentParameter

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DocumentParameter.Builder,DocumentParameter>

@Generated(value="software.amazon.awssdk:codegen")
public final class DocumentParameter
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DocumentParameter.Builder,DocumentParameter>

Parameters specified in a System 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 and Description
static interface	DocumentParameter.Builder

Method Summary

Modifier and Type	Method and 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) Indicates whether some other object is "equal to" this one by SDK fields.
<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() Take this object and create a builder that contains all of the current property values of this object.
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

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 return DocumentParameterType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

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 return DocumentParameterType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

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()

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 interface ToCopyableBuilder<DocumentParameter.Builder,DocumentParameter>

Returns:

a builder for type T

builder

public static DocumentParameter.Builder builder()

serializableBuilderClass

public static Class<? extends DocumentParameter.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

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 an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.