Package software.amazon.awssdk.services.sagemaker.model

Class DescribeInferenceRecommendationsJobResponse

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

      • 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, jobType will return RecommendationJobType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobTypeAsString().

        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.

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

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

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

      • 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