Class PurgeDocumentsRequest.InlineSource (0.48.0)

public static final class PurgeDocumentsRequest.InlineSource extends GeneratedMessageV3 implements PurgeDocumentsRequest.InlineSourceOrBuilder

The inline source for the input config for DocumentService.PurgeDocuments method.

Protobuf type google.cloud.discoveryengine.v1.PurgeDocumentsRequest.InlineSource

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > PurgeDocumentsRequest.InlineSource

Static Fields

DOCUMENTS_FIELD_NUMBER

public static final int DOCUMENTS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PurgeDocumentsRequest.InlineSource getDefaultInstance()
Returns
Type Description
PurgeDocumentsRequest.InlineSource

getDescriptor()

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

newBuilder()

public static PurgeDocumentsRequest.InlineSource.Builder newBuilder()
Returns
Type Description
PurgeDocumentsRequest.InlineSource.Builder

newBuilder(PurgeDocumentsRequest.InlineSource prototype)

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

parseDelimitedFrom(InputStream input)

public static PurgeDocumentsRequest.InlineSource parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PurgeDocumentsRequest.InlineSource
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static PurgeDocumentsRequest.InlineSource parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PurgeDocumentsRequest.InlineSource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static PurgeDocumentsRequest.InlineSource parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PurgeDocumentsRequest.InlineSource
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static PurgeDocumentsRequest.InlineSource parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PurgeDocumentsRequest.InlineSource
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static PurgeDocumentsRequest.InlineSource parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PurgeDocumentsRequest.InlineSource
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<PurgeDocumentsRequest.InlineSource> parser()
Returns
Type Description
Parser<InlineSource>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public PurgeDocumentsRequest.InlineSource getDefaultInstanceForType()
Returns
Type Description
PurgeDocumentsRequest.InlineSource

getDocuments(int index)

public String getDocuments(int index)

Required. A list of full resource name of documents to purge. In the format projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*. Recommended max of 100 items.

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

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The documents at the given index.

getDocumentsBytes(int index)

public ByteString getDocumentsBytes(int index)

Required. A list of full resource name of documents to purge. In the format projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*. Recommended max of 100 items.

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

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the documents at the given index.

getDocumentsCount()

public int getDocumentsCount()

Required. A list of full resource name of documents to purge. In the format projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*. Recommended max of 100 items.

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

Returns
Type Description
int

The count of documents.

getDocumentsList()

public ProtocolStringList getDocumentsList()

Required. A list of full resource name of documents to purge. In the format projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*. Recommended max of 100 items.

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

Returns
Type Description
ProtocolStringList

A list containing the documents.

getParserForType()

public Parser<PurgeDocumentsRequest.InlineSource> getParserForType()
Returns
Type Description
Parser<InlineSource>
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 PurgeDocumentsRequest.InlineSource.Builder newBuilderForType()
Returns
Type Description
PurgeDocumentsRequest.InlineSource.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public PurgeDocumentsRequest.InlineSource.Builder toBuilder()
Returns
Type Description
PurgeDocumentsRequest.InlineSource.Builder

writeTo(CodedOutputStream output)

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