com.amazonaws.services.sagemaker.model.ListMonitoringSchedulesRequest 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 ListMonitoringSchedulesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* Name of a specific endpoint to fetch schedules for.
*
*/
private String endpointName;
/**
*
* Whether to sort the results by the Status, CreationTime, or ScheduledTime
* field. The default is CreationTime.
*
*/
private String sortBy;
/**
*
* Whether to sort the results in Ascending or Descending order. The default is
* Descending.
*
*/
private String sortOrder;
/**
*
* The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next
* request.
*
*/
private String nextToken;
/**
*
* The maximum number of jobs to return in the response. The default value is 10.
*
*/
private Integer maxResults;
/**
*
* Filter for monitoring schedules whose name contains a specified string.
*
*/
private String nameContains;
/**
*
* A filter that returns only monitoring schedules created before a specified time.
*
*/
private java.util.Date creationTimeBefore;
/**
*
* A filter that returns only monitoring schedules created after a specified time.
*
*/
private java.util.Date creationTimeAfter;
/**
*
* A filter that returns only monitoring schedules modified before a specified time.
*
*/
private java.util.Date lastModifiedTimeBefore;
/**
*
* A filter that returns only monitoring schedules modified after a specified time.
*
*/
private java.util.Date lastModifiedTimeAfter;
/**
*
* A filter that returns only monitoring schedules modified before a specified time.
*
*/
private String statusEquals;
/**
*
* Gets a list of the monitoring schedules for the specified monitoring job definition.
*
*/
private String monitoringJobDefinitionName;
/**
*
* A filter that returns only the monitoring schedules for the specified monitoring type.
*
*/
private String monitoringTypeEquals;
/**
*
* Name of a specific endpoint to fetch schedules for.
*
*
* @param endpointName
* Name of a specific endpoint to fetch schedules for.
*/
public void setEndpointName(String endpointName) {
this.endpointName = endpointName;
}
/**
*
* Name of a specific endpoint to fetch schedules for.
*
*
* @return Name of a specific endpoint to fetch schedules for.
*/
public String getEndpointName() {
return this.endpointName;
}
/**
*
* Name of a specific endpoint to fetch schedules for.
*
*
* @param endpointName
* Name of a specific endpoint to fetch schedules for.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListMonitoringSchedulesRequest withEndpointName(String endpointName) {
setEndpointName(endpointName);
return this;
}
/**
*
* Whether to sort the results by the Status, CreationTime, or ScheduledTime
* field. The default is CreationTime.
*
*
* @param sortBy
* Whether to sort the results by the Status, CreationTime, or
* ScheduledTime field. The default is CreationTime.
* @see MonitoringScheduleSortKey
*/
public void setSortBy(String sortBy) {
this.sortBy = sortBy;
}
/**
*
* Whether to sort the results by the Status, CreationTime, or ScheduledTime
* field. The default is CreationTime.
*
*
* @return Whether to sort the results by the Status, CreationTime, or
* ScheduledTime field. The default is CreationTime.
* @see MonitoringScheduleSortKey
*/
public String getSortBy() {
return this.sortBy;
}
/**
*
* Whether to sort the results by the Status, CreationTime, or ScheduledTime
* field. The default is CreationTime.
*
*
* @param sortBy
* Whether to sort the results by the Status, CreationTime, or
* ScheduledTime field. The default is CreationTime.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MonitoringScheduleSortKey
*/
public ListMonitoringSchedulesRequest withSortBy(String sortBy) {
setSortBy(sortBy);
return this;
}
/**
*
* Whether to sort the results by the Status, CreationTime, or ScheduledTime
* field. The default is CreationTime.
*
*
* @param sortBy
* Whether to sort the results by the Status, CreationTime, or
* ScheduledTime field. The default is CreationTime.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MonitoringScheduleSortKey
*/
public ListMonitoringSchedulesRequest withSortBy(MonitoringScheduleSortKey sortBy) {
this.sortBy = sortBy.toString();
return this;
}
/**
*
* Whether to sort the results in Ascending or Descending order. The default is
* Descending.
*
*
* @param sortOrder
* Whether to sort the results in Ascending or Descending order. The default is
* Descending.
* @see SortOrder
*/
public void setSortOrder(String sortOrder) {
this.sortOrder = sortOrder;
}
/**
*
* Whether to sort the results in Ascending or Descending order. The default is
* Descending.
*
*
* @return Whether to sort the results in Ascending or Descending order. The default is
* Descending.
* @see SortOrder
*/
public String getSortOrder() {
return this.sortOrder;
}
/**
*
* Whether to sort the results in Ascending or Descending order. The default is
* Descending.
*
*
* @param sortOrder
* Whether to sort the results in Ascending or Descending order. The default is
* Descending.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SortOrder
*/
public ListMonitoringSchedulesRequest withSortOrder(String sortOrder) {
setSortOrder(sortOrder);
return this;
}
/**
*
* Whether to sort the results in Ascending or Descending order. The default is
* Descending.
*
*
* @param sortOrder
* Whether to sort the results in Ascending or Descending order. The default is
* Descending.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SortOrder
*/
public ListMonitoringSchedulesRequest withSortOrder(SortOrder sortOrder) {
this.sortOrder = sortOrder.toString();
return this;
}
/**
*
* The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next
* request.
*
*
* @param nextToken
* The token returned if the response is truncated. To retrieve the next set of job executions, use it in the
* next request.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next
* request.
*
*
* @return The token returned if the response is truncated. To retrieve the next set of job executions, use it in
* the next request.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next
* request.
*
*
* @param nextToken
* The token returned if the response is truncated. To retrieve the next set of job executions, use it in the
* next request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListMonitoringSchedulesRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The maximum number of jobs to return in the response. The default value is 10.
*
*
* @param maxResults
* The maximum number of jobs to return in the response. The default value is 10.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of jobs to return in the response. The default value is 10.
*
*
* @return The maximum number of jobs to return in the response. The default value is 10.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of jobs to return in the response. The default value is 10.
*
*
* @param maxResults
* The maximum number of jobs to return in the response. The default value is 10.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListMonitoringSchedulesRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* Filter for monitoring schedules whose name contains a specified string.
*
*
* @param nameContains
* Filter for monitoring schedules whose name contains a specified string.
*/
public void setNameContains(String nameContains) {
this.nameContains = nameContains;
}
/**
*
* Filter for monitoring schedules whose name contains a specified string.
*
*
* @return Filter for monitoring schedules whose name contains a specified string.
*/
public String getNameContains() {
return this.nameContains;
}
/**
*
* Filter for monitoring schedules whose name contains a specified string.
*
*
* @param nameContains
* Filter for monitoring schedules whose name contains a specified string.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListMonitoringSchedulesRequest withNameContains(String nameContains) {
setNameContains(nameContains);
return this;
}
/**
*
* A filter that returns only monitoring schedules created before a specified time.
*
*
* @param creationTimeBefore
* A filter that returns only monitoring schedules created before a specified time.
*/
public void setCreationTimeBefore(java.util.Date creationTimeBefore) {
this.creationTimeBefore = creationTimeBefore;
}
/**
*
* A filter that returns only monitoring schedules created before a specified time.
*
*
* @return A filter that returns only monitoring schedules created before a specified time.
*/
public java.util.Date getCreationTimeBefore() {
return this.creationTimeBefore;
}
/**
*
* A filter that returns only monitoring schedules created before a specified time.
*
*
* @param creationTimeBefore
* A filter that returns only monitoring schedules created before a specified time.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListMonitoringSchedulesRequest withCreationTimeBefore(java.util.Date creationTimeBefore) {
setCreationTimeBefore(creationTimeBefore);
return this;
}
/**
*
* A filter that returns only monitoring schedules created after a specified time.
*
*
* @param creationTimeAfter
* A filter that returns only monitoring schedules created after a specified time.
*/
public void setCreationTimeAfter(java.util.Date creationTimeAfter) {
this.creationTimeAfter = creationTimeAfter;
}
/**
*
* A filter that returns only monitoring schedules created after a specified time.
*
*
* @return A filter that returns only monitoring schedules created after a specified time.
*/
public java.util.Date getCreationTimeAfter() {
return this.creationTimeAfter;
}
/**
*
* A filter that returns only monitoring schedules created after a specified time.
*
*
* @param creationTimeAfter
* A filter that returns only monitoring schedules created after a specified time.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListMonitoringSchedulesRequest withCreationTimeAfter(java.util.Date creationTimeAfter) {
setCreationTimeAfter(creationTimeAfter);
return this;
}
/**
*
* A filter that returns only monitoring schedules modified before a specified time.
*
*
* @param lastModifiedTimeBefore
* A filter that returns only monitoring schedules modified before a specified time.
*/
public void setLastModifiedTimeBefore(java.util.Date lastModifiedTimeBefore) {
this.lastModifiedTimeBefore = lastModifiedTimeBefore;
}
/**
*
* A filter that returns only monitoring schedules modified before a specified time.
*
*
* @return A filter that returns only monitoring schedules modified before a specified time.
*/
public java.util.Date getLastModifiedTimeBefore() {
return this.lastModifiedTimeBefore;
}
/**
*
* A filter that returns only monitoring schedules modified before a specified time.
*
*
* @param lastModifiedTimeBefore
* A filter that returns only monitoring schedules modified before a specified time.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListMonitoringSchedulesRequest withLastModifiedTimeBefore(java.util.Date lastModifiedTimeBefore) {
setLastModifiedTimeBefore(lastModifiedTimeBefore);
return this;
}
/**
*
* A filter that returns only monitoring schedules modified after a specified time.
*
*
* @param lastModifiedTimeAfter
* A filter that returns only monitoring schedules modified after a specified time.
*/
public void setLastModifiedTimeAfter(java.util.Date lastModifiedTimeAfter) {
this.lastModifiedTimeAfter = lastModifiedTimeAfter;
}
/**
*
* A filter that returns only monitoring schedules modified after a specified time.
*
*
* @return A filter that returns only monitoring schedules modified after a specified time.
*/
public java.util.Date getLastModifiedTimeAfter() {
return this.lastModifiedTimeAfter;
}
/**
*
* A filter that returns only monitoring schedules modified after a specified time.
*
*
* @param lastModifiedTimeAfter
* A filter that returns only monitoring schedules modified after a specified time.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListMonitoringSchedulesRequest withLastModifiedTimeAfter(java.util.Date lastModifiedTimeAfter) {
setLastModifiedTimeAfter(lastModifiedTimeAfter);
return this;
}
/**
*
* A filter that returns only monitoring schedules modified before a specified time.
*
*
* @param statusEquals
* A filter that returns only monitoring schedules modified before a specified time.
* @see ScheduleStatus
*/
public void setStatusEquals(String statusEquals) {
this.statusEquals = statusEquals;
}
/**
*
* A filter that returns only monitoring schedules modified before a specified time.
*
*
* @return A filter that returns only monitoring schedules modified before a specified time.
* @see ScheduleStatus
*/
public String getStatusEquals() {
return this.statusEquals;
}
/**
*
* A filter that returns only monitoring schedules modified before a specified time.
*
*
* @param statusEquals
* A filter that returns only monitoring schedules modified before a specified time.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ScheduleStatus
*/
public ListMonitoringSchedulesRequest withStatusEquals(String statusEquals) {
setStatusEquals(statusEquals);
return this;
}
/**
*
* A filter that returns only monitoring schedules modified before a specified time.
*
*
* @param statusEquals
* A filter that returns only monitoring schedules modified before a specified time.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ScheduleStatus
*/
public ListMonitoringSchedulesRequest withStatusEquals(ScheduleStatus statusEquals) {
this.statusEquals = statusEquals.toString();
return this;
}
/**
*
* Gets a list of the monitoring schedules for the specified monitoring job definition.
*
*
* @param monitoringJobDefinitionName
* Gets a list of the monitoring schedules for the specified monitoring job definition.
*/
public void setMonitoringJobDefinitionName(String monitoringJobDefinitionName) {
this.monitoringJobDefinitionName = monitoringJobDefinitionName;
}
/**
*
* Gets a list of the monitoring schedules for the specified monitoring job definition.
*
*
* @return Gets a list of the monitoring schedules for the specified monitoring job definition.
*/
public String getMonitoringJobDefinitionName() {
return this.monitoringJobDefinitionName;
}
/**
*
* Gets a list of the monitoring schedules for the specified monitoring job definition.
*
*
* @param monitoringJobDefinitionName
* Gets a list of the monitoring schedules for the specified monitoring job definition.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListMonitoringSchedulesRequest withMonitoringJobDefinitionName(String monitoringJobDefinitionName) {
setMonitoringJobDefinitionName(monitoringJobDefinitionName);
return this;
}
/**
*
* A filter that returns only the monitoring schedules for the specified monitoring type.
*
*
* @param monitoringTypeEquals
* A filter that returns only the monitoring schedules for the specified monitoring type.
* @see MonitoringType
*/
public void setMonitoringTypeEquals(String monitoringTypeEquals) {
this.monitoringTypeEquals = monitoringTypeEquals;
}
/**
*
* A filter that returns only the monitoring schedules for the specified monitoring type.
*
*
* @return A filter that returns only the monitoring schedules for the specified monitoring type.
* @see MonitoringType
*/
public String getMonitoringTypeEquals() {
return this.monitoringTypeEquals;
}
/**
*
* A filter that returns only the monitoring schedules for the specified monitoring type.
*
*
* @param monitoringTypeEquals
* A filter that returns only the monitoring schedules for the specified monitoring type.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MonitoringType
*/
public ListMonitoringSchedulesRequest withMonitoringTypeEquals(String monitoringTypeEquals) {
setMonitoringTypeEquals(monitoringTypeEquals);
return this;
}
/**
*
* A filter that returns only the monitoring schedules for the specified monitoring type.
*
*
* @param monitoringTypeEquals
* A filter that returns only the monitoring schedules for the specified monitoring type.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MonitoringType
*/
public ListMonitoringSchedulesRequest withMonitoringTypeEquals(MonitoringType monitoringTypeEquals) {
this.monitoringTypeEquals = monitoringTypeEquals.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 (getEndpointName() != null)
sb.append("EndpointName: ").append(getEndpointName()).append(",");
if (getSortBy() != null)
sb.append("SortBy: ").append(getSortBy()).append(",");
if (getSortOrder() != null)
sb.append("SortOrder: ").append(getSortOrder()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getNameContains() != null)
sb.append("NameContains: ").append(getNameContains()).append(",");
if (getCreationTimeBefore() != null)
sb.append("CreationTimeBefore: ").append(getCreationTimeBefore()).append(",");
if (getCreationTimeAfter() != null)
sb.append("CreationTimeAfter: ").append(getCreationTimeAfter()).append(",");
if (getLastModifiedTimeBefore() != null)
sb.append("LastModifiedTimeBefore: ").append(getLastModifiedTimeBefore()).append(",");
if (getLastModifiedTimeAfter() != null)
sb.append("LastModifiedTimeAfter: ").append(getLastModifiedTimeAfter()).append(",");
if (getStatusEquals() != null)
sb.append("StatusEquals: ").append(getStatusEquals()).append(",");
if (getMonitoringJobDefinitionName() != null)
sb.append("MonitoringJobDefinitionName: ").append(getMonitoringJobDefinitionName()).append(",");
if (getMonitoringTypeEquals() != null)
sb.append("MonitoringTypeEquals: ").append(getMonitoringTypeEquals());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListMonitoringSchedulesRequest == false)
return false;
ListMonitoringSchedulesRequest other = (ListMonitoringSchedulesRequest) obj;
if (other.getEndpointName() == null ^ this.getEndpointName() == null)
return false;
if (other.getEndpointName() != null && other.getEndpointName().equals(this.getEndpointName()) == 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;
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.getNameContains() == null ^ this.getNameContains() == null)
return false;
if (other.getNameContains() != null && other.getNameContains().equals(this.getNameContains()) == 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.getCreationTimeAfter() == null ^ this.getCreationTimeAfter() == null)
return false;
if (other.getCreationTimeAfter() != null && other.getCreationTimeAfter().equals(this.getCreationTimeAfter()) == false)
return false;
if (other.getLastModifiedTimeBefore() == null ^ this.getLastModifiedTimeBefore() == null)
return false;
if (other.getLastModifiedTimeBefore() != null && other.getLastModifiedTimeBefore().equals(this.getLastModifiedTimeBefore()) == false)
return false;
if (other.getLastModifiedTimeAfter() == null ^ this.getLastModifiedTimeAfter() == null)
return false;
if (other.getLastModifiedTimeAfter() != null && other.getLastModifiedTimeAfter().equals(this.getLastModifiedTimeAfter()) == 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.getMonitoringJobDefinitionName() == null ^ this.getMonitoringJobDefinitionName() == null)
return false;
if (other.getMonitoringJobDefinitionName() != null && other.getMonitoringJobDefinitionName().equals(this.getMonitoringJobDefinitionName()) == false)
return false;
if (other.getMonitoringTypeEquals() == null ^ this.getMonitoringTypeEquals() == null)
return false;
if (other.getMonitoringTypeEquals() != null && other.getMonitoringTypeEquals().equals(this.getMonitoringTypeEquals()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getEndpointName() == null) ? 0 : getEndpointName().hashCode());
hashCode = prime * hashCode + ((getSortBy() == null) ? 0 : getSortBy().hashCode());
hashCode = prime * hashCode + ((getSortOrder() == null) ? 0 : getSortOrder().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getNameContains() == null) ? 0 : getNameContains().hashCode());
hashCode = prime * hashCode + ((getCreationTimeBefore() == null) ? 0 : getCreationTimeBefore().hashCode());
hashCode = prime * hashCode + ((getCreationTimeAfter() == null) ? 0 : getCreationTimeAfter().hashCode());
hashCode = prime * hashCode + ((getLastModifiedTimeBefore() == null) ? 0 : getLastModifiedTimeBefore().hashCode());
hashCode = prime * hashCode + ((getLastModifiedTimeAfter() == null) ? 0 : getLastModifiedTimeAfter().hashCode());
hashCode = prime * hashCode + ((getStatusEquals() == null) ? 0 : getStatusEquals().hashCode());
hashCode = prime * hashCode + ((getMonitoringJobDefinitionName() == null) ? 0 : getMonitoringJobDefinitionName().hashCode());
hashCode = prime * hashCode + ((getMonitoringTypeEquals() == null) ? 0 : getMonitoringTypeEquals().hashCode());
return hashCode;
}
@Override
public ListMonitoringSchedulesRequest clone() {
return (ListMonitoringSchedulesRequest) super.clone();
}
}