<?php
# Generated by the protocol buffer compiler.  DO NOT EDIT!
# source: google/cloud/aiplatform/v1/index_endpoint_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
 * [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints].
 *
 * Generated from protobuf message <code>google.cloud.aiplatform.v1.ListIndexEndpointsRequest</code>
 */
class ListIndexEndpointsRequest extends \Google\Protobuf\Internal\Message
{
    /**
     * Required. The resource name of the Location from which to list the
     * IndexEndpoints. Format: `projects/{project}/locations/{location}`
     *
     * Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
     */
    private $parent = '';
    /**
     * Optional. An expression for filtering the results of the request. For field
     * names both snake_case and camelCase are supported.
     *   * `index_endpoint` supports = and !=. `index_endpoint` represents the
     *      IndexEndpoint ID, ie. the last segment of the IndexEndpoint's
     *      [resourcename][google.cloud.aiplatform.v1.IndexEndpoint.name].
     *   * `display_name` supports =, != and regex()
     *             (uses [re2](https://github.com/google/re2/wiki/Syntax) syntax)
     *   * `labels` supports general map functions that is:
     *             `labels.key=value` - key:value equality
     *             `labels.key:* or labels:key - key existence
     *              A key including a space must be quoted. `labels."a key"`.
     * Some examples:
     *   * `index_endpoint="1"`
     *   * `display_name="myDisplayName"`
     *   * `regex(display_name, "^A") -> The display name starts with an A.
     *   * `labels.myKey="myValue"`
     *
     * Generated from protobuf field <code>string filter = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    private $filter = '';
    /**
     * Optional. The standard list page size.
     *
     * Generated from protobuf field <code>int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    private $page_size = 0;
    /**
     * Optional. The standard list page token.
     * Typically obtained via
     * [ListIndexEndpointsResponse.next_page_token][google.cloud.aiplatform.v1.ListIndexEndpointsResponse.next_page_token]
     * of the previous
     * [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints]
     * call.
     *
     * Generated from protobuf field <code>string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    private $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>
     */
    private $read_mask = null;

    /**
     * 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
     *           IndexEndpoints. 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.
     *             * `index_endpoint` supports = and !=. `index_endpoint` represents the
     *                IndexEndpoint ID, ie. the last segment of the IndexEndpoint's
     *                [resourcename][google.cloud.aiplatform.v1.IndexEndpoint.name].
     *             * `display_name` supports =, != and regex()
     *                       (uses [re2](https://github.com/google/re2/wiki/Syntax) syntax)
     *             * `labels` supports general map functions that is:
     *                       `labels.key=value` - key:value equality
     *                       `labels.key:* or labels:key - key existence
     *                        A key including a space must be quoted. `labels."a key"`.
     *           Some examples:
     *             * `index_endpoint="1"`
     *             * `display_name="myDisplayName"`
     *             * `regex(display_name, "^A") -> The display name starts with an A.
     *             * `labels.myKey="myValue"`
     *     @type int $page_size
     *           Optional. The standard list page size.
     *     @type string $page_token
     *           Optional. The standard list page token.
     *           Typically obtained via
     *           [ListIndexEndpointsResponse.next_page_token][google.cloud.aiplatform.v1.ListIndexEndpointsResponse.next_page_token]
     *           of the previous
     *           [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints]
     *           call.
     *     @type \Google\Protobuf\FieldMask $read_mask
     *           Optional. Mask specifying which fields to read.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Cloud\Aiplatform\V1\IndexEndpointService::initOnce();
        parent::__construct($data);
    }

    /**
     * Required. The resource name of the Location from which to list the
     * IndexEndpoints. 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
     * IndexEndpoints. 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.
     *   * `index_endpoint` supports = and !=. `index_endpoint` represents the
     *      IndexEndpoint ID, ie. the last segment of the IndexEndpoint's
     *      [resourcename][google.cloud.aiplatform.v1.IndexEndpoint.name].
     *   * `display_name` supports =, != and regex()
     *             (uses [re2](https://github.com/google/re2/wiki/Syntax) syntax)
     *   * `labels` supports general map functions that is:
     *             `labels.key=value` - key:value equality
     *             `labels.key:* or labels:key - key existence
     *              A key including a space must be quoted. `labels."a key"`.
     * Some examples:
     *   * `index_endpoint="1"`
     *   * `display_name="myDisplayName"`
     *   * `regex(display_name, "^A") -> The display name starts with an A.
     *   * `labels.myKey="myValue"`
     *
     * 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.
     *   * `index_endpoint` supports = and !=. `index_endpoint` represents the
     *      IndexEndpoint ID, ie. the last segment of the IndexEndpoint's
     *      [resourcename][google.cloud.aiplatform.v1.IndexEndpoint.name].
     *   * `display_name` supports =, != and regex()
     *             (uses [re2](https://github.com/google/re2/wiki/Syntax) syntax)
     *   * `labels` supports general map functions that is:
     *             `labels.key=value` - key:value equality
     *             `labels.key:* or labels:key - key existence
     *              A key including a space must be quoted. `labels."a key"`.
     * Some examples:
     *   * `index_endpoint="1"`
     *   * `display_name="myDisplayName"`
     *   * `regex(display_name, "^A") -> The display name starts with an A.
     *   * `labels.myKey="myValue"`
     *
     * 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
     * [ListIndexEndpointsResponse.next_page_token][google.cloud.aiplatform.v1.ListIndexEndpointsResponse.next_page_token]
     * of the previous
     * [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints]
     * 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
     * [ListIndexEndpointsResponse.next_page_token][google.cloud.aiplatform.v1.ListIndexEndpointsResponse.next_page_token]
     * of the previous
     * [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints]
     * 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;
    }

}