Package software.amazon.awssdk.services.ecr.model

Class ListImageReferrersRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.ecr.model.EcrRequest
software.amazon.awssdk.services.ecr.model.ListImageReferrersRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListImageReferrersRequest.Builder,ListImageReferrersRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListImageReferrersRequest extends EcrRequest implements ToCopyableBuilder<ListImageReferrersRequest.Builder,ListImageReferrersRequest>

  • Method Details

    • registryId

      public final 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.

      Returns:
      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.

    • repositoryName

      public final String repositoryName()

      The name of the repository that contains the subject image.

      Returns:
      The name of the repository that contains the subject image.

    • subjectId

      public final SubjectIdentifier subjectId()

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

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

    • filter

      public final 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.

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

    • nextToken

      public final 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.

      Returns:
      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.

    • maxResults

      public final 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 20 results and a nextToken value, if applicable.

      Returns:
      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 20 results and a nextToken value, if applicable.

    • toBuilder

      public ListImageReferrersRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<ListImageReferrersRequest.Builder,ListImageReferrersRequest>
      Specified by:
      toBuilder in class EcrRequest

    • builder

      public static ListImageReferrersRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListImageReferrersRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo