com.amazonaws.services.connect.model

Class CreateTaskTemplateRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.connect.model.CreateTaskTemplateRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class CreateTaskTemplateRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable

Creates a new task template in the specified Amazon Connect instance.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateTaskTemplateRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getClientToken() A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
TaskTemplateConstraints	getConstraints() Constraints that are applicable to the fields listed.
java.lang.String	getContactFlowId() The identifier of the flow that runs by default when a task is created by referencing this template.
TaskTemplateDefaults	getDefaults() The default values for fields when a task is created by referencing this template.
java.lang.String	getDescription() The description of the task template.
java.util.List<TaskTemplateField>	getFields() Fields that are part of the template.
java.lang.String	getInstanceId() The identifier of the Amazon Connect instance.
java.lang.String	getName() The name of the task template.
java.lang.String	getStatus() Marks a template as ACTIVE or INACTIVE for a task to refer to it.
int	hashCode()
void	setClientToken(java.lang.String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
void	setConstraints(TaskTemplateConstraints constraints) Constraints that are applicable to the fields listed.
void	setContactFlowId(java.lang.String contactFlowId) The identifier of the flow that runs by default when a task is created by referencing this template.
void	setDefaults(TaskTemplateDefaults defaults) The default values for fields when a task is created by referencing this template.
void	setDescription(java.lang.String description) The description of the task template.
void	setFields(java.util.Collection<TaskTemplateField> fields) Fields that are part of the template.
void	setInstanceId(java.lang.String instanceId) The identifier of the Amazon Connect instance.
void	setName(java.lang.String name) The name of the task template.
void	setStatus(java.lang.String status) Marks a template as ACTIVE or INACTIVE for a task to refer to it.
void	setStatus(TaskTemplateStatus status) Marks a template as ACTIVE or INACTIVE for a task to refer to it.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateTaskTemplateRequest	withClientToken(java.lang.String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
CreateTaskTemplateRequest	withConstraints(TaskTemplateConstraints constraints) Constraints that are applicable to the fields listed.
CreateTaskTemplateRequest	withContactFlowId(java.lang.String contactFlowId) The identifier of the flow that runs by default when a task is created by referencing this template.
CreateTaskTemplateRequest	withDefaults(TaskTemplateDefaults defaults) The default values for fields when a task is created by referencing this template.
CreateTaskTemplateRequest	withDescription(java.lang.String description) The description of the task template.
CreateTaskTemplateRequest	withFields(java.util.Collection<TaskTemplateField> fields) Fields that are part of the template.
CreateTaskTemplateRequest	withFields(TaskTemplateField... fields) Fields that are part of the template.
CreateTaskTemplateRequest	withInstanceId(java.lang.String instanceId) The identifier of the Amazon Connect instance.
CreateTaskTemplateRequest	withName(java.lang.String name) The name of the task template.
CreateTaskTemplateRequest	withStatus(java.lang.String status) Marks a template as ACTIVE or INACTIVE for a task to refer to it.
CreateTaskTemplateRequest	withStatus(TaskTemplateStatus status) Marks a template as ACTIVE or INACTIVE for a task to refer to it.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateTaskTemplateRequest

public CreateTaskTemplateRequest()

Method Detail

getInstanceId

public java.lang.String getInstanceId()

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

Constraints:
Length: 1 - 100

Returns:

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

setInstanceId

public void setInstanceId(java.lang.String instanceId)

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

Constraints:
Length: 1 - 100

Parameters:

instanceId -

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

withInstanceId

public CreateTaskTemplateRequest withInstanceId(java.lang.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 a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 100

Parameters:

instanceId -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getName

public java.lang.String getName()

The name of the task template.

Constraints:
Length: 1 - 100

Returns:

The name of the task template.

setName

public void setName(java.lang.String name)

The name of the task template.

Constraints:
Length: 1 - 100

Parameters:

name -

The name of the task template.

withName

public CreateTaskTemplateRequest withName(java.lang.String name)

The name of the task template.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 100

Parameters:

name -

The name of the task template.

Returns:

A reference to this updated object so that method calls can be chained together.

getDescription

public java.lang.String getDescription()

The description of the task template.

Constraints:
Length: 1 - 255

Returns:

The description of the task template.

setDescription

public void setDescription(java.lang.String description)

The description of the task template.

Constraints:
Length: 1 - 255

Parameters:

description -

The description of the task template.

withDescription

public CreateTaskTemplateRequest withDescription(java.lang.String description)

The description of the task template.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 255

Parameters:

description -

The description of the task template.

Returns:

A reference to this updated object so that method calls can be chained together.

getContactFlowId

public java.lang.String getContactFlowId()

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

Constraints:
Length: - 500

Returns:

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

setContactFlowId

public void setContactFlowId(java.lang.String contactFlowId)

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

Constraints:
Length: - 500

Parameters:

contactFlowId -

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

withContactFlowId

public CreateTaskTemplateRequest withContactFlowId(java.lang.String contactFlowId)

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: - 500

Parameters:

contactFlowId -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getConstraints

public TaskTemplateConstraints getConstraints()

Constraints that are applicable to the fields listed.

Returns:

Constraints that are applicable to the fields listed.

setConstraints

public void setConstraints(TaskTemplateConstraints constraints)

Constraints that are applicable to the fields listed.

Parameters:

constraints -

Constraints that are applicable to the fields listed.

withConstraints

public CreateTaskTemplateRequest withConstraints(TaskTemplateConstraints constraints)

Constraints that are applicable to the fields listed.

Returns a reference to this object so that method calls can be chained together.

Parameters:

constraints -

Constraints that are applicable to the fields listed.

Returns:

A reference to this updated object so that method calls can be chained together.

getDefaults

public TaskTemplateDefaults getDefaults()

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.

setDefaults

public void setDefaults(TaskTemplateDefaults defaults)

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

Parameters:

defaults -

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

withDefaults

public CreateTaskTemplateRequest withDefaults(TaskTemplateDefaults defaults)

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

Returns a reference to this object so that method calls can be chained together.

Parameters:

defaults -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getStatus

public java.lang.String getStatus()

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.

Constraints:
Allowed Values: ACTIVE, INACTIVE

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

setStatus

public void setStatus(java.lang.String 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.

Constraints:
Allowed Values: ACTIVE, INACTIVE

Parameters:

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.

See Also:

TaskTemplateStatus

withStatus

public CreateTaskTemplateRequest withStatus(java.lang.String 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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: ACTIVE, INACTIVE

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

TaskTemplateStatus

setStatus

public void setStatus(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.

Constraints:
Allowed Values: ACTIVE, INACTIVE

Parameters:

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.

See Also:

TaskTemplateStatus

withStatus

public CreateTaskTemplateRequest withStatus(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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: ACTIVE, INACTIVE

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

TaskTemplateStatus

getFields

public java.util.List<TaskTemplateField> getFields()

Fields that are part of the template.

Returns:

Fields that are part of the template.

setFields

public void setFields(java.util.Collection<TaskTemplateField> fields)

Fields that are part of the template.

Parameters:

fields -

Fields that are part of the template.

withFields

public CreateTaskTemplateRequest withFields(TaskTemplateField... fields)

Fields that are part of the template.

Returns a reference to this object so that method calls can be chained together.

Parameters:

fields -

Fields that are part of the template.

Returns:

A reference to this updated object so that method calls can be chained together.

withFields

public CreateTaskTemplateRequest withFields(java.util.Collection<TaskTemplateField> fields)

Fields that are part of the template.

Returns a reference to this object so that method calls can be chained together.

Parameters:

fields -

Fields that are part of the template.

Returns:

A reference to this updated object so that method calls can be chained together.

getClientToken

public java.lang.String getClientToken()

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.

Constraints:
Length: - 500

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.

setClientToken

public void setClientToken(java.lang.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.

Constraints:
Length: - 500

Parameters:

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.

withClientToken

public CreateTaskTemplateRequest withClientToken(java.lang.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 reference to this object so that method calls can be chained together.

Constraints:
Length: - 500

Parameters:

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 reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object