Class RegistryAlias

java.lang.Object
software.amazon.awssdk.services.ecrpublic.model.RegistryAlias
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RegistryAlias.Builder,RegistryAlias>
@Generated("software.amazon.awssdk:codegen") public final class RegistryAlias extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RegistryAlias.Builder,RegistryAlias>

An object representing the aliases for a public registry. A public registry is given an alias when it's created. However, a custom alias can be set using the Amazon ECR console. For more information, see Registries in the Amazon Elastic Container Registry User Guide.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the registry alias.

      Returns:
      The name of the registry alias.

    • status

      public final RegistryAliasStatus status()

      The status of the registry alias.

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

      Returns:
      The status of the registry alias.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the registry alias.

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

      Returns:
      The status of the registry alias.
      See Also:

    • primaryRegistryAlias

      public final Boolean primaryRegistryAlias()

      Indicates whether the registry alias is the primary alias for the registry. If true, the alias is the primary registry alias and is displayed in both the repository URL and the image URI used in the docker pull commands on the Amazon ECR Public Gallery.

      A registry alias that isn't the primary registry alias can be used in the repository URI in a docker pull command.

      Returns:
      Indicates whether the registry alias is the primary alias for the registry. If true, the alias is the primary registry alias and is displayed in both the repository URL and the image URI used in the docker pull commands on the Amazon ECR Public Gallery.

      A registry alias that isn't the primary registry alias can be used in the repository URI in a docker pull command.

    • defaultRegistryAlias

      public final Boolean defaultRegistryAlias()

      Indicates whether the registry alias is the default alias for the registry. When the first public repository is created, your public registry is assigned a default registry alias.

      Returns:
      Indicates whether the registry alias is the default alias for the registry. When the first public repository is created, your public registry is assigned a default registry alias.

    • toBuilder

      public RegistryAlias.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<RegistryAlias.Builder,RegistryAlias>
      Returns:
      a builder for type T

    • builder

      public static RegistryAlias.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

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

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.