Class ListClusterEventsRequest

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

  • Method Details

    • clusterName

      public final String clusterName()

      The name or Amazon Resource Name (ARN) of the HyperPod cluster for which to list events.

      Returns:
      The name or Amazon Resource Name (ARN) of the HyperPod cluster for which to list events.

    • instanceGroupName

      public final String instanceGroupName()

      The name of the instance group to filter events. If specified, only events related to this instance group are returned.

      Returns:
      The name of the instance group to filter events. If specified, only events related to this instance group are returned.

    • nodeId

      public final String nodeId()

      The EC2 instance ID to filter events. If specified, only events related to this instance are returned.

      Returns:
      The EC2 instance ID to filter events. If specified, only events related to this instance are returned.

    • eventTimeAfter

      public final Instant eventTimeAfter()

      The start of the time range for filtering events. Only events that occurred after this time are included in the results.

      Returns:
      The start of the time range for filtering events. Only events that occurred after this time are included in the results.

    • eventTimeBefore

      public final Instant eventTimeBefore()

      The end of the time range for filtering events. Only events that occurred before this time are included in the results.

      Returns:
      The end of the time range for filtering events. Only events that occurred before this time are included in the results.

    • sortBy

      public final EventSortBy sortBy()

      The field to use for sorting the event list. Currently, the only supported value is EventTime.

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

      Returns:
      The field to use for sorting the event list. Currently, the only supported value is EventTime.
      See Also:

    • sortByAsString

      public final String sortByAsString()

      The field to use for sorting the event list. Currently, the only supported value is EventTime.

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

      Returns:
      The field to use for sorting the event list. Currently, the only supported value is EventTime.
      See Also:

    • sortOrder

      public final SortOrder sortOrder()

      The order in which to sort the results. Valid values are Ascending or Descending (the default is Descending).

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

      Returns:
      The order in which to sort the results. Valid values are Ascending or Descending (the default is Descending).
      See Also:

    • sortOrderAsString

      public final String sortOrderAsString()

      The order in which to sort the results. Valid values are Ascending or Descending (the default is Descending).

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

      Returns:
      The order in which to sort the results. Valid values are Ascending or Descending (the default is Descending).
      See Also:

    • resourceType

      public final ClusterEventResourceType resourceType()

      The type of resource for which to filter events. Valid values are Cluster, InstanceGroup, or Instance.

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

      Returns:
      The type of resource for which to filter events. Valid values are Cluster, InstanceGroup, or Instance.
      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      The type of resource for which to filter events. Valid values are Cluster, InstanceGroup, or Instance.

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

      Returns:
      The type of resource for which to filter events. Valid values are Cluster, InstanceGroup, or Instance.
      See Also:

    • maxResults

      public final Integer maxResults()

      The maximum number of events to return in the response. Valid range is 1 to 100.

      Returns:
      The maximum number of events to return in the response. Valid range is 1 to 100.

    • nextToken

      public final String nextToken()

      A token to retrieve the next set of results. This token is obtained from the output of a previous ListClusterEvents call.

      Returns:
      A token to retrieve the next set of results. This token is obtained from the output of a previous ListClusterEvents call.

    • toBuilder

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

    • builder

      public static ListClusterEventsRequest.Builder builder()

    • serializableBuilderClass

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