Class OperationMetadata.Builder (2.55.0)

public static final class OperationMetadata.Builder extends GeneratedMessageV3.Builder<OperationMetadata.Builder> implements OperationMetadataOrBuilder

Represents the metadata of a long-running operation.

Protobuf type google.cloud.memcache.v1beta2.OperationMetadata

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public OperationMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
OperationMetadata.Builder
Overrides

build()

public OperationMetadata build()
Returns
Type Description
OperationMetadata

buildPartial()

public OperationMetadata buildPartial()
Returns
Type Description
OperationMetadata

clear()

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

clearApiVersion()

public OperationMetadata.Builder clearApiVersion()

Output only. API version used to start the operation.

string api_version = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
OperationMetadata.Builder

This builder for chaining.

clearCancelRequested()

public OperationMetadata.Builder clearCancelRequested()

Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have [Operation.error][] value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

bool cancel_requested = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
OperationMetadata.Builder

This builder for chaining.

clearCreateTime()

public OperationMetadata.Builder clearCreateTime()

Output only. Time when the operation was created.

.google.protobuf.Timestamp create_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
OperationMetadata.Builder

clearEndTime()

public OperationMetadata.Builder clearEndTime()

Output only. Time when the operation finished running.

.google.protobuf.Timestamp end_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
OperationMetadata.Builder

clearField(Descriptors.FieldDescriptor field)

public OperationMetadata.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
OperationMetadata.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public OperationMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
OperationMetadata.Builder
Overrides

clearStatusDetail()

public OperationMetadata.Builder clearStatusDetail()

Output only. Human-readable status of the operation, if any.

string status_detail = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
OperationMetadata.Builder

This builder for chaining.

clearTarget()

public OperationMetadata.Builder clearTarget()

Output only. Server-defined resource path for the target of the operation.

string target = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
OperationMetadata.Builder

This builder for chaining.

clearVerb()

public OperationMetadata.Builder clearVerb()

Output only. Name of the verb executed by the operation.

string verb = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
OperationMetadata.Builder

This builder for chaining.

clone()

public OperationMetadata.Builder clone()
Returns
Type Description
OperationMetadata.Builder
Overrides

getApiVersion()

public String getApiVersion()

Output only. API version used to start the operation.

string api_version = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The apiVersion.

getApiVersionBytes()

public ByteString getApiVersionBytes()

Output only. API version used to start the operation.

string api_version = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for apiVersion.

getCancelRequested()

public boolean getCancelRequested()

Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have [Operation.error][] value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

bool cancel_requested = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The cancelRequested.

getCreateTime()

public Timestamp getCreateTime()

Output only. Time when the operation was created.

.google.protobuf.Timestamp create_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Time when the operation was created.

.google.protobuf.Timestamp create_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Time when the operation was created.

.google.protobuf.Timestamp create_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public OperationMetadata getDefaultInstanceForType()
Returns
Type Description
OperationMetadata

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEndTime()

public Timestamp getEndTime()

Output only. Time when the operation finished running.

.google.protobuf.Timestamp end_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The endTime.

getEndTimeBuilder()

public Timestamp.Builder getEndTimeBuilder()

Output only. Time when the operation finished running.

.google.protobuf.Timestamp end_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

Output only. Time when the operation finished running.

.google.protobuf.Timestamp end_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getStatusDetail()

public String getStatusDetail()

Output only. Human-readable status of the operation, if any.

string status_detail = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The statusDetail.

getStatusDetailBytes()

public ByteString getStatusDetailBytes()

Output only. Human-readable status of the operation, if any.

string status_detail = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for statusDetail.

getTarget()

public String getTarget()

Output only. Server-defined resource path for the target of the operation.

string target = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The target.

getTargetBytes()

public ByteString getTargetBytes()

Output only. Server-defined resource path for the target of the operation.

string target = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for target.

getVerb()

public String getVerb()

Output only. Name of the verb executed by the operation.

string verb = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The verb.

getVerbBytes()

public ByteString getVerbBytes()

Output only. Name of the verb executed by the operation.

string verb = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for verb.

hasCreateTime()

public boolean hasCreateTime()

Output only. Time when the operation was created.

.google.protobuf.Timestamp create_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasEndTime()

public boolean hasEndTime()

Output only. Time when the operation finished running.

.google.protobuf.Timestamp end_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the endTime field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public OperationMetadata.Builder mergeCreateTime(Timestamp value)

Output only. Time when the operation was created.

.google.protobuf.Timestamp create_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
OperationMetadata.Builder

mergeEndTime(Timestamp value)

public OperationMetadata.Builder mergeEndTime(Timestamp value)

Output only. Time when the operation finished running.

.google.protobuf.Timestamp end_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
OperationMetadata.Builder

mergeFrom(OperationMetadata other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

public OperationMetadata.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
OperationMetadata.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final OperationMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
OperationMetadata.Builder
Overrides

setApiVersion(String value)

public OperationMetadata.Builder setApiVersion(String value)

Output only. API version used to start the operation.

string api_version = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The apiVersion to set.

Returns
Type Description
OperationMetadata.Builder

This builder for chaining.

setApiVersionBytes(ByteString value)

public OperationMetadata.Builder setApiVersionBytes(ByteString value)

Output only. API version used to start the operation.

string api_version = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for apiVersion to set.

Returns
Type Description
OperationMetadata.Builder

This builder for chaining.

setCancelRequested(boolean value)

public OperationMetadata.Builder setCancelRequested(boolean value)

Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have [Operation.error][] value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

bool cancel_requested = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The cancelRequested to set.

Returns
Type Description
OperationMetadata.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public OperationMetadata.Builder setCreateTime(Timestamp value)

Output only. Time when the operation was created.

.google.protobuf.Timestamp create_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
OperationMetadata.Builder

setCreateTime(Timestamp.Builder builderForValue)

public OperationMetadata.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Time when the operation was created.

.google.protobuf.Timestamp create_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
OperationMetadata.Builder

setEndTime(Timestamp value)

public OperationMetadata.Builder setEndTime(Timestamp value)

Output only. Time when the operation finished running.

.google.protobuf.Timestamp end_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
OperationMetadata.Builder

setEndTime(Timestamp.Builder builderForValue)

public OperationMetadata.Builder setEndTime(Timestamp.Builder builderForValue)

Output only. Time when the operation finished running.

.google.protobuf.Timestamp end_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
OperationMetadata.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public OperationMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
OperationMetadata.Builder
Overrides

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

public OperationMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
OperationMetadata.Builder
Overrides

setStatusDetail(String value)

public OperationMetadata.Builder setStatusDetail(String value)

Output only. Human-readable status of the operation, if any.

string status_detail = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The statusDetail to set.

Returns
Type Description
OperationMetadata.Builder

This builder for chaining.

setStatusDetailBytes(ByteString value)

public OperationMetadata.Builder setStatusDetailBytes(ByteString value)

Output only. Human-readable status of the operation, if any.

string status_detail = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for statusDetail to set.

Returns
Type Description
OperationMetadata.Builder

This builder for chaining.

setTarget(String value)

public OperationMetadata.Builder setTarget(String value)

Output only. Server-defined resource path for the target of the operation.

string target = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The target to set.

Returns
Type Description
OperationMetadata.Builder

This builder for chaining.

setTargetBytes(ByteString value)

public OperationMetadata.Builder setTargetBytes(ByteString value)

Output only. Server-defined resource path for the target of the operation.

string target = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for target to set.

Returns
Type Description
OperationMetadata.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final OperationMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
OperationMetadata.Builder
Overrides

setVerb(String value)

public OperationMetadata.Builder setVerb(String value)

Output only. Name of the verb executed by the operation.

string verb = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The verb to set.

Returns
Type Description
OperationMetadata.Builder

This builder for chaining.

setVerbBytes(ByteString value)

public OperationMetadata.Builder setVerbBytes(ByteString value)

Output only. Name of the verb executed by the operation.

string verb = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for verb to set.

Returns
Type Description
OperationMetadata.Builder

This builder for chaining.