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

namespace Google\Cloud\AIPlatform\V1;

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

/**
 * Request message for
 * [NotebookService.ListNotebookRuntimes][google.cloud.aiplatform.v1.NotebookService.ListNotebookRuntimes].
 *
 * Generated from protobuf message <code>google.cloud.aiplatform.v1.ListNotebookRuntimesRequest</code>
 */
class ListNotebookRuntimesRequest extends \Google\Protobuf\Internal\Message
{
    /**
     * Required. The resource name of the Location from which to list the
     * NotebookRuntimes.
     * 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. An expression for filtering the results of the request. For field
     * names both snake_case and camelCase are supported.
     *   * `notebookRuntime` supports = and !=. `notebookRuntime` represents the
     *     NotebookRuntime ID,
     *     i.e. the last segment of the NotebookRuntime's [resource name]
     *     [google.cloud.aiplatform.v1.NotebookRuntime.name].
     *   * `displayName` supports = and != and regex.
     *   * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate`
     *     represents the NotebookRuntimeTemplate ID,
     *     i.e. the last segment of the NotebookRuntimeTemplate's [resource name]
     *     [google.cloud.aiplatform.v1.NotebookRuntimeTemplate.name].
     *   * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY,
     *   HEALTH_STATE_UNSPECIFIED].
     *   * `runtimeState` supports = and !=. runtimeState enum:
     *   [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED,
     *   STOPPED, BEING_UPGRADED, ERROR, INVALID].
     *   * `runtimeUser` supports = and !=.
     *   * API version is UI only: `uiState` supports = and !=. uiState enum:
     *   [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED,
     *   UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED,
     *   UI_RESOURCE_STATE_CREATION_FAILED].
     *   * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum:
     *   [USER_DEFINED, ONE_CLICK].
     *   * `machineType` supports = and !=.
     *   * `acceleratorType` supports = and !=.
     * Some examples:
     *   * `notebookRuntime="notebookRuntime123"`
     *   * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"`
     *   * `notebookRuntimeTemplate="notebookRuntimeTemplate321"`
     *   * `healthState=HEALTHY`
     *   * `runtimeState=RUNNING`
     *   * `runtimeUser="test&#64;google.com"`
     *   * `uiState=UI_RESOURCE_STATE_BEING_DELETED`
     *   * `notebookRuntimeType=USER_DEFINED`
     *   * `machineType=e2-standard-4`
     *   * `acceleratorType=NVIDIA_TESLA_T4`
     *
     * Generated from protobuf field <code>string filter = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $filter = '';
    /**
     * Optional. The standard list page size.
     *
     * Generated from protobuf field <code>int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $page_size = 0;
    /**
     * Optional. The standard list page token.
     * Typically obtained via
     * [ListNotebookRuntimesResponse.next_page_token][google.cloud.aiplatform.v1.ListNotebookRuntimesResponse.next_page_token]
     * of the previous
     * [NotebookService.ListNotebookRuntimes][google.cloud.aiplatform.v1.NotebookService.ListNotebookRuntimes]
     * call.
     *
     * Generated from protobuf field <code>string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $page_token = '';
    /**
     * Optional. Mask specifying which fields to read.
     *
     * Generated from protobuf field <code>.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $read_mask = null;
    /**
     * Optional. A comma-separated list of fields to order by, sorted in ascending
     * order. Use "desc" after a field name for descending. Supported fields:
     *   * `display_name`
     *   * `create_time`
     *   * `update_time`
     * Example: `display_name, create_time desc`.
     *
     * Generated from protobuf field <code>string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $order_by = '';

    /**
     * @param string $parent Required. The resource name of the Location from which to list the
     *                       NotebookRuntimes.
     *                       Format: `projects/{project}/locations/{location}`
     *                       Please see {@see NotebookServiceClient::locationName()} for help formatting this field.
     *
     * @return \Google\Cloud\AIPlatform\V1\ListNotebookRuntimesRequest
     *
     * @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. The resource name of the Location from which to list the
     *           NotebookRuntimes.
     *           Format: `projects/{project}/locations/{location}`
     *     @type string $filter
     *           Optional. An expression for filtering the results of the request. For field
     *           names both snake_case and camelCase are supported.
     *             * `notebookRuntime` supports = and !=. `notebookRuntime` represents the
     *               NotebookRuntime ID,
     *               i.e. the last segment of the NotebookRuntime's [resource name]
     *               [google.cloud.aiplatform.v1.NotebookRuntime.name].
     *             * `displayName` supports = and != and regex.
     *             * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate`
     *               represents the NotebookRuntimeTemplate ID,
     *               i.e. the last segment of the NotebookRuntimeTemplate's [resource name]
     *               [google.cloud.aiplatform.v1.NotebookRuntimeTemplate.name].
     *             * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY,
     *             HEALTH_STATE_UNSPECIFIED].
     *             * `runtimeState` supports = and !=. runtimeState enum:
     *             [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED,
     *             STOPPED, BEING_UPGRADED, ERROR, INVALID].
     *             * `runtimeUser` supports = and !=.
     *             * API version is UI only: `uiState` supports = and !=. uiState enum:
     *             [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED,
     *             UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED,
     *             UI_RESOURCE_STATE_CREATION_FAILED].
     *             * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum:
     *             [USER_DEFINED, ONE_CLICK].
     *             * `machineType` supports = and !=.
     *             * `acceleratorType` supports = and !=.
     *           Some examples:
     *             * `notebookRuntime="notebookRuntime123"`
     *             * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"`
     *             * `notebookRuntimeTemplate="notebookRuntimeTemplate321"`
     *             * `healthState=HEALTHY`
     *             * `runtimeState=RUNNING`
     *             * `runtimeUser="test&#64;google.com"`
     *             * `uiState=UI_RESOURCE_STATE_BEING_DELETED`
     *             * `notebookRuntimeType=USER_DEFINED`
     *             * `machineType=e2-standard-4`
     *             * `acceleratorType=NVIDIA_TESLA_T4`
     *     @type int $page_size
     *           Optional. The standard list page size.
     *     @type string $page_token
     *           Optional. The standard list page token.
     *           Typically obtained via
     *           [ListNotebookRuntimesResponse.next_page_token][google.cloud.aiplatform.v1.ListNotebookRuntimesResponse.next_page_token]
     *           of the previous
     *           [NotebookService.ListNotebookRuntimes][google.cloud.aiplatform.v1.NotebookService.ListNotebookRuntimes]
     *           call.
     *     @type \Google\Protobuf\FieldMask $read_mask
     *           Optional. Mask specifying which fields to read.
     *     @type string $order_by
     *           Optional. A comma-separated list of fields to order by, sorted in ascending
     *           order. Use "desc" after a field name for descending. Supported fields:
     *             * `display_name`
     *             * `create_time`
     *             * `update_time`
     *           Example: `display_name, create_time desc`.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Cloud\Aiplatform\V1\NotebookService::initOnce();
        parent::__construct($data);
    }

    /**
     * Required. The resource name of the Location from which to list the
     * NotebookRuntimes.
     * 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. The resource name of the Location from which to list the
     * NotebookRuntimes.
     * 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. An expression for filtering the results of the request. For field
     * names both snake_case and camelCase are supported.
     *   * `notebookRuntime` supports = and !=. `notebookRuntime` represents the
     *     NotebookRuntime ID,
     *     i.e. the last segment of the NotebookRuntime's [resource name]
     *     [google.cloud.aiplatform.v1.NotebookRuntime.name].
     *   * `displayName` supports = and != and regex.
     *   * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate`
     *     represents the NotebookRuntimeTemplate ID,
     *     i.e. the last segment of the NotebookRuntimeTemplate's [resource name]
     *     [google.cloud.aiplatform.v1.NotebookRuntimeTemplate.name].
     *   * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY,
     *   HEALTH_STATE_UNSPECIFIED].
     *   * `runtimeState` supports = and !=. runtimeState enum:
     *   [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED,
     *   STOPPED, BEING_UPGRADED, ERROR, INVALID].
     *   * `runtimeUser` supports = and !=.
     *   * API version is UI only: `uiState` supports = and !=. uiState enum:
     *   [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED,
     *   UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED,
     *   UI_RESOURCE_STATE_CREATION_FAILED].
     *   * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum:
     *   [USER_DEFINED, ONE_CLICK].
     *   * `machineType` supports = and !=.
     *   * `acceleratorType` supports = and !=.
     * Some examples:
     *   * `notebookRuntime="notebookRuntime123"`
     *   * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"`
     *   * `notebookRuntimeTemplate="notebookRuntimeTemplate321"`
     *   * `healthState=HEALTHY`
     *   * `runtimeState=RUNNING`
     *   * `runtimeUser="test&#64;google.com"`
     *   * `uiState=UI_RESOURCE_STATE_BEING_DELETED`
     *   * `notebookRuntimeType=USER_DEFINED`
     *   * `machineType=e2-standard-4`
     *   * `acceleratorType=NVIDIA_TESLA_T4`
     *
     * Generated from protobuf field <code>string filter = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return string
     */
    public function getFilter()
    {
        return $this->filter;
    }

