Class DescribeScheduledInstancesRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.ec2.model.DescribeScheduledInstancesRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,DryRunSupportedRequest<DescribeScheduledInstancesRequest>
,Serializable
,Cloneable
public class DescribeScheduledInstancesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest<DescribeScheduledInstancesRequest>
Contains the parameters for DescribeScheduledInstances.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description DescribeScheduledInstancesRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DescribeScheduledInstancesRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
Request<DescribeScheduledInstancesRequest>
getDryRunRequest()
This method is intended for internal use only.List<Filter>
getFilters()
One or more filters.Integer
getMaxResults()
The maximum number of results to return in a single call.String
getNextToken()
The token for the next set of results.List<String>
getScheduledInstanceIds()
One or more Scheduled Instance IDs.SlotStartTimeRangeRequest
getSlotStartTimeRange()
The time period for the first schedule to start.int
hashCode()
void
setFilters(Collection<Filter> filters)
One or more filters.void
setMaxResults(Integer maxResults)
The maximum number of results to return in a single call.void
setNextToken(String nextToken)
The token for the next set of results.void
setScheduledInstanceIds(Collection<String> scheduledInstanceIds)
One or more Scheduled Instance IDs.void
setSlotStartTimeRange(SlotStartTimeRangeRequest slotStartTimeRange)
The time period for the first schedule to start.String
toString()
Returns a string representation of this object; useful for testing and debugging.DescribeScheduledInstancesRequest
withFilters(Filter... filters)
One or more filters.DescribeScheduledInstancesRequest
withFilters(Collection<Filter> filters)
One or more filters.DescribeScheduledInstancesRequest
withMaxResults(Integer maxResults)
The maximum number of results to return in a single call.DescribeScheduledInstancesRequest
withNextToken(String nextToken)
The token for the next set of results.DescribeScheduledInstancesRequest
withScheduledInstanceIds(String... scheduledInstanceIds)
One or more Scheduled Instance IDs.DescribeScheduledInstancesRequest
withScheduledInstanceIds(Collection<String> scheduledInstanceIds)
One or more Scheduled Instance IDs.DescribeScheduledInstancesRequest
withSlotStartTimeRange(SlotStartTimeRangeRequest slotStartTimeRange)
The time period for the first schedule to start.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
getScheduledInstanceIds
public List<String> getScheduledInstanceIds()
One or more Scheduled Instance IDs.
- Returns:
- One or more Scheduled Instance IDs.
-
setScheduledInstanceIds
public void setScheduledInstanceIds(Collection<String> scheduledInstanceIds)
One or more Scheduled Instance IDs.
- Parameters:
scheduledInstanceIds
- One or more Scheduled Instance IDs.
-
withScheduledInstanceIds
public DescribeScheduledInstancesRequest withScheduledInstanceIds(String... scheduledInstanceIds)
One or more Scheduled Instance IDs.
NOTE: This method appends the values to the existing list (if any). Use
setScheduledInstanceIds(java.util.Collection)
orwithScheduledInstanceIds(java.util.Collection)
if you want to override the existing values.- Parameters:
scheduledInstanceIds
- One or more Scheduled Instance IDs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withScheduledInstanceIds
public DescribeScheduledInstancesRequest withScheduledInstanceIds(Collection<String> scheduledInstanceIds)
One or more Scheduled Instance IDs.
- Parameters:
scheduledInstanceIds
- One or more Scheduled Instance IDs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSlotStartTimeRange
public void setSlotStartTimeRange(SlotStartTimeRangeRequest slotStartTimeRange)
The time period for the first schedule to start.
- Parameters:
slotStartTimeRange
- The time period for the first schedule to start.
-
getSlotStartTimeRange
public SlotStartTimeRangeRequest getSlotStartTimeRange()
The time period for the first schedule to start.
- Returns:
- The time period for the first schedule to start.
-
withSlotStartTimeRange
public DescribeScheduledInstancesRequest withSlotStartTimeRange(SlotStartTimeRangeRequest slotStartTimeRange)
The time period for the first schedule to start.
- Parameters:
slotStartTimeRange
- The time period for the first schedule to start.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setNextToken
public void setNextToken(String nextToken)
The token for the next set of results.
- Parameters:
nextToken
- The token for the next set of results.
-
getNextToken
public String getNextToken()
The token for the next set of results.
- Returns:
- The token for the next set of results.
-
withNextToken
public DescribeScheduledInstancesRequest withNextToken(String nextToken)
The token for the next set of results.
- Parameters:
nextToken
- The token for the next set of results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMaxResults
public void setMaxResults(Integer 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.- Parameters:
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 returnedNextToken
value.
-
getMaxResults
public Integer getMaxResults()
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:
- 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.
-
withMaxResults
public DescribeScheduledInstancesRequest withMaxResults(Integer 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.- Parameters:
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 returnedNextToken
value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getFilters
public List<Filter> getFilters()
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
orEC2-VPC
). -
platform
- The platform (Linux/UNIX
orWindows
).
- Returns:
- 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
orEC2-VPC
). -
platform
- The platform (Linux/UNIX
orWindows
).
-
-
-
setFilters
public void setFilters(Collection<Filter> 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
orEC2-VPC
). -
platform
- The platform (Linux/UNIX
orWindows
).
- Parameters:
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
orEC2-VPC
). -
platform
- The platform (Linux/UNIX
orWindows
).
-
-
-
withFilters
public DescribeScheduledInstancesRequest withFilters(Filter... 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
orEC2-VPC
). -
platform
- The platform (Linux/UNIX
orWindows
).
NOTE: This method appends the values to the existing list (if any). Use
setFilters(java.util.Collection)
orwithFilters(java.util.Collection)
if you want to override the existing values.- Parameters:
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
orEC2-VPC
). -
platform
- The platform (Linux/UNIX
orWindows
).
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
withFilters
public DescribeScheduledInstancesRequest withFilters(Collection<Filter> 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
orEC2-VPC
). -
platform
- The platform (Linux/UNIX
orWindows
).
- Parameters:
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
orEC2-VPC
). -
platform
- The platform (Linux/UNIX
orWindows
).
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
getDryRunRequest
public Request<DescribeScheduledInstancesRequest> getDryRunRequest()
This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.- Specified by:
getDryRunRequest
in interfaceDryRunSupportedRequest<DescribeScheduledInstancesRequest>
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public DescribeScheduledInstancesRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-