Google Cloud Dialogflow V2 Client - Class DeleteKnowledgeBaseRequest (1.9.0)

Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class DeleteKnowledgeBaseRequest.

Request message for KnowledgeBases.DeleteKnowledgeBase.

Generated from protobuf message google.cloud.dialogflow.v2.DeleteKnowledgeBaseRequest

Namespace

Google \ Cloud \ Dialogflow \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Required. The name of the knowledge base to delete. Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>.

↳ force bool

Optional. Force deletes the knowledge base. When set to true, any documents in the knowledge base are also deleted.

getName

Required. The name of the knowledge base to delete.

Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>.

Returns
TypeDescription
string

setName

Required. The name of the knowledge base to delete.

Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getForce

Optional. Force deletes the knowledge base. When set to true, any documents in the knowledge base are also deleted.

Returns
TypeDescription
bool

setForce

Optional. Force deletes the knowledge base. When set to true, any documents in the knowledge base are also deleted.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
name string

Required. The name of the knowledge base to delete. Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>. Please see Google\Cloud\Dialogflow\V2\KnowledgeBasesClient::knowledgeBaseName() for help formatting this field.

Returns
TypeDescription
Google\Cloud\Dialogflow\V2\DeleteKnowledgeBaseRequest