software.amazon.awssdk.services.ec2.model

Class DescribeScheduledInstancesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ec2.model.Ec2Request

software.amazon.awssdk.services.ec2.model.DescribeScheduledInstancesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeScheduledInstancesRequest.Builder,DescribeScheduledInstancesRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeScheduledInstancesRequest
extends Ec2Request
implements ToCopyableBuilder<DescribeScheduledInstancesRequest.Builder,DescribeScheduledInstancesRequest>

Contains the parameters for DescribeScheduledInstances.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeScheduledInstancesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeScheduledInstancesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
List<Filter>	filters() The filters.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
boolean	hasFilters() Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasScheduledInstanceIds() Returns true if the ScheduledInstanceIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
Integer	maxResults() The maximum number of results to return in a single call.
String	nextToken() The token for the next set of results.
List<String>	scheduledInstanceIds() The Scheduled Instance IDs.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeScheduledInstancesRequest.Builder>	serializableBuilderClass()
SlotStartTimeRangeRequest	slotStartTimeRange() The time period for the first schedule to start.
DescribeScheduledInstancesRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasFilters

public final boolean hasFilters()

Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

filters

public final List<Filter> filters()

The 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).

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasFilters() to see if a value was sent in this field.

Returns:

The 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).

maxResults

public final 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.

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.

nextToken

public final String nextToken()

The token for the next set of results.

Returns:

The token for the next set of results.

hasScheduledInstanceIds

public final boolean hasScheduledInstanceIds()

Returns true if the ScheduledInstanceIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

scheduledInstanceIds

public final List<String> scheduledInstanceIds()

The Scheduled Instance IDs.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasScheduledInstanceIds() to see if a value was sent in this field.

Returns:

The Scheduled Instance IDs.

slotStartTimeRange

public final SlotStartTimeRangeRequest slotStartTimeRange()

The time period for the first schedule to start.

Returns:

The time period for the first schedule to start.

toBuilder

public DescribeScheduledInstancesRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeScheduledInstancesRequest.Builder,DescribeScheduledInstancesRequest>

Specified by:

toBuilder in class Ec2Request

Returns:

a builder for type T

builder

public static DescribeScheduledInstancesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeScheduledInstancesRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.