Class OpMetadata.Builder (1.53.0)

public static final class OpMetadata.Builder extends GeneratedMessageV3.Builder<OpMetadata.Builder> implements OpMetadataOrBuilder

Represents the metadata of the long-running operation.

Protobuf type google.cloud.managedidentities.v1.OpMetadata

Implements

OpMetadataOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public OpMetadata build()
Returns
Type Description
OpMetadata

buildPartial()

public OpMetadata buildPartial()
Returns
Type Description
OpMetadata

clear()

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

clearApiVersion()

public OpMetadata.Builder clearApiVersion()

Output only. API version used to start the operation.

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

Returns
Type Description
OpMetadata.Builder

This builder for chaining.

clearCreateTime()

public OpMetadata.Builder clearCreateTime()

Output only. The time the operation was created.

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

Returns
Type Description
OpMetadata.Builder

clearEndTime()

public OpMetadata.Builder clearEndTime()

Output only. The time the operation finished running.

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

Returns
Type Description
OpMetadata.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearRequestedCancellation()

public OpMetadata.Builder clearRequestedCancellation()

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 requested_cancellation = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
OpMetadata.Builder

This builder for chaining.

clearTarget()

public OpMetadata.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
OpMetadata.Builder

This builder for chaining.

clearVerb()

public OpMetadata.Builder clearVerb()

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

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

Returns
Type Description
OpMetadata.Builder

This builder for chaining.

clone()

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

getApiVersion()

public String getApiVersion()

Output only. API version used to start the operation.

string api_version = 6 [(.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 = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for apiVersion.

getCreateTime()

public Timestamp getCreateTime()

Output only. The time 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. The time 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. The time the operation was created.

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public OpMetadata getDefaultInstanceForType()
Returns
Type Description
OpMetadata

getDescriptorForType()

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

getEndTime()

public Timestamp getEndTime()

Output only. The time 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. The time 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. The time the operation finished running.

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

Returns
Type Description
TimestampOrBuilder

getRequestedCancellation()

public boolean getRequestedCancellation()

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 requested_cancellation = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The requestedCancellation.

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. The time 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. The time 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 OpMetadata.Builder mergeCreateTime(Timestamp value)

Output only. The time the operation was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
OpMetadata.Builder

mergeEndTime(Timestamp value)

public OpMetadata.Builder mergeEndTime(Timestamp value)

Output only. The time the operation finished running.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
OpMetadata.Builder

mergeFrom(OpMetadata other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setApiVersion(String value)

public OpMetadata.Builder setApiVersion(String value)

Output only. API version used to start the operation.

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

Parameter
Name Description
value String

The apiVersion to set.

Returns
Type Description
OpMetadata.Builder

This builder for chaining.

setApiVersionBytes(ByteString value)

public OpMetadata.Builder setApiVersionBytes(ByteString value)

Output only. API version used to start the operation.

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

Parameter
Name Description
value ByteString

The bytes for apiVersion to set.

Returns
Type Description
OpMetadata.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public OpMetadata.Builder setCreateTime(Timestamp value)

Output only. The time the operation was created.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
OpMetadata.Builder

setCreateTime(Timestamp.Builder builderForValue)

public OpMetadata.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The time the operation was created.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
OpMetadata.Builder

setEndTime(Timestamp value)

public OpMetadata.Builder setEndTime(Timestamp value)

Output only. The time the operation finished running.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
OpMetadata.Builder

setEndTime(Timestamp.Builder builderForValue)

public OpMetadata.Builder setEndTime(Timestamp.Builder builderForValue)

Output only. The time the operation finished running.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
OpMetadata.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

setRequestedCancellation(boolean value)

public OpMetadata.Builder setRequestedCancellation(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 requested_cancellation = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The requestedCancellation to set.

Returns
Type Description
OpMetadata.Builder

This builder for chaining.

setTarget(String value)

public OpMetadata.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
OpMetadata.Builder

This builder for chaining.

setTargetBytes(ByteString value)

public OpMetadata.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
OpMetadata.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

setVerb(String value)

public OpMetadata.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
OpMetadata.Builder

This builder for chaining.

setVerbBytes(ByteString value)

public OpMetadata.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
OpMetadata.Builder

This builder for chaining.