-
Notifications
You must be signed in to change notification settings - Fork 241
/
com.microsoft.azure.management.cdn.UrlRedirectActionParameters.yml
205 lines (205 loc) · 15.8 KB
/
com.microsoft.azure.management.cdn.UrlRedirectActionParameters.yml
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
### YamlMime:JavaType
uid: "com.microsoft.azure.management.cdn.UrlRedirectActionParameters"
fullName: "com.microsoft.azure.management.cdn.UrlRedirectActionParameters"
name: "UrlRedirectActionParameters"
nameWithType: "UrlRedirectActionParameters"
summary: "Defines the parameters for the url redirect action."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
syntax: "public class **UrlRedirectActionParameters**"
constructors:
- uid: "com.microsoft.azure.management.cdn.UrlRedirectActionParameters.UrlRedirectActionParameters()"
fullName: "com.microsoft.azure.management.cdn.UrlRedirectActionParameters.UrlRedirectActionParameters()"
name: "UrlRedirectActionParameters()"
nameWithType: "UrlRedirectActionParameters.UrlRedirectActionParameters()"
summary: "Creates an instance of Url<wbr>Redirect<wbr>Action<wbr>Parameters class."
syntax: "public UrlRedirectActionParameters()"
desc: "Creates an instance of UrlRedirectActionParameters class."
methods:
- uid: "com.microsoft.azure.management.cdn.UrlRedirectActionParameters.customFragment()"
fullName: "com.microsoft.azure.management.cdn.UrlRedirectActionParameters.customFragment()"
name: "customFragment()"
nameWithType: "UrlRedirectActionParameters.customFragment()"
summary: "Get fragment to add to the redirect URL."
syntax: "public String customFragment()"
desc: "Get fragment to add to the redirect URL. Fragment is the part of the URL that comes after \\#. Do not include the \\#."
returns:
description: "the customFragment value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.cdn.UrlRedirectActionParameters.customHostname()"
fullName: "com.microsoft.azure.management.cdn.UrlRedirectActionParameters.customHostname()"
name: "customHostname()"
nameWithType: "UrlRedirectActionParameters.customHostname()"
summary: "Get host to redirect."
syntax: "public String customHostname()"
desc: "Get host to redirect. Leave empty to use the incoming host as the destination host."
returns:
description: "the customHostname value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.cdn.UrlRedirectActionParameters.customPath()"
fullName: "com.microsoft.azure.management.cdn.UrlRedirectActionParameters.customPath()"
name: "customPath()"
nameWithType: "UrlRedirectActionParameters.customPath()"
summary: "Get the full path to redirect."
syntax: "public String customPath()"
desc: "Get the full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path."
returns:
description: "the customPath value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.cdn.UrlRedirectActionParameters.customQueryString()"
fullName: "com.microsoft.azure.management.cdn.UrlRedirectActionParameters.customQueryString()"
name: "customQueryString()"
nameWithType: "UrlRedirectActionParameters.customQueryString()"
summary: "Get the set of query strings to be placed in the redirect URL."
syntax: "public String customQueryString()"
desc: "Get the set of query strings to be placed in the redirect URL. Setting this value would replace any existing query string; leave empty to preserve the incoming query string. Query string must be in <key>=<value> format. ? and & will be added automatically so do not include them."
returns:
description: "the customQueryString value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.cdn.UrlRedirectActionParameters.destinationProtocol()"
fullName: "com.microsoft.azure.management.cdn.UrlRedirectActionParameters.destinationProtocol()"
name: "destinationProtocol()"
nameWithType: "UrlRedirectActionParameters.destinationProtocol()"
summary: "Get protocol to use for the redirect."
syntax: "public DestinationProtocol destinationProtocol()"
desc: "Get protocol to use for the redirect. The default value is MatchRequest. Possible values include: 'MatchRequest', 'Http', 'Https'."
returns:
description: "the destinationProtocol value"
type: "<xref href=\"com.microsoft.azure.management.cdn.DestinationProtocol?alt=com.microsoft.azure.management.cdn.DestinationProtocol&text=DestinationProtocol\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.cdn.UrlRedirectActionParameters.odatatype()"
fullName: "com.microsoft.azure.management.cdn.UrlRedirectActionParameters.odatatype()"
name: "odatatype()"
nameWithType: "UrlRedirectActionParameters.odatatype()"
summary: "Get the odatatype value."
syntax: "public String odatatype()"
desc: "Get the odatatype value."
returns:
description: "the odatatype value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.cdn.UrlRedirectActionParameters.redirectType()"
fullName: "com.microsoft.azure.management.cdn.UrlRedirectActionParameters.redirectType()"
name: "redirectType()"
nameWithType: "UrlRedirectActionParameters.redirectType()"
summary: "Get the redirect type the rule will use when redirecting traffic."
syntax: "public RedirectType redirectType()"
desc: "Get the redirect type the rule will use when redirecting traffic. Possible values include: 'Moved', 'Found', 'TemporaryRedirect', 'PermanentRedirect'."
returns:
description: "the redirectType value"
type: "<xref href=\"com.microsoft.azure.management.cdn.RedirectType?alt=com.microsoft.azure.management.cdn.RedirectType&text=RedirectType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.cdn.UrlRedirectActionParameters.withCustomFragment(java.lang.String)"
fullName: "com.microsoft.azure.management.cdn.UrlRedirectActionParameters.withCustomFragment(String customFragment)"
name: "withCustomFragment(String customFragment)"
nameWithType: "UrlRedirectActionParameters.withCustomFragment(String customFragment)"
summary: "Set fragment to add to the redirect URL."
parameters:
- description: "the customFragment value to set"
name: "customFragment"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public UrlRedirectActionParameters withCustomFragment(String customFragment)"
desc: "Set fragment to add to the redirect URL. Fragment is the part of the URL that comes after \\#. Do not include the \\#."
returns:
description: "the UrlRedirectActionParameters object itself."
type: "<xref href=\"com.microsoft.azure.management.cdn.UrlRedirectActionParameters?alt=com.microsoft.azure.management.cdn.UrlRedirectActionParameters&text=UrlRedirectActionParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.cdn.UrlRedirectActionParameters.withCustomHostname(java.lang.String)"
fullName: "com.microsoft.azure.management.cdn.UrlRedirectActionParameters.withCustomHostname(String customHostname)"
name: "withCustomHostname(String customHostname)"
nameWithType: "UrlRedirectActionParameters.withCustomHostname(String customHostname)"
summary: "Set host to redirect."
parameters:
- description: "the customHostname value to set"
name: "customHostname"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public UrlRedirectActionParameters withCustomHostname(String customHostname)"
desc: "Set host to redirect. Leave empty to use the incoming host as the destination host."
returns:
description: "the UrlRedirectActionParameters object itself."
type: "<xref href=\"com.microsoft.azure.management.cdn.UrlRedirectActionParameters?alt=com.microsoft.azure.management.cdn.UrlRedirectActionParameters&text=UrlRedirectActionParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.cdn.UrlRedirectActionParameters.withCustomPath(java.lang.String)"
fullName: "com.microsoft.azure.management.cdn.UrlRedirectActionParameters.withCustomPath(String customPath)"
name: "withCustomPath(String customPath)"
nameWithType: "UrlRedirectActionParameters.withCustomPath(String customPath)"
summary: "Set the full path to redirect."
parameters:
- description: "the customPath value to set"
name: "customPath"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public UrlRedirectActionParameters withCustomPath(String customPath)"
desc: "Set the full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path."
returns:
description: "the UrlRedirectActionParameters object itself."
type: "<xref href=\"com.microsoft.azure.management.cdn.UrlRedirectActionParameters?alt=com.microsoft.azure.management.cdn.UrlRedirectActionParameters&text=UrlRedirectActionParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.cdn.UrlRedirectActionParameters.withCustomQueryString(java.lang.String)"
fullName: "com.microsoft.azure.management.cdn.UrlRedirectActionParameters.withCustomQueryString(String customQueryString)"
name: "withCustomQueryString(String customQueryString)"
nameWithType: "UrlRedirectActionParameters.withCustomQueryString(String customQueryString)"
summary: "Set the set of query strings to be placed in the redirect URL."
parameters:
- description: "the customQueryString value to set"
name: "customQueryString"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public UrlRedirectActionParameters withCustomQueryString(String customQueryString)"
desc: "Set the set of query strings to be placed in the redirect URL. Setting this value would replace any existing query string; leave empty to preserve the incoming query string. Query string must be in <key>=<value> format. ? and & will be added automatically so do not include them."
returns:
description: "the UrlRedirectActionParameters object itself."
type: "<xref href=\"com.microsoft.azure.management.cdn.UrlRedirectActionParameters?alt=com.microsoft.azure.management.cdn.UrlRedirectActionParameters&text=UrlRedirectActionParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.cdn.UrlRedirectActionParameters.withDestinationProtocol(com.microsoft.azure.management.cdn.DestinationProtocol)"
fullName: "com.microsoft.azure.management.cdn.UrlRedirectActionParameters.withDestinationProtocol(DestinationProtocol destinationProtocol)"
name: "withDestinationProtocol(DestinationProtocol destinationProtocol)"
nameWithType: "UrlRedirectActionParameters.withDestinationProtocol(DestinationProtocol destinationProtocol)"
summary: "Set protocol to use for the redirect."
parameters:
- description: "the destinationProtocol value to set"
name: "destinationProtocol"
type: "<xref href=\"com.microsoft.azure.management.cdn.DestinationProtocol?alt=com.microsoft.azure.management.cdn.DestinationProtocol&text=DestinationProtocol\" data-throw-if-not-resolved=\"False\" />"
syntax: "public UrlRedirectActionParameters withDestinationProtocol(DestinationProtocol destinationProtocol)"
desc: "Set protocol to use for the redirect. The default value is MatchRequest. Possible values include: 'MatchRequest', 'Http', 'Https'."
returns:
description: "the UrlRedirectActionParameters object itself."
type: "<xref href=\"com.microsoft.azure.management.cdn.UrlRedirectActionParameters?alt=com.microsoft.azure.management.cdn.UrlRedirectActionParameters&text=UrlRedirectActionParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.cdn.UrlRedirectActionParameters.withOdatatype(java.lang.String)"
fullName: "com.microsoft.azure.management.cdn.UrlRedirectActionParameters.withOdatatype(String odatatype)"
name: "withOdatatype(String odatatype)"
nameWithType: "UrlRedirectActionParameters.withOdatatype(String odatatype)"
summary: "Set the odatatype value."
parameters:
- description: "the odatatype value to set"
name: "odatatype"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public UrlRedirectActionParameters withOdatatype(String odatatype)"
desc: "Set the odatatype value."
returns:
description: "the UrlRedirectActionParameters object itself."
type: "<xref href=\"com.microsoft.azure.management.cdn.UrlRedirectActionParameters?alt=com.microsoft.azure.management.cdn.UrlRedirectActionParameters&text=UrlRedirectActionParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.cdn.UrlRedirectActionParameters.withRedirectType(com.microsoft.azure.management.cdn.RedirectType)"
fullName: "com.microsoft.azure.management.cdn.UrlRedirectActionParameters.withRedirectType(RedirectType redirectType)"
name: "withRedirectType(RedirectType redirectType)"
nameWithType: "UrlRedirectActionParameters.withRedirectType(RedirectType redirectType)"
summary: "Set the redirect type the rule will use when redirecting traffic."
parameters:
- description: "the redirectType value to set"
name: "redirectType"
type: "<xref href=\"com.microsoft.azure.management.cdn.RedirectType?alt=com.microsoft.azure.management.cdn.RedirectType&text=RedirectType\" data-throw-if-not-resolved=\"False\" />"
syntax: "public UrlRedirectActionParameters withRedirectType(RedirectType redirectType)"
desc: "Set the redirect type the rule will use when redirecting traffic. Possible values include: 'Moved', 'Found', 'TemporaryRedirect', 'PermanentRedirect'."
returns:
description: "the UrlRedirectActionParameters object itself."
type: "<xref href=\"com.microsoft.azure.management.cdn.UrlRedirectActionParameters?alt=com.microsoft.azure.management.cdn.UrlRedirectActionParameters&text=UrlRedirectActionParameters\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Defines the parameters for the url redirect action."
metadata: {}
package: "com.microsoft.azure.management.cdn"
artifact: com.microsoft.azure:azure-mgmt-cdn:1.41.4