Interface DescribeFpgaImagesRequest.Builder

All Superinterfaces:

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

Enclosing class:

DescribeFpgaImagesRequest

@Mutable
@NotThreadSafe
public static interface DescribeFpgaImagesRequest.Builder
extends Ec2Request.Builder, SdkPojo, CopyableBuilder<DescribeFpgaImagesRequest.Builder,DescribeFpgaImagesRequest>

Method Summary

Modifier and Type	Method	Description
DescribeFpgaImagesRequest.Builder	dryRun(Boolean dryRun)	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
DescribeFpgaImagesRequest.Builder	filters(Collection<Filter> filters)	The filters.
DescribeFpgaImagesRequest.Builder	filters(Consumer<Filter.Builder>... filters)	The filters.
DescribeFpgaImagesRequest.Builder	filters(Filter... filters)	The filters.
DescribeFpgaImagesRequest.Builder	fpgaImageIds(String... fpgaImageIds)	The AFI IDs.
DescribeFpgaImagesRequest.Builder	fpgaImageIds(Collection<String> fpgaImageIds)	The 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(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
DescribeFpgaImagesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
DescribeFpgaImagesRequest.Builder	owners(String... owners)	Filters the AFI by owner.
DescribeFpgaImagesRequest.Builder	owners(Collection<String> owners)	Filters the AFI by owner.

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, sdkFieldNameToField, sdkFields

Method Details

dryRun

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

fpgaImageIds

DescribeFpgaImagesRequest.Builder fpgaImageIds(Collection<String> fpgaImageIds)

The AFI IDs.

Parameters:

fpgaImageIds - The AFI IDs.

Returns:

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

fpgaImageIds

DescribeFpgaImagesRequest.Builder fpgaImageIds(String... fpgaImageIds)

The AFI IDs.

Parameters:

fpgaImageIds - The 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 Amazon Web Services account ID, self (owner is the sender of the request), or an Amazon Web Services owner alias (valid values are amazon | aws-marketplace).

Parameters:

owners - Filters the AFI by owner. Specify an Amazon Web Services account ID, self (owner is the sender of the request), or an Amazon Web Services 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 Amazon Web Services account ID, self (owner is the sender of the request), or an Amazon Web Services owner alias (valid values are amazon | aws-marketplace).

Parameters:

owners - Filters the AFI by owner. Specify an Amazon Web Services account ID, self (owner is the sender of the request), or an Amazon Web Services 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)

The 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 Amazon Web Services account ID of the AFI owner.

• product-code - The product code.

• shell-version - The version of the Amazon Web Services Shell that was used to create the bitstream.

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

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

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

Parameters:

filters - The 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 Amazon Web Services account ID of the AFI owner.

• product-code - The product code.

• shell-version - The version of the Amazon Web Services Shell that was used to create the bitstream.

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

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

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

The 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 Amazon Web Services account ID of the AFI owner.

• product-code - The product code.

• shell-version - The version of the Amazon Web Services Shell that was used to create the bitstream.

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

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

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

Parameters:

filters - The 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 Amazon Web Services account ID of the AFI owner.

• product-code - The product code.

• shell-version - The version of the Amazon Web Services Shell that was used to create the bitstream.

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

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

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

The 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 Amazon Web Services account ID of the AFI owner.

• product-code - The product code.

• shell-version - The version of the Amazon Web Services Shell that was used to create the bitstream.

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

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

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

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

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.