1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
|
/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/s3/S3_EXPORTS.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <utility>
namespace Aws
{
namespace Utils
{
namespace Xml
{
class XmlNode;
} // namespace Xml
} // namespace Utils
namespace S3
{
namespace Model
{
/**
* <p>A container for describing a condition that must be met for the specified
* redirect to apply. For example, 1. If request is for pages in the
* <code>/docs</code> folder, redirect to the <code>/documents</code> folder. 2. If
* request results in HTTP error 4xx, redirect request to another host where you
* might process the error.</p><p><h3>See Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/Condition">AWS API
* Reference</a></p>
*/
class AWS_S3_API Condition
{
public:
Condition();
Condition(const Aws::Utils::Xml::XmlNode& xmlNode);
Condition& operator=(const Aws::Utils::Xml::XmlNode& xmlNode);
void AddToNode(Aws::Utils::Xml::XmlNode& parentNode) const;
/**
* <p>The HTTP error code when the redirect is applied. In the event of an error,
* if the error code equals this value, then the specified redirect is applied.
* Required when parent element <code>Condition</code> is specified and sibling
* <code>KeyPrefixEquals</code> is not specified. If both are specified, then both
* must be true for the redirect to be applied.</p>
*/
inline const Aws::String& GetHttpErrorCodeReturnedEquals() const{ return m_httpErrorCodeReturnedEquals; }
/**
* <p>The HTTP error code when the redirect is applied. In the event of an error,
* if the error code equals this value, then the specified redirect is applied.
* Required when parent element <code>Condition</code> is specified and sibling
* <code>KeyPrefixEquals</code> is not specified. If both are specified, then both
* must be true for the redirect to be applied.</p>
*/
inline bool HttpErrorCodeReturnedEqualsHasBeenSet() const { return m_httpErrorCodeReturnedEqualsHasBeenSet; }
/**
* <p>The HTTP error code when the redirect is applied. In the event of an error,
* if the error code equals this value, then the specified redirect is applied.
* Required when parent element <code>Condition</code> is specified and sibling
* <code>KeyPrefixEquals</code> is not specified. If both are specified, then both
* must be true for the redirect to be applied.</p>
*/
inline void SetHttpErrorCodeReturnedEquals(const Aws::String& value) { m_httpErrorCodeReturnedEqualsHasBeenSet = true; m_httpErrorCodeReturnedEquals = value; }
/**
* <p>The HTTP error code when the redirect is applied. In the event of an error,
* if the error code equals this value, then the specified redirect is applied.
* Required when parent element <code>Condition</code> is specified and sibling
* <code>KeyPrefixEquals</code> is not specified. If both are specified, then both
* must be true for the redirect to be applied.</p>
*/
inline void SetHttpErrorCodeReturnedEquals(Aws::String&& value) { m_httpErrorCodeReturnedEqualsHasBeenSet = true; m_httpErrorCodeReturnedEquals = std::move(value); }
/**
* <p>The HTTP error code when the redirect is applied. In the event of an error,
* if the error code equals this value, then the specified redirect is applied.
* Required when parent element <code>Condition</code> is specified and sibling
* <code>KeyPrefixEquals</code> is not specified. If both are specified, then both
* must be true for the redirect to be applied.</p>
*/
inline void SetHttpErrorCodeReturnedEquals(const char* value) { m_httpErrorCodeReturnedEqualsHasBeenSet = true; m_httpErrorCodeReturnedEquals.assign(value); }
/**
* <p>The HTTP error code when the redirect is applied. In the event of an error,
* if the error code equals this value, then the specified redirect is applied.
* Required when parent element <code>Condition</code> is specified and sibling
* <code>KeyPrefixEquals</code> is not specified. If both are specified, then both
* must be true for the redirect to be applied.</p>
*/
inline Condition& WithHttpErrorCodeReturnedEquals(const Aws::String& value) { SetHttpErrorCodeReturnedEquals(value); return *this;}
/**
* <p>The HTTP error code when the redirect is applied. In the event of an error,
* if the error code equals this value, then the specified redirect is applied.
* Required when parent element <code>Condition</code> is specified and sibling
* <code>KeyPrefixEquals</code> is not specified. If both are specified, then both
* must be true for the redirect to be applied.</p>
*/
inline Condition& WithHttpErrorCodeReturnedEquals(Aws::String&& value) { SetHttpErrorCodeReturnedEquals(std::move(value)); return *this;}
/**
* <p>The HTTP error code when the redirect is applied. In the event of an error,
* if the error code equals this value, then the specified redirect is applied.
* Required when parent element <code>Condition</code> is specified and sibling
* <code>KeyPrefixEquals</code> is not specified. If both are specified, then both
* must be true for the redirect to be applied.</p>
*/
inline Condition& WithHttpErrorCodeReturnedEquals(const char* value) { SetHttpErrorCodeReturnedEquals(value); return *this;}
/**
* <p>The object key name prefix when the redirect is applied. For example, to
* redirect requests for <code>ExamplePage.html</code>, the key prefix will be
* <code>ExamplePage.html</code>. To redirect request for all pages with the prefix
* <code>docs/</code>, the key prefix will be <code>/docs</code>, which identifies
* all objects in the <code>docs/</code> folder. Required when the parent element
* <code>Condition</code> is specified and sibling
* <code>HttpErrorCodeReturnedEquals</code> is not specified. If both conditions
* are specified, both must be true for the redirect to be applied.</p>
* <p>Replacement must be made for object keys containing special characters (such
* as carriage returns) when using XML requests. For more information, see <a
* href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints">
* XML related object key constraints</a>.</p>
*/
inline const Aws::String& GetKeyPrefixEquals() const{ return m_keyPrefixEquals; }
/**
* <p>The object key name prefix when the redirect is applied. For example, to
* redirect requests for <code>ExamplePage.html</code>, the key prefix will be
* <code>ExamplePage.html</code>. To redirect request for all pages with the prefix
* <code>docs/</code>, the key prefix will be <code>/docs</code>, which identifies
* all objects in the <code>docs/</code> folder. Required when the parent element
* <code>Condition</code> is specified and sibling
* <code>HttpErrorCodeReturnedEquals</code> is not specified. If both conditions
* are specified, both must be true for the redirect to be applied.</p>
* <p>Replacement must be made for object keys containing special characters (such
* as carriage returns) when using XML requests. For more information, see <a
* href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints">
* XML related object key constraints</a>.</p>
*/
inline bool KeyPrefixEqualsHasBeenSet() const { return m_keyPrefixEqualsHasBeenSet; }
/**
* <p>The object key name prefix when the redirect is applied. For example, to
* redirect requests for <code>ExamplePage.html</code>, the key prefix will be
* <code>ExamplePage.html</code>. To redirect request for all pages with the prefix
* <code>docs/</code>, the key prefix will be <code>/docs</code>, which identifies
* all objects in the <code>docs/</code> folder. Required when the parent element
* <code>Condition</code> is specified and sibling
* <code>HttpErrorCodeReturnedEquals</code> is not specified. If both conditions
* are specified, both must be true for the redirect to be applied.</p>
* <p>Replacement must be made for object keys containing special characters (such
* as carriage returns) when using XML requests. For more information, see <a
* href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints">
* XML related object key constraints</a>.</p>
*/
inline void SetKeyPrefixEquals(const Aws::String& value) { m_keyPrefixEqualsHasBeenSet = true; m_keyPrefixEquals = value; }
/**
* <p>The object key name prefix when the redirect is applied. For example, to
* redirect requests for <code>ExamplePage.html</code>, the key prefix will be
* <code>ExamplePage.html</code>. To redirect request for all pages with the prefix
* <code>docs/</code>, the key prefix will be <code>/docs</code>, which identifies
* all objects in the <code>docs/</code> folder. Required when the parent element
* <code>Condition</code> is specified and sibling
* <code>HttpErrorCodeReturnedEquals</code> is not specified. If both conditions
* are specified, both must be true for the redirect to be applied.</p>
* <p>Replacement must be made for object keys containing special characters (such
* as carriage returns) when using XML requests. For more information, see <a
* href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints">
* XML related object key constraints</a>.</p>
*/
inline void SetKeyPrefixEquals(Aws::String&& value) { m_keyPrefixEqualsHasBeenSet = true; m_keyPrefixEquals = std::move(value); }
/**
* <p>The object key name prefix when the redirect is applied. For example, to
* redirect requests for <code>ExamplePage.html</code>, the key prefix will be
* <code>ExamplePage.html</code>. To redirect request for all pages with the prefix
* <code>docs/</code>, the key prefix will be <code>/docs</code>, which identifies
* all objects in the <code>docs/</code> folder. Required when the parent element
* <code>Condition</code> is specified and sibling
* <code>HttpErrorCodeReturnedEquals</code> is not specified. If both conditions
* are specified, both must be true for the redirect to be applied.</p>
* <p>Replacement must be made for object keys containing special characters (such
* as carriage returns) when using XML requests. For more information, see <a
* href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints">
* XML related object key constraints</a>.</p>
*/
inline void SetKeyPrefixEquals(const char* value) { m_keyPrefixEqualsHasBeenSet = true; m_keyPrefixEquals.assign(value); }
/**
* <p>The object key name prefix when the redirect is applied. For example, to
* redirect requests for <code>ExamplePage.html</code>, the key prefix will be
* <code>ExamplePage.html</code>. To redirect request for all pages with the prefix
* <code>docs/</code>, the key prefix will be <code>/docs</code>, which identifies
* all objects in the <code>docs/</code> folder. Required when the parent element
* <code>Condition</code> is specified and sibling
* <code>HttpErrorCodeReturnedEquals</code> is not specified. If both conditions
* are specified, both must be true for the redirect to be applied.</p>
* <p>Replacement must be made for object keys containing special characters (such
* as carriage returns) when using XML requests. For more information, see <a
* href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints">
* XML related object key constraints</a>.</p>
*/
inline Condition& WithKeyPrefixEquals(const Aws::String& value) { SetKeyPrefixEquals(value); return *this;}
/**
* <p>The object key name prefix when the redirect is applied. For example, to
* redirect requests for <code>ExamplePage.html</code>, the key prefix will be
* <code>ExamplePage.html</code>. To redirect request for all pages with the prefix
* <code>docs/</code>, the key prefix will be <code>/docs</code>, which identifies
* all objects in the <code>docs/</code> folder. Required when the parent element
* <code>Condition</code> is specified and sibling
* <code>HttpErrorCodeReturnedEquals</code> is not specified. If both conditions
* are specified, both must be true for the redirect to be applied.</p>
* <p>Replacement must be made for object keys containing special characters (such
* as carriage returns) when using XML requests. For more information, see <a
* href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints">
* XML related object key constraints</a>.</p>
*/
inline Condition& WithKeyPrefixEquals(Aws::String&& value) { SetKeyPrefixEquals(std::move(value)); return *this;}
/**
* <p>The object key name prefix when the redirect is applied. For example, to
* redirect requests for <code>ExamplePage.html</code>, the key prefix will be
* <code>ExamplePage.html</code>. To redirect request for all pages with the prefix
* <code>docs/</code>, the key prefix will be <code>/docs</code>, which identifies
* all objects in the <code>docs/</code> folder. Required when the parent element
* <code>Condition</code> is specified and sibling
* <code>HttpErrorCodeReturnedEquals</code> is not specified. If both conditions
* are specified, both must be true for the redirect to be applied.</p>
* <p>Replacement must be made for object keys containing special characters (such
* as carriage returns) when using XML requests. For more information, see <a
* href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints">
* XML related object key constraints</a>.</p>
*/
inline Condition& WithKeyPrefixEquals(const char* value) { SetKeyPrefixEquals(value); return *this;}
private:
Aws::String m_httpErrorCodeReturnedEquals;
bool m_httpErrorCodeReturnedEqualsHasBeenSet;
Aws::String m_keyPrefixEquals;
bool m_keyPrefixEqualsHasBeenSet;
};
} // namespace Model
} // namespace S3
} // namespace Aws
|
