public final class HttpTarget extends com.google.protobuf.GeneratedMessageV3 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 type
google.cloud.scheduler.v1beta1.HttpTarget| Modifier and Type | Class and Description |
|---|---|
static class |
HttpTarget.AuthorizationHeaderCase |
static class |
HttpTarget.Builder
Http target.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
BODY_FIELD_NUMBER |
static int |
HEADERS_FIELD_NUMBER |
static int |
HTTP_METHOD_FIELD_NUMBER |
static int |
OAUTH_TOKEN_FIELD_NUMBER |
static int |
OIDC_TOKEN_FIELD_NUMBER |
static int |
URI_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
containsHeaders(String key)
The user can specify HTTP request headers to send with the job's
HTTP request.
|
boolean |
equals(Object obj) |
HttpTarget.AuthorizationHeaderCase |
getAuthorizationHeaderCase() |
com.google.protobuf.ByteString |
getBody()
HTTP request body.
|
static HttpTarget |
getDefaultInstance() |
HttpTarget |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
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.
|
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() |
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
String |
getUri()
Required.
|
com.google.protobuf.ByteString |
getUriBytes()
Required.
|
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.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapField |
internalGetMapField(int number) |
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, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, 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_FIELD_NUMBER
public static final int HTTP_METHOD_FIELD_NUMBER
public static final int HEADERS_FIELD_NUMBER
public static final int BODY_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 final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapField internalGetMapField(int number)
internalGetMapField in class com.google.protobuf.GeneratedMessageV3protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public HttpTarget.AuthorizationHeaderCase getAuthorizationHeaderCase()
getAuthorizationHeaderCase in interface HttpTargetOrBuilderpublic 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;getUri in interface HttpTargetOrBuilderpublic 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;getUriBytes in interface HttpTargetOrBuilderpublic int getHttpMethodValue()
Which HTTP method to use for the request.
.google.cloud.scheduler.v1beta1.HttpMethod http_method = 2;getHttpMethodValue in interface HttpTargetOrBuilderpublic HttpMethod getHttpMethod()
Which HTTP method to use for the request.
.google.cloud.scheduler.v1beta1.HttpMethod http_method = 2;getHttpMethod in interface HttpTargetOrBuilderpublic int getHeadersCount()
HttpTargetOrBuilderThe 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. The total size of headers must be less than 80KB.
map<string, string> headers = 3;getHeadersCount in interface HttpTargetOrBuilderpublic 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. The total size of headers must be less than 80KB.
map<string, string> headers = 3;containsHeaders in interface HttpTargetOrBuilder@Deprecated public Map<String,String> getHeaders()
getHeadersMap() instead.getHeaders in interface HttpTargetOrBuilderpublic 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. The total size of headers must be less than 80KB.
map<string, string> headers = 3;getHeadersMap in interface HttpTargetOrBuilderpublic 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. The total size of headers must be less than 80KB.
map<string, string> headers = 3;getHeadersOrDefault in interface HttpTargetOrBuilderpublic 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. The total size of headers must be less than 80KB.
map<string, string> headers = 3;getHeadersOrThrow in interface HttpTargetOrBuilderpublic 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;getBody 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.scheduler.v1beta1.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.scheduler.v1beta1.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.scheduler.v1beta1.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.scheduler.v1beta1.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.scheduler.v1beta1.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.scheduler.v1beta1.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 © 2022 Google LLC. All rights reserved.