software.amazon.awssdk.services.connect.model

Class TaskTemplateField

java.lang.Object

software.amazon.awssdk.services.connect.model.TaskTemplateField

All Implemented Interfaces:

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

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

Describes a single task template field.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TaskTemplateField.Builder

Method Summary

Modifier and Type	Method and Description
static TaskTemplateField.Builder	builder()
String	description() The description of the field.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSingleSelectOptions() For responses, this returns true if the service returned a value for the SingleSelectOptions property.
TaskTemplateFieldIdentifier	id() The unique identifier for the field.
List<SdkField<?>>	sdkFields()
static Class<? extends TaskTemplateField.Builder>	serializableBuilderClass()
List<String>	singleSelectOptions() A list of options for a single select field.
TaskTemplateField.Builder	toBuilder()
String	toString() Returns a string representation of this object.
TaskTemplateFieldType	type() Indicates the type of field.
String	typeAsString() Indicates the type of field.

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

id

public final TaskTemplateFieldIdentifier id()

The unique identifier for the field.

Returns:

The unique identifier for the field.

description

public final String description()

The description of the field.

Returns:

The description of the field.

type

public final TaskTemplateFieldType type()

Indicates the type of field.

If the service returns an enum value that is not available in the current SDK version, type will return TaskTemplateFieldType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

Indicates the type of field.

See Also:

TaskTemplateFieldType

typeAsString

public final String typeAsString()

Indicates the type of field.

If the service returns an enum value that is not available in the current SDK version, type will return TaskTemplateFieldType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

Indicates the type of field.

See Also:

TaskTemplateFieldType

hasSingleSelectOptions

public final boolean hasSingleSelectOptions()

For responses, this returns true if the service returned a value for the SingleSelectOptions 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.

singleSelectOptions

public final List<String> singleSelectOptions()

A list of options for a single select field.

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 hasSingleSelectOptions() method.

Returns:

A list of options for a single select field.

toBuilder

public TaskTemplateField.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TaskTemplateField.Builder,TaskTemplateField>

builder

public static TaskTemplateField.Builder builder()

serializableBuilderClass

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