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

namespace Google\Cloud\Ces\V1;

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

/**
 * Request message for
 * [AgentService.DeleteTool][google.cloud.ces.v1.AgentService.DeleteTool].
 *
 * Generated from protobuf message <code>google.cloud.ces.v1.DeleteToolRequest</code>
 */
class DeleteToolRequest extends \Google\Protobuf\Internal\Message
{
    /**
     * Required. The resource name of the tool to delete.
     *
     * Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
     */
    protected $name = '';
    /**
     * Optional. Indicates whether to forcefully delete the tool, even if it is
     * still referenced by agents/examples.
     * *  If `force = false`, the deletion will fail if any agents still
     * reference the tool.
     * *  If `force = true`, all existing references from agents will be removed
     * and the tool will be deleted.
     *
     * Generated from protobuf field <code>bool force = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $force = false;
    /**
     * Optional. The current etag of the tool. If an etag is not provided, the
     * deletion will overwrite any concurrent changes. If an etag is provided and
     * does not match the current etag of the tool, deletion will be blocked and
     * an ABORTED error will be returned.
     *
     * Generated from protobuf field <code>string etag = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
     */
    protected $etag = '';

    /**
     * @param string $name Required. The resource name of the tool to delete. Please see
     *                     {@see AgentServiceClient::toolName()} for help formatting this field.
     *
     * @return \Google\Cloud\Ces\V1\DeleteToolRequest
     *
     * @experimental
     */
    public static function build(string $name): self
    {
        return (new self())
            ->setName($name);
    }

    /**
     * Constructor.
     *
     * @param array $data {
     *     Optional. Data for populating the Message object.
     *
     *     @type string $name
     *           Required. The resource name of the tool to delete.
     *     @type bool $force
     *           Optional. Indicates whether to forcefully delete the tool, even if it is
     *           still referenced by agents/examples.
     *           *  If `force = false`, the deletion will fail if any agents still
     *           reference the tool.
     *           *  If `force = true`, all existing references from agents will be removed
     *           and the tool will be deleted.
     *     @type string $etag
     *           Optional. The current etag of the tool. If an etag is not provided, the
     *           deletion will overwrite any concurrent changes. If an etag is provided and
     *           does not match the current etag of the tool, deletion will be blocked and
     *           an ABORTED error will be returned.
     * }
     */
    public function __construct($data = NULL) {
        \GPBMetadata\Google\Cloud\Ces\V1\AgentService::initOnce();
        parent::__construct($data);
    }

    /**
     * Required. The resource name of the tool to delete.
     *
     * Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Required. The resource name of the tool to delete.
     *
     * Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
     * @param string $var
     * @return $this
     */
    public function setName($var)
    {
        GPBUtil::checkString($var, True);
        $this->name = $var;

        return $this;
    }

    /**
     * Optional. Indicates whether to forcefully delete the tool, even if it is
     * still referenced by agents/examples.
     * *  If `force = false`, the deletion will fail if any agents still
     * reference the tool.
     * *  If `force = true`, all existing references from agents will be removed
     * and the tool will be deleted.
     *
     * Generated from protobuf field <code>bool force = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return bool
     */
    public function getForce()
    {
        return $this->force;
    }

    /**
     * Optional. Indicates whether to forcefully delete the tool, even if it is
     * still referenced by agents/examples.
     * *  If `force = false`, the deletion will fail if any agents still
     * reference the tool.
     * *  If `force = true`, all existing references from agents will be removed
     * and the tool will be deleted.
     *
     * Generated from protobuf field <code>bool force = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @param bool $var
     * @return $this
     */
    public function setForce($var)
    {
        GPBUtil::checkBool($var);
        $this->force = $var;

        return $this;
    }

    /**
     * Optional. The current etag of the tool. If an etag is not provided, the
     * deletion will overwrite any concurrent changes. If an etag is provided and
     * does not match the current etag of the tool, deletion will be blocked and
     * an ABORTED error will be returned.
     *
     * Generated from protobuf field <code>string etag = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @return string
     */
    public function getEtag()
    {
        return $this->etag;
    }

    /**
     * Optional. The current etag of the tool. If an etag is not provided, the
     * deletion will overwrite any concurrent changes. If an etag is provided and
     * does not match the current etag of the tool, deletion will be blocked and
     * an ABORTED error will be returned.
     *
     * Generated from protobuf field <code>string etag = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
     * @param string $var
     * @return $this
     */
    public function setEtag($var)
    {
        GPBUtil::checkString($var, True);
        $this->etag = $var;

        return $this;
    }

}

