Class BatchOperationMetadata.Builder (2.17.0)

public static final class BatchOperationMetadata.Builder extends GeneratedMessageV3.Builder<BatchOperationMetadata.Builder> 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 Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BatchOperationMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
BatchOperationMetadata.Builder
Overrides

build()

public BatchOperationMetadata build()
Returns
TypeDescription
BatchOperationMetadata

buildPartial()

public BatchOperationMetadata buildPartial()
Returns
TypeDescription
BatchOperationMetadata

clear()

public BatchOperationMetadata.Builder clear()
Returns
TypeDescription
BatchOperationMetadata.Builder
Overrides

clearCreateTime()

public BatchOperationMetadata.Builder clearCreateTime()

The time when the batch operation is created.

.google.protobuf.Timestamp create_time = 6;

Returns
TypeDescription
BatchOperationMetadata.Builder

clearEndTime()

public BatchOperationMetadata.Builder clearEndTime()

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
BatchOperationMetadata.Builder

clearFailureCount()

public BatchOperationMetadata.Builder clearFailureCount()

Count of failed item(s) inside an operation.

int32 failure_count = 4;

Returns
TypeDescription
BatchOperationMetadata.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public BatchOperationMetadata.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
BatchOperationMetadata.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public BatchOperationMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
BatchOperationMetadata.Builder
Overrides

clearState()

public BatchOperationMetadata.Builder clearState()

The state of a long running operation.

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

Returns
TypeDescription
BatchOperationMetadata.Builder

This builder for chaining.

clearStateDescription()

public BatchOperationMetadata.Builder clearStateDescription()

More detailed information about operation state.

string state_description = 2;

Returns
TypeDescription
BatchOperationMetadata.Builder

This builder for chaining.

clearSuccessCount()

public BatchOperationMetadata.Builder clearSuccessCount()

Count of successful item(s) inside an operation.

int32 success_count = 3;

Returns
TypeDescription
BatchOperationMetadata.Builder

This builder for chaining.

clearTotalCount()

public BatchOperationMetadata.Builder clearTotalCount()

Count of total item(s) inside an operation.

int32 total_count = 5;

Returns
TypeDescription
BatchOperationMetadata.Builder

This builder for chaining.

clearUpdateTime()

public BatchOperationMetadata.Builder clearUpdateTime()

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
BatchOperationMetadata.Builder

clone()

public BatchOperationMetadata.Builder clone()
Returns
TypeDescription
BatchOperationMetadata.Builder
Overrides

getCreateTime()

public Timestamp getCreateTime()

The time when the batch operation is created.

.google.protobuf.Timestamp create_time = 6;

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

The time when the batch operation is created.

.google.protobuf.Timestamp create_time = 6;

Returns
TypeDescription
Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

getEndTimeBuilder()

public Timestamp.Builder getEndTimeBuilder()

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
Builder

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.

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.

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.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

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
Builder

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeCreateTime(Timestamp value)

public BatchOperationMetadata.Builder mergeCreateTime(Timestamp value)

The time when the batch operation is created.

.google.protobuf.Timestamp create_time = 6;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
BatchOperationMetadata.Builder

mergeEndTime(Timestamp value)

public BatchOperationMetadata.Builder mergeEndTime(Timestamp value)

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

.google.protobuf.Timestamp end_time = 8;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
BatchOperationMetadata.Builder

mergeFrom(BatchOperationMetadata other)

public BatchOperationMetadata.Builder mergeFrom(BatchOperationMetadata other)
Parameter
NameDescription
otherBatchOperationMetadata
Returns
TypeDescription
BatchOperationMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BatchOperationMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BatchOperationMetadata.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public BatchOperationMetadata.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
BatchOperationMetadata.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BatchOperationMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
BatchOperationMetadata.Builder
Overrides

mergeUpdateTime(Timestamp value)

public BatchOperationMetadata.Builder mergeUpdateTime(Timestamp value)

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;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
BatchOperationMetadata.Builder

setCreateTime(Timestamp value)

public BatchOperationMetadata.Builder setCreateTime(Timestamp value)

The time when the batch operation is created.

.google.protobuf.Timestamp create_time = 6;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
BatchOperationMetadata.Builder

setCreateTime(Timestamp.Builder builderForValue)

public BatchOperationMetadata.Builder setCreateTime(Timestamp.Builder builderForValue)

The time when the batch operation is created.

.google.protobuf.Timestamp create_time = 6;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
BatchOperationMetadata.Builder

setEndTime(Timestamp value)

public BatchOperationMetadata.Builder setEndTime(Timestamp value)

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

.google.protobuf.Timestamp end_time = 8;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
BatchOperationMetadata.Builder

setEndTime(Timestamp.Builder builderForValue)

public BatchOperationMetadata.Builder setEndTime(Timestamp.Builder builderForValue)

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

.google.protobuf.Timestamp end_time = 8;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
BatchOperationMetadata.Builder

setFailureCount(int value)

public BatchOperationMetadata.Builder setFailureCount(int value)

Count of failed item(s) inside an operation.

int32 failure_count = 4;

Parameter
NameDescription
valueint

The failureCount to set.

Returns
TypeDescription
BatchOperationMetadata.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public BatchOperationMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
BatchOperationMetadata.Builder
Overrides

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

public BatchOperationMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
BatchOperationMetadata.Builder
Overrides

setState(BatchOperationMetadata.State value)

public BatchOperationMetadata.Builder setState(BatchOperationMetadata.State value)

The state of a long running operation.

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

Parameter
NameDescription
valueBatchOperationMetadata.State

The state to set.

Returns
TypeDescription
BatchOperationMetadata.Builder

This builder for chaining.

setStateDescription(String value)

public BatchOperationMetadata.Builder setStateDescription(String value)

More detailed information about operation state.

string state_description = 2;

Parameter
NameDescription
valueString

The stateDescription to set.

Returns
TypeDescription
BatchOperationMetadata.Builder

This builder for chaining.

setStateDescriptionBytes(ByteString value)

public BatchOperationMetadata.Builder setStateDescriptionBytes(ByteString value)

More detailed information about operation state.

string state_description = 2;

Parameter
NameDescription
valueByteString

The bytes for stateDescription to set.

Returns
TypeDescription
BatchOperationMetadata.Builder

This builder for chaining.

setStateValue(int value)

public BatchOperationMetadata.Builder setStateValue(int value)

The state of a long running operation.

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

Parameter
NameDescription
valueint

The enum numeric value on the wire for state to set.

Returns
TypeDescription
BatchOperationMetadata.Builder

This builder for chaining.

setSuccessCount(int value)

public BatchOperationMetadata.Builder setSuccessCount(int value)

Count of successful item(s) inside an operation.

int32 success_count = 3;

Parameter
NameDescription
valueint

The successCount to set.

Returns
TypeDescription
BatchOperationMetadata.Builder

This builder for chaining.

setTotalCount(int value)

public BatchOperationMetadata.Builder setTotalCount(int value)

Count of total item(s) inside an operation.

int32 total_count = 5;

Parameter
NameDescription
valueint

The totalCount to set.

Returns
TypeDescription
BatchOperationMetadata.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final BatchOperationMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
BatchOperationMetadata.Builder
Overrides

setUpdateTime(Timestamp value)

public BatchOperationMetadata.Builder setUpdateTime(Timestamp value)

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;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
BatchOperationMetadata.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public BatchOperationMetadata.Builder setUpdateTime(Timestamp.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
BatchOperationMetadata.Builder