| 1 | |||
| 2 | package Paws::TimestreamWrite::WriteRecords; | ||
| 3 | use Moose; | ||
| 4 | has CommonAttributes => (is => 'ro', isa => 'Paws::TimestreamWrite::Record'); | ||
| 5 | has DatabaseName => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has Records => (is => 'ro', isa => 'ArrayRef[Paws::TimestreamWrite::Record]', required => 1); | ||
| 7 | has TableName => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'WriteRecords'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::TimestreamWrite::WriteRecords - Arguments for method WriteRecords on L<Paws::TimestreamWrite> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method WriteRecords on the | ||
| 25 | L<Amazon Timestream Write|Paws::TimestreamWrite> service. Use the attributes of this class | ||
| 26 | as arguments to method WriteRecords. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to WriteRecords. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $ingest.timestream = Paws->service('TimestreamWrite'); | ||
| 33 | $ingest . timestream->WriteRecords( | ||
| 34 | DatabaseName => 'MyResourceName', | ||
| 35 | Records => [ | ||
| 36 | { | ||
| 37 | Dimensions => [ | ||
| 38 | { | ||
| 39 | Name => 'MyStringValue256', # min: 1, max: 256 | ||
| 40 | Value => 'MyStringValue2048', # min: 1, max: 2048 | ||
| 41 | DimensionValueType => 'VARCHAR', # values: VARCHAR; OPTIONAL | ||
| 42 | }, | ||
| 43 | ... | ||
| 44 | ], # max: 128; OPTIONAL | ||
| 45 | MeasureName => 'MyStringValue256', # min: 1, max: 256 | ||
| 46 | MeasureValue => 'MyStringValue2048', # min: 1, max: 2048 | ||
| 47 | MeasureValueType => | ||
| 48 | 'DOUBLE', # values: DOUBLE, BIGINT, VARCHAR, BOOLEAN; OPTIONAL | ||
| 49 | Time => 'MyStringValue256', # min: 1, max: 256 | ||
| 50 | TimeUnit => 'MILLISECONDS' | ||
| 51 | , # values: MILLISECONDS, SECONDS, MICROSECONDS, NANOSECONDS; OPTIONAL | ||
| 52 | Version => 1, # OPTIONAL | ||
| 53 | }, | ||
| 54 | ... | ||
| 55 | ], | ||
| 56 | TableName => 'MyResourceName', | ||
| 57 | CommonAttributes => { | ||
| 58 | Dimensions => [ | ||
| 59 | { | ||
| 60 | Name => 'MyStringValue256', # min: 1, max: 256 | ||
| 61 | Value => 'MyStringValue2048', # min: 1, max: 2048 | ||
| 62 | DimensionValueType => 'VARCHAR', # values: VARCHAR; OPTIONAL | ||
| 63 | }, | ||
| 64 | ... | ||
| 65 | ], # max: 128; OPTIONAL | ||
| 66 | MeasureName => 'MyStringValue256', # min: 1, max: 256 | ||
| 67 | MeasureValue => 'MyStringValue2048', # min: 1, max: 2048 | ||
| 68 | MeasureValueType => | ||
| 69 | 'DOUBLE', # values: DOUBLE, BIGINT, VARCHAR, BOOLEAN; OPTIONAL | ||
| 70 | Time => 'MyStringValue256', # min: 1, max: 256 | ||
| 71 | TimeUnit => 'MILLISECONDS' | ||
| 72 | , # values: MILLISECONDS, SECONDS, MICROSECONDS, NANOSECONDS; OPTIONAL | ||
| 73 | Version => 1, # OPTIONAL | ||
| 74 | }, # OPTIONAL | ||
| 75 | ); | ||
| 76 | |||
| 77 | 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. | ||
| 78 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ingest.timestream/WriteRecords> | ||
| 79 | |||
| 80 | =head1 ATTRIBUTES | ||
| 81 | |||
| 82 | |||
| 83 | =head2 CommonAttributes => L<Paws::TimestreamWrite::Record> | ||
| 84 | |||
| 85 | A record containing the common measure and dimension attributes shared | ||
| 86 | across all the records in the request. The measure and dimension | ||
| 87 | attributes specified in here will be merged with the measure and | ||
| 88 | dimension attributes in the records object when the data is written | ||
| 89 | into Timestream. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 B<REQUIRED> DatabaseName => Str | ||
| 94 | |||
| 95 | The name of the Timestream database. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 B<REQUIRED> Records => ArrayRef[L<Paws::TimestreamWrite::Record>] | ||
| 100 | |||
| 101 | An array of records containing the unique dimension and measure | ||
| 102 | attributes for each time series data point. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head2 B<REQUIRED> TableName => Str | ||
| 107 | |||
| 108 | The name of the Timesream table. | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head1 SEE ALSO | ||
| 114 | |||
| 115 | This class forms part of L<Paws>, documenting arguments for method WriteRecords in L<Paws::TimestreamWrite> | ||
| 116 | |||
| 117 | =head1 BUGS and CONTRIBUTIONS | ||
| 118 | |||
| 119 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 120 | |||
| 121 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 122 | |||
| 123 | =cut | ||
| 124 |