File Coverage

blib/lib/Paws/S3/Redirect.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::S3::Redirect;
2 1     1   304 use Moose;
  1         3  
  1         5  
3             has HostName => (is => 'ro', isa => 'Str');
4             has HttpRedirectCode => (is => 'ro', isa => 'Str');
5             has Protocol => (is => 'ro', isa => 'Str');
6             has ReplaceKeyPrefixWith => (is => 'ro', isa => 'Str');
7             has ReplaceKeyWith => (is => 'ro', isa => 'Str');
8             1;
9              
10             ### main pod documentation begin ###
11              
12             =head1 NAME
13              
14             Paws::S3::Redirect
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::S3::Redirect object:
26              
27             $service_obj->Method(Att1 => { HostName => $value, ..., ReplaceKeyWith => $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::S3::Redirect object:
32              
33             $result = $service_obj->Method(...);
34             $result->Att1->HostName
35              
36             =head1 DESCRIPTION
37              
38             This class has no description
39              
40             =head1 ATTRIBUTES
41              
42              
43             =head2 HostName => Str
44              
45             The host name to use in the redirect request.
46              
47              
48             =head2 HttpRedirectCode => Str
49              
50             The HTTP redirect code to use on the response. Not required if one of
51             the siblings is present.
52              
53              
54             =head2 Protocol => Str
55              
56             Protocol to use (http, https) when redirecting requests. The default is
57             the protocol that is used in the original request.
58              
59              
60             =head2 ReplaceKeyPrefixWith => Str
61              
62             The object key prefix to use in the redirect request. For example, to
63             redirect requests for all pages with prefix docs/ (objects in the docs/
64             folder) to documents/, you can set a condition block with
65             KeyPrefixEquals set to docs/ and in the Redirect set
66             ReplaceKeyPrefixWith to /documents. Not required if one of the siblings
67             is present. Can be present only if ReplaceKeyWith is not provided.
68              
69              
70             =head2 ReplaceKeyWith => Str
71              
72             The specific object key to use in the redirect request. For example,
73             redirect request to error.html. Not required if one of the sibling is
74             present. Can be present only if ReplaceKeyPrefixWith is not provided.
75              
76              
77              
78             =head1 SEE ALSO
79              
80             This class forms part of L<Paws>, describing an object used in L<Paws::S3>
81              
82             =head1 BUGS and CONTRIBUTIONS
83              
84             The source code is located here: https://github.com/pplu/aws-sdk-perl
85              
86             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
87              
88             =cut
89