com.amazonaws.services.ec2.model.DescribeScheduledInstancesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 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.ec2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.DescribeScheduledInstancesRequestMarshaller;
/**
*
* Contains the parameters for DescribeScheduledInstances.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeScheduledInstancesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable,
DryRunSupportedRequest {
/**
*
* The filters.
*
*
* -
*
* availability-zone - The Availability Zone (for example, us-west-2a).
*
*
* -
*
* instance-type - The instance type (for example, c4.large).
*
*
* -
*
* platform - The platform (Linux/UNIX or Windows).
*
*
*
*/
private com.amazonaws.internal.SdkInternalList filters;
/**
*
* The maximum number of results to return in a single call. This value can be between 5 and 300. The default value
* is 100. To retrieve the remaining results, make another call with the returned NextToken value.
*
*/
private Integer maxResults;
/**
*
* The token for the next set of results.
*
*/
private String nextToken;
/**
*
* The Scheduled Instance IDs.
*
*/
private com.amazonaws.internal.SdkInternalList scheduledInstanceIds;
/**
*
* The time period for the first schedule to start.
*
*/
private SlotStartTimeRangeRequest slotStartTimeRange;
/**
*
* The filters.
*
*
* -
*
* availability-zone - The Availability Zone (for example, us-west-2a).
*
*
* -
*
* instance-type - The instance type (for example, c4.large).
*
*
* -
*
* platform - The platform (Linux/UNIX or Windows).
*
*
*
*
* @return The filters.
*
* -
*
* availability-zone - The Availability Zone (for example, us-west-2a).
*
*
* -
*
* instance-type - The instance type (for example, c4.large).
*
*
* -
*
* platform - The platform (Linux/UNIX or Windows).
*
*
*/
public java.util.List getFilters() {
if (filters == null) {
filters = new com.amazonaws.internal.SdkInternalList();
}
return filters;
}
/**
*
* The filters.
*
*
* -
*
* availability-zone - The Availability Zone (for example, us-west-2a).
*
*
* -
*
* instance-type - The instance type (for example, c4.large).
*
*
* -
*
* platform - The platform (Linux/UNIX or Windows).
*
*
*
*
* @param filters
* The filters.
*
* -
*
* availability-zone - The Availability Zone (for example, us-west-2a).
*
*
* -
*
* instance-type - The instance type (for example, c4.large).
*
*
* -
*
* platform - The platform (Linux/UNIX or Windows).
*
*
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
this.filters = new com.amazonaws.internal.SdkInternalList(filters);
}
/**
*
* The filters.
*
*
* -
*
* availability-zone - The Availability Zone (for example, us-west-2a).
*
*
* -
*
* instance-type - The instance type (for example, c4.large).
*
*
* -
*
* platform - The platform (Linux/UNIX or Windows).
*
*
*
*
* 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
* The filters.
*
* -
*
* availability-zone - The Availability Zone (for example, us-west-2a).
*
*
* -
*
* instance-type - The instance type (for example, c4.large).
*
*
* -
*
* platform - The platform (Linux/UNIX or Windows).
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeScheduledInstancesRequest withFilters(Filter... filters) {
if (this.filters == null) {
setFilters(new com.amazonaws.internal.SdkInternalList(filters.length));
}
for (Filter ele : filters) {
this.filters.add(ele);
}
return this;
}
/**
*
* The filters.
*
*
* -
*
* availability-zone - The Availability Zone (for example, us-west-2a).
*
*
* -
*
* instance-type - The instance type (for example, c4.large).
*
*
* -
*
* platform - The platform (Linux/UNIX or Windows).
*
*
*
*
* @param filters
* The filters.
*
* -
*
* availability-zone - The Availability Zone (for example, us-west-2a).
*
*
* -
*
* instance-type - The instance type (for example, c4.large).
*
*
* -
*
* platform - The platform (Linux/UNIX or Windows).
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeScheduledInstancesRequest withFilters(java.util.Collection filters) {
setFilters(filters);
return this;
}
/**
*
* The maximum number of results to return in a single call. This value can be between 5 and 300. The default value
* is 100. To retrieve the remaining results, make another call with the returned NextToken value.
*
*
* @param maxResults
* The maximum number of results to return in a single call. This value can be between 5 and 300. The default
* value is 100. To retrieve the remaining results, make another call with the returned
* NextToken value.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of results to return in a single call. This value can be between 5 and 300. The default value
* is 100. To retrieve the remaining results, make another call with the returned NextToken value.
*
*
* @return The maximum number of results to return in a single call. This value can be between 5 and 300. The
* default value is 100. To retrieve the remaining results, make another call with the returned
* NextToken value.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of results to return in a single call. This value can be between 5 and 300. The default value
* is 100. To retrieve the remaining results, make another call with the returned NextToken value.
*
*
* @param maxResults
* The maximum number of results to return in a single call. This value can be between 5 and 300. The default
* value is 100. To retrieve the remaining results, make another call with the returned
* NextToken value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeScheduledInstancesRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* The token for the next set of results.
*
*
* @param nextToken
* The token for the next set of results.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The token for the next set of results.
*
*
* @return The token for the next set of results.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* The token for the next set of results.
*
*
* @param nextToken
* The token for the next set of results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeScheduledInstancesRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The Scheduled Instance IDs.
*
*
* @return The Scheduled Instance IDs.
*/
public java.util.List getScheduledInstanceIds() {
if (scheduledInstanceIds == null) {
scheduledInstanceIds = new com.amazonaws.internal.SdkInternalList();
}
return scheduledInstanceIds;
}
/**
*
* The Scheduled Instance IDs.
*
*
* @param scheduledInstanceIds
* The Scheduled Instance IDs.
*/
public void setScheduledInstanceIds(java.util.Collection scheduledInstanceIds) {
if (scheduledInstanceIds == null) {
this.scheduledInstanceIds = null;
return;
}
this.scheduledInstanceIds = new com.amazonaws.internal.SdkInternalList(scheduledInstanceIds);
}
/**
*
* The Scheduled Instance IDs.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setScheduledInstanceIds(java.util.Collection)} or {@link #withScheduledInstanceIds(java.util.Collection)}
* if you want to override the existing values.
*
*
* @param scheduledInstanceIds
* The Scheduled Instance IDs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeScheduledInstancesRequest withScheduledInstanceIds(String... scheduledInstanceIds) {
if (this.scheduledInstanceIds == null) {
setScheduledInstanceIds(new com.amazonaws.internal.SdkInternalList(scheduledInstanceIds.length));
}
for (String ele : scheduledInstanceIds) {
this.scheduledInstanceIds.add(ele);
}
return this;
}
/**
*
* The Scheduled Instance IDs.
*
*
* @param scheduledInstanceIds
* The Scheduled Instance IDs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeScheduledInstancesRequest withScheduledInstanceIds(java.util.Collection scheduledInstanceIds) {
setScheduledInstanceIds(scheduledInstanceIds);
return this;
}
/**
*
* The time period for the first schedule to start.
*
*
* @param slotStartTimeRange
* The time period for the first schedule to start.
*/
public void setSlotStartTimeRange(SlotStartTimeRangeRequest slotStartTimeRange) {
this.slotStartTimeRange = slotStartTimeRange;
}
/**
*
* The time period for the first schedule to start.
*
*
* @return The time period for the first schedule to start.
*/
public SlotStartTimeRangeRequest getSlotStartTimeRange() {
return this.slotStartTimeRange;
}
/**
*
* The time period for the first schedule to start.
*
*
* @param slotStartTimeRange
* The time period for the first schedule to start.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeScheduledInstancesRequest withSlotStartTimeRange(SlotStartTimeRangeRequest slotStartTimeRange) {
setSlotStartTimeRange(slotStartTimeRange);
return this;
}
/**
* This method is intended for internal use only. Returns the marshaled request configured with additional
* parameters to enable operation dry-run.
*/
@Override
public Request getDryRunRequest() {
Request request = new DescribeScheduledInstancesRequestMarshaller().marshall(this);
request.addParameter("DryRun", Boolean.toString(true));
return request;
}
/**
* 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 (getFilters() != null)
sb.append("Filters: ").append(getFilters()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getScheduledInstanceIds() != null)
sb.append("ScheduledInstanceIds: ").append(getScheduledInstanceIds()).append(",");
if (getSlotStartTimeRange() != null)
sb.append("SlotStartTimeRange: ").append(getSlotStartTimeRange());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeScheduledInstancesRequest == false)
return false;
DescribeScheduledInstancesRequest other = (DescribeScheduledInstancesRequest) obj;
if (other.getFilters() == null ^ this.getFilters() == null)
return false;
if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == 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;
if (other.getScheduledInstanceIds() == null ^ this.getScheduledInstanceIds() == null)
return false;
if (other.getScheduledInstanceIds() != null && other.getScheduledInstanceIds().equals(this.getScheduledInstanceIds()) == false)
return false;
if (other.getSlotStartTimeRange() == null ^ this.getSlotStartTimeRange() == null)
return false;
if (other.getSlotStartTimeRange() != null && other.getSlotStartTimeRange().equals(this.getSlotStartTimeRange()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getScheduledInstanceIds() == null) ? 0 : getScheduledInstanceIds().hashCode());
hashCode = prime * hashCode + ((getSlotStartTimeRange() == null) ? 0 : getSlotStartTimeRange().hashCode());
return hashCode;
}
@Override
public DescribeScheduledInstancesRequest clone() {
return (DescribeScheduledInstancesRequest) super.clone();
}
}