« blib/lib/Paws/KinesisAnalyticsV2/RecordFormat.pm
↑ Summary
blib/lib/Paws/KinesisAnalyticsV2/ReferenceDataSourceDescription.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::KinesisAnalyticsV2::ReferenceDataSource; | ||
| 3 | use Moose; | ||
| 4 | has ReferenceSchema => (is => 'ro', isa => 'Paws::KinesisAnalyticsV2::SourceSchema', required => 1); | ||
| 5 | has S3ReferenceDataSource => (is => 'ro', isa => 'Paws::KinesisAnalyticsV2::S3ReferenceDataSource'); | ||
| 6 | has TableName => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::KinesisAnalyticsV2::ReferenceDataSource | ||
| 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::KinesisAnalyticsV2::ReferenceDataSource object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { ReferenceSchema => $value, ..., TableName => $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::KinesisAnalyticsV2::ReferenceDataSource object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->ReferenceSchema | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | For a SQL-based Kinesis Data Analytics application, describes the | ||
| 39 | reference data source by providing the source information (Amazon S3 | ||
| 40 | bucket name and object key name), the resulting in-application table | ||
| 41 | name that is created, and the necessary schema to map the data elements | ||
| 42 | in the Amazon S3 object to the in-application table. | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 B<REQUIRED> ReferenceSchema => L<Paws::KinesisAnalyticsV2::SourceSchema> | ||
| 48 | |||
| 49 | Describes the format of the data in the streaming source, and how each | ||
| 50 | data element maps to corresponding columns created in the | ||
| 51 | in-application stream. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 S3ReferenceDataSource => L<Paws::KinesisAnalyticsV2::S3ReferenceDataSource> | ||
| 55 | |||
| 56 | Identifies the S3 bucket and object that contains the reference data. A | ||
| 57 | Kinesis Data Analytics application loads reference data only once. If | ||
| 58 | the data changes, you call the UpdateApplication operation to trigger | ||
| 59 | reloading of data into your application. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 B<REQUIRED> TableName => Str | ||
| 63 | |||
| 64 | The name of the in-application table to create. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head1 SEE ALSO | ||
| 69 | |||
| 70 | This class forms part of L<Paws>, describing an object used in L<Paws::KinesisAnalyticsV2> | ||
| 71 | |||
| 72 | =head1 BUGS and CONTRIBUTIONS | ||
| 73 | |||
| 74 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 75 | |||
| 76 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 77 | |||
| 78 | =cut | ||
| 79 |