- 0.50.0 (latest)
- 0.49.0
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public static final class PurgeDocumentsRequest.Builder extends GeneratedMessageV3.Builder<PurgeDocumentsRequest.Builder> implements PurgeDocumentsRequestOrBuilder
Request message for DocumentService.PurgeDocuments method.
Protobuf type google.cloud.discoveryengine.v1.PurgeDocumentsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PurgeDocumentsRequest.BuilderImplements
PurgeDocumentsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PurgeDocumentsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest.Builder |
build()
public PurgeDocumentsRequest build()
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest |
buildPartial()
public PurgeDocumentsRequest buildPartial()
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest |
clear()
public PurgeDocumentsRequest.Builder clear()
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest.Builder |
clearErrorConfig()
public PurgeDocumentsRequest.Builder clearErrorConfig()
The desired location of errors incurred during the purge.
.google.cloud.discoveryengine.v1.PurgeErrorConfig error_config = 7;
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public PurgeDocumentsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest.Builder |
clearFilter()
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];
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest.Builder |
This builder for chaining. |
clearForce()
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;
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest.Builder |
This builder for chaining. |
clearGcsSource()
public PurgeDocumentsRequest.Builder clearGcsSource()
Cloud Storage location for the input content.
Supported data_schema
:
document_id
: One valid Document.id per line.
.google.cloud.discoveryengine.v1.GcsSource gcs_source = 5;
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest.Builder |
clearInlineSource()
public PurgeDocumentsRequest.Builder clearInlineSource()
Inline source for the input content for purge.
.google.cloud.discoveryengine.v1.PurgeDocumentsRequest.InlineSource inline_source = 6;
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public PurgeDocumentsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest.Builder |
clearParent()
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) = { ... }
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest.Builder |
This builder for chaining. |
clearSource()
public PurgeDocumentsRequest.Builder clearSource()
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest.Builder |
clone()
public PurgeDocumentsRequest.Builder clone()
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest.Builder |
getDefaultInstanceForType()
public PurgeDocumentsRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getErrorConfig()
public PurgeErrorConfig getErrorConfig()
The desired location of errors incurred during the purge.
.google.cloud.discoveryengine.v1.PurgeErrorConfig error_config = 7;
Returns | |
---|---|
Type | Description |
PurgeErrorConfig |
The errorConfig. |
getErrorConfigBuilder()
public PurgeErrorConfig.Builder getErrorConfigBuilder()
The desired location of errors incurred during the purge.
.google.cloud.discoveryengine.v1.PurgeErrorConfig error_config = 7;
Returns | |
---|---|
Type | Description |
PurgeErrorConfig.Builder |
getErrorConfigOrBuilder()
public PurgeErrorConfigOrBuilder getErrorConfigOrBuilder()
The desired location of errors incurred during the purge.
.google.cloud.discoveryengine.v1.PurgeErrorConfig error_config = 7;
Returns | |
---|---|
Type | Description |
PurgeErrorConfigOrBuilder |
getFilter()
public String getFilter()
Required. Filter matching documents to purge. Only currently supported
value is
*
(all items).
string filter = 2 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
String |
The filter. |
getFilterBytes()
public ByteString getFilterBytes()
Required. Filter matching documents to purge. Only currently supported
value is
*
(all items).
string filter = 2 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for filter. |
getForce()
public boolean getForce()
Actually performs the purge. If force
is set to false, return the
expected purge count without deleting any documents.
bool force = 3;
Returns | |
---|---|
Type | Description |
boolean |
The force. |
getGcsSource()
public GcsSource getGcsSource()
Cloud Storage location for the input content.
Supported data_schema
:
document_id
: One valid Document.id per line.
.google.cloud.discoveryengine.v1.GcsSource gcs_source = 5;
Returns | |
---|---|
Type | Description |
GcsSource |
The gcsSource. |
getGcsSourceBuilder()
public GcsSource.Builder getGcsSourceBuilder()
Cloud Storage location for the input content.
Supported data_schema
:
document_id
: One valid Document.id per line.
.google.cloud.discoveryengine.v1.GcsSource gcs_source = 5;
Returns | |
---|---|
Type | Description |
GcsSource.Builder |
getGcsSourceOrBuilder()
public GcsSourceOrBuilder getGcsSourceOrBuilder()
Cloud Storage location for the input content.
Supported data_schema
:
document_id
: One valid Document.id per line.
.google.cloud.discoveryengine.v1.GcsSource gcs_source = 5;
Returns | |
---|---|
Type | Description |
GcsSourceOrBuilder |
getInlineSource()
public PurgeDocumentsRequest.InlineSource getInlineSource()
Inline source for the input content for purge.
.google.cloud.discoveryengine.v1.PurgeDocumentsRequest.InlineSource inline_source = 6;
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest.InlineSource |
The inlineSource. |
getInlineSourceBuilder()
public PurgeDocumentsRequest.InlineSource.Builder getInlineSourceBuilder()
Inline source for the input content for purge.
.google.cloud.discoveryengine.v1.PurgeDocumentsRequest.InlineSource inline_source = 6;
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest.InlineSource.Builder |
getInlineSourceOrBuilder()
public PurgeDocumentsRequest.InlineSourceOrBuilder getInlineSourceOrBuilder()
Inline source for the input content for purge.
.google.cloud.discoveryengine.v1.PurgeDocumentsRequest.InlineSource inline_source = 6;
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest.InlineSourceOrBuilder |
getParent()
public 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) = { ... }
Returns | |
---|---|
Type | Description |
String |
The parent. |
getParentBytes()
public 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) = { ... }
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for parent. |
getSourceCase()
public PurgeDocumentsRequest.SourceCase getSourceCase()
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest.SourceCase |
hasErrorConfig()
public boolean hasErrorConfig()
The desired location of errors incurred during the purge.
.google.cloud.discoveryengine.v1.PurgeErrorConfig error_config = 7;
Returns | |
---|---|
Type | Description |
boolean |
Whether the errorConfig field is set. |
hasGcsSource()
public boolean hasGcsSource()
Cloud Storage location for the input content.
Supported data_schema
:
document_id
: One valid Document.id per line.
.google.cloud.discoveryengine.v1.GcsSource gcs_source = 5;
Returns | |
---|---|
Type | Description |
boolean |
Whether the gcsSource field is set. |
hasInlineSource()
public boolean hasInlineSource()
Inline source for the input content for purge.
.google.cloud.discoveryengine.v1.PurgeDocumentsRequest.InlineSource inline_source = 6;
Returns | |
---|---|
Type | Description |
boolean |
Whether the inlineSource field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeErrorConfig(PurgeErrorConfig value)
public PurgeDocumentsRequest.Builder mergeErrorConfig(PurgeErrorConfig value)
The desired location of errors incurred during the purge.
.google.cloud.discoveryengine.v1.PurgeErrorConfig error_config = 7;
Parameter | |
---|---|
Name | Description |
value |
PurgeErrorConfig |
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest.Builder |
mergeFrom(PurgeDocumentsRequest other)
public PurgeDocumentsRequest.Builder mergeFrom(PurgeDocumentsRequest other)
Parameter | |
---|---|
Name | Description |
other |
PurgeDocumentsRequest |
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public PurgeDocumentsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public PurgeDocumentsRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest.Builder |
mergeGcsSource(GcsSource value)
public PurgeDocumentsRequest.Builder mergeGcsSource(GcsSource value)
Cloud Storage location for the input content.
Supported data_schema
:
document_id
: One valid Document.id per line.
.google.cloud.discoveryengine.v1.GcsSource gcs_source = 5;
Parameter | |
---|---|
Name | Description |
value |
GcsSource |
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest.Builder |
mergeInlineSource(PurgeDocumentsRequest.InlineSource value)
public PurgeDocumentsRequest.Builder mergeInlineSource(PurgeDocumentsRequest.InlineSource value)
Inline source for the input content for purge.
.google.cloud.discoveryengine.v1.PurgeDocumentsRequest.InlineSource inline_source = 6;
Parameter | |
---|---|
Name | Description |
value |
PurgeDocumentsRequest.InlineSource |
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final PurgeDocumentsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest.Builder |
setErrorConfig(PurgeErrorConfig value)
public PurgeDocumentsRequest.Builder setErrorConfig(PurgeErrorConfig value)
The desired location of errors incurred during the purge.
.google.cloud.discoveryengine.v1.PurgeErrorConfig error_config = 7;
Parameter | |
---|---|
Name | Description |
value |
PurgeErrorConfig |
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest.Builder |
setErrorConfig(PurgeErrorConfig.Builder builderForValue)
public PurgeDocumentsRequest.Builder setErrorConfig(PurgeErrorConfig.Builder builderForValue)
The desired location of errors incurred during the purge.
.google.cloud.discoveryengine.v1.PurgeErrorConfig error_config = 7;
Parameter | |
---|---|
Name | Description |
builderForValue |
PurgeErrorConfig.Builder |
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public PurgeDocumentsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest.Builder |
setFilter(String value)
public 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];
Parameter | |
---|---|
Name | Description |
value |
String The filter to set. |
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest.Builder |
This builder for chaining. |
setFilterBytes(ByteString value)
public PurgeDocumentsRequest.Builder setFilterBytes(ByteString value)
Required. Filter matching documents to purge. Only currently supported
value is
*
(all items).
string filter = 2 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for filter to set. |
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest.Builder |
This builder for chaining. |
setForce(boolean value)
public 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;
Parameter | |
---|---|
Name | Description |
value |
boolean The force to set. |
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest.Builder |
This builder for chaining. |
setGcsSource(GcsSource value)
public PurgeDocumentsRequest.Builder setGcsSource(GcsSource value)
Cloud Storage location for the input content.
Supported data_schema
:
document_id
: One valid Document.id per line.
.google.cloud.discoveryengine.v1.GcsSource gcs_source = 5;
Parameter | |
---|---|
Name | Description |
value |
GcsSource |
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest.Builder |
setGcsSource(GcsSource.Builder builderForValue)
public PurgeDocumentsRequest.Builder setGcsSource(GcsSource.Builder builderForValue)
Cloud Storage location for the input content.
Supported data_schema
:
document_id
: One valid Document.id per line.
.google.cloud.discoveryengine.v1.GcsSource gcs_source = 5;
Parameter | |
---|---|
Name | Description |
builderForValue |
GcsSource.Builder |
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest.Builder |
setInlineSource(PurgeDocumentsRequest.InlineSource value)
public PurgeDocumentsRequest.Builder setInlineSource(PurgeDocumentsRequest.InlineSource value)
Inline source for the input content for purge.
.google.cloud.discoveryengine.v1.PurgeDocumentsRequest.InlineSource inline_source = 6;
Parameter | |
---|---|
Name | Description |
value |
PurgeDocumentsRequest.InlineSource |
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest.Builder |
setInlineSource(PurgeDocumentsRequest.InlineSource.Builder builderForValue)
public PurgeDocumentsRequest.Builder setInlineSource(PurgeDocumentsRequest.InlineSource.Builder builderForValue)
Inline source for the input content for purge.
.google.cloud.discoveryengine.v1.PurgeDocumentsRequest.InlineSource inline_source = 6;
Parameter | |
---|---|
Name | Description |
builderForValue |
PurgeDocumentsRequest.InlineSource.Builder |
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest.Builder |
setParent(String value)
public 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) = { ... }
Parameter | |
---|---|
Name | Description |
value |
String The parent to set. |
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public PurgeDocumentsRequest.Builder setParentBytes(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) = { ... }
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for parent to set. |
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public PurgeDocumentsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final PurgeDocumentsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
PurgeDocumentsRequest.Builder |