Package software.amazon.awssdk.services.ecrpublic.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RegistryAlias.Builder

Method Summary

Modifier and Type	Method	Description
static RegistryAlias.Builder	builder()
Boolean	defaultRegistryAlias()	Indicates whether the registry alias is the default alias for the registry.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	The name of the registry alias.
Boolean	primaryRegistryAlias()	Indicates whether the registry alias is the primary alias for the registry.
List<SdkField<?>>	sdkFields()
static Class<? extends RegistryAlias.Builder>	serializableBuilderClass()
RegistryAliasStatus	status()	The status of the registry alias.
String	statusAsString()	The status of the registry alias.
RegistryAlias.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

RegistryAliasStatus

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:

RegistryAliasStatus

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

Specified by:

toBuilder in interface ToCopyableBuilder<RegistryAlias.Builder,RegistryAlias>

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)

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo