public final class HttpTarget extends GeneratedMessageV3 implements HttpTargetOrBuilder
HTTP target.
When specified as a Queue, all the tasks with [HttpRequest]
will be overridden according to the target.
Protobuf type google.cloud.tasks.v2beta2.HttpTarget
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
Static Fields
public static final int HEADER_OVERRIDES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
HTTP_METHOD_FIELD_NUMBER
public static final int HTTP_METHOD_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
OAUTH_TOKEN_FIELD_NUMBER
public static final int OAUTH_TOKEN_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
OIDC_TOKEN_FIELD_NUMBER
public static final int OIDC_TOKEN_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
URI_OVERRIDE_FIELD_NUMBER
public static final int URI_OVERRIDE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static HttpTarget getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static HttpTarget.Builder newBuilder()
newBuilder(HttpTarget prototype)
public static HttpTarget.Builder newBuilder(HttpTarget prototype)
public static HttpTarget parseDelimitedFrom(InputStream input)
public static HttpTarget parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static HttpTarget parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static HttpTarget parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static HttpTarget parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static HttpTarget parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static HttpTarget parseFrom(CodedInputStream input)
public static HttpTarget parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static HttpTarget parseFrom(InputStream input)
public static HttpTarget parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static HttpTarget parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static HttpTarget parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<HttpTarget> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
public HttpTarget.AuthorizationHeaderCase getAuthorizationHeaderCase()
getDefaultInstanceForType()
public HttpTarget getDefaultInstanceForType()
public HttpTarget.HeaderOverride getHeaderOverrides(int index)
HTTP target headers.
This map contains the header field names and values.
Headers will be set when running the
task is created and/or
task is created.
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.
- Content-Length: This will be computed by Cloud Tasks.
- User-Agent: This will be set to
"Google-CloudTasks".
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.
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.
Queue-level headers to override headers of all the tasks in the queue.
repeated .google.cloud.tasks.v2beta2.HttpTarget.HeaderOverride header_overrides = 3;
| Parameter |
|---|
| Name | Description |
index | int
|
public int getHeaderOverridesCount()
HTTP target headers.
This map contains the header field names and values.
Headers will be set when running the
task is created and/or
task is created.
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.
- Content-Length: This will be computed by Cloud Tasks.
- User-Agent: This will be set to
"Google-CloudTasks".
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.
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.
Queue-level headers to override headers of all the tasks in the queue.
repeated .google.cloud.tasks.v2beta2.HttpTarget.HeaderOverride header_overrides = 3;
| Returns |
|---|
| Type | Description |
int | |
public List<HttpTarget.HeaderOverride> getHeaderOverridesList()
HTTP target headers.
This map contains the header field names and values.
Headers will be set when running the
task is created and/or
task is created.
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.
- Content-Length: This will be computed by Cloud Tasks.
- User-Agent: This will be set to
"Google-CloudTasks".
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.
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.
Queue-level headers to override headers of all the tasks in the queue.
repeated .google.cloud.tasks.v2beta2.HttpTarget.HeaderOverride header_overrides = 3;
public HttpTarget.HeaderOverrideOrBuilder getHeaderOverridesOrBuilder(int index)
HTTP target headers.
This map contains the header field names and values.
Headers will be set when running the
task is created and/or
task is created.
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.
- Content-Length: This will be computed by Cloud Tasks.
- User-Agent: This will be set to
"Google-CloudTasks".
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.
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.
Queue-level headers to override headers of all the tasks in the queue.
repeated .google.cloud.tasks.v2beta2.HttpTarget.HeaderOverride header_overrides = 3;
| Parameter |
|---|
| Name | Description |
index | int
|
public List<? extends HttpTarget.HeaderOverrideOrBuilder> getHeaderOverridesOrBuilderList()
HTTP target headers.
This map contains the header field names and values.
Headers will be set when running the
task is created and/or
task is created.
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.
- Content-Length: This will be computed by Cloud Tasks.
- User-Agent: This will be set to
"Google-CloudTasks".
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.
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.
Queue-level headers to override headers of all the tasks in the queue.
repeated .google.cloud.tasks.v2beta2.HttpTarget.HeaderOverride header_overrides = 3;
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.tasks.v2beta2.HttpTarget.HeaderOverrideOrBuilder> | |
getHttpMethod()
public HttpMethod getHttpMethod()
The HTTP method to use for the request.
When specified, it overrides
HttpRequest for the
task. Note that if the value is set to HttpMethod the
HttpRequest of the task will be ignored at execution time.
.google.cloud.tasks.v2beta2.HttpMethod http_method = 2;
getHttpMethodValue()
public int getHttpMethodValue()
The HTTP method to use for the request.
When specified, it overrides
HttpRequest for the
task. Note that if the value is set to HttpMethod the
HttpRequest of the task will be ignored at execution time.
.google.cloud.tasks.v2beta2.HttpMethod http_method = 2;
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for httpMethod.
|
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.tasks.v2beta2.OAuthToken oauth_token = 5;
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.tasks.v2beta2.OAuthToken oauth_token = 5;
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.tasks.v2beta2.OidcToken oidc_token = 6;
| Returns |
|---|
| Type | Description |
OidcToken | The oidcToken.
|
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.tasks.v2beta2.OidcToken oidc_token = 6;
getParserForType()
public Parser<HttpTarget> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getUriOverride()
public UriOverride getUriOverride()
Uri override.
When specified, overrides the execution Uri for all the tasks in the queue.
.google.cloud.tasks.v2beta2.UriOverride uri_override = 1;
getUriOverrideOrBuilder()
public UriOverrideOrBuilder getUriOverrideOrBuilder()
Uri override.
When specified, overrides the execution Uri for all the tasks in the queue.
.google.cloud.tasks.v2beta2.UriOverride uri_override = 1;
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.tasks.v2beta2.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.tasks.v2beta2.OidcToken oidc_token = 6;
| Returns |
|---|
| Type | Description |
boolean | Whether the oidcToken field is set.
|
hasUriOverride()
public boolean hasUriOverride()
Uri override.
When specified, overrides the execution Uri for all the tasks in the queue.
.google.cloud.tasks.v2beta2.UriOverride uri_override = 1;
| Returns |
|---|
| Type | Description |
boolean | Whether the uriOverride field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public HttpTarget.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected HttpTarget.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public HttpTarget.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
