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

Class CreateRepositoryRequest

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

  • Method Details

    • registryId

      public final String registryId()

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

    • repositoryName

      public final String repositoryName()

      The name to use for the repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app).

      The repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, and forward slashes.

      Returns:
      The name to use for the repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app).

      The repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, and forward slashes.

    • hasTags

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

    • tags

      public final List<Tag> tags()

      The metadata that you apply to the repository to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

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

      Returns:
      The metadata that you apply to the repository to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

    • imageTagMutability

      public final ImageTagMutability imageTagMutability()

      The tag mutability setting for the repository. If this parameter is omitted, the default setting of MUTABLE will be used which will allow image tags to be overwritten. If IMMUTABLE is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.

      If the service returns an enum value that is not available in the current SDK version, imageTagMutability will return ImageTagMutability.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from imageTagMutabilityAsString().

      Returns:
      The tag mutability setting for the repository. If this parameter is omitted, the default setting of MUTABLE will be used which will allow image tags to be overwritten. If IMMUTABLE is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.
      See Also:

    • imageTagMutabilityAsString

      public final String imageTagMutabilityAsString()

      The tag mutability setting for the repository. If this parameter is omitted, the default setting of MUTABLE will be used which will allow image tags to be overwritten. If IMMUTABLE is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.

      If the service returns an enum value that is not available in the current SDK version, imageTagMutability will return ImageTagMutability.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from imageTagMutabilityAsString().

      Returns:
      The tag mutability setting for the repository. If this parameter is omitted, the default setting of MUTABLE will be used which will allow image tags to be overwritten. If IMMUTABLE is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.
      See Also:

    • hasImageTagMutabilityExclusionFilters

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

    • imageTagMutabilityExclusionFilters

      public final List<ImageTagMutabilityExclusionFilter> imageTagMutabilityExclusionFilters()

      A list of filters that specify which image tags should be excluded from the repository's image tag mutability setting.

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

      Returns:
      A list of filters that specify which image tags should be excluded from the repository's image tag mutability setting.

    • imageScanningConfiguration

      public final ImageScanningConfiguration imageScanningConfiguration()

      The imageScanningConfiguration parameter is being deprecated, in favor of specifying the image scanning configuration at the registry level. For more information, see PutRegistryScanningConfiguration.

      The image scanning configuration for the repository. This determines whether images are scanned for known vulnerabilities after being pushed to the repository.

      Returns:

      The imageScanningConfiguration parameter is being deprecated, in favor of specifying the image scanning configuration at the registry level. For more information, see PutRegistryScanningConfiguration.

      The image scanning configuration for the repository. This determines whether images are scanned for known vulnerabilities after being pushed to the repository.

    • encryptionConfiguration

      public final EncryptionConfiguration encryptionConfiguration()

      The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.

      Returns:
      The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest.

    • toBuilder

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

    • builder

      public static CreateRepositoryRequest.Builder builder()

    • serializableBuilderClass

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