« blib/lib/Paws/CodeArtifact/GetPackageVersionAssetResult.pm
↑ Summary
blib/lib/Paws/CodeArtifact/GetPackageVersionReadmeResult.pm »
| 1 | |||
| 2 | package Paws::CodeArtifact::GetPackageVersionReadme; | ||
| 3 | use Moose; | ||
| 4 | has Domain => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'domain', required => 1); | ||
| 5 | has DomainOwner => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'domain-owner'); | ||
| 6 | has Format => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'format', required => 1); | ||
| 7 | has Namespace => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'namespace'); | ||
| 8 | has Package => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'package', required => 1); | ||
| 9 | has PackageVersion => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'version', required => 1); | ||
| 10 | has Repository => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'repository', required => 1); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetPackageVersionReadme'); | ||
| 15 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/package/version/readme'); | ||
| 16 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CodeArtifact::GetPackageVersionReadmeResult'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::CodeArtifact::GetPackageVersionReadme - Arguments for method GetPackageVersionReadme on L<Paws::CodeArtifact> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method GetPackageVersionReadme on the | ||
| 29 | L<CodeArtifact|Paws::CodeArtifact> service. Use the attributes of this class | ||
| 30 | as arguments to method GetPackageVersionReadme. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetPackageVersionReadme. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $codeartifact = Paws->service('CodeArtifact'); | ||
| 37 | my $GetPackageVersionReadmeResult = $codeartifact->GetPackageVersionReadme( | ||
| 38 | Domain => 'MyDomainName', | ||
| 39 | Format => 'npm', | ||
| 40 | Package => 'MyPackageName', | ||
| 41 | PackageVersion => 'MyPackageVersion', | ||
| 42 | Repository => 'MyRepositoryName', | ||
| 43 | DomainOwner => 'MyAccountId', # OPTIONAL | ||
| 44 | Namespace => 'MyPackageNamespace', # OPTIONAL | ||
| 45 | ); | ||
| 46 | |||
| 47 | # Results: | ||
| 48 | my $Format = $GetPackageVersionReadmeResult->Format; | ||
| 49 | my $Namespace = $GetPackageVersionReadmeResult->Namespace; | ||
| 50 | my $Package = $GetPackageVersionReadmeResult->Package; | ||
| 51 | my $Readme = $GetPackageVersionReadmeResult->Readme; | ||
| 52 | my $Version = $GetPackageVersionReadmeResult->Version; | ||
| 53 | my $VersionRevision = $GetPackageVersionReadmeResult->VersionRevision; | ||
| 54 | |||
| 55 | # Returns a L<Paws::CodeArtifact::GetPackageVersionReadmeResult> object. | ||
| 56 | |||
| 57 | 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. | ||
| 58 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/codeartifact/GetPackageVersionReadme> | ||
| 59 | |||
| 60 | =head1 ATTRIBUTES | ||
| 61 | |||
| 62 | |||
| 63 | =head2 B<REQUIRED> Domain => Str | ||
| 64 | |||
| 65 | The name of the domain that contains the repository that contains the | ||
| 66 | package version with the requested readme file. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 DomainOwner => Str | ||
| 71 | |||
| 72 | The 12-digit account number of the AWS account that owns the domain. It | ||
| 73 | does not include dashes or spaces. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 B<REQUIRED> Format => Str | ||
| 78 | |||
| 79 | A format that specifies the type of the package version with the | ||
| 80 | requested readme file. The valid values are: | ||
| 81 | |||
| 82 | =over | ||
| 83 | |||
| 84 | =item * | ||
| 85 | |||
| 86 | C<npm> | ||
| 87 | |||
| 88 | =item * | ||
| 89 | |||
| 90 | C<pypi> | ||
| 91 | |||
| 92 | =item * | ||
| 93 | |||
| 94 | C<maven> | ||
| 95 | |||
| 96 | =back | ||
| 97 | |||
| 98 | |||
| 99 | Valid values are: C<"npm">, C<"pypi">, C<"maven">, C<"nuget"> | ||
| 100 | |||
| 101 | =head2 Namespace => Str | ||
| 102 | |||
| 103 | The namespace of the package. The package component that specifies its | ||
| 104 | namespace depends on its type. For example: | ||
| 105 | |||
| 106 | =over | ||
| 107 | |||
| 108 | =item * | ||
| 109 | |||
| 110 | The namespace of a Maven package is its C<groupId>. | ||
| 111 | |||
| 112 | =item * | ||
| 113 | |||
| 114 | The namespace of an npm package is its C<scope>. | ||
| 115 | |||
| 116 | =item * | ||
| 117 | |||
| 118 | A Python package does not contain a corresponding component, so Python | ||
| 119 | packages do not have a namespace. | ||
| 120 | |||
| 121 | =back | ||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | |||
| 126 | =head2 B<REQUIRED> Package => Str | ||
| 127 | |||
| 128 | The name of the package version that contains the requested readme | ||
| 129 | file. | ||
| 130 | |||
| 131 | |||
| 132 | |||
| 133 | =head2 B<REQUIRED> PackageVersion => Str | ||
| 134 | |||
| 135 | A string that contains the package version (for example, C<3.5.2>). | ||
| 136 | |||
| 137 | |||
| 138 | |||
| 139 | =head2 B<REQUIRED> Repository => Str | ||
| 140 | |||
| 141 | The repository that contains the package with the requested readme | ||
| 142 | file. | ||
| 143 | |||
| 144 | |||
| 145 | |||
| 146 | |||
| 147 | =head1 SEE ALSO | ||
| 148 | |||
| 149 | This class forms part of L<Paws>, documenting arguments for method GetPackageVersionReadme in L<Paws::CodeArtifact> | ||
| 150 | |||
| 151 | =head1 BUGS and CONTRIBUTIONS | ||
| 152 | |||
| 153 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 154 | |||
| 155 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 156 | |||
| 157 | =cut | ||
| 158 |