<?php
# Generated by the protocol buffer compiler.  DO NOT EDIT!
# source: google/cloud/aiplatform/v1/job_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
 * [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs].
 *
 * Generated from protobuf message <code>google.cloud.aiplatform.v1.ListHyperparameterTuningJobsRequest</code>
 */
class ListHyperparameterTuningJobsRequest extends \Google\Protobuf\Internal\Message
{
    /**
     * Required. The resource name of the Location to list the
     * HyperparameterTuningJobs from. 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 = '';
    /**
     * The standard list filter.
     * Supported fields:
     *   * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
     *   * `state` supports `=`, `!=` comparisons.
     *   * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons.
     *     `create_time` must be in RFC 3339 format.
     *   * `labels` supports general map functions that is:
     *     `labels.key=value` - key:value equality
     *     `labels.key:* - key existence
     * Some examples of using the filter are:
     *   * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
     *   * `state!="JOB_STATE_FAILED" OR display_name="my_job"`
     *   * `NOT display_name="my_job"`
     *   * `create_time>"2021-05-18T00:00:00Z"`
     *   * `labels.keyA=valueA`
     *   * `labels.keyB:*`
     *
     * Generated from protobuf field <code>string filter = 2;</code>
     */
    protected $filter = '';
    /**
     * The standard list page size.
     *
     * Generated from protobuf field <code>int32 page_size = 3;</code>
     */
    protected $page_size = 0;
    /**
     * The standard list page token.
     * Typically obtained via
     * [ListHyperparameterTuningJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListHyperparameterTuningJobsResponse.next_page_token]
     * of the previous
     * [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs]
     * call.
     *
     * Generated from protobuf field <code>string page_token = 4;</code>
     */
    protected $page_token = '';
    /**
     * Mask specifying which fields to read.
     *
     * Generated from protobuf field <code>.google.protobuf.FieldMask read_mask = 5;</code>
     */
    protected $read_mask = null;

    /**
     * @param string $parent Required. The resource name of the Location to list the
     *                       HyperparameterTuningJobs from. Format:
     *                       `projects/{project}/locations/{location}`
     *                       Please see {@see JobServiceClient::locationName()} for help formatting this field.
     *
     * @return \Google\Cloud\AIPlatform\V1\ListHyperparameterTuningJobsRequest
     *
     * @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 to list the
     *           HyperparameterTuningJobs from. Format:
     *           `projects/{project}/locations/{location}`
     *     @type string $filter
     *           The standard list filter.
     *           Supported fields:
     *             * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
     *             * `state` supports `=`, `!=` comparisons.
     *             * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons.
     *               `create_time` must be in RFC 3339 format.
     *             * `labels` supports general map functions that is:
     *               `labels.key=value` - key:value equality
     *               `labels.key:* - key existence
     *           Some examples of using the filter are:
     *             * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
     *             * `state!="JOB_STATE_FAILED" OR display_name="my_job"`
     *             * `NOT display_name="my_job"`
     *             * `create_time>"2021-05-18T00:00:00Z"`
     *             * `labels.keyA=valueA`
     *             * `labels.keyB:*`
     *     @type int $page_size
     *           The standard list page size.
     *     @type string $page_token
     *           The standard list page token.
     *           Typically obtained via
     *           [ListHyperparameterTuningJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListHyperparameterTuningJobsResponse.next_page_token]
     *           of the previous
     *           [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs]
     *           call.
     *     @type \Google\Protobuf\FieldMask $read_mask
     *           Mask specifying which fields to read.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Cloud\Aiplatform\V1\JobService::initOnce();
        parent::__construct($data);
    }

    /**
     * Required. The resource name of the Location to list the
     * HyperparameterTuningJobs from. 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 to list the
     * HyperparameterTuningJobs from. 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;
    }

    /**
     * The standard list filter.
     * Supported fields:
     *   * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
     *   * `state` supports `=`, `!=` comparisons.
     *   * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons.
     *     `create_time` must be in RFC 3339 format.
     *   * `labels` supports general map functions that is:
     *     `labels.key=value` - key:value equality
     *     `labels.key:* - key existence
     * Some examples of using the filter are:
     *   * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
     *   * `state!="JOB_STATE_FAILED" OR display_name="my_job"`
     *   * `NOT display_name="my_job"`
     *   * `create_time>"2021-05-18T00:00:00Z"`
     *   * `labels.keyA=valueA`
     *   * `labels.keyB:*`
     *
     * Generated from protobuf field <code>string filter = 2;</code>
     * @return string
     */
    public function getFilter()
    {
        return $this->filter;
    }

    /**
     * The standard list filter.
     * Supported fields:
     *   * `display_name` supports `=`, `!=` comparisons, and `:` wildcard.
     *   * `state` supports `=`, `!=` comparisons.
     *   * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons.
     *     `create_time` must be in RFC 3339 format.
     *   * `labels` supports general map functions that is:
     *     `labels.key=value` - key:value equality
     *     `labels.key:* - key existence
     * Some examples of using the filter are:
     *   * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"`
     *   * `state!="JOB_STATE_FAILED" OR display_name="my_job"`
     *   * `NOT display_name="my_job"`
     *   * `create_time>"2021-05-18T00:00:00Z"`
     *   * `labels.keyA=valueA`
     *   * `labels.keyB:*`
     *
     * Generated from protobuf field <code>string filter = 2;</code>
     * @param string $var
     * @return $this
     */
    public function setFilter($var)
    {
        GPBUtil::checkString($var, True);
        $this->filter = $var;

        return $this;
    }

    /**
     * The standard list page size.
     *
     * Generated from protobuf field <code>int32 page_size = 3;</code>
     * @return int
     */
    public function getPageSize()
    {
        return $this->page_size;
    }

    /**
     * The standard list page size.
     *
     * Generated from protobuf field <code>int32 page_size = 3;</code>
     * @param int $var
     * @return $this
     */
    public function setPageSize($var)
    {
        GPBUtil::checkInt32($var);
        $this->page_size = $var;

        return $this;
    }

    /**
     * The standard list page token.
     * Typically obtained via
     * [ListHyperparameterTuningJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListHyperparameterTuningJobsResponse.next_page_token]
     * of the previous
     * [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs]
     * call.
     *
     * Generated from protobuf field <code>string page_token = 4;</code>
     * @return string
     */
    public function getPageToken()
    {
        return $this->page_token;
    }

    /**
     * The standard list page token.
     * Typically obtained via
     * [ListHyperparameterTuningJobsResponse.next_page_token][google.cloud.aiplatform.v1.ListHyperparameterTuningJobsResponse.next_page_token]
     * of the previous
     * [JobService.ListHyperparameterTuningJobs][google.cloud.aiplatform.v1.JobService.ListHyperparameterTuningJobs]
     * call.
     *
     * Generated from protobuf field <code>string page_token = 4;</code>
     * @param string $var
     * @return $this
     */
    public function setPageToken($var)
    {
        GPBUtil::checkString($var, True);
        $this->page_token = $var;

        return $this;
    }

    /**
     * Mask specifying which fields to read.
     *
     * Generated from protobuf field <code>.google.protobuf.FieldMask read_mask = 5;</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);
    }

    /**
     * Mask specifying which fields to read.
     *
     * Generated from protobuf field <code>.google.protobuf.FieldMask read_mask = 5;</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;
    }

}

