Class AppEngineHttpTarget (2.44.0)

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.v1beta1.AppEngineHttpTarget

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

HEADERS_FIELD_NUMBER

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()
Returns
Type Description
AppEngineHttpTarget

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static AppEngineHttpTarget.Builder newBuilder()
Returns
Type Description
AppEngineHttpTarget.Builder

newBuilder(AppEngineHttpTarget prototype)

public static AppEngineHttpTarget.Builder newBuilder(AppEngineHttpTarget prototype)
Parameter
Name Description
prototype AppEngineHttpTarget
Returns
Type Description
AppEngineHttpTarget.Builder

parseDelimitedFrom(InputStream input)

public static AppEngineHttpTarget parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AppEngineHttpTarget
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AppEngineHttpTarget parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AppEngineHttpTarget
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AppEngineHttpTarget parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AppEngineHttpTarget
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AppEngineHttpTarget parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AppEngineHttpTarget
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AppEngineHttpTarget parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AppEngineHttpTarget
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AppEngineHttpTarget parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AppEngineHttpTarget
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AppEngineHttpTarget parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AppEngineHttpTarget
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AppEngineHttpTarget parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AppEngineHttpTarget
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AppEngineHttpTarget parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AppEngineHttpTarget
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AppEngineHttpTarget parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AppEngineHttpTarget
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AppEngineHttpTarget parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AppEngineHttpTarget
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AppEngineHttpTarget parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AppEngineHttpTarget
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AppEngineHttpTarget> parser()
Returns
Type Description
Parser<AppEngineHttpTarget>

Methods

containsHeaders(String key)

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 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, 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
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAppEngineRouting()

public AppEngineRouting getAppEngineRouting()

App Engine Routing setting for the job.

.google.cloud.scheduler.v1beta1.AppEngineRouting app_engine_routing = 2;

Returns
Type Description
AppEngineRouting

The appEngineRouting.

getAppEngineRoutingOrBuilder()

public AppEngineRoutingOrBuilder getAppEngineRoutingOrBuilder()

App Engine Routing setting for the job.

.google.cloud.scheduler.v1beta1.AppEngineRouting app_engine_routing = 2;

Returns
Type Description
AppEngineRoutingOrBuilder

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;

Returns
Type Description
ByteString

The body.

getDefaultInstanceForType()

public AppEngineHttpTarget getDefaultInstanceForType()
Returns
Type Description
AppEngineHttpTarget

getHeaders() (deprecated)

public Map<String,String> getHeaders()

Use #getHeadersMap() instead.

Returns
Type Description
Map<String,String>

getHeadersCount()

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 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, 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

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 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, 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
Map<String,String>

getHeadersOrDefault(String key, String defaultValue)

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 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, 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;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getHeadersOrThrow(String key)

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 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, 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
Returns
Type Description
String

getHttpMethod()

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;

Returns
Type Description
HttpMethod

The httpMethod.

getHttpMethodValue()

public int getHttpMethodValue()

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.

getParserForType()

public Parser<AppEngineHttpTarget> getParserForType()
Returns
Type Description
Parser<AppEngineHttpTarget>
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.v1beta1.AppEngineRouting app_engine_routing = 2;

Returns
Type Description
boolean

Whether the appEngineRouting field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AppEngineHttpTarget.Builder newBuilderForType()
Returns
Type Description
AppEngineHttpTarget.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AppEngineHttpTarget.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AppEngineHttpTarget.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AppEngineHttpTarget.Builder toBuilder()
Returns
Type Description
AppEngineHttpTarget.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException