public static final class PurgeDocumentsRequest.InlineSource.Builder extends GeneratedMessage.Builder<PurgeDocumentsRequest.InlineSource.Builder> implements PurgeDocumentsRequest.InlineSourceOrBuilderThe inline source for the input config for DocumentService.PurgeDocuments method.
Protobuf type google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest.InlineSource
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > PurgeDocumentsRequest.InlineSource.BuilderImplements
PurgeDocumentsRequest.InlineSourceOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllDocuments(Iterable<String> values)
public PurgeDocumentsRequest.InlineSource.Builder addAllDocuments(Iterable<String> values) 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 |
values |
Iterable<String>The documents to add. |
| Returns | |
|---|---|
| Type | Description |
PurgeDocumentsRequest.InlineSource.Builder |
This builder for chaining. |
addDocuments(String value)
public PurgeDocumentsRequest.InlineSource.Builder addDocuments(String value) 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 |
value |
StringThe documents to add. |
| Returns | |
|---|---|
| Type | Description |
PurgeDocumentsRequest.InlineSource.Builder |
This builder for chaining. |
addDocumentsBytes(ByteString value)
public PurgeDocumentsRequest.InlineSource.Builder addDocumentsBytes(ByteString value) 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 |
value |
ByteStringThe bytes of the documents to add. |
| Returns | |
|---|---|
| Type | Description |
PurgeDocumentsRequest.InlineSource.Builder |
This builder for chaining. |
build()
public PurgeDocumentsRequest.InlineSource build()| Returns | |
|---|---|
| Type | Description |
PurgeDocumentsRequest.InlineSource |
|
buildPartial()
public PurgeDocumentsRequest.InlineSource buildPartial()| Returns | |
|---|---|
| Type | Description |
PurgeDocumentsRequest.InlineSource |
|
clear()
public PurgeDocumentsRequest.InlineSource.Builder clear()| Returns | |
|---|---|
| Type | Description |
PurgeDocumentsRequest.InlineSource.Builder |
|
clearDocuments()
public PurgeDocumentsRequest.InlineSource.Builder clearDocuments() 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 |
PurgeDocumentsRequest.InlineSource.Builder |
This builder for chaining. |
getDefaultInstanceForType()
public PurgeDocumentsRequest.InlineSource getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
PurgeDocumentsRequest.InlineSource |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 |
intThe 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 |
intThe 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. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(PurgeDocumentsRequest.InlineSource other)
public PurgeDocumentsRequest.InlineSource.Builder mergeFrom(PurgeDocumentsRequest.InlineSource other)| Parameter | |
|---|---|
| Name | Description |
other |
PurgeDocumentsRequest.InlineSource |
| Returns | |
|---|---|
| Type | Description |
PurgeDocumentsRequest.InlineSource.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public PurgeDocumentsRequest.InlineSource.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
PurgeDocumentsRequest.InlineSource.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public PurgeDocumentsRequest.InlineSource.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
PurgeDocumentsRequest.InlineSource.Builder |
|
setDocuments(int index, String value)
public PurgeDocumentsRequest.InlineSource.Builder setDocuments(int index, String value) 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) = { ... }
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe documents to set. |
| Returns | |
|---|---|
| Type | Description |
PurgeDocumentsRequest.InlineSource.Builder |
This builder for chaining. |