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

namespace Google\Cloud\Deploy\V1;

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

/**
 * The request object for `ListAutomations`.
 *
 * Generated from protobuf message <code>google.cloud.deploy.v1.ListAutomationsRequest</code>
 */
class ListAutomationsRequest extends \Google\Protobuf\Internal\Message
{
    /**
     * Required. The parent `Delivery Pipeline`, which owns this collection of
     * automations. Format must be
     * `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.
     *
     * Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
     */
    protected $parent = '';
    /**
     * The maximum number of automations to return. The service may return
     * fewer than this value. If unspecified, at most 50 automations will
     * be returned. The maximum value is 1000; values above 1000 will be set
     * to 1000.
     *
     * Generated from protobuf field <code>int32 page_size = 2;</code>
     */
    protected $page_size = 0;
    /**
     * A page token, received from a previous `ListAutomations` call.
     * Provide this to retrieve the subsequent page.
     * When paginating, all other provided parameters match
     * the call that provided the page token.
     *
     * Generated from protobuf field <code>string page_token = 3;</code>
     */
    protected $page_token = '';
    /**
     * Filter automations to be returned. All fields can be used in the
     * filter.
     *
     * Generated from protobuf field <code>string filter = 4;</code>
     */
    protected $filter = '';
    /**
     * Field to sort by.
     *
     * Generated from protobuf field <code>string order_by = 5;</code>
     */
    protected $order_by = '';

    /**
     * @param string $parent Required. The parent `Delivery Pipeline`, which owns this collection of
     *                       automations. Format must be
     *                       `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`. Please see
     *                       {@see CloudDeployClient::deliveryPipelineName()} for help formatting this field.
     *
     * @return \Google\Cloud\Deploy\V1\ListAutomationsRequest
     *
     * @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 parent `Delivery Pipeline`, which owns this collection of
     *           automations. Format must be
     *           `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.
     *     @type int $page_size
     *           The maximum number of automations to return. The service may return
     *           fewer than this value. If unspecified, at most 50 automations will
     *           be returned. The maximum value is 1000; values above 1000 will be set
     *           to 1000.
     *     @type string $page_token
     *           A page token, received from a previous `ListAutomations` call.
     *           Provide this to retrieve the subsequent page.
     *           When paginating, all other provided parameters match
     *           the call that provided the page token.
     *     @type string $filter
     *           Filter automations to be returned. All fields can be used in the
     *           filter.
     *     @type string $order_by
     *           Field to sort by.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Cloud\Deploy\V1\CloudDeploy::initOnce();
        parent::__construct($data);
    }

    /**
     * Required. The parent `Delivery Pipeline`, which owns this collection of
     * automations. Format must be
     * `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.
     *
     * 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 parent `Delivery Pipeline`, which owns this collection of
     * automations. Format must be
     * `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.
     *
     * 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 maximum number of automations to return. The service may return
     * fewer than this value. If unspecified, at most 50 automations will
     * be returned. The maximum value is 1000; values above 1000 will be set
     * to 1000.
     *
     * Generated from protobuf field <code>int32 page_size = 2;</code>
     * @return int
     */
    public function getPageSize()
    {
        return $this->page_size;
    }

    /**
     * The maximum number of automations to return. The service may return
     * fewer than this value. If unspecified, at most 50 automations will
     * be returned. The maximum value is 1000; values above 1000 will be set
     * to 1000.
     *
     * Generated from protobuf field <code>int32 page_size = 2;</code>
     * @param int $var
     * @return $this
     */
    public function setPageSize($var)
    {
        GPBUtil::checkInt32($var);
        $this->page_size = $var;

        return $this;
    }

    /**
     * A page token, received from a previous `ListAutomations` call.
     * Provide this to retrieve the subsequent page.
     * When paginating, all other provided parameters match
     * the call that provided the page token.
     *
     * Generated from protobuf field <code>string page_token = 3;</code>
     * @return string
     */
    public function getPageToken()
    {
        return $this->page_token;
    }

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

        return $this;
    }

    /**
     * Filter automations to be returned. All fields can be used in the
     * filter.
     *
     * Generated from protobuf field <code>string filter = 4;</code>
     * @return string
     */
    public function getFilter()
    {
        return $this->filter;
    }

    /**
     * Filter automations to be returned. All fields can be used in the
     * filter.
     *
     * Generated from protobuf field <code>string filter = 4;</code>
     * @param string $var
     * @return $this
     */
    public function setFilter($var)
    {
        GPBUtil::checkString($var, True);
        $this->filter = $var;

        return $this;
    }

    /**
     * Field to sort by.
     *
     * Generated from protobuf field <code>string order_by = 5;</code>
     * @return string
     */
    public function getOrderBy()
    {
        return $this->order_by;
    }

    /**
     * Field to sort by.
     *
     * Generated from protobuf field <code>string order_by = 5;</code>
     * @param string $var
     * @return $this
     */
    public function setOrderBy($var)
    {
        GPBUtil::checkString($var, True);
        $this->order_by = $var;

        return $this;
    }

}

