Class DescribeGlobalInferenceGatewayResponse

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the global inference gateway.

      Returns:
      The Amazon Resource Name (ARN) of the global inference gateway.
    • id

      public final String id()

      The ID of the global inference gateway.

      Returns:
      The ID of the global inference gateway.
    • name

      public final String name()

      The name of the global inference gateway.

      Returns:
      The name of the global inference gateway.
    • executionRoleArn

      public final String executionRoleArn()

      The Amazon Resource Name (ARN) of the IAM role that the global inference gateway assumes to access your SageMaker HyperPod clusters. You can't change the role after you create the global inference gateway.

      Returns:
      The Amazon Resource Name (ARN) of the IAM role that the global inference gateway assumes to access your SageMaker HyperPod clusters. You can't change the role after you create the global inference gateway.
    • status

      public final GlobalInferenceGatewayStatus status()

      The status of the global inference gateway.

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

      Returns:
      The status of the global inference gateway.
      See Also:
    • statusAsString

      public final String statusAsString()

      The status of the global inference gateway.

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

      Returns:
      The status of the global inference gateway.
      See Also:
    • endpointUrl

      public final String endpointUrl()

      The URL that you use to invoke the global inference gateway. This value is set after the global inference gateway becomes ACTIVE.

      Returns:
      The URL that you use to invoke the global inference gateway. This value is set after the global inference gateway becomes ACTIVE.
    • vpcEndpointServiceName

      public final String vpcEndpointServiceName()

      The name of the VPC endpoint service to create an interface VPC endpoint (AWS PrivateLink) from, so that you can call EndpointUrl without going over the internet. This value is set after the global inference gateway becomes ACTIVE.

      Returns:
      The name of the VPC endpoint service to create an interface VPC endpoint (AWS PrivateLink) from, so that you can call EndpointUrl without going over the internet. This value is set after the global inference gateway becomes ACTIVE.
    • routing

      public final GlobalInferenceGatewayRouting routing()

      The routing configuration of the global inference gateway.

      Returns:
      The routing configuration of the global inference gateway.
    • creationTime

      public final Instant creationTime()

      The time when the global inference gateway was created.

      Returns:
      The time when the global inference gateway was created.
    • failureReason

      public final String failureReason()

      The reason that the global inference gateway failed. SageMaker returns this value only when the status is FAILED.

      Returns:
      The reason that the global inference gateway failed. SageMaker returns this value only when the status is FAILED.
    • 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<DescribeGlobalInferenceGatewayResponse.Builder,DescribeGlobalInferenceGatewayResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T
    • builder

    • serializableBuilderClass

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