Class DescribeAiBenchmarkJobResponse

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.DescribeAiBenchmarkJobResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeAiBenchmarkJobResponse.Builder,DescribeAiBenchmarkJobResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeAiBenchmarkJobResponse extends SageMakerResponse implements ToCopyableBuilder<DescribeAiBenchmarkJobResponse.Builder,DescribeAiBenchmarkJobResponse>

  • Method Details

    • aiBenchmarkJobName

      public final String aiBenchmarkJobName()

      The name of the AI benchmark job.

      Returns:
      The name of the AI benchmark job.

    • aiBenchmarkJobArn

      public final String aiBenchmarkJobArn()

      The Amazon Resource Name (ARN) of the AI benchmark job.

      Returns:
      The Amazon Resource Name (ARN) of the AI benchmark job.

    • aiBenchmarkJobStatus

      public final AIBenchmarkJobStatus aiBenchmarkJobStatus()

      The status of the AI benchmark job.

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

      Returns:
      The status of the AI benchmark job.
      See Also:

    • aiBenchmarkJobStatusAsString

      public final String aiBenchmarkJobStatusAsString()

      The status of the AI benchmark job.

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

      Returns:
      The status of the AI benchmark job.
      See Also:

    • failureReason

      public final String failureReason()

      If the benchmark job failed, the reason it failed.

      Returns:
      If the benchmark job failed, the reason it failed.

    • benchmarkTarget

      public final AIBenchmarkTarget benchmarkTarget()

      The target endpoint that was benchmarked.

      Returns:
      The target endpoint that was benchmarked.

    • outputConfig

      public final AIBenchmarkOutputResult outputConfig()

      The output configuration for the benchmark job, including the Amazon S3 output location and CloudWatch log information.

      Returns:
      The output configuration for the benchmark job, including the Amazon S3 output location and CloudWatch log information.

    • aiWorkloadConfigIdentifier

      public final String aiWorkloadConfigIdentifier()

      The name or Amazon Resource Name (ARN) of the AI workload configuration used for this benchmark job.

      Returns:
      The name or Amazon Resource Name (ARN) of the AI workload configuration used for this benchmark job.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of the IAM role used by the benchmark job.

      Returns:
      The Amazon Resource Name (ARN) of the IAM role used by the benchmark job.

    • networkConfig

      public final AIBenchmarkNetworkConfig networkConfig()

      The network configuration for the benchmark job.

      Returns:
      The network configuration for the benchmark job.

    • creationTime

      public final Instant creationTime()

      A timestamp that indicates when the benchmark job was created.

      Returns:
      A timestamp that indicates when the benchmark job was created.

    • startTime

      public final Instant startTime()

      A timestamp that indicates when the benchmark job started running.

      Returns:
      A timestamp that indicates when the benchmark job started running.

    • endTime

      public final Instant endTime()

      A timestamp that indicates when the benchmark job completed.

      Returns:
      A timestamp that indicates when the benchmark job completed.

    • 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 tags associated with the benchmark job.

      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 tags associated with the benchmark job.

    • toBuilder

      public DescribeAiBenchmarkJobResponse.Builder 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 interface ToCopyableBuilder<DescribeAiBenchmarkJobResponse.Builder,DescribeAiBenchmarkJobResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeAiBenchmarkJobResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.