Class PurgeDocumentsMetadata (0.25.0)

public final class PurgeDocumentsMetadata extends GeneratedMessageV3 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.v1alpha.PurgeDocumentsMetadata

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

FAILURE_COUNT_FIELD_NUMBER

public static final int FAILURE_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

SUCCESS_COUNT_FIELD_NUMBER

public static final int SUCCESS_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static PurgeDocumentsMetadata getDefaultInstance()
Returns
TypeDescription
PurgeDocumentsMetadata

getDescriptor()

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

newBuilder()

public static PurgeDocumentsMetadata.Builder newBuilder()
Returns
TypeDescription
PurgeDocumentsMetadata.Builder

newBuilder(PurgeDocumentsMetadata prototype)

public static PurgeDocumentsMetadata.Builder newBuilder(PurgeDocumentsMetadata prototype)
Parameter
NameDescription
prototypePurgeDocumentsMetadata
Returns
TypeDescription
PurgeDocumentsMetadata.Builder

parseDelimitedFrom(InputStream input)

public static PurgeDocumentsMetadata parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PurgeDocumentsMetadata
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PurgeDocumentsMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PurgeDocumentsMetadata
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static PurgeDocumentsMetadata parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
PurgeDocumentsMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PurgeDocumentsMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PurgeDocumentsMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PurgeDocumentsMetadata parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
PurgeDocumentsMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PurgeDocumentsMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PurgeDocumentsMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PurgeDocumentsMetadata parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
PurgeDocumentsMetadata
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PurgeDocumentsMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PurgeDocumentsMetadata
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static PurgeDocumentsMetadata parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PurgeDocumentsMetadata
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PurgeDocumentsMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PurgeDocumentsMetadata
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static PurgeDocumentsMetadata parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
PurgeDocumentsMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PurgeDocumentsMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PurgeDocumentsMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<PurgeDocumentsMetadata> parser()
Returns
TypeDescription
Parser<PurgeDocumentsMetadata>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCreateTime()

public Timestamp getCreateTime()

Operation create time.

.google.protobuf.Timestamp create_time = 1;

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Operation create time.

.google.protobuf.Timestamp create_time = 1;

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public PurgeDocumentsMetadata getDefaultInstanceForType()
Returns
TypeDescription
PurgeDocumentsMetadata

getFailureCount()

public long getFailureCount()

Count of entries that encountered errors while processing.

int64 failure_count = 4;

Returns
TypeDescription
long

The failureCount.

getParserForType()

public Parser<PurgeDocumentsMetadata> getParserForType()
Returns
TypeDescription
Parser<PurgeDocumentsMetadata>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSuccessCount()

public long getSuccessCount()

Count of entries that were deleted successfully.

int64 success_count = 3;

Returns
TypeDescription
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
TypeDescription
Timestamp

The updateTime.

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

hasCreateTime()

public boolean hasCreateTime()

Operation create time.

.google.protobuf.Timestamp create_time = 1;

Returns
TypeDescription
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
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public PurgeDocumentsMetadata.Builder newBuilderForType()
Returns
TypeDescription
PurgeDocumentsMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PurgeDocumentsMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
PurgeDocumentsMetadata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public PurgeDocumentsMetadata.Builder toBuilder()
Returns
TypeDescription
PurgeDocumentsMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException