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>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCopyPackageVersionsRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description BooleanallowOverwrite()Set to true to overwrite a package version that already exists in the destination repository.static CopyPackageVersionsRequest.Builderbuilder()StringdestinationRepository()The name of the repository into which package versions are copied.Stringdomain()The name of the domain that contains the source and destination repositories.StringdomainOwner()The 12-digit account number of the Amazon Web Services account that owns the domain.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)PackageFormatformat()The format of the package versions to be copied.StringformatAsString()The format of the package versions to be copied.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasVersionRevisions()For responses, this returns true if the service returned a value for the VersionRevisions property.booleanhasVersions()For responses, this returns true if the service returned a value for the Versions property.BooleanincludeFromUpstream()Set to true to copy packages from repositories that are upstream from the source repository to the destination repository.Stringnamespace()The namespace of the package versions to be copied.StringpackageValue()The name of the package that contains the versions to be copied.List<SdkField<?>>sdkFields()static Class<? extends CopyPackageVersionsRequest.Builder>serializableBuilderClass()StringsourceRepository()The name of the repository that contains the package versions to be copied.CopyPackageVersionsRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.Map<String,String>versionRevisions()A list of key-value pairs.List<String>versions()The versions of the package to be copied.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
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
-
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,
formatwill returnPackageFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromformatAsString().- Returns:
- The format of the package versions to be copied.
- See Also:
PackageFormat
-
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,
formatwill returnPackageFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromformatAsString().- 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 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.
-
versions
public final List<String> versions()
The versions of the package to be copied.
You must specify
versionsorversionRevisions. 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
versionsorversionRevisions. 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 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.
-
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
CopyPackageVersionoperation succeeds if the specified versions in the source repository match the specified package version revision.You must specify
versionsorversionRevisions. 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
CopyPackageVersionoperation succeeds if the specified versions in the source repository match the specified package version revision.You must specify
versionsorversionRevisions. 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
failedVersionsfield of the response with anALREADY_EXISTSerror 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
failedVersionsfield of the response with anALREADY_EXISTSerror 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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CopyPackageVersionsRequest.Builder,CopyPackageVersionsRequest>- Specified by:
toBuilderin classCodeartifactRequest
-
builder
public static CopyPackageVersionsRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CopyPackageVersionsRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-