File Manager

Editing: ListOperationsRequest.php

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

namespace Google\LongRunning;

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

/**
 * The request message for
 * [Operations.ListOperations][google.longrunning.Operations.ListOperations].
 *
 * Generated from protobuf message <code>google.longrunning.ListOperationsRequest</code>
 */
class ListOperationsRequest extends \Google\Protobuf\Internal\Message
{
    /**
     * The name of the operation's parent resource.
     *
     * Generated from protobuf field <code>string name = 4;</code>
     */
    private $name = '';
    /**
     * The standard list filter.
     *
     * Generated from protobuf field <code>string filter = 1;</code>
     */
    private $filter = '';
    /**
     * The standard list page size.
     *
     * Generated from protobuf field <code>int32 page_size = 2;</code>
     */
    private $page_size = 0;
    /**
     * The standard list page token.
     *
     * Generated from protobuf field <code>string page_token = 3;</code>
     */
    private $page_token = '';
    /**
     * When set to `true`, operations that are reachable are returned as normal,
     * and those that are unreachable are returned in the
     * [ListOperationsResponse.unreachable] field.
     * This can only be `true` when reading across collections e.g. when `parent`
     * is set to `"projects/example/locations/-"`.
     * This field is not by default supported and will result in an
     * `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
     * service or product specific documentation.
     *
     * Generated from protobuf field <code>bool return_partial_success = 5;</code>
     */
    private $return_partial_success = false;

/**
     * @param string $name   The name of the operation's parent resource.
     * @param string $filter The standard list filter.
     *
     * @return \Google\LongRunning\ListOperationsRequest
     *
     * @experimental
     */
    public static function build(string $name, string $filter): self
    {
        return (new self())
            ->setName($name)
            ->setFilter($filter);
    }

/**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type string $name
     *           The name of the operation's parent resource.
     *     @type string $filter
     *           The standard list filter.
     *     @type int $page_size
     *           The standard list page size.
     *     @type string $page_token
     *           The standard list page token.
     *     @type bool $return_partial_success
     *           When set to `true`, operations that are reachable are returned as normal,
     *           and those that are unreachable are returned in the
     *           [ListOperationsResponse.unreachable] field.
     *           This can only be `true` when reading across collections e.g. when `parent`
     *           is set to `"projects/example/locations/-"`.
     *           This field is not by default supported and will result in an
     *           `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
     *           service or product specific documentation.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Longrunning\Operations::initOnce();
        parent::__construct($data);
    }

/**
     * The name of the operation's parent resource.
     *
     * Generated from protobuf field <code>string name = 4;</code>
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

/**
     * The name of the operation's parent resource.
     *
     * Generated from protobuf field <code>string name = 4;</code>
     * @param string $var
     * @return $this
     */
    public function setName($var)
    {
        GPBUtil::checkString($var, True);
        $this->name = $var;

return $this;
    }

/**
     * The standard list filter.
     *
     * Generated from protobuf field <code>string filter = 1;</code>
     * @return string
     */
    public function getFilter()
    {
        return $this->filter;
    }

/**
     * The standard list filter.
     *
     * Generated from protobuf field <code>string filter = 1;</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 = 2;</code>
     * @return int
     */
    public function getPageSize()
    {
        return $this->page_size;
    }

/**
     * The standard list page size.
     *
     * 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;
    }

/**
     * The standard list page token.
     *
     * Generated from protobuf field <code>string page_token = 3;</code>
     * @return string
     */
    public function getPageToken()
    {
        return $this->page_token;
    }

/**
     * The standard list 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;
    }

/**
     * When set to `true`, operations that are reachable are returned as normal,
     * and those that are unreachable are returned in the
     * [ListOperationsResponse.unreachable] field.
     * This can only be `true` when reading across collections e.g. when `parent`
     * is set to `"projects/example/locations/-"`.
     * This field is not by default supported and will result in an
     * `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
     * service or product specific documentation.
     *
     * Generated from protobuf field <code>bool return_partial_success = 5;</code>
     * @return bool
     */
    public function getReturnPartialSuccess()
    {
        return $this->return_partial_success;
    }

/**
     * When set to `true`, operations that are reachable are returned as normal,
     * and those that are unreachable are returned in the
     * [ListOperationsResponse.unreachable] field.
     * This can only be `true` when reading across collections e.g. when `parent`
     * is set to `"projects/example/locations/-"`.
     * This field is not by default supported and will result in an
     * `UNIMPLEMENTED` error if set unless explicitly documented otherwise in
     * service or product specific documentation.
     *
     * Generated from protobuf field <code>bool return_partial_success = 5;</code>
     * @param bool $var
     * @return $this
     */
    public function setReturnPartialSuccess($var)
    {
        GPBUtil::checkBool($var);
        $this->return_partial_success = $var;

return $this;
    }

}

⬅ Back