com.amazonaws.services.sagemaker.model.ListSpacesRequest 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 ListSpacesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* If the previous response was truncated, you will receive this token. Use it in your next request to receive the
* next set of results.
*
*/
private String nextToken;
/**
*
* This parameter defines the maximum number of results that can be return in a single response. The
* MaxResults parameter is an upper bound, not a target. If there are more results available than the
* value specified, a NextToken is provided in the response. The NextToken indicates that
* the user should get the next set of results by providing this token as a part of a subsequent call. The default
* value for MaxResults is 10.
*
*/
private Integer maxResults;
/**
*
* The sort order for the results. The default is Ascending.
*
*/
private String sortOrder;
/**
*
* The parameter by which to sort the results. The default is CreationTime.
*
*/
private String sortBy;
/**
*
* A parameter to search for the domain ID.
*
*/
private String domainIdEquals;
/**
*
* A parameter by which to filter the results.
*
*/
private String spaceNameContains;
/**
*
* If the previous response was truncated, you will receive this token. Use it in your next request to receive the
* next set of results.
*
*
* @param nextToken
* If the previous response was truncated, you will receive this token. Use it in your next request to
* receive the next set of results.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* If the previous response was truncated, you will receive this token. Use it in your next request to receive the
* next set of results.
*
*
* @return If the previous response was truncated, you will receive this token. Use it in your next request to
* receive the next set of results.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* If the previous response was truncated, you will receive this token. Use it in your next request to receive the
* next set of results.
*
*
* @param nextToken
* If the previous response was truncated, you will receive this token. Use it in your next request to
* receive the next set of results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListSpacesRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* This parameter defines the maximum number of results that can be return in a single response. The
* MaxResults parameter is an upper bound, not a target. If there are more results available than the
* value specified, a NextToken is provided in the response. The NextToken indicates that
* the user should get the next set of results by providing this token as a part of a subsequent call. The default
* value for MaxResults is 10.
*
*
* @param maxResults
* This parameter defines the maximum number of results that can be return in a single response. The
* MaxResults parameter is an upper bound, not a target. If there are more results available
* than the value specified, a NextToken is provided in the response. The NextToken
* indicates that the user should get the next set of results by providing this token as a part of a
* subsequent call. The default value for MaxResults is 10.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* This parameter defines the maximum number of results that can be return in a single response. The
* MaxResults parameter is an upper bound, not a target. If there are more results available than the
* value specified, a NextToken is provided in the response. The NextToken indicates that
* the user should get the next set of results by providing this token as a part of a subsequent call. The default
* value for MaxResults is 10.
*
*
* @return This parameter defines the maximum number of results that can be return in a single response. The
* MaxResults parameter is an upper bound, not a target. If there are more results available
* than the value specified, a NextToken is provided in the response. The
* NextToken indicates that the user should get the next set of results by providing this token
* as a part of a subsequent call. The default value for MaxResults is 10.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* This parameter defines the maximum number of results that can be return in a single response. The
* MaxResults parameter is an upper bound, not a target. If there are more results available than the
* value specified, a NextToken is provided in the response. The NextToken indicates that
* the user should get the next set of results by providing this token as a part of a subsequent call. The default
* value for MaxResults is 10.
*
*
* @param maxResults
* This parameter defines the maximum number of results that can be return in a single response. The
* MaxResults parameter is an upper bound, not a target. If there are more results available
* than the value specified, a NextToken is provided in the response. The NextToken
* indicates that the user should get the next set of results by providing this token as a part of a
* subsequent call. The default value for MaxResults is 10.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListSpacesRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* The sort order for the results. The default is Ascending.
*
*
* @param sortOrder
* The sort order for the results. The default is Ascending.
* @see SortOrder
*/
public void setSortOrder(String sortOrder) {
this.sortOrder = sortOrder;
}
/**
*
* The sort order for the results. The default is Ascending.
*
*
* @return The sort order for the results. The default is Ascending.
* @see SortOrder
*/
public String getSortOrder() {
return this.sortOrder;
}
/**
*
* The sort order for the results. The default is Ascending.
*
*
* @param sortOrder
* The sort order for the results. The default is Ascending.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SortOrder
*/
public ListSpacesRequest withSortOrder(String sortOrder) {
setSortOrder(sortOrder);
return this;
}
/**
*
* The sort order for the results. The default is Ascending.
*
*
* @param sortOrder
* The sort order for the results. The default is Ascending.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SortOrder
*/
public ListSpacesRequest withSortOrder(SortOrder sortOrder) {
this.sortOrder = sortOrder.toString();
return this;
}
/**
*
* The parameter by which to sort the results. The default is CreationTime.
*
*
* @param sortBy
* The parameter by which to sort the results. The default is CreationTime.
* @see SpaceSortKey
*/
public void setSortBy(String sortBy) {
this.sortBy = sortBy;
}
/**
*
* The parameter by which to sort the results. The default is CreationTime.
*
*
* @return The parameter by which to sort the results. The default is CreationTime.
* @see SpaceSortKey
*/
public String getSortBy() {
return this.sortBy;
}
/**
*
* The parameter by which to sort the results. The default is CreationTime.
*
*
* @param sortBy
* The parameter by which to sort the results. The default is CreationTime.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SpaceSortKey
*/
public ListSpacesRequest withSortBy(String sortBy) {
setSortBy(sortBy);
return this;
}
/**
*
* The parameter by which to sort the results. The default is CreationTime.
*
*
* @param sortBy
* The parameter by which to sort the results. The default is CreationTime.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SpaceSortKey
*/
public ListSpacesRequest withSortBy(SpaceSortKey sortBy) {
this.sortBy = sortBy.toString();
return this;
}
/**
*
* A parameter to search for the domain ID.
*
*
* @param domainIdEquals
* A parameter to search for the domain ID.
*/
public void setDomainIdEquals(String domainIdEquals) {
this.domainIdEquals = domainIdEquals;
}
/**
*
* A parameter to search for the domain ID.
*
*
* @return A parameter to search for the domain ID.
*/
public String getDomainIdEquals() {
return this.domainIdEquals;
}
/**
*
* A parameter to search for the domain ID.
*
*
* @param domainIdEquals
* A parameter to search for the domain ID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListSpacesRequest withDomainIdEquals(String domainIdEquals) {
setDomainIdEquals(domainIdEquals);
return this;
}
/**
*
* A parameter by which to filter the results.
*
*
* @param spaceNameContains
* A parameter by which to filter the results.
*/
public void setSpaceNameContains(String spaceNameContains) {
this.spaceNameContains = spaceNameContains;
}
/**
*
* A parameter by which to filter the results.
*
*
* @return A parameter by which to filter the results.
*/
public String getSpaceNameContains() {
return this.spaceNameContains;
}
/**
*
* A parameter by which to filter the results.
*
*
* @param spaceNameContains
* A parameter by which to filter the results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListSpacesRequest withSpaceNameContains(String spaceNameContains) {
setSpaceNameContains(spaceNameContains);
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 (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getSortOrder() != null)
sb.append("SortOrder: ").append(getSortOrder()).append(",");
if (getSortBy() != null)
sb.append("SortBy: ").append(getSortBy()).append(",");
if (getDomainIdEquals() != null)
sb.append("DomainIdEquals: ").append(getDomainIdEquals()).append(",");
if (getSpaceNameContains() != null)
sb.append("SpaceNameContains: ").append(getSpaceNameContains());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListSpacesRequest == false)
return false;
ListSpacesRequest other = (ListSpacesRequest) obj;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == 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.getSortOrder() == null ^ this.getSortOrder() == null)
return false;
if (other.getSortOrder() != null && other.getSortOrder().equals(this.getSortOrder()) == 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.getDomainIdEquals() == null ^ this.getDomainIdEquals() == null)
return false;
if (other.getDomainIdEquals() != null && other.getDomainIdEquals().equals(this.getDomainIdEquals()) == false)
return false;
if (other.getSpaceNameContains() == null ^ this.getSpaceNameContains() == null)
return false;
if (other.getSpaceNameContains() != null && other.getSpaceNameContains().equals(this.getSpaceNameContains()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getSortOrder() == null) ? 0 : getSortOrder().hashCode());
hashCode = prime * hashCode + ((getSortBy() == null) ? 0 : getSortBy().hashCode());
hashCode = prime * hashCode + ((getDomainIdEquals() == null) ? 0 : getDomainIdEquals().hashCode());
hashCode = prime * hashCode + ((getSpaceNameContains() == null) ? 0 : getSpaceNameContains().hashCode());
return hashCode;
}
@Override
public ListSpacesRequest clone() {
return (ListSpacesRequest) super.clone();
}
}