Package com.google.cloud.tasks.v2beta3
Class HttpRequest.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderT>
-
- com.google.protobuf.GeneratedMessageV3.Builder<HttpRequest.Builder>
-
- com.google.cloud.tasks.v2beta3.HttpRequest.Builder
-
- All Implemented Interfaces:
HttpRequestOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable
- Enclosing class:
- HttpRequest
public static final class HttpRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<HttpRequest.Builder> implements HttpRequestOrBuilder
HTTP request. The task will be pushed to the worker as an HTTP request. If the worker or the redirected worker acknowledges the task by returning a successful HTTP response code ([`200` - `299`]), the task will be removed from the queue. If any other HTTP response code is returned or no response is received, the task will be retried according to the following: * User-specified throttling: [retry configuration][google.cloud.tasks.v2beta3.Queue.retry_config], [rate limits][google.cloud.tasks.v2beta3.Queue.rate_limits], and the [queue's state][google.cloud.tasks.v2beta3.Queue.state]. * System throttling: To prevent the worker from overloading, Cloud Tasks may temporarily reduce the queue's effective rate. User-specified settings will not be changed. System throttling happens because: * Cloud Tasks backs off on all errors. Normally the backoff specified in [rate limits][google.cloud.tasks.v2beta3.Queue.rate_limits] will be used. But if the worker returns `429` (Too Many Requests), `503` (Service Unavailable), or the rate of errors is high, Cloud Tasks will use a higher backoff rate. The retry specified in the `Retry-After` HTTP response header is considered. * To prevent traffic spikes and to smooth sudden increases in traffic, dispatches ramp up slowly when the queue is newly created or idle and if large numbers of tasks suddenly become available to dispatch (due to spikes in create task rates, the queue being unpaused, or many tasks that are scheduled at the same time).Protobuf typegoogle.cloud.tasks.v2beta3.HttpRequest
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description HttpRequest.BuilderaddRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)HttpRequestbuild()HttpRequestbuildPartial()HttpRequest.Builderclear()HttpRequest.BuilderclearAuthorizationHeader()HttpRequest.BuilderclearBody()HTTP request body.HttpRequest.BuilderclearField(com.google.protobuf.Descriptors.FieldDescriptor field)HttpRequest.BuilderclearHeaders()HttpRequest.BuilderclearHttpMethod()The HTTP method to use for the request.HttpRequest.BuilderclearOauthToken()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.HttpRequest.BuilderclearOidcToken()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.HttpRequest.BuilderclearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)HttpRequest.BuilderclearUrl()Required.HttpRequest.Builderclone()booleancontainsHeaders(String key)HTTP request headers.HttpRequest.AuthorizationHeaderCasegetAuthorizationHeaderCase()com.google.protobuf.ByteStringgetBody()HTTP request body.HttpRequestgetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()com.google.protobuf.Descriptors.DescriptorgetDescriptorForType()Map<String,String>getHeaders()Deprecated.intgetHeadersCount()HTTP request headers.Map<String,String>getHeadersMap()HTTP request headers.StringgetHeadersOrDefault(String key, String defaultValue)HTTP request headers.StringgetHeadersOrThrow(String key)HTTP request headers.HttpMethodgetHttpMethod()The HTTP method to use for the request.intgetHttpMethodValue()The HTTP method to use for the request.Map<String,String>getMutableHeaders()Deprecated.OAuthTokengetOauthToken()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.BuildergetOauthTokenBuilder()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.OAuthTokenOrBuildergetOauthTokenOrBuilder()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.OidcTokengetOidcToken()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.BuildergetOidcTokenBuilder()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.OidcTokenOrBuildergetOidcTokenOrBuilder()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.StringgetUrl()Required.com.google.protobuf.ByteStringgetUrlBytes()Required.booleanhasOauthToken()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.booleanhasOidcToken()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.FieldAccessorTableinternalGetFieldAccessorTable()protected com.google.protobuf.MapFieldinternalGetMapField(int number)protected com.google.protobuf.MapFieldinternalGetMutableMapField(int number)booleanisInitialized()HttpRequest.BuildermergeFrom(HttpRequest other)HttpRequest.BuildermergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)HttpRequest.BuildermergeFrom(com.google.protobuf.Message other)HttpRequest.BuildermergeOauthToken(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.HttpRequest.BuildermergeOidcToken(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.HttpRequest.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)HttpRequest.BuilderputAllHeaders(Map<String,String> values)HTTP request headers.HttpRequest.BuilderputHeaders(String key, String value)HTTP request headers.HttpRequest.BuilderremoveHeaders(String key)HTTP request headers.HttpRequest.BuildersetBody(com.google.protobuf.ByteString value)HTTP request body.HttpRequest.BuildersetField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)HttpRequest.BuildersetHttpMethod(HttpMethod value)The HTTP method to use for the request.HttpRequest.BuildersetHttpMethodValue(int value)The HTTP method to use for the request.HttpRequest.BuildersetOauthToken(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.HttpRequest.BuildersetOauthToken(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.HttpRequest.BuildersetOidcToken(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.HttpRequest.BuildersetOidcToken(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.HttpRequest.BuildersetRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)HttpRequest.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)HttpRequest.BuildersetUrl(String value)Required.HttpRequest.BuildersetUrlBytes(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:
internalGetMapFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<HttpRequest.Builder>
-
internalGetMutableMapField
protected com.google.protobuf.MapField internalGetMutableMapField(int number)
- Overrides:
internalGetMutableMapFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<HttpRequest.Builder>
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<HttpRequest.Builder>
-
clear
public HttpRequest.Builder clear()
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<HttpRequest.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<HttpRequest.Builder>
-
getDefaultInstanceForType
public HttpRequest getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
public HttpRequest build()
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public HttpRequest buildPartial()
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
public HttpRequest.Builder clone()
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<HttpRequest.Builder>
-
setField
public HttpRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<HttpRequest.Builder>
-
clearField
public HttpRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<HttpRequest.Builder>
-
clearOneof
public HttpRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<HttpRequest.Builder>
-
setRepeatedField
public HttpRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
- Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<HttpRequest.Builder>
-
addRepeatedField
public HttpRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<HttpRequest.Builder>
-
mergeFrom
public HttpRequest.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<HttpRequest.Builder>
-
mergeFrom
public HttpRequest.Builder mergeFrom(HttpRequest other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3.Builder<HttpRequest.Builder>
-
mergeFrom
public HttpRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<HttpRequest.Builder>- Throws:
IOException
-
getAuthorizationHeaderCase
public HttpRequest.AuthorizationHeaderCase getAuthorizationHeaderCase()
- Specified by:
getAuthorizationHeaderCasein interfaceHttpRequestOrBuilder
-
clearAuthorizationHeader
public HttpRequest.Builder clearAuthorizationHeader()
-
getUrl
public String getUrl()
Required. The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. The `Location` header response from a redirect response [`300` - `399`] may be followed. The redirect is not counted as a separate attempt.
string url = 1;- Specified by:
getUrlin interfaceHttpRequestOrBuilder- Returns:
- The url.
-
getUrlBytes
public com.google.protobuf.ByteString getUrlBytes()
Required. The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. The `Location` header response from a redirect response [`300` - `399`] may be followed. The redirect is not counted as a separate attempt.
string url = 1;- Specified by:
getUrlBytesin interfaceHttpRequestOrBuilder- Returns:
- The bytes for url.
-
setUrl
public HttpRequest.Builder setUrl(String value)
Required. The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. The `Location` header response from a redirect response [`300` - `399`] may be followed. The redirect is not counted as a separate attempt.
string url = 1;- Parameters:
value- The url to set.- Returns:
- This builder for chaining.
-
clearUrl
public HttpRequest.Builder clearUrl()
Required. The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. The `Location` header response from a redirect response [`300` - `399`] may be followed. The redirect is not counted as a separate attempt.
string url = 1;- Returns:
- This builder for chaining.
-
setUrlBytes
public HttpRequest.Builder setUrlBytes(com.google.protobuf.ByteString value)
Required. The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. The `Location` header response from a redirect response [`300` - `399`] may be followed. The redirect is not counted as a separate attempt.
string url = 1;- Parameters:
value- The bytes for url to set.- Returns:
- This builder for chaining.
-
getHttpMethodValue
public int getHttpMethodValue()
The HTTP method to use for the request. The default is POST.
.google.cloud.tasks.v2beta3.HttpMethod http_method = 2;- Specified by:
getHttpMethodValuein interfaceHttpRequestOrBuilder- Returns:
- The enum numeric value on the wire for httpMethod.
-
setHttpMethodValue
public HttpRequest.Builder setHttpMethodValue(int value)
The HTTP method to use for the request. The default is POST.
.google.cloud.tasks.v2beta3.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()
The HTTP method to use for the request. The default is POST.
.google.cloud.tasks.v2beta3.HttpMethod http_method = 2;- Specified by:
getHttpMethodin interfaceHttpRequestOrBuilder- Returns:
- The httpMethod.
-
setHttpMethod
public HttpRequest.Builder setHttpMethod(HttpMethod value)
The HTTP method to use for the request. The default is POST.
.google.cloud.tasks.v2beta3.HttpMethod http_method = 2;- Parameters:
value- The httpMethod to set.- Returns:
- This builder for chaining.
-
clearHttpMethod
public HttpRequest.Builder clearHttpMethod()
The HTTP method to use for the request. The default is POST.
.google.cloud.tasks.v2beta3.HttpMethod http_method = 2;- Returns:
- This builder for chaining.
-
getHeadersCount
public int getHeadersCount()
Description copied from interface:HttpRequestOrBuilderHTTP request headers. This map contains the header field names and values. Headers can be set when the [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with "X-CloudTasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from [HttpRequest.url][google.cloud.tasks.v2beta3.HttpRequest.url]. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB.
map<string, string> headers = 3;- Specified by:
getHeadersCountin interfaceHttpRequestOrBuilder
-
containsHeaders
public boolean containsHeaders(String key)
HTTP request headers. This map contains the header field names and values. Headers can be set when the [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with "X-CloudTasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from [HttpRequest.url][google.cloud.tasks.v2beta3.HttpRequest.url]. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB.
map<string, string> headers = 3;- Specified by:
containsHeadersin interfaceHttpRequestOrBuilder
-
getHeaders
@Deprecated public Map<String,String> getHeaders()
Deprecated.UsegetHeadersMap()instead.- Specified by:
getHeadersin interfaceHttpRequestOrBuilder
-
getHeadersMap
public Map<String,String> getHeadersMap()
HTTP request headers. This map contains the header field names and values. Headers can be set when the [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with "X-CloudTasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from [HttpRequest.url][google.cloud.tasks.v2beta3.HttpRequest.url]. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB.
map<string, string> headers = 3;- Specified by:
getHeadersMapin interfaceHttpRequestOrBuilder
-
getHeadersOrDefault
public String getHeadersOrDefault(String key, String defaultValue)
HTTP request headers. This map contains the header field names and values. Headers can be set when the [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with "X-CloudTasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from [HttpRequest.url][google.cloud.tasks.v2beta3.HttpRequest.url]. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB.
map<string, string> headers = 3;- Specified by:
getHeadersOrDefaultin interfaceHttpRequestOrBuilder
-
getHeadersOrThrow
public String getHeadersOrThrow(String key)
HTTP request headers. This map contains the header field names and values. Headers can be set when the [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with "X-CloudTasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from [HttpRequest.url][google.cloud.tasks.v2beta3.HttpRequest.url]. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB.
map<string, string> headers = 3;- Specified by:
getHeadersOrThrowin interfaceHttpRequestOrBuilder
-
clearHeaders
public HttpRequest.Builder clearHeaders()
-
removeHeaders
public HttpRequest.Builder removeHeaders(String key)
HTTP request headers. This map contains the header field names and values. Headers can be set when the [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with "X-CloudTasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from [HttpRequest.url][google.cloud.tasks.v2beta3.HttpRequest.url]. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the 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 HttpRequest.Builder putHeaders(String key, String value)
HTTP request headers. This map contains the header field names and values. Headers can be set when the [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with "X-CloudTasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from [HttpRequest.url][google.cloud.tasks.v2beta3.HttpRequest.url]. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB.
map<string, string> headers = 3;
-
putAllHeaders
public HttpRequest.Builder putAllHeaders(Map<String,String> values)
HTTP request headers. This map contains the header field names and values. Headers can be set when the [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. These headers represent a subset of the headers that will accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Any header that is prefixed with "X-CloudTasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask. * Host: This will be computed by Cloud Tasks and derived from [HttpRequest.url][google.cloud.tasks.v2beta3.HttpRequest.url]. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the 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][google.cloud.tasks.v2beta3.HttpRequest.http_method] is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible [HttpMethod][google.cloud.tasks.v2beta3.HttpMethod].
bytes body = 4;- Specified by:
getBodyin interfaceHttpRequestOrBuilder- Returns:
- The body.
-
setBody
public HttpRequest.Builder setBody(com.google.protobuf.ByteString value)
HTTP request body. A request body is allowed only if the [HTTP method][google.cloud.tasks.v2beta3.HttpRequest.http_method] is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible [HttpMethod][google.cloud.tasks.v2beta3.HttpMethod].
bytes body = 4;- Parameters:
value- The body to set.- Returns:
- This builder for chaining.
-
clearBody
public HttpRequest.Builder clearBody()
HTTP request body. A request body is allowed only if the [HTTP method][google.cloud.tasks.v2beta3.HttpRequest.http_method] is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible [HttpMethod][google.cloud.tasks.v2beta3.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.tasks.v2beta3.OAuthToken oauth_token = 5;- Specified by:
hasOauthTokenin interfaceHttpRequestOrBuilder- 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.tasks.v2beta3.OAuthToken oauth_token = 5;- Specified by:
getOauthTokenin interfaceHttpRequestOrBuilder- Returns:
- The oauthToken.
-
setOauthToken
public HttpRequest.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.tasks.v2beta3.OAuthToken oauth_token = 5;
-
setOauthToken
public HttpRequest.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.tasks.v2beta3.OAuthToken oauth_token = 5;
-
mergeOauthToken
public HttpRequest.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.tasks.v2beta3.OAuthToken oauth_token = 5;
-
clearOauthToken
public HttpRequest.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.tasks.v2beta3.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.tasks.v2beta3.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.tasks.v2beta3.OAuthToken oauth_token = 5;- Specified by:
getOauthTokenOrBuilderin interfaceHttpRequestOrBuilder
-
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.tasks.v2beta3.OidcToken oidc_token = 6;- Specified by:
hasOidcTokenin interfaceHttpRequestOrBuilder- 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.tasks.v2beta3.OidcToken oidc_token = 6;- Specified by:
getOidcTokenin interfaceHttpRequestOrBuilder- Returns:
- The oidcToken.
-
setOidcToken
public HttpRequest.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.tasks.v2beta3.OidcToken oidc_token = 6;
-
setOidcToken
public HttpRequest.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.tasks.v2beta3.OidcToken oidc_token = 6;
-
mergeOidcToken
public HttpRequest.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.tasks.v2beta3.OidcToken oidc_token = 6;
-
clearOidcToken
public HttpRequest.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.tasks.v2beta3.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.tasks.v2beta3.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.tasks.v2beta3.OidcToken oidc_token = 6;- Specified by:
getOidcTokenOrBuilderin interfaceHttpRequestOrBuilder
-
setUnknownFields
public final HttpRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<HttpRequest.Builder>
-
mergeUnknownFields
public final HttpRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<HttpRequest.Builder>
-
-