« blib/lib/Paws/KinesisAnalyticsV2/Input.pm
↑ Summary
blib/lib/Paws/KinesisAnalyticsV2/InputLambdaProcessor.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::KinesisAnalyticsV2::InputDescription; | ||
| 3 | use Moose; | ||
| 4 | has InAppStreamNames => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 5 | has InputId => (is => 'ro', isa => 'Str'); | ||
| 6 | has InputParallelism => (is => 'ro', isa => 'Paws::KinesisAnalyticsV2::InputParallelism'); | ||
| 7 | has InputProcessingConfigurationDescription => (is => 'ro', isa => 'Paws::KinesisAnalyticsV2::InputProcessingConfigurationDescription'); | ||
| 8 | has InputSchema => (is => 'ro', isa => 'Paws::KinesisAnalyticsV2::SourceSchema'); | ||
| 9 | has InputStartingPositionConfiguration => (is => 'ro', isa => 'Paws::KinesisAnalyticsV2::InputStartingPositionConfiguration'); | ||
| 10 | has KinesisFirehoseInputDescription => (is => 'ro', isa => 'Paws::KinesisAnalyticsV2::KinesisFirehoseInputDescription'); | ||
| 11 | has KinesisStreamsInputDescription => (is => 'ro', isa => 'Paws::KinesisAnalyticsV2::KinesisStreamsInputDescription'); | ||
| 12 | has NamePrefix => (is => 'ro', isa => 'Str'); | ||
| 13 | |||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::KinesisAnalyticsV2::InputDescription | ||
| 21 | |||
| 22 | =head1 USAGE | ||
| 23 | |||
| 24 | This class represents one of two things: | ||
| 25 | |||
| 26 | =head3 Arguments in a call to a service | ||
| 27 | |||
| 28 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 29 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 30 | |||
| 31 | As an example, if Att1 is expected to be a Paws::KinesisAnalyticsV2::InputDescription object: | ||
| 32 | |||
| 33 | $service_obj->Method(Att1 => { InAppStreamNames => $value, ..., NamePrefix => $value }); | ||
| 34 | |||
| 35 | =head3 Results returned from an API call | ||
| 36 | |||
| 37 | Use accessors for each attribute. If Att1 is expected to be an Paws::KinesisAnalyticsV2::InputDescription object: | ||
| 38 | |||
| 39 | $result = $service_obj->Method(...); | ||
| 40 | $result->Att1->InAppStreamNames | ||
| 41 | |||
| 42 | =head1 DESCRIPTION | ||
| 43 | |||
| 44 | Describes the application input configuration for a SQL-based Kinesis | ||
| 45 | Data Analytics application. | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 InAppStreamNames => ArrayRef[Str|Undef] | ||
| 51 | |||
| 52 | Returns the in-application stream names that are mapped to the stream | ||
| 53 | source. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 InputId => Str | ||
| 57 | |||
| 58 | The input ID that is associated with the application input. This is the | ||
| 59 | ID that Kinesis Data Analytics assigns to each input configuration that | ||
| 60 | you add to your application. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 InputParallelism => L<Paws::KinesisAnalyticsV2::InputParallelism> | ||
| 64 | |||
| 65 | Describes the configured parallelism (number of in-application streams | ||
| 66 | mapped to the streaming source). | ||
| 67 | |||
| 68 | |||
| 69 | =head2 InputProcessingConfigurationDescription => L<Paws::KinesisAnalyticsV2::InputProcessingConfigurationDescription> | ||
| 70 | |||
| 71 | The description of the preprocessor that executes on records in this | ||
| 72 | input before the application's code is run. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 InputSchema => L<Paws::KinesisAnalyticsV2::SourceSchema> | ||
| 76 | |||
| 77 | Describes the format of the data in the streaming source, and how each | ||
| 78 | data element maps to corresponding columns in the in-application stream | ||
| 79 | that is being created. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 InputStartingPositionConfiguration => L<Paws::KinesisAnalyticsV2::InputStartingPositionConfiguration> | ||
| 83 | |||
| 84 | The point at which the application is configured to read from the input | ||
| 85 | stream. | ||
| 86 | |||
| 87 | |||
| 88 | =head2 KinesisFirehoseInputDescription => L<Paws::KinesisAnalyticsV2::KinesisFirehoseInputDescription> | ||
| 89 | |||
| 90 | If a Kinesis Data Firehose delivery stream is configured as a streaming | ||
| 91 | source, provides the delivery stream's ARN. | ||
| 92 | |||
| 93 | |||
| 94 | =head2 KinesisStreamsInputDescription => L<Paws::KinesisAnalyticsV2::KinesisStreamsInputDescription> | ||
| 95 | |||
| 96 | If a Kinesis data stream is configured as a streaming source, provides | ||
| 97 | the Kinesis data stream's Amazon Resource Name (ARN). | ||
| 98 | |||
| 99 | |||
| 100 | =head2 NamePrefix => Str | ||
| 101 | |||
| 102 | The in-application name prefix. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head1 SEE ALSO | ||
| 107 | |||
| 108 | This class forms part of L<Paws>, describing an object used in L<Paws::KinesisAnalyticsV2> | ||
| 109 | |||
| 110 | =head1 BUGS and CONTRIBUTIONS | ||
| 111 | |||
| 112 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 113 | |||
| 114 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 115 | |||
| 116 | =cut | ||
| 117 |