    /**
     * Optional. An expression for filtering the results of the request. For field
     * names both snake_case and camelCase are supported.
     *   * `notebookRuntime` supports = and !=. `notebookRuntime` represents the
     *     NotebookRuntime ID,
     *     i.e. the last segment of the NotebookRuntime's [resource name]
     *     [google.cloud.aiplatform.v1.NotebookRuntime.name].
     *   * `displayName` supports = and != and regex.
     *   * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate`
     *     represents the NotebookRuntimeTemplate ID,
     *     i.e. the last segment of the NotebookRuntimeTemplate's [resource name]
     *     [google.cloud.aiplatform.v1.NotebookRuntimeTemplate.name].
     *   * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY,
     *   HEALTH_STATE_UNSPECIFIED].
     *   * `runtimeState` supports = and !=. runtimeState enum:
     *   [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED,
     *   STOPPED, BEING_UPGRADED, ERROR, INVALID].
     *   * `runtimeUser` supports = and !=.
     *   * API version is UI only: `uiState` supports = and !=. uiState enum:
     *   [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED,
     *   UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED,
     *   UI_RESOURCE_STATE_CREATION_FAILED].
     *   * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum:
     *   [USER_DEFINED, ONE_CLICK].
     *   * `machineType` supports = and !=.
     *   * `acceleratorType` supports = and !=.
     * Some examples:
     *   * `notebookRuntime="notebookRuntime123"`
     *   * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"`
     *   * `notebookRuntimeTemplate="notebookRuntimeTemplate321"`
     *   * `healthState=HEALTHY`
     *   * `runtimeState=RUNNING`
     *   * `runtimeUser="test&#64;google.com"`
     *   * `uiState=UI_RESOURCE_STATE_BEING_DELETED`
     *   * `notebookRuntimeType=USER_DEFINED`
     *   * `machineType=e2-standard-4`
     *   * `acceleratorType=NVIDIA_TESLA_T4`
     *
     * Generated from protobuf field <code>string filter = 2 [(.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. The standard list page size.
     *
     * Generated from protobuf field <code>int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return int
     */
    public function getPageSize()
    {
        return $this->page_size;
    }

