google.cloud.tasks.v2.HttpRequest */ class HttpRequest extends \Google\Protobuf\Internal\Message { /** * 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. * * Generated from protobuf field string url = 1 [(.google.api.field_behavior) = REQUIRED]; */ private $url = ''; /** * The HTTP method to use for the request. The default is POST. * * Generated from protobuf field .google.cloud.tasks.v2.HttpMethod http_method = 2; */ private $http_method = 0; /** * 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. * * Generated from protobuf field map headers = 3; */ private $headers; /** * 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]. * * Generated from protobuf field bytes body = 4; */ private $body = ''; protected $authorization_header; /** * Constructor. * * @param array $data { * Optional. Data for populating the Message object. * * @type string $url * 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. * @type int $http_method * The HTTP method to use for the request. The default is POST. * @type array|\Google\Protobuf\Internal\MapField $headers * 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. * @type string $body * 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]. * @type \Google\Cloud\Tasks\V2\OAuthToken $oauth_token * 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. * @type \Google\Cloud\Tasks\V2\OidcToken $oidc_token * 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. * } */ public function __construct($data = NULL) { \GPBMetadata\Google\Cloud\Tasks\V2\Target::initOnce(); parent::__construct($data); } /** * 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. * * Generated from protobuf field string url = 1 [(.google.api.field_behavior) = REQUIRED]; * @return string */ public function getUrl() { return $this->url; } /** * 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. * * Generated from protobuf field string url = 1 [(.google.api.field_behavior) = REQUIRED]; * @param string $var * @return $this */ public function setUrl($var) { GPBUtil::checkString($var, True); $this->url = $var; return $this; } /** * The HTTP method to use for the request. The default is POST. * * Generated from protobuf field .google.cloud.tasks.v2.HttpMethod http_method = 2; * @return int */ public function getHttpMethod() { return $this->http_method; } /** * The HTTP method to use for the request. The default is POST. * * Generated from protobuf field .google.cloud.tasks.v2.HttpMethod http_method = 2; * @param int $var * @return $this */ public function setHttpMethod($var) { GPBUtil::checkEnum($var, \Google\Cloud\Tasks\V2\HttpMethod::class); $this->http_method = $var; return $this; } /** * 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. * * Generated from protobuf field map headers = 3; * @return \Google\Protobuf\Internal\MapField */ public function getHeaders() { return $this->headers; } /** * 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. * * Generated from protobuf field map headers = 3; * @param array|\Google\Protobuf\Internal\MapField $var * @return $this */ public function setHeaders($var) { $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING); $this->headers = $arr; return $this; } /** * 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]. * * Generated from protobuf field bytes body = 4; * @return string */ public function getBody() { return $this->body; } /** * 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]. * * Generated from protobuf field bytes body = 4; * @param string $var * @return $this */ public function setBody($var) { GPBUtil::checkString($var, False); $this->body = $var; return $this; } /** * 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. * * Generated from protobuf field .google.cloud.tasks.v2.OAuthToken oauth_token = 5; * @return \Google\Cloud\Tasks\V2\OAuthToken|null */ public function getOauthToken() { return $this->readOneof(5); } public function hasOauthToken() { return $this->hasOneof(5); } /** * 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. * * Generated from protobuf field .google.cloud.tasks.v2.OAuthToken oauth_token = 5; * @param \Google\Cloud\Tasks\V2\OAuthToken $var * @return $this */ public function setOauthToken($var) { GPBUtil::checkMessage($var, \Google\Cloud\Tasks\V2\OAuthToken::class); $this->writeOneof(5, $var); return $this; } /** * 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. * * Generated from protobuf field .google.cloud.tasks.v2.OidcToken oidc_token = 6; * @return \Google\Cloud\Tasks\V2\OidcToken|null */ public function getOidcToken() { return $this->readOneof(6); } public function hasOidcToken() { return $this->hasOneof(6); } /** * 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. * * Generated from protobuf field .google.cloud.tasks.v2.OidcToken oidc_token = 6; * @param \Google\Cloud\Tasks\V2\OidcToken $var * @return $this */ public function setOidcToken($var) { GPBUtil::checkMessage($var, \Google\Cloud\Tasks\V2\OidcToken::class); $this->writeOneof(6, $var); return $this; } /** * @return string */ public function getAuthorizationHeader() { return $this->whichOneof("authorization_header"); } }