public final class HttpTarget extends com.google.protobuf.GeneratedMessageV3 implements HttpTargetOrBuilder
HTTP target. When specified as a [Queue][target_type], all the tasks with [HttpRequest] will be overridden according to the target.Protobuf type
google.cloud.tasks.v2beta2.HttpTarget| Modifier and Type | Class and Description |
|---|---|
static class |
HttpTarget.AuthorizationHeaderCase |
static class |
HttpTarget.Builder
HTTP target.
|
static class |
HttpTarget.Header
Defines a header message.
|
static interface |
HttpTarget.HeaderOrBuilder |
static class |
HttpTarget.HeaderOverride
Wraps the Header object.
|
static interface |
HttpTarget.HeaderOverrideOrBuilder |
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
HEADER_OVERRIDES_FIELD_NUMBER |
static int |
HTTP_METHOD_FIELD_NUMBER |
static int |
OAUTH_TOKEN_FIELD_NUMBER |
static int |
OIDC_TOKEN_FIELD_NUMBER |
static int |
URI_OVERRIDE_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
HttpTarget.AuthorizationHeaderCase |
getAuthorizationHeaderCase() |
static HttpTarget |
getDefaultInstance() |
HttpTarget |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
HttpTarget.HeaderOverride |
getHeaderOverrides(int index)
HTTP target headers.
|
int |
getHeaderOverridesCount()
HTTP target headers.
|
List<HttpTarget.HeaderOverride> |
getHeaderOverridesList()
HTTP target headers.
|
HttpTarget.HeaderOverrideOrBuilder |
getHeaderOverridesOrBuilder(int index)
HTTP target headers.
|
List<? extends HttpTarget.HeaderOverrideOrBuilder> |
getHeaderOverridesOrBuilderList()
HTTP target headers.
|
HttpMethod |
getHttpMethod()
The HTTP method to use for the request.
|
int |
getHttpMethodValue()
The HTTP method to use for the request.
|
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.
|
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.
|
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.
|
com.google.protobuf.Parser<HttpTarget> |
getParserForType() |
int |
getSerializedSize() |
UriOverride |
getUriOverride()
Uri override.
|
UriOverrideOrBuilder |
getUriOverrideOrBuilder()
Uri override.
|
int |
hashCode() |
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.
|
boolean |
hasUriOverride()
Uri override.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static HttpTarget.Builder |
newBuilder() |
static HttpTarget.Builder |
newBuilder(HttpTarget prototype) |
HttpTarget.Builder |
newBuilderForType() |
protected HttpTarget.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static HttpTarget |
parseDelimitedFrom(InputStream input) |
static HttpTarget |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static HttpTarget |
parseFrom(byte[] data) |
static HttpTarget |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static HttpTarget |
parseFrom(ByteBuffer data) |
static HttpTarget |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static HttpTarget |
parseFrom(com.google.protobuf.ByteString data) |
static HttpTarget |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static HttpTarget |
parseFrom(com.google.protobuf.CodedInputStream input) |
static HttpTarget |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static HttpTarget |
parseFrom(InputStream input) |
static HttpTarget |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<HttpTarget> |
parser() |
HttpTarget.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int URI_OVERRIDE_FIELD_NUMBER
public static final int HTTP_METHOD_FIELD_NUMBER
public static final int HEADER_OVERRIDES_FIELD_NUMBER
public static final int OAUTH_TOKEN_FIELD_NUMBER
public static final int OIDC_TOKEN_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public HttpTarget.AuthorizationHeaderCase getAuthorizationHeaderCase()
getAuthorizationHeaderCase in interface HttpTargetOrBuilderpublic 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;hasUriOverride in interface HttpTargetOrBuilderpublic 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;getUriOverride in interface HttpTargetOrBuilderpublic 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;getUriOverrideOrBuilder in interface HttpTargetOrBuilderpublic int getHttpMethodValue()
The HTTP method to use for the request. When specified, it overrides [HttpRequest][google.cloud.tasks.v2beta2.HttpTarget.http_method] for the task. Note that if the value is set to [HttpMethod][GET] the [HttpRequest][body] of the task will be ignored at execution time.
.google.cloud.tasks.v2beta2.HttpMethod http_method = 2;getHttpMethodValue in interface HttpTargetOrBuilderpublic HttpMethod getHttpMethod()
The HTTP method to use for the request. When specified, it overrides [HttpRequest][google.cloud.tasks.v2beta2.HttpTarget.http_method] for the task. Note that if the value is set to [HttpMethod][GET] the [HttpRequest][body] of the task will be ignored at execution time.
.google.cloud.tasks.v2beta2.HttpMethod http_method = 2;getHttpMethod in interface HttpTargetOrBuilderpublic 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][google.cloud.tasks.v2beta2.CloudTasks.CreateTask] and/or [task is created][google.cloud.tasks.v2beta2.CloudTasks.BufferTask]. 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.v2beta2.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][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. Queue-level headers to override headers of all the tasks in the queue.
repeated .google.cloud.tasks.v2beta2.HttpTarget.HeaderOverride header_overrides = 3;
getHeaderOverridesList in interface HttpTargetOrBuilderpublic 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][google.cloud.tasks.v2beta2.CloudTasks.CreateTask] and/or [task is created][google.cloud.tasks.v2beta2.CloudTasks.BufferTask]. 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.v2beta2.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][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. Queue-level headers to override headers of all the tasks in the queue.
repeated .google.cloud.tasks.v2beta2.HttpTarget.HeaderOverride header_overrides = 3;
getHeaderOverridesOrBuilderList in interface HttpTargetOrBuilderpublic int getHeaderOverridesCount()
HTTP target headers. This map contains the header field names and values. Headers will be set when running the [task is created][google.cloud.tasks.v2beta2.CloudTasks.CreateTask] and/or [task is created][google.cloud.tasks.v2beta2.CloudTasks.BufferTask]. 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.v2beta2.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][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. Queue-level headers to override headers of all the tasks in the queue.
repeated .google.cloud.tasks.v2beta2.HttpTarget.HeaderOverride header_overrides = 3;
getHeaderOverridesCount in interface HttpTargetOrBuilderpublic 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][google.cloud.tasks.v2beta2.CloudTasks.CreateTask] and/or [task is created][google.cloud.tasks.v2beta2.CloudTasks.BufferTask]. 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.v2beta2.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][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. Queue-level headers to override headers of all the tasks in the queue.
repeated .google.cloud.tasks.v2beta2.HttpTarget.HeaderOverride header_overrides = 3;
getHeaderOverrides in interface HttpTargetOrBuilderpublic 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][google.cloud.tasks.v2beta2.CloudTasks.CreateTask] and/or [task is created][google.cloud.tasks.v2beta2.CloudTasks.BufferTask]. 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.v2beta2.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][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. Queue-level headers to override headers of all the tasks in the queue.
repeated .google.cloud.tasks.v2beta2.HttpTarget.HeaderOverride header_overrides = 3;
getHeaderOverridesOrBuilder in interface HttpTargetOrBuilderpublic 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.v2beta2.OAuthToken oauth_token = 5;hasOauthToken in interface HttpTargetOrBuilderpublic 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.v2beta2.OAuthToken oauth_token = 5;getOauthToken in interface HttpTargetOrBuilderpublic 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.v2beta2.OAuthToken oauth_token = 5;getOauthTokenOrBuilder in interface HttpTargetOrBuilderpublic 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.v2beta2.OidcToken oidc_token = 6;hasOidcToken in interface HttpTargetOrBuilderpublic 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.v2beta2.OidcToken oidc_token = 6;getOidcToken in interface HttpTargetOrBuilderpublic 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.v2beta2.OidcToken oidc_token = 6;getOidcTokenOrBuilder in interface HttpTargetOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static HttpTarget parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static HttpTarget parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static HttpTarget parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static HttpTarget parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static HttpTarget parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static HttpTarget parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static HttpTarget parseFrom(InputStream input) throws IOException
IOExceptionpublic static HttpTarget parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static HttpTarget parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static HttpTarget parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static HttpTarget parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static HttpTarget parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic HttpTarget.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static HttpTarget.Builder newBuilder()
public static HttpTarget.Builder newBuilder(HttpTarget prototype)
public HttpTarget.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected HttpTarget.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static HttpTarget getDefaultInstance()
public static com.google.protobuf.Parser<HttpTarget> parser()
public com.google.protobuf.Parser<HttpTarget> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public HttpTarget getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024 Google LLC. All rights reserved.