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)
List<Filter>	filters() The filters.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilters() For responses, this returns true if the service returned a value for the Filters property.
int	hashCode()
boolean	hasScheduledInstanceIds() For responses, this returns true if the service returned a value for the ScheduledInstanceIds property.
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()
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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

hasFilters

public final boolean hasFilters()

For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

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

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

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFilters() method.

Returns:

The filters.

• availability-zone - The Availability Zone (for example, us-west-2a).

• instance-type - The instance type (for example, c4.large).

• 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()

For responses, this returns true if the service returned a value for the ScheduledInstanceIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

scheduledInstanceIds

public final List<String> scheduledInstanceIds()

The Scheduled Instance IDs.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasScheduledInstanceIds() method.

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()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeScheduledInstancesRequest.Builder,DescribeScheduledInstancesRequest>

Specified by:

toBuilder in class Ec2Request

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo