Interface CreateInferenceRecommendationsJobRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateInferenceRecommendationsJobRequest

public static interface CreateInferenceRecommendationsJobRequest.Builder
extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<CreateInferenceRecommendationsJobRequest.Builder,CreateInferenceRecommendationsJobRequest>

Method Summary

Modifier and Type	Method	Description
default CreateInferenceRecommendationsJobRequest.Builder	inputConfig(Consumer<RecommendationJobInputConfig.Builder> inputConfig)	Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.
CreateInferenceRecommendationsJobRequest.Builder	inputConfig(RecommendationJobInputConfig inputConfig)	Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.
CreateInferenceRecommendationsJobRequest.Builder	jobDescription(String jobDescription)	Description of the recommendation job.
CreateInferenceRecommendationsJobRequest.Builder	jobName(String jobName)	A name for the recommendation job.
CreateInferenceRecommendationsJobRequest.Builder	jobType(String jobType)	Defines the type of recommendation job.
CreateInferenceRecommendationsJobRequest.Builder	jobType(RecommendationJobType jobType)	Defines the type of recommendation job.
default CreateInferenceRecommendationsJobRequest.Builder	outputConfig(Consumer<RecommendationJobOutputConfig.Builder> outputConfig)	Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.
CreateInferenceRecommendationsJobRequest.Builder	outputConfig(RecommendationJobOutputConfig outputConfig)	Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.
CreateInferenceRecommendationsJobRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateInferenceRecommendationsJobRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateInferenceRecommendationsJobRequest.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
default CreateInferenceRecommendationsJobRequest.Builder	stoppingConditions(Consumer<RecommendationJobStoppingConditions.Builder> stoppingConditions)	A set of conditions for stopping a recommendation job.
CreateInferenceRecommendationsJobRequest.Builder	stoppingConditions(RecommendationJobStoppingConditions stoppingConditions)	A set of conditions for stopping a recommendation job.
CreateInferenceRecommendationsJobRequest.Builder	tags(Collection<Tag> tags)	The metadata that you apply to Amazon Web Services resources to help you categorize and organize them.
CreateInferenceRecommendationsJobRequest.Builder	tags(Consumer<Tag.Builder>... tags)	The metadata that you apply to Amazon Web Services resources to help you categorize and organize them.
CreateInferenceRecommendationsJobRequest.Builder	tags(Tag... tags)	The metadata that you apply to Amazon Web Services resources to help you categorize and organize them.

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, sdkFields

Method Details

jobName

CreateInferenceRecommendationsJobRequest.Builder jobName(String jobName)

A name for the recommendation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account. The job name is passed down to the resources created by the recommendation job. The names of resources (such as the model, endpoint configuration, endpoint, and compilation) that are prefixed with the job name are truncated at 40 characters.

Parameters:

jobName - A name for the recommendation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account. The job name is passed down to the resources created by the recommendation job. The names of resources (such as the model, endpoint configuration, endpoint, and compilation) that are prefixed with the job name are truncated at 40 characters.

Returns:

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

jobType

CreateInferenceRecommendationsJobRequest.Builder jobType(String jobType)

Defines the type of recommendation job. Specify Default to initiate an instance recommendation and Advanced to initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation (DEFAULT) job.

Parameters:

jobType - Defines the type of recommendation job. Specify Default to initiate an instance recommendation and Advanced to initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation (DEFAULT) job.

Returns:

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

See Also:

• RecommendationJobType
• RecommendationJobType

jobType

CreateInferenceRecommendationsJobRequest.Builder jobType(RecommendationJobType jobType)

Defines the type of recommendation job. Specify Default to initiate an instance recommendation and Advanced to initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation (DEFAULT) job.

Parameters:

jobType - Defines the type of recommendation job. Specify Default to initiate an instance recommendation and Advanced to initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation (DEFAULT) job.

Returns:

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

See Also:

• RecommendationJobType
• RecommendationJobType

roleArn

CreateInferenceRecommendationsJobRequest.Builder roleArn(String roleArn)

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

Parameters:

roleArn - The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

Returns:

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

inputConfig

CreateInferenceRecommendationsJobRequest.Builder inputConfig(RecommendationJobInputConfig inputConfig)

Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.

Parameters:

inputConfig - Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.

Returns:

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

inputConfig

default CreateInferenceRecommendationsJobRequest.Builder inputConfig(Consumer<RecommendationJobInputConfig.Builder> inputConfig)

Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.

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

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

Parameters:

inputConfig - a consumer that will call methods on RecommendationJobInputConfig.Builder

Returns:

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

See Also:

• inputConfig(RecommendationJobInputConfig)

jobDescription

CreateInferenceRecommendationsJobRequest.Builder jobDescription(String jobDescription)

Description of the recommendation job.

Parameters:

jobDescription - Description of the recommendation job.

Returns:

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

stoppingConditions

CreateInferenceRecommendationsJobRequest.Builder stoppingConditions(RecommendationJobStoppingConditions stoppingConditions)

A set of conditions for stopping a recommendation job. If any of the conditions are met, the job is automatically stopped.

Parameters:

stoppingConditions - A set of conditions for stopping a recommendation job. If any of the conditions are met, the job is automatically stopped.

Returns:

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

stoppingConditions

default CreateInferenceRecommendationsJobRequest.Builder stoppingConditions(Consumer<RecommendationJobStoppingConditions.Builder> stoppingConditions)

A set of conditions for stopping a recommendation job. If any of the conditions are met, the job is automatically stopped.

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

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

Parameters:

stoppingConditions - a consumer that will call methods on RecommendationJobStoppingConditions.Builder

Returns:

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

See Also:

• stoppingConditions(RecommendationJobStoppingConditions)

outputConfig

CreateInferenceRecommendationsJobRequest.Builder outputConfig(RecommendationJobOutputConfig outputConfig)

Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.

Parameters:

outputConfig - Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.

Returns:

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

outputConfig

default CreateInferenceRecommendationsJobRequest.Builder outputConfig(Consumer<RecommendationJobOutputConfig.Builder> outputConfig)

Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.

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

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

Parameters:

outputConfig - a consumer that will call methods on RecommendationJobOutputConfig.Builder

Returns:

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

See Also:

• outputConfig(RecommendationJobOutputConfig)

tags

CreateInferenceRecommendationsJobRequest.Builder tags(Collection<Tag> tags)

The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

Parameters:

tags - The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

Returns:

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

tags

CreateInferenceRecommendationsJobRequest.Builder tags(Tag... tags)

The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

Parameters:

tags - The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

Returns:

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

tags

CreateInferenceRecommendationsJobRequest.Builder tags(Consumer<Tag.Builder>... tags)

The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

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

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

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

• tags(java.util.Collection<Tag>)

overrideConfiguration

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

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