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

Class GetLifecyclePolicyPreviewRequest

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

  • Method Details

    • registryId

      public final String registryId()

      The Amazon Web Services account ID associated with the registry that contains the repository. 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. If you do not specify a registry, the default registry is assumed.

    • repositoryName

      public final String repositoryName()

      The name of the repository.

      Returns:
      The name of the repository.

    • hasImageIds

      public final boolean hasImageIds()
      For responses, this returns true if the service returned a value for the ImageIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • imageIds

      public final List<ImageIdentifier> imageIds()

      The list of imageIDs to be included.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasImageIds() method.

      Returns:
      The list of imageIDs to be included.

    • nextToken

      public final String nextToken()

      The nextToken value returned from a previous paginated
 GetLifecyclePolicyPreviewRequest 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 option cannot be used when you specify images with imageIds.

      Returns:
      The nextToken value returned from a previous paginated
 GetLifecyclePolicyPreviewRequest 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 option cannot be used when you specify images with imageIds.

    • maxResults

      public final Integer maxResults()

      The maximum number of repository results returned by GetLifecyclePolicyPreviewRequest in
 paginated output. When this parameter is used, GetLifecyclePolicyPreviewRequest 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 GetLifecyclePolicyPreviewRequest request with the returned nextToken
 value. This value can be between 1 and 100. If this
 parameter is not used, then GetLifecyclePolicyPreviewRequest returns up to
100 results and a nextToken value, if
 applicable. This option cannot be used when you specify images with imageIds.

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

    • filter

      public final LifecyclePolicyPreviewFilter filter()

      An optional parameter that filters results based on image tag status and all tags, if tagged.

      Returns:
      An optional parameter that filters results based on image tag status and all tags, if tagged.

    • toBuilder

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

    • builder

      public static GetLifecyclePolicyPreviewRequest.Builder builder()

    • serializableBuilderClass

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