File Coverage

blib/lib/Paws/ElasticTranscoder/Job.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::ElasticTranscoder::Job;
2 1     1   406 use Moose;
  1         3  
  1         6  
3             has Arn => (is => 'ro', isa => 'Str');
4             has Id => (is => 'ro', isa => 'Str');
5             has Input => (is => 'ro', isa => 'Paws::ElasticTranscoder::JobInput');
6             has Inputs => (is => 'ro', isa => 'ArrayRef[Paws::ElasticTranscoder::JobInput]');
7             has Output => (is => 'ro', isa => 'Paws::ElasticTranscoder::JobOutput');
8             has OutputKeyPrefix => (is => 'ro', isa => 'Str');
9             has Outputs => (is => 'ro', isa => 'ArrayRef[Paws::ElasticTranscoder::JobOutput]');
10             has PipelineId => (is => 'ro', isa => 'Str');
11             has Playlists => (is => 'ro', isa => 'ArrayRef[Paws::ElasticTranscoder::Playlist]');
12             has Status => (is => 'ro', isa => 'Str');
13             has Timing => (is => 'ro', isa => 'Paws::ElasticTranscoder::Timing');
14             has UserMetadata => (is => 'ro', isa => 'Paws::ElasticTranscoder::UserMetadata');
15             1;
16              
17             ### main pod documentation begin ###
18              
19             =head1 NAME
20              
21             Paws::ElasticTranscoder::Job
22              
23             =head1 USAGE
24              
25             This class represents one of two things:
26              
27             =head3 Arguments in a call to a service
28              
29             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
30             Each attribute should be used as a named argument in the calls that expect this type of object.
31              
32             As an example, if Att1 is expected to be a Paws::ElasticTranscoder::Job object:
33              
34             $service_obj->Method(Att1 => { Arn => $value, ..., UserMetadata => $value });
35              
36             =head3 Results returned from an API call
37              
38             Use accessors for each attribute. If Att1 is expected to be an Paws::ElasticTranscoder::Job object:
39              
40             $result = $service_obj->Method(...);
41             $result->Att1->Arn
42              
43             =head1 DESCRIPTION
44              
45             A section of the response body that provides information about the job
46             that is created.
47              
48             =head1 ATTRIBUTES
49              
50              
51             =head2 Arn => Str
52              
53             The Amazon Resource Name (ARN) for the job.
54              
55              
56             =head2 Id => Str
57              
58             The identifier that Elastic Transcoder assigned to the job. You use
59             this value to get settings for the job or to delete the job.
60              
61              
62             =head2 Input => L<Paws::ElasticTranscoder::JobInput>
63              
64             A section of the request or response body that provides information
65             about the file that is being transcoded.
66              
67              
68             =head2 Inputs => ArrayRef[L<Paws::ElasticTranscoder::JobInput>]
69              
70             Information about the files that you're transcoding. If you specified
71             multiple files for this job, Elastic Transcoder stitches the files
72             together to make one output.
73              
74              
75             =head2 Output => L<Paws::ElasticTranscoder::JobOutput>
76              
77             If you specified one output for a job, information about that output.
78             If you specified multiple outputs for a job, the Output object lists
79             information about the first output. This duplicates the information
80             that is listed for the first output in the Outputs object.
81              
82             Outputs recommended instead.
83              
84             A section of the request or response body that provides information
85             about the transcoded (target) file.
86              
87              
88             =head2 OutputKeyPrefix => Str
89              
90             The value, if any, that you want Elastic Transcoder to prepend to the
91             names of all files that this job creates, including output files,
92             thumbnails, and playlists. We recommend that you add a / or some other
93             delimiter to the end of the C<OutputKeyPrefix>.
94              
95              
96             =head2 Outputs => ArrayRef[L<Paws::ElasticTranscoder::JobOutput>]
97              
98             Information about the output files. We recommend that you use the
99             C<Outputs> syntax for all jobs, even when you want Elastic Transcoder
100             to transcode a file into only one format. Do not use both the
101             C<Outputs> and C<Output> syntaxes in the same request. You can create a
102             maximum of 30 outputs per job.
103              
104             If you specify more than one output for a job, Elastic Transcoder
105             creates the files for each output in the order in which you specify
106             them in the job.
107              
108              
109             =head2 PipelineId => Str
110              
111             The C<Id> of the pipeline that you want Elastic Transcoder to use for
112             transcoding. The pipeline determines several settings, including the
113             Amazon S3 bucket from which Elastic Transcoder gets the files to
114             transcode and the bucket into which Elastic Transcoder puts the
115             transcoded files.
116              
117              
118             =head2 Playlists => ArrayRef[L<Paws::ElasticTranscoder::Playlist>]
119              
120             Outputs in Fragmented MP4 or MPEG-TS format only.
121              
122             If you specify a preset in C<PresetId> for which the value of
123             C<Container> is fmp4 (Fragmented MP4) or ts (MPEG-TS), C<Playlists>
124             contains information about the master playlists that you want Elastic
125             Transcoder to create.
126              
127             The maximum number of master playlists in a job is 30.
128              
129              
130             =head2 Status => Str
131              
132             The status of the job: C<Submitted>, C<Progressing>, C<Complete>,
133             C<Canceled>, or C<Error>.
134              
135              
136             =head2 Timing => L<Paws::ElasticTranscoder::Timing>
137              
138             Details about the timing of a job.
139              
140              
141             =head2 UserMetadata => L<Paws::ElasticTranscoder::UserMetadata>
142              
143             User-defined metadata that you want to associate with an Elastic
144             Transcoder job. You specify metadata in C<key/value> pairs, and you can
145             add up to 10 C<key/value> pairs per job. Elastic Transcoder does not
146             guarantee that C<key/value> pairs are returned in the same order in
147             which you specify them.
148              
149             Metadata C<keys> and C<values> must use characters from the following
150             list:
151              
152             =over
153              
154             =item *
155              
156             C<0-9>
157              
158             =item *
159              
160             C<A-Z> and C<a-z>
161              
162             =item *
163              
164             C<Space>
165              
166             =item *
167              
168             The following symbols: C<_.:/=+-%@>
169              
170             =back
171              
172              
173              
174              
175             =head1 SEE ALSO
176              
177             This class forms part of L<Paws>, describing an object used in L<Paws::ElasticTranscoder>
178              
179             =head1 BUGS and CONTRIBUTIONS
180              
181             The source code is located here: https://github.com/pplu/aws-sdk-perl
182              
183             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
184              
185             =cut
186