Class DeleteRagCorpusRequest.Builder (3.84.0)

public static final class DeleteRagCorpusRequest.Builder extends GeneratedMessage.Builder<DeleteRagCorpusRequest.Builder> implements DeleteRagCorpusRequestOrBuilder

Request message for VertexRagDataService.DeleteRagCorpus.

Protobuf type google.cloud.aiplatform.v1beta1.DeleteRagCorpusRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public DeleteRagCorpusRequest build()
Returns
Type Description
DeleteRagCorpusRequest

buildPartial()

public DeleteRagCorpusRequest buildPartial()
Returns
Type Description
DeleteRagCorpusRequest

clear()

public DeleteRagCorpusRequest.Builder clear()
Returns
Type Description
DeleteRagCorpusRequest.Builder
Overrides

clearForce()

public DeleteRagCorpusRequest.Builder clearForce()

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.

bool force = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DeleteRagCorpusRequest.Builder

This builder for chaining.

clearName()

public DeleteRagCorpusRequest.Builder clearName()

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

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
DeleteRagCorpusRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public DeleteRagCorpusRequest getDefaultInstanceForType()
Returns
Type Description
DeleteRagCorpusRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getForce()

public boolean 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.

bool force = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The force.

getName()

public String getName()

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

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(DeleteRagCorpusRequest other)

public DeleteRagCorpusRequest.Builder mergeFrom(DeleteRagCorpusRequest other)
Parameter
Name Description
other DeleteRagCorpusRequest
Returns
Type Description
DeleteRagCorpusRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DeleteRagCorpusRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeleteRagCorpusRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public DeleteRagCorpusRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
DeleteRagCorpusRequest.Builder
Overrides

setForce(boolean value)

public DeleteRagCorpusRequest.Builder setForce(boolean value)

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.

bool force = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The force to set.

Returns
Type Description
DeleteRagCorpusRequest.Builder

This builder for chaining.

setName(String value)

public DeleteRagCorpusRequest.Builder setName(String value)

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

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The name to set.

Returns
Type Description
DeleteRagCorpusRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public DeleteRagCorpusRequest.Builder setNameBytes(ByteString value)

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

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
DeleteRagCorpusRequest.Builder

This builder for chaining.