Class ListClustersRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListClustersRequest.Builder,
ListClustersRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ListClustersRequest.Builder
builder()
final Instant
Set a start time for the time range during which you want to list SageMaker HyperPod clusters.final Instant
Set an end time for the time range during which you want to list SageMaker HyperPod clusters.final boolean
final boolean
equalsBySdkFields
(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 int
hashCode()
final Integer
Set the maximum number of SageMaker HyperPod clusters to list.final String
Set the maximum number of instances to print in the list.final String
Set the next token to retrieve the list of SageMaker HyperPod clusters.static Class
<? extends ListClustersRequest.Builder> final ClusterSortBy
sortBy()
The field by which to sort results.final String
The field by which to sort results.final SortOrder
The sort order for results.final String
The sort order for results.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
creationTimeAfter
Set a start time for the time range during which you want to list SageMaker HyperPod clusters. Timestamps are formatted according to the ISO 8601 standard.
Acceptable formats include:
-
YYYY-MM-DDThh:mm:ss.sssTZD
(UTC), for example,2014-10-01T20:30:00.000Z
-
YYYY-MM-DDThh:mm:ss.sssTZD
(with offset), for example,2014-10-01T12:30:00.000-08:00
-
YYYY-MM-DD
, for example,2014-10-01
-
Unix time in seconds, for example,
1412195400
. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC.
For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.
- Returns:
- Set a start time for the time range during which you want to list SageMaker HyperPod clusters. Timestamps
are formatted according to the ISO 8601 standard.
Acceptable formats include:
-
YYYY-MM-DDThh:mm:ss.sssTZD
(UTC), for example,2014-10-01T20:30:00.000Z
-
YYYY-MM-DDThh:mm:ss.sssTZD
(with offset), for example,2014-10-01T12:30:00.000-08:00
-
YYYY-MM-DD
, for example,2014-10-01
-
Unix time in seconds, for example,
1412195400
. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC.
For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.
-
-
-
creationTimeBefore
Set an end time for the time range during which you want to list SageMaker HyperPod clusters. A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable formats are the same as the timestamp formats for
CreationTimeAfter
. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.- Returns:
- Set an end time for the time range during which you want to list SageMaker HyperPod clusters. A filter
that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable
formats are the same as the timestamp formats for
CreationTimeAfter
. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.
-
maxResults
Set the maximum number of SageMaker HyperPod clusters to list.
- Returns:
- Set the maximum number of SageMaker HyperPod clusters to list.
-
nameContains
Set the maximum number of instances to print in the list.
- Returns:
- Set the maximum number of instances to print in the list.
-
nextToken
Set the next token to retrieve the list of SageMaker HyperPod clusters.
- Returns:
- Set the next token to retrieve the list of SageMaker HyperPod clusters.
-
sortBy
The field by which to sort results. The default value is
CREATION_TIME
.If the service returns an enum value that is not available in the current SDK version,
sortBy
will returnClusterSortBy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortByAsString()
.- Returns:
- The field by which to sort results. The default value is
CREATION_TIME
. - See Also:
-
sortByAsString
The field by which to sort results. The default value is
CREATION_TIME
.If the service returns an enum value that is not available in the current SDK version,
sortBy
will returnClusterSortBy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortByAsString()
.- Returns:
- The field by which to sort results. The default value is
CREATION_TIME
. - See Also:
-
sortOrder
The sort order for results. The default value is
Ascending
.If the service returns an enum value that is not available in the current SDK version,
sortOrder
will returnSortOrder.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortOrderAsString()
.- Returns:
- The sort order for results. The default value is
Ascending
. - See Also:
-
sortOrderAsString
The sort order for results. The default value is
Ascending
.If the service returns an enum value that is not available in the current SDK version,
sortOrder
will returnSortOrder.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortOrderAsString()
.- Returns:
- The sort order for results. The default value is
Ascending
. - See Also:
-
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 interfaceToCopyableBuilder<ListClustersRequest.Builder,
ListClustersRequest> - Specified by:
toBuilder
in classSageMakerRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in 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
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. -
getValueForField
Description copied from class:SdkRequest
Used 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:
getValueForField
in 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
-