software.amazon.awssdk.services.connectcases.model

Class GetTemplateResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.connectcases.model.ConnectCasesResponse

software.amazon.awssdk.services.connectcases.model.GetTemplateResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetTemplateResponse.Builder,GetTemplateResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetTemplateResponse
extends ConnectCasesResponse
implements ToCopyableBuilder<GetTemplateResponse.Builder,GetTemplateResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetTemplateResponse.Builder

Method Summary

Modifier and Type	Method and Description
static GetTemplateResponse.Builder	builder()
String	description() A brief description of the template.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRequiredFields() For responses, this returns true if the service returned a value for the RequiredFields property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
LayoutConfiguration	layoutConfiguration() Configuration of layouts associated to the template.
String	name() The name of the template.
List<RequiredField>	requiredFields() A list of fields that must contain a value for a case to be successfully created with this template.
List<SdkField<?>>	sdkFields()
static Class<? extends GetTemplateResponse.Builder>	serializableBuilderClass()
TemplateStatus	status() The status of the template.
String	statusAsString() The status of the template.
Map<String,String>	tags() A map of of key-value pairs that represent tags on a resource.
String	templateArn() The Amazon Resource Name (ARN) of the template.
String	templateId() A unique identifier of a template.
GetTemplateResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.connectcases.model.ConnectCasesResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

A brief description of the template.

Returns:

A brief description of the template.

layoutConfiguration

public final LayoutConfiguration layoutConfiguration()

Configuration of layouts associated to the template.

Returns:

Configuration of layouts associated to the template.

name

public final String name()

The name of the template.

Returns:

The name of the template.

hasRequiredFields

public final boolean hasRequiredFields()

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

requiredFields

public final List<RequiredField> requiredFields()

A list of fields that must contain a value for a case to be successfully created with this template.

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

Returns:

A list of fields that must contain a value for a case to be successfully created with this template.

status

public final TemplateStatus status()

The status of the template.

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

Returns:

The status of the template.

See Also:

TemplateStatus

statusAsString

public final String statusAsString()

The status of the template.

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

Returns:

The status of the template.

See Also:

TemplateStatus

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.

templateArn

public final String templateArn()

The Amazon Resource Name (ARN) of the template.

Returns:

The Amazon Resource Name (ARN) of the template.

templateId

public final String templateId()

A unique identifier of a template.

Returns:

A unique identifier of a template.

toBuilder

public GetTemplateResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetTemplateResponse.Builder,GetTemplateResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetTemplateResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo