Package software.amazon.awssdk.services.ec2.model

Interface DescribeScheduledInstancesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<DescribeScheduledInstancesRequest.Builder,DescribeScheduledInstancesRequest>, Ec2Request.Builder, SdkBuilder<DescribeScheduledInstancesRequest.Builder,DescribeScheduledInstancesRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

DescribeScheduledInstancesRequest

public static interface DescribeScheduledInstancesRequest.Builder
extends Ec2Request.Builder, SdkPojo, CopyableBuilder<DescribeScheduledInstancesRequest.Builder,DescribeScheduledInstancesRequest>

Method Summary

Modifier and Type	Method	Description
DescribeScheduledInstancesRequest.Builder	dryRun(Boolean dryRun)	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
DescribeScheduledInstancesRequest.Builder	filters(Collection<Filter> filters)	The filters.
DescribeScheduledInstancesRequest.Builder	filters(Consumer<Filter.Builder>... filters)	The filters.
DescribeScheduledInstancesRequest.Builder	filters(Filter... filters)	The filters.
DescribeScheduledInstancesRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return in a single call.
DescribeScheduledInstancesRequest.Builder	nextToken(String nextToken)	The token for the next set of results.
DescribeScheduledInstancesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
DescribeScheduledInstancesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
DescribeScheduledInstancesRequest.Builder	scheduledInstanceIds(String... scheduledInstanceIds)	The Scheduled Instance IDs.
DescribeScheduledInstancesRequest.Builder	scheduledInstanceIds(Collection<String> scheduledInstanceIds)	The Scheduled Instance IDs.
default DescribeScheduledInstancesRequest.Builder	slotStartTimeRange(Consumer<SlotStartTimeRangeRequest.Builder> slotStartTimeRange)	The time period for the first schedule to start.
DescribeScheduledInstancesRequest.Builder	slotStartTimeRange(SlotStartTimeRangeRequest slotStartTimeRange)	The time period for the first schedule to start.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder

build

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Details

dryRun

DescribeScheduledInstancesRequest.Builder dryRun(Boolean dryRun)

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Parameters:

dryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

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

filters

DescribeScheduledInstancesRequest.Builder filters(Collection<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).

Parameters:

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

Returns:

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

filters

DescribeScheduledInstancesRequest.Builder filters(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).

Parameters:

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

Returns:

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

filters

DescribeScheduledInstancesRequest.Builder filters(Consumer<Filter.Builder>... 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).

This is a convenience method that creates an instance of the Filter.Builder avoiding the need to create one manually via Filter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(List<Filter>).

Parameters:

filters - a consumer that will call methods on Filter.Builder

Returns:

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

See Also:

• filters(java.util.Collection<Filter>)

maxResults

DescribeScheduledInstancesRequest.Builder maxResults(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.

nextToken

DescribeScheduledInstancesRequest.Builder nextToken(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.

scheduledInstanceIds

DescribeScheduledInstancesRequest.Builder scheduledInstanceIds(Collection<String> scheduledInstanceIds)

The Scheduled Instance IDs.

Parameters:

scheduledInstanceIds - The Scheduled Instance IDs.

Returns:

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

scheduledInstanceIds

DescribeScheduledInstancesRequest.Builder scheduledInstanceIds(String... scheduledInstanceIds)

The Scheduled Instance IDs.

Parameters:

scheduledInstanceIds - The Scheduled Instance IDs.

Returns:

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

slotStartTimeRange

DescribeScheduledInstancesRequest.Builder slotStartTimeRange(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.

slotStartTimeRange

default DescribeScheduledInstancesRequest.Builder slotStartTimeRange(Consumer<SlotStartTimeRangeRequest.Builder> slotStartTimeRange)

The time period for the first schedule to start.

This is a convenience method that creates an instance of the SlotStartTimeRangeRequest.Builder avoiding the need to create one manually via SlotStartTimeRangeRequest.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to slotStartTimeRange(SlotStartTimeRangeRequest).

Parameters:

slotStartTimeRange - a consumer that will call methods on SlotStartTimeRangeRequest.Builder

Returns:

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

See Also:

• slotStartTimeRange(SlotStartTimeRangeRequest)

overrideConfiguration

DescribeScheduledInstancesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

DescribeScheduledInstancesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.