Class DescribeInferenceRecommendationsJobResponse
- java.lang.Object
-
- software.amazon.awssdk.core.SdkResponse
-
- software.amazon.awssdk.awscore.AwsResponse
-
- software.amazon.awssdk.services.sagemaker.model.SageMakerResponse
-
- software.amazon.awssdk.services.sagemaker.model.DescribeInferenceRecommendationsJobResponse
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<DescribeInferenceRecommendationsJobResponse.Builder,DescribeInferenceRecommendationsJobResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeInferenceRecommendationsJobResponse extends SageMakerResponse implements ToCopyableBuilder<DescribeInferenceRecommendationsJobResponse.Builder,DescribeInferenceRecommendationsJobResponse>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceDescribeInferenceRecommendationsJobResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DescribeInferenceRecommendationsJobResponse.Builderbuilder()InstantcompletionTime()A timestamp that shows when the job completed.InstantcreationTime()A timestamp that shows when the job was created.List<EndpointPerformance>endpointPerformances()The performance results from running an Inference Recommender job on an existing endpoint.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringfailureReason()If the job fails, provides information why the job failed.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasEndpointPerformances()For responses, this returns true if the service returned a value for the EndpointPerformances property.inthashCode()booleanhasInferenceRecommendations()For responses, this returns true if the service returned a value for the InferenceRecommendations property.List<InferenceRecommendation>inferenceRecommendations()The recommendations made by Inference Recommender.RecommendationJobInputConfiginputConfig()Returns information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations you provided when you initiated the job.StringjobArn()The Amazon Resource Name (ARN) of the job.StringjobDescription()The job description that you provided when you initiated the job.StringjobName()The name of the job.RecommendationJobTypejobType()The job type that you provided when you initiated the job.StringjobTypeAsString()The job type that you provided when you initiated the job.InstantlastModifiedTime()A timestamp that shows when the job was last modified.StringroleArn()The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role you provided when you initiated the job.List<SdkField<?>>sdkFields()static Class<? extends DescribeInferenceRecommendationsJobResponse.Builder>serializableBuilderClass()RecommendationJobStatusstatus()The status of the job.StringstatusAsString()The status of the job.RecommendationJobStoppingConditionsstoppingConditions()The stopping conditions that you provided when you initiated the job.DescribeInferenceRecommendationsJobResponse.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.services.sagemaker.model.SageMakerResponse
responseMetadata
-
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
-
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()
The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
- Returns:
- The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
-
jobDescription
public final String jobDescription()
The job description that you provided when you initiated the job.
- Returns:
- The job description that you provided when you initiated the job.
-
jobType
public final RecommendationJobType jobType()
The job type that you provided when you initiated the job.
If the service returns an enum value that is not available in the current SDK version,
jobTypewill returnRecommendationJobType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromjobTypeAsString().- Returns:
- The job type that you provided when you initiated the job.
- See Also:
RecommendationJobType
-
jobTypeAsString
public final String jobTypeAsString()
The job type that you provided when you initiated the job.
If the service returns an enum value that is not available in the current SDK version,
jobTypewill returnRecommendationJobType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromjobTypeAsString().- Returns:
- The job type that you provided when you initiated the job.
- See Also:
RecommendationJobType
-
jobArn
public final String jobArn()
The Amazon Resource Name (ARN) of the job.
- Returns:
- The Amazon Resource Name (ARN) of the job.
-
roleArn
public final String roleArn()
The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role you provided when you initiated the job.
- Returns:
- The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role you provided when you initiated the job.
-
status
public final RecommendationJobStatus status()
The status of the job.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnRecommendationJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the job.
- See Also:
RecommendationJobStatus
-
statusAsString
public final String statusAsString()
The status of the job.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnRecommendationJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the job.
- See Also:
RecommendationJobStatus
-
creationTime
public final Instant creationTime()
A timestamp that shows when the job was created.
- Returns:
- A timestamp that shows when the job was created.
-
completionTime
public final Instant completionTime()
A timestamp that shows when the job completed.
- Returns:
- A timestamp that shows when the job completed.
-
lastModifiedTime
public final Instant lastModifiedTime()
A timestamp that shows when the job was last modified.
- Returns:
- A timestamp that shows when the job was last modified.
-
failureReason
public final String failureReason()
If the job fails, provides information why the job failed.
- Returns:
- If the job fails, provides information why the job failed.
-
inputConfig
public final RecommendationJobInputConfig inputConfig()
Returns information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations you provided when you initiated the job.
- Returns:
- Returns information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations you provided when you initiated the job.
-
stoppingConditions
public final RecommendationJobStoppingConditions stoppingConditions()
The stopping conditions that you provided when you initiated the job.
- Returns:
- The stopping conditions that you provided when you initiated the job.
-
hasInferenceRecommendations
public final boolean hasInferenceRecommendations()
For responses, this returns true if the service returned a value for the InferenceRecommendations 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.
-
inferenceRecommendations
public final List<InferenceRecommendation> inferenceRecommendations()
The recommendations made by Inference Recommender.
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
hasInferenceRecommendations()method.- Returns:
- The recommendations made by Inference Recommender.
-
hasEndpointPerformances
public final boolean hasEndpointPerformances()
For responses, this returns true if the service returned a value for the EndpointPerformances 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.
-
endpointPerformances
public final List<EndpointPerformance> endpointPerformances()
The performance results from running an Inference Recommender job on an existing endpoint.
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
hasEndpointPerformances()method.- Returns:
- The performance results from running an Inference Recommender job on an existing endpoint.
-
toBuilder
public DescribeInferenceRecommendationsJobResponse.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<DescribeInferenceRecommendationsJobResponse.Builder,DescribeInferenceRecommendationsJobResponse>- Specified by:
toBuilderin classAwsResponse
-
builder
public static DescribeInferenceRecommendationsJobResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribeInferenceRecommendationsJobResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsResponse
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkResponse
-
-