google.cloud.dataproc.v1.ListBatchesRequest */ class ListBatchesRequest extends \Google\Protobuf\Internal\Message { /** * Required. The parent, which owns this collection of batches. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { */ private $parent = ''; /** * Optional. The maximum number of batches to return in each response. * The service may return fewer than this value. * The default page size is 20; the maximum page size is 1000. * * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; */ private $page_size = 0; /** * Optional. A page token received from a previous `ListBatches` call. * Provide this token to retrieve the subsequent page. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; */ private $page_token = ''; /** * Optional. A filter for the batches to return in the response. * A filter is a logical expression constraining the values of various fields * in each batch resource. Filters are case sensitive, and may contain * multiple clauses combined with logical operators (AND/OR). * Supported fields are `batch_id`, `batch_uuid`, `state`, and `create_time`. * e.g. `state = RUNNING and create_time < "2023-01-01T00:00:00Z"` * filters for batches in state RUNNING that were created before 2023-01-01 * See https://google.aip.dev/assets/misc/ebnf-filtering.txt for a detailed * description of the filter syntax and a list of supported comparisons. * * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; */ private $filter = ''; /** * Optional. Field(s) on which to sort the list of batches. * Currently the only supported sort orders are unspecified (empty) and * `create_time desc` to sort by most recently created batches first. * See https://google.aip.dev/132#ordering for more details. * * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; */ private $order_by = ''; /** * Constructor. * * @param array $data { * Optional. Data for populating the Message object. * * @type string $parent * Required. The parent, which owns this collection of batches. * @type int $page_size * Optional. The maximum number of batches to return in each response. * The service may return fewer than this value. * The default page size is 20; the maximum page size is 1000. * @type string $page_token * Optional. A page token received from a previous `ListBatches` call. * Provide this token to retrieve the subsequent page. * @type string $filter * Optional. A filter for the batches to return in the response. * A filter is a logical expression constraining the values of various fields * in each batch resource. Filters are case sensitive, and may contain * multiple clauses combined with logical operators (AND/OR). * Supported fields are `batch_id`, `batch_uuid`, `state`, and `create_time`. * e.g. `state = RUNNING and create_time < "2023-01-01T00:00:00Z"` * filters for batches in state RUNNING that were created before 2023-01-01 * See https://google.aip.dev/assets/misc/ebnf-filtering.txt for a detailed * description of the filter syntax and a list of supported comparisons. * @type string $order_by * Optional. Field(s) on which to sort the list of batches. * Currently the only supported sort orders are unspecified (empty) and * `create_time desc` to sort by most recently created batches first. * See https://google.aip.dev/132#ordering for more details. * } */ public function __construct($data = NULL) { \GPBMetadata\Google\Cloud\Dataproc\V1\Batches::initOnce(); parent::__construct($data); } /** * Required. The parent, which owns this collection of batches. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @return string */ public function getParent() { return $this->parent; } /** * Required. The parent, which owns this collection of batches. * * Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { * @param string $var * @return $this */ public function setParent($var) { GPBUtil::checkString($var, True); $this->parent = $var; return $this; } /** * Optional. The maximum number of batches to return in each response. * The service may return fewer than this value. * The default page size is 20; the maximum page size is 1000. * * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return int */ public function getPageSize() { return $this->page_size; } /** * Optional. The maximum number of batches to return in each response. * The service may return fewer than this value. * The default page size is 20; the maximum page size is 1000. * * Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var * @return $this */ public function setPageSize($var) { GPBUtil::checkInt32($var); $this->page_size = $var; return $this; } /** * Optional. A page token received from a previous `ListBatches` call. * Provide this token to retrieve the subsequent page. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getPageToken() { return $this->page_token; } /** * Optional. A page token received from a previous `ListBatches` call. * Provide this token to retrieve the subsequent page. * * Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ public function setPageToken($var) { GPBUtil::checkString($var, True); $this->page_token = $var; return $this; } /** * Optional. A filter for the batches to return in the response. * A filter is a logical expression constraining the values of various fields * in each batch resource. Filters are case sensitive, and may contain * multiple clauses combined with logical operators (AND/OR). * Supported fields are `batch_id`, `batch_uuid`, `state`, and `create_time`. * e.g. `state = RUNNING and create_time < "2023-01-01T00:00:00Z"` * filters for batches in state RUNNING that were created before 2023-01-01 * See https://google.aip.dev/assets/misc/ebnf-filtering.txt for a detailed * description of the filter syntax and a list of supported comparisons. * * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getFilter() { return $this->filter; } /** * Optional. A filter for the batches to return in the response. * A filter is a logical expression constraining the values of various fields * in each batch resource. Filters are case sensitive, and may contain * multiple clauses combined with logical operators (AND/OR). * Supported fields are `batch_id`, `batch_uuid`, `state`, and `create_time`. * e.g. `state = RUNNING and create_time < "2023-01-01T00:00:00Z"` * filters for batches in state RUNNING that were created before 2023-01-01 * See https://google.aip.dev/assets/misc/ebnf-filtering.txt for a detailed * description of the filter syntax and a list of supported comparisons. * * Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ public function setFilter($var) { GPBUtil::checkString($var, True); $this->filter = $var; return $this; } /** * Optional. Field(s) on which to sort the list of batches. * Currently the only supported sort orders are unspecified (empty) and * `create_time desc` to sort by most recently created batches first. * See https://google.aip.dev/132#ordering for more details. * * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; * @return string */ public function getOrderBy() { return $this->order_by; } /** * Optional. Field(s) on which to sort the list of batches. * Currently the only supported sort orders are unspecified (empty) and * `create_time desc` to sort by most recently created batches first. * See https://google.aip.dev/132#ordering for more details. * * Generated from protobuf field string order_by = 5 [(.google.api.field_behavior) = OPTIONAL]; * @param string $var * @return $this */ public function setOrderBy($var) { GPBUtil::checkString($var, True); $this->order_by = $var; return $this; } }