Class OperationMetadata.Builder (1.30.0)

Version 1.30.0

• 1.52.0 (latest)
• 1.51.0
• 1.50.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.7
• 1.1.1
• 1.0.4

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

Represents the metadata of the long-running operation.

Protobuf type google.cloud.ids.v1.OperationMetadata

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > OperationMetadata.Builder

Implements

OperationMetadataOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

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.

clearCreateTime()

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

clearEndTime()

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

clearField(Descriptors.FieldDescriptor field)

public OperationMetadata.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
OperationMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public OperationMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
OperationMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearRequestedCancellation()

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

Returns
Type	Description
OperationMetadata.Builder	This builder for chaining.

clearStatusMessage()

public OperationMetadata.Builder clearStatusMessage()

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

string status_message = 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

GeneratedMessageV3.Builder<BuilderType>.clone()

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.

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 OperationMetadata getDefaultInstanceForType()

Returns
Type	Description
OperationMetadata

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

Returns
Type	Description
boolean	The requestedCancellation.

getStatusMessage()

public String getStatusMessage()

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

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

Returns
Type	Description
String	The statusMessage.

getStatusMessageBytes()

public ByteString getStatusMessageBytes()

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

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

Returns
Type	Description
ByteString	The bytes for statusMessage.

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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeCreateTime(Timestamp value)

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

mergeEndTime(Timestamp value)

public OperationMetadata.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
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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public OperationMetadata.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
OperationMetadata.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final OperationMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
OperationMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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.

setCreateTime(Timestamp value)

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

setCreateTime(Timestamp.Builder builderForValue)

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

setEndTime(Timestamp value)

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

setEndTime(Timestamp.Builder builderForValue)

public OperationMetadata.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
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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setRequestedCancellation(boolean value)

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

Parameter
Name	Description
value	boolean The requestedCancellation to set.

Returns
Type	Description
OperationMetadata.Builder	This builder for chaining.

setStatusMessage(String value)

public OperationMetadata.Builder setStatusMessage(String value)

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

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

Parameter
Name	Description
value	String The statusMessage to set.

Returns
Type	Description
OperationMetadata.Builder	This builder for chaining.

setStatusMessageBytes(ByteString value)

public OperationMetadata.Builder setStatusMessageBytes(ByteString value)

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

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

Parameter
Name	Description
value	ByteString The bytes for statusMessage 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

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

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.