google.cloud.tasks.v2.AppEngineHttpRequest */ class AppEngineHttpRequest extends \Google\Protobuf\Internal\Message { /** * The HTTP method to use for the request. The default is POST. * The app's request handler for the task's target URL must be able to handle * HTTP requests with this http_method, otherwise the task attempt will fail * with error code 405 (Method Not Allowed). See * [Writing a push task request * handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler) * and the documentation for the request handlers in the language your app is * written in e.g. * [Python Request * Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass). * * Generated from protobuf field .google.cloud.tasks.v2.HttpMethod http_method = 1; */ private $http_method = 0; /** * Task-level setting for App Engine routing. * * If [app_engine_routing_override is set on the * queue][Queue.app_engine_routing_override], this value is used for all * tasks in the queue, no matter what the setting is for the [task-level * app_engine_routing][AppEngineHttpRequest.app_engine_routing]. * * Generated from protobuf field .google.cloud.tasks.v2.AppEngineRouting app_engine_routing = 2; */ private $app_engine_routing = null; /** * The relative URI. * The relative URI must begin with "/" and must be a valid HTTP relative URI. * It can contain a path and query string arguments. * If the relative URI is empty, then the root path "/" will be used. * No spaces are allowed, and the maximum length allowed is 2083 characters. * * Generated from protobuf field string relative_uri = 3; */ private $relative_uri = ''; /** * HTTP request headers. * This map contains the header field names and values. * Headers can be set when the * [task is created][google.cloud.tasks.v2.CloudTasks.CreateTask]. * Repeated headers are not supported but a header value can contain commas. * Cloud Tasks 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 Tasks will append * `"AppEngine-Google; (+http://code.google.com/appengine)"` to the * modified `User-Agent`. * If the task has a [body][google.cloud.tasks.v2.AppEngineHttpRequest.body], Cloud * Tasks sets the following headers: * * `Content-Type`: By default, the `Content-Type` header is set to * `"application/octet-stream"`. The default can be overridden by explicitly * setting `Content-Type` to a particular media type when the * [task is created][google.cloud.tasks.v2.CloudTasks.CreateTask]. * For example, `Content-Type` can be set to `"application/json"`. * * `Content-Length`: This is computed by Cloud Tasks. This value is * output only. It cannot be changed. * The headers below cannot be set or overridden: * * `Host` * * `X-Google-*` * * `X-AppEngine-*` * In addition, Cloud Tasks sets some headers when the task is dispatched, * such as headers containing information about the task; see * [request * headers](https://cloud.google.com/tasks/docs/creating-appengine-handlers#reading_request_headers). * These headers are set only when the task is dispatched, so they are not * visible when the task is returned in a Cloud Tasks response. * Although there is no specific limit for the maximum number of headers or * the size, there is a limit on the maximum size of the [Task][google.cloud.tasks.v2.Task]. For more * information, see the [CreateTask][google.cloud.tasks.v2.CloudTasks.CreateTask] documentation. * * Generated from protobuf field map headers = 4; */ private $headers; /** * HTTP request body. * A request body is allowed only if the HTTP method is POST or PUT. It is * an error to set a body on a task with an incompatible [HttpMethod][google.cloud.tasks.v2.HttpMethod]. * * Generated from protobuf field bytes body = 5; */ private $body = ''; /** * Constructor. * * @param array $data { * Optional. Data for populating the Message object. * * @type int $http_method * The HTTP method to use for the request. The default is POST. * The app's request handler for the task's target URL must be able to handle * HTTP requests with this http_method, otherwise the task attempt will fail * with error code 405 (Method Not Allowed). See * [Writing a push task request * handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler) * and the documentation for the request handlers in the language your app is * written in e.g. * [Python Request * Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass). * @type \Google\Cloud\Tasks\V2\AppEngineRouting $app_engine_routing * Task-level setting for App Engine routing. * * If [app_engine_routing_override is set on the * queue][Queue.app_engine_routing_override], this value is used for all * tasks in the queue, no matter what the setting is for the [task-level * app_engine_routing][AppEngineHttpRequest.app_engine_routing]. * @type string $relative_uri * The relative URI. * The relative URI must begin with "/" and must be a valid HTTP relative URI. * It can contain a path and query string arguments. * If the relative URI is empty, then the root path "/" will be used. * No spaces are allowed, and the maximum length allowed is 2083 characters. * @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.v2.CloudTasks.CreateTask]. * Repeated headers are not supported but a header value can contain commas. * Cloud Tasks 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 Tasks will append * `"AppEngine-Google; (+http://code.google.com/appengine)"` to the * modified `User-Agent`. * If the task has a [body][google.cloud.tasks.v2.AppEngineHttpRequest.body], Cloud * Tasks sets the following headers: * * `Content-Type`: By default, the `Content-Type` header is set to * `"application/octet-stream"`. The default can be overridden by explicitly * setting `Content-Type` to a particular media type when the * [task is created][google.cloud.tasks.v2.CloudTasks.CreateTask]. * For example, `Content-Type` can be set to `"application/json"`. * * `Content-Length`: This is computed by Cloud Tasks. This value is * output only. It cannot be changed. * The headers below cannot be set or overridden: * * `Host` * * `X-Google-*` * * `X-AppEngine-*` * In addition, Cloud Tasks sets some headers when the task is dispatched, * such as headers containing information about the task; see * [request * headers](https://cloud.google.com/tasks/docs/creating-appengine-handlers#reading_request_headers). * These headers are set only when the task is dispatched, so they are not * visible when the task is returned in a Cloud Tasks response. * Although there is no specific limit for the maximum number of headers or * the size, there is a limit on the maximum size of the [Task][google.cloud.tasks.v2.Task]. For more * information, see the [CreateTask][google.cloud.tasks.v2.CloudTasks.CreateTask] documentation. * @type string $body * HTTP request body. * A request body is allowed only if the HTTP method is POST or PUT. It is * an error to set a body on a task with an incompatible [HttpMethod][google.cloud.tasks.v2.HttpMethod]. * } */ public function __construct($data = NULL) { \GPBMetadata\Google\Cloud\Tasks\V2\Target::initOnce(); parent::__construct($data); } /** * The HTTP method to use for the request. The default is POST. * The app's request handler for the task's target URL must be able to handle * HTTP requests with this http_method, otherwise the task attempt will fail * with error code 405 (Method Not Allowed). See * [Writing a push task request * handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler) * and the documentation for the request handlers in the language your app is * written in e.g. * [Python Request * Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass). * * Generated from protobuf field .google.cloud.tasks.v2.HttpMethod http_method = 1; * @return int */ public function getHttpMethod() { return $this->http_method; } /** * The HTTP method to use for the request. The default is POST. * The app's request handler for the task's target URL must be able to handle * HTTP requests with this http_method, otherwise the task attempt will fail * with error code 405 (Method Not Allowed). See * [Writing a push task request * handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler) * and the documentation for the request handlers in the language your app is * written in e.g. * [Python Request * Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass). * * Generated from protobuf field .google.cloud.tasks.v2.HttpMethod http_method = 1; * @param int $var * @return $this */ public function setHttpMethod($var) { GPBUtil::checkEnum($var, \Google\Cloud\Tasks\V2\HttpMethod::class); $this->http_method = $var; return $this; } /** * Task-level setting for App Engine routing. * * If [app_engine_routing_override is set on the * queue][Queue.app_engine_routing_override], this value is used for all * tasks in the queue, no matter what the setting is for the [task-level * app_engine_routing][AppEngineHttpRequest.app_engine_routing]. * * Generated from protobuf field .google.cloud.tasks.v2.AppEngineRouting app_engine_routing = 2; * @return \Google\Cloud\Tasks\V2\AppEngineRouting|null */ public function getAppEngineRouting() { return $this->app_engine_routing; } public function hasAppEngineRouting() { return isset($this->app_engine_routing); } public function clearAppEngineRouting() { unset($this->app_engine_routing); } /** * Task-level setting for App Engine routing. * * If [app_engine_routing_override is set on the * queue][Queue.app_engine_routing_override], this value is used for all * tasks in the queue, no matter what the setting is for the [task-level * app_engine_routing][AppEngineHttpRequest.app_engine_routing]. * * Generated from protobuf field .google.cloud.tasks.v2.AppEngineRouting app_engine_routing = 2; * @param \Google\Cloud\Tasks\V2\AppEngineRouting $var * @return $this */ public function setAppEngineRouting($var) { GPBUtil::checkMessage($var, \Google\Cloud\Tasks\V2\AppEngineRouting::class); $this->app_engine_routing = $var; return $this; } /** * The relative URI. * The relative URI must begin with "/" and must be a valid HTTP relative URI. * It can contain a path and query string arguments. * If the relative URI is empty, then the root path "/" will be used. * No spaces are allowed, and the maximum length allowed is 2083 characters. * * Generated from protobuf field string relative_uri = 3; * @return string */ public function getRelativeUri() { return $this->relative_uri; } /** * The relative URI. * The relative URI must begin with "/" and must be a valid HTTP relative URI. * It can contain a path and query string arguments. * If the relative URI is empty, then the root path "/" will be used. * No spaces are allowed, and the maximum length allowed is 2083 characters. * * Generated from protobuf field string relative_uri = 3; * @param string $var * @return $this */ public function setRelativeUri($var) { GPBUtil::checkString($var, True); $this->relative_uri = $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.v2.CloudTasks.CreateTask]. * Repeated headers are not supported but a header value can contain commas. * Cloud Tasks 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 Tasks will append * `"AppEngine-Google; (+http://code.google.com/appengine)"` to the * modified `User-Agent`. * If the task has a [body][google.cloud.tasks.v2.AppEngineHttpRequest.body], Cloud * Tasks sets the following headers: * * `Content-Type`: By default, the `Content-Type` header is set to * `"application/octet-stream"`. The default can be overridden by explicitly * setting `Content-Type` to a particular media type when the * [task is created][google.cloud.tasks.v2.CloudTasks.CreateTask]. * For example, `Content-Type` can be set to `"application/json"`. * * `Content-Length`: This is computed by Cloud Tasks. This value is * output only. It cannot be changed. * The headers below cannot be set or overridden: * * `Host` * * `X-Google-*` * * `X-AppEngine-*` * In addition, Cloud Tasks sets some headers when the task is dispatched, * such as headers containing information about the task; see * [request * headers](https://cloud.google.com/tasks/docs/creating-appengine-handlers#reading_request_headers). * These headers are set only when the task is dispatched, so they are not * visible when the task is returned in a Cloud Tasks response. * Although there is no specific limit for the maximum number of headers or * the size, there is a limit on the maximum size of the [Task][google.cloud.tasks.v2.Task]. For more * information, see the [CreateTask][google.cloud.tasks.v2.CloudTasks.CreateTask] documentation. * * Generated from protobuf field map headers = 4; * @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.v2.CloudTasks.CreateTask]. * Repeated headers are not supported but a header value can contain commas. * Cloud Tasks 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 Tasks will append * `"AppEngine-Google; (+http://code.google.com/appengine)"` to the * modified `User-Agent`. * If the task has a [body][google.cloud.tasks.v2.AppEngineHttpRequest.body], Cloud * Tasks sets the following headers: * * `Content-Type`: By default, the `Content-Type` header is set to * `"application/octet-stream"`. The default can be overridden by explicitly * setting `Content-Type` to a particular media type when the * [task is created][google.cloud.tasks.v2.CloudTasks.CreateTask]. * For example, `Content-Type` can be set to `"application/json"`. * * `Content-Length`: This is computed by Cloud Tasks. This value is * output only. It cannot be changed. * The headers below cannot be set or overridden: * * `Host` * * `X-Google-*` * * `X-AppEngine-*` * In addition, Cloud Tasks sets some headers when the task is dispatched, * such as headers containing information about the task; see * [request * headers](https://cloud.google.com/tasks/docs/creating-appengine-handlers#reading_request_headers). * These headers are set only when the task is dispatched, so they are not * visible when the task is returned in a Cloud Tasks response. * Although there is no specific limit for the maximum number of headers or * the size, there is a limit on the maximum size of the [Task][google.cloud.tasks.v2.Task]. For more * information, see the [CreateTask][google.cloud.tasks.v2.CloudTasks.CreateTask] documentation. * * Generated from protobuf field map headers = 4; * @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 is POST or PUT. It is * an error to set a body on a task with an incompatible [HttpMethod][google.cloud.tasks.v2.HttpMethod]. * * Generated from protobuf field bytes body = 5; * @return string */ public function getBody() { return $this->body; } /** * HTTP request body. * A request body is allowed only if the HTTP method is POST or PUT. It is * an error to set a body on a task with an incompatible [HttpMethod][google.cloud.tasks.v2.HttpMethod]. * * Generated from protobuf field bytes body = 5; * @param string $var * @return $this */ public function setBody($var) { GPBUtil::checkString($var, False); $this->body = $var; return $this; } }