Class CreateTaskTemplateRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateTaskTemplateRequest.Builder,
CreateTaskTemplateRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.final TaskTemplateConstraints
Constraints that are applicable to the fields listed.final String
The identifier of the flow that runs by default when a task is created by referencing this template.final TaskTemplateDefaults
defaults()
The default values for fields when a task is created by referencing this template.final String
The description of the task template.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final List
<TaskTemplateField> fields()
Fields that are part of the template.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the Fields property.final int
hashCode()
final String
The identifier of the Amazon Connect instance.final String
name()
The name of the task template.static Class
<? extends CreateTaskTemplateRequest.Builder> final TaskTemplateStatus
status()
Marks a template asACTIVE
orINACTIVE
for a task to refer to it.final String
Marks a template asACTIVE
orINACTIVE
for a task to refer to it.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.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The name of the task template.
- Returns:
- The name of the task template.
-
description
The description of the task template.
- Returns:
- The description of the task template.
-
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.
-
constraints
Constraints that are applicable to the fields listed.
- Returns:
- Constraints that are applicable to the fields listed.
-
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
Marks a template as
ACTIVE
orINACTIVE
for a task to refer to it. Tasks can only be created fromACTIVE
templates. If a template is marked asINACTIVE
, 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 returnTaskTemplateStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- Marks a template as
ACTIVE
orINACTIVE
for a task to refer to it. Tasks can only be created fromACTIVE
templates. If a template is marked asINACTIVE
, then a task that refers to this template cannot be created. - See Also:
-
statusAsString
Marks a template as
ACTIVE
orINACTIVE
for a task to refer to it. Tasks can only be created fromACTIVE
templates. If a template is marked asINACTIVE
, 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 returnTaskTemplateStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- Marks a template as
ACTIVE
orINACTIVE
for a task to refer to it. Tasks can only be created fromACTIVE
templates. If a template is marked asINACTIVE
, then a task that refers to this template cannot be created. - See Also:
-
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 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. -
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
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
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<CreateTaskTemplateRequest.Builder,
CreateTaskTemplateRequest> - Specified by:
toBuilder
in classConnectRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
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:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-