software.amazon.awssdk.services.sagemaker.model.ListClusterNodesRequest Maven / Gradle / Ivy
Show all versions of sagemaker Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.sagemaker.model;
import java.time.Instant;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class ListClusterNodesRequest extends SageMakerRequest implements
ToCopyableBuilder {
private static final SdkField CLUSTER_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ClusterName").getter(getter(ListClusterNodesRequest::clusterName)).setter(setter(Builder::clusterName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ClusterName").build()).build();
private static final SdkField CREATION_TIME_AFTER_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("CreationTimeAfter").getter(getter(ListClusterNodesRequest::creationTimeAfter))
.setter(setter(Builder::creationTimeAfter))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreationTimeAfter").build()).build();
private static final SdkField CREATION_TIME_BEFORE_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("CreationTimeBefore").getter(getter(ListClusterNodesRequest::creationTimeBefore))
.setter(setter(Builder::creationTimeBefore))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreationTimeBefore").build())
.build();
private static final SdkField INSTANCE_GROUP_NAME_CONTAINS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("InstanceGroupNameContains").getter(getter(ListClusterNodesRequest::instanceGroupNameContains))
.setter(setter(Builder::instanceGroupNameContains))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("InstanceGroupNameContains").build())
.build();
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxResults").getter(getter(ListClusterNodesRequest::maxResults)).setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxResults").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(ListClusterNodesRequest::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();
private static final SdkField SORT_BY_FIELD = SdkField. builder(MarshallingType.STRING).memberName("SortBy")
.getter(getter(ListClusterNodesRequest::sortByAsString)).setter(setter(Builder::sortBy))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SortBy").build()).build();
private static final SdkField SORT_ORDER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SortOrder").getter(getter(ListClusterNodesRequest::sortOrderAsString))
.setter(setter(Builder::sortOrder))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SortOrder").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CLUSTER_NAME_FIELD,
CREATION_TIME_AFTER_FIELD, CREATION_TIME_BEFORE_FIELD, INSTANCE_GROUP_NAME_CONTAINS_FIELD, MAX_RESULTS_FIELD,
NEXT_TOKEN_FIELD, SORT_BY_FIELD, SORT_ORDER_FIELD));
private final String clusterName;
private final Instant creationTimeAfter;
private final Instant creationTimeBefore;
private final String instanceGroupNameContains;
private final Integer maxResults;
private final String nextToken;
private final String sortBy;
private final String sortOrder;
private ListClusterNodesRequest(BuilderImpl builder) {
super(builder);
this.clusterName = builder.clusterName;
this.creationTimeAfter = builder.creationTimeAfter;
this.creationTimeBefore = builder.creationTimeBefore;
this.instanceGroupNameContains = builder.instanceGroupNameContains;
this.maxResults = builder.maxResults;
this.nextToken = builder.nextToken;
this.sortBy = builder.sortBy;
this.sortOrder = builder.sortOrder;
}
/**
*
* The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve
* the list of nodes.
*
*
* @return The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to
* retrieve the list of nodes.
*/
public final String clusterName() {
return clusterName;
}
/**
*
* A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time. 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.
*
*
* @return A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time. 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.
*/
public final Instant creationTimeAfter() {
return creationTimeAfter;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final Instant creationTimeBefore() {
return creationTimeBefore;
}
/**
*
* A filter that returns the instance groups whose name contain a specified string.
*
*
* @return A filter that returns the instance groups whose name contain a specified string.
*/
public final String instanceGroupNameContains() {
return instanceGroupNameContains;
}
/**
*
* The maximum number of nodes to return in the response.
*
*
* @return The maximum number of nodes to return in the response.
*/
public final Integer maxResults() {
return maxResults;
}
/**
*
* If the result of the previous ListClusterNodes request was truncated, the response includes a
* NextToken. To retrieve the next set of cluster nodes, use the token in the next request.
*
*
* @return If the result of the previous ListClusterNodes request was truncated, the response includes
* a NextToken. To retrieve the next set of cluster nodes, use the token in the next request.
*/
public final String nextToken() {
return nextToken;
}
/**
*
* 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, {@link #sortBy} will
* return {@link ClusterSortBy#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #sortByAsString}.
*
*
* @return The field by which to sort results. The default value is CREATION_TIME.
* @see ClusterSortBy
*/
public final ClusterSortBy sortBy() {
return ClusterSortBy.fromValue(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, {@link #sortBy} will
* return {@link ClusterSortBy#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #sortByAsString}.
*
*
* @return The field by which to sort results. The default value is CREATION_TIME.
* @see ClusterSortBy
*/
public final String sortByAsString() {
return sortBy;
}
/**
*
* 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, {@link #sortOrder} will
* return {@link SortOrder#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #sortOrderAsString}.
*
*
* @return The sort order for results. The default value is Ascending.
* @see SortOrder
*/
public final SortOrder sortOrder() {
return SortOrder.fromValue(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, {@link #sortOrder} will
* return {@link SortOrder#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #sortOrderAsString}.
*
*
* @return The sort order for results. The default value is Ascending.
* @see SortOrder
*/
public final String sortOrderAsString() {
return sortOrder;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(clusterName());
hashCode = 31 * hashCode + Objects.hashCode(creationTimeAfter());
hashCode = 31 * hashCode + Objects.hashCode(creationTimeBefore());
hashCode = 31 * hashCode + Objects.hashCode(instanceGroupNameContains());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(sortByAsString());
hashCode = 31 * hashCode + Objects.hashCode(sortOrderAsString());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ListClusterNodesRequest)) {
return false;
}
ListClusterNodesRequest other = (ListClusterNodesRequest) obj;
return Objects.equals(clusterName(), other.clusterName())
&& Objects.equals(creationTimeAfter(), other.creationTimeAfter())
&& Objects.equals(creationTimeBefore(), other.creationTimeBefore())
&& Objects.equals(instanceGroupNameContains(), other.instanceGroupNameContains())
&& Objects.equals(maxResults(), other.maxResults()) && Objects.equals(nextToken(), other.nextToken())
&& Objects.equals(sortByAsString(), other.sortByAsString())
&& Objects.equals(sortOrderAsString(), other.sortOrderAsString());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("ListClusterNodesRequest").add("ClusterName", clusterName())
.add("CreationTimeAfter", creationTimeAfter()).add("CreationTimeBefore", creationTimeBefore())
.add("InstanceGroupNameContains", instanceGroupNameContains()).add("MaxResults", maxResults())
.add("NextToken", nextToken()).add("SortBy", sortByAsString()).add("SortOrder", sortOrderAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ClusterName":
return Optional.ofNullable(clazz.cast(clusterName()));
case "CreationTimeAfter":
return Optional.ofNullable(clazz.cast(creationTimeAfter()));
case "CreationTimeBefore":
return Optional.ofNullable(clazz.cast(creationTimeBefore()));
case "InstanceGroupNameContains":
return Optional.ofNullable(clazz.cast(instanceGroupNameContains()));
case "MaxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "SortBy":
return Optional.ofNullable(clazz.cast(sortByAsString()));
case "SortOrder":
return Optional.ofNullable(clazz.cast(sortOrderAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ListClusterNodesRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to
* retrieve the list of nodes.
*
*
* @param clusterName
* The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want
* to retrieve the list of nodes.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder clusterName(String clusterName);
/**
*
* A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time. 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.
*
*
* @param creationTimeAfter
* A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time.
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder creationTimeAfter(Instant creationTimeAfter);
/**
*
* 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.
*
*
* @param creationTimeBefore
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder creationTimeBefore(Instant creationTimeBefore);
/**
*
* A filter that returns the instance groups whose name contain a specified string.
*
*
* @param instanceGroupNameContains
* A filter that returns the instance groups whose name contain a specified string.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder instanceGroupNameContains(String instanceGroupNameContains);
/**
*
* The maximum number of nodes to return in the response.
*
*
* @param maxResults
* The maximum number of nodes to return in the response.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
/**
*
* If the result of the previous ListClusterNodes request was truncated, the response includes a
* NextToken. To retrieve the next set of cluster nodes, use the token in the next request.
*
*
* @param nextToken
* If the result of the previous ListClusterNodes request was truncated, the response
* includes a NextToken. To retrieve the next set of cluster nodes, use the token in the
* next request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* The field by which to sort results. The default value is CREATION_TIME.
*
*
* @param sortBy
* The field by which to sort results. The default value is CREATION_TIME.
* @see ClusterSortBy
* @return Returns a reference to this object so that method calls can be chained together.
* @see ClusterSortBy
*/
Builder sortBy(String sortBy);
/**
*
* The field by which to sort results. The default value is CREATION_TIME.
*
*
* @param sortBy
* The field by which to sort results. The default value is CREATION_TIME.
* @see ClusterSortBy
* @return Returns a reference to this object so that method calls can be chained together.
* @see ClusterSortBy
*/
Builder sortBy(ClusterSortBy sortBy);
/**
*
* The sort order for results. The default value is Ascending.
*
*
* @param sortOrder
* The sort order for results. The default value is Ascending.
* @see SortOrder
* @return Returns a reference to this object so that method calls can be chained together.
* @see SortOrder
*/
Builder sortOrder(String sortOrder);
/**
*
* The sort order for results. The default value is Ascending.
*
*
* @param sortOrder
* The sort order for results. The default value is Ascending.
* @see SortOrder
* @return Returns a reference to this object so that method calls can be chained together.
* @see SortOrder
*/
Builder sortOrder(SortOrder sortOrder);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends SageMakerRequest.BuilderImpl implements Builder {
private String clusterName;
private Instant creationTimeAfter;
private Instant creationTimeBefore;
private String instanceGroupNameContains;
private Integer maxResults;
private String nextToken;
private String sortBy;
private String sortOrder;
private BuilderImpl() {
}
private BuilderImpl(ListClusterNodesRequest model) {
super(model);
clusterName(model.clusterName);
creationTimeAfter(model.creationTimeAfter);
creationTimeBefore(model.creationTimeBefore);
instanceGroupNameContains(model.instanceGroupNameContains);
maxResults(model.maxResults);
nextToken(model.nextToken);
sortBy(model.sortBy);
sortOrder(model.sortOrder);
}
public final String getClusterName() {
return clusterName;
}
public final void setClusterName(String clusterName) {
this.clusterName = clusterName;
}
@Override
public final Builder clusterName(String clusterName) {
this.clusterName = clusterName;
return this;
}
public final Instant getCreationTimeAfter() {
return creationTimeAfter;
}
public final void setCreationTimeAfter(Instant creationTimeAfter) {
this.creationTimeAfter = creationTimeAfter;
}
@Override
public final Builder creationTimeAfter(Instant creationTimeAfter) {
this.creationTimeAfter = creationTimeAfter;
return this;
}
public final Instant getCreationTimeBefore() {
return creationTimeBefore;
}
public final void setCreationTimeBefore(Instant creationTimeBefore) {
this.creationTimeBefore = creationTimeBefore;
}
@Override
public final Builder creationTimeBefore(Instant creationTimeBefore) {
this.creationTimeBefore = creationTimeBefore;
return this;
}
public final String getInstanceGroupNameContains() {
return instanceGroupNameContains;
}
public final void setInstanceGroupNameContains(String instanceGroupNameContains) {
this.instanceGroupNameContains = instanceGroupNameContains;
}
@Override
public final Builder instanceGroupNameContains(String instanceGroupNameContains) {
this.instanceGroupNameContains = instanceGroupNameContains;
return this;
}
public final Integer getMaxResults() {
return maxResults;
}
public final void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
@Override
public final Builder maxResults(Integer maxResults) {
this.maxResults = maxResults;
return this;
}
public final String getNextToken() {
return nextToken;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
public final String getSortBy() {
return sortBy;
}
public final void setSortBy(String sortBy) {
this.sortBy = sortBy;
}
@Override
public final Builder sortBy(String sortBy) {
this.sortBy = sortBy;
return this;
}
@Override
public final Builder sortBy(ClusterSortBy sortBy) {
this.sortBy(sortBy == null ? null : sortBy.toString());
return this;
}
public final String getSortOrder() {
return sortOrder;
}
public final void setSortOrder(String sortOrder) {
this.sortOrder = sortOrder;
}
@Override
public final Builder sortOrder(String sortOrder) {
this.sortOrder = sortOrder;
return this;
}
@Override
public final Builder sortOrder(SortOrder sortOrder) {
this.sortOrder(sortOrder == null ? null : sortOrder.toString());
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public ListClusterNodesRequest build() {
return new ListClusterNodesRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}