File Coverage

blib/lib/Paws/DataPipeline/PipelineDescription.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::DataPipeline::PipelineDescription;
2 1     1   448 use Moose;
  1         4  
  1         7  
3             has Description => (is => 'ro', isa => 'Str', request_name => 'description', traits => ['NameInRequest']);
4             has Fields => (is => 'ro', isa => 'ArrayRef[Paws::DataPipeline::Field]', request_name => 'fields', traits => ['NameInRequest'], required => 1);
5             has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest'], required => 1);
6             has PipelineId => (is => 'ro', isa => 'Str', request_name => 'pipelineId', traits => ['NameInRequest'], required => 1);
7             has Tags => (is => 'ro', isa => 'ArrayRef[Paws::DataPipeline::Tag]', request_name => 'tags', traits => ['NameInRequest']);
8             1;
9              
10             ### main pod documentation begin ###
11              
12             =head1 NAME
13              
14             Paws::DataPipeline::PipelineDescription
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::DataPipeline::PipelineDescription object:
26              
27             $service_obj->Method(Att1 => { Description => $value, ..., Tags => $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::DataPipeline::PipelineDescription object:
32              
33             $result = $service_obj->Method(...);
34             $result->Att1->Description
35              
36             =head1 DESCRIPTION
37              
38             Contains pipeline metadata.
39              
40             =head1 ATTRIBUTES
41              
42              
43             =head2 Description => Str
44              
45             Description of the pipeline.
46              
47              
48             =head2 B<REQUIRED> Fields => ArrayRef[L<Paws::DataPipeline::Field>]
49              
50             A list of read-only fields that contain metadata about the pipeline:
51             @userId, @accountId, and @pipelineState.
52              
53              
54             =head2 B<REQUIRED> Name => Str
55              
56             The name of the pipeline.
57              
58              
59             =head2 B<REQUIRED> PipelineId => Str
60              
61             The pipeline identifier that was assigned by AWS Data Pipeline. This is
62             a string of the form C<df-297EG78HU43EEXAMPLE>.
63              
64              
65             =head2 Tags => ArrayRef[L<Paws::DataPipeline::Tag>]
66              
67             A list of tags to associated with a pipeline. Tags let you control
68             access to pipelines. For more information, see Controlling User Access
69             to Pipelines in the I<AWS Data Pipeline Developer Guide>.
70              
71              
72              
73             =head1 SEE ALSO
74              
75             This class forms part of L<Paws>, describing an object used in L<Paws::DataPipeline>
76              
77             =head1 BUGS and CONTRIBUTIONS
78              
79             The source code is located here: https://github.com/pplu/aws-sdk-perl
80              
81             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
82              
83             =cut
84