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

namespace Google\Cloud\Dataform\V1beta1;

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

/**
 * `ListWorkspaces` request message.
 *
 * Generated from protobuf message <code>google.cloud.dataform.v1beta1.ListWorkspacesRequest</code>
 */
class ListWorkspacesRequest extends \Google\Protobuf\Internal\Message
{
    /**
     * Required. The repository in which to list workspaces. Must be in the
     * format `projects/&#42;&#47;locations/&#42;&#47;repositories/&#42;`.
     *
     * Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
     */
    private $parent = '';
    /**
     * Optional. Maximum number of workspaces to return. The server may return fewer
     * items than requested. If unspecified, the server will pick an appropriate
     * default.
     *
     * Generated from protobuf field <code>int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    private $page_size = 0;
    /**
     * Optional. Page token received from a previous `ListWorkspaces` call.
     * Provide this to retrieve the subsequent page.
     * When paginating, all other parameters provided to `ListWorkspaces`
     * must match the call that provided the page token.
     *
     * Generated from protobuf field <code>string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    private $page_token = '';
    /**
     * Optional. This field only supports ordering by `name`. If unspecified, the server
     * will choose the ordering. If specified, the default order is ascending for
     * the `name` field.
     *
     * Generated from protobuf field <code>string order_by = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    private $order_by = '';
    /**
     * Optional. Filter for the returned list.
     *
     * Generated from protobuf field <code>string filter = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    private $filter = '';

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type string $parent
     *           Required. The repository in which to list workspaces. Must be in the
     *           format `projects/&#42;&#47;locations/&#42;&#47;repositories/&#42;`.
     *     @type int $page_size
     *           Optional. Maximum number of workspaces to return. The server may return fewer
     *           items than requested. If unspecified, the server will pick an appropriate
     *           default.
     *     @type string $page_token
     *           Optional. Page token received from a previous `ListWorkspaces` call.
     *           Provide this to retrieve the subsequent page.
     *           When paginating, all other parameters provided to `ListWorkspaces`
     *           must match the call that provided the page token.
     *     @type string $order_by
     *           Optional. This field only supports ordering by `name`. If unspecified, the server
     *           will choose the ordering. If specified, the default order is ascending for
     *           the `name` field.
     *     @type string $filter
     *           Optional. Filter for the returned list.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Cloud\Dataform\V1Beta1\Dataform::initOnce();
        parent::__construct($data);
    }

    /**
     * Required. The repository in which to list workspaces. Must be in the
     * format `projects/&#42;&#47;locations/&#42;&#47;repositories/&#42;`.
     *
     * 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. The repository in which to list workspaces. Must be in the
     * format `projects/&#42;&#47;locations/&#42;&#47;repositories/&#42;`.
     *
     * 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 workspaces to return. The server may return fewer
     * items than requested. If unspecified, the server will pick an appropriate
     * default.
     *
     * 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 workspaces to return. The server may return fewer
     * items than requested. If unspecified, the server will pick an appropriate
     * default.
     *
     * 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. Page token received from a previous `ListWorkspaces` call.
     * Provide this to retrieve the subsequent page.
     * When paginating, all other parameters provided to `ListWorkspaces`
     * 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. Page token received from a previous `ListWorkspaces` call.
     * Provide this to retrieve the subsequent page.
     * When paginating, all other parameters provided to `ListWorkspaces`
     * 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. This field only supports ordering by `name`. If unspecified, the server
     * will choose the ordering. If specified, the default order is ascending for
     * the `name` field.
     *
     * Generated from protobuf field <code>string order_by = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return string
     */
    public function getOrderBy()
    {
        return $this->order_by;
    }

    /**
     * Optional. This field only supports ordering by `name`. If unspecified, the server
     * will choose the ordering. If specified, the default order is ascending for
     * the `name` field.
     *
     * Generated from protobuf field <code>string order_by = 4 [(.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;
    }

    /**
     * Optional. Filter for the returned list.
     *
     * Generated from protobuf field <code>string filter = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return string
     */
    public function getFilter()
    {
        return $this->filter;
    }

    /**
     * Optional. Filter for the returned list.
     *
     * Generated from protobuf field <code>string filter = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @param string $var
     * @return $this
     */
    public function setFilter($var)
    {
        GPBUtil::checkString($var, True);
        $this->filter = $var;

        return $this;
    }

}