Class BatchOperationMetadata (2.28.0)

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > BatchOperationMetadata

Implements

BatchOperationMetadataOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

Field Value
Type	Description
`int`

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER

Field Value
Type	Description
`int`

FAILURE_COUNT_FIELD_NUMBER

public static final int FAILURE_COUNT_FIELD_NUMBER

Field Value
Type	Description
`int`

STATE_DESCRIPTION_FIELD_NUMBER

public static final int STATE_DESCRIPTION_FIELD_NUMBER

Field Value
Type	Description
`int`

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER

Field Value
Type	Description
`int`

SUCCESS_COUNT_FIELD_NUMBER

public static final int SUCCESS_COUNT_FIELD_NUMBER

Field Value
Type	Description
`int`

TOTAL_COUNT_FIELD_NUMBER

public static final int TOTAL_COUNT_FIELD_NUMBER

Field Value
Type	Description
`int`

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static BatchOperationMetadata getDefaultInstance()

Returns
Type	Description
`BatchOperationMetadata`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static BatchOperationMetadata.Builder newBuilder()

Returns
Type	Description
`BatchOperationMetadata.Builder`

newBuilder(BatchOperationMetadata prototype)

public static BatchOperationMetadata.Builder newBuilder(BatchOperationMetadata prototype)

Parameter
Name	Description
`prototype`	`BatchOperationMetadata`

Returns
Type	Description
`BatchOperationMetadata.Builder`

parseDelimitedFrom(InputStream input)

public static BatchOperationMetadata parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`BatchOperationMetadata`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchOperationMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`BatchOperationMetadata`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static BatchOperationMetadata parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`BatchOperationMetadata`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BatchOperationMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`BatchOperationMetadata`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static BatchOperationMetadata parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`BatchOperationMetadata`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BatchOperationMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`BatchOperationMetadata`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static BatchOperationMetadata parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`BatchOperationMetadata`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchOperationMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`BatchOperationMetadata`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static BatchOperationMetadata parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`BatchOperationMetadata`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BatchOperationMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`BatchOperationMetadata`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static BatchOperationMetadata parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`BatchOperationMetadata`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BatchOperationMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`BatchOperationMetadata`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<BatchOperationMetadata> parser()

Returns
Type	Description
`Parser<BatchOperationMetadata>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getCreateTime()

public Timestamp getCreateTime()

The time when the batch operation is created.

.google.protobuf.Timestamp create_time = 6;

Returns
Type	Description
`Timestamp`	The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

The time when the batch operation is created.

.google.protobuf.Timestamp create_time = 6;

Returns
Type	Description
`TimestampOrBuilder`

getDefaultInstanceForType()

public BatchOperationMetadata getDefaultInstanceForType()

Returns
Type	Description
`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
Type	Description
`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
Type	Description
`TimestampOrBuilder`

getFailureCount()

public int getFailureCount()

Count of failed item(s) inside an operation.

int32 failure_count = 4;

Returns
Type	Description
`int`	The failureCount.

getParserForType()

public Parser<BatchOperationMetadata> getParserForType()

Returns
Type	Description
`Parser<BatchOperationMetadata>`

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

getState()

public BatchOperationMetadata.State getState()

The state of a long running operation.

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

Returns
Type	Description
`BatchOperationMetadata.State`	The state.

getStateDescription()

public String getStateDescription()

More detailed information about operation state.

string state_description = 2;

Returns
Type	Description
`String`	The stateDescription.

getStateDescriptionBytes()

public ByteString getStateDescriptionBytes()

More detailed information about operation state.

string state_description = 2;

Returns
Type	Description
`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
Type	Description
`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
Type	Description
`int`	The successCount.

getTotalCount()

public int getTotalCount()

Count of total item(s) inside an operation.

int32 total_count = 5;

Returns
Type	Description
`int`	The totalCount.

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
Type	Description
`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
Type	Description
`TimestampOrBuilder`

hasCreateTime()

public boolean hasCreateTime()

The time when the batch operation is created.

.google.protobuf.Timestamp create_time = 6;

Returns
Type	Description
`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
Type	Description
`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
Type	Description
`boolean`	Whether the updateTime field is set.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public BatchOperationMetadata.Builder newBuilderForType()

Returns
Type	Description
`BatchOperationMetadata.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BatchOperationMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`BatchOperationMetadata.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public BatchOperationMetadata.Builder toBuilder()

Returns
Type	Description
`BatchOperationMetadata.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`