Interface HttpTargetOrBuilder (2.42.0)

public interface HttpTargetOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsHeaders(String key)

public abstract 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.
  • 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.
  • X-CloudScheduler: This header will be set to true.
  • X-CloudScheduler-JobName: This header will contain the job name.

  • X-CloudScheduler-ScheduleTime: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339.

    The total size of headers must be less than 80KB.

map<string, string> headers = 3;

Parameter
Name Description
key String
Returns
Type Description
boolean

getAuthorizationHeaderCase()

public abstract HttpTarget.AuthorizationHeaderCase getAuthorizationHeaderCase()
Returns
Type Description
HttpTarget.AuthorizationHeaderCase

getBody()

public abstract 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.

bytes body = 4;

Returns
Type Description
ByteString

The body.

getHeaders() (deprecated)

public abstract Map<String,String> getHeaders()

Use #getHeadersMap() instead.

Returns
Type Description
Map<String,String>

getHeadersCount()

public abstract 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.
  • 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.
  • X-CloudScheduler: This header will be set to true.
  • X-CloudScheduler-JobName: This header will contain the job name.

  • X-CloudScheduler-ScheduleTime: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339.

    The total size of headers must be less than 80KB.

map<string, string> headers = 3;

Returns
Type Description
int

getHeadersMap()

public abstract 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.
  • 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.
  • X-CloudScheduler: This header will be set to true.
  • X-CloudScheduler-JobName: This header will contain the job name.

  • X-CloudScheduler-ScheduleTime: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339.

    The total size of headers must be less than 80KB.

map<string, string> headers = 3;

Returns
Type Description
Map<String,String>

getHeadersOrDefault(String key, String defaultValue)

public abstract 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.
  • 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.
  • X-CloudScheduler: This header will be set to true.
  • X-CloudScheduler-JobName: This header will contain the job name.

  • X-CloudScheduler-ScheduleTime: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339.

    The total size of headers must be less than 80KB.

map<string, string> headers = 3;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getHeadersOrThrow(String key)

public abstract 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.
  • 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.
  • X-CloudScheduler: This header will be set to true.
  • X-CloudScheduler-JobName: This header will contain the job name.

  • X-CloudScheduler-ScheduleTime: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule as an offset of UTC parsed according to RFC3339.

    The total size of headers must be less than 80KB.

map<string, string> headers = 3;

Parameter
Name Description
key String
Returns
Type Description
String

getHttpMethod()

public abstract HttpMethod getHttpMethod()

Which HTTP method to use for the request.

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

Returns
Type Description
HttpMethod

The httpMethod.

getHttpMethodValue()

public abstract int getHttpMethodValue()

Which HTTP method to use for the request.

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

Returns
Type Description
int

The enum numeric value on the wire for httpMethod.

getOauthToken()

public abstract OAuthToken getOauthToken()

If specified, an OAuth token 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
Type Description
OAuthToken

The oauthToken.

getOauthTokenOrBuilder()

public abstract OAuthTokenOrBuilder getOauthTokenOrBuilder()

If specified, an OAuth token 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
Type Description
OAuthTokenOrBuilder

getOidcToken()

public abstract OidcToken getOidcToken()

If specified, an OIDC 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
Type Description
OidcToken

The oidcToken.

getOidcTokenOrBuilder()

public abstract OidcTokenOrBuilder getOidcTokenOrBuilder()

If specified, an OIDC 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
Type Description
OidcTokenOrBuilder

getUri()

public abstract 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 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
Type Description
String

The uri.

getUriBytes()

public abstract 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 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
Type Description
ByteString

The bytes for uri.

hasOauthToken()

public abstract boolean hasOauthToken()

If specified, an OAuth token 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
Type Description
boolean

Whether the oauthToken field is set.

hasOidcToken()

public abstract boolean hasOidcToken()

If specified, an OIDC 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
Type Description
boolean

Whether the oidcToken field is set.