« blib/lib/Paws/CodeArtifact/PackageSummary.pm
↑ Summary
blib/lib/Paws/CodeArtifact/PackageVersionError.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CodeArtifact::PackageVersionDescription; | ||
| 3 | use Moose; | ||
| 4 | has DisplayName => (is => 'ro', isa => 'Str', request_name => 'displayName', traits => ['NameInRequest']); | ||
| 5 | has Format => (is => 'ro', isa => 'Str', request_name => 'format', traits => ['NameInRequest']); | ||
| 6 | has HomePage => (is => 'ro', isa => 'Str', request_name => 'homePage', traits => ['NameInRequest']); | ||
| 7 | has Licenses => (is => 'ro', isa => 'ArrayRef[Paws::CodeArtifact::LicenseInfo]', request_name => 'licenses', traits => ['NameInRequest']); | ||
| 8 | has Namespace => (is => 'ro', isa => 'Str', request_name => 'namespace', traits => ['NameInRequest']); | ||
| 9 | has PackageName => (is => 'ro', isa => 'Str', request_name => 'packageName', traits => ['NameInRequest']); | ||
| 10 | has PublishedTime => (is => 'ro', isa => 'Str', request_name => 'publishedTime', traits => ['NameInRequest']); | ||
| 11 | has Revision => (is => 'ro', isa => 'Str', request_name => 'revision', traits => ['NameInRequest']); | ||
| 12 | has SourceCodeRepository => (is => 'ro', isa => 'Str', request_name => 'sourceCodeRepository', traits => ['NameInRequest']); | ||
| 13 | has Status => (is => 'ro', isa => 'Str', request_name => 'status', traits => ['NameInRequest']); | ||
| 14 | has Summary => (is => 'ro', isa => 'Str', request_name => 'summary', traits => ['NameInRequest']); | ||
| 15 | has Version => (is => 'ro', isa => 'Str', request_name => 'version', traits => ['NameInRequest']); | ||
| 16 | |||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::CodeArtifact::PackageVersionDescription | ||
| 24 | |||
| 25 | =head1 USAGE | ||
| 26 | |||
| 27 | This class represents one of two things: | ||
| 28 | |||
| 29 | =head3 Arguments in a call to a service | ||
| 30 | |||
| 31 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 32 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 33 | |||
| 34 | As an example, if Att1 is expected to be a Paws::CodeArtifact::PackageVersionDescription object: | ||
| 35 | |||
| 36 | $service_obj->Method(Att1 => { DisplayName => $value, ..., Version => $value }); | ||
| 37 | |||
| 38 | =head3 Results returned from an API call | ||
| 39 | |||
| 40 | Use accessors for each attribute. If Att1 is expected to be an Paws::CodeArtifact::PackageVersionDescription object: | ||
| 41 | |||
| 42 | $result = $service_obj->Method(...); | ||
| 43 | $result->Att1->DisplayName | ||
| 44 | |||
| 45 | =head1 DESCRIPTION | ||
| 46 | |||
| 47 | Details about a package version. | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 DisplayName => Str | ||
| 53 | |||
| 54 | The name of the package that is displayed. The C<displayName> varies | ||
| 55 | depending on the package version's format. For example, if an npm | ||
| 56 | package is named C<ui>, is in the namespace C<vue>, and has the format | ||
| 57 | C<npm>, then the C<displayName> is C<@vue/ui>. | ||
| 58 | |||
| 59 | |||
| 60 | =head2 Format => Str | ||
| 61 | |||
| 62 | The format of the package version. The valid package formats are: | ||
| 63 | |||
| 64 | =over | ||
| 65 | |||
| 66 | =item * | ||
| 67 | |||
| 68 | C<npm>: A Node Package Manager (npm) package. | ||
| 69 | |||
| 70 | =item * | ||
| 71 | |||
| 72 | C<pypi>: A Python Package Index (PyPI) package. | ||
| 73 | |||
| 74 | =item * | ||
| 75 | |||
| 76 | C<maven>: A Maven package that contains compiled code in a | ||
| 77 | distributable format, such as a JAR file. | ||
| 78 | |||
| 79 | =back | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 HomePage => Str | ||
| 84 | |||
| 85 | The homepage associated with the package. | ||
| 86 | |||
| 87 | |||
| 88 | =head2 Licenses => ArrayRef[L<Paws::CodeArtifact::LicenseInfo>] | ||
| 89 | |||
| 90 | Information about licenses associated with the package version. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 Namespace => Str | ||
| 94 | |||
| 95 | The namespace of the package. The package component that specifies its | ||
| 96 | namespace depends on its type. For example: | ||
| 97 | |||
| 98 | =over | ||
| 99 | |||
| 100 | =item * | ||
| 101 | |||
| 102 | The namespace of a Maven package is its C<groupId>. | ||
| 103 | |||
| 104 | =item * | ||
| 105 | |||
| 106 | The namespace of an npm package is its C<scope>. | ||
| 107 | |||
| 108 | =item * | ||
| 109 | |||
| 110 | A Python package does not contain a corresponding component, so Python | ||
| 111 | packages do not have a namespace. | ||
| 112 | |||
| 113 | =back | ||
| 114 | |||
| 115 | |||
| 116 | |||
| 117 | =head2 PackageName => Str | ||
| 118 | |||
| 119 | The name of the requested package. | ||
| 120 | |||
| 121 | |||
| 122 | =head2 PublishedTime => Str | ||
| 123 | |||
| 124 | A timestamp that contains the date and time the package version was | ||
| 125 | published. | ||
| 126 | |||
| 127 | |||
| 128 | =head2 Revision => Str | ||
| 129 | |||
| 130 | The revision of the package version. | ||
| 131 | |||
| 132 | |||
| 133 | =head2 SourceCodeRepository => Str | ||
| 134 | |||
| 135 | The repository for the source code in the package version, or the | ||
| 136 | source code used to build it. | ||
| 137 | |||
| 138 | |||
| 139 | =head2 Status => Str | ||
| 140 | |||
| 141 | A string that contains the status of the package version. It can be one | ||
| 142 | of the following: | ||
| 143 | |||
| 144 | =over | ||
| 145 | |||
| 146 | =item * | ||
| 147 | |||
| 148 | C<Published> | ||
| 149 | |||
| 150 | =item * | ||
| 151 | |||
| 152 | C<Unfinished> | ||
| 153 | |||
| 154 | =item * | ||
| 155 | |||
| 156 | C<Unlisted> | ||
| 157 | |||
| 158 | =item * | ||
| 159 | |||
| 160 | C<Archived> | ||
| 161 | |||
| 162 | =item * | ||
| 163 | |||
| 164 | C<Disposed> | ||
| 165 | |||
| 166 | =back | ||
| 167 | |||
| 168 | |||
| 169 | |||
| 170 | =head2 Summary => Str | ||
| 171 | |||
| 172 | A summary of the package version. The summary is extracted from the | ||
| 173 | package. The information in and detail level of the summary depends on | ||
| 174 | the package version's format. | ||
| 175 | |||
| 176 | |||
| 177 | =head2 Version => Str | ||
| 178 | |||
| 179 | The version of the package. | ||
| 180 | |||
| 181 | |||
| 182 | |||
| 183 | =head1 SEE ALSO | ||
| 184 | |||
| 185 | This class forms part of L<Paws>, describing an object used in L<Paws::CodeArtifact> | ||
| 186 | |||
| 187 | =head1 BUGS and CONTRIBUTIONS | ||
| 188 | |||
| 189 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 190 | |||
| 191 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 192 | |||
| 193 | =cut | ||
| 194 |