com.google.cloud.scheduler.v1

Interface HttpTargetOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

HttpTarget, HttpTarget.Builder

public interface HttpTargetOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsHeaders(String key) The user can specify HTTP request headers to send with the job's HTTP request.
HttpTarget.AuthorizationHeaderCase	getAuthorizationHeaderCase()
ByteString	getBody() HTTP request body.
Map<String,String>	getHeaders() Deprecated.
int	getHeadersCount() The user can specify HTTP request headers to send with the job's HTTP request.
Map<String,String>	getHeadersMap() The user can specify HTTP request headers to send with the job's HTTP request.
String	getHeadersOrDefault(String key, String defaultValue) The user can specify HTTP request headers to send with the job's HTTP request.
String	getHeadersOrThrow(String key) The user can specify HTTP request headers to send with the job's HTTP request.
HttpMethod	getHttpMethod() Which HTTP method to use for the request.
int	getHttpMethodValue() Which HTTP method to use for the request.
OAuthToken	getOauthToken() 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.
OAuthTokenOrBuilder	getOauthTokenOrBuilder() 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.
OidcToken	getOidcToken() 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.
OidcTokenOrBuilder	getOidcTokenOrBuilder() 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.
String	getUri() Required.
ByteString	getUriBytes() Required.
boolean	hasOauthToken() 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.
boolean	hasOidcToken() 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.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getUri

String getUri()

 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.
 

string uri = 1;

Returns:

The uri.

getUriBytes

ByteString getUriBytes()

 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.
 

string uri = 1;

Returns:

The bytes for uri.

getHttpMethodValue

int getHttpMethodValue()

 Which HTTP method to use for the request.
 

.google.cloud.scheduler.v1.HttpMethod http_method = 2;

Returns:

The enum numeric value on the wire for httpMethod.

getHttpMethod

HttpMethod getHttpMethod()

 Which HTTP method to use for the request.
 

.google.cloud.scheduler.v1.HttpMethod http_method = 2;

Returns:

The httpMethod.

getHeadersCount

int getHeadersCount()

 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.
 

map<string, string> headers = 3;

containsHeaders

boolean containsHeaders(String key)

 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.
 

map<string, string> headers = 3;

getHeaders

@Deprecated
Map<String,String> getHeaders()

Deprecated.

Use getHeadersMap() instead.

getHeadersMap

Map<String,String> getHeadersMap()

 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.
 

map<string, string> headers = 3;

getHeadersOrDefault

String getHeadersOrDefault(String key,
                           String defaultValue)

 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.
 

map<string, string> headers = 3;

getHeadersOrThrow

String getHeadersOrThrow(String key)

 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.
 

map<string, string> headers = 3;

getBody

ByteString getBody()

 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].
 

bytes body = 4;

Returns:

The body.

hasOauthToken

boolean hasOauthToken()

 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.
 

.google.cloud.scheduler.v1.OAuthToken oauth_token = 5;

Returns:

Whether the oauthToken field is set.

getOauthToken

OAuthToken getOauthToken()

 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.
 

.google.cloud.scheduler.v1.OAuthToken oauth_token = 5;

Returns:

The oauthToken.

getOauthTokenOrBuilder

OAuthTokenOrBuilder getOauthTokenOrBuilder()

 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.
 

.google.cloud.scheduler.v1.OAuthToken oauth_token = 5;

hasOidcToken

boolean hasOidcToken()

 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.
 

.google.cloud.scheduler.v1.OidcToken oidc_token = 6;

Returns:

Whether the oidcToken field is set.

getOidcToken

OidcToken getOidcToken()

 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.
 

.google.cloud.scheduler.v1.OidcToken oidc_token = 6;

Returns:

The oidcToken.

getOidcTokenOrBuilder

OidcTokenOrBuilder getOidcTokenOrBuilder()

 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.
 

.google.cloud.scheduler.v1.OidcToken oidc_token = 6;

getAuthorizationHeaderCase

HttpTarget.AuthorizationHeaderCase getAuthorizationHeaderCase()