Class BatchOperationMetadata (2.4.4)

Stay organized with collections Save and categorize content based on your preferences.
public final class BatchOperationMetadata extends GeneratedMessageV3 implements BatchOperationMetadataOrBuilder

Metadata used for long running operations returned by CTS batch APIs. It's used to replace google.longrunning.Operation.metadata.

Protobuf type google.cloud.talent.v4.BatchOperationMetadata

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

FAILURE_COUNT_FIELD_NUMBER

public static final int FAILURE_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_DESCRIPTION_FIELD_NUMBER

public static final int STATE_DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

SUCCESS_COUNT_FIELD_NUMBER

public static final int SUCCESS_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

TOTAL_COUNT_FIELD_NUMBER

public static final int TOTAL_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 BatchOperationMetadata getDefaultInstance()
Returns
TypeDescription
BatchOperationMetadata

getDescriptor()

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

newBuilder()

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

newBuilder(BatchOperationMetadata prototype)

public static BatchOperationMetadata.Builder newBuilder(BatchOperationMetadata prototype)
Parameter
NameDescription
prototypeBatchOperationMetadata
Returns
TypeDescription
BatchOperationMetadata.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCreateTime()

public Timestamp getCreateTime()

The time when the batch operation is created.

.google.protobuf.Timestamp create_time = 6;

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

The time when the batch operation is created.

.google.protobuf.Timestamp create_time = 6;

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public BatchOperationMetadata getDefaultInstanceForType()
Returns
TypeDescription
BatchOperationMetadata

getEndTime()

public Timestamp getEndTime()

The time when the batch operation is finished and google.longrunning.Operation.done is set to true.

.google.protobuf.Timestamp end_time = 8;

Returns
TypeDescription
Timestamp

The endTime.

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

The time when the batch operation is finished and google.longrunning.Operation.done is set to true.

.google.protobuf.Timestamp end_time = 8;

Returns
TypeDescription
TimestampOrBuilder

getFailureCount()

public int getFailureCount()

Count of failed item(s) inside an operation.

int32 failure_count = 4;

Returns
TypeDescription
int

The failureCount.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getState()

public BatchOperationMetadata.State getState()

The state of a long running operation.

.google.cloud.talent.v4.BatchOperationMetadata.State state = 1;

Returns
TypeDescription
BatchOperationMetadata.State

The state.

getStateDescription()

public String getStateDescription()

More detailed information about operation state.

string state_description = 2;

Returns
TypeDescription
String

The stateDescription.

getStateDescriptionBytes()

public ByteString getStateDescriptionBytes()

More detailed information about operation state.

string state_description = 2;

Returns
TypeDescription
ByteString

The bytes for stateDescription.

getStateValue()

public int getStateValue()

The state of a long running operation.

.google.cloud.talent.v4.BatchOperationMetadata.State state = 1;

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getSuccessCount()

public int getSuccessCount()

Count of successful item(s) inside an operation.

int32 success_count = 3;

Returns
TypeDescription
int

The successCount.

getTotalCount()

public int getTotalCount()

Count of total item(s) inside an operation.

int32 total_count = 5;

Returns
TypeDescription
int

The totalCount.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

The time when the batch operation status is updated. The metadata and the update_time is refreshed every minute otherwise cached data is returned.

.google.protobuf.Timestamp update_time = 7;

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

The time when the batch operation status is updated. The metadata and the update_time is refreshed every minute otherwise cached data is returned.

.google.protobuf.Timestamp update_time = 7;

Returns
TypeDescription
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

The time when the batch operation is created.

.google.protobuf.Timestamp create_time = 6;

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasEndTime()

public boolean hasEndTime()

The time when the batch operation is finished and google.longrunning.Operation.done is set to true.

.google.protobuf.Timestamp end_time = 8;

Returns
TypeDescription
boolean

Whether the endTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

The time when the batch operation status is updated. The metadata and the update_time is refreshed every minute otherwise cached data is returned.

.google.protobuf.Timestamp update_time = 7;

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 BatchOperationMetadata.Builder newBuilderForType()
Returns
TypeDescription
BatchOperationMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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