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

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:

  • Method Details

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

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

    • 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()
      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<RepositoryCatalogDataInput.Builder,RepositoryCatalogDataInput>
      Returns:
      a builder for type T

    • builder

      public static RepositoryCatalogDataInput.Builder builder()

    • serializableBuilderClass

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