File Coverage

blib/lib/Paws/Firehose/CopyCommand.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::Firehose::CopyCommand;
2 1     1   535 use Moose;
  1         3  
  1         11  
3             has CopyOptions => (is => 'ro', isa => 'Str');
4             has DataTableColumns => (is => 'ro', isa => 'Str');
5             has DataTableName => (is => 'ro', isa => 'Str', required => 1);
6             1;
7              
8             ### main pod documentation begin ###
9              
10             =head1 NAME
11              
12             Paws::Firehose::CopyCommand
13              
14             =head1 USAGE
15              
16             This class represents one of two things:
17              
18             =head3 Arguments in a call to a service
19              
20             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
21             Each attribute should be used as a named argument in the calls that expect this type of object.
22              
23             As an example, if Att1 is expected to be a Paws::Firehose::CopyCommand object:
24              
25             $service_obj->Method(Att1 => { CopyOptions => $value, ..., DataTableName => $value });
26              
27             =head3 Results returned from an API call
28              
29             Use accessors for each attribute. If Att1 is expected to be an Paws::Firehose::CopyCommand object:
30              
31             $result = $service_obj->Method(...);
32             $result->Att1->CopyOptions
33              
34             =head1 DESCRIPTION
35              
36             Describes a C<COPY> command for Amazon Redshift.
37              
38             =head1 ATTRIBUTES
39              
40              
41             =head2 CopyOptions => Str
42              
43             Optional parameters to use with the Amazon Redshift C<COPY> command.
44             For more information, see the "Optional Parameters" section of Amazon
45             Redshift COPY command. Some possible examples that would apply to
46             Kinesis Firehose are as follows:
47              
48             C<delimiter '\t' lzop;> - fields are delimited with "\t" (TAB
49             character) and compressed using lzop.
50              
51             C<delimiter '|'> - fields are delimited with "|" (this is the default
52             delimiter).
53              
54             C<delimiter '|' escape> - the delimiter should be escaped.
55              
56             C<fixedwidth
57             'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6'> -
58             fields are fixed width in the source, with each width specified after
59             every column in the table.
60              
61             C<JSON 's3://mybucket/jsonpaths.txt'> - data is in JSON format, and the
62             path specified is the format of the data.
63              
64             For more examples, see Amazon Redshift COPY command examples.
65              
66              
67             =head2 DataTableColumns => Str
68              
69             A comma-separated list of column names.
70              
71              
72             =head2 B<REQUIRED> DataTableName => Str
73              
74             The name of the target table. The table must already exist in the
75             database.
76              
77              
78              
79             =head1 SEE ALSO
80              
81             This class forms part of L<Paws>, describing an object used in L<Paws::Firehose>
82              
83             =head1 BUGS and CONTRIBUTIONS
84              
85             The source code is located here: https://github.com/pplu/aws-sdk-perl
86              
87             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
88              
89             =cut
90