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

Class ImageReferrer

java.lang.Object

software.amazon.awssdk.services.ecr.model.ImageReferrer

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ImageReferrer.Builder,ImageReferrer>

@Generated("software.amazon.awssdk:codegen")
public final class ImageReferrer
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ImageReferrer.Builder,ImageReferrer>

An object representing an artifact associated with a subject image.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ImageReferrer.Builder

Method Summary

Modifier and Type	Method	Description
Map<String,String>	annotations()	A map of annotations associated with the artifact.
ArtifactStatus	artifactStatus()	The status of the artifact.
String	artifactStatusAsString()	The status of the artifact.
String	artifactType()	A string identifying the type of artifact.
static ImageReferrer.Builder	builder()
String	digest()	The digest of the artifact manifest.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAnnotations()	For responses, this returns true if the service returned a value for the Annotations property.
int	hashCode()
String	mediaType()	The media type of the artifact manifest.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ImageReferrer.Builder>	serializableBuilderClass()
Long	size()	The size, in bytes, of the artifact.
ImageReferrer.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

digest

public final String digest()

The digest of the artifact manifest.

Returns:

The digest of the artifact manifest.

mediaType

public final String mediaType()

The media type of the artifact manifest.

Returns:

The media type of the artifact manifest.

artifactType

public final String artifactType()

A string identifying the type of artifact.

Returns:

A string identifying the type of artifact.

size

public final Long size()

The size, in bytes, of the artifact.

Returns:

The size, in bytes, of the artifact.

hasAnnotations

public final boolean hasAnnotations()

For responses, this returns true if the service returned a value for the Annotations 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.

annotations

public final Map<String,String> annotations()

A map of annotations associated with the artifact.

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

Returns:

A map of annotations associated with the artifact.

artifactStatus

public final ArtifactStatus artifactStatus()

The status of the artifact. Valid values are ACTIVE, ARCHIVED, or ACTIVATING.

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

Returns:

The status of the artifact. Valid values are ACTIVE, ARCHIVED, or ACTIVATING.

See Also:

ArtifactStatus

artifactStatusAsString

public final String artifactStatusAsString()

The status of the artifact. Valid values are ACTIVE, ARCHIVED, or ACTIVATING.

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

Returns:

The status of the artifact. Valid values are ACTIVE, ARCHIVED, or ACTIVATING.

See Also:

ArtifactStatus

toBuilder

public ImageReferrer.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ImageReferrer.Builder,ImageReferrer>

builder

public static ImageReferrer.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo