Google Cloud Ai Platform V1 Client - Class DeleteRagCorpusRequest (1.35.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class DeleteRagCorpusRequest.

Request message for VertexRagDataService.DeleteRagCorpus.

Generated from protobuf message google.cloud.aiplatform.v1.DeleteRagCorpusRequest

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Required. The name of the RagCorpus resource to be deleted. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}
↳ force bool

Optional. If set to true, any RagFiles in this RagCorpus will also be deleted. Otherwise, the request will only work if the RagCorpus has no RagFiles.

getName

Required. The name of the RagCorpus resource to be deleted.

Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}

Returns
Type Description
string

setName

Required. The name of the RagCorpus resource to be deleted.

Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}

Parameter
Name Description
var string
Returns
Type Description
$this

getForce

Optional. If set to true, any RagFiles in this RagCorpus will also be deleted. Otherwise, the request will only work if the RagCorpus has no RagFiles.

Returns
Type Description
bool

setForce

Optional. If set to true, any RagFiles in this RagCorpus will also be deleted. Otherwise, the request will only work if the RagCorpus has no RagFiles.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. The name of the RagCorpus resource to be deleted. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus} Please see VertexRagDataServiceClient::ragCorpusName() for help formatting this field.
Returns
Type Description
DeleteRagCorpusRequest