Package software.amazon.awssdk.services.imagebuilder.model

Interface ListImagesRequest.Builder

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

  • Method Details

    • owner

      ListImagesRequest.Builder owner(String owner)

      The owner defines which images you want to list. By default, this request will only show images owned by your account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those images that have been shared with you by other customers.

      Parameters:
      owner - The owner defines which images you want to list. By default, this request will only show images owned by your account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those images that have been shared with you by other customers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • owner

      ListImagesRequest.Builder owner(Ownership owner)

      The owner defines which images you want to list. By default, this request will only show images owned by your account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those images that have been shared with you by other customers.

      Parameters:
      owner - The owner defines which images you want to list. By default, this request will only show images owned by your account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those images that have been shared with you by other customers.
      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)

      Requests a list of images with a specific recipe name.

      Parameters:
      byName - Requests a list of images with a specific recipe name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      ListImagesRequest.Builder maxResults(Integer maxResults)

      The maximum items to return in a request.

      Parameters:
      maxResults - The maximum items to return in a 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. This is the nextToken from a previously truncated response.

      Parameters:
      nextToken - A token to specify where to start paginating. This is the nextToken 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)

      Includes deprecated images in the response list.

      Parameters:
      includeDeprecated - Includes deprecated images in the response list.
      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.