software.amazon.awssdk.services.connectcases.model

Class GetFieldResponse

java.lang.Object

software.amazon.awssdk.services.connectcases.model.GetFieldResponse

All Implemented Interfaces:

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

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

Object to store detailed field information.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetFieldResponse.Builder

Method Summary

Modifier and Type	Method and Description
static GetFieldResponse.Builder	builder()
String	description() Description of the field.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fieldArn() The Amazon Resource Name (ARN) of the field.
String	fieldId() Unique identifier of the field.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	name() Name of the field.
FieldNamespace	namespace() Namespace of the field.
String	namespaceAsString() Namespace of the field.
List<SdkField<?>>	sdkFields()
static Class<? extends GetFieldResponse.Builder>	serializableBuilderClass()
Map<String,String>	tags() A map of of key-value pairs that represent tags on a resource.
GetFieldResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
FieldType	type() Type of the field.
String	typeAsString() Type of the 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

description

public final String description()

Description of the field.

Returns:

Description of the field.

fieldArn

public final String fieldArn()

The Amazon Resource Name (ARN) of the field.

Returns:

The Amazon Resource Name (ARN) of the field.

fieldId

public final String fieldId()

Unique identifier of the field.

Returns:

Unique identifier of the field.

name

public final String name()

Name of the field.

Returns:

Name of the field.

namespace

public final FieldNamespace namespace()

Namespace of the field.

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

Returns:

Namespace of the field.

See Also:

FieldNamespace

namespaceAsString

public final String namespaceAsString()

Namespace of the field.

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

Returns:

Namespace of the field.

See Also:

FieldNamespace

hasTags

public final boolean hasTags()

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

tags

public final Map<String,String> tags()

A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

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

Returns:

A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

type

public final FieldType type()

Type of the field.

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

Returns:

Type of the field.

See Also:

FieldType

typeAsString

public final String typeAsString()

Type of the field.

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

Returns:

Type of the field.

See Also:

FieldType

toBuilder

public GetFieldResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetFieldResponse.Builder,GetFieldResponse>

builder

public static GetFieldResponse.Builder builder()

serializableBuilderClass

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