« blib/lib/Paws/CodeCommit/GetDifferencesOutput.pm
↑ Summary
blib/lib/Paws/CodeCommit/GetFileOutput.pm »
| 1 | |||
| 2 | package Paws::CodeCommit::GetFile; | ||
| 3 | use Moose; | ||
| 4 | has CommitSpecifier => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'commitSpecifier' ); | ||
| 5 | has FilePath => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'filePath' , 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 => 'GetFile'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CodeCommit::GetFileOutput'); | ||
| 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::GetFile - Arguments for method GetFile on L<Paws::CodeCommit> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method GetFile on the | ||
| 24 | L<AWS CodeCommit|Paws::CodeCommit> service. Use the attributes of this class | ||
| 25 | as arguments to method GetFile. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetFile. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $codecommit = Paws->service('CodeCommit'); | ||
| 32 | my $GetFileOutput = $codecommit->GetFile( | ||
| 33 | FilePath => 'MyPath', | ||
| 34 | RepositoryName => 'MyRepositoryName', | ||
| 35 | CommitSpecifier => 'MyCommitName', # OPTIONAL | ||
| 36 | ); | ||
| 37 | |||
| 38 | # Results: | ||
| 39 | my $BlobId = $GetFileOutput->BlobId; | ||
| 40 | my $CommitId = $GetFileOutput->CommitId; | ||
| 41 | my $FileContent = $GetFileOutput->FileContent; | ||
| 42 | my $FileMode = $GetFileOutput->FileMode; | ||
| 43 | my $FilePath = $GetFileOutput->FilePath; | ||
| 44 | my $FileSize = $GetFileOutput->FileSize; | ||
| 45 | |||
| 46 | # Returns a L<Paws::CodeCommit::GetFileOutput> object. | ||
| 47 | |||
| 48 | 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. | ||
| 49 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/codecommit/GetFile> | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 CommitSpecifier => Str | ||
| 55 | |||
| 56 | The fully quaified reference that identifies the commit that contains | ||
| 57 | the file. For example, you can specify a full commit ID, a tag, a | ||
| 58 | branch name, or a reference such as refs/heads/master. If none is | ||
| 59 | provided, the head commit is used. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head2 B<REQUIRED> FilePath => Str | ||
| 64 | |||
| 65 | The fully qualified path to the file, including the full name and | ||
| 66 | extension of the file. For example, /examples/file.md is the fully | ||
| 67 | qualified path to a file named file.md in a folder named examples. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 B<REQUIRED> RepositoryName => Str | ||
| 72 | |||
| 73 | The name of the repository that contains the file. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head1 SEE ALSO | ||
| 79 | |||
| 80 | This class forms part of L<Paws>, documenting arguments for method GetFile in L<Paws::CodeCommit> | ||
| 81 | |||
| 82 | =head1 BUGS and CONTRIBUTIONS | ||
| 83 | |||
| 84 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 85 | |||
| 86 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 87 | |||
| 88 | =cut | ||
| 89 |