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:
  • Constructor Details

    • DescribeScheduledInstancesRequest

      public DescribeScheduledInstancesRequest()
  • Method Details

    • 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) or withScheduledInstanceIds(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 returned NextToken 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 returned NextToken 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 or EC2-VPC).

      • platform - The platform (Linux/UNIX or Windows).

      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 or EC2-VPC).

      • platform - The platform (Linux/UNIX or Windows).

    • 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 or EC2-VPC).

      • platform - The platform (Linux/UNIX or Windows).

      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 or EC2-VPC).

      • platform - The platform (Linux/UNIX or Windows).

    • 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 or EC2-VPC).

      • platform - The platform (Linux/UNIX or Windows).

      NOTE: This method appends the values to the existing list (if any). Use setFilters(java.util.Collection) or withFilters(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 or EC2-VPC).

      • platform - The platform (Linux/UNIX or Windows).

      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 or EC2-VPC).

      • platform - The platform (Linux/UNIX or Windows).

      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 or EC2-VPC).

      • platform - The platform (Linux/UNIX or Windows).

      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 interface DryRunSupportedRequest<DescribeScheduledInstancesRequest>
    • toString

      public String toString()
      Returns a string representation of this object; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • 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 class AmazonWebServiceRequest
      See Also: