Package software.amazon.awssdk.services.connect.model

Class CreateTaskTemplateRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.connect.model.ConnectRequest

software.amazon.awssdk.services.connect.model.CreateTaskTemplateRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateTaskTemplateRequest.Builder,CreateTaskTemplateRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateTaskTemplateRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateTaskTemplateRequest.Builder	builder()
String	clientToken()	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
TaskTemplateConstraints	constraints()	Constraints that are applicable to the fields listed.
String	contactFlowId()	The identifier of the flow that runs by default when a task is created by referencing this template.
TaskTemplateDefaults	defaults()	The default values for fields when a task is created by referencing this template.
String	description()	The description of the task template.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<TaskTemplateField>	fields()	Fields that are part of the template.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFields()	For responses, this returns true if the service returned a value for the Fields property.
int	hashCode()
String	instanceId()	The identifier of the Amazon Connect instance.
String	name()	The name of the task template.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
String	selfAssignFlowId()	The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task.
static Class<? extends CreateTaskTemplateRequest.Builder>	serializableBuilderClass()
TaskTemplateStatus	status()	Marks a template as ACTIVE or INACTIVE for a task to refer to it.
String	statusAsString()	Marks a template as ACTIVE or INACTIVE for a task to refer to it.
CreateTaskTemplateRequest.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

instanceId

public final String instanceId()

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

name

public final String name()

The name of the task template.

Returns:

The name of the task template.

description

public final String description()

The description of the task template.

Returns:

The description of the task template.

contactFlowId

public final String contactFlowId()

The identifier of the flow that runs by default when a task is created by referencing this template.

Returns:

The identifier of the flow that runs by default when a task is created by referencing this template.

selfAssignFlowId

public final String selfAssignFlowId()

The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task.

Returns:

The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task.

constraints

public final TaskTemplateConstraints constraints()

Constraints that are applicable to the fields listed.

Returns:

Constraints that are applicable to the fields listed.

defaults

public final TaskTemplateDefaults defaults()

The default values for fields when a task is created by referencing this template.

Returns:

The default values for fields when a task is created by referencing this template.

status

public final TaskTemplateStatus status()

Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task that refers to this template cannot be created.

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

Returns:

Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task that refers to this template cannot be created.

See Also:

TaskTemplateStatus

statusAsString

public final String statusAsString()

Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task that refers to this template cannot be created.

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

Returns:

Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can only be created from ACTIVE templates. If a template is marked as INACTIVE, then a task that refers to this template cannot be created.

See Also:

TaskTemplateStatus

hasFields

public final boolean hasFields()

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

fields

public final List<TaskTemplateField> fields()

Fields that are part of the 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 hasFields() method.

Returns:

Fields that are part of the template.

clientToken

public final String clientToken()

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Returns:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

toBuilder

public CreateTaskTemplateRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateTaskTemplateRequest.Builder,CreateTaskTemplateRequest>

Specified by:

toBuilder in class ConnectRequest

builder

public static CreateTaskTemplateRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo