« blib/lib/Paws/RDSData/RollbackTransactionResponse.pm
↑ Summary
blib/lib/Paws/RDSData/SqlStatementResult.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::RDSData::SqlParameter; | ||
| 3 | use Moose; | ||
| 4 | has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest']); | ||
| 5 | has TypeHint => (is => 'ro', isa => 'Str', request_name => 'typeHint', traits => ['NameInRequest']); | ||
| 6 | has Value => (is => 'ro', isa => 'Paws::RDSData::Field', request_name => 'value', traits => ['NameInRequest']); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::RDSData::SqlParameter | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::RDSData::SqlParameter object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { Name => $value, ..., Value => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::RDSData::SqlParameter object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->Name | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | A parameter used in a SQL statement. | ||
| 39 | |||
| 40 | =head1 ATTRIBUTES | ||
| 41 | |||
| 42 | |||
| 43 | =head2 Name => Str | ||
| 44 | |||
| 45 | The name of the parameter. | ||
| 46 | |||
| 47 | |||
| 48 | =head2 TypeHint => Str | ||
| 49 | |||
| 50 | A hint that specifies the correct object type for data type mapping. | ||
| 51 | Possible values are as follows: | ||
| 52 | |||
| 53 | =over | ||
| 54 | |||
| 55 | =item * | ||
| 56 | |||
| 57 | C<DATE> - The corresponding C<String> parameter value is sent as an | ||
| 58 | object of C<DATE> type to the database. The accepted format is | ||
| 59 | C<YYYY-MM-DD>. | ||
| 60 | |||
| 61 | =item * | ||
| 62 | |||
| 63 | C<DECIMAL> - The corresponding C<String> parameter value is sent as an | ||
| 64 | object of C<DECIMAL> type to the database. | ||
| 65 | |||
| 66 | =item * | ||
| 67 | |||
| 68 | C<JSON> - The corresponding C<String> parameter value is sent as an | ||
| 69 | object of C<JSON> type to the database. | ||
| 70 | |||
| 71 | =item * | ||
| 72 | |||
| 73 | C<TIME> - The corresponding C<String> parameter value is sent as an | ||
| 74 | object of C<TIME> type to the database. The accepted format is | ||
| 75 | C<HH:MM:SS[.FFF]>. | ||
| 76 | |||
| 77 | =item * | ||
| 78 | |||
| 79 | C<TIMESTAMP> - The corresponding C<String> parameter value is sent as | ||
| 80 | an object of C<TIMESTAMP> type to the database. The accepted format is | ||
| 81 | C<YYYY-MM-DD HH:MM:SS[.FFF]>. | ||
| 82 | |||
| 83 | =item * | ||
| 84 | |||
| 85 | C<UUID> - The corresponding C<String> parameter value is sent as an | ||
| 86 | object of C<UUID> type to the database. | ||
| 87 | |||
| 88 | =back | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 Value => L<Paws::RDSData::Field> | ||
| 93 | |||
| 94 | The value of the parameter. | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | =head1 SEE ALSO | ||
| 99 | |||
| 100 | This class forms part of L<Paws>, describing an object used in L<Paws::RDSData> | ||
| 101 | |||
| 102 | =head1 BUGS and CONTRIBUTIONS | ||
| 103 | |||
| 104 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 105 | |||
| 106 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 107 | |||
| 108 | =cut | ||
| 109 |