| 1 | |||
| 2 | package Paws::QLDB::GetRevision; | ||
| 3 | use Moose; | ||
| 4 | has BlockAddress => (is => 'ro', isa => 'Paws::QLDB::ValueHolder', required => 1); | ||
| 5 | has DigestTipAddress => (is => 'ro', isa => 'Paws::QLDB::ValueHolder'); | ||
| 6 | has DocumentId => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has Name => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'name', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetRevision'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/ledgers/{name}/revision'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::QLDB::GetRevisionResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::QLDB::GetRevision - Arguments for method GetRevision on L<Paws::QLDB> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method GetRevision on the | ||
| 26 | L<Amazon QLDB|Paws::QLDB> service. Use the attributes of this class | ||
| 27 | as arguments to method GetRevision. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetRevision. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $qldb = Paws->service('QLDB'); | ||
| 34 | my $GetRevisionResponse = $qldb->GetRevision( | ||
| 35 | BlockAddress => { | ||
| 36 | IonText => 'MyIonText', # min: 1, max: 1048576; OPTIONAL | ||
| 37 | }, | ||
| 38 | DocumentId => 'MyUniqueId', | ||
| 39 | Name => 'MyLedgerName', | ||
| 40 | DigestTipAddress => { | ||
| 41 | IonText => 'MyIonText', # min: 1, max: 1048576; OPTIONAL | ||
| 42 | }, # OPTIONAL | ||
| 43 | ); | ||
| 44 | |||
| 45 | # Results: | ||
| 46 | my $Proof = $GetRevisionResponse->Proof; | ||
| 47 | my $Revision = $GetRevisionResponse->Revision; | ||
| 48 | |||
| 49 | # Returns a L<Paws::QLDB::GetRevisionResponse> object. | ||
| 50 | |||
| 51 | 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. | ||
| 52 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/qldb/GetRevision> | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 B<REQUIRED> BlockAddress => L<Paws::QLDB::ValueHolder> | ||
| 58 | |||
| 59 | The block location of the document revision to be verified. An address | ||
| 60 | is an Amazon Ion structure that has two fields: C<strandId> and | ||
| 61 | C<sequenceNo>. | ||
| 62 | |||
| 63 | For example: C<{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14}>. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 DigestTipAddress => L<Paws::QLDB::ValueHolder> | ||
| 68 | |||
| 69 | The latest block location covered by the digest for which to request a | ||
| 70 | proof. An address is an Amazon Ion structure that has two fields: | ||
| 71 | C<strandId> and C<sequenceNo>. | ||
| 72 | |||
| 73 | For example: C<{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49}>. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 B<REQUIRED> DocumentId => Str | ||
| 78 | |||
| 79 | The UUID (represented in Base62-encoded text) of the document to be | ||
| 80 | verified. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head2 B<REQUIRED> Name => Str | ||
| 85 | |||
| 86 | The name of the ledger. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head1 SEE ALSO | ||
| 92 | |||
| 93 | This class forms part of L<Paws>, documenting arguments for method GetRevision in L<Paws::QLDB> | ||
| 94 | |||
| 95 | =head1 BUGS and CONTRIBUTIONS | ||
| 96 | |||
| 97 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 98 | |||
| 99 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 100 | |||
| 101 | =cut | ||
| 102 |