Class DescribeInferenceComponentResponse

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

  • Method Details

    • inferenceComponentName

      public final String inferenceComponentName()

      The name of the inference component.

      Returns:
      The name of the inference component.

    • inferenceComponentArn

      public final String inferenceComponentArn()

      The Amazon Resource Name (ARN) of the inference component.

      Returns:
      The Amazon Resource Name (ARN) of the inference component.

    • endpointName

      public final String endpointName()

      The name of the endpoint that hosts the inference component.

      Returns:
      The name of the endpoint that hosts the inference component.

    • endpointArn

      public final String endpointArn()

      The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.

      Returns:
      The Amazon Resource Name (ARN) of the endpoint that hosts the inference component.

    • variantName

      public final String variantName()

      The name of the production variant that hosts the inference component.

      Returns:
      The name of the production variant that hosts the inference component.

    • failureReason

      public final String failureReason()

      If the inference component status is Failed, the reason for the failure.

      Returns:
      If the inference component status is Failed, the reason for the failure.

    • specification

      public final InferenceComponentSpecificationSummary specification()

      Details about the resources that are deployed with this inference component.

      Returns:
      Details about the resources that are deployed with this inference component.

    • runtimeConfig

      public final InferenceComponentRuntimeConfigSummary runtimeConfig()

      Details about the runtime settings for the model that is deployed with the inference component.

      Returns:
      Details about the runtime settings for the model that is deployed with the inference component.

    • creationTime

      public final Instant creationTime()

      The time when the inference component was created.

      Returns:
      The time when the inference component was created.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The time when the inference component was last updated.

      Returns:
      The time when the inference component was last updated.

    • inferenceComponentStatus

      public final InferenceComponentStatus inferenceComponentStatus()

      The status of the inference component.

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

      Returns:
      The status of the inference component.
      See Also:

    • inferenceComponentStatusAsString

      public final String inferenceComponentStatusAsString()

      The status of the inference component.

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

      Returns:
      The status of the inference component.
      See Also:

    • toBuilder

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

    • builder

      public static DescribeInferenceComponentResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeInferenceComponentResponse.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.