Class DescribeScheduledInstancesRequest
- All Implemented Interfaces:
ReadLimitInfo
,DryRunSupportedRequest<DescribeScheduledInstancesRequest>
,Serializable
,Cloneable
Contains the parameters for DescribeScheduledInstances.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
This method is intended for internal use only.One or more filters.The maximum number of results to return in a single call.The token for the next set of results.One or more Scheduled Instance IDs.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.toString()
Returns a string representation of this object; useful for testing and debugging.withFilters
(Filter... filters) One or more filters.withFilters
(Collection<Filter> filters) One or more filters.withMaxResults
(Integer maxResults) The maximum number of results to return in a single call.withNextToken
(String nextToken) The token for the next set of results.withScheduledInstanceIds
(String... scheduledInstanceIds) One or more Scheduled Instance IDs.withScheduledInstanceIds
(Collection<String> scheduledInstanceIds) One or more Scheduled Instance IDs.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
-
Constructor Details
-
DescribeScheduledInstancesRequest
public DescribeScheduledInstancesRequest()
-
-
Method Details
-
getScheduledInstanceIds
One or more Scheduled Instance IDs.
- Returns:
- One or more Scheduled Instance IDs.
-
setScheduledInstanceIds
One or more Scheduled Instance IDs.
- Parameters:
scheduledInstanceIds
- One or more Scheduled Instance IDs.
-
withScheduledInstanceIds
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
The time period for the first schedule to start.
- Parameters:
slotStartTimeRange
- The time period for the first schedule to start.
-
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
The token for the next set of results.
- Parameters:
nextToken
- The token for the next set of results.
-
getNextToken
The token for the next set of results.
- Returns:
- The token for the next set of results.
-
withNextToken
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
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
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
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
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
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
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
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
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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:
-