Class DescribeClusterSchedulerConfigResponse

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

  • Method Details

    • clusterSchedulerConfigArn

      public final String clusterSchedulerConfigArn()

      ARN of the cluster policy.

      Returns:
      ARN of the cluster policy.

    • clusterSchedulerConfigId

      public final String clusterSchedulerConfigId()

      ID of the cluster policy.

      Returns:
      ID of the cluster policy.

    • name

      public final String name()

      Name of the cluster policy.

      Returns:
      Name of the cluster policy.

    • clusterSchedulerConfigVersion

      public final Integer clusterSchedulerConfigVersion()

      Version of the cluster policy.

      Returns:
      Version of the cluster policy.

    • status

      public final SchedulerResourceStatus status()

      Status of the cluster policy.

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

      Returns:
      Status of the cluster policy.
      See Also:

    • statusAsString

      public final String statusAsString()

      Status of the cluster policy.

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

      Returns:
      Status of the cluster policy.
      See Also:

    • failureReason

      public final String failureReason()

      Failure reason of the cluster policy.

      Returns:
      Failure reason of the cluster policy.

    • statusDetails

      public final Map<SchedulerConfigComponent,SchedulerResourceStatus> statusDetails()

      Additional details about the status of the cluster policy. This field provides context when the policy is in a non-active state, such as during creation, updates, or if failures occur.

      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 hasStatusDetails() method.

      Returns:
      Additional details about the status of the cluster policy. This field provides context when the policy is in a non-active state, such as during creation, updates, or if failures occur.

    • hasStatusDetails

      public final boolean hasStatusDetails()
      For responses, this returns true if the service returned a value for the StatusDetails 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.

    • statusDetailsAsStrings

      public final Map<String,String> statusDetailsAsStrings()

      Additional details about the status of the cluster policy. This field provides context when the policy is in a non-active state, such as during creation, updates, or if failures occur.

      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 hasStatusDetails() method.

      Returns:
      Additional details about the status of the cluster policy. This field provides context when the policy is in a non-active state, such as during creation, updates, or if failures occur.

    • clusterArn

      public final String clusterArn()

      ARN of the cluster where the cluster policy is applied.

      Returns:
      ARN of the cluster where the cluster policy is applied.

    • schedulerConfig

      public final SchedulerConfig schedulerConfig()

      Cluster policy configuration. This policy is used for task prioritization and fair-share allocation. This helps prioritize critical workloads and distributes idle compute across entities.

      Returns:
      Cluster policy configuration. This policy is used for task prioritization and fair-share allocation. This helps prioritize critical workloads and distributes idle compute across entities.

    • description

      public final String description()

      Description of the cluster policy.

      Returns:
      Description of the cluster policy.

    • creationTime

      public final Instant creationTime()

      Creation time of the cluster policy.

      Returns:
      Creation time of the cluster policy.

    • createdBy

      public final UserContext createdBy()
      Returns the value of the CreatedBy property for this object.
      Returns:
      The value of the CreatedBy property for this object.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      Last modified time of the cluster policy.

      Returns:
      Last modified time of the cluster policy.

    • lastModifiedBy

      public final UserContext lastModifiedBy()
      Returns the value of the LastModifiedBy property for this object.
      Returns:
      The value of the LastModifiedBy property for this object.

    • toBuilder

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

    • builder

      public static DescribeClusterSchedulerConfigResponse.Builder builder()

    • serializableBuilderClass

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