Package com.google.cloud.scheduler.v1

Interface HttpTargetOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsHeaders(String key)
    HTTP request headers.
    HttpTarget.AuthorizationHeaderCase
    getAuthorizationHeaderCase()
     
    com.google.protobuf.ByteString
    getBody()
    HTTP request body.
    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()
    Which HTTP method to use for the request.
    int
    getHttpMethodValue()
    Which HTTP method to use for the request.
    OAuthToken
    getOauthToken()
    If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request.
    OAuthTokenOrBuilder
    getOauthTokenOrBuilder()
    If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request.
    OidcToken
    getOidcToken()
    If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request.
    OidcTokenOrBuilder
    getOidcTokenOrBuilder()
    If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request.
    String
    getUri()
    Required.
    com.google.protobuf.ByteString
    getUriBytes()
    Required.
    boolean
    hasOauthToken()
    If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request.
    boolean
    hasOidcToken()
    If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getUri

      String getUri()
       Required. The full URI path that the request will be sent to. This string
 must begin with either "http://" or "https://". Some examples of
 valid values for [uri][google.cloud.scheduler.v1.HttpTarget.uri] are:
 `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will
 encode some characters for safety and compatibility. The maximum allowed
 URL length is 2083 characters after encoding.
      string uri = 1;
      Returns:
      The uri.

    • getUriBytes

      com.google.protobuf.ByteString getUriBytes()
       Required. The full URI path that the request will be sent to. This string
 must begin with either "http://" or "https://". Some examples of
 valid values for [uri][google.cloud.scheduler.v1.HttpTarget.uri] are:
 `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will
 encode some characters for safety and compatibility. The maximum allowed
 URL length is 2083 characters after encoding.
      string uri = 1;
      Returns:
      The bytes for uri.

    • getHttpMethodValue

      int getHttpMethodValue()
       Which HTTP method to use for the request.
      .google.cloud.scheduler.v1.HttpMethod http_method = 2;
      Returns:
      The enum numeric value on the wire for httpMethod.

    • getHttpMethod

      HttpMethod getHttpMethod()
       Which HTTP method to use for the request.
      .google.cloud.scheduler.v1.HttpMethod http_method = 2;
      Returns:
      The httpMethod.

    • getHeadersCount

      int getHeadersCount()
       HTTP request headers.

 This map contains the header field names and values.

 The user can specify HTTP request headers to send with the job's
 HTTP request. Repeated headers are not supported, but a header value can
 contain commas.

 The following headers represent a subset of the headers
 that accompany the job's HTTP request. Some HTTP request
 headers are ignored or replaced. A partial list of headers that
 are ignored or replaced is below:

 * Host: This will be computed by Cloud Scheduler and derived from
 [uri][google.cloud.scheduler.v1.HttpTarget.uri].
 * `Content-Length`: This will be computed by Cloud Scheduler.
 * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`.
 * `X-Google-*`: Google internal use only.
 * `X-AppEngine-*`: Google internal use only.
 * `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.HttpTarget.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 total size of headers must be less than 80KB.
      map<string, string> headers = 3;

    • containsHeaders

      boolean containsHeaders(String key)
       HTTP request headers.

 This map contains the header field names and values.

 The user can specify HTTP request headers to send with the job's
 HTTP request. Repeated headers are not supported, but a header value can
 contain commas.

 The following headers represent a subset of the headers
 that accompany the job's HTTP request. Some HTTP request
 headers are ignored or replaced. A partial list of headers that
 are ignored or replaced is below:

 * Host: This will be computed by Cloud Scheduler and derived from
 [uri][google.cloud.scheduler.v1.HttpTarget.uri].
 * `Content-Length`: This will be computed by Cloud Scheduler.
 * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`.
 * `X-Google-*`: Google internal use only.
 * `X-AppEngine-*`: Google internal use only.
 * `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.HttpTarget.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 total size of headers must be less than 80KB.
      map<string, string> headers = 3;

    • 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.

 The user can specify HTTP request headers to send with the job's
 HTTP request. Repeated headers are not supported, but a header value can
 contain commas.

 The following headers represent a subset of the headers
 that accompany the job's HTTP request. Some HTTP request
 headers are ignored or replaced. A partial list of headers that
 are ignored or replaced is below:

 * Host: This will be computed by Cloud Scheduler and derived from
 [uri][google.cloud.scheduler.v1.HttpTarget.uri].
 * `Content-Length`: This will be computed by Cloud Scheduler.
 * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`.
 * `X-Google-*`: Google internal use only.
 * `X-AppEngine-*`: Google internal use only.
 * `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.HttpTarget.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 total size of headers must be less than 80KB.
      map<string, string> headers = 3;

    • getHeadersOrDefault

      String getHeadersOrDefault(String key, String defaultValue)
       HTTP request headers.

 This map contains the header field names and values.

 The user can specify HTTP request headers to send with the job's
 HTTP request. Repeated headers are not supported, but a header value can
 contain commas.

 The following headers represent a subset of the headers
 that accompany the job's HTTP request. Some HTTP request
 headers are ignored or replaced. A partial list of headers that
 are ignored or replaced is below:

 * Host: This will be computed by Cloud Scheduler and derived from
 [uri][google.cloud.scheduler.v1.HttpTarget.uri].
 * `Content-Length`: This will be computed by Cloud Scheduler.
 * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`.
 * `X-Google-*`: Google internal use only.
 * `X-AppEngine-*`: Google internal use only.
 * `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.HttpTarget.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 total size of headers must be less than 80KB.
      map<string, string> headers = 3;

    • getHeadersOrThrow

      String getHeadersOrThrow(String key)
       HTTP request headers.

 This map contains the header field names and values.

 The user can specify HTTP request headers to send with the job's
 HTTP request. Repeated headers are not supported, but a header value can
 contain commas.

 The following headers represent a subset of the headers
 that accompany the job's HTTP request. Some HTTP request
 headers are ignored or replaced. A partial list of headers that
 are ignored or replaced is below:

 * Host: This will be computed by Cloud Scheduler and derived from
 [uri][google.cloud.scheduler.v1.HttpTarget.uri].
 * `Content-Length`: This will be computed by Cloud Scheduler.
 * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`.
 * `X-Google-*`: Google internal use only.
 * `X-AppEngine-*`: Google internal use only.
 * `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.HttpTarget.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 total size of headers must be less than 80KB.
      map<string, string> headers = 3;

    • getBody

      com.google.protobuf.ByteString getBody()
       HTTP request body. A request body is allowed only if the HTTP
 method is POST, PUT, or PATCH. It is an error to set body on a job with an
 incompatible [HttpMethod][google.cloud.scheduler.v1.HttpMethod].
      bytes body = 4;
      Returns:
      The body.

    • hasOauthToken

      boolean hasOauthToken()
       If specified, an
 [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
 will be generated and attached as an `Authorization` header in the HTTP
 request.

 This type of authorization should generally only be used when calling
 Google APIs hosted on *.googleapis.com.
      .google.cloud.scheduler.v1.OAuthToken oauth_token = 5;
      Returns:
      Whether the oauthToken field is set.

    • getOauthToken

      OAuthToken getOauthToken()
       If specified, an
 [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
 will be generated and attached as an `Authorization` header in the HTTP
 request.

 This type of authorization should generally only be used when calling
 Google APIs hosted on *.googleapis.com.
      .google.cloud.scheduler.v1.OAuthToken oauth_token = 5;
      Returns:
      The oauthToken.

    • getOauthTokenOrBuilder

      OAuthTokenOrBuilder getOauthTokenOrBuilder()
       If specified, an
 [OAuth token](https://developers.google.com/identity/protocols/OAuth2)
 will be generated and attached as an `Authorization` header in the HTTP
 request.

 This type of authorization should generally only be used when calling
 Google APIs hosted on *.googleapis.com.
      .google.cloud.scheduler.v1.OAuthToken oauth_token = 5;

    • hasOidcToken

      boolean hasOidcToken()
       If specified, an
 [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)
 token will be generated and attached as an `Authorization` header in the
 HTTP request.

 This type of authorization can be used for many scenarios, including
 calling Cloud Run, or endpoints where you intend to validate the token
 yourself.
      .google.cloud.scheduler.v1.OidcToken oidc_token = 6;
      Returns:
      Whether the oidcToken field is set.

    • getOidcToken

      OidcToken getOidcToken()
       If specified, an
 [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)
 token will be generated and attached as an `Authorization` header in the
 HTTP request.

 This type of authorization can be used for many scenarios, including
 calling Cloud Run, or endpoints where you intend to validate the token
 yourself.
      .google.cloud.scheduler.v1.OidcToken oidc_token = 6;
      Returns:
      The oidcToken.

    • getOidcTokenOrBuilder

      OidcTokenOrBuilder getOidcTokenOrBuilder()
       If specified, an
 [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)
 token will be generated and attached as an `Authorization` header in the
 HTTP request.

 This type of authorization can be used for many scenarios, including
 calling Cloud Run, or endpoints where you intend to validate the token
 yourself.
      .google.cloud.scheduler.v1.OidcToken oidc_token = 6;

    • getAuthorizationHeaderCase

      HttpTarget.AuthorizationHeaderCase getAuthorizationHeaderCase()