This repository has been archived by the owner on Sep 16, 2023. It is now read-only.
/
HttpTargetOrBuilder.java
325 lines (316 loc) · 11.4 KB
/
HttpTargetOrBuilder.java
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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/scheduler/v1/target.proto
package com.google.cloud.scheduler.v1;
public interface HttpTargetOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.scheduler.v1.HttpTarget)
com.google.protobuf.MessageOrBuilder {
/**
*
*
* <pre>
* Required. The full URI path that the request will be sent to. This string
* must begin with either "http://" or "https://". Some examples of
* valid values for [uri][google.cloud.scheduler.v1.HttpTarget.uri] are:
* `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will
* encode some characters for safety and compatibility. The maximum allowed
* URL length is 2083 characters after encoding.
* </pre>
*
* <code>string uri = 1;</code>
*
* @return The uri.
*/
java.lang.String getUri();
/**
*
*
* <pre>
* Required. The full URI path that the request will be sent to. This string
* must begin with either "http://" or "https://". Some examples of
* valid values for [uri][google.cloud.scheduler.v1.HttpTarget.uri] are:
* `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will
* encode some characters for safety and compatibility. The maximum allowed
* URL length is 2083 characters after encoding.
* </pre>
*
* <code>string uri = 1;</code>
*
* @return The bytes for uri.
*/
com.google.protobuf.ByteString getUriBytes();
/**
*
*
* <pre>
* Which HTTP method to use for the request.
* </pre>
*
* <code>.google.cloud.scheduler.v1.HttpMethod http_method = 2;</code>
*
* @return The enum numeric value on the wire for httpMethod.
*/
int getHttpMethodValue();
/**
*
*
* <pre>
* Which HTTP method to use for the request.
* </pre>
*
* <code>.google.cloud.scheduler.v1.HttpMethod http_method = 2;</code>
*
* @return The httpMethod.
*/
com.google.cloud.scheduler.v1.HttpMethod getHttpMethod();
/**
*
*
* <pre>
* The user can specify HTTP request headers to send with the job's
* HTTP request. This map contains the header field names and
* values. Repeated headers are not supported, but a header value can
* contain commas. These headers represent a subset of the headers
* that will accompany the job's HTTP request. Some HTTP request
* headers will be ignored or replaced. A partial list of headers that
* will be ignored or replaced is below:
* - Host: This will be computed by Cloud Scheduler and derived from
* [uri][google.cloud.scheduler.v1.HttpTarget.uri].
* * `Content-Length`: This will be computed by Cloud Scheduler.
* * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`.
* * `X-Google-*`: Google internal use only.
* * `X-AppEngine-*`: Google internal use only.
* The total size of headers must be less than 80KB.
* </pre>
*
* <code>map<string, string> headers = 3;</code>
*/
int getHeadersCount();
/**
*
*
* <pre>
* The user can specify HTTP request headers to send with the job's
* HTTP request. This map contains the header field names and
* values. Repeated headers are not supported, but a header value can
* contain commas. These headers represent a subset of the headers
* that will accompany the job's HTTP request. Some HTTP request
* headers will be ignored or replaced. A partial list of headers that
* will be ignored or replaced is below:
* - Host: This will be computed by Cloud Scheduler and derived from
* [uri][google.cloud.scheduler.v1.HttpTarget.uri].
* * `Content-Length`: This will be computed by Cloud Scheduler.
* * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`.
* * `X-Google-*`: Google internal use only.
* * `X-AppEngine-*`: Google internal use only.
* The total size of headers must be less than 80KB.
* </pre>
*
* <code>map<string, string> headers = 3;</code>
*/
boolean containsHeaders(java.lang.String key);
/** Use {@link #getHeadersMap()} instead. */
@java.lang.Deprecated
java.util.Map<java.lang.String, java.lang.String> getHeaders();
/**
*
*
* <pre>
* The user can specify HTTP request headers to send with the job's
* HTTP request. This map contains the header field names and
* values. Repeated headers are not supported, but a header value can
* contain commas. These headers represent a subset of the headers
* that will accompany the job's HTTP request. Some HTTP request
* headers will be ignored or replaced. A partial list of headers that
* will be ignored or replaced is below:
* - Host: This will be computed by Cloud Scheduler and derived from
* [uri][google.cloud.scheduler.v1.HttpTarget.uri].
* * `Content-Length`: This will be computed by Cloud Scheduler.
* * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`.
* * `X-Google-*`: Google internal use only.
* * `X-AppEngine-*`: Google internal use only.
* The total size of headers must be less than 80KB.
* </pre>
*
* <code>map<string, string> headers = 3;</code>
*/
java.util.Map<java.lang.String, java.lang.String> getHeadersMap();
/**
*
*
* <pre>
* The user can specify HTTP request headers to send with the job's
* HTTP request. This map contains the header field names and
* values. Repeated headers are not supported, but a header value can
* contain commas. These headers represent a subset of the headers
* that will accompany the job's HTTP request. Some HTTP request
* headers will be ignored or replaced. A partial list of headers that
* will be ignored or replaced is below:
* - Host: This will be computed by Cloud Scheduler and derived from
* [uri][google.cloud.scheduler.v1.HttpTarget.uri].
* * `Content-Length`: This will be computed by Cloud Scheduler.
* * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`.
* * `X-Google-*`: Google internal use only.
* * `X-AppEngine-*`: Google internal use only.
* The total size of headers must be less than 80KB.
* </pre>
*
* <code>map<string, string> headers = 3;</code>
*/
java.lang.String getHeadersOrDefault(java.lang.String key, java.lang.String defaultValue);
/**
*
*
* <pre>
* The user can specify HTTP request headers to send with the job's
* HTTP request. This map contains the header field names and
* values. Repeated headers are not supported, but a header value can
* contain commas. These headers represent a subset of the headers
* that will accompany the job's HTTP request. Some HTTP request
* headers will be ignored or replaced. A partial list of headers that
* will be ignored or replaced is below:
* - Host: This will be computed by Cloud Scheduler and derived from
* [uri][google.cloud.scheduler.v1.HttpTarget.uri].
* * `Content-Length`: This will be computed by Cloud Scheduler.
* * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`.
* * `X-Google-*`: Google internal use only.
* * `X-AppEngine-*`: Google internal use only.
* The total size of headers must be less than 80KB.
* </pre>
*
* <code>map<string, string> headers = 3;</code>
*/
java.lang.String getHeadersOrThrow(java.lang.String key);
/**
*
*
* <pre>
* HTTP request body. A request body is allowed only if the HTTP
* method is POST, PUT, or PATCH. It is an error to set body on a job with an
* incompatible [HttpMethod][google.cloud.scheduler.v1.HttpMethod].
* </pre>
*
* <code>bytes body = 4;</code>
*
* @return The body.
*/
com.google.protobuf.ByteString getBody();
/**
*
*
* <pre>
* If specified, an
* [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
* will be generated and attached as an `Authorization` header in the HTTP
* request.
* This type of authorization should generally only be used when calling
* Google APIs hosted on *.googleapis.com.
* </pre>
*
* <code>.google.cloud.scheduler.v1.OAuthToken oauth_token = 5;</code>
*
* @return Whether the oauthToken field is set.
*/
boolean hasOauthToken();
/**
*
*
* <pre>
* If specified, an
* [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
* will be generated and attached as an `Authorization` header in the HTTP
* request.
* This type of authorization should generally only be used when calling
* Google APIs hosted on *.googleapis.com.
* </pre>
*
* <code>.google.cloud.scheduler.v1.OAuthToken oauth_token = 5;</code>
*
* @return The oauthToken.
*/
com.google.cloud.scheduler.v1.OAuthToken getOauthToken();
/**
*
*
* <pre>
* If specified, an
* [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
* will be generated and attached as an `Authorization` header in the HTTP
* request.
* This type of authorization should generally only be used when calling
* Google APIs hosted on *.googleapis.com.
* </pre>
*
* <code>.google.cloud.scheduler.v1.OAuthToken oauth_token = 5;</code>
*/
com.google.cloud.scheduler.v1.OAuthTokenOrBuilder getOauthTokenOrBuilder();
/**
*
*
* <pre>
* If specified, an
* [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)
* token will be generated and attached as an `Authorization` header in the
* HTTP request.
* This type of authorization can be used for many scenarios, including
* calling Cloud Run, or endpoints where you intend to validate the token
* yourself.
* </pre>
*
* <code>.google.cloud.scheduler.v1.OidcToken oidc_token = 6;</code>
*
* @return Whether the oidcToken field is set.
*/
boolean hasOidcToken();
/**
*
*
* <pre>
* If specified, an
* [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)
* token will be generated and attached as an `Authorization` header in the
* HTTP request.
* This type of authorization can be used for many scenarios, including
* calling Cloud Run, or endpoints where you intend to validate the token
* yourself.
* </pre>
*
* <code>.google.cloud.scheduler.v1.OidcToken oidc_token = 6;</code>
*
* @return The oidcToken.
*/
com.google.cloud.scheduler.v1.OidcToken getOidcToken();
/**
*
*
* <pre>
* If specified, an
* [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)
* token will be generated and attached as an `Authorization` header in the
* HTTP request.
* This type of authorization can be used for many scenarios, including
* calling Cloud Run, or endpoints where you intend to validate the token
* yourself.
* </pre>
*
* <code>.google.cloud.scheduler.v1.OidcToken oidc_token = 6;</code>
*/
com.google.cloud.scheduler.v1.OidcTokenOrBuilder getOidcTokenOrBuilder();
public com.google.cloud.scheduler.v1.HttpTarget.AuthorizationHeaderCase
getAuthorizationHeaderCase();
}