« blib/lib/Paws/CodeArtifact/AssociateExternalConnectionResult.pm
↑ Summary
blib/lib/Paws/CodeArtifact/CopyPackageVersionsResult.pm »
| 1 | |||
| 2 | package Paws::CodeArtifact::CopyPackageVersions; | ||
| 3 | use Moose; | ||
| 4 | has AllowOverwrite => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'allowOverwrite'); | ||
| 5 | has DestinationRepository => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'destination-repository', required => 1); | ||
| 6 | has Domain => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'domain', required => 1); | ||
| 7 | has DomainOwner => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'domain-owner'); | ||
| 8 | has Format => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'format', required => 1); | ||
| 9 | has IncludeFromUpstream => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'includeFromUpstream'); | ||
| 10 | has Namespace => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'namespace'); | ||
| 11 | has Package => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'package', required => 1); | ||
| 12 | has SourceRepository => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'source-repository', required => 1); | ||
| 13 | has VersionRevisions => (is => 'ro', isa => 'Paws::CodeArtifact::PackageVersionRevisionMap', traits => ['NameInRequest'], request_name => 'versionRevisions'); | ||
| 14 | has Versions => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'versions'); | ||
| 15 | |||
| 16 | use MooseX::ClassAttribute; | ||
| 17 | |||
| 18 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CopyPackageVersions'); | ||
| 19 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/package/versions/copy'); | ||
| 20 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 21 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CodeArtifact::CopyPackageVersionsResult'); | ||
| 22 | 1; | ||
| 23 | |||
| 24 | ### main pod documentation begin ### | ||
| 25 | |||
| 26 | =head1 NAME | ||
| 27 | |||
| 28 | Paws::CodeArtifact::CopyPackageVersions - Arguments for method CopyPackageVersions on L<Paws::CodeArtifact> | ||
| 29 | |||
| 30 | =head1 DESCRIPTION | ||
| 31 | |||
| 32 | This class represents the parameters used for calling the method CopyPackageVersions on the | ||
| 33 | L<CodeArtifact|Paws::CodeArtifact> service. Use the attributes of this class | ||
| 34 | as arguments to method CopyPackageVersions. | ||
| 35 | |||
| 36 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CopyPackageVersions. | ||
| 37 | |||
| 38 | =head1 SYNOPSIS | ||
| 39 | |||
| 40 | my $codeartifact = Paws->service('CodeArtifact'); | ||
| 41 | my $CopyPackageVersionsResult = $codeartifact->CopyPackageVersions( | ||
| 42 | DestinationRepository => 'MyRepositoryName', | ||
| 43 | Domain => 'MyDomainName', | ||
| 44 | Format => 'npm', | ||
| 45 | Package => 'MyPackageName', | ||
| 46 | SourceRepository => 'MyRepositoryName', | ||
| 47 | AllowOverwrite => 1, # OPTIONAL | ||
| 48 | DomainOwner => 'MyAccountId', # OPTIONAL | ||
| 49 | IncludeFromUpstream => 1, # OPTIONAL | ||
| 50 | Namespace => 'MyPackageNamespace', # OPTIONAL | ||
| 51 | VersionRevisions => { | ||
| 52 | 'MyPackageVersion' => 'MyPackageVersionRevision' | ||
| 53 | , # key: min: 1, max: 255, value: min: 1, max: 50 | ||
| 54 | }, # OPTIONAL | ||
| 55 | Versions => [ | ||
| 56 | 'MyPackageVersion', ... # min: 1, max: 255 | ||
| 57 | ], # OPTIONAL | ||
| 58 | ); | ||
| 59 | |||
| 60 | # Results: | ||
| 61 | my $FailedVersions = $CopyPackageVersionsResult->FailedVersions; | ||
| 62 | my $SuccessfulVersions = $CopyPackageVersionsResult->SuccessfulVersions; | ||
| 63 | |||
| 64 | # Returns a L<Paws::CodeArtifact::CopyPackageVersionsResult> object. | ||
| 65 | |||
| 66 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 67 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/codeartifact/CopyPackageVersions> | ||
| 68 | |||
| 69 | =head1 ATTRIBUTES | ||
| 70 | |||
| 71 | |||
| 72 | =head2 AllowOverwrite => Bool | ||
| 73 | |||
| 74 | Set to true to overwrite a package version that already exists in the | ||
| 75 | destination repository. If set to false and the package version already | ||
| 76 | exists in the destination repository, the package version is returned | ||
| 77 | in the C<failedVersions> field of the response with an | ||
| 78 | C<ALREADY_EXISTS> error code. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 B<REQUIRED> DestinationRepository => Str | ||
| 83 | |||
| 84 | The name of the repository into which package versions are copied. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 B<REQUIRED> Domain => Str | ||
| 89 | |||
| 90 | The name of the domain that contains the source and destination | ||
| 91 | repositories. | ||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head2 DomainOwner => Str | ||
| 96 | |||
| 97 | The 12-digit account number of the AWS account that owns the domain. It | ||
| 98 | does not include dashes or spaces. | ||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | =head2 B<REQUIRED> Format => Str | ||
| 103 | |||
| 104 | The format of the package that is copied. The valid package types are: | ||
| 105 | |||
| 106 | =over | ||
| 107 | |||
| 108 | =item * | ||
| 109 | |||
| 110 | C<npm>: A Node Package Manager (npm) package. | ||
| 111 | |||
| 112 | =item * | ||
| 113 | |||
| 114 | C<pypi>: A Python Package Index (PyPI) package. | ||
| 115 | |||
| 116 | =item * | ||
| 117 | |||
| 118 | C<maven>: A Maven package that contains compiled code in a | ||
| 119 | distributable format, such as a JAR file. | ||
| 120 | |||
| 121 | =back | ||
| 122 | |||
| 123 | |||
| 124 | Valid values are: C<"npm">, C<"pypi">, C<"maven">, C<"nuget"> | ||
| 125 | |||
| 126 | =head2 IncludeFromUpstream => Bool | ||
| 127 | |||
| 128 | Set to true to copy packages from repositories that are upstream from | ||
| 129 | the source repository to the destination repository. The default | ||
| 130 | setting is false. For more information, see Working with upstream | ||
| 131 | repositories | ||
| 132 | (https://docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html). | ||
| 133 | |||
| 134 | |||
| 135 | |||
| 136 | =head2 Namespace => Str | ||
| 137 | |||
| 138 | The namespace of the package. The package component that specifies its | ||
| 139 | namespace depends on its type. For example: | ||
| 140 | |||
| 141 | =over | ||
| 142 | |||
| 143 | =item * | ||
| 144 | |||
| 145 | The namespace of a Maven package is its C<groupId>. | ||
| 146 | |||
| 147 | =item * | ||
| 148 | |||
| 149 | The namespace of an npm package is its C<scope>. | ||
| 150 | |||
| 151 | =item * | ||
| 152 | |||
| 153 | A Python package does not contain a corresponding component, so Python | ||
| 154 | packages do not have a namespace. | ||
| 155 | |||
| 156 | =back | ||
| 157 | |||
| 158 | |||
| 159 | |||
| 160 | |||
| 161 | =head2 B<REQUIRED> Package => Str | ||
| 162 | |||
| 163 | The name of the package that is copied. | ||
| 164 | |||
| 165 | |||
| 166 | |||
| 167 | =head2 B<REQUIRED> SourceRepository => Str | ||
| 168 | |||
| 169 | The name of the repository that contains the package versions to copy. | ||
| 170 | |||
| 171 | |||
| 172 | |||
| 173 | =head2 VersionRevisions => L<Paws::CodeArtifact::PackageVersionRevisionMap> | ||
| 174 | |||
| 175 | A list of key-value pairs. The keys are package versions and the values | ||
| 176 | are package version revisions. A C<CopyPackageVersion> operation | ||
| 177 | succeeds if the specified versions in the source repository match the | ||
| 178 | specified package version revision. | ||
| 179 | |||
| 180 | You must specify C<versions> or C<versionRevisions>. You cannot specify | ||
| 181 | both. | ||
| 182 | |||
| 183 | |||
| 184 | |||
| 185 | =head2 Versions => ArrayRef[Str|Undef] | ||
| 186 | |||
| 187 | The versions of the package to copy. | ||
| 188 | |||
| 189 | You must specify C<versions> or C<versionRevisions>. You cannot specify | ||
| 190 | both. | ||
| 191 | |||
| 192 | |||
| 193 | |||
| 194 | |||
| 195 | =head1 SEE ALSO | ||
| 196 | |||
| 197 | This class forms part of L<Paws>, documenting arguments for method CopyPackageVersions in L<Paws::CodeArtifact> | ||
| 198 | |||
| 199 | =head1 BUGS and CONTRIBUTIONS | ||
| 200 | |||
| 201 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 202 | |||
| 203 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 204 | |||
| 205 | =cut | ||
| 206 |