Package software.amazon.awssdk.services.codeartifact.model

Class RepositoryDescription

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

The details of a repository stored in CodeArtifact. A CodeArtifact repository contains a set of package versions, each of which maps to a set of assets. Repositories are polyglot—a single repository can contain packages of any supported type. Each repository exposes endpoints for fetching and publishing packages using tools like the npm CLI, the Maven CLI (mvn), and pip. You can create up to 100 repositories per Amazon Web Services account.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the repository.

      Returns:
      The name of the repository.

    • administratorAccount

      public final String administratorAccount()

      The 12-digit account number of the Amazon Web Services account that manages the repository.

      Returns:
      The 12-digit account number of the Amazon Web Services account that manages the repository.

    • domainName

      public final String domainName()

      The name of the domain that contains the repository.

      Returns:
      The name of the domain that contains the repository.

    • domainOwner

      public final String domainOwner()

      The 12-digit account number of the Amazon Web Services account that owns the domain that contains the repository. It does not include dashes or spaces.

      Returns:
      The 12-digit account number of the Amazon Web Services account that owns the domain that contains the repository. It does not include dashes or spaces.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the repository.

      Returns:
      The Amazon Resource Name (ARN) of the repository.

    • description

      public final String description()

      A text description of the repository.

      Returns:
      A text description of the repository.

    • hasUpstreams

      public final boolean hasUpstreams()
      For responses, this returns true if the service returned a value for the Upstreams 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.

    • upstreams

      public final List<UpstreamRepositoryInfo> upstreams()

      A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories.

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

      Returns:
      A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories.

    • hasExternalConnections

      public final boolean hasExternalConnections()
      For responses, this returns true if the service returned a value for the ExternalConnections 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.

    • externalConnections

      public final List<RepositoryExternalConnectionInfo> externalConnections()

      An array of external connections associated with the repository.

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

      Returns:
      An array of external connections associated with the repository.

    • createdTime

      public final Instant createdTime()

      A timestamp that represents the date and time the repository was created.

      Returns:
      A timestamp that represents the date and time the repository was created.

    • toBuilder

      public RepositoryDescription.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<RepositoryDescription.Builder,RepositoryDescription>
      Returns:
      a builder for type T

    • builder

      public static RepositoryDescription.Builder builder()

    • serializableBuilderClass

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