com.amazonaws.services.ec2.model.DescribeScheduledInstancesRequest Maven / Gradle / Ivy
Show all versions of aws-android-sdk-ec2 Show documentation
/*
* Copyright 2010-2016 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 com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.DescribeScheduledInstancesRequestMarshaller;
/**
* Container for the parameters to the {@link com.amazonaws.services.ec2.AmazonEC2#describeScheduledInstances(DescribeScheduledInstancesRequest) DescribeScheduledInstances operation}.
*
* Describes one or more of your Scheduled Instances.
*
*
* @see com.amazonaws.services.ec2.AmazonEC2#describeScheduledInstances(DescribeScheduledInstancesRequest)
*/
public class DescribeScheduledInstancesRequest extends AmazonWebServiceRequest implements Serializable, DryRunSupportedRequest {
/**
* One or more Scheduled Instance IDs.
*/
private com.amazonaws.internal.ListWithAutoConstructFlag scheduledInstanceIds;
/**
* The time period for the first schedule to start.
*/
private SlotStartTimeRangeRequest slotStartTimeRange;
/**
* The token for the next set of results.
*/
private String nextToken;
/**
* 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;
/**
* One or more filters. -
availability-zone - The
* Availability Zone (for example, us-west-2a).
-
*
instance-type - The instance type (for example,
* c4.large).
-
network-platform -
* The network platform (EC2-Classic or
* EC2-VPC).
-
platform - The
* platform (Linux/UNIX or Windows).
*
*/
private com.amazonaws.internal.ListWithAutoConstructFlag filters;
/**
* One or more Scheduled Instance IDs.
*
* @return One or more Scheduled Instance IDs.
*/
public java.util.List getScheduledInstanceIds() {
if (scheduledInstanceIds == null) {
scheduledInstanceIds = new com.amazonaws.internal.ListWithAutoConstructFlag();
scheduledInstanceIds.setAutoConstruct(true);
}
return scheduledInstanceIds;
}
/**
* One or more Scheduled Instance IDs.
*
* @param scheduledInstanceIds One or more Scheduled Instance IDs.
*/
public void setScheduledInstanceIds(java.util.Collection scheduledInstanceIds) {
if (scheduledInstanceIds == null) {
this.scheduledInstanceIds = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag scheduledInstanceIdsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(scheduledInstanceIds.size());
scheduledInstanceIdsCopy.addAll(scheduledInstanceIds);
this.scheduledInstanceIds = scheduledInstanceIdsCopy;
}
/**
* One or more Scheduled Instance IDs.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param scheduledInstanceIds One or more Scheduled Instance IDs.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeScheduledInstancesRequest withScheduledInstanceIds(String... scheduledInstanceIds) {
if (getScheduledInstanceIds() == null) setScheduledInstanceIds(new java.util.ArrayList(scheduledInstanceIds.length));
for (String value : scheduledInstanceIds) {
getScheduledInstanceIds().add(value);
}
return this;
}
/**
* One or more Scheduled Instance IDs.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param scheduledInstanceIds One or more Scheduled Instance IDs.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeScheduledInstancesRequest withScheduledInstanceIds(java.util.Collection scheduledInstanceIds) {
if (scheduledInstanceIds == null) {
this.scheduledInstanceIds = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag scheduledInstanceIdsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(scheduledInstanceIds.size());
scheduledInstanceIdsCopy.addAll(scheduledInstanceIds);
this.scheduledInstanceIds = scheduledInstanceIdsCopy;
}
return this;
}
/**
* The time period for the first schedule to start.
*
* @return The time period for the first schedule to start.
*/
public SlotStartTimeRangeRequest getSlotStartTimeRange() {
return slotStartTimeRange;
}
/**
* 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.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param slotStartTimeRange The time period for the first schedule to start.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeScheduledInstancesRequest withSlotStartTimeRange(SlotStartTimeRangeRequest slotStartTimeRange) {
this.slotStartTimeRange = slotStartTimeRange;
return this;
}
/**
* The token for the next set of results.
*
* @return The token for the next set of results.
*/
public String getNextToken() {
return nextToken;
}
/**
* 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.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param nextToken The token for the next set of results.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeScheduledInstancesRequest withNextToken(String nextToken) {
this.nextToken = nextToken;
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.
*
* @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 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.
*/
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.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @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 A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeScheduledInstancesRequest withMaxResults(Integer maxResults) {
this.maxResults = maxResults;
return this;
}
/**
* One or more filters.
-
availability-zone - The
* Availability Zone (for example, us-west-2a).
-
*
instance-type - The instance type (for example,
* c4.large).
-
network-platform -
* The network platform (EC2-Classic or
* EC2-VPC).
-
platform - The
* platform (Linux/UNIX or Windows).
*
*
* @return One or more filters. -
availability-zone - The
* Availability Zone (for example, us-west-2a).
-
*
instance-type - The instance type (for example,
* c4.large).
-
network-platform -
* The network platform (EC2-Classic or
* EC2-VPC).
-
platform - The
* platform (Linux/UNIX or Windows).
*
*/
public java.util.List getFilters() {
if (filters == null) {
filters = new com.amazonaws.internal.ListWithAutoConstructFlag();
filters.setAutoConstruct(true);
}
return filters;
}
/**
* One or more filters. -
availability-zone - The
* Availability Zone (for example, us-west-2a).
-
*
instance-type - The instance type (for example,
* c4.large).
-
network-platform -
* The network platform (EC2-Classic or
* EC2-VPC).
-
platform - The
* platform (Linux/UNIX or Windows).
*
*
* @param filters One or more filters. -
availability-zone - The
* Availability Zone (for example, us-west-2a).
-
*
instance-type - The instance type (for example,
* c4.large).
-
network-platform -
* The network platform (EC2-Classic or
* EC2-VPC).
-
platform - The
* platform (Linux/UNIX or Windows).
*
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag filtersCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(filters.size());
filtersCopy.addAll(filters);
this.filters = filtersCopy;
}
/**
* One or more filters. -
availability-zone - The
* Availability Zone (for example, us-west-2a).
-
*
instance-type - The instance type (for example,
* c4.large).
-
network-platform -
* The network platform (EC2-Classic or
* EC2-VPC).
-
platform - The
* platform (Linux/UNIX or Windows).
*
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param filters One or more filters.
-
availability-zone - The
* Availability Zone (for example, us-west-2a).
-
*
instance-type - The instance type (for example,
* c4.large).
-
network-platform -
* The network platform (EC2-Classic or
* EC2-VPC).
-
platform - The
* platform (Linux/UNIX or Windows).
*
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeScheduledInstancesRequest withFilters(Filter... filters) {
if (getFilters() == null) setFilters(new java.util.ArrayList(filters.length));
for (Filter value : filters) {
getFilters().add(value);
}
return this;
}
/**
* One or more filters. -
availability-zone - The
* Availability Zone (for example, us-west-2a).
-
*
instance-type - The instance type (for example,
* c4.large).
-
network-platform -
* The network platform (EC2-Classic or
* EC2-VPC).
-
platform - The
* platform (Linux/UNIX or Windows).
*
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param filters One or more filters.
-
availability-zone - The
* Availability Zone (for example, us-west-2a).
-
*
instance-type - The instance type (for example,
* c4.large).
-
network-platform -
* The network platform (EC2-Classic or
* EC2-VPC).
-
platform - The
* platform (Linux/UNIX or Windows).
*
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeScheduledInstancesRequest withFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag filtersCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(filters.size());
filtersCopy.addAll(filters);
this.filters = filtersCopy;
}
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; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getScheduledInstanceIds() != null) sb.append("ScheduledInstanceIds: " + getScheduledInstanceIds() + ",");
if (getSlotStartTimeRange() != null) sb.append("SlotStartTimeRange: " + getSlotStartTimeRange() + ",");
if (getNextToken() != null) sb.append("NextToken: " + getNextToken() + ",");
if (getMaxResults() != null) sb.append("MaxResults: " + getMaxResults() + ",");
if (getFilters() != null) sb.append("Filters: " + getFilters() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getScheduledInstanceIds() == null) ? 0 : getScheduledInstanceIds().hashCode());
hashCode = prime * hashCode + ((getSlotStartTimeRange() == null) ? 0 : getSlotStartTimeRange().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
return hashCode;
}
@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.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;
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.getFilters() == null ^ this.getFilters() == null) return false;
if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false) return false;
return true;
}
}