| 1 | |||
| 2 | package Paws::CodeCommit::GetFolder; | ||
| 3 | use Moose; | ||
| 4 | has CommitSpecifier => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'commitSpecifier' ); | ||
| 5 | has FolderPath => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'folderPath' , required => 1); | ||
| 6 | has RepositoryName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'repositoryName' , required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetFolder'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CodeCommit::GetFolderOutput'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::CodeCommit::GetFolder - Arguments for method GetFolder on L<Paws::CodeCommit> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method GetFolder on the | ||
| 24 | L<AWS CodeCommit|Paws::CodeCommit> service. Use the attributes of this class | ||
| 25 | as arguments to method GetFolder. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetFolder. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $codecommit = Paws->service('CodeCommit'); | ||
| 32 | my $GetFolderOutput = $codecommit->GetFolder( | ||
| 33 | FolderPath => 'MyPath', | ||
| 34 | RepositoryName => 'MyRepositoryName', | ||
| 35 | CommitSpecifier => 'MyCommitName', # OPTIONAL | ||
| 36 | ); | ||
| 37 | |||
| 38 | # Results: | ||
| 39 | my $CommitId = $GetFolderOutput->CommitId; | ||
| 40 | my $Files = $GetFolderOutput->Files; | ||
| 41 | my $FolderPath = $GetFolderOutput->FolderPath; | ||
| 42 | my $SubFolders = $GetFolderOutput->SubFolders; | ||
| 43 | my $SubModules = $GetFolderOutput->SubModules; | ||
| 44 | my $SymbolicLinks = $GetFolderOutput->SymbolicLinks; | ||
| 45 | my $TreeId = $GetFolderOutput->TreeId; | ||
| 46 | |||
| 47 | # Returns a L<Paws::CodeCommit::GetFolderOutput> object. | ||
| 48 | |||
| 49 | 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. | ||
| 50 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/codecommit/GetFolder> | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 CommitSpecifier => Str | ||
| 56 | |||
| 57 | A fully qualified reference used to identify a commit that contains the | ||
| 58 | version of the folder's content to return. A fully qualified reference | ||
| 59 | can be a commit ID, branch name, tag, or reference such as HEAD. If no | ||
| 60 | specifier is provided, the folder content is returned as it exists in | ||
| 61 | the HEAD commit. | ||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head2 B<REQUIRED> FolderPath => Str | ||
| 66 | |||
| 67 | The fully qualified path to the folder whose contents are returned, | ||
| 68 | including the folder name. For example, /examples is a fully-qualified | ||
| 69 | path to a folder named examples that was created off of the root | ||
| 70 | directory (/) of a repository. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 B<REQUIRED> RepositoryName => Str | ||
| 75 | |||
| 76 | The name of the repository. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head1 SEE ALSO | ||
| 82 | |||
| 83 | This class forms part of L<Paws>, documenting arguments for method GetFolder in L<Paws::CodeCommit> | ||
| 84 | |||
| 85 | =head1 BUGS and CONTRIBUTIONS | ||
| 86 | |||
| 87 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 88 | |||
| 89 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 90 | |||
| 91 | =cut | ||
| 92 |