1 /*
2  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License").
5  * You may not use this file except in compliance with the License.
6  * A copy of the License is located at
7  *
8  *  http://aws.amazon.com/apache2.0
9  *
10  * or in the "license" file accompanying this file. This file is distributed
11  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
12  * express or implied. See the License for the specific language governing
13  * permissions and limitations under the License.
14  */
15
16 package software.amazon.awssdk.core.protocol;
17
18 import software.amazon.awssdk.annotations.SdkProtectedApi;
19
20 /**
21  * Enum representing the various locations data can be marshalled to.
22  */
23 @SdkProtectedApi
24 public enum MarshallLocation {
25
26     /**
27      * Payload of the request (format depends on the protocol/content-type)
28      */
29     // TODO change to default or NONE as actual location depends on protocol
30     PAYLOAD,
31
32     /**
33      * Add as a query parameter.
34      */
35     QUERY_PARAM,
36
37     /**
38      * HTTP header.
39      */
40     HEADER,
41
42     /**
43      * Replace the placeholder in the request URI (non-greedy).
44      */
45     PATH,
46
47     /**
48      * Replace the placeholder in the request URI (greedy). This location is really the same as {@link #PATH},
49      * the only difference is whether it's URL encoded or not. Members bound to the {@link #PATH} will be URL
50      * encoded before replacing, members bound to {@link #GREEDY_PATH} will not be URL encoded.
51      */
52     GREEDY_PATH,
53
54     /**
55      * HTTP status code of response.
56      */
57     STATUS_CODE;
58
59 }
60