Class SearchTrainingPlanOfferingsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.sagemaker.model.SageMakerRequest
software.amazon.awssdk.services.sagemaker.model.SearchTrainingPlanOfferingsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<SearchTrainingPlanOfferingsRequest.Builder,SearchTrainingPlanOfferingsRequest>
@Generated("software.amazon.awssdk:codegen") public final class SearchTrainingPlanOfferingsRequest extends SageMakerRequest implements ToCopyableBuilder<SearchTrainingPlanOfferingsRequest.Builder,SearchTrainingPlanOfferingsRequest>

  • Method Details

    • instanceType

      public final ReservedCapacityInstanceType instanceType()

      The type of instance you want to search for in the available training plan offerings. This field allows you to filter the search results based on the specific compute resources you require for your SageMaker training jobs or SageMaker HyperPod clusters. When searching for training plan offerings, specifying the instance type helps you find Reserved Instances that match your computational needs.

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

      Returns:
      The type of instance you want to search for in the available training plan offerings. This field allows you to filter the search results based on the specific compute resources you require for your SageMaker training jobs or SageMaker HyperPod clusters. When searching for training plan offerings, specifying the instance type helps you find Reserved Instances that match your computational needs.
      See Also:

    • instanceTypeAsString

      public final String instanceTypeAsString()

      The type of instance you want to search for in the available training plan offerings. This field allows you to filter the search results based on the specific compute resources you require for your SageMaker training jobs or SageMaker HyperPod clusters. When searching for training plan offerings, specifying the instance type helps you find Reserved Instances that match your computational needs.

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

      Returns:
      The type of instance you want to search for in the available training plan offerings. This field allows you to filter the search results based on the specific compute resources you require for your SageMaker training jobs or SageMaker HyperPod clusters. When searching for training plan offerings, specifying the instance type helps you find Reserved Instances that match your computational needs.
      See Also:

    • instanceCount

      public final Integer instanceCount()

      The number of instances you want to reserve in the training plan offerings. This allows you to specify the quantity of compute resources needed for your SageMaker training jobs or SageMaker HyperPod clusters, helping you find reserved capacity offerings that match your requirements.

      Returns:
      The number of instances you want to reserve in the training plan offerings. This allows you to specify the quantity of compute resources needed for your SageMaker training jobs or SageMaker HyperPod clusters, helping you find reserved capacity offerings that match your requirements.

    • startTimeAfter

      public final Instant startTimeAfter()

      A filter to search for training plan offerings with a start time after a specified date.

      Returns:
      A filter to search for training plan offerings with a start time after a specified date.

    • endTimeBefore

      public final Instant endTimeBefore()

      A filter to search for reserved capacity offerings with an end time before a specified date.

      Returns:
      A filter to search for reserved capacity offerings with an end time before a specified date.

    • durationHours

      public final Long durationHours()

      The desired duration in hours for the training plan offerings.

      Returns:
      The desired duration in hours for the training plan offerings.

    • targetResources

      public final List<SageMakerResourceName> targetResources()

      The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) to search for in the offerings.

      Training plans are specific to their target resource.

      • A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.

      • A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group.

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

      Returns:
      The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) to search for in the offerings.

      Training plans are specific to their target resource.

      • A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.

      • A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group.

    • hasTargetResources

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

    • targetResourcesAsStrings

      public final List<String> targetResourcesAsStrings()

      The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) to search for in the offerings.

      Training plans are specific to their target resource.

      • A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.

      • A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group.

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

      Returns:
      The target resources (e.g., SageMaker Training Jobs, SageMaker HyperPod) to search for in the offerings.

      Training plans are specific to their target resource.

      • A training plan designed for SageMaker training jobs can only be used to schedule and run training jobs.

      • A training plan for HyperPod clusters can be used exclusively to provide compute resources to a cluster's instance group.

    • toBuilder

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

    • builder

      public static SearchTrainingPlanOfferingsRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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