public static final class AppEngineHttpTarget.Builder extends GeneratedMessageV3.Builder<AppEngineHttpTarget.Builder> 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.v1beta1.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.v1beta1.AppEngineHttpTargetgetAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofmergeDelimitedFrom, mergeDelimitedFrommergeFrompublic static final Descriptors.Descriptor getDescriptor()
protected MapField internalGetMapField(int number)
internalGetMapField in class GeneratedMessageV3.Builder<AppEngineHttpTarget.Builder>protected MapField internalGetMutableMapField(int number)
internalGetMutableMapField in class GeneratedMessageV3.Builder<AppEngineHttpTarget.Builder>protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<AppEngineHttpTarget.Builder>public AppEngineHttpTarget.Builder clear()
clear in interface Message.Builderclear in interface MessageLite.Builderclear in class GeneratedMessageV3.Builder<AppEngineHttpTarget.Builder>public Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface Message.BuildergetDescriptorForType in interface MessageOrBuildergetDescriptorForType in class GeneratedMessageV3.Builder<AppEngineHttpTarget.Builder>public AppEngineHttpTarget getDefaultInstanceForType()
getDefaultInstanceForType in interface MessageLiteOrBuildergetDefaultInstanceForType in interface MessageOrBuilderpublic AppEngineHttpTarget build()
build in interface Message.Builderbuild in interface MessageLite.Builderpublic AppEngineHttpTarget buildPartial()
buildPartial in interface Message.BuilderbuildPartial in interface MessageLite.Builderpublic AppEngineHttpTarget.Builder clone()
clone in interface Message.Builderclone in interface MessageLite.Builderclone in class GeneratedMessageV3.Builder<AppEngineHttpTarget.Builder>public AppEngineHttpTarget.Builder setField(Descriptors.FieldDescriptor field, Object value)
setField in interface Message.BuildersetField in class GeneratedMessageV3.Builder<AppEngineHttpTarget.Builder>public AppEngineHttpTarget.Builder clearField(Descriptors.FieldDescriptor field)
clearField in interface Message.BuilderclearField in class GeneratedMessageV3.Builder<AppEngineHttpTarget.Builder>public AppEngineHttpTarget.Builder clearOneof(Descriptors.OneofDescriptor oneof)
clearOneof in interface Message.BuilderclearOneof in class GeneratedMessageV3.Builder<AppEngineHttpTarget.Builder>public AppEngineHttpTarget.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface Message.BuildersetRepeatedField in class GeneratedMessageV3.Builder<AppEngineHttpTarget.Builder>public AppEngineHttpTarget.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface Message.BuilderaddRepeatedField in class GeneratedMessageV3.Builder<AppEngineHttpTarget.Builder>public AppEngineHttpTarget.Builder mergeFrom(Message other)
mergeFrom in interface Message.BuildermergeFrom in class AbstractMessage.Builder<AppEngineHttpTarget.Builder>public AppEngineHttpTarget.Builder mergeFrom(AppEngineHttpTarget other)
public final boolean isInitialized()
isInitialized in interface MessageLiteOrBuilderisInitialized in class GeneratedMessageV3.Builder<AppEngineHttpTarget.Builder>public AppEngineHttpTarget.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface Message.BuildermergeFrom in interface MessageLite.BuildermergeFrom in class AbstractMessage.Builder<AppEngineHttpTarget.Builder>IOExceptionpublic int getHttpMethodValue()
The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
.google.cloud.scheduler.v1beta1.HttpMethod http_method = 1;getHttpMethodValue in interface AppEngineHttpTargetOrBuilderpublic AppEngineHttpTarget.Builder setHttpMethodValue(int value)
The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
.google.cloud.scheduler.v1beta1.HttpMethod http_method = 1;value - The enum numeric value on the wire for httpMethod to set.public HttpMethod getHttpMethod()
The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
.google.cloud.scheduler.v1beta1.HttpMethod http_method = 1;getHttpMethod in interface AppEngineHttpTargetOrBuilderpublic AppEngineHttpTarget.Builder setHttpMethod(HttpMethod value)
The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
.google.cloud.scheduler.v1beta1.HttpMethod http_method = 1;value - The httpMethod to set.public AppEngineHttpTarget.Builder clearHttpMethod()
The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
.google.cloud.scheduler.v1beta1.HttpMethod http_method = 1;public boolean hasAppEngineRouting()
App Engine Routing setting for the job.
.google.cloud.scheduler.v1beta1.AppEngineRouting app_engine_routing = 2;hasAppEngineRouting in interface AppEngineHttpTargetOrBuilderpublic AppEngineRouting getAppEngineRouting()
App Engine Routing setting for the job.
.google.cloud.scheduler.v1beta1.AppEngineRouting app_engine_routing = 2;getAppEngineRouting in interface AppEngineHttpTargetOrBuilderpublic AppEngineHttpTarget.Builder setAppEngineRouting(AppEngineRouting value)
App Engine Routing setting for the job.
.google.cloud.scheduler.v1beta1.AppEngineRouting app_engine_routing = 2;public AppEngineHttpTarget.Builder setAppEngineRouting(AppEngineRouting.Builder builderForValue)
App Engine Routing setting for the job.
.google.cloud.scheduler.v1beta1.AppEngineRouting app_engine_routing = 2;public AppEngineHttpTarget.Builder mergeAppEngineRouting(AppEngineRouting value)
App Engine Routing setting for the job.
.google.cloud.scheduler.v1beta1.AppEngineRouting app_engine_routing = 2;public AppEngineHttpTarget.Builder clearAppEngineRouting()
App Engine Routing setting for the job.
.google.cloud.scheduler.v1beta1.AppEngineRouting app_engine_routing = 2;public AppEngineRouting.Builder getAppEngineRoutingBuilder()
App Engine Routing setting for the job.
.google.cloud.scheduler.v1beta1.AppEngineRouting app_engine_routing = 2;public AppEngineRoutingOrBuilder getAppEngineRoutingOrBuilder()
App Engine Routing setting for the job.
.google.cloud.scheduler.v1beta1.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 AppEngineHttpTarget.Builder setRelativeUri(String value)
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;value - The relativeUri to set.public AppEngineHttpTarget.Builder clearRelativeUri()
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;public AppEngineHttpTarget.Builder setRelativeUriBytes(ByteString value)
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;value - The bytes for relativeUri to set.public 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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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 AppEngineHttpTarget.Builder clearHeaders()
public AppEngineHttpTarget.Builder removeHeaders(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.v1beta1.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;@Deprecated public Map<String,String> getMutableHeaders()
public AppEngineHttpTarget.Builder putHeaders(String key, String value)
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.v1beta1.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;public AppEngineHttpTarget.Builder putAllHeaders(Map<String,String> values)
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.v1beta1.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;public 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.v1beta1.HttpMethod].
bytes body = 5;getBody in interface AppEngineHttpTargetOrBuilderpublic AppEngineHttpTarget.Builder setBody(ByteString value)
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.v1beta1.HttpMethod].
bytes body = 5;value - The body to set.public AppEngineHttpTarget.Builder clearBody()
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.v1beta1.HttpMethod].
bytes body = 5;public final AppEngineHttpTarget.Builder setUnknownFields(UnknownFieldSet unknownFields)
setUnknownFields in interface Message.BuildersetUnknownFields in class GeneratedMessageV3.Builder<AppEngineHttpTarget.Builder>public final AppEngineHttpTarget.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
mergeUnknownFields in interface Message.BuildermergeUnknownFields in class GeneratedMessageV3.Builder<AppEngineHttpTarget.Builder>Copyright © 2022 Google LLC. All rights reserved.