Class MoveClusterNodesRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<MoveClusterNodesRequest.Builder,MoveClusterNodesRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()final StringA unique, case-sensitive identifier that you provide to ensure that the operation completes no more than one time.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 booleanFor responses, this returns true if the service returned a value for the NodeIds property.final booleanFor responses, this returns true if the service returned a value for the NodeLogicalIds property.final IntegerThe number of nodes to move, from 1 to 50.nodeIds()A list of instance IDs of the nodes to move.A list ofNodeLogicalIdsof the nodes to move.static Class<? extends MoveClusterNodesRequest.Builder> final StringThe Amazon Resource Name (ARN) of the HyperPod cluster that the nodes are moved from.final StringThe name of the instance group in the source cluster that the nodes are moved from.final StringThe Amazon Resource Name (ARN) of the HyperPod cluster that the nodes are moved to.final StringThe name of the instance group in the target cluster that the nodes are moved to.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.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
sourceClusterArn
The Amazon Resource Name (ARN) of the HyperPod cluster that the nodes are moved from.
- Returns:
- The Amazon Resource Name (ARN) of the HyperPod cluster that the nodes are moved from.
-
sourceInstanceGroupName
The name of the instance group in the source cluster that the nodes are moved from.
- Returns:
- The name of the instance group in the source cluster that the nodes are moved from.
-
targetClusterArn
The Amazon Resource Name (ARN) of the HyperPod cluster that the nodes are moved to. The target cluster must be in the same account and Region as the source cluster, and can be the same cluster as the source.
- Returns:
- The Amazon Resource Name (ARN) of the HyperPod cluster that the nodes are moved to. The target cluster must be in the same account and Region as the source cluster, and can be the same cluster as the source.
-
targetInstanceGroupName
The name of the instance group in the target cluster that the nodes are moved to. If the target cluster is the same as the source cluster, the target instance group must be different from the source instance group.
- Returns:
- The name of the instance group in the target cluster that the nodes are moved to. If the target cluster is the same as the source cluster, the target instance group must be different from the source instance group.
-
instanceCount
The number of nodes to move, from 1 to 50. HyperPod selects the nodes from the source instance group. If fewer than this number of nodes are eligible to move, the request fails and no nodes are moved. Specify exactly one of
NodeIds,NodeLogicalIds, orInstanceCount.- Returns:
- The number of nodes to move, from 1 to 50. HyperPod selects the nodes from the source instance group. If
fewer than this number of nodes are eligible to move, the request fails and no nodes are moved. Specify
exactly one of
NodeIds,NodeLogicalIds, orInstanceCount.
-
hasNodeIds
public final boolean hasNodeIds()For responses, this returns true if the service returned a value for the NodeIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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. -
nodeIds
A list of instance IDs of the nodes to move. You can specify up to 50 instance IDs. Each node is evaluated separately, so some nodes can be moved while others fail. The request fails if moving the eligible nodes would reduce the source instance group below its minimum instance count. Specify exactly one of
NodeIds,NodeLogicalIds, orInstanceCount.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
hasNodeIds()method.- Returns:
- A list of instance IDs of the nodes to move. You can specify up to 50 instance IDs. Each node is
evaluated separately, so some nodes can be moved while others fail. The request fails if moving the
eligible nodes would reduce the source instance group below its minimum instance count. Specify exactly
one of
NodeIds,NodeLogicalIds, orInstanceCount.
-
hasNodeLogicalIds
public final boolean hasNodeLogicalIds()For responses, this returns true if the service returned a value for the NodeLogicalIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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. -
nodeLogicalIds
A list of
NodeLogicalIdsof the nodes to move. You can specify up to 50NodeLogicalIds. Each node is evaluated separately, so some nodes can be moved while others fail. The request fails if moving the eligible nodes would reduce the source instance group below its minimum instance count. Specify exactly one ofNodeIds,NodeLogicalIds, orInstanceCount.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
hasNodeLogicalIds()method.- Returns:
- A list of
NodeLogicalIdsof the nodes to move. You can specify up to 50NodeLogicalIds. Each node is evaluated separately, so some nodes can be moved while others fail. The request fails if moving the eligible nodes would reduce the source instance group below its minimum instance count. Specify exactly one ofNodeIds,NodeLogicalIds, orInstanceCount.
-
clientToken
A unique, case-sensitive identifier that you provide to ensure that the operation completes no more than one time. If you retry the request with the same client token and the same parameters within 8 hours, the service returns the original response. It doesn't start a new move. If you reuse a client token with different parameters, the request fails.
- Returns:
- A unique, case-sensitive identifier that you provide to ensure that the operation completes no more than one time. If you retry the request with the same client token and the same parameters within 8 hours, the service returns the original response. It doesn't start a new move. If you reuse a client token with different parameters, the request fails.
-
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<MoveClusterNodesRequest.Builder,MoveClusterNodesRequest> - 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.
-