Class HttpTarget.Builder (2.31.0)

Version 2.31.0

• 2.53.0 (latest)
• 2.52.0
• 2.51.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.13
• 2.2.0
• 2.1.23

public static final class HttpTarget.Builder extends GeneratedMessageV3.Builder<HttpTarget.Builder> implements HttpTargetOrBuilder

Http target. The job will be pushed to the job handler by means of an HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. A failure to receive a response constitutes a failed execution. For a redirected request, the response returned by the redirected request is considered.

Protobuf type google.cloud.scheduler.v1.HttpTarget

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > HttpTarget.Builder

Implements

HttpTargetOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public HttpTarget.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
HttpTarget.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public HttpTarget build()

Returns
Type	Description
HttpTarget

buildPartial()

public HttpTarget buildPartial()

Returns
Type	Description
HttpTarget

clear()

public HttpTarget.Builder clear()

Returns
Type	Description
HttpTarget.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAuthorizationHeader()

public HttpTarget.Builder clearAuthorizationHeader()

Returns
Type	Description
HttpTarget.Builder

clearBody()

public HttpTarget.Builder clearBody()

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
HttpTarget.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public HttpTarget.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
HttpTarget.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearHeaders()

public HttpTarget.Builder clearHeaders()

Returns
Type	Description
HttpTarget.Builder

clearHttpMethod()

public HttpTarget.Builder clearHttpMethod()

Which HTTP method to use for the request.

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

Returns
Type	Description
HttpTarget.Builder	This builder for chaining.

clearOauthToken()

public HttpTarget.Builder clearOauthToken()

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
HttpTarget.Builder

clearOidcToken()

public HttpTarget.Builder clearOidcToken()

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
HttpTarget.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public HttpTarget.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
HttpTarget.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearUri()

public HttpTarget.Builder clearUri()

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
HttpTarget.Builder	This builder for chaining.

clone()

public HttpTarget.Builder clone()

Returns
Type	Description
HttpTarget.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

containsHeaders(String key)

public 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 HttpTarget.AuthorizationHeaderCase getAuthorizationHeaderCase()

Returns
Type	Description
HttpTarget.AuthorizationHeaderCase

getBody()

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

getDefaultInstanceForType()

public HttpTarget getDefaultInstanceForType()

Returns
Type	Description
HttpTarget

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getHeaders() (deprecated)

public Map<String,String> getHeaders()

Use #getHeadersMap() instead.

Returns
Type	Description
Map<String,String>

getHeadersCount()

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

getMutableHeaders() (deprecated)

public Map<String,String> getMutableHeaders()

Use alternate mutation accessors instead.

Returns
Type	Description
Map<String,String>

getOauthToken()

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

getOauthTokenBuilder()

public OAuthToken.Builder getOauthTokenBuilder()

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

getOauthTokenOrBuilder()

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

getOidcTokenBuilder()

public OidcToken.Builder getOidcTokenBuilder()

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

getOidcTokenOrBuilder()

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
MapField

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMapField(int fieldNumber)

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
MapField

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMutableMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(HttpTarget other)

public HttpTarget.Builder mergeFrom(HttpTarget other)

Parameter
Name	Description
other	HttpTarget

Returns
Type	Description
HttpTarget.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public HttpTarget.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
HttpTarget.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public HttpTarget.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
HttpTarget.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeOauthToken(OAuthToken value)

public HttpTarget.Builder mergeOauthToken(OAuthToken value)

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;

Parameter
Name	Description
value	OAuthToken

Returns
Type	Description
HttpTarget.Builder

mergeOidcToken(OidcToken value)

public HttpTarget.Builder mergeOidcToken(OidcToken value)

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;

Parameter
Name	Description
value	OidcToken

Returns
Type	Description
HttpTarget.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final HttpTarget.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
HttpTarget.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

putAllHeaders(Map<String,String> values)

public HttpTarget.Builder putAllHeaders(Map<String,String> values)

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
values	Map<String,String>

Returns
Type	Description
HttpTarget.Builder

putHeaders(String key, String value)

public HttpTarget.Builder putHeaders(String key, String value)

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
value	String

Returns
Type	Description
HttpTarget.Builder

removeHeaders(String key)

public HttpTarget.Builder removeHeaders(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
HttpTarget.Builder

setBody(ByteString value)

public HttpTarget.Builder setBody(ByteString value)

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;

Parameter
Name	Description
value	ByteString The body to set.

Returns
Type	Description
HttpTarget.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public HttpTarget.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
HttpTarget.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setHttpMethod(HttpMethod value)

public HttpTarget.Builder setHttpMethod(HttpMethod value)

Which HTTP method to use for the request.

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

Parameter
Name	Description
value	HttpMethod The httpMethod to set.

Returns
Type	Description
HttpTarget.Builder	This builder for chaining.

setHttpMethodValue(int value)

public HttpTarget.Builder setHttpMethodValue(int value)

Which HTTP method to use for the request.

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

Parameter
Name	Description
value	int The enum numeric value on the wire for httpMethod to set.

Returns
Type	Description
HttpTarget.Builder	This builder for chaining.

setOauthToken(OAuthToken value)

public HttpTarget.Builder setOauthToken(OAuthToken value)

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;

Parameter
Name	Description
value	OAuthToken

Returns
Type	Description
HttpTarget.Builder

setOauthToken(OAuthToken.Builder builderForValue)

public HttpTarget.Builder setOauthToken(OAuthToken.Builder builderForValue)

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;

Parameter
Name	Description
builderForValue	OAuthToken.Builder

Returns
Type	Description
HttpTarget.Builder

setOidcToken(OidcToken value)

public HttpTarget.Builder setOidcToken(OidcToken value)

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;

Parameter
Name	Description
value	OidcToken

Returns
Type	Description
HttpTarget.Builder

setOidcToken(OidcToken.Builder builderForValue)

public HttpTarget.Builder setOidcToken(OidcToken.Builder builderForValue)

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;

Parameter
Name	Description
builderForValue	OidcToken.Builder

Returns
Type	Description
HttpTarget.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public HttpTarget.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
HttpTarget.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final HttpTarget.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
HttpTarget.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUri(String value)

public HttpTarget.Builder setUri(String value)

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;

Parameter
Name	Description
value	String The uri to set.

Returns
Type	Description
HttpTarget.Builder	This builder for chaining.

setUriBytes(ByteString value)

public HttpTarget.Builder setUriBytes(ByteString value)

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;

Parameter
Name	Description
value	ByteString The bytes for uri to set.

Returns
Type	Description
HttpTarget.Builder	This builder for chaining.