Package com.google.cloud.scheduler.v1

Interface AppEngineHttpTargetOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
AppEngineHttpTarget, AppEngineHttpTarget.Builder
@Generated public interface AppEngineHttpTargetOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getHttpMethodValue

      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:
      The enum numeric value on the wire for httpMethod.

    • getHttpMethod

      HttpMethod getHttpMethod()
       The HTTP method to use for the request. PATCH and OPTIONS are not
 permitted.
      .google.cloud.scheduler.v1.HttpMethod http_method = 1;
      Returns:
      The httpMethod.

    • hasAppEngineRouting

      boolean hasAppEngineRouting()
       App Engine Routing setting for the job.
      .google.cloud.scheduler.v1.AppEngineRouting app_engine_routing = 2;
      Returns:
      Whether the appEngineRouting field is set.

    • getAppEngineRouting

      AppEngineRouting getAppEngineRouting()
       App Engine Routing setting for the job.
      .google.cloud.scheduler.v1.AppEngineRouting app_engine_routing = 2;
      Returns:
      The appEngineRouting.

    • getAppEngineRoutingOrBuilder

      AppEngineRoutingOrBuilder getAppEngineRoutingOrBuilder()
       App Engine Routing setting for the job.
      .google.cloud.scheduler.v1.AppEngineRouting app_engine_routing = 2;

    • getRelativeUri

      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:
      The relativeUri.

    • getRelativeUriBytes

      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;
      Returns:
      The bytes for relativeUri.

    • getHeadersCount

      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 a [body][google.cloud.scheduler.v1.AppEngineHttpTarget.body]
 and the following headers are not set by the user, Cloud Scheduler sets
 default values:

 * `Content-Type`: This will be set to `"application/octet-stream"`. You
 can override this default by explicitly setting `Content-Type` to a
 particular media type when creating the job. For example, you can set
 `Content-Type` to `"application/json"`.

 The headers below are output only. They cannot be set or overridden:

 * `Content-Length`: This is computed by Cloud Scheduler.
 * `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;

    • containsHeaders

      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 a [body][google.cloud.scheduler.v1.AppEngineHttpTarget.body]
 and the following headers are not set by the user, Cloud Scheduler sets
 default values:

 * `Content-Type`: This will be set to `"application/octet-stream"`. You
 can override this default by explicitly setting `Content-Type` to a
 particular media type when creating the job. For example, you can set
 `Content-Type` to `"application/json"`.

 The headers below are output only. They cannot be set or overridden:

 * `Content-Length`: This is computed by Cloud Scheduler.
 * `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;

    • getHeaders

      @Deprecated Map<String,String> getHeaders()
      Deprecated.
      Use getHeadersMap() instead.

    • getHeadersMap

      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 a [body][google.cloud.scheduler.v1.AppEngineHttpTarget.body]
 and the following headers are not set by the user, Cloud Scheduler sets
 default values:

 * `Content-Type`: This will be set to `"application/octet-stream"`. You
 can override this default by explicitly setting `Content-Type` to a
 particular media type when creating the job. For example, you can set
 `Content-Type` to `"application/json"`.

 The headers below are output only. They cannot be set or overridden:

 * `Content-Length`: This is computed by Cloud Scheduler.
 * `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;

    • getHeadersOrDefault

      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 a [body][google.cloud.scheduler.v1.AppEngineHttpTarget.body]
 and the following headers are not set by the user, Cloud Scheduler sets
 default values:

 * `Content-Type`: This will be set to `"application/octet-stream"`. You
 can override this default by explicitly setting `Content-Type` to a
 particular media type when creating the job. For example, you can set
 `Content-Type` to `"application/json"`.

 The headers below are output only. They cannot be set or overridden:

 * `Content-Length`: This is computed by Cloud Scheduler.
 * `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;

    • getHeadersOrThrow

      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 a [body][google.cloud.scheduler.v1.AppEngineHttpTarget.body]
 and the following headers are not set by the user, Cloud Scheduler sets
 default values:

 * `Content-Type`: This will be set to `"application/octet-stream"`. You
 can override this default by explicitly setting `Content-Type` to a
 particular media type when creating the job. For example, you can set
 `Content-Type` to `"application/json"`.

 The headers below are output only. They cannot be set or overridden:

 * `Content-Length`: This is computed by Cloud Scheduler.
 * `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;

    • getBody

      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;
      Returns:
      The body.