software.amazon.awssdk.services.ec2.model

Interface DescribeFpgaImagesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<DescribeFpgaImagesRequest.Builder,DescribeFpgaImagesRequest>, Ec2Request.Builder, SdkBuilder<DescribeFpgaImagesRequest.Builder,DescribeFpgaImagesRequest>, SdkRequest.Builder

Enclosing class:

DescribeFpgaImagesRequest

public static interface DescribeFpgaImagesRequest.Builder
extends Ec2Request.Builder, CopyableBuilder<DescribeFpgaImagesRequest.Builder,DescribeFpgaImagesRequest>

Method Summary

Modifier and Type	Method and Description
DescribeFpgaImagesRequest.Builder	filters(Collection<Filter> filters) One or more filters.
DescribeFpgaImagesRequest.Builder	filters(Consumer<Filter.Builder>... filters) One or more filters.
DescribeFpgaImagesRequest.Builder	filters(Filter... filters) One or more filters.
DescribeFpgaImagesRequest.Builder	fpgaImageIds(Collection<String> fpgaImageIds) One or more AFI IDs.
DescribeFpgaImagesRequest.Builder	fpgaImageIds(String... fpgaImageIds) One or more AFI IDs.
DescribeFpgaImagesRequest.Builder	maxResults(Integer maxResults) The maximum number of results to return in a single call.
DescribeFpgaImagesRequest.Builder	nextToken(String nextToken) The token to retrieve the next page of results.
DescribeFpgaImagesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
DescribeFpgaImagesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
DescribeFpgaImagesRequest.Builder	owners(Collection<String> owners) Filters the AFI by owner.
DescribeFpgaImagesRequest.Builder	owners(String... owners) Filters the AFI by owner.

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

build

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.utils.builder.SdkBuilder

applyMutation, build

Method Detail

fpgaImageIds

DescribeFpgaImagesRequest.Builder fpgaImageIds(Collection<String> fpgaImageIds)

One or more AFI IDs.

Parameters:

fpgaImageIds - One or more AFI IDs.

Returns:

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

fpgaImageIds

DescribeFpgaImagesRequest.Builder fpgaImageIds(String... fpgaImageIds)

One or more AFI IDs.

Parameters:

fpgaImageIds - One or more AFI IDs.

Returns:

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

owners

DescribeFpgaImagesRequest.Builder owners(Collection<String> owners)

Filters the AFI by owner. Specify an AWS account ID, self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketplace).

Parameters:

owners - Filters the AFI by owner. Specify an AWS account ID, self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketplace).

Returns:

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

owners

DescribeFpgaImagesRequest.Builder owners(String... owners)

Filters the AFI by owner. Specify an AWS account ID, self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketplace).

Parameters:

owners - Filters the AFI by owner. Specify an AWS account ID, self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketplace).

Returns:

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

filters

DescribeFpgaImagesRequest.Builder filters(Collection<Filter> filters)

One or more filters.

• create-time - The creation time of the AFI.

• fpga-image-id - The FPGA image identifier (AFI ID).

• fpga-image-global-id - The global FPGA image identifier (AGFI ID).

• name - The name of the AFI.

• owner-id - The AWS account ID of the AFI owner.

• product-code - The product code.

• shell-version - The version of the AWS Shell that was used to create the bitstream.

• state - The state of the AFI (pending | failed | available | unavailable).

• tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

• update-time - The time of the most recent update.

Parameters:

filters - One or more filters.

• create-time - The creation time of the AFI.

• fpga-image-id - The FPGA image identifier (AFI ID).

• fpga-image-global-id - The global FPGA image identifier (AGFI ID).

• name - The name of the AFI.

• owner-id - The AWS account ID of the AFI owner.

• product-code - The product code.

• shell-version - The version of the AWS Shell that was used to create the bitstream.

• state - The state of the AFI (pending | failed | available | unavailable).

• tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

• update-time - The time of the most recent update.

Returns:

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

filters

DescribeFpgaImagesRequest.Builder filters(Filter... filters)

One or more filters.

• create-time - The creation time of the AFI.

• fpga-image-id - The FPGA image identifier (AFI ID).

• fpga-image-global-id - The global FPGA image identifier (AGFI ID).

• name - The name of the AFI.

• owner-id - The AWS account ID of the AFI owner.

• product-code - The product code.

• shell-version - The version of the AWS Shell that was used to create the bitstream.

• state - The state of the AFI (pending | failed | available | unavailable).

• tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

• update-time - The time of the most recent update.

Parameters:

filters - One or more filters.

• create-time - The creation time of the AFI.

• fpga-image-id - The FPGA image identifier (AFI ID).

• fpga-image-global-id - The global FPGA image identifier (AGFI ID).

• name - The name of the AFI.

• owner-id - The AWS account ID of the AFI owner.

• product-code - The product code.

• shell-version - The version of the AWS Shell that was used to create the bitstream.

• state - The state of the AFI (pending | failed | available | unavailable).

• tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

• update-time - The time of the most recent update.

Returns:

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

filters

DescribeFpgaImagesRequest.Builder filters(Consumer<Filter.Builder>... filters)

One or more filters.

• create-time - The creation time of the AFI.

• fpga-image-id - The FPGA image identifier (AFI ID).

• fpga-image-global-id - The global FPGA image identifier (AGFI ID).

• name - The name of the AFI.

• owner-id - The AWS account ID of the AFI owner.

• product-code - The product code.

• shell-version - The version of the AWS Shell that was used to create the bitstream.

• state - The state of the AFI (pending | failed | available | unavailable).

• tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

• update-time - The time of the most recent update.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #filters(List).

Parameters:

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

Returns:

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

See Also:

#filters(List)

nextToken

DescribeFpgaImagesRequest.Builder nextToken(String nextToken)

The token to retrieve the next page of results.

Parameters:

nextToken - The token to retrieve the next page of results.

Returns:

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

maxResults

DescribeFpgaImagesRequest.Builder maxResults(Integer maxResults)

The maximum number of results to return in a single call.

Parameters:

maxResults - The maximum number of results to return in a single call.

Returns:

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

overrideConfiguration

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

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