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

Class CopyPackageVersionsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.codeartifact.model.CodeartifactRequest
software.amazon.awssdk.services.codeartifact.model.CopyPackageVersionsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CopyPackageVersionsRequest.Builder,CopyPackageVersionsRequest>
@Generated("software.amazon.awssdk:codegen") public final class CopyPackageVersionsRequest extends CodeartifactRequest implements ToCopyableBuilder<CopyPackageVersionsRequest.Builder,CopyPackageVersionsRequest>

  • Method Details

    • domain

      public final String domain()

      The name of the domain that contains the source and destination repositories.

      Returns:
      The name of the domain that contains the source and destination repositories.

    • domainOwner

      public final String domainOwner()

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

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

    • sourceRepository

      public final String sourceRepository()

      The name of the repository that contains the package versions to be copied.

      Returns:
      The name of the repository that contains the package versions to be copied.

    • destinationRepository

      public final String destinationRepository()

      The name of the repository into which package versions are copied.

      Returns:
      The name of the repository into which package versions are copied.

    • format

      public final PackageFormat format()

      The format of the package versions to be copied.

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

      Returns:
      The format of the package versions to be copied.
      See Also:

    • formatAsString

      public final String formatAsString()

      The format of the package versions to be copied.

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

      Returns:
      The format of the package versions to be copied.
      See Also:

    • namespace

      public final String namespace()

      The namespace of the package versions to be copied. The package component that specifies its namespace depends on its type. For example:

      The namespace is required when copying package versions of the following formats:

      • Maven

      • Swift

      • generic

      • The namespace of a Maven package version is its groupId.

      • The namespace of an npm or Swift package version is its scope.

      • The namespace of a generic package is its namespace.

      • Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

      Returns:
      The namespace of the package versions to be copied. The package component that specifies its namespace depends on its type. For example:

      The namespace is required when copying package versions of the following formats:

      • Maven

      • Swift

      • generic

      • The namespace of a Maven package version is its groupId.

      • The namespace of an npm or Swift package version is its scope.

      • The namespace of a generic package is its namespace.

      • Python, NuGet, and Ruby package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

    • packageValue

      public final String packageValue()

      The name of the package that contains the versions to be copied.

      Returns:
      The name of the package that contains the versions to be copied.

    • hasVersions

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

    • versions

      public final List<String> versions()

      The versions of the package to be copied.

      You must specify versions or versionRevisions. You cannot specify both.

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

      Returns:
      The versions of the package to be copied.

      You must specify versions or versionRevisions. You cannot specify both.

    • hasVersionRevisions

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

    • versionRevisions

      public final Map<String,String> versionRevisions()

      A list of key-value pairs. The keys are package versions and the values are package version revisions. A CopyPackageVersion operation succeeds if the specified versions in the source repository match the specified package version revision.

      You must specify versions or versionRevisions. You cannot specify both.

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

      Returns:
      A list of key-value pairs. The keys are package versions and the values are package version revisions. A CopyPackageVersion operation succeeds if the specified versions in the source repository match the specified package version revision.

      You must specify versions or versionRevisions. You cannot specify both.

    • allowOverwrite

      public final Boolean allowOverwrite()

      Set to true to overwrite a package version that already exists in the destination repository. If set to false and the package version already exists in the destination repository, the package version is returned in the failedVersions field of the response with an ALREADY_EXISTS error code.

      Returns:
      Set to true to overwrite a package version that already exists in the destination repository. If set to false and the package version already exists in the destination repository, the package version is returned in the failedVersions field of the response with an ALREADY_EXISTS error code.

    • includeFromUpstream

      public final Boolean includeFromUpstream()

      Set to true to copy packages from repositories that are upstream from the source repository to the destination repository. The default setting is false. For more information, see Working with upstream repositories.

      Returns:
      Set to true to copy packages from repositories that are upstream from the source repository to the destination repository. The default setting is false. For more information, see Working with upstream repositories.

    • toBuilder

      public CopyPackageVersionsRequest.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<CopyPackageVersionsRequest.Builder,CopyPackageVersionsRequest>
      Specified by:
      toBuilder in class CodeartifactRequest
      Returns:
      a builder for type T

    • builder

      public static CopyPackageVersionsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CopyPackageVersionsRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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