com.amazonaws.services.redshift.model.DescribeScheduledActionsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-redshift 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.redshift.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 DescribeScheduledActionsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name of the scheduled action to retrieve.
*
*/
private String scheduledActionName;
/**
*
* The type of the scheduled actions to retrieve.
*
*/
private String targetActionType;
/**
*
* The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have invocations
* after this time are retrieved.
*
*/
private java.util.Date startTime;
/**
*
* The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations
* before this time are retrieved.
*
*/
private java.util.Date endTime;
/**
*
* If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.
*
*/
private Boolean active;
/**
*
* List of scheduled action filters.
*
*/
private com.amazonaws.internal.SdkInternalList filters;
/**
*
* An optional parameter that specifies the starting point to return a set of response records. When the results of
* a DescribeScheduledActions request exceed the value specified in MaxRecords, Amazon Web
* Services returns a value in the Marker field of the response. You can retrieve the next set of
* response records by providing the returned marker value in the Marker parameter and retrying the
* request.
*
*/
private String marker;
/**
*
* The maximum number of response records to return in each call. If the number of remaining response records
* exceeds the specified MaxRecords value, a value is returned in a marker field of the
* response. You can retrieve the next set of records by retrying the command with the returned marker value.
*
*
* Default: 100
*
*
* Constraints: minimum 20, maximum 100.
*
*/
private Integer maxRecords;
/**
*
* The name of the scheduled action to retrieve.
*
*
* @param scheduledActionName
* The name of the scheduled action to retrieve.
*/
public void setScheduledActionName(String scheduledActionName) {
this.scheduledActionName = scheduledActionName;
}
/**
*
* The name of the scheduled action to retrieve.
*
*
* @return The name of the scheduled action to retrieve.
*/
public String getScheduledActionName() {
return this.scheduledActionName;
}
/**
*
* The name of the scheduled action to retrieve.
*
*
* @param scheduledActionName
* The name of the scheduled action to retrieve.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeScheduledActionsRequest withScheduledActionName(String scheduledActionName) {
setScheduledActionName(scheduledActionName);
return this;
}
/**
*
* The type of the scheduled actions to retrieve.
*
*
* @param targetActionType
* The type of the scheduled actions to retrieve.
* @see ScheduledActionTypeValues
*/
public void setTargetActionType(String targetActionType) {
this.targetActionType = targetActionType;
}
/**
*
* The type of the scheduled actions to retrieve.
*
*
* @return The type of the scheduled actions to retrieve.
* @see ScheduledActionTypeValues
*/
public String getTargetActionType() {
return this.targetActionType;
}
/**
*
* The type of the scheduled actions to retrieve.
*
*
* @param targetActionType
* The type of the scheduled actions to retrieve.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ScheduledActionTypeValues
*/
public DescribeScheduledActionsRequest withTargetActionType(String targetActionType) {
setTargetActionType(targetActionType);
return this;
}
/**
*
* The type of the scheduled actions to retrieve.
*
*
* @param targetActionType
* The type of the scheduled actions to retrieve.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ScheduledActionTypeValues
*/
public DescribeScheduledActionsRequest withTargetActionType(ScheduledActionTypeValues targetActionType) {
this.targetActionType = targetActionType.toString();
return this;
}
/**
*
* The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have invocations
* after this time are retrieved.
*
*
* @param startTime
* The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have
* invocations after this time are retrieved.
*/
public void setStartTime(java.util.Date startTime) {
this.startTime = startTime;
}
/**
*
* The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have invocations
* after this time are retrieved.
*
*
* @return The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have
* invocations after this time are retrieved.
*/
public java.util.Date getStartTime() {
return this.startTime;
}
/**
*
* The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have invocations
* after this time are retrieved.
*
*
* @param startTime
* The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have
* invocations after this time are retrieved.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeScheduledActionsRequest withStartTime(java.util.Date startTime) {
setStartTime(startTime);
return this;
}
/**
*
* The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations
* before this time are retrieved.
*
*
* @param endTime
* The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have
* invocations before this time are retrieved.
*/
public void setEndTime(java.util.Date endTime) {
this.endTime = endTime;
}
/**
*
* The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations
* before this time are retrieved.
*
*
* @return The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have
* invocations before this time are retrieved.
*/
public java.util.Date getEndTime() {
return this.endTime;
}
/**
*
* The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations
* before this time are retrieved.
*
*
* @param endTime
* The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have
* invocations before this time are retrieved.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeScheduledActionsRequest withEndTime(java.util.Date endTime) {
setEndTime(endTime);
return this;
}
/**
*
* If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.
*
*
* @param active
* If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.
*/
public void setActive(Boolean active) {
this.active = active;
}
/**
*
* If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.
*
*
* @return If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.
*/
public Boolean getActive() {
return this.active;
}
/**
*
* If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.
*
*
* @param active
* If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeScheduledActionsRequest withActive(Boolean active) {
setActive(active);
return this;
}
/**
*
* If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.
*
*
* @return If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.
*/
public Boolean isActive() {
return this.active;
}
/**
*
* List of scheduled action filters.
*
*
* @return List of scheduled action filters.
*/
public java.util.List getFilters() {
if (filters == null) {
filters = new com.amazonaws.internal.SdkInternalList();
}
return filters;
}
/**
*
* List of scheduled action filters.
*
*
* @param filters
* List of scheduled action filters.
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
this.filters = new com.amazonaws.internal.SdkInternalList(filters);
}
/**
*
* List of scheduled action filters.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setFilters(java.util.Collection)} or {@link #withFilters(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param filters
* List of scheduled action filters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeScheduledActionsRequest withFilters(ScheduledActionFilter... filters) {
if (this.filters == null) {
setFilters(new com.amazonaws.internal.SdkInternalList(filters.length));
}
for (ScheduledActionFilter ele : filters) {
this.filters.add(ele);
}
return this;
}
/**
*
* List of scheduled action filters.
*
*
* @param filters
* List of scheduled action filters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeScheduledActionsRequest withFilters(java.util.Collection filters) {
setFilters(filters);
return this;
}
/**
*
* An optional parameter that specifies the starting point to return a set of response records. When the results of
* a DescribeScheduledActions request exceed the value specified in MaxRecords, Amazon Web
* Services returns a value in the Marker field of the response. You can retrieve the next set of
* response records by providing the returned marker value in the Marker parameter and retrying the
* request.
*
*
* @param marker
* An optional parameter that specifies the starting point to return a set of response records. When the
* results of a DescribeScheduledActions request exceed the value specified in MaxRecords
* , Amazon Web Services returns a value in the Marker field of the response. You can retrieve
* the next set of response records by providing the returned marker value in the Marker
* parameter and retrying the request.
*/
public void setMarker(String marker) {
this.marker = marker;
}
/**
*
* An optional parameter that specifies the starting point to return a set of response records. When the results of
* a DescribeScheduledActions request exceed the value specified in MaxRecords, Amazon Web
* Services returns a value in the Marker field of the response. You can retrieve the next set of
* response records by providing the returned marker value in the Marker parameter and retrying the
* request.
*
*
* @return An optional parameter that specifies the starting point to return a set of response records. When the
* results of a DescribeScheduledActions request exceed the value specified in
* MaxRecords, Amazon Web Services returns a value in the Marker field of the
* response. You can retrieve the next set of response records by providing the returned marker value in the
* Marker parameter and retrying the request.
*/
public String getMarker() {
return this.marker;
}
/**
*
* An optional parameter that specifies the starting point to return a set of response records. When the results of
* a DescribeScheduledActions request exceed the value specified in MaxRecords, Amazon Web
* Services returns a value in the Marker field of the response. You can retrieve the next set of
* response records by providing the returned marker value in the Marker parameter and retrying the
* request.
*
*
* @param marker
* An optional parameter that specifies the starting point to return a set of response records. When the
* results of a DescribeScheduledActions request exceed the value specified in MaxRecords
* , Amazon Web Services returns a value in the Marker field of the response. You can retrieve
* the next set of response records by providing the returned marker value in the Marker
* parameter and retrying the request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeScheduledActionsRequest withMarker(String marker) {
setMarker(marker);
return this;
}
/**
*
* The maximum number of response records to return in each call. If the number of remaining response records
* exceeds the specified MaxRecords value, a value is returned in a marker field of the
* response. You can retrieve the next set of records by retrying the command with the returned marker value.
*
*
* Default: 100
*
*
* Constraints: minimum 20, maximum 100.
*
*
* @param maxRecords
* The maximum number of response records to return in each call. If the number of remaining response records
* exceeds the specified MaxRecords value, a value is returned in a marker field of
* the response. You can retrieve the next set of records by retrying the command with the returned marker
* value.
*
* Default: 100
*
*
* Constraints: minimum 20, maximum 100.
*/
public void setMaxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
}
/**
*
* The maximum number of response records to return in each call. If the number of remaining response records
* exceeds the specified MaxRecords value, a value is returned in a marker field of the
* response. You can retrieve the next set of records by retrying the command with the returned marker value.
*
*
* Default: 100
*
*
* Constraints: minimum 20, maximum 100.
*
*
* @return The maximum number of response records to return in each call. If the number of remaining response
* records exceeds the specified MaxRecords value, a value is returned in a marker
* field of the response. You can retrieve the next set of records by retrying the command with the returned
* marker value.
*
* Default: 100
*
*
* Constraints: minimum 20, maximum 100.
*/
public Integer getMaxRecords() {
return this.maxRecords;
}
/**
*
* The maximum number of response records to return in each call. If the number of remaining response records
* exceeds the specified MaxRecords value, a value is returned in a marker field of the
* response. You can retrieve the next set of records by retrying the command with the returned marker value.
*
*
* Default: 100
*
*
* Constraints: minimum 20, maximum 100.
*
*
* @param maxRecords
* The maximum number of response records to return in each call. If the number of remaining response records
* exceeds the specified MaxRecords value, a value is returned in a marker field of
* the response. You can retrieve the next set of records by retrying the command with the returned marker
* value.
*
* Default: 100
*
*
* Constraints: minimum 20, maximum 100.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeScheduledActionsRequest withMaxRecords(Integer maxRecords) {
setMaxRecords(maxRecords);
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 (getScheduledActionName() != null)
sb.append("ScheduledActionName: ").append(getScheduledActionName()).append(",");
if (getTargetActionType() != null)
sb.append("TargetActionType: ").append(getTargetActionType()).append(",");
if (getStartTime() != null)
sb.append("StartTime: ").append(getStartTime()).append(",");
if (getEndTime() != null)
sb.append("EndTime: ").append(getEndTime()).append(",");
if (getActive() != null)
sb.append("Active: ").append(getActive()).append(",");
if (getFilters() != null)
sb.append("Filters: ").append(getFilters()).append(",");
if (getMarker() != null)
sb.append("Marker: ").append(getMarker()).append(",");
if (getMaxRecords() != null)
sb.append("MaxRecords: ").append(getMaxRecords());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeScheduledActionsRequest == false)
return false;
DescribeScheduledActionsRequest other = (DescribeScheduledActionsRequest) obj;
if (other.getScheduledActionName() == null ^ this.getScheduledActionName() == null)
return false;
if (other.getScheduledActionName() != null && other.getScheduledActionName().equals(this.getScheduledActionName()) == false)
return false;
if (other.getTargetActionType() == null ^ this.getTargetActionType() == null)
return false;
if (other.getTargetActionType() != null && other.getTargetActionType().equals(this.getTargetActionType()) == false)
return false;
if (other.getStartTime() == null ^ this.getStartTime() == null)
return false;
if (other.getStartTime() != null && other.getStartTime().equals(this.getStartTime()) == false)
return false;
if (other.getEndTime() == null ^ this.getEndTime() == null)
return false;
if (other.getEndTime() != null && other.getEndTime().equals(this.getEndTime()) == false)
return false;
if (other.getActive() == null ^ this.getActive() == null)
return false;
if (other.getActive() != null && other.getActive().equals(this.getActive()) == false)
return false;
if (other.getFilters() == null ^ this.getFilters() == null)
return false;
if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false)
return false;
if (other.getMarker() == null ^ this.getMarker() == null)
return false;
if (other.getMarker() != null && other.getMarker().equals(this.getMarker()) == false)
return false;
if (other.getMaxRecords() == null ^ this.getMaxRecords() == null)
return false;
if (other.getMaxRecords() != null && other.getMaxRecords().equals(this.getMaxRecords()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getScheduledActionName() == null) ? 0 : getScheduledActionName().hashCode());
hashCode = prime * hashCode + ((getTargetActionType() == null) ? 0 : getTargetActionType().hashCode());
hashCode = prime * hashCode + ((getStartTime() == null) ? 0 : getStartTime().hashCode());
hashCode = prime * hashCode + ((getEndTime() == null) ? 0 : getEndTime().hashCode());
hashCode = prime * hashCode + ((getActive() == null) ? 0 : getActive().hashCode());
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
hashCode = prime * hashCode + ((getMarker() == null) ? 0 : getMarker().hashCode());
hashCode = prime * hashCode + ((getMaxRecords() == null) ? 0 : getMaxRecords().hashCode());
return hashCode;
}
@Override
public DescribeScheduledActionsRequest clone() {
return (DescribeScheduledActionsRequest) super.clone();
}
}