Class PurgeDocumentsRequest.Builder (0.35.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.v1alpha.PurgeDocumentsRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PurgeDocumentsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PurgeDocumentsRequest.Builder
Overrides

build()

public PurgeDocumentsRequest build()
Returns
TypeDescription
PurgeDocumentsRequest

buildPartial()

public PurgeDocumentsRequest buildPartial()
Returns
TypeDescription
PurgeDocumentsRequest

clear()

public PurgeDocumentsRequest.Builder clear()
Returns
TypeDescription
PurgeDocumentsRequest.Builder
Overrides

clearErrorConfig()

public PurgeDocumentsRequest.Builder clearErrorConfig()

The desired location of errors incurred during the purge.

.google.cloud.discoveryengine.v1alpha.PurgeErrorConfig error_config = 7;

Returns
TypeDescription
PurgeDocumentsRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public PurgeDocumentsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
PurgeDocumentsRequest.Builder
Overrides

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
TypeDescription
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
TypeDescription
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.v1alpha.GcsSource gcs_source = 5;

Returns
TypeDescription
PurgeDocumentsRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public PurgeDocumentsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
PurgeDocumentsRequest.Builder
Overrides

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
TypeDescription
PurgeDocumentsRequest.Builder

This builder for chaining.

clearSource()

public PurgeDocumentsRequest.Builder clearSource()
Returns
TypeDescription
PurgeDocumentsRequest.Builder

clone()

public PurgeDocumentsRequest.Builder clone()
Returns
TypeDescription
PurgeDocumentsRequest.Builder
Overrides

getDefaultInstanceForType()

public PurgeDocumentsRequest getDefaultInstanceForType()
Returns
TypeDescription
PurgeDocumentsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getErrorConfig()

public PurgeErrorConfig getErrorConfig()

The desired location of errors incurred during the purge.

.google.cloud.discoveryengine.v1alpha.PurgeErrorConfig error_config = 7;

Returns
TypeDescription
PurgeErrorConfig

The errorConfig.

getErrorConfigBuilder()

public PurgeErrorConfig.Builder getErrorConfigBuilder()

The desired location of errors incurred during the purge.

.google.cloud.discoveryengine.v1alpha.PurgeErrorConfig error_config = 7;

Returns
TypeDescription
PurgeErrorConfig.Builder

getErrorConfigOrBuilder()

public PurgeErrorConfigOrBuilder getErrorConfigOrBuilder()

The desired location of errors incurred during the purge.

.google.cloud.discoveryengine.v1alpha.PurgeErrorConfig error_config = 7;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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.v1alpha.GcsSource gcs_source = 5;

Returns
TypeDescription
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.v1alpha.GcsSource gcs_source = 5;

Returns
TypeDescription
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.v1alpha.GcsSource gcs_source = 5;

Returns
TypeDescription
GcsSourceOrBuilder

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
TypeDescription
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
TypeDescription
ByteString

The bytes for parent.

getSourceCase()

public PurgeDocumentsRequest.SourceCase getSourceCase()
Returns
TypeDescription
PurgeDocumentsRequest.SourceCase

hasErrorConfig()

public boolean hasErrorConfig()

The desired location of errors incurred during the purge.

.google.cloud.discoveryengine.v1alpha.PurgeErrorConfig error_config = 7;

Returns
TypeDescription
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.v1alpha.GcsSource gcs_source = 5;

Returns
TypeDescription
boolean

Whether the gcsSource field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeErrorConfig(PurgeErrorConfig value)

public PurgeDocumentsRequest.Builder mergeErrorConfig(PurgeErrorConfig value)

The desired location of errors incurred during the purge.

.google.cloud.discoveryengine.v1alpha.PurgeErrorConfig error_config = 7;

Parameter
NameDescription
valuePurgeErrorConfig
Returns
TypeDescription
PurgeDocumentsRequest.Builder

mergeFrom(PurgeDocumentsRequest other)

public PurgeDocumentsRequest.Builder mergeFrom(PurgeDocumentsRequest other)
Parameter
NameDescription
otherPurgeDocumentsRequest
Returns
TypeDescription
PurgeDocumentsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PurgeDocumentsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PurgeDocumentsRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public PurgeDocumentsRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
PurgeDocumentsRequest.Builder
Overrides

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.v1alpha.GcsSource gcs_source = 5;

Parameter
NameDescription
valueGcsSource
Returns
TypeDescription
PurgeDocumentsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PurgeDocumentsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PurgeDocumentsRequest.Builder
Overrides

setErrorConfig(PurgeErrorConfig value)

public PurgeDocumentsRequest.Builder setErrorConfig(PurgeErrorConfig value)

The desired location of errors incurred during the purge.

.google.cloud.discoveryengine.v1alpha.PurgeErrorConfig error_config = 7;

Parameter
NameDescription
valuePurgeErrorConfig
Returns
TypeDescription
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.v1alpha.PurgeErrorConfig error_config = 7;

Parameter
NameDescription
builderForValuePurgeErrorConfig.Builder
Returns
TypeDescription
PurgeDocumentsRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public PurgeDocumentsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PurgeDocumentsRequest.Builder
Overrides

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
NameDescription
valueString

The filter to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
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
NameDescription
valueboolean

The force to set.

Returns
TypeDescription
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.v1alpha.GcsSource gcs_source = 5;

Parameter
NameDescription
valueGcsSource
Returns
TypeDescription
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.v1alpha.GcsSource gcs_source = 5;

Parameter
NameDescription
builderForValueGcsSource.Builder
Returns
TypeDescription
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
NameDescription
valueString

The parent to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
PurgeDocumentsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final PurgeDocumentsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PurgeDocumentsRequest.Builder
Overrides