software.amazon.awssdk.services.imagebuilder.model

Class ComponentParameterDetail

java.lang.Object

software.amazon.awssdk.services.imagebuilder.model.ComponentParameterDetail

All Implemented Interfaces:

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

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

Defines a parameter that is used to provide configuration details for the component.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ComponentParameterDetail.Builder

Method Summary

Modifier and Type	Method and Description
static ComponentParameterDetail.Builder	builder()
List<String>	defaultValue() The default value of this parameter if no input is provided.
String	description() Describes this parameter.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDefaultValue() For responses, this returns true if the service returned a value for the DefaultValue property.
int	hashCode()
String	name() The name of this input parameter.
List<SdkField<?>>	sdkFields()
static Class<? extends ComponentParameterDetail.Builder>	serializableBuilderClass()
ComponentParameterDetail.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	type() The type of input this parameter provides.

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 this input parameter.

Returns:

The name of this input parameter.

type

public final String type()

The type of input this parameter provides. The currently supported value is "string".

Returns:

The type of input this parameter provides. The currently supported value is "string".

hasDefaultValue

public final boolean hasDefaultValue()

For responses, this returns true if the service returned a value for the DefaultValue property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

defaultValue

public final List<String> defaultValue()

The default value of this parameter if no input is provided.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDefaultValue() method.

Returns:

The default value of this parameter if no input is provided.

description

public final String description()

Describes this parameter.

Returns:

Describes this parameter.

toBuilder

public ComponentParameterDetail.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ComponentParameterDetail.Builder,ComponentParameterDetail>

builder

public static ComponentParameterDetail.Builder builder()

serializableBuilderClass

public static Class<? extends ComponentParameterDetail.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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