Class ListClusterOperationsRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<ListClusterOperationsRequest.Builder,ListClusterOperationsRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()final StringThe name or Amazon Resource Name (ARN) of the HyperPod cluster for which to list operations.final InstantThe start of the time range for filtering operations.final InstantThe end of the time range for filtering operations.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest.final inthashCode()final IntegerThe maximum number of operations to return in the response.final StringA token to retrieve the next set of results.static Class<? extends ListClusterOperationsRequest.Builder> final ClusterOperationSortBysortBy()The field to use for sorting the operation list.final StringThe field to use for sorting the operation list.final SortOrderThe order in which to sort the results.final StringThe order in which to sort the results.final ClusterOperationStatusstatus()The operation status to filter by.final StringThe operation status to filter by.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.final ClusterOperationTypetype()The operation type to filter by.final StringThe operation type to filter by.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
clusterName
The name or Amazon Resource Name (ARN) of the HyperPod cluster for which to list operations.
- Returns:
- The name or Amazon Resource Name (ARN) of the HyperPod cluster for which to list operations.
-
status
The operation status to filter by. If specified, only operations with this status are returned. Valid values are
InProgress,Superseded, orDone.If the service returns an enum value that is not available in the current SDK version,
statuswill returnClusterOperationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The operation status to filter by. If specified, only operations with this status are returned. Valid
values are
InProgress,Superseded, orDone. - See Also:
-
statusAsString
The operation status to filter by. If specified, only operations with this status are returned. Valid values are
InProgress,Superseded, orDone.If the service returns an enum value that is not available in the current SDK version,
statuswill returnClusterOperationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The operation status to filter by. If specified, only operations with this status are returned. Valid
values are
InProgress,Superseded, orDone. - See Also:
-
type
The operation type to filter by. If specified, only operations of this type are returned. Valid values are
ScalingorDeepHealthCheck.If the service returns an enum value that is not available in the current SDK version,
typewill returnClusterOperationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The operation type to filter by. If specified, only operations of this type are returned. Valid values
are
ScalingorDeepHealthCheck. - See Also:
-
typeAsString
The operation type to filter by. If specified, only operations of this type are returned. Valid values are
ScalingorDeepHealthCheck.If the service returns an enum value that is not available in the current SDK version,
typewill returnClusterOperationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The operation type to filter by. If specified, only operations of this type are returned. Valid values
are
ScalingorDeepHealthCheck. - See Also:
-
creationTimeAfter
The start of the time range for filtering operations. Only operations created after this time are included in the results.
- Returns:
- The start of the time range for filtering operations. Only operations created after this time are included in the results.
-
creationTimeBefore
The end of the time range for filtering operations. Only operations created before this time are included in the results.
- Returns:
- The end of the time range for filtering operations. Only operations created before this time are included in the results.
-
sortBy
The field to use for sorting the operation list. Currently, the only supported value is
CreationTime.If the service returns an enum value that is not available in the current SDK version,
sortBywill returnClusterOperationSortBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsortByAsString().- Returns:
- The field to use for sorting the operation list. Currently, the only supported value is
CreationTime. - See Also:
-
sortByAsString
The field to use for sorting the operation list. Currently, the only supported value is
CreationTime.If the service returns an enum value that is not available in the current SDK version,
sortBywill returnClusterOperationSortBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsortByAsString().- Returns:
- The field to use for sorting the operation list. Currently, the only supported value is
CreationTime. - See Also:
-
sortOrder
The order in which to sort the results. Valid values are
AscendingorDescending(the default isDescending).If the service returns an enum value that is not available in the current SDK version,
sortOrderwill returnSortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsortOrderAsString().- Returns:
- The order in which to sort the results. Valid values are
AscendingorDescending(the default isDescending). - See Also:
-
sortOrderAsString
The order in which to sort the results. Valid values are
AscendingorDescending(the default isDescending).If the service returns an enum value that is not available in the current SDK version,
sortOrderwill returnSortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsortOrderAsString().- Returns:
- The order in which to sort the results. Valid values are
AscendingorDescending(the default isDescending). - See Also:
-
maxResults
The maximum number of operations to return in the response. Valid range is 1 to 100.
- Returns:
- The maximum number of operations to return in the response. Valid range is 1 to 100.
-
nextToken
A token to retrieve the next set of results. This token is obtained from the output of a previous
ListClusterOperationscall.- Returns:
- A token to retrieve the next set of results. This token is obtained from the output of a previous
ListClusterOperationscall.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<ListClusterOperationsRequest.Builder,ListClusterOperationsRequest> - Specified by:
toBuilderin classSageMakerRequest- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsRequest
-
equals
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkRequestUsed to retrieve the value of a field from any class that extendsSdkRequest. 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, theSdkRequest.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkRequest- 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
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-