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