Class DeleteRagCorpusRequest (3.45.0)

public final class DeleteRagCorpusRequest extends GeneratedMessageV3 implements DeleteRagCorpusRequestOrBuilder

Request message for VertexRagDataService.DeleteRagCorpus.

Protobuf type google.cloud.aiplatform.v1beta1.DeleteRagCorpusRequest

Static Fields

FORCE_FIELD_NUMBER

public static final int FORCE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DeleteRagCorpusRequest getDefaultInstance()
Returns
Type Description
DeleteRagCorpusRequest

getDescriptor()

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

newBuilder()

public static DeleteRagCorpusRequest.Builder newBuilder()
Returns
Type Description
DeleteRagCorpusRequest.Builder

newBuilder(DeleteRagCorpusRequest prototype)

public static DeleteRagCorpusRequest.Builder newBuilder(DeleteRagCorpusRequest prototype)
Parameter
Name Description
prototype DeleteRagCorpusRequest
Returns
Type Description
DeleteRagCorpusRequest.Builder

parseDelimitedFrom(InputStream input)

public static DeleteRagCorpusRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DeleteRagCorpusRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DeleteRagCorpusRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeleteRagCorpusRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DeleteRagCorpusRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DeleteRagCorpusRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DeleteRagCorpusRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeleteRagCorpusRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DeleteRagCorpusRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DeleteRagCorpusRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DeleteRagCorpusRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeleteRagCorpusRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DeleteRagCorpusRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DeleteRagCorpusRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DeleteRagCorpusRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeleteRagCorpusRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DeleteRagCorpusRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DeleteRagCorpusRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DeleteRagCorpusRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeleteRagCorpusRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DeleteRagCorpusRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DeleteRagCorpusRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DeleteRagCorpusRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeleteRagCorpusRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DeleteRagCorpusRequest> parser()
Returns
Type Description
Parser<DeleteRagCorpusRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public DeleteRagCorpusRequest getDefaultInstanceForType()
Returns
Type Description
DeleteRagCorpusRequest

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.

getParserForType()

public Parser<DeleteRagCorpusRequest> getParserForType()
Returns
Type Description
Parser<DeleteRagCorpusRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public DeleteRagCorpusRequest.Builder newBuilderForType()
Returns
Type Description
DeleteRagCorpusRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DeleteRagCorpusRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DeleteRagCorpusRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public DeleteRagCorpusRequest.Builder toBuilder()
Returns
Type Description
DeleteRagCorpusRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException