com.amazonaws.services.sagemaker.model.ListTrainingJobsForHyperParameterTuningJobRequest Maven / Gradle / Ivy
/*
* Copyright 2015-2020 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 ListTrainingJobsForHyperParameterTuningJobRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name of the tuning job whose training jobs you want to list.
*
*/
private String hyperParameterTuningJobName;
/**
*
* If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the
* response includes a NextToken. To retrieve the next set of training jobs, use the token in the next
* request.
*
*/
private String nextToken;
/**
*
* The maximum number of training jobs to return. The default value is 10.
*
*/
private Integer maxResults;
/**
*
* A filter that returns only training jobs with the specified status.
*
*/
private String statusEquals;
/**
*
* The field to sort results by. The default is Name.
*
*
* If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an
* objective metric are not listed.
*
*/
private String sortBy;
/**
*
* The sort order for results. The default is Ascending.
*
*/
private String sortOrder;
/**
*
* The name of the tuning job whose training jobs you want to list.
*
*
* @param hyperParameterTuningJobName
* The name of the tuning job whose training jobs you want to list.
*/
public void setHyperParameterTuningJobName(String hyperParameterTuningJobName) {
this.hyperParameterTuningJobName = hyperParameterTuningJobName;
}
/**
*
* The name of the tuning job whose training jobs you want to list.
*
*
* @return The name of the tuning job whose training jobs you want to list.
*/
public String getHyperParameterTuningJobName() {
return this.hyperParameterTuningJobName;
}
/**
*
* The name of the tuning job whose training jobs you want to list.
*
*
* @param hyperParameterTuningJobName
* The name of the tuning job whose training jobs you want to list.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListTrainingJobsForHyperParameterTuningJobRequest withHyperParameterTuningJobName(String hyperParameterTuningJobName) {
setHyperParameterTuningJobName(hyperParameterTuningJobName);
return this;
}
/**
*
* If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the
* response includes a NextToken. To retrieve the next set of training jobs, use the token in the next
* request.
*
*
* @param nextToken
* If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was
* truncated, the response includes a NextToken. To retrieve the next set of training jobs, use
* the token in the next request.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the
* response includes a NextToken. To retrieve the next set of training jobs, use the token in the next
* request.
*
*
* @return If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was
* truncated, the response includes a NextToken. To retrieve the next set of training jobs, use
* the token in the next request.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the
* response includes a NextToken. To retrieve the next set of training jobs, use the token in the next
* request.
*
*
* @param nextToken
* If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was
* truncated, the response includes a NextToken. To retrieve the next set of training jobs, use
* the token in the next request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListTrainingJobsForHyperParameterTuningJobRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The maximum number of training jobs to return. The default value is 10.
*
*
* @param maxResults
* The maximum number of training jobs to return. The default value is 10.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of training jobs to return. The default value is 10.
*
*
* @return The maximum number of training jobs to return. The default value is 10.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of training jobs to return. The default value is 10.
*
*
* @param maxResults
* The maximum number of training jobs to return. The default value is 10.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListTrainingJobsForHyperParameterTuningJobRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* A filter that returns only training jobs with the specified status.
*
*
* @param statusEquals
* A filter that returns only training jobs with the specified status.
* @see TrainingJobStatus
*/
public void setStatusEquals(String statusEquals) {
this.statusEquals = statusEquals;
}
/**
*
* A filter that returns only training jobs with the specified status.
*
*
* @return A filter that returns only training jobs with the specified status.
* @see TrainingJobStatus
*/
public String getStatusEquals() {
return this.statusEquals;
}
/**
*
* A filter that returns only training jobs with the specified status.
*
*
* @param statusEquals
* A filter that returns only training jobs with the specified status.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TrainingJobStatus
*/
public ListTrainingJobsForHyperParameterTuningJobRequest withStatusEquals(String statusEquals) {
setStatusEquals(statusEquals);
return this;
}
/**
*
* A filter that returns only training jobs with the specified status.
*
*
* @param statusEquals
* A filter that returns only training jobs with the specified status.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TrainingJobStatus
*/
public ListTrainingJobsForHyperParameterTuningJobRequest withStatusEquals(TrainingJobStatus statusEquals) {
this.statusEquals = statusEquals.toString();
return this;
}
/**
*
* The field to sort results by. The default is Name.
*
*
* If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an
* objective metric are not listed.
*
*
* @param sortBy
* The field to sort results by. The default is Name.
*
* If the value of this field is FinalObjectiveMetricValue, any training jobs that did not
* return an objective metric are not listed.
* @see TrainingJobSortByOptions
*/
public void setSortBy(String sortBy) {
this.sortBy = sortBy;
}
/**
*
* The field to sort results by. The default is Name.
*
*
* If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an
* objective metric are not listed.
*
*
* @return The field to sort results by. The default is Name.
*
* If the value of this field is FinalObjectiveMetricValue, any training jobs that did not
* return an objective metric are not listed.
* @see TrainingJobSortByOptions
*/
public String getSortBy() {
return this.sortBy;
}
/**
*
* The field to sort results by. The default is Name.
*
*
* If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an
* objective metric are not listed.
*
*
* @param sortBy
* The field to sort results by. The default is Name.
*
* If the value of this field is FinalObjectiveMetricValue, any training jobs that did not
* return an objective metric are not listed.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TrainingJobSortByOptions
*/
public ListTrainingJobsForHyperParameterTuningJobRequest withSortBy(String sortBy) {
setSortBy(sortBy);
return this;
}
/**
*
* The field to sort results by. The default is Name.
*
*
* If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an
* objective metric are not listed.
*
*
* @param sortBy
* The field to sort results by. The default is Name.
*
* If the value of this field is FinalObjectiveMetricValue, any training jobs that did not
* return an objective metric are not listed.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TrainingJobSortByOptions
*/
public ListTrainingJobsForHyperParameterTuningJobRequest withSortBy(TrainingJobSortByOptions sortBy) {
this.sortBy = sortBy.toString();
return this;
}
/**
*
* The sort order for results. The default is Ascending.
*
*
* @param sortOrder
* The sort order for results. The default is Ascending.
* @see SortOrder
*/
public void setSortOrder(String sortOrder) {
this.sortOrder = sortOrder;
}
/**
*
* The sort order for results. The default is Ascending.
*
*
* @return The sort order for results. The default is Ascending.
* @see SortOrder
*/
public String getSortOrder() {
return this.sortOrder;
}
/**
*
* The sort order for results. The default is Ascending.
*
*
* @param sortOrder
* The sort order for results. The default is Ascending.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SortOrder
*/
public ListTrainingJobsForHyperParameterTuningJobRequest withSortOrder(String sortOrder) {
setSortOrder(sortOrder);
return this;
}
/**
*
* The sort order for results. The default is Ascending.
*
*
* @param sortOrder
* The sort order for results. The default is Ascending.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SortOrder
*/
public ListTrainingJobsForHyperParameterTuningJobRequest 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 (getHyperParameterTuningJobName() != null)
sb.append("HyperParameterTuningJobName: ").append(getHyperParameterTuningJobName()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getStatusEquals() != null)
sb.append("StatusEquals: ").append(getStatusEquals()).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 ListTrainingJobsForHyperParameterTuningJobRequest == false)
return false;
ListTrainingJobsForHyperParameterTuningJobRequest other = (ListTrainingJobsForHyperParameterTuningJobRequest) obj;
if (other.getHyperParameterTuningJobName() == null ^ this.getHyperParameterTuningJobName() == null)
return false;
if (other.getHyperParameterTuningJobName() != null && other.getHyperParameterTuningJobName().equals(this.getHyperParameterTuningJobName()) == 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.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == 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.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 + ((getHyperParameterTuningJobName() == null) ? 0 : getHyperParameterTuningJobName().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getStatusEquals() == null) ? 0 : getStatusEquals().hashCode());
hashCode = prime * hashCode + ((getSortBy() == null) ? 0 : getSortBy().hashCode());
hashCode = prime * hashCode + ((getSortOrder() == null) ? 0 : getSortOrder().hashCode());
return hashCode;
}
@Override
public ListTrainingJobsForHyperParameterTuningJobRequest clone() {
return (ListTrainingJobsForHyperParameterTuningJobRequest) super.clone();
}
}