software.amazon.awssdk.services.sagemaker.model

Class CreateInferenceRecommendationsJobRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.sagemaker.model.SageMakerRequest

software.amazon.awssdk.services.sagemaker.model.CreateInferenceRecommendationsJobRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateInferenceRecommendationsJobRequest.Builder,CreateInferenceRecommendationsJobRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateInferenceRecommendationsJobRequest
extends SageMakerRequest
implements ToCopyableBuilder<CreateInferenceRecommendationsJobRequest.Builder,CreateInferenceRecommendationsJobRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateInferenceRecommendationsJobRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateInferenceRecommendationsJobRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
RecommendationJobInputConfig	inputConfig() Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.
String	jobDescription() Description of the recommendation job.
String	jobName() A name for the recommendation job.
RecommendationJobType	jobType() Defines the type of recommendation job.
String	jobTypeAsString() Defines the type of recommendation job.
RecommendationJobOutputConfig	outputConfig() Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.
String	roleArn() The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateInferenceRecommendationsJobRequest.Builder>	serializableBuilderClass()
RecommendationJobStoppingConditions	stoppingConditions() A set of conditions for stopping a recommendation job.
List<Tag>	tags() The metadata that you apply to Amazon Web Services resources to help you categorize and organize them.
CreateInferenceRecommendationsJobRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

jobName

public final 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.

Returns:

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.

jobType

public final 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.

If the service returns an enum value that is not available in the current SDK version, jobType will return RecommendationJobType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobTypeAsString().

Returns:

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.

See Also:

RecommendationJobType

jobTypeAsString

public final String jobTypeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, jobType will return RecommendationJobType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobTypeAsString().

Returns:

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.

See Also:

RecommendationJobType

roleArn

public final String roleArn()

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

Returns:

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

inputConfig

public final RecommendationJobInputConfig inputConfig()

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

Returns:

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

jobDescription

public final String jobDescription()

Description of the recommendation job.

Returns:

Description of the recommendation job.

stoppingConditions

public final RecommendationJobStoppingConditions stoppingConditions()

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

Returns:

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

outputConfig

public final RecommendationJobOutputConfig outputConfig()

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

Returns:

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

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

tags

public final List<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.

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 hasTags() method.

Returns:

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.

toBuilder

public CreateInferenceRecommendationsJobRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateInferenceRecommendationsJobRequest.Builder,CreateInferenceRecommendationsJobRequest>

Specified by:

toBuilder in class SageMakerRequest

builder

public static CreateInferenceRecommendationsJobRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateInferenceRecommendationsJobRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo