Class RepositoryCatalogDataInput
- java.lang.Object
-
- software.amazon.awssdk.services.ecrpublic.model.RepositoryCatalogDataInput
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<RepositoryCatalogDataInput.Builder,RepositoryCatalogDataInput>
@Generated("software.amazon.awssdk:codegen") public final class RepositoryCatalogDataInput extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RepositoryCatalogDataInput.Builder,RepositoryCatalogDataInput>
An object that contains the catalog data for a repository. This data is publicly visible in the Amazon ECR Public Gallery.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceRepositoryCatalogDataInput.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringaboutText()A detailed description of the contents of the repository.List<String>architectures()The system architecture that the images in the repository are compatible with.static RepositoryCatalogDataInput.Builderbuilder()Stringdescription()A short description of the contents of the repository.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasArchitectures()For responses, this returns true if the service returned a value for the Architectures property.inthashCode()booleanhasOperatingSystems()For responses, this returns true if the service returned a value for the OperatingSystems property.SdkByteslogoImageBlob()The base64-encoded repository logo payload.List<String>operatingSystems()The operating systems that the images in the repository are compatible with.List<SdkField<?>>sdkFields()static Class<? extends RepositoryCatalogDataInput.Builder>serializableBuilderClass()RepositoryCatalogDataInput.BuildertoBuilder()StringtoString()Returns a string representation of this object.StringusageText()Detailed information about how to use the contents of the repository.-
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
-
description
public final String description()
A short description of the contents of the repository. This text appears in both the image details and also when searching for repositories on the Amazon ECR Public Gallery.
- Returns:
- A short description of the contents of the repository. This text appears in both the image details and also when searching for repositories on the Amazon ECR Public Gallery.
-
hasArchitectures
public final boolean hasArchitectures()
For responses, this returns true if the service returned a value for the Architectures property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
architectures
public final List<String> architectures()
The system architecture that the images in the repository are compatible with. On the Amazon ECR Public Gallery, the following supported architectures appear as badges on the repository and are used as search filters.
If an unsupported tag is added to your repository catalog data, it's associated with the repository and can be retrieved using the API but isn't discoverable in the Amazon ECR Public Gallery.
-
ARM -
ARM 64 -
x86 -
x86-64
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
hasArchitectures()method.- Returns:
- The system architecture that the images in the repository are compatible with. On the Amazon ECR Public
Gallery, the following supported architectures appear as badges on the repository and are used as search
filters.
If an unsupported tag is added to your repository catalog data, it's associated with the repository and can be retrieved using the API but isn't discoverable in the Amazon ECR Public Gallery.
-
ARM -
ARM 64 -
x86 -
x86-64
-
-
-
hasOperatingSystems
public final boolean hasOperatingSystems()
For responses, this returns true if the service returned a value for the OperatingSystems property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
operatingSystems
public final List<String> operatingSystems()
The operating systems that the images in the repository are compatible with. On the Amazon ECR Public Gallery, the following supported operating systems appear as badges on the repository and are used as search filters.
If an unsupported tag is added to your repository catalog data, it's associated with the repository and can be retrieved using the API but isn't discoverable in the Amazon ECR Public Gallery.
-
Linux -
Windows
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
hasOperatingSystems()method.- Returns:
- The operating systems that the images in the repository are compatible with. On the Amazon ECR Public
Gallery, the following supported operating systems appear as badges on the repository and are used as
search filters.
If an unsupported tag is added to your repository catalog data, it's associated with the repository and can be retrieved using the API but isn't discoverable in the Amazon ECR Public Gallery.
-
Linux -
Windows
-
-
-
logoImageBlob
public final SdkBytes logoImageBlob()
The base64-encoded repository logo payload.
The repository logo is only publicly visible in the Amazon ECR Public Gallery for verified accounts.
- Returns:
- The base64-encoded repository logo payload.
The repository logo is only publicly visible in the Amazon ECR Public Gallery for verified accounts.
-
aboutText
public final String aboutText()
A detailed description of the contents of the repository. It's publicly visible in the Amazon ECR Public Gallery. The text must be in markdown format.
- Returns:
- A detailed description of the contents of the repository. It's publicly visible in the Amazon ECR Public Gallery. The text must be in markdown format.
-
usageText
public final String usageText()
Detailed information about how to use the contents of the repository. It's publicly visible in the Amazon ECR Public Gallery. The usage text provides context, support information, and additional usage details for users of the repository. The text must be in markdown format.
- Returns:
- Detailed information about how to use the contents of the repository. It's publicly visible in the Amazon ECR Public Gallery. The usage text provides context, support information, and additional usage details for users of the repository. The text must be in markdown format.
-
toBuilder
public RepositoryCatalogDataInput.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<RepositoryCatalogDataInput.Builder,RepositoryCatalogDataInput>
-
builder
public static RepositoryCatalogDataInput.Builder builder()
-
serializableBuilderClass
public static Class<? extends RepositoryCatalogDataInput.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-