com.amazonaws.services.sagemaker.model.ListClusterNodesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-sagemaker Show documentation
/*
* Copyright 2019-2024 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 com.amazonaws.services.sagemaker.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ListClusterNodesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve
* the list of nodes.
*
*/
private 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.
*
*/
private java.util.Date 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.
*
*/
private java.util.Date creationTimeBefore;
/**
*
* A filter that returns the instance groups whose name contain a specified string.
*
*/
private String instanceGroupNameContains;
/**
*
* The maximum number of nodes to return in the response.
*
*/
private 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.
*
*/
private String nextToken;
/**
*
* The field by which to sort results. The default value is CREATION_TIME.
*
*/
private String sortBy;
/**
*
* The sort order for results. The default value is Ascending.
*
*/
private String 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.
*
*
* @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.
*/
public void setClusterName(String clusterName) {
this.clusterName = 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 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 String getClusterName() {
return this.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.
*
*
* @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.
*/
public ListClusterNodesRequest withClusterName(String clusterName) {
setClusterName(clusterName);
return this;
}
/**
*
* 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.
*/
public void setCreationTimeAfter(java.util.Date creationTimeAfter) {
this.creationTimeAfter = 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 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 java.util.Date getCreationTimeAfter() {
return this.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.
*
*
* @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.
*/
public ListClusterNodesRequest withCreationTimeAfter(java.util.Date creationTimeAfter) {
setCreationTimeAfter(creationTimeAfter);
return this;
}
/**
*
* 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.
*/
public void setCreationTimeBefore(java.util.Date creationTimeBefore) {
this.creationTimeBefore = 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 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 java.util.Date getCreationTimeBefore() {
return this.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.
*
*
* @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.
*/
public ListClusterNodesRequest withCreationTimeBefore(java.util.Date creationTimeBefore) {
setCreationTimeBefore(creationTimeBefore);
return this;
}
/**
*
* 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.
*/
public void setInstanceGroupNameContains(String instanceGroupNameContains) {
this.instanceGroupNameContains = instanceGroupNameContains;
}
/**
*
* 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 String getInstanceGroupNameContains() {
return this.instanceGroupNameContains;
}
/**
*
* 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.
*/
public ListClusterNodesRequest withInstanceGroupNameContains(String instanceGroupNameContains) {
setInstanceGroupNameContains(instanceGroupNameContains);
return this;
}
/**
*
* The maximum number of nodes to return in the response.
*
*
* @param maxResults
* The maximum number of nodes to return in the response.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of nodes to return in the response.
*
*
* @return The maximum number of nodes to return in the response.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* 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.
*/
public ListClusterNodesRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* 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.
*/
public void setNextToken(String nextToken) {
this.nextToken = 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 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 String getNextToken() {
return this.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.
*
*
* @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.
*/
public ListClusterNodesRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* 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
*/
public void setSortBy(String sortBy) {
this.sortBy = sortBy;
}
/**
*
* The field by which to sort results. The default value is CREATION_TIME.
*
*
* @return The field by which to sort results. The default value is CREATION_TIME.
* @see ClusterSortBy
*/
public String getSortBy() {
return this.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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ClusterSortBy
*/
public ListClusterNodesRequest withSortBy(String sortBy) {
setSortBy(sortBy);
return this;
}
/**
*
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ClusterSortBy
*/
public ListClusterNodesRequest withSortBy(ClusterSortBy sortBy) {
this.sortBy = sortBy.toString();
return this;
}
/**
*
* The sort order for results. The default value is Ascending.
*
*
* @param sortOrder
* The sort order for results. The default value is Ascending.
* @see SortOrder
*/
public void setSortOrder(String sortOrder) {
this.sortOrder = sortOrder;
}
/**
*
* The sort order for results. The default value is Ascending.
*
*
* @return The sort order for results. The default value is Ascending.
* @see SortOrder
*/
public String getSortOrder() {
return this.sortOrder;
}
/**
*
* The sort order for results. The default value is Ascending.
*
*
* @param sortOrder
* The sort order for results. The default value is Ascending.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SortOrder
*/
public ListClusterNodesRequest withSortOrder(String sortOrder) {
setSortOrder(sortOrder);
return this;
}
/**
*
* The sort order for results. The default value is Ascending.
*
*
* @param sortOrder
* The sort order for results. The default value is Ascending.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SortOrder
*/
public ListClusterNodesRequest withSortOrder(SortOrder sortOrder) {
this.sortOrder = sortOrder.toString();
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getClusterName() != null)
sb.append("ClusterName: ").append(getClusterName()).append(",");
if (getCreationTimeAfter() != null)
sb.append("CreationTimeAfter: ").append(getCreationTimeAfter()).append(",");
if (getCreationTimeBefore() != null)
sb.append("CreationTimeBefore: ").append(getCreationTimeBefore()).append(",");
if (getInstanceGroupNameContains() != null)
sb.append("InstanceGroupNameContains: ").append(getInstanceGroupNameContains()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getSortBy() != null)
sb.append("SortBy: ").append(getSortBy()).append(",");
if (getSortOrder() != null)
sb.append("SortOrder: ").append(getSortOrder());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListClusterNodesRequest == false)
return false;
ListClusterNodesRequest other = (ListClusterNodesRequest) obj;
if (other.getClusterName() == null ^ this.getClusterName() == null)
return false;
if (other.getClusterName() != null && other.getClusterName().equals(this.getClusterName()) == false)
return false;
if (other.getCreationTimeAfter() == null ^ this.getCreationTimeAfter() == null)
return false;
if (other.getCreationTimeAfter() != null && other.getCreationTimeAfter().equals(this.getCreationTimeAfter()) == false)
return false;
if (other.getCreationTimeBefore() == null ^ this.getCreationTimeBefore() == null)
return false;
if (other.getCreationTimeBefore() != null && other.getCreationTimeBefore().equals(this.getCreationTimeBefore()) == false)
return false;
if (other.getInstanceGroupNameContains() == null ^ this.getInstanceGroupNameContains() == null)
return false;
if (other.getInstanceGroupNameContains() != null && other.getInstanceGroupNameContains().equals(this.getInstanceGroupNameContains()) == false)
return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
if (other.getSortBy() == null ^ this.getSortBy() == null)
return false;
if (other.getSortBy() != null && other.getSortBy().equals(this.getSortBy()) == false)
return false;
if (other.getSortOrder() == null ^ this.getSortOrder() == null)
return false;
if (other.getSortOrder() != null && other.getSortOrder().equals(this.getSortOrder()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getClusterName() == null) ? 0 : getClusterName().hashCode());
hashCode = prime * hashCode + ((getCreationTimeAfter() == null) ? 0 : getCreationTimeAfter().hashCode());
hashCode = prime * hashCode + ((getCreationTimeBefore() == null) ? 0 : getCreationTimeBefore().hashCode());
hashCode = prime * hashCode + ((getInstanceGroupNameContains() == null) ? 0 : getInstanceGroupNameContains().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getSortBy() == null) ? 0 : getSortBy().hashCode());
hashCode = prime * hashCode + ((getSortOrder() == null) ? 0 : getSortOrder().hashCode());
return hashCode;
}
@Override
public ListClusterNodesRequest clone() {
return (ListClusterNodesRequest) super.clone();
}
}