public static final class PurgeDocumentsRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<PurgeDocumentsRequest.Builder> implements PurgeDocumentsRequestOrBuilder
Request message for [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1alpha.DocumentService.PurgeDocuments] method.Protobuf type
google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest| Modifier and Type | Method and Description |
|---|---|
PurgeDocumentsRequest.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
PurgeDocumentsRequest |
build() |
PurgeDocumentsRequest |
buildPartial() |
PurgeDocumentsRequest.Builder |
clear() |
PurgeDocumentsRequest.Builder |
clearErrorConfig()
The desired location of errors incurred during the purge.
|
PurgeDocumentsRequest.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
PurgeDocumentsRequest.Builder |
clearFilter()
Required.
|
PurgeDocumentsRequest.Builder |
clearForce()
Actually performs the purge.
|
PurgeDocumentsRequest.Builder |
clearGcsSource()
Cloud Storage location for the input content.
|
PurgeDocumentsRequest.Builder |
clearInlineSource()
Inline source for the input content for purge.
|
PurgeDocumentsRequest.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
PurgeDocumentsRequest.Builder |
clearParent()
Required.
|
PurgeDocumentsRequest.Builder |
clearSource() |
PurgeDocumentsRequest.Builder |
clone() |
PurgeDocumentsRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
PurgeErrorConfig |
getErrorConfig()
The desired location of errors incurred during the purge.
|
PurgeErrorConfig.Builder |
getErrorConfigBuilder()
The desired location of errors incurred during the purge.
|
PurgeErrorConfigOrBuilder |
getErrorConfigOrBuilder()
The desired location of errors incurred during the purge.
|
String |
getFilter()
Required.
|
com.google.protobuf.ByteString |
getFilterBytes()
Required.
|
boolean |
getForce()
Actually performs the purge.
|
GcsSource |
getGcsSource()
Cloud Storage location for the input content.
|
GcsSource.Builder |
getGcsSourceBuilder()
Cloud Storage location for the input content.
|
GcsSourceOrBuilder |
getGcsSourceOrBuilder()
Cloud Storage location for the input content.
|
PurgeDocumentsRequest.InlineSource |
getInlineSource()
Inline source for the input content for purge.
|
PurgeDocumentsRequest.InlineSource.Builder |
getInlineSourceBuilder()
Inline source for the input content for purge.
|
PurgeDocumentsRequest.InlineSourceOrBuilder |
getInlineSourceOrBuilder()
Inline source for the input content for purge.
|
String |
getParent()
Required.
|
com.google.protobuf.ByteString |
getParentBytes()
Required.
|
PurgeDocumentsRequest.SourceCase |
getSourceCase() |
boolean |
hasErrorConfig()
The desired location of errors incurred during the purge.
|
boolean |
hasGcsSource()
Cloud Storage location for the input content.
|
boolean |
hasInlineSource()
Inline source for the input content for purge.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
PurgeDocumentsRequest.Builder |
mergeErrorConfig(PurgeErrorConfig value)
The desired location of errors incurred during the purge.
|
PurgeDocumentsRequest.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
PurgeDocumentsRequest.Builder |
mergeFrom(com.google.protobuf.Message other) |
PurgeDocumentsRequest.Builder |
mergeFrom(PurgeDocumentsRequest other) |
PurgeDocumentsRequest.Builder |
mergeGcsSource(GcsSource value)
Cloud Storage location for the input content.
|
PurgeDocumentsRequest.Builder |
mergeInlineSource(PurgeDocumentsRequest.InlineSource value)
Inline source for the input content for purge.
|
PurgeDocumentsRequest.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
PurgeDocumentsRequest.Builder |
setErrorConfig(PurgeErrorConfig.Builder builderForValue)
The desired location of errors incurred during the purge.
|
PurgeDocumentsRequest.Builder |
setErrorConfig(PurgeErrorConfig value)
The desired location of errors incurred during the purge.
|
PurgeDocumentsRequest.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
PurgeDocumentsRequest.Builder |
setFilter(String value)
Required.
|
PurgeDocumentsRequest.Builder |
setFilterBytes(com.google.protobuf.ByteString value)
Required.
|
PurgeDocumentsRequest.Builder |
setForce(boolean value)
Actually performs the purge.
|
PurgeDocumentsRequest.Builder |
setGcsSource(GcsSource.Builder builderForValue)
Cloud Storage location for the input content.
|
PurgeDocumentsRequest.Builder |
setGcsSource(GcsSource value)
Cloud Storage location for the input content.
|
PurgeDocumentsRequest.Builder |
setInlineSource(PurgeDocumentsRequest.InlineSource.Builder builderForValue)
Inline source for the input content for purge.
|
PurgeDocumentsRequest.Builder |
setInlineSource(PurgeDocumentsRequest.InlineSource value)
Inline source for the input content for purge.
|
PurgeDocumentsRequest.Builder |
setParent(String value)
Required.
|
PurgeDocumentsRequest.Builder |
setParentBytes(com.google.protobuf.ByteString value)
Required.
|
PurgeDocumentsRequest.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
PurgeDocumentsRequest.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeDocumentsRequest.Builder>public PurgeDocumentsRequest.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeDocumentsRequest.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeDocumentsRequest.Builder>public PurgeDocumentsRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic PurgeDocumentsRequest build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic PurgeDocumentsRequest buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic PurgeDocumentsRequest.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeDocumentsRequest.Builder>public PurgeDocumentsRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeDocumentsRequest.Builder>public PurgeDocumentsRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeDocumentsRequest.Builder>public PurgeDocumentsRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeDocumentsRequest.Builder>public PurgeDocumentsRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeDocumentsRequest.Builder>public PurgeDocumentsRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeDocumentsRequest.Builder>public PurgeDocumentsRequest.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<PurgeDocumentsRequest.Builder>public PurgeDocumentsRequest.Builder mergeFrom(PurgeDocumentsRequest other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeDocumentsRequest.Builder>public PurgeDocumentsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<PurgeDocumentsRequest.Builder>IOExceptionpublic PurgeDocumentsRequest.SourceCase getSourceCase()
getSourceCase in interface PurgeDocumentsRequestOrBuilderpublic PurgeDocumentsRequest.Builder clearSource()
public boolean hasGcsSource()
Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid [Document.id][google.cloud.discoveryengine.v1alpha.Document.id] per line.
.google.cloud.discoveryengine.v1alpha.GcsSource gcs_source = 5;hasGcsSource in interface PurgeDocumentsRequestOrBuilderpublic GcsSource getGcsSource()
Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid [Document.id][google.cloud.discoveryengine.v1alpha.Document.id] per line.
.google.cloud.discoveryengine.v1alpha.GcsSource gcs_source = 5;getGcsSource in interface PurgeDocumentsRequestOrBuilderpublic PurgeDocumentsRequest.Builder setGcsSource(GcsSource value)
Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid [Document.id][google.cloud.discoveryengine.v1alpha.Document.id] per line.
.google.cloud.discoveryengine.v1alpha.GcsSource gcs_source = 5;public PurgeDocumentsRequest.Builder setGcsSource(GcsSource.Builder builderForValue)
Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid [Document.id][google.cloud.discoveryengine.v1alpha.Document.id] per line.
.google.cloud.discoveryengine.v1alpha.GcsSource gcs_source = 5;public PurgeDocumentsRequest.Builder mergeGcsSource(GcsSource value)
Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid [Document.id][google.cloud.discoveryengine.v1alpha.Document.id] per line.
.google.cloud.discoveryengine.v1alpha.GcsSource gcs_source = 5;public PurgeDocumentsRequest.Builder clearGcsSource()
Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid [Document.id][google.cloud.discoveryengine.v1alpha.Document.id] per line.
.google.cloud.discoveryengine.v1alpha.GcsSource gcs_source = 5;public GcsSource.Builder getGcsSourceBuilder()
Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid [Document.id][google.cloud.discoveryengine.v1alpha.Document.id] per line.
.google.cloud.discoveryengine.v1alpha.GcsSource gcs_source = 5;public GcsSourceOrBuilder getGcsSourceOrBuilder()
Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid [Document.id][google.cloud.discoveryengine.v1alpha.Document.id] per line.
.google.cloud.discoveryengine.v1alpha.GcsSource gcs_source = 5;getGcsSourceOrBuilder in interface PurgeDocumentsRequestOrBuilderpublic boolean hasInlineSource()
Inline source for the input content for purge.
.google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest.InlineSource inline_source = 6;
hasInlineSource in interface PurgeDocumentsRequestOrBuilderpublic PurgeDocumentsRequest.InlineSource getInlineSource()
Inline source for the input content for purge.
.google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest.InlineSource inline_source = 6;
getInlineSource in interface PurgeDocumentsRequestOrBuilderpublic PurgeDocumentsRequest.Builder setInlineSource(PurgeDocumentsRequest.InlineSource value)
Inline source for the input content for purge.
.google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest.InlineSource inline_source = 6;
public PurgeDocumentsRequest.Builder setInlineSource(PurgeDocumentsRequest.InlineSource.Builder builderForValue)
Inline source for the input content for purge.
.google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest.InlineSource inline_source = 6;
public PurgeDocumentsRequest.Builder mergeInlineSource(PurgeDocumentsRequest.InlineSource value)
Inline source for the input content for purge.
.google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest.InlineSource inline_source = 6;
public PurgeDocumentsRequest.Builder clearInlineSource()
Inline source for the input content for purge.
.google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest.InlineSource inline_source = 6;
public PurgeDocumentsRequest.InlineSource.Builder getInlineSourceBuilder()
Inline source for the input content for purge.
.google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest.InlineSource inline_source = 6;
public PurgeDocumentsRequest.InlineSourceOrBuilder getInlineSourceOrBuilder()
Inline source for the input content for purge.
.google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest.InlineSource inline_source = 6;
getInlineSourceOrBuilder in interface PurgeDocumentsRequestOrBuilderpublic String getParent()
Required. The parent resource name, such as
`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getParent in interface PurgeDocumentsRequestOrBuilderpublic com.google.protobuf.ByteString getParentBytes()
Required. The parent resource name, such as
`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getParentBytes in interface PurgeDocumentsRequestOrBuilderpublic PurgeDocumentsRequest.Builder setParent(String value)
Required. The parent resource name, such as
`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
value - The parent to set.public PurgeDocumentsRequest.Builder clearParent()
Required. The parent resource name, such as
`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
public PurgeDocumentsRequest.Builder setParentBytes(com.google.protobuf.ByteString value)
Required. The parent resource name, such as
`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
value - The bytes for parent to set.public String getFilter()
Required. Filter matching documents to purge. Only currently supported value is `*` (all items).
string filter = 2 [(.google.api.field_behavior) = REQUIRED];getFilter in interface PurgeDocumentsRequestOrBuilderpublic com.google.protobuf.ByteString getFilterBytes()
Required. Filter matching documents to purge. Only currently supported value is `*` (all items).
string filter = 2 [(.google.api.field_behavior) = REQUIRED];getFilterBytes in interface PurgeDocumentsRequestOrBuilderpublic PurgeDocumentsRequest.Builder setFilter(String value)
Required. Filter matching documents to purge. Only currently supported value is `*` (all items).
string filter = 2 [(.google.api.field_behavior) = REQUIRED];value - The filter to set.public PurgeDocumentsRequest.Builder clearFilter()
Required. Filter matching documents to purge. Only currently supported value is `*` (all items).
string filter = 2 [(.google.api.field_behavior) = REQUIRED];public PurgeDocumentsRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)
Required. Filter matching documents to purge. Only currently supported value is `*` (all items).
string filter = 2 [(.google.api.field_behavior) = REQUIRED];value - The bytes for filter to set.public boolean hasErrorConfig()
The desired location of errors incurred during the purge.
.google.cloud.discoveryengine.v1alpha.PurgeErrorConfig error_config = 7;hasErrorConfig in interface PurgeDocumentsRequestOrBuilderpublic PurgeErrorConfig getErrorConfig()
The desired location of errors incurred during the purge.
.google.cloud.discoveryengine.v1alpha.PurgeErrorConfig error_config = 7;getErrorConfig in interface PurgeDocumentsRequestOrBuilderpublic PurgeDocumentsRequest.Builder setErrorConfig(PurgeErrorConfig value)
The desired location of errors incurred during the purge.
.google.cloud.discoveryengine.v1alpha.PurgeErrorConfig error_config = 7;public PurgeDocumentsRequest.Builder setErrorConfig(PurgeErrorConfig.Builder builderForValue)
The desired location of errors incurred during the purge.
.google.cloud.discoveryengine.v1alpha.PurgeErrorConfig error_config = 7;public PurgeDocumentsRequest.Builder mergeErrorConfig(PurgeErrorConfig value)
The desired location of errors incurred during the purge.
.google.cloud.discoveryengine.v1alpha.PurgeErrorConfig error_config = 7;public PurgeDocumentsRequest.Builder clearErrorConfig()
The desired location of errors incurred during the purge.
.google.cloud.discoveryengine.v1alpha.PurgeErrorConfig error_config = 7;public PurgeErrorConfig.Builder getErrorConfigBuilder()
The desired location of errors incurred during the purge.
.google.cloud.discoveryengine.v1alpha.PurgeErrorConfig error_config = 7;public PurgeErrorConfigOrBuilder getErrorConfigOrBuilder()
The desired location of errors incurred during the purge.
.google.cloud.discoveryengine.v1alpha.PurgeErrorConfig error_config = 7;getErrorConfigOrBuilder in interface PurgeDocumentsRequestOrBuilderpublic boolean getForce()
Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents.
bool force = 3;getForce in interface PurgeDocumentsRequestOrBuilderpublic PurgeDocumentsRequest.Builder setForce(boolean value)
Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents.
bool force = 3;value - The force to set.public PurgeDocumentsRequest.Builder clearForce()
Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents.
bool force = 3;public final PurgeDocumentsRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeDocumentsRequest.Builder>public final PurgeDocumentsRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PurgeDocumentsRequest.Builder>Copyright © 2024 Google LLC. All rights reserved.