com.amazonaws.services.sagemaker.model.ListCandidatesForAutoMLJobRequest 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 ListCandidatesForAutoMLJobRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* List the candidates created for the job by providing the job's name.
*
*/
private String autoMLJobName;
/**
*
* List the candidates for the job and filter by status.
*
*/
private String statusEquals;
/**
*
* List the candidates for the job and filter by candidate name.
*
*/
private String candidateNameEquals;
/**
*
* The sort order for the results. The default is Ascending
.
*
*/
private String sortOrder;
/**
*
* The parameter by which to sort the results. The default is Descending
.
*
*/
private String sortBy;
/**
*
* List the job's candidates up to a specified limit.
*
*/
private Integer maxResults;
/**
*
* If the previous response was truncated, you receive this token. Use it in your next request to receive the next
* set of results.
*
*/
private String nextToken;
/**
*
* List the candidates created for the job by providing the job's name.
*
*
* @param autoMLJobName
* List the candidates created for the job by providing the job's name.
*/
public void setAutoMLJobName(String autoMLJobName) {
this.autoMLJobName = autoMLJobName;
}
/**
*
* List the candidates created for the job by providing the job's name.
*
*
* @return List the candidates created for the job by providing the job's name.
*/
public String getAutoMLJobName() {
return this.autoMLJobName;
}
/**
*
* List the candidates created for the job by providing the job's name.
*
*
* @param autoMLJobName
* List the candidates created for the job by providing the job's name.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListCandidatesForAutoMLJobRequest withAutoMLJobName(String autoMLJobName) {
setAutoMLJobName(autoMLJobName);
return this;
}
/**
*
* List the candidates for the job and filter by status.
*
*
* @param statusEquals
* List the candidates for the job and filter by status.
* @see CandidateStatus
*/
public void setStatusEquals(String statusEquals) {
this.statusEquals = statusEquals;
}
/**
*
* List the candidates for the job and filter by status.
*
*
* @return List the candidates for the job and filter by status.
* @see CandidateStatus
*/
public String getStatusEquals() {
return this.statusEquals;
}
/**
*
* List the candidates for the job and filter by status.
*
*
* @param statusEquals
* List the candidates for the job and filter by status.
* @return Returns a reference to this object so that method calls can be chained together.
* @see CandidateStatus
*/
public ListCandidatesForAutoMLJobRequest withStatusEquals(String statusEquals) {
setStatusEquals(statusEquals);
return this;
}
/**
*
* List the candidates for the job and filter by status.
*
*
* @param statusEquals
* List the candidates for the job and filter by status.
* @return Returns a reference to this object so that method calls can be chained together.
* @see CandidateStatus
*/
public ListCandidatesForAutoMLJobRequest withStatusEquals(CandidateStatus statusEquals) {
this.statusEquals = statusEquals.toString();
return this;
}
/**
*
* List the candidates for the job and filter by candidate name.
*
*
* @param candidateNameEquals
* List the candidates for the job and filter by candidate name.
*/
public void setCandidateNameEquals(String candidateNameEquals) {
this.candidateNameEquals = candidateNameEquals;
}
/**
*
* List the candidates for the job and filter by candidate name.
*
*
* @return List the candidates for the job and filter by candidate name.
*/
public String getCandidateNameEquals() {
return this.candidateNameEquals;
}
/**
*
* List the candidates for the job and filter by candidate name.
*
*
* @param candidateNameEquals
* List the candidates for the job and filter by candidate name.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListCandidatesForAutoMLJobRequest withCandidateNameEquals(String candidateNameEquals) {
setCandidateNameEquals(candidateNameEquals);
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 AutoMLSortOrder
*/
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 AutoMLSortOrder
*/
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 AutoMLSortOrder
*/
public ListCandidatesForAutoMLJobRequest 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 AutoMLSortOrder
*/
public ListCandidatesForAutoMLJobRequest withSortOrder(AutoMLSortOrder sortOrder) {
this.sortOrder = sortOrder.toString();
return this;
}
/**
*
* The parameter by which to sort the results. The default is Descending
.
*
*
* @param sortBy
* The parameter by which to sort the results. The default is Descending
.
* @see CandidateSortBy
*/
public void setSortBy(String sortBy) {
this.sortBy = sortBy;
}
/**
*
* The parameter by which to sort the results. The default is Descending
.
*
*
* @return The parameter by which to sort the results. The default is Descending
.
* @see CandidateSortBy
*/
public String getSortBy() {
return this.sortBy;
}
/**
*
* The parameter by which to sort the results. The default is Descending
.
*
*
* @param sortBy
* The parameter by which to sort the results. The default is Descending
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see CandidateSortBy
*/
public ListCandidatesForAutoMLJobRequest withSortBy(String sortBy) {
setSortBy(sortBy);
return this;
}
/**
*
* The parameter by which to sort the results. The default is Descending
.
*
*
* @param sortBy
* The parameter by which to sort the results. The default is Descending
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see CandidateSortBy
*/
public ListCandidatesForAutoMLJobRequest withSortBy(CandidateSortBy sortBy) {
this.sortBy = sortBy.toString();
return this;
}
/**
*
* List the job's candidates up to a specified limit.
*
*
* @param maxResults
* List the job's candidates up to a specified limit.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* List the job's candidates up to a specified limit.
*
*
* @return List the job's candidates up to a specified limit.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* List the job's candidates up to a specified limit.
*
*
* @param maxResults
* List the job's candidates up to a specified limit.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListCandidatesForAutoMLJobRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* If the previous response was truncated, you 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 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 receive this token. Use it in your next request to receive the next
* set of results.
*
*
* @return If the previous response was truncated, you 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 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 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 ListCandidatesForAutoMLJobRequest withNextToken(String nextToken) {
setNextToken(nextToken);
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 (getAutoMLJobName() != null)
sb.append("AutoMLJobName: ").append(getAutoMLJobName()).append(",");
if (getStatusEquals() != null)
sb.append("StatusEquals: ").append(getStatusEquals()).append(",");
if (getCandidateNameEquals() != null)
sb.append("CandidateNameEquals: ").append(getCandidateNameEquals()).append(",");
if (getSortOrder() != null)
sb.append("SortOrder: ").append(getSortOrder()).append(",");
if (getSortBy() != null)
sb.append("SortBy: ").append(getSortBy()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListCandidatesForAutoMLJobRequest == false)
return false;
ListCandidatesForAutoMLJobRequest other = (ListCandidatesForAutoMLJobRequest) obj;
if (other.getAutoMLJobName() == null ^ this.getAutoMLJobName() == null)
return false;
if (other.getAutoMLJobName() != null && other.getAutoMLJobName().equals(this.getAutoMLJobName()) == false)
return false;
if (other.getStatusEquals() == null ^ this.getStatusEquals() == null)
return false;
if (other.getStatusEquals() != null && other.getStatusEquals().equals(this.getStatusEquals()) == false)
return false;
if (other.getCandidateNameEquals() == null ^ this.getCandidateNameEquals() == null)
return false;
if (other.getCandidateNameEquals() != null && other.getCandidateNameEquals().equals(this.getCandidateNameEquals()) == 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.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;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAutoMLJobName() == null) ? 0 : getAutoMLJobName().hashCode());
hashCode = prime * hashCode + ((getStatusEquals() == null) ? 0 : getStatusEquals().hashCode());
hashCode = prime * hashCode + ((getCandidateNameEquals() == null) ? 0 : getCandidateNameEquals().hashCode());
hashCode = prime * hashCode + ((getSortOrder() == null) ? 0 : getSortOrder().hashCode());
hashCode = prime * hashCode + ((getSortBy() == null) ? 0 : getSortBy().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
return hashCode;
}
@Override
public ListCandidatesForAutoMLJobRequest clone() {
return (ListCandidatesForAutoMLJobRequest) super.clone();
}
}