<?php
# Generated by the protocol buffer compiler.  DO NOT EDIT!
# source: google/cloud/hypercomputecluster/v1beta/hypercompute_cluster.proto

namespace Google\Cloud\HypercomputeCluster\V1beta;

use Google\Protobuf\Internal\GPBType;
use Google\Protobuf\Internal\RepeatedField;
use Google\Protobuf\Internal\GPBUtil;

/**
 * Request message for
 * [ListClusters][google.cloud.hypercomputecluster.v1beta.HypercomputeCluster.ListClusters].
 *
 * Generated from protobuf message <code>google.cloud.hypercomputecluster.v1beta.ListClustersRequest</code>
 */
class ListClustersRequest extends \Google\Protobuf\Internal\Message
{
    /**
     * Required. Parent location of the clusters to list, in the format
     * `projects/{project}/locations/{location}`.
     *
     * Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
     */
    protected $parent = '';
    /**
     * Optional. Maximum number of clusters to return. The service may return
     * fewer than this value.
     *
     * Generated from protobuf field <code>int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $page_size = 0;
    /**
     * Optional. A page token received from a previous `ListClusters` call.
     * Provide this to retrieve the subsequent page. When paginating, all other
     * parameters provided to `ListClusters` must match the call that provided the
     * page token.
     *
     * Generated from protobuf field <code>string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $page_token = '';
    /**
     * Optional. [Filter](https://google.aip.dev/160) to apply to the returned
     * results.
     *
     * Generated from protobuf field <code>string filter = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $filter = '';
    /**
     * Optional. How to order the resulting clusters. Must be one of the following
     * strings:
     * * `name`
     * * `name desc`
     * * `create_time`
     * * `create_time desc`
     * If not specified, clusters will be returned in an arbitrary order.
     *
     * Generated from protobuf field <code>string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $order_by = '';

    /**
     * @param string $parent Required. Parent location of the clusters to list, in the format
     *                       `projects/{project}/locations/{location}`. Please see
     *                       {@see HypercomputeClusterClient::locationName()} for help formatting this field.
     *
     * @return \Google\Cloud\HypercomputeCluster\V1beta\ListClustersRequest
     *
     * @experimental
     */
    public static function build(string $parent): self
    {
        return (new self())
            ->setParent($parent);
    }

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type string $parent
     *           Required. Parent location of the clusters to list, in the format
     *           `projects/{project}/locations/{location}`.
     *     @type int $page_size
     *           Optional. Maximum number of clusters to return. The service may return
     *           fewer than this value.
     *     @type string $page_token
     *           Optional. A page token received from a previous `ListClusters` call.
     *           Provide this to retrieve the subsequent page. When paginating, all other
     *           parameters provided to `ListClusters` must match the call that provided the
     *           page token.
     *     @type string $filter
     *           Optional. [Filter](https://google.aip.dev/160) to apply to the returned
     *           results.
     *     @type string $order_by
     *           Optional. How to order the resulting clusters. Must be one of the following
     *           strings:
     *           * `name`
     *           * `name desc`
     *           * `create_time`
     *           * `create_time desc`
     *           If not specified, clusters will be returned in an arbitrary order.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Cloud\Hypercomputecluster\V1Beta\HypercomputeCluster::initOnce();
        parent::__construct($data);
    }

    /**
     * Required. Parent location of the clusters to list, in the format
     * `projects/{project}/locations/{location}`.
     *
     * Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
     * @return string
     */
    public function getParent()
    {
        return $this->parent;
    }

    /**
     * Required. Parent location of the clusters to list, in the format
     * `projects/{project}/locations/{location}`.
     *
     * Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
     * @param string $var
     * @return $this
     */
    public function setParent($var)
    {
        GPBUtil::checkString($var, True);
        $this->parent = $var;

        return $this;
    }

    /**
     * Optional. Maximum number of clusters to return. The service may return
     * fewer than this value.
     *
     * Generated from protobuf field <code>int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return int
     */
    public function getPageSize()
    {
        return $this->page_size;
    }

    /**
     * Optional. Maximum number of clusters to return. The service may return
     * fewer than this value.
     *
     * Generated from protobuf field <code>int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @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 `ListClusters` call.
     * Provide this to retrieve the subsequent page. When paginating, all other
     * parameters provided to `ListClusters` must match the call that provided the
     * page token.
     *
     * Generated from protobuf field <code>string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return string
     */
    public function getPageToken()
    {
        return $this->page_token;
    }

    /**
     * Optional. A page token received from a previous `ListClusters` call.
     * Provide this to retrieve the subsequent page. When paginating, all other
     * parameters provided to `ListClusters` must match the call that provided the
     * page token.
     *
     * Generated from protobuf field <code>string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @param string $var
     * @return $this
     */
    public function setPageToken($var)
    {
        GPBUtil::checkString($var, True);
        $this->page_token = $var;

        return $this;
    }

    /**
     * Optional. [Filter](https://google.aip.dev/160) to apply to the returned
     * results.
     *
     * Generated from protobuf field <code>string filter = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return string
     */
    public function getFilter()
    {
        return $this->filter;
    }

    /**
     * Optional. [Filter](https://google.aip.dev/160) to apply to the returned
     * results.
     *
     * Generated from protobuf field <code>string filter = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @param string $var
     * @return $this
     */
    public function setFilter($var)
    {
        GPBUtil::checkString($var, True);
        $this->filter = $var;

        return $this;
    }

    /**
     * Optional. How to order the resulting clusters. Must be one of the following
     * strings:
     * * `name`
     * * `name desc`
     * * `create_time`
     * * `create_time desc`
     * If not specified, clusters will be returned in an arbitrary order.
     *
     * Generated from protobuf field <code>string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return string
     */
    public function getOrderBy()
    {
        return $this->order_by;
    }

    /**
     * Optional. How to order the resulting clusters. Must be one of the following
     * strings:
     * * `name`
     * * `name desc`
     * * `create_time`
     * * `create_time desc`
     * If not specified, clusters will be returned in an arbitrary order.
     *
     * Generated from protobuf field <code>string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @param string $var
     * @return $this
     */
    public function setOrderBy($var)
    {
        GPBUtil::checkString($var, True);
        $this->order_by = $var;

        return $this;
    }

}

