com.amazonaws.services.ec2.model

Class DescribeScheduledInstanceAvailabilityRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeScheduledInstanceAvailabilityRequest

All Implemented Interfaces:

DryRunSupportedRequest<DescribeScheduledInstanceAvailabilityRequest>, java.io.Serializable, java.lang.Cloneable

public class DescribeScheduledInstanceAvailabilityRequest
extends AmazonWebServiceRequest
implements java.io.Serializable, DryRunSupportedRequest<DescribeScheduledInstanceAvailabilityRequest>

Container for the parameters to the DescribeScheduledInstanceAvailability operation.

Finds available schedules that meet the specified criteria.

You can search for an available schedule no more than 3 months in advance. You must meet the minimum required duration of 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.

After you find a schedule that meets your needs, call PurchaseScheduledInstances to purchase Scheduled Instances with that schedule.

See Also:

AmazonEC2.describeScheduledInstanceAvailability(DescribeScheduledInstanceAvailabilityRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeScheduledInstanceAvailabilityRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
Request<DescribeScheduledInstanceAvailabilityRequest>	getDryRunRequest() This method is intended for internal use only.
java.util.List<Filter>	getFilters() One or more filters.
SlotDateTimeRangeRequest	getFirstSlotStartTimeRange() The time period for the first schedule to start.
java.lang.Integer	getMaxResults() The maximum number of results to return in a single call.
java.lang.Integer	getMaxSlotDurationInHours() The maximum available duration, in hours.
java.lang.Integer	getMinSlotDurationInHours() The minimum available duration, in hours.
java.lang.String	getNextToken() The token for the next set of results.
ScheduledInstanceRecurrenceRequest	getRecurrence() The schedule recurrence.
int	hashCode()
void	setFilters(java.util.Collection<Filter> filters) One or more filters.
void	setFirstSlotStartTimeRange(SlotDateTimeRangeRequest firstSlotStartTimeRange) The time period for the first schedule to start.
void	setMaxResults(java.lang.Integer maxResults) The maximum number of results to return in a single call.
void	setMaxSlotDurationInHours(java.lang.Integer maxSlotDurationInHours) The maximum available duration, in hours.
void	setMinSlotDurationInHours(java.lang.Integer minSlotDurationInHours) The minimum available duration, in hours.
void	setNextToken(java.lang.String nextToken) The token for the next set of results.
void	setRecurrence(ScheduledInstanceRecurrenceRequest recurrence) The schedule recurrence.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeScheduledInstanceAvailabilityRequest	withFilters(java.util.Collection<Filter> filters) One or more filters.
DescribeScheduledInstanceAvailabilityRequest	withFilters(Filter... filters) One or more filters.
DescribeScheduledInstanceAvailabilityRequest	withFirstSlotStartTimeRange(SlotDateTimeRangeRequest firstSlotStartTimeRange) The time period for the first schedule to start.
DescribeScheduledInstanceAvailabilityRequest	withMaxResults(java.lang.Integer maxResults) The maximum number of results to return in a single call.
DescribeScheduledInstanceAvailabilityRequest	withMaxSlotDurationInHours(java.lang.Integer maxSlotDurationInHours) The maximum available duration, in hours.
DescribeScheduledInstanceAvailabilityRequest	withMinSlotDurationInHours(java.lang.Integer minSlotDurationInHours) The minimum available duration, in hours.
DescribeScheduledInstanceAvailabilityRequest	withNextToken(java.lang.String nextToken) The token for the next set of results.
DescribeScheduledInstanceAvailabilityRequest	withRecurrence(ScheduledInstanceRecurrenceRequest recurrence) The schedule recurrence.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeScheduledInstanceAvailabilityRequest

public DescribeScheduledInstanceAvailabilityRequest()

Method Detail

getRecurrence

public ScheduledInstanceRecurrenceRequest getRecurrence()

The schedule recurrence.

Returns:

The schedule recurrence.

setRecurrence

public void setRecurrence(ScheduledInstanceRecurrenceRequest recurrence)

The schedule recurrence.

Parameters:

recurrence - The schedule recurrence.

withRecurrence

public DescribeScheduledInstanceAvailabilityRequest withRecurrence(ScheduledInstanceRecurrenceRequest recurrence)

The schedule recurrence.

Returns a reference to this object so that method calls can be chained together.

Parameters:

recurrence - The schedule recurrence.

Returns:

A reference to this updated object so that method calls can be chained together.

getFirstSlotStartTimeRange

public SlotDateTimeRangeRequest getFirstSlotStartTimeRange()

The time period for the first schedule to start.

Returns:

The time period for the first schedule to start.

setFirstSlotStartTimeRange

public void setFirstSlotStartTimeRange(SlotDateTimeRangeRequest firstSlotStartTimeRange)

The time period for the first schedule to start.

Parameters:

firstSlotStartTimeRange - The time period for the first schedule to start.

withFirstSlotStartTimeRange

public DescribeScheduledInstanceAvailabilityRequest withFirstSlotStartTimeRange(SlotDateTimeRangeRequest firstSlotStartTimeRange)

The time period for the first schedule to start.

Returns a reference to this object so that method calls can be chained together.

Parameters:

firstSlotStartTimeRange - The time period for the first schedule to start.

Returns:

A reference to this updated object so that method calls can be chained together.

getMinSlotDurationInHours

public java.lang.Integer getMinSlotDurationInHours()

The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.

Returns:

The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.

setMinSlotDurationInHours

public void setMinSlotDurationInHours(java.lang.Integer minSlotDurationInHours)

The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.

Parameters:

minSlotDurationInHours - The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.

withMinSlotDurationInHours

public DescribeScheduledInstanceAvailabilityRequest withMinSlotDurationInHours(java.lang.Integer minSlotDurationInHours)

The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.

Returns a reference to this object so that method calls can be chained together.

Parameters:

minSlotDurationInHours - The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxSlotDurationInHours

public java.lang.Integer getMaxSlotDurationInHours()

The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours and less than 1,720.

Returns:

The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours and less than 1,720.

setMaxSlotDurationInHours

public void setMaxSlotDurationInHours(java.lang.Integer maxSlotDurationInHours)

The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours and less than 1,720.

Parameters:

maxSlotDurationInHours - The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours and less than 1,720.

withMaxSlotDurationInHours

public DescribeScheduledInstanceAvailabilityRequest withMaxSlotDurationInHours(java.lang.Integer maxSlotDurationInHours)

The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours and less than 1,720.

Returns a reference to this object so that method calls can be chained together.

Parameters:

maxSlotDurationInHours - The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours and less than 1,720.

Returns:

A reference to this updated object so that method calls can be chained together.

getNextToken

public java.lang.String getNextToken()

The token for the next set of results.

Returns:

The token for the next set of results.

setNextToken

public void setNextToken(java.lang.String nextToken)

The token for the next set of results.

Parameters:

nextToken - The token for the next set of results.

withNextToken

public DescribeScheduledInstanceAvailabilityRequest withNextToken(java.lang.String nextToken)

The token for the next set of results.

Returns a reference to this object so that method calls can be chained together.

Parameters:

nextToken - The token for the next set of results.

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxResults

public java.lang.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 300. 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 300. To retrieve the remaining results, make another call with the returned NextToken value.

setMaxResults

public void setMaxResults(java.lang.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 300. 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 300. To retrieve the remaining results, make another call with the returned NextToken value.

withMaxResults

public DescribeScheduledInstanceAvailabilityRequest withMaxResults(java.lang.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 300. 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.

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 300. To retrieve the remaining results, make another call with the returned NextToken value.

Returns:

A reference to this updated object so that method calls can be chained together.

getFilters

public java.util.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(java.util.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 DescribeScheduledInstanceAvailabilityRequest 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).

Returns a reference to this object so that method calls can be chained together.

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:

A reference to this updated object so that method calls can be chained together.

withFilters

public DescribeScheduledInstanceAvailabilityRequest withFilters(java.util.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).

Returns a reference to this object so that method calls can be chained together.

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:

A reference to this updated object so that method calls can be chained together.

getDryRunRequest

public Request<DescribeScheduledInstanceAvailabilityRequest> 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<DescribeScheduledInstanceAvailabilityRequest>

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object