Interface AppEngineHttpTargetOrBuilder (2.44.0)
Stay organized with collections
Save and categorize content based on your preferences.
- 2.78.0 (latest)
- 2.76.0
- 2.75.0
- 2.74.0
- 2.73.0
- 2.72.0
- 2.70.0
- 2.68.0
- 2.67.0
- 2.64.0
- 2.63.0
- 2.62.0
- 2.60.0
- 2.59.0
- 2.58.0
- 2.57.0
- 2.56.0
- 2.55.0
- 2.54.0
- 2.53.0
- 2.52.0
- 2.51.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.13
- 2.2.0
- 2.1.23
publicinterface AppEngineHttpTargetOrBuilderextendsMessageOrBuilderImplements
MessageOrBuilderMethods
containsHeaders(String key)
publicabstractbooleancontainsHeaders(Stringkey)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 modifiedUser-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 as an offset of UTC parsed according to RFC3339.If the job has an body, Cloud Scheduler sets the following headers:
Content-Type: By default, theContent-Typeheader is set to"application/octet-stream". The default can be overridden by explictly settingContent-Typeto a particular media type when the job is created. For example,Content-Typecan 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;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getAppEngineRouting()
publicabstractAppEngineRoutinggetAppEngineRouting()App Engine Routing setting for the job.
.google.cloud.scheduler.v1beta1.AppEngineRouting app_engine_routing = 2;
| Returns | |
|---|---|
| Type | Description |
AppEngineRouting |
The appEngineRouting. |
getAppEngineRoutingOrBuilder()
publicabstractAppEngineRoutingOrBuildergetAppEngineRoutingOrBuilder()App Engine Routing setting for the job.
.google.cloud.scheduler.v1beta1.AppEngineRouting app_engine_routing = 2;
| Returns | |
|---|---|
| Type | Description |
AppEngineRoutingOrBuilder |
|
getBody()
publicabstractByteStringgetBody()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.
bytes body = 5;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The body. |
getHeaders() (deprecated)
publicabstractMap<String,String>getHeaders()Use #getHeadersMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getHeadersCount()
publicabstractintgetHeadersCount()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 modifiedUser-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 as an offset of UTC parsed according to RFC3339.If the job has an body, Cloud Scheduler sets the following headers:
Content-Type: By default, theContent-Typeheader is set to"application/octet-stream". The default can be overridden by explictly settingContent-Typeto a particular media type when the job is created. For example,Content-Typecan 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;
| Returns | |
|---|---|
| Type | Description |
int |
|
getHeadersMap()
publicabstractMap<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 modifiedUser-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 as an offset of UTC parsed according to RFC3339.If the job has an body, Cloud Scheduler sets the following headers:
Content-Type: By default, theContent-Typeheader is set to"application/octet-stream". The default can be overridden by explictly settingContent-Typeto a particular media type when the job is created. For example,Content-Typecan 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;
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getHeadersOrDefault(String key, String defaultValue)
publicabstractStringgetHeadersOrDefault(Stringkey,StringdefaultValue)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 modifiedUser-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 as an offset of UTC parsed according to RFC3339.If the job has an body, Cloud Scheduler sets the following headers:
Content-Type: By default, theContent-Typeheader is set to"application/octet-stream". The default can be overridden by explictly settingContent-Typeto a particular media type when the job is created. For example,Content-Typecan 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;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getHeadersOrThrow(String key)
publicabstractStringgetHeadersOrThrow(Stringkey)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 modifiedUser-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 as an offset of UTC parsed according to RFC3339.If the job has an body, Cloud Scheduler sets the following headers:
Content-Type: By default, theContent-Typeheader is set to"application/octet-stream". The default can be overridden by explictly settingContent-Typeto a particular media type when the job is created. For example,Content-Typecan 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;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getHttpMethod()
publicabstractHttpMethodgetHttpMethod()The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
.google.cloud.scheduler.v1beta1.HttpMethod http_method = 1;
| Returns | |
|---|---|
| Type | Description |
HttpMethod |
The httpMethod. |
getHttpMethodValue()
publicabstractintgetHttpMethodValue()The HTTP method to use for the request. PATCH and OPTIONS are not permitted.
.google.cloud.scheduler.v1beta1.HttpMethod http_method = 1;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for httpMethod. |
getRelativeUri()
publicabstractStringgetRelativeUri()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 | |
|---|---|
| Type | Description |
String |
The relativeUri. |
getRelativeUriBytes()
publicabstractByteStringgetRelativeUriBytes()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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for relativeUri. |
hasAppEngineRouting()
publicabstractbooleanhasAppEngineRouting()App Engine Routing setting for the job.
.google.cloud.scheduler.v1beta1.AppEngineRouting app_engine_routing = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the appEngineRouting field is set. |