Interface ListImageReferrersRequest.Builder

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

  • Method Details

    • registryId

      ListImageReferrersRequest.Builder registryId(String registryId)

      The Amazon Web Services account ID associated with the registry that contains the repository in which to list image referrers. If you do not specify a registry, the default registry is assumed.

      Parameters:
      registryId - The Amazon Web Services account ID associated with the registry that contains the repository in which to list image referrers. If you do not specify a registry, the default registry is assumed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • repositoryName

      ListImageReferrersRequest.Builder repositoryName(String repositoryName)

      The name of the repository that contains the subject image.

      Parameters:
      repositoryName - The name of the repository that contains the subject image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subjectId

      ListImageReferrersRequest.Builder subjectId(SubjectIdentifier subjectId)

      An object containing the image digest of the subject image for which to retrieve associated artifacts.

      Parameters:
      subjectId - An object containing the image digest of the subject image for which to retrieve associated artifacts.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subjectId

      default ListImageReferrersRequest.Builder subjectId(Consumer<SubjectIdentifier.Builder> subjectId)

      An object containing the image digest of the subject image for which to retrieve associated artifacts.

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

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

      Parameters:
      subjectId - a consumer that will call methods on SubjectIdentifier.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • filter

      ListImageReferrersRequest.Builder filter(ListImageReferrersFilter filter)

      The filter key and value with which to filter your ListImageReferrers results. If no filter is specified, only artifacts with ACTIVE status are returned.

      Parameters:
      filter - The filter key and value with which to filter your ListImageReferrers results. If no filter is specified, only artifacts with ACTIVE status are returned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filter

      default ListImageReferrersRequest.Builder filter(Consumer<ListImageReferrersFilter.Builder> filter)

      The filter key and value with which to filter your ListImageReferrers results. If no filter is specified, only artifacts with ACTIVE status are returned.

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

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

      Parameters:
      filter - a consumer that will call methods on ListImageReferrersFilter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • nextToken

      ListImageReferrersRequest.Builder nextToken(String nextToken)

      The nextToken value returned from a previous paginated ListImageReferrers request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

      This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

      Parameters:
      nextToken - The nextToken value returned from a previous paginated ListImageReferrers request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

      This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

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

    • maxResults

      ListImageReferrersRequest.Builder maxResults(Integer maxResults)

      The maximum number of image referrer results returned by ListImageReferrers in paginated output. When this parameter is used, ListImageReferrers only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListImageReferrers request with the returned nextToken value. This value can be between 1 and 50. If this parameter is not used, then ListImageReferrers returns up to 50 results and a nextToken value, if applicable.

      Parameters:
      maxResults - The maximum number of image referrer results returned by ListImageReferrers in paginated output. When this parameter is used, ListImageReferrers only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListImageReferrers request with the returned nextToken value. This value can be between 1 and 50. If this parameter is not used, then ListImageReferrers returns up to 50 results and a nextToken value, if applicable.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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