Class PurgeDocumentsMetadata.Builder (0.40.0)

public static final class PurgeDocumentsMetadata.Builder extends GeneratedMessageV3.Builder<PurgeDocumentsMetadata.Builder> implements PurgeDocumentsMetadataOrBuilder

Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.

Protobuf type google.cloud.discoveryengine.v1.PurgeDocumentsMetadata

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public PurgeDocumentsMetadata build()
Returns
Type Description
PurgeDocumentsMetadata

buildPartial()

public PurgeDocumentsMetadata buildPartial()
Returns
Type Description
PurgeDocumentsMetadata

clear()

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

clearCreateTime()

public PurgeDocumentsMetadata.Builder clearCreateTime()

Operation create time.

.google.protobuf.Timestamp create_time = 1;

Returns
Type Description
PurgeDocumentsMetadata.Builder

clearFailureCount()

public PurgeDocumentsMetadata.Builder clearFailureCount()

Count of entries that encountered errors while processing.

int64 failure_count = 4;

Returns
Type Description
PurgeDocumentsMetadata.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearIgnoredCount()

public PurgeDocumentsMetadata.Builder clearIgnoredCount()

Count of entries that were ignored as entries were not found.

int64 ignored_count = 5;

Returns
Type Description
PurgeDocumentsMetadata.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearSuccessCount()

public PurgeDocumentsMetadata.Builder clearSuccessCount()

Count of entries that were deleted successfully.

int64 success_count = 3;

Returns
Type Description
PurgeDocumentsMetadata.Builder

This builder for chaining.

clearUpdateTime()

public PurgeDocumentsMetadata.Builder clearUpdateTime()

Operation last update time. If the operation is done, this is also the finish time.

.google.protobuf.Timestamp update_time = 2;

Returns
Type Description
PurgeDocumentsMetadata.Builder

clone()

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

getCreateTime()

public Timestamp getCreateTime()

Operation create time.

.google.protobuf.Timestamp create_time = 1;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Operation create time.

.google.protobuf.Timestamp create_time = 1;

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Operation create time.

.google.protobuf.Timestamp create_time = 1;

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public PurgeDocumentsMetadata getDefaultInstanceForType()
Returns
Type Description
PurgeDocumentsMetadata

getDescriptorForType()

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

getFailureCount()

public long getFailureCount()

Count of entries that encountered errors while processing.

int64 failure_count = 4;

Returns
Type Description
long

The failureCount.

getIgnoredCount()

public long getIgnoredCount()

Count of entries that were ignored as entries were not found.

int64 ignored_count = 5;

Returns
Type Description
long

The ignoredCount.

getSuccessCount()

public long getSuccessCount()

Count of entries that were deleted successfully.

int64 success_count = 3;

Returns
Type Description
long

The successCount.

getUpdateTime()

public Timestamp getUpdateTime()

Operation last update time. If the operation is done, this is also the finish time.

.google.protobuf.Timestamp update_time = 2;

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Operation last update time. If the operation is done, this is also the finish time.

.google.protobuf.Timestamp update_time = 2;

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Operation last update time. If the operation is done, this is also the finish time.

.google.protobuf.Timestamp update_time = 2;

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Operation create time.

.google.protobuf.Timestamp create_time = 1;

Returns
Type Description
boolean

Whether the createTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Operation last update time. If the operation is done, this is also the finish time.

.google.protobuf.Timestamp update_time = 2;

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public PurgeDocumentsMetadata.Builder mergeCreateTime(Timestamp value)

Operation create time.

.google.protobuf.Timestamp create_time = 1;

Parameter
Name Description
value Timestamp
Returns
Type Description
PurgeDocumentsMetadata.Builder

mergeFrom(PurgeDocumentsMetadata other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

mergeUpdateTime(Timestamp value)

public PurgeDocumentsMetadata.Builder mergeUpdateTime(Timestamp value)

Operation last update time. If the operation is done, this is also the finish time.

.google.protobuf.Timestamp update_time = 2;

Parameter
Name Description
value Timestamp
Returns
Type Description
PurgeDocumentsMetadata.Builder

setCreateTime(Timestamp value)

public PurgeDocumentsMetadata.Builder setCreateTime(Timestamp value)

Operation create time.

.google.protobuf.Timestamp create_time = 1;

Parameter
Name Description
value Timestamp
Returns
Type Description
PurgeDocumentsMetadata.Builder

setCreateTime(Timestamp.Builder builderForValue)

public PurgeDocumentsMetadata.Builder setCreateTime(Timestamp.Builder builderForValue)

Operation create time.

.google.protobuf.Timestamp create_time = 1;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
PurgeDocumentsMetadata.Builder

setFailureCount(long value)

public PurgeDocumentsMetadata.Builder setFailureCount(long value)

Count of entries that encountered errors while processing.

int64 failure_count = 4;

Parameter
Name Description
value long

The failureCount to set.

Returns
Type Description
PurgeDocumentsMetadata.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setIgnoredCount(long value)

public PurgeDocumentsMetadata.Builder setIgnoredCount(long value)

Count of entries that were ignored as entries were not found.

int64 ignored_count = 5;

Parameter
Name Description
value long

The ignoredCount to set.

Returns
Type Description
PurgeDocumentsMetadata.Builder

This builder for chaining.

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

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

setSuccessCount(long value)

public PurgeDocumentsMetadata.Builder setSuccessCount(long value)

Count of entries that were deleted successfully.

int64 success_count = 3;

Parameter
Name Description
value long

The successCount to set.

Returns
Type Description
PurgeDocumentsMetadata.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

setUpdateTime(Timestamp value)

public PurgeDocumentsMetadata.Builder setUpdateTime(Timestamp value)

Operation last update time. If the operation is done, this is also the finish time.

.google.protobuf.Timestamp update_time = 2;

Parameter
Name Description
value Timestamp
Returns
Type Description
PurgeDocumentsMetadata.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public PurgeDocumentsMetadata.Builder setUpdateTime(Timestamp.Builder builderForValue)

Operation last update time. If the operation is done, this is also the finish time.

.google.protobuf.Timestamp update_time = 2;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
PurgeDocumentsMetadata.Builder