Class BatchOperationMetadata.Builder (2.84.0)

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

Static Methods

getDescriptor()

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

Methods

build()

public BatchOperationMetadata build()
Returns
Type Description
BatchOperationMetadata

buildPartial()

public BatchOperationMetadata buildPartial()
Returns
Type Description
BatchOperationMetadata

clear()

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

clearCreateTime()

public BatchOperationMetadata.Builder clearCreateTime()

The time when the batch operation is created.

.google.protobuf.Timestamp create_time = 6;

Returns
Type Description
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
Type Description
BatchOperationMetadata.Builder

clearFailureCount()

public BatchOperationMetadata.Builder clearFailureCount()

Count of failed item(s) inside an operation.

int32 failure_count = 4;

Returns
Type Description
BatchOperationMetadata.Builder

This builder for chaining.

clearState()

public BatchOperationMetadata.Builder clearState()

The state of a long running operation.

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

Returns
Type Description
BatchOperationMetadata.Builder

This builder for chaining.

clearStateDescription()

public BatchOperationMetadata.Builder clearStateDescription()

More detailed information about operation state.

string state_description = 2;

Returns
Type Description
BatchOperationMetadata.Builder

This builder for chaining.

clearSuccessCount()

public BatchOperationMetadata.Builder clearSuccessCount()

Count of successful item(s) inside an operation.

int32 success_count = 3;

Returns
Type Description
BatchOperationMetadata.Builder

This builder for chaining.

clearTotalCount()

public BatchOperationMetadata.Builder clearTotalCount()

Count of total item(s) inside an operation.

int32 total_count = 5;

Returns
Type Description
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
Type Description
BatchOperationMetadata.Builder

getCreateTime()

public Timestamp getCreateTime()

The time when the batch operation is created.

.google.protobuf.Timestamp create_time = 6;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

The time when the batch operation is created.

.google.protobuf.Timestamp create_time = 6;

Returns
Type Description
Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
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
Type Description
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
Type Description
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
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.

getState()

public BatchOperationMetadata.State getState()

The state of a long running operation.

.google.cloud.talent.v4beta1.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.v4beta1.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.

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
Type Description
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
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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
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
Name Description
value Timestamp
Returns
Type Description
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
Name Description
value Timestamp
Returns
Type Description
BatchOperationMetadata.Builder

mergeFrom(BatchOperationMetadata other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

public BatchOperationMetadata.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
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
Name Description
value Timestamp
Returns
Type Description
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
Name Description
value Timestamp
Returns
Type Description
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
Name Description
builderForValue Builder
Returns
Type Description
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
Name Description
value Timestamp
Returns
Type Description
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
Name Description
builderForValue Builder
Returns
Type Description
BatchOperationMetadata.Builder

setFailureCount(int value)

public BatchOperationMetadata.Builder setFailureCount(int value)

Count of failed item(s) inside an operation.

int32 failure_count = 4;

Parameter
Name Description
value int

The failureCount to set.

Returns
Type Description
BatchOperationMetadata.Builder

This builder for chaining.

setState(BatchOperationMetadata.State value)

public BatchOperationMetadata.Builder setState(BatchOperationMetadata.State value)

The state of a long running operation.

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

Parameter
Name Description
value BatchOperationMetadata.State

The state to set.

Returns
Type Description
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
Name Description
value String

The stateDescription to set.

Returns
Type Description
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
Name Description
value ByteString

The bytes for stateDescription to set.

Returns
Type Description
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.v4beta1.BatchOperationMetadata.State state = 1;

Parameter
Name Description
value int

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

Returns
Type Description
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
Name Description
value int

The successCount to set.

Returns
Type Description
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
Name Description
value int

The totalCount to set.

Returns
Type Description
BatchOperationMetadata.Builder

This builder for chaining.

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
Name Description
value Timestamp
Returns
Type Description
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
Name Description
builderForValue Builder
Returns
Type Description
BatchOperationMetadata.Builder