Package com.google.cloud.scheduler.v1
Class AppEngineHttpTarget.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderT>
-
- com.google.protobuf.GeneratedMessageV3.Builder<AppEngineHttpTarget.Builder>
-
- com.google.cloud.scheduler.v1.AppEngineHttpTarget.Builder
-
- All Implemented Interfaces:
AppEngineHttpTargetOrBuilder
,com.google.protobuf.Message.Builder
,com.google.protobuf.MessageLite.Builder
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,Cloneable
- Enclosing class:
- AppEngineHttpTarget
public static final class AppEngineHttpTarget.Builder extends com.google.protobuf.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.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 typegoogle.cloud.scheduler.v1.AppEngineHttpTarget
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description AppEngineHttpTarget.Builder
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
AppEngineHttpTarget
build()
AppEngineHttpTarget
buildPartial()
AppEngineHttpTarget.Builder
clear()
AppEngineHttpTarget.Builder
clearAppEngineRouting()
App Engine Routing setting for the job.AppEngineHttpTarget.Builder
clearBody()
Body.AppEngineHttpTarget.Builder
clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
AppEngineHttpTarget.Builder
clearHeaders()
AppEngineHttpTarget.Builder
clearHttpMethod()
The HTTP method to use for the request.AppEngineHttpTarget.Builder
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
AppEngineHttpTarget.Builder
clearRelativeUri()
The relative URI.AppEngineHttpTarget.Builder
clone()
boolean
containsHeaders(String key)
HTTP request headers.AppEngineRouting
getAppEngineRouting()
App Engine Routing setting for the job.AppEngineRouting.Builder
getAppEngineRoutingBuilder()
App Engine Routing setting for the job.AppEngineRoutingOrBuilder
getAppEngineRoutingOrBuilder()
App Engine Routing setting for the job.com.google.protobuf.ByteString
getBody()
Body.AppEngineHttpTarget
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
com.google.protobuf.Descriptors.Descriptor
getDescriptorForType()
Map<String,String>
getHeaders()
Deprecated.int
getHeadersCount()
HTTP request headers.Map<String,String>
getHeadersMap()
HTTP request headers.String
getHeadersOrDefault(String key, String defaultValue)
HTTP request headers.String
getHeadersOrThrow(String key)
HTTP request headers.HttpMethod
getHttpMethod()
The HTTP method to use for the request.int
getHttpMethodValue()
The HTTP method to use for the request.Map<String,String>
getMutableHeaders()
Deprecated.String
getRelativeUri()
The relative URI.com.google.protobuf.ByteString
getRelativeUriBytes()
The relative URI.boolean
hasAppEngineRouting()
App Engine Routing setting for the job.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
protected com.google.protobuf.MapField
internalGetMapField(int number)
protected com.google.protobuf.MapField
internalGetMutableMapField(int number)
boolean
isInitialized()
AppEngineHttpTarget.Builder
mergeAppEngineRouting(AppEngineRouting value)
App Engine Routing setting for the job.AppEngineHttpTarget.Builder
mergeFrom(AppEngineHttpTarget other)
AppEngineHttpTarget.Builder
mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
AppEngineHttpTarget.Builder
mergeFrom(com.google.protobuf.Message other)
AppEngineHttpTarget.Builder
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
AppEngineHttpTarget.Builder
putAllHeaders(Map<String,String> values)
HTTP request headers.AppEngineHttpTarget.Builder
putHeaders(String key, String value)
HTTP request headers.AppEngineHttpTarget.Builder
removeHeaders(String key)
HTTP request headers.AppEngineHttpTarget.Builder
setAppEngineRouting(AppEngineRouting value)
App Engine Routing setting for the job.AppEngineHttpTarget.Builder
setAppEngineRouting(AppEngineRouting.Builder builderForValue)
App Engine Routing setting for the job.AppEngineHttpTarget.Builder
setBody(com.google.protobuf.ByteString value)
Body.AppEngineHttpTarget.Builder
setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
AppEngineHttpTarget.Builder
setHttpMethod(HttpMethod value)
The HTTP method to use for the request.AppEngineHttpTarget.Builder
setHttpMethodValue(int value)
The HTTP method to use for the request.AppEngineHttpTarget.Builder
setRelativeUri(String value)
The relative URI.AppEngineHttpTarget.Builder
setRelativeUriBytes(com.google.protobuf.ByteString value)
The relative URI.AppEngineHttpTarget.Builder
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
AppEngineHttpTarget.Builder
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
-
Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetMapField
protected com.google.protobuf.MapField internalGetMapField(int number)
- Overrides:
internalGetMapField
in classcom.google.protobuf.GeneratedMessageV3.Builder<AppEngineHttpTarget.Builder>
-
internalGetMutableMapField
protected com.google.protobuf.MapField internalGetMutableMapField(int number)
- Overrides:
internalGetMutableMapField
in classcom.google.protobuf.GeneratedMessageV3.Builder<AppEngineHttpTarget.Builder>
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3.Builder<AppEngineHttpTarget.Builder>
-
clear
public AppEngineHttpTarget.Builder clear()
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessageV3.Builder<AppEngineHttpTarget.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessageV3.Builder<AppEngineHttpTarget.Builder>
-
getDefaultInstanceForType
public AppEngineHttpTarget getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
public AppEngineHttpTarget build()
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public AppEngineHttpTarget buildPartial()
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
clone
public AppEngineHttpTarget.Builder clone()
- Specified by:
clone
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clone
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clone
in classcom.google.protobuf.GeneratedMessageV3.Builder<AppEngineHttpTarget.Builder>
-
setField
public AppEngineHttpTarget.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
setField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setField
in classcom.google.protobuf.GeneratedMessageV3.Builder<AppEngineHttpTarget.Builder>
-
clearField
public AppEngineHttpTarget.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearField
in classcom.google.protobuf.GeneratedMessageV3.Builder<AppEngineHttpTarget.Builder>
-
clearOneof
public AppEngineHttpTarget.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneof
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearOneof
in classcom.google.protobuf.GeneratedMessageV3.Builder<AppEngineHttpTarget.Builder>
-
setRepeatedField
public AppEngineHttpTarget.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
- Specified by:
setRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<AppEngineHttpTarget.Builder>
-
addRepeatedField
public AppEngineHttpTarget.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
addRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
addRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<AppEngineHttpTarget.Builder>
-
mergeFrom
public AppEngineHttpTarget.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<AppEngineHttpTarget.Builder>
-
mergeFrom
public AppEngineHttpTarget.Builder mergeFrom(AppEngineHttpTarget other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3.Builder<AppEngineHttpTarget.Builder>
-
mergeFrom
public AppEngineHttpTarget.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<AppEngineHttpTarget.Builder>
- Throws:
IOException
-
getHttpMethodValue
public int getHttpMethodValue()
The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
.google.cloud.scheduler.v1.HttpMethod http_method = 1;
- Specified by:
getHttpMethodValue
in interfaceAppEngineHttpTargetOrBuilder
- Returns:
- The enum numeric value on the wire for httpMethod.
-
setHttpMethodValue
public AppEngineHttpTarget.Builder setHttpMethodValue(int value)
The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
.google.cloud.scheduler.v1.HttpMethod http_method = 1;
- Parameters:
value
- The enum numeric value on the wire for httpMethod to set.- Returns:
- This builder for chaining.
-
getHttpMethod
public HttpMethod getHttpMethod()
The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
.google.cloud.scheduler.v1.HttpMethod http_method = 1;
- Specified by:
getHttpMethod
in interfaceAppEngineHttpTargetOrBuilder
- Returns:
- The httpMethod.
-
setHttpMethod
public AppEngineHttpTarget.Builder setHttpMethod(HttpMethod value)
The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
.google.cloud.scheduler.v1.HttpMethod http_method = 1;
- Parameters:
value
- The httpMethod to set.- Returns:
- This builder for chaining.
-
clearHttpMethod
public AppEngineHttpTarget.Builder clearHttpMethod()
The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
.google.cloud.scheduler.v1.HttpMethod http_method = 1;
- Returns:
- This builder for chaining.
-
hasAppEngineRouting
public boolean hasAppEngineRouting()
App Engine Routing setting for the job.
.google.cloud.scheduler.v1.AppEngineRouting app_engine_routing = 2;
- Specified by:
hasAppEngineRouting
in interfaceAppEngineHttpTargetOrBuilder
- Returns:
- Whether the appEngineRouting field is set.
-
getAppEngineRouting
public AppEngineRouting getAppEngineRouting()
App Engine Routing setting for the job.
.google.cloud.scheduler.v1.AppEngineRouting app_engine_routing = 2;
- Specified by:
getAppEngineRouting
in interfaceAppEngineHttpTargetOrBuilder
- Returns:
- The appEngineRouting.
-
setAppEngineRouting
public AppEngineHttpTarget.Builder setAppEngineRouting(AppEngineRouting value)
App Engine Routing setting for the job.
.google.cloud.scheduler.v1.AppEngineRouting app_engine_routing = 2;
-
setAppEngineRouting
public AppEngineHttpTarget.Builder setAppEngineRouting(AppEngineRouting.Builder builderForValue)
App Engine Routing setting for the job.
.google.cloud.scheduler.v1.AppEngineRouting app_engine_routing = 2;
-
mergeAppEngineRouting
public AppEngineHttpTarget.Builder mergeAppEngineRouting(AppEngineRouting value)
App Engine Routing setting for the job.
.google.cloud.scheduler.v1.AppEngineRouting app_engine_routing = 2;
-
clearAppEngineRouting
public AppEngineHttpTarget.Builder clearAppEngineRouting()
App Engine Routing setting for the job.
.google.cloud.scheduler.v1.AppEngineRouting app_engine_routing = 2;
-
getAppEngineRoutingBuilder
public AppEngineRouting.Builder getAppEngineRoutingBuilder()
App Engine Routing setting for the job.
.google.cloud.scheduler.v1.AppEngineRouting app_engine_routing = 2;
-
getAppEngineRoutingOrBuilder
public AppEngineRoutingOrBuilder getAppEngineRoutingOrBuilder()
App Engine Routing setting for the job.
.google.cloud.scheduler.v1.AppEngineRouting app_engine_routing = 2;
- Specified by:
getAppEngineRoutingOrBuilder
in interfaceAppEngineHttpTargetOrBuilder
-
getRelativeUri
public 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;
- Specified by:
getRelativeUri
in interfaceAppEngineHttpTargetOrBuilder
- Returns:
- The relativeUri.
-
getRelativeUriBytes
public com.google.protobuf.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;
- Specified by:
getRelativeUriBytes
in interfaceAppEngineHttpTargetOrBuilder
- Returns:
- The bytes for relativeUri.
-
setRelativeUri
public 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;
- Parameters:
value
- The relativeUri to set.- Returns:
- This builder for chaining.
-
clearRelativeUri
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;
- Returns:
- This builder for chaining.
-
setRelativeUriBytes
public AppEngineHttpTarget.Builder setRelativeUriBytes(com.google.protobuf.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;
- Parameters:
value
- The bytes for relativeUri to set.- Returns:
- This builder for chaining.
-
getHeadersCount
public int getHeadersCount()
Description copied from interface:AppEngineHttpTargetOrBuilder
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. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. 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;
- Specified by:
getHeadersCount
in interfaceAppEngineHttpTargetOrBuilder
-
containsHeaders
public 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. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. 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;
- Specified by:
containsHeaders
in interfaceAppEngineHttpTargetOrBuilder
-
getHeaders
@Deprecated public Map<String,String> getHeaders()
Deprecated.UsegetHeadersMap()
instead.- Specified by:
getHeaders
in interfaceAppEngineHttpTargetOrBuilder
-
getHeadersMap
public 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. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. 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;
- Specified by:
getHeadersMap
in interfaceAppEngineHttpTargetOrBuilder
-
getHeadersOrDefault
public 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. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. 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;
- Specified by:
getHeadersOrDefault
in interfaceAppEngineHttpTargetOrBuilder
-
getHeadersOrThrow
public 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. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. 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;
- Specified by:
getHeadersOrThrow
in interfaceAppEngineHttpTargetOrBuilder
-
clearHeaders
public AppEngineHttpTarget.Builder clearHeaders()
-
removeHeaders
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. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. 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;
-
getMutableHeaders
@Deprecated public Map<String,String> getMutableHeaders()
Deprecated.Use alternate mutation accessors instead.
-
putHeaders
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. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. 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;
-
putAllHeaders
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. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. 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;
-
getBody
public com.google.protobuf.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;
- Specified by:
getBody
in interfaceAppEngineHttpTargetOrBuilder
- Returns:
- The body.
-
setBody
public AppEngineHttpTarget.Builder setBody(com.google.protobuf.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.v1.HttpMethod].
bytes body = 5;
- Parameters:
value
- The body to set.- Returns:
- This builder for chaining.
-
clearBody
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.v1.HttpMethod].
bytes body = 5;
- Returns:
- This builder for chaining.
-
setUnknownFields
public final AppEngineHttpTarget.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
setUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<AppEngineHttpTarget.Builder>
-
mergeUnknownFields
public final AppEngineHttpTarget.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<AppEngineHttpTarget.Builder>
-
-