Package software.amazon.awssdk.services.connectcases.model

Class CreateTemplateRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.connectcases.model.ConnectCasesRequest

software.amazon.awssdk.services.connectcases.model.CreateTemplateRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateTemplateRequest.Builder,CreateTemplateRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateTemplateRequest
extends ConnectCasesRequest
implements ToCopyableBuilder<CreateTemplateRequest.Builder,CreateTemplateRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateTemplateRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateTemplateRequest.Builder	builder()
String	description()	A brief description of the template.
String	domainId()	The unique identifier of the Cases domain.
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.
LayoutConfiguration	layoutConfiguration()	Configuration of layouts associated to the template.
String	name()	A name for 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 CreateTemplateRequest.Builder>	serializableBuilderClass()
TemplateStatus	status()	The status of the template.
String	statusAsString()	The status of the template.
CreateTemplateRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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.

domainId

public final String domainId()

The unique identifier of the Cases domain.

Returns:

The unique identifier of the Cases domain.

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

A name for the template. It must be unique per domain.

Returns:

A name for the template. It must be unique per domain.

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

toBuilder

public CreateTemplateRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateTemplateRequest.Builder,CreateTemplateRequest>

Specified by:

toBuilder in class ConnectCasesRequest

builder

public static CreateTemplateRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo