com.google.cloud.scheduler.v1

Class AppEngineHttpTarget

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.scheduler.v1.AppEngineHttpTarget

All Implemented Interfaces:

AppEngineHttpTargetOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class AppEngineHttpTarget
extends com.google.protobuf.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][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 type google.cloud.scheduler.v1.AppEngineHttpTarget

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AppEngineHttpTarget.Builder App Engine target.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	APP_ENGINE_ROUTING_FIELD_NUMBER
static int	BODY_FIELD_NUMBER
static int	HEADERS_FIELD_NUMBER
static int	HTTP_METHOD_FIELD_NUMBER
static int	RELATIVE_URI_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	containsHeaders(String key) HTTP request headers.
boolean	equals(Object obj)
AppEngineRouting	getAppEngineRouting() App Engine Routing setting for the job.
AppEngineRoutingOrBuilder	getAppEngineRoutingOrBuilder() App Engine Routing setting for the job.
com.google.protobuf.ByteString	getBody() Body.
static AppEngineHttpTarget	getDefaultInstance()
AppEngineHttpTarget	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.
com.google.protobuf.Parser<AppEngineHttpTarget>	getParserForType()
String	getRelativeUri() The relative URI.
com.google.protobuf.ByteString	getRelativeUriBytes() The relative URI.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasAppEngineRouting() App Engine Routing setting for the job.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
boolean	isInitialized()
static AppEngineHttpTarget.Builder	newBuilder()
static AppEngineHttpTarget.Builder	newBuilder(AppEngineHttpTarget prototype)
AppEngineHttpTarget.Builder	newBuilderForType()
protected AppEngineHttpTarget.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static AppEngineHttpTarget	parseDelimitedFrom(InputStream input)
static AppEngineHttpTarget	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AppEngineHttpTarget	parseFrom(byte[] data)
static AppEngineHttpTarget	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AppEngineHttpTarget	parseFrom(ByteBuffer data)
static AppEngineHttpTarget	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AppEngineHttpTarget	parseFrom(com.google.protobuf.ByteString data)
static AppEngineHttpTarget	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AppEngineHttpTarget	parseFrom(com.google.protobuf.CodedInputStream input)
static AppEngineHttpTarget	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AppEngineHttpTarget	parseFrom(InputStream input)
static AppEngineHttpTarget	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<AppEngineHttpTarget>	parser()
AppEngineHttpTarget.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, makeExtensionsImmutable, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

HTTP_METHOD_FIELD_NUMBER

public static final int HTTP_METHOD_FIELD_NUMBER

See Also:

Constant Field Values

APP_ENGINE_ROUTING_FIELD_NUMBER

public static final int APP_ENGINE_ROUTING_FIELD_NUMBER

See Also:

Constant Field Values

RELATIVE_URI_FIELD_NUMBER

public static final int RELATIVE_URI_FIELD_NUMBER

See Also:

Constant Field Values

HEADERS_FIELD_NUMBER

public static final int HEADERS_FIELD_NUMBER

See Also:

Constant Field Values

BODY_FIELD_NUMBER

public static final int BODY_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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 interface AppEngineHttpTargetOrBuilder

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 interface AppEngineHttpTargetOrBuilder

hasAppEngineRouting

public boolean hasAppEngineRouting()

 App Engine Routing setting for the job.
 

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

Specified by:

hasAppEngineRouting in interface AppEngineHttpTargetOrBuilder

getAppEngineRouting

public AppEngineRouting getAppEngineRouting()

 App Engine Routing setting for the job.
 

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

Specified by:

getAppEngineRouting in interface AppEngineHttpTargetOrBuilder

getAppEngineRoutingOrBuilder

public AppEngineRoutingOrBuilder getAppEngineRoutingOrBuilder()

 App Engine Routing setting for the job.
 

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

Specified by:

getAppEngineRoutingOrBuilder in interface AppEngineHttpTargetOrBuilder

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 interface AppEngineHttpTargetOrBuilder

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 interface AppEngineHttpTargetOrBuilder

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.
 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 interface AppEngineHttpTargetOrBuilder

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.
 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 interface AppEngineHttpTargetOrBuilder

getHeaders

@Deprecated
public Map<String,String> getHeaders()

Deprecated.

Use getHeadersMap() instead.

Specified by:

getHeaders in interface AppEngineHttpTargetOrBuilder

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.
 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 interface AppEngineHttpTargetOrBuilder

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.
 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 interface AppEngineHttpTargetOrBuilder

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.
 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 interface AppEngineHttpTargetOrBuilder

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 interface AppEngineHttpTargetOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static AppEngineHttpTarget parseFrom(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AppEngineHttpTarget parseFrom(ByteBuffer data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AppEngineHttpTarget parseFrom(com.google.protobuf.ByteString data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AppEngineHttpTarget parseFrom(com.google.protobuf.ByteString data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AppEngineHttpTarget parseFrom(byte[] data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AppEngineHttpTarget parseFrom(byte[] data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AppEngineHttpTarget parseFrom(InputStream input)
                                     throws IOException

Throws:

IOException

parseFrom

public static AppEngineHttpTarget parseFrom(InputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static AppEngineHttpTarget parseDelimitedFrom(InputStream input)
                                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static AppEngineHttpTarget parseDelimitedFrom(InputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws IOException

Throws:

IOException

parseFrom

public static AppEngineHttpTarget parseFrom(com.google.protobuf.CodedInputStream input)
                                     throws IOException

Throws:

IOException

parseFrom

public static AppEngineHttpTarget parseFrom(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Throws:

IOException

newBuilderForType

public AppEngineHttpTarget.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static AppEngineHttpTarget.Builder newBuilder()

newBuilder

public static AppEngineHttpTarget.Builder newBuilder(AppEngineHttpTarget prototype)

toBuilder

public AppEngineHttpTarget.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected AppEngineHttpTarget.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static AppEngineHttpTarget getDefaultInstance()

parser

public static com.google.protobuf.Parser<AppEngineHttpTarget> parser()

getParserForType

public com.google.protobuf.Parser<AppEngineHttpTarget> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public AppEngineHttpTarget getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder