Class CopyPackageVersionsRequest

    • Method Detail

      • 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.
      • 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:
        PackageFormat
      • namespace

        public final String namespace()

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

        • The namespace of a Maven package version is its groupId. The namespace is required when copying Maven package versions.

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

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

        • The namespace of a generic package is its namespace.

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

        • The namespace of a Maven package version is its groupId. The namespace is required when copying Maven package versions.

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

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

        • The namespace of a generic package is its 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.
      • 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