Interface CreateTemplateRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, ConnectCasesRequest.Builder, CopyableBuilder<CreateTemplateRequest.Builder,CreateTemplateRequest>, SdkBuilder<CreateTemplateRequest.Builder,CreateTemplateRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateTemplateRequest

@Mutable
@NotThreadSafe
public static interface CreateTemplateRequest.Builder
extends ConnectCasesRequest.Builder, SdkPojo, CopyableBuilder<CreateTemplateRequest.Builder,CreateTemplateRequest>

Method Summary

Modifier and Type	Method	Description
CreateTemplateRequest.Builder	description(String description)	A brief description of the template.
CreateTemplateRequest.Builder	domainId(String domainId)	The unique identifier of the Cases domain.
default CreateTemplateRequest.Builder	layoutConfiguration(Consumer<LayoutConfiguration.Builder> layoutConfiguration)	Configuration of layouts associated to the template.
CreateTemplateRequest.Builder	layoutConfiguration(LayoutConfiguration layoutConfiguration)	Configuration of layouts associated to the template.
CreateTemplateRequest.Builder	name(String name)	A name for the template.
CreateTemplateRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateTemplateRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateTemplateRequest.Builder	requiredFields(Collection<RequiredField> requiredFields)	A list of fields that must contain a value for a case to be successfully created with this template.
CreateTemplateRequest.Builder	requiredFields(Consumer<RequiredField.Builder>... requiredFields)	A list of fields that must contain a value for a case to be successfully created with this template.
CreateTemplateRequest.Builder	requiredFields(RequiredField... requiredFields)	A list of fields that must contain a value for a case to be successfully created with this template.
CreateTemplateRequest.Builder	rules(Collection<TemplateRule> rules)	A list of case rules (also known as case field conditions) on a template.
CreateTemplateRequest.Builder	rules(Consumer<TemplateRule.Builder>... rules)	A list of case rules (also known as case field conditions) on a template.
CreateTemplateRequest.Builder	rules(TemplateRule... rules)	A list of case rules (also known as case field conditions) on a template.
CreateTemplateRequest.Builder	status(String status)	The status of the template.
CreateTemplateRequest.Builder	status(TemplateStatus status)	The status of the template.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.connectcases.model.ConnectCasesRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

description

CreateTemplateRequest.Builder description(String description)

A brief description of the template.

Parameters:

description - A brief description of the template.

Returns:

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

domainId

CreateTemplateRequest.Builder domainId(String domainId)

The unique identifier of the Cases domain.

Parameters:

domainId - The unique identifier of the Cases domain.

Returns:

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

layoutConfiguration

CreateTemplateRequest.Builder layoutConfiguration(LayoutConfiguration layoutConfiguration)

Configuration of layouts associated to the template.

Parameters:

layoutConfiguration - Configuration of layouts associated to the template.

Returns:

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

layoutConfiguration

default CreateTemplateRequest.Builder layoutConfiguration(Consumer<LayoutConfiguration.Builder> layoutConfiguration)

Configuration of layouts associated to the template.

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

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

Parameters:

layoutConfiguration - a consumer that will call methods on LayoutConfiguration.Builder

Returns:

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

See Also:

• layoutConfiguration(LayoutConfiguration)

name

CreateTemplateRequest.Builder name(String name)

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

Parameters:

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

Returns:

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

requiredFields

CreateTemplateRequest.Builder requiredFields(Collection<RequiredField> requiredFields)

A list of fields that must contain a value for a case to be successfully created with this template.

Parameters:

requiredFields - A list of fields that must contain a value for a case to be successfully created with this template.

Returns:

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

requiredFields

CreateTemplateRequest.Builder requiredFields(RequiredField... requiredFields)

A list of fields that must contain a value for a case to be successfully created with this template.

Parameters:

requiredFields - A list of fields that must contain a value for a case to be successfully created with this template.

Returns:

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

requiredFields

CreateTemplateRequest.Builder requiredFields(Consumer<RequiredField.Builder>... requiredFields)

A list of fields that must contain a value for a case to be successfully created with this template.

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

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

Parameters:

requiredFields - a consumer that will call methods on RequiredField.Builder

Returns:

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

See Also:

• requiredFields(java.util.Collection<RequiredField>)

rules

CreateTemplateRequest.Builder rules(Collection<TemplateRule> rules)

A list of case rules (also known as case field conditions) on a template.

Parameters:

rules - A list of case rules (also known as case field conditions) on a template.

Returns:

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

rules

CreateTemplateRequest.Builder rules(TemplateRule... rules)

A list of case rules (also known as case field conditions) on a template.

Parameters:

rules - A list of case rules (also known as case field conditions) on a template.

Returns:

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

rules

CreateTemplateRequest.Builder rules(Consumer<TemplateRule.Builder>... rules)

A list of case rules (also known as case field conditions) on a template.

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

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

Parameters:

rules - a consumer that will call methods on TemplateRule.Builder

Returns:

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

See Also:

• rules(java.util.Collection<TemplateRule>)

status

CreateTemplateRequest.Builder status(String status)

The status of the template.

Parameters:

status - The status of the template.

Returns:

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

See Also:

• TemplateStatus
• TemplateStatus

status

CreateTemplateRequest.Builder status(TemplateStatus status)

The status of the template.

Parameters:

status - The status of the template.

Returns:

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

See Also:

• TemplateStatus
• TemplateStatus

overrideConfiguration

CreateTemplateRequest.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

CreateTemplateRequest.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.