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 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
Static Fields
APP_ENGINE_ROUTING_FIELD_NUMBER
public static final int APP_ENGINE_ROUTING_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
BODY_FIELD_NUMBER
public static final int BODY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int HEADERS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
HTTP_METHOD_FIELD_NUMBER
public static final int HTTP_METHOD_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RELATIVE_URI_FIELD_NUMBER
public static final int RELATIVE_URI_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static AppEngineHttpTarget getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static AppEngineHttpTarget.Builder newBuilder()
newBuilder(AppEngineHttpTarget prototype)
public static AppEngineHttpTarget.Builder newBuilder(AppEngineHttpTarget prototype)
public static AppEngineHttpTarget parseDelimitedFrom(InputStream input)
public static AppEngineHttpTarget parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static AppEngineHttpTarget parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AppEngineHttpTarget parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static AppEngineHttpTarget parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AppEngineHttpTarget parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AppEngineHttpTarget parseFrom(CodedInputStream input)
public static AppEngineHttpTarget parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static AppEngineHttpTarget parseFrom(InputStream input)
public static AppEngineHttpTarget parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static AppEngineHttpTarget parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AppEngineHttpTarget parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<AppEngineHttpTarget> parser()
Methods
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, 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;
| Parameter |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getAppEngineRouting()
public AppEngineRouting getAppEngineRouting()
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;
getBody()
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.
bytes body = 5;
getDefaultInstanceForType()
public AppEngineHttpTarget getDefaultInstanceForType()
public Map<String,String> getHeaders()
public int getHeadersCount()
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, 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;
| Returns |
|---|
| Type | Description |
int | |
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, 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 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, 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 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, 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;
| Parameter |
|---|
| Name | Description |
key | String
|
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;
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;
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for httpMethod.
|
getParserForType()
public Parser<AppEngineHttpTarget> getParserForType()
Overrides
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;
| Returns |
|---|
| Type | Description |
String | The relativeUri.
|
getRelativeUriBytes()
public 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;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for relativeUri.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
hasAppEngineRouting()
public boolean hasAppEngineRouting()
App Engine Routing setting for the job.
.google.cloud.scheduler.v1.AppEngineRouting app_engine_routing = 2;
| Returns |
|---|
| Type | Description |
boolean | Whether the appEngineRouting field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public AppEngineHttpTarget.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AppEngineHttpTarget.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public AppEngineHttpTarget.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