    /**
     * Optional. The standard list page size.
     *
     * Generated from protobuf field <code>int32 page_size = 3 [(.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. The standard list page token.
     * Typically obtained via
     * [ListNotebookRuntimesResponse.next_page_token][google.cloud.aiplatform.v1.ListNotebookRuntimesResponse.next_page_token]
     * of the previous
     * [NotebookService.ListNotebookRuntimes][google.cloud.aiplatform.v1.NotebookService.ListNotebookRuntimes]
     * call.
     *
     * Generated from protobuf field <code>string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return string
     */
    public function getPageToken()
    {
        return $this->page_token;
    }

    /**
     * Optional. The standard list page token.
     * Typically obtained via
     * [ListNotebookRuntimesResponse.next_page_token][google.cloud.aiplatform.v1.ListNotebookRuntimesResponse.next_page_token]
     * of the previous
     * [NotebookService.ListNotebookRuntimes][google.cloud.aiplatform.v1.NotebookService.ListNotebookRuntimes]
     * call.
     *
     * Generated from protobuf field <code>string page_token = 4 [(.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. Mask specifying which fields to read.
     *
     * Generated from protobuf field <code>.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return \Google\Protobuf\FieldMask|null
     */
    public function getReadMask()
    {
        return $this->read_mask;
    }

    public function hasReadMask()
    {
        return isset($this->read_mask);
    }

    public function clearReadMask()
    {
        unset($this->read_mask);
    }

    /**
     * Optional. Mask specifying which fields to read.
     *
     * Generated from protobuf field <code>.google.protobuf.FieldMask read_mask = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @param \Google\Protobuf\FieldMask $var
     * @return $this
     */
    public function setReadMask($var)
    {
        GPBUtil::checkMessage($var, \Google\Protobuf\FieldMask::class);
        $this->read_mask = $var;

        return $this;
    }

    /**
     * Optional. A comma-separated list of fields to order by, sorted in ascending
     * order. Use "desc" after a field name for descending. Supported fields:
     *   * `display_name`
     *   * `create_time`
     *   * `update_time`
     * Example: `display_name, create_time desc`.
     *
     * Generated from protobuf field <code>string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return string
     */
    public function getOrderBy()
    {
        return $this->order_by;
    }

    /**
     * Optional. A comma-separated list of fields to order by, sorted in ascending
     * order. Use "desc" after a field name for descending. Supported fields:
     *   * `display_name`
     *   * `create_time`
     *   * `update_time`
     * Example: `display_name, create_time desc`.
     *
     * Generated from protobuf field <code>string order_by = 6 [(.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;
    }

}

