Class HttpTarget.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderT>
-
- com.google.protobuf.GeneratedMessageV3.Builder<HttpTarget.Builder>
-
- com.google.cloud.scheduler.v1beta1.HttpTarget.Builder
-
- All Implemented Interfaces:
HttpTargetOrBuilder
,com.google.protobuf.Message.Builder
,com.google.protobuf.MessageLite.Builder
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,Cloneable
- Enclosing class:
- HttpTarget
public static final class HttpTarget.Builder extends com.google.protobuf.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][google.cloud.scheduler.v1beta1.HttpTarget.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 typegoogle.cloud.scheduler.v1beta1.HttpTarget
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description HttpTarget.Builder
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
HttpTarget
build()
HttpTarget
buildPartial()
HttpTarget.Builder
clear()
HttpTarget.Builder
clearAuthorizationHeader()
HttpTarget.Builder
clearBody()
HTTP request body.HttpTarget.Builder
clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
HttpTarget.Builder
clearHeaders()
HttpTarget.Builder
clearHttpMethod()
Which HTTP method to use for the request.HttpTarget.Builder
clearOauthToken()
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.HttpTarget.Builder
clearOidcToken()
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.HttpTarget.Builder
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
HttpTarget.Builder
clearUri()
Required.HttpTarget.Builder
clone()
boolean
containsHeaders(String key)
The user can specify HTTP request headers to send with the job's HTTP request.HttpTarget.AuthorizationHeaderCase
getAuthorizationHeaderCase()
com.google.protobuf.ByteString
getBody()
HTTP request body.HttpTarget
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
com.google.protobuf.Descriptors.Descriptor
getDescriptorForType()
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.Map<String,String>
getMutableHeaders()
Deprecated.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.OAuthToken.Builder
getOauthTokenBuilder()
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.OidcToken.Builder
getOidcTokenBuilder()
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.com.google.protobuf.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.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
protected com.google.protobuf.MapField
internalGetMapField(int number)
protected com.google.protobuf.MapField
internalGetMutableMapField(int number)
boolean
isInitialized()
HttpTarget.Builder
mergeFrom(HttpTarget other)
HttpTarget.Builder
mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
HttpTarget.Builder
mergeFrom(com.google.protobuf.Message other)
HttpTarget.Builder
mergeOauthToken(OAuthToken value)
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.HttpTarget.Builder
mergeOidcToken(OidcToken value)
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.HttpTarget.Builder
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
HttpTarget.Builder
putAllHeaders(Map<String,String> values)
The user can specify HTTP request headers to send with the job's HTTP request.HttpTarget.Builder
putHeaders(String key, String value)
The user can specify HTTP request headers to send with the job's HTTP request.HttpTarget.Builder
removeHeaders(String key)
The user can specify HTTP request headers to send with the job's HTTP request.HttpTarget.Builder
setBody(com.google.protobuf.ByteString value)
HTTP request body.HttpTarget.Builder
setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
HttpTarget.Builder
setHttpMethod(HttpMethod value)
Which HTTP method to use for the request.HttpTarget.Builder
setHttpMethodValue(int value)
Which HTTP method to use for the request.HttpTarget.Builder
setOauthToken(OAuthToken value)
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.HttpTarget.Builder
setOauthToken(OAuthToken.Builder builderForValue)
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.HttpTarget.Builder
setOidcToken(OidcToken value)
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.HttpTarget.Builder
setOidcToken(OidcToken.Builder builderForValue)
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.HttpTarget.Builder
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
HttpTarget.Builder
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
HttpTarget.Builder
setUri(String value)
Required.HttpTarget.Builder
setUriBytes(com.google.protobuf.ByteString value)
Required.-
Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetMapField
protected com.google.protobuf.MapField internalGetMapField(int number)
- Overrides:
internalGetMapField
in classcom.google.protobuf.GeneratedMessageV3.Builder<HttpTarget.Builder>
-
internalGetMutableMapField
protected com.google.protobuf.MapField internalGetMutableMapField(int number)
- Overrides:
internalGetMutableMapField
in classcom.google.protobuf.GeneratedMessageV3.Builder<HttpTarget.Builder>
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3.Builder<HttpTarget.Builder>
-
clear
public HttpTarget.Builder clear()
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessageV3.Builder<HttpTarget.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessageV3.Builder<HttpTarget.Builder>
-
getDefaultInstanceForType
public HttpTarget getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
public HttpTarget build()
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public HttpTarget buildPartial()
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
clone
public HttpTarget.Builder clone()
- Specified by:
clone
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clone
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clone
in classcom.google.protobuf.GeneratedMessageV3.Builder<HttpTarget.Builder>
-
setField
public HttpTarget.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
setField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setField
in classcom.google.protobuf.GeneratedMessageV3.Builder<HttpTarget.Builder>
-
clearField
public HttpTarget.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearField
in classcom.google.protobuf.GeneratedMessageV3.Builder<HttpTarget.Builder>
-
clearOneof
public HttpTarget.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneof
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearOneof
in classcom.google.protobuf.GeneratedMessageV3.Builder<HttpTarget.Builder>
-
setRepeatedField
public HttpTarget.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
- Specified by:
setRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<HttpTarget.Builder>
-
addRepeatedField
public HttpTarget.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
addRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
addRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<HttpTarget.Builder>
-
mergeFrom
public HttpTarget.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<HttpTarget.Builder>
-
mergeFrom
public HttpTarget.Builder mergeFrom(HttpTarget other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3.Builder<HttpTarget.Builder>
-
mergeFrom
public HttpTarget.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<HttpTarget.Builder>
- Throws:
IOException
-
getAuthorizationHeaderCase
public HttpTarget.AuthorizationHeaderCase getAuthorizationHeaderCase()
- Specified by:
getAuthorizationHeaderCase
in interfaceHttpTargetOrBuilder
-
clearAuthorizationHeader
public HttpTarget.Builder clearAuthorizationHeader()
-
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][google.cloud.scheduler.v1beta1.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;
- Specified by:
getUri
in interfaceHttpTargetOrBuilder
- Returns:
- The uri.
-
getUriBytes
public com.google.protobuf.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.v1beta1.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;
- Specified by:
getUriBytes
in interfaceHttpTargetOrBuilder
- Returns:
- The bytes for uri.
-
setUri
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][google.cloud.scheduler.v1beta1.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;
- Parameters:
value
- The uri to set.- Returns:
- This builder for chaining.
-
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][google.cloud.scheduler.v1beta1.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:
- This builder for chaining.
-
setUriBytes
public HttpTarget.Builder setUriBytes(com.google.protobuf.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][google.cloud.scheduler.v1beta1.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;
- Parameters:
value
- The bytes for uri to set.- Returns:
- This builder for chaining.
-
getHttpMethodValue
public int getHttpMethodValue()
Which HTTP method to use for the request.
.google.cloud.scheduler.v1beta1.HttpMethod http_method = 2;
- Specified by:
getHttpMethodValue
in interfaceHttpTargetOrBuilder
- Returns:
- The enum numeric value on the wire for httpMethod.
-
setHttpMethodValue
public HttpTarget.Builder setHttpMethodValue(int value)
Which HTTP method to use for the request.
.google.cloud.scheduler.v1beta1.HttpMethod http_method = 2;
- Parameters:
value
- The enum numeric value on the wire for httpMethod to set.- Returns:
- This builder for chaining.
-
getHttpMethod
public HttpMethod getHttpMethod()
Which HTTP method to use for the request.
.google.cloud.scheduler.v1beta1.HttpMethod http_method = 2;
- Specified by:
getHttpMethod
in interfaceHttpTargetOrBuilder
- Returns:
- The httpMethod.
-
setHttpMethod
public HttpTarget.Builder setHttpMethod(HttpMethod value)
Which HTTP method to use for the request.
.google.cloud.scheduler.v1beta1.HttpMethod http_method = 2;
- Parameters:
value
- The httpMethod to set.- Returns:
- This builder for chaining.
-
clearHttpMethod
public HttpTarget.Builder clearHttpMethod()
Which HTTP method to use for the request.
.google.cloud.scheduler.v1beta1.HttpMethod http_method = 2;
- Returns:
- This builder for chaining.
-
getHeadersCount
public int getHeadersCount()
Description copied from interface:HttpTargetOrBuilder
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.v1beta1.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. * `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 time in RFC3339 UTC "Zulu" format. The total size of headers must be less than 80KB.
map<string, string> headers = 3;
- Specified by:
getHeadersCount
in interfaceHttpTargetOrBuilder
-
containsHeaders
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][google.cloud.scheduler.v1beta1.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. * `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 time in RFC3339 UTC "Zulu" format. The total size of headers must be less than 80KB.
map<string, string> headers = 3;
- Specified by:
containsHeaders
in interfaceHttpTargetOrBuilder
-
getHeaders
@Deprecated public Map<String,String> getHeaders()
Deprecated.UsegetHeadersMap()
instead.- Specified by:
getHeaders
in interfaceHttpTargetOrBuilder
-
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][google.cloud.scheduler.v1beta1.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. * `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 time in RFC3339 UTC "Zulu" format. The total size of headers must be less than 80KB.
map<string, string> headers = 3;
- Specified by:
getHeadersMap
in interfaceHttpTargetOrBuilder
-
getHeadersOrDefault
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][google.cloud.scheduler.v1beta1.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. * `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 time in RFC3339 UTC "Zulu" format. The total size of headers must be less than 80KB.
map<string, string> headers = 3;
- Specified by:
getHeadersOrDefault
in interfaceHttpTargetOrBuilder
-
getHeadersOrThrow
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][google.cloud.scheduler.v1beta1.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. * `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 time in RFC3339 UTC "Zulu" format. The total size of headers must be less than 80KB.
map<string, string> headers = 3;
- Specified by:
getHeadersOrThrow
in interfaceHttpTargetOrBuilder
-
clearHeaders
public HttpTarget.Builder clearHeaders()
-
removeHeaders
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][google.cloud.scheduler.v1beta1.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. * `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 time in RFC3339 UTC "Zulu" format. The total size of headers must be less than 80KB.
map<string, string> headers = 3;
-
getMutableHeaders
@Deprecated public Map<String,String> getMutableHeaders()
Deprecated.Use alternate mutation accessors instead.
-
putHeaders
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][google.cloud.scheduler.v1beta1.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. * `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 time in RFC3339 UTC "Zulu" format. The total size of headers must be less than 80KB.
map<string, string> headers = 3;
-
putAllHeaders
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][google.cloud.scheduler.v1beta1.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. * `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 time in RFC3339 UTC "Zulu" format. The total size of headers must be less than 80KB.
map<string, string> headers = 3;
-
getBody
public com.google.protobuf.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.v1beta1.HttpMethod].
bytes body = 4;
- Specified by:
getBody
in interfaceHttpTargetOrBuilder
- Returns:
- The body.
-
setBody
public HttpTarget.Builder setBody(com.google.protobuf.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][google.cloud.scheduler.v1beta1.HttpMethod].
bytes body = 4;
- Parameters:
value
- The body to set.- Returns:
- This builder for chaining.
-
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][google.cloud.scheduler.v1beta1.HttpMethod].
bytes body = 4;
- Returns:
- This builder for chaining.
-
hasOauthToken
public 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.v1beta1.OAuthToken oauth_token = 5;
- Specified by:
hasOauthToken
in interfaceHttpTargetOrBuilder
- Returns:
- Whether the oauthToken field is set.
-
getOauthToken
public 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.v1beta1.OAuthToken oauth_token = 5;
- Specified by:
getOauthToken
in interfaceHttpTargetOrBuilder
- Returns:
- The oauthToken.
-
setOauthToken
public HttpTarget.Builder setOauthToken(OAuthToken value)
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.v1beta1.OAuthToken oauth_token = 5;
-
setOauthToken
public HttpTarget.Builder setOauthToken(OAuthToken.Builder builderForValue)
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.v1beta1.OAuthToken oauth_token = 5;
-
mergeOauthToken
public HttpTarget.Builder mergeOauthToken(OAuthToken value)
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.v1beta1.OAuthToken oauth_token = 5;
-
clearOauthToken
public HttpTarget.Builder clearOauthToken()
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.v1beta1.OAuthToken oauth_token = 5;
-
getOauthTokenBuilder
public OAuthToken.Builder getOauthTokenBuilder()
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.v1beta1.OAuthToken oauth_token = 5;
-
getOauthTokenOrBuilder
public 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.v1beta1.OAuthToken oauth_token = 5;
- Specified by:
getOauthTokenOrBuilder
in interfaceHttpTargetOrBuilder
-
hasOidcToken
public 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.v1beta1.OidcToken oidc_token = 6;
- Specified by:
hasOidcToken
in interfaceHttpTargetOrBuilder
- Returns:
- Whether the oidcToken field is set.
-
getOidcToken
public 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.v1beta1.OidcToken oidc_token = 6;
- Specified by:
getOidcToken
in interfaceHttpTargetOrBuilder
- Returns:
- The oidcToken.
-
setOidcToken
public HttpTarget.Builder setOidcToken(OidcToken value)
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.v1beta1.OidcToken oidc_token = 6;
-
setOidcToken
public HttpTarget.Builder setOidcToken(OidcToken.Builder builderForValue)
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.v1beta1.OidcToken oidc_token = 6;
-
mergeOidcToken
public HttpTarget.Builder mergeOidcToken(OidcToken value)
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.v1beta1.OidcToken oidc_token = 6;
-
clearOidcToken
public HttpTarget.Builder clearOidcToken()
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.v1beta1.OidcToken oidc_token = 6;
-
getOidcTokenBuilder
public OidcToken.Builder getOidcTokenBuilder()
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.v1beta1.OidcToken oidc_token = 6;
-
getOidcTokenOrBuilder
public 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.v1beta1.OidcToken oidc_token = 6;
- Specified by:
getOidcTokenOrBuilder
in interfaceHttpTargetOrBuilder
-
setUnknownFields
public final HttpTarget.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
setUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<HttpTarget.Builder>
-
mergeUnknownFields
public final HttpTarget.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<HttpTarget.Builder>
-
-