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

Static 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
Overrides

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
Overrides

clearField(Descriptors.FieldDescriptor field)

public PurgeDocumentsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
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
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.

clearOneof(Descriptors.OneofDescriptor oneof)

public PurgeDocumentsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
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
Type Description
PurgeDocumentsRequest.Builder

This builder for chaining.

clone()

public PurgeDocumentsRequest.Builder clone()
Returns
Type Description
PurgeDocumentsRequest.Builder
Overrides

getDefaultInstanceForType()

public PurgeDocumentsRequest getDefaultInstanceForType()
Returns
Type Description
PurgeDocumentsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public PurgeDocumentsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
PurgeDocumentsRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PurgeDocumentsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PurgeDocumentsRequest.Builder
Overrides

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
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
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.

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
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final PurgeDocumentsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PurgeDocumentsRequest.Builder
Overrides