Package com.google.cloud.tasks.v2

Interface HttpRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    HttpRequest, HttpRequest.Builder
    public interface HttpRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getUrl

        String getUrl()
         Required. The full url path that the request will be sent to.

 This string must begin with either "http://" or "https://". Some examples
 are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will
 encode some characters for safety and compatibility. The maximum allowed
 URL length is 2083 characters after encoding.

 The `Location` header response from a redirect response [`300` - `399`]
 may be followed. The redirect is not counted as a separate attempt.
        string url = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The url.

      • getUrlBytes

        com.google.protobuf.ByteString getUrlBytes()
         Required. The full url path that the request will be sent to.

 This string must begin with either "http://" or "https://". Some examples
 are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks will
 encode some characters for safety and compatibility. The maximum allowed
 URL length is 2083 characters after encoding.

 The `Location` header response from a redirect response [`300` - `399`]
 may be followed. The redirect is not counted as a separate attempt.
        string url = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The bytes for url.

      • getHttpMethodValue

        int getHttpMethodValue()
         The HTTP method to use for the request. The default is POST.
        .google.cloud.tasks.v2.HttpMethod http_method = 2;
        Returns:
        The enum numeric value on the wire for httpMethod.

      • getHttpMethod

        HttpMethod getHttpMethod()
         The HTTP method to use for the request. The default is POST.
        .google.cloud.tasks.v2.HttpMethod http_method = 2;
        Returns:
        The httpMethod.

      • getHeadersCount

        int getHeadersCount()
         HTTP request headers.

 This map contains the header field names and values.
 Headers can be set when the
 [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].

 These headers represent a subset of the headers that will accompany the
 task's HTTP request. Some HTTP request headers will be ignored or replaced.

 A partial list of headers that will be ignored or replaced is:

 * Host: This will be computed by Cloud Tasks and derived from
   [HttpRequest.url][google.cloud.tasks.v2.HttpRequest.url].
 * Content-Length: This will be computed by Cloud Tasks.
 * User-Agent: This will be set to `"Google-Cloud-Tasks"`.
 * `X-Google-*`: Google use only.
 * `X-AppEngine-*`: Google use only.

 `Content-Type` won't be set by Cloud Tasks. You can explicitly set
 `Content-Type` to a media type when the
  [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
  For example, `Content-Type` can be set to `"application/octet-stream"` or
  `"application/json"`.

 Headers which can have multiple values (according to RFC2616) can be
 specified using comma-separated values.

 The size of the 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.
 Headers can be set when the
 [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].

 These headers represent a subset of the headers that will accompany the
 task's HTTP request. Some HTTP request headers will be ignored or replaced.

 A partial list of headers that will be ignored or replaced is:

 * Host: This will be computed by Cloud Tasks and derived from
   [HttpRequest.url][google.cloud.tasks.v2.HttpRequest.url].
 * Content-Length: This will be computed by Cloud Tasks.
 * User-Agent: This will be set to `"Google-Cloud-Tasks"`.
 * `X-Google-*`: Google use only.
 * `X-AppEngine-*`: Google use only.

 `Content-Type` won't be set by Cloud Tasks. You can explicitly set
 `Content-Type` to a media type when the
  [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
  For example, `Content-Type` can be set to `"application/octet-stream"` or
  `"application/json"`.

 Headers which can have multiple values (according to RFC2616) can be
 specified using comma-separated values.

 The size of the headers must be less than 80KB.
        map<string, string> headers = 3;

      • getHeadersMap

        Map<String,​String> getHeadersMap()
         HTTP request headers.

 This map contains the header field names and values.
 Headers can be set when the
 [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].

 These headers represent a subset of the headers that will accompany the
 task's HTTP request. Some HTTP request headers will be ignored or replaced.

 A partial list of headers that will be ignored or replaced is:

 * Host: This will be computed by Cloud Tasks and derived from
   [HttpRequest.url][google.cloud.tasks.v2.HttpRequest.url].
 * Content-Length: This will be computed by Cloud Tasks.
 * User-Agent: This will be set to `"Google-Cloud-Tasks"`.
 * `X-Google-*`: Google use only.
 * `X-AppEngine-*`: Google use only.

 `Content-Type` won't be set by Cloud Tasks. You can explicitly set
 `Content-Type` to a media type when the
  [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
  For example, `Content-Type` can be set to `"application/octet-stream"` or
  `"application/json"`.

 Headers which can have multiple values (according to RFC2616) can be
 specified using comma-separated values.

 The size of the 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.
 Headers can be set when the
 [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].

 These headers represent a subset of the headers that will accompany the
 task's HTTP request. Some HTTP request headers will be ignored or replaced.

 A partial list of headers that will be ignored or replaced is:

 * Host: This will be computed by Cloud Tasks and derived from
   [HttpRequest.url][google.cloud.tasks.v2.HttpRequest.url].
 * Content-Length: This will be computed by Cloud Tasks.
 * User-Agent: This will be set to `"Google-Cloud-Tasks"`.
 * `X-Google-*`: Google use only.
 * `X-AppEngine-*`: Google use only.

 `Content-Type` won't be set by Cloud Tasks. You can explicitly set
 `Content-Type` to a media type when the
  [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
  For example, `Content-Type` can be set to `"application/octet-stream"` or
  `"application/json"`.

 Headers which can have multiple values (according to RFC2616) can be
 specified using comma-separated values.

 The size of the 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.
 Headers can be set when the
 [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].

 These headers represent a subset of the headers that will accompany the
 task's HTTP request. Some HTTP request headers will be ignored or replaced.

 A partial list of headers that will be ignored or replaced is:

 * Host: This will be computed by Cloud Tasks and derived from
   [HttpRequest.url][google.cloud.tasks.v2.HttpRequest.url].
 * Content-Length: This will be computed by Cloud Tasks.
 * User-Agent: This will be set to `"Google-Cloud-Tasks"`.
 * `X-Google-*`: Google use only.
 * `X-AppEngine-*`: Google use only.

 `Content-Type` won't be set by Cloud Tasks. You can explicitly set
 `Content-Type` to a media type when the
  [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
  For example, `Content-Type` can be set to `"application/octet-stream"` or
  `"application/json"`.

 Headers which can have multiple values (according to RFC2616) can be
 specified using comma-separated values.

 The size of the 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][google.cloud.tasks.v2.HttpRequest.http_method] is POST, PUT,
 or PATCH. It is an error to set body on a task with an incompatible
 [HttpMethod][google.cloud.tasks.v2.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.tasks.v2.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.tasks.v2.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.tasks.v2.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.tasks.v2.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.tasks.v2.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.tasks.v2.OidcToken oidc_token = 6;