Interface UpdateTaskTemplateRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, ConnectRequest.Builder, CopyableBuilder<UpdateTaskTemplateRequest.Builder,UpdateTaskTemplateRequest>, SdkBuilder<UpdateTaskTemplateRequest.Builder,UpdateTaskTemplateRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateTaskTemplateRequest
@Mutable @NotThreadSafe public static interface UpdateTaskTemplateRequest.Builder extends ConnectRequest.Builder, SdkPojo, CopyableBuilder<UpdateTaskTemplateRequest.Builder,UpdateTaskTemplateRequest>

  • Method Details

    • taskTemplateId

      UpdateTaskTemplateRequest.Builder taskTemplateId(String taskTemplateId)

      A unique identifier for the task template.

      Parameters:
      taskTemplateId - A unique identifier for the task template.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instanceId

      UpdateTaskTemplateRequest.Builder instanceId(String instanceId)

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

      Parameters:
      instanceId - The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      UpdateTaskTemplateRequest.Builder name(String name)

      The name of the task template.

      Parameters:
      name - The name of the task template.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      UpdateTaskTemplateRequest.Builder description(String description)

      The description of the task template.

      Parameters:
      description - The description of the task template.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • contactFlowId

      UpdateTaskTemplateRequest.Builder contactFlowId(String contactFlowId)

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

      Although this parameter is marked as optional, the request must contain either a ContactFlowId or a field of type QUICK_CONNECT.

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

      Although this parameter is marked as optional, the request must contain either a ContactFlowId or a field of type QUICK_CONNECT.

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

    • selfAssignFlowId

      UpdateTaskTemplateRequest.Builder selfAssignFlowId(String selfAssignFlowId)

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

      Parameters:
      selfAssignFlowId - The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • constraints

      UpdateTaskTemplateRequest.Builder constraints(TaskTemplateConstraints constraints)

      Constraints that are applicable to the fields listed. Although this parameter is marked as optional in the API model, the service requires it when calling CreateTaskTemplate or UpdateTaskTemplate. The RequiredFields array must contain at least one element, and the field of type NAME must be included in RequiredFields.

      Parameters:
      constraints - Constraints that are applicable to the fields listed. Although this parameter is marked as optional in the API model, the service requires it when calling CreateTaskTemplate or UpdateTaskTemplate. The RequiredFields array must contain at least one element, and the field of type NAME must be included in RequiredFields.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • constraints

      default UpdateTaskTemplateRequest.Builder constraints(Consumer<TaskTemplateConstraints.Builder> constraints)

      Constraints that are applicable to the fields listed. Although this parameter is marked as optional in the API model, the service requires it when calling CreateTaskTemplate or UpdateTaskTemplate. The RequiredFields array must contain at least one element, and the field of type NAME must be included in RequiredFields.

      This is a convenience method that creates an instance of the TaskTemplateConstraints.Builder avoiding the need to create one manually via TaskTemplateConstraints.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to constraints(TaskTemplateConstraints).

      Parameters:
      constraints - a consumer that will call methods on TaskTemplateConstraints.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • defaults

      UpdateTaskTemplateRequest.Builder defaults(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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • defaults

      default UpdateTaskTemplateRequest.Builder defaults(Consumer<TaskTemplateDefaults.Builder> defaults)

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

      This is a convenience method that creates an instance of the TaskTemplateDefaults.Builder avoiding the need to create one manually via TaskTemplateDefaults.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to defaults(TaskTemplateDefaults).

      Parameters:
      defaults - a consumer that will call methods on TaskTemplateDefaults.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      UpdateTaskTemplateRequest.Builder status(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.

      Although this parameter is marked as optional, the service requires it when calling UpdateTaskTemplate.

      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.

      Although this parameter is marked as optional, the service requires it when calling UpdateTaskTemplate.

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

    • status

      UpdateTaskTemplateRequest.Builder status(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.

      Although this parameter is marked as optional, the service requires it when calling UpdateTaskTemplate.

      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.

      Although this parameter is marked as optional, the service requires it when calling UpdateTaskTemplate.

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

    • fields

      UpdateTaskTemplateRequest.Builder fields(Collection<TaskTemplateField> fields)

      Fields that are part of the template.

      The request must contain exactly one field of type NAME. This field must also be listed in the RequiredFields array within the Constraints parameter.

      Parameters:
      fields - Fields that are part of the template.

      The request must contain exactly one field of type NAME. This field must also be listed in the RequiredFields array within the Constraints parameter.

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

    • fields

      UpdateTaskTemplateRequest.Builder fields(TaskTemplateField... fields)

      Fields that are part of the template.

      The request must contain exactly one field of type NAME. This field must also be listed in the RequiredFields array within the Constraints parameter.

      Parameters:
      fields - Fields that are part of the template.

      The request must contain exactly one field of type NAME. This field must also be listed in the RequiredFields array within the Constraints parameter.

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

    • fields

      UpdateTaskTemplateRequest.Builder fields(Consumer<TaskTemplateField.Builder>... fields)

      Fields that are part of the template.

      The request must contain exactly one field of type NAME. This field must also be listed in the RequiredFields array within the Constraints parameter.

      This is a convenience method that creates an instance of the TaskTemplateField.Builder avoiding the need to create one manually via TaskTemplateField.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to fields(List<TaskTemplateField>).

      Parameters:
      fields - a consumer that will call methods on TaskTemplateField.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      UpdateTaskTemplateRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateTaskTemplateRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.