Interface ListImagesRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ListImagesRequest.Builder,ListImagesRequest>, ImagebuilderRequest.Builder, SdkBuilder<ListImagesRequest.Builder,ListImagesRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ListImagesRequest
@Mutable @NotThreadSafe public static interface ListImagesRequest.Builder extends ImagebuilderRequest.Builder, SdkPojo, CopyableBuilder<ListImagesRequest.Builder,ListImagesRequest>

  • Method Details

    • owner

      ListImagesRequest.Builder owner(String owner)

      Filters the list to images owned by you, by Amazon, or shared with you by other accounts. By default, only your account's images are returned.

      Parameters:
      owner - Filters the list to images owned by you, by Amazon, or shared with you by other accounts. By default, only your account's images are returned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • owner

      ListImagesRequest.Builder owner(Ownership owner)

      Filters the list to images owned by you, by Amazon, or shared with you by other accounts. By default, only your account's images are returned.

      Parameters:
      owner - Filters the list to images owned by you, by Amazon, or shared with you by other accounts. By default, only your account's images are returned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • filters

      ListImagesRequest.Builder filters(Collection<Filter> filters)

      Use the following filters to streamline results:

      • name

      • osVersion

      • platform

      • type

      • version

      Parameters:
      filters - Use the following filters to streamline results:

      • name

      • osVersion

      • platform

      • type

      • version

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

    • filters

      ListImagesRequest.Builder filters(Filter... filters)

      Use the following filters to streamline results:

      • name

      • osVersion

      • platform

      • type

      • version

      Parameters:
      filters - Use the following filters to streamline results:

      • name

      • osVersion

      • platform

      • type

      • version

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

    • filters

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

      Use the following filters to streamline results:

      • name

      • osVersion

      • platform

      • type

      • version

      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:

    • byName

      ListImagesRequest.Builder byName(Boolean byName)

      Specifies whether to return one entry per image name, with all versions of each image aggregated. Defaults to false, which returns one entry per image version. You can't combine this option with the version filter.

      Parameters:
      byName - Specifies whether to return one entry per image name, with all versions of each image aggregated. Defaults to false, which returns one entry per image version. You can't combine this option with the version filter.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      ListImagesRequest.Builder maxResults(Integer maxResults)

      The maximum number of items to return in a single request.

      Parameters:
      maxResults - The maximum number of items to return in a single request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      ListImagesRequest.Builder nextToken(String nextToken)

      A token to specify where to start paginating. Use the nextToken value from a previously truncated response.

      Parameters:
      nextToken - A token to specify where to start paginating. Use the nextToken value from a previously truncated response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • includeDeprecated

      ListImagesRequest.Builder includeDeprecated(Boolean includeDeprecated)

      Specifies whether to include deprecated Amazon-managed images in the results. Deprecated images that you own are always returned. Defaults to false.

      Parameters:
      includeDeprecated - Specifies whether to include deprecated Amazon-managed images in the results. Deprecated images that you own are always returned. Defaults to false.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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