Interface RenderUiTemplateRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<RenderUiTemplateRequest.Builder,RenderUiTemplateRequest>, SageMakerRequest.Builder, SdkBuilder<RenderUiTemplateRequest.Builder,RenderUiTemplateRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

RenderUiTemplateRequest

@Mutable
@NotThreadSafe
public static interface RenderUiTemplateRequest.Builder
extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<RenderUiTemplateRequest.Builder,RenderUiTemplateRequest>

Method Summary

Modifier and Type	Method	Description
RenderUiTemplateRequest.Builder	humanTaskUiArn(String humanTaskUiArn)	The HumanTaskUiArn of the worker UI that you want to render.
RenderUiTemplateRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
RenderUiTemplateRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
RenderUiTemplateRequest.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.
default RenderUiTemplateRequest.Builder	task(Consumer<RenderableTask.Builder> task)	A RenderableTask object containing a representative task to render.
RenderUiTemplateRequest.Builder	task(RenderableTask task)	A RenderableTask object containing a representative task to render.
default RenderUiTemplateRequest.Builder	uiTemplate(Consumer<UiTemplate.Builder> uiTemplate)	A Template object containing the worker UI template to render.
RenderUiTemplateRequest.Builder	uiTemplate(UiTemplate uiTemplate)	A Template object containing the worker UI template to render.

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

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.sagemaker.model.SageMakerRequest.Builder

build

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

uiTemplate

RenderUiTemplateRequest.Builder uiTemplate(UiTemplate uiTemplate)

A Template object containing the worker UI template to render.

Parameters:

uiTemplate - A Template object containing the worker UI template to render.

Returns:

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

uiTemplate

default RenderUiTemplateRequest.Builder uiTemplate(Consumer<UiTemplate.Builder> uiTemplate)

A Template object containing the worker UI template to render.

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

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

Parameters:

uiTemplate - a consumer that will call methods on UiTemplate.Builder

Returns:

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

See Also:

• uiTemplate(UiTemplate)

task

RenderUiTemplateRequest.Builder task(RenderableTask task)

A RenderableTask object containing a representative task to render.

Parameters:

task - A RenderableTask object containing a representative task to render.

Returns:

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

task

default RenderUiTemplateRequest.Builder task(Consumer<RenderableTask.Builder> task)

A RenderableTask object containing a representative task to render.

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

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

Parameters:

task - a consumer that will call methods on RenderableTask.Builder

Returns:

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

See Also:

• task(RenderableTask)

roleArn

RenderUiTemplateRequest.Builder roleArn(String roleArn)

The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.

Parameters:

roleArn - The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.

Returns:

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

humanTaskUiArn

RenderUiTemplateRequest.Builder humanTaskUiArn(String humanTaskUiArn)

The HumanTaskUiArn of the worker UI that you want to render. Do not provide a HumanTaskUiArn if you use the UiTemplate parameter.

See a list of available Human Ui Amazon Resource Names (ARNs) in UiConfig.

Parameters:

humanTaskUiArn - The HumanTaskUiArn of the worker UI that you want to render. Do not provide a HumanTaskUiArn if you use the UiTemplate parameter.

See a list of available Human Ui Amazon Resource Names (ARNs) in UiConfig.

Returns:

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

overrideConfiguration

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

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