public final class AppEngineHttpTarget extends GeneratedMessageV3 implements AppEngineHttpTargetOrBuilder
App Engine target. The job will be pushed to a job handler by means of an HTTP request via an [http_method][google.cloud.scheduler.v1.AppEngineHttpTarget.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]. Error 503 is considered an App Engine system error instead of an application error. Requests returning error 503 will be retried regardless of retry configuration and not counted against retry counts. Any other response code, or a failure to receive a response before the deadline, constitutes a failed attempt.Protobuf type
google.cloud.scheduler.v1.AppEngineHttpTarget| Modifier and Type | Class and Description |
|---|---|
static class |
AppEngineHttpTarget.Builder
App Engine target.
|
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameterAbstractMessageLite.InternalOneOfEnum| Modifier and Type | Field and Description |
|---|---|
static int |
APP_ENGINE_ROUTING_FIELD_NUMBER |
static int |
BODY_FIELD_NUMBER |
static int |
HEADERS_FIELD_NUMBER |
static int |
HTTP_METHOD_FIELD_NUMBER |
static int |
RELATIVE_URI_FIELD_NUMBER |
alwaysUseFieldBuilders, unknownFieldsmemoizedSizememoizedHashCodecanUseUnsafe, 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, waitfindInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneoftoByteArray, toByteString, writeDelimitedTo, writeTopublic static final int HTTP_METHOD_FIELD_NUMBER
public static final int APP_ENGINE_ROUTING_FIELD_NUMBER
public static final int RELATIVE_URI_FIELD_NUMBER
public static final int HEADERS_FIELD_NUMBER
public static final int BODY_FIELD_NUMBER
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class GeneratedMessageV3public final UnknownFieldSet getUnknownFields()
getUnknownFields in interface MessageOrBuildergetUnknownFields in class GeneratedMessageV3public static final Descriptors.Descriptor getDescriptor()
protected MapField internalGetMapField(int number)
internalGetMapField in class GeneratedMessageV3protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class GeneratedMessageV3public int getHttpMethodValue()
The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
.google.cloud.scheduler.v1.HttpMethod http_method = 1;getHttpMethodValue in interface AppEngineHttpTargetOrBuilderpublic HttpMethod getHttpMethod()
The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
.google.cloud.scheduler.v1.HttpMethod http_method = 1;getHttpMethod in interface AppEngineHttpTargetOrBuilderpublic boolean hasAppEngineRouting()
App Engine Routing setting for the job.
.google.cloud.scheduler.v1.AppEngineRouting app_engine_routing = 2;hasAppEngineRouting in interface AppEngineHttpTargetOrBuilderpublic AppEngineRouting getAppEngineRouting()
App Engine Routing setting for the job.
.google.cloud.scheduler.v1.AppEngineRouting app_engine_routing = 2;getAppEngineRouting in interface AppEngineHttpTargetOrBuilderpublic AppEngineRoutingOrBuilder getAppEngineRoutingOrBuilder()
App Engine Routing setting for the job.
.google.cloud.scheduler.v1.AppEngineRouting app_engine_routing = 2;getAppEngineRoutingOrBuilder in interface AppEngineHttpTargetOrBuilderpublic String getRelativeUri()
The relative URI. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path, query string arguments, and `#` fragments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.
string relative_uri = 3;getRelativeUri in interface AppEngineHttpTargetOrBuilderpublic ByteString getRelativeUriBytes()
The relative URI. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path, query string arguments, and `#` fragments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.
string relative_uri = 3;getRelativeUriBytes in interface AppEngineHttpTargetOrBuilderpublic int getHeadersCount()
AppEngineHttpTargetOrBuilderHTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. If the job has an [body][google.cloud.scheduler.v1.AppEngineHttpTarget.body], Cloud Scheduler sets the following headers: * `Content-Type`: By default, the `Content-Type` header is set to `"application/octet-stream"`. The default can be overridden by explictly setting `Content-Type` to a particular media type when the job is created. For example, `Content-Type` can be set to `"application/json"`. * `Content-Length`: This is computed by Cloud Scheduler. This value is output only. It cannot be changed. The headers below are output only. They cannot be set or overridden: * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
map<string, string> headers = 4;getHeadersCount in interface AppEngineHttpTargetOrBuilderpublic boolean containsHeaders(String key)
HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. If the job has an [body][google.cloud.scheduler.v1.AppEngineHttpTarget.body], Cloud Scheduler sets the following headers: * `Content-Type`: By default, the `Content-Type` header is set to `"application/octet-stream"`. The default can be overridden by explictly setting `Content-Type` to a particular media type when the job is created. For example, `Content-Type` can be set to `"application/json"`. * `Content-Length`: This is computed by Cloud Scheduler. This value is output only. It cannot be changed. The headers below are output only. They cannot be set or overridden: * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
map<string, string> headers = 4;containsHeaders in interface AppEngineHttpTargetOrBuilder@Deprecated public Map<String,String> getHeaders()
getHeadersMap() instead.getHeaders in interface AppEngineHttpTargetOrBuilderpublic Map<String,String> getHeadersMap()
HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. If the job has an [body][google.cloud.scheduler.v1.AppEngineHttpTarget.body], Cloud Scheduler sets the following headers: * `Content-Type`: By default, the `Content-Type` header is set to `"application/octet-stream"`. The default can be overridden by explictly setting `Content-Type` to a particular media type when the job is created. For example, `Content-Type` can be set to `"application/json"`. * `Content-Length`: This is computed by Cloud Scheduler. This value is output only. It cannot be changed. The headers below are output only. They cannot be set or overridden: * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
map<string, string> headers = 4;getHeadersMap in interface AppEngineHttpTargetOrBuilderpublic String getHeadersOrDefault(String key, String defaultValue)
HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. If the job has an [body][google.cloud.scheduler.v1.AppEngineHttpTarget.body], Cloud Scheduler sets the following headers: * `Content-Type`: By default, the `Content-Type` header is set to `"application/octet-stream"`. The default can be overridden by explictly setting `Content-Type` to a particular media type when the job is created. For example, `Content-Type` can be set to `"application/json"`. * `Content-Length`: This is computed by Cloud Scheduler. This value is output only. It cannot be changed. The headers below are output only. They cannot be set or overridden: * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
map<string, string> headers = 4;getHeadersOrDefault in interface AppEngineHttpTargetOrBuilderpublic String getHeadersOrThrow(String key)
HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `X-CloudScheduler`: This header will be set to true. If the job has an [body][google.cloud.scheduler.v1.AppEngineHttpTarget.body], Cloud Scheduler sets the following headers: * `Content-Type`: By default, the `Content-Type` header is set to `"application/octet-stream"`. The default can be overridden by explictly setting `Content-Type` to a particular media type when the job is created. For example, `Content-Type` can be set to `"application/json"`. * `Content-Length`: This is computed by Cloud Scheduler. This value is output only. It cannot be changed. The headers below are output only. They cannot be set or overridden: * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler.
map<string, string> headers = 4;getHeadersOrThrow in interface AppEngineHttpTargetOrBuilderpublic ByteString getBody()
Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible [HttpMethod][google.cloud.scheduler.v1.HttpMethod].
bytes body = 5;getBody in interface AppEngineHttpTargetOrBuilderpublic final boolean isInitialized()
isInitialized in interface MessageLiteOrBuilderisInitialized in class GeneratedMessageV3public void writeTo(CodedOutputStream output) throws IOException
writeTo in interface MessageLitewriteTo in class GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface MessageLitegetSerializedSize in class GeneratedMessageV3public boolean equals(Object obj)
equals in interface Messageequals in class AbstractMessagepublic int hashCode()
hashCode in interface MessagehashCode in class AbstractMessagepublic static AppEngineHttpTarget parseFrom(ByteBuffer data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static AppEngineHttpTarget parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static AppEngineHttpTarget parseFrom(ByteString data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static AppEngineHttpTarget parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static AppEngineHttpTarget parseFrom(byte[] data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static AppEngineHttpTarget parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static AppEngineHttpTarget parseFrom(InputStream input) throws IOException
IOExceptionpublic static AppEngineHttpTarget parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static AppEngineHttpTarget parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static AppEngineHttpTarget parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static AppEngineHttpTarget parseFrom(CodedInputStream input) throws IOException
IOExceptionpublic static AppEngineHttpTarget parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic AppEngineHttpTarget.Builder newBuilderForType()
newBuilderForType in interface MessagenewBuilderForType in interface MessageLitepublic static AppEngineHttpTarget.Builder newBuilder()
public static AppEngineHttpTarget.Builder newBuilder(AppEngineHttpTarget prototype)
public AppEngineHttpTarget.Builder toBuilder()
toBuilder in interface MessagetoBuilder in interface MessageLiteprotected AppEngineHttpTarget.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class GeneratedMessageV3public static AppEngineHttpTarget getDefaultInstance()
public static Parser<AppEngineHttpTarget> parser()
public Parser<AppEngineHttpTarget> getParserForType()
getParserForType in interface MessagegetParserForType in interface MessageLitegetParserForType in class GeneratedMessageV3public AppEngineHttpTarget getDefaultInstanceForType()
getDefaultInstanceForType in interface MessageLiteOrBuildergetDefaultInstanceForType in interface MessageOrBuilderCopyright © 2022 Google LLC. All rights reserved.