Class GetTemplateResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetTemplateResponse.Builder,
GetTemplateResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic GetTemplateResponse.Builder
builder()
final Instant
Timestamp at which the resource was created.final Boolean
deleted()
Denotes whether or not the resource has been deleted.final String
A brief description of the template.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the RequiredFields property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final Instant
Timestamp at which the resource was created or last modified.final LayoutConfiguration
Configuration of layouts associated to the template.final String
name()
The name of the template.final List
<RequiredField> A list of fields that must contain a value for a case to be successfully created with this template.static Class
<? extends GetTemplateResponse.Builder> final TemplateStatus
status()
The status of the template.final String
The status of the template.tags()
A map of of key-value pairs that represent tags on a resource.final String
The Amazon Resource Name (ARN) of the template.final String
A unique identifier of a template.Take this object and create a builder that contains all of the current property values of this object.final 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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
createdTime
Timestamp at which the resource was created.
- Returns:
- Timestamp at which the resource was created.
-
deleted
Denotes whether or not the resource has been deleted.
- Returns:
- Denotes whether or not the resource has been deleted.
-
description
A brief description of the template.
- Returns:
- A brief description of the template.
-
lastModifiedTime
Timestamp at which the resource was created or last modified.
- Returns:
- Timestamp at which the resource was created or last modified.
-
layoutConfiguration
Configuration of layouts associated to the template.
- Returns:
- Configuration of layouts associated to the template.
-
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 theisEmpty()
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
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
The status of the template.
If the service returns an enum value that is not available in the current SDK version,
status
will returnTemplateStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the template.
- See Also:
-
statusAsString
The status of the template.
If the service returns an enum value that is not available in the current SDK version,
status
will returnTemplateStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the template.
- See Also:
-
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 theisEmpty()
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
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
The Amazon Resource Name (ARN) of the template.
- Returns:
- The Amazon Resource Name (ARN) of the template.
-
templateId
A unique identifier of a template.
- Returns:
- A unique identifier of a template.
-
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 interfaceToCopyableBuilder<GetTemplateResponse.Builder,
GetTemplateResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-