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

Class ListImagesRequest

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.ListImagesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListImagesRequest.Builder,ListImagesRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListImagesRequest extends EcrRequest implements ToCopyableBuilder<ListImagesRequest.Builder,ListImagesRequest>

  • 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 images. 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 images. If you do not specify a registry, the default registry is assumed.

    • repositoryName

      public final String repositoryName()

      The repository with image IDs to be listed.

      Returns:
      The repository with image IDs to be listed.

    • nextToken

      public final String nextToken()

      The nextToken value returned from a previous paginated ListImages 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 ListImages 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 results returned by ListImages in paginated output. When this parameter is used, ListImages 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 ListImages request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then ListImages returns up to 100 results and a nextToken value, if applicable.

      Returns:
      The maximum number of image results returned by ListImages in paginated output. When this parameter is used, ListImages 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 ListImages request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then ListImages returns up to 100 results and a nextToken value, if applicable.

    • filter

      public final ListImagesFilter filter()

      The filter key and value with which to filter your ListImages results.

      Returns:
      The filter key and value with which to filter your ListImages results.

    • toBuilder

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

    • builder

      public static ListImagesRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListImagesRequest.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