Class PurgeDocumentsResponse.Builder (0.40.0)

public static final class PurgeDocumentsResponse.Builder extends GeneratedMessageV3.Builder<PurgeDocumentsResponse.Builder> implements PurgeDocumentsResponseOrBuilder

Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.

Protobuf type google.cloud.discoveryengine.v1.PurgeDocumentsResponse

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllPurgeSample(Iterable<String> values)

public PurgeDocumentsResponse.Builder addAllPurgeSample(Iterable<String> values)

A sample of document names that will be deleted. Only populated if force is set to false. A max of 100 names will be returned and the names are chosen at random.

repeated string purge_sample = 2 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
values Iterable<String>

The purgeSample to add.

Returns
Type Description
PurgeDocumentsResponse.Builder

This builder for chaining.

addPurgeSample(String value)

public PurgeDocumentsResponse.Builder addPurgeSample(String value)

A sample of document names that will be deleted. Only populated if force is set to false. A max of 100 names will be returned and the names are chosen at random.

repeated string purge_sample = 2 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The purgeSample to add.

Returns
Type Description
PurgeDocumentsResponse.Builder

This builder for chaining.

addPurgeSampleBytes(ByteString value)

public PurgeDocumentsResponse.Builder addPurgeSampleBytes(ByteString value)

A sample of document names that will be deleted. Only populated if force is set to false. A max of 100 names will be returned and the names are chosen at random.

repeated string purge_sample = 2 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes of the purgeSample to add.

Returns
Type Description
PurgeDocumentsResponse.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PurgeDocumentsResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PurgeDocumentsResponse.Builder
Overrides

build()

public PurgeDocumentsResponse build()
Returns
Type Description
PurgeDocumentsResponse

buildPartial()

public PurgeDocumentsResponse buildPartial()
Returns
Type Description
PurgeDocumentsResponse

clear()

public PurgeDocumentsResponse.Builder clear()
Returns
Type Description
PurgeDocumentsResponse.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public PurgeDocumentsResponse.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
PurgeDocumentsResponse.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public PurgeDocumentsResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
PurgeDocumentsResponse.Builder
Overrides

clearPurgeCount()

public PurgeDocumentsResponse.Builder clearPurgeCount()

The total count of documents purged as a result of the operation.

int64 purge_count = 1;

Returns
Type Description
PurgeDocumentsResponse.Builder

This builder for chaining.

clearPurgeSample()

public PurgeDocumentsResponse.Builder clearPurgeSample()

A sample of document names that will be deleted. Only populated if force is set to false. A max of 100 names will be returned and the names are chosen at random.

repeated string purge_sample = 2 [(.google.api.resource_reference) = { ... }

Returns
Type Description
PurgeDocumentsResponse.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public PurgeDocumentsResponse getDefaultInstanceForType()
Returns
Type Description
PurgeDocumentsResponse

getDescriptorForType()

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

getPurgeCount()

public long getPurgeCount()

The total count of documents purged as a result of the operation.

int64 purge_count = 1;

Returns
Type Description
long

The purgeCount.

getPurgeSample(int index)

public String getPurgeSample(int index)

A sample of document names that will be deleted. Only populated if force is set to false. A max of 100 names will be returned and the names are chosen at random.

repeated string purge_sample = 2 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The purgeSample at the given index.

getPurgeSampleBytes(int index)

public ByteString getPurgeSampleBytes(int index)

A sample of document names that will be deleted. Only populated if force is set to false. A max of 100 names will be returned and the names are chosen at random.

repeated string purge_sample = 2 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the purgeSample at the given index.

getPurgeSampleCount()

public int getPurgeSampleCount()

A sample of document names that will be deleted. Only populated if force is set to false. A max of 100 names will be returned and the names are chosen at random.

repeated string purge_sample = 2 [(.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of purgeSample.

getPurgeSampleList()

public ProtocolStringList getPurgeSampleList()

A sample of document names that will be deleted. Only populated if force is set to false. A max of 100 names will be returned and the names are chosen at random.

repeated string purge_sample = 2 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the purgeSample.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(PurgeDocumentsResponse other)

public PurgeDocumentsResponse.Builder mergeFrom(PurgeDocumentsResponse other)
Parameter
Name Description
other PurgeDocumentsResponse
Returns
Type Description
PurgeDocumentsResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PurgeDocumentsResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PurgeDocumentsResponse.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

public PurgeDocumentsResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PurgeDocumentsResponse.Builder
Overrides

setPurgeCount(long value)

public PurgeDocumentsResponse.Builder setPurgeCount(long value)

The total count of documents purged as a result of the operation.

int64 purge_count = 1;

Parameter
Name Description
value long

The purgeCount to set.

Returns
Type Description
PurgeDocumentsResponse.Builder

This builder for chaining.

setPurgeSample(int index, String value)

public PurgeDocumentsResponse.Builder setPurgeSample(int index, String value)

A sample of document names that will be deleted. Only populated if force is set to false. A max of 100 names will be returned and the names are chosen at random.

repeated string purge_sample = 2 [(.google.api.resource_reference) = { ... }

Parameters
Name Description
index int

The index to set the value at.

value String

The purgeSample to set.

Returns
Type Description
PurgeDocumentsResponse.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public PurgeDocumentsResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
PurgeDocumentsResponse.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

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