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

Class BatchGetImageRequest

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

  • Method Details

    • registryId

      public final String registryId()

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

    • repositoryName

      public final String repositoryName()

      The repository that contains the images to describe.

      Returns:
      The repository that contains the images to describe.

    • 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()

      A list of image ID references that correspond to images to describe. The format of the imageIds reference is imageTag=tag or imageDigest=digest.

      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:
      A list of image ID references that correspond to images to describe. The format of the imageIds reference is imageTag=tag or imageDigest=digest.

    • hasAcceptedMediaTypes

      public final boolean hasAcceptedMediaTypes()
      For responses, this returns true if the service returned a value for the AcceptedMediaTypes 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.

    • acceptedMediaTypes

      public final List<String> acceptedMediaTypes()

      The accepted media types for the request.

      Valid values: application/vnd.docker.distribution.manifest.v1+json | application/vnd.docker.distribution.manifest.v2+json | application/vnd.oci.image.manifest.v1+json

      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 hasAcceptedMediaTypes() method.

      Returns:
      The accepted media types for the request.

      Valid values: application/vnd.docker.distribution.manifest.v1+json | application/vnd.docker.distribution.manifest.v2+json | application/vnd.oci.image.manifest.v1+json

    • toBuilder

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

    • builder

      public static BatchGetImageRequest.Builder builder()

    • serializableBuilderClass

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