Package com.google.cloud.scheduler.v1

Class 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

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance 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
        Returns:
        The enum numeric value on the wire for httpMethod.

      • 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
        Returns:
        The httpMethod.

      • 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
        Returns:
        Whether the appEngineRouting field is set.

      • 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
        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 interface AppEngineHttpTargetOrBuilder
        Returns:
        The bytes for relativeUri.

      • 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 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.
 * `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 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.
 * `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 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.
 * `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 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.
 * `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 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
        Returns:
        The body.

      • 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​(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

      • 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

      • 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