Class CreateInferenceRecommendationsJobRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateInferenceRecommendationsJobRequest.Builder,
CreateInferenceRecommendationsJobRequest>
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.final String
Description of the recommendation job.final String
jobName()
A name for the recommendation job.final RecommendationJobType
jobType()
Defines the type of recommendation job.final String
Defines the type of recommendation job.Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.final String
roleArn()
The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.static Class
<? extends CreateInferenceRecommendationsJobRequest.Builder> A set of conditions for stopping a recommendation job.tags()
The metadata that you apply to Amazon Web Services resources to help you categorize and organize them.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
Defines the type of recommendation job. Specify
Default
to initiate an instance recommendation andAdvanced
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 returnRecommendationJobType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromjobTypeAsString()
.- Returns:
- Defines the type of recommendation job. Specify
Default
to initiate an instance recommendation andAdvanced
to initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation (DEFAULT
) job. - See Also:
-
jobTypeAsString
Defines the type of recommendation job. Specify
Default
to initiate an instance recommendation andAdvanced
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 returnRecommendationJobType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromjobTypeAsString()
.- Returns:
- Defines the type of recommendation job. Specify
Default
to initiate an instance recommendation andAdvanced
to initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation (DEFAULT
) job. - See Also:
-
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
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
Description of the recommendation job.
- Returns:
- Description of the recommendation job.
-
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
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 theisEmpty()
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateInferenceRecommendationsJobRequest.Builder,
CreateInferenceRecommendationsJobRequest> - Specified by:
toBuilder
in classSageMakerRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends CreateInferenceRecommendationsJobRequest.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-