Class OperationMetadata.Builder (2.18.0)

publicstaticfinalclass OperationMetadata.BuilderextendsGeneratedMessageV3.Builder<OperationMetadata.Builder>implementsOperationMetadataOrBuilder

Represents the metadata of the long-running operation.

Protobuf type google.cloud.functions.v2alpha.OperationMetadata

Inherited Members

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

Static Methods

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

Methods

addAllStages(Iterable<? extends Stage> values)

publicOperationMetadata.BuilderaddAllStages(Iterable<?extendsStage>values)

Mechanism for reporting in-progress stages

repeated .google.cloud.functions.v2alpha.Stage stages = 9;

Parameter
Name Description
values Iterable<? extends com.google.cloud.functions.v2alpha.Stage>
Returns
Type Description
OperationMetadata.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

publicOperationMetadata.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
OperationMetadata.Builder
Overrides

addStages(Stage value)

publicOperationMetadata.BuilderaddStages(Stagevalue)

Mechanism for reporting in-progress stages

repeated .google.cloud.functions.v2alpha.Stage stages = 9;

Parameter
Name Description
value Stage
Returns
Type Description
OperationMetadata.Builder

addStages(Stage.Builder builderForValue)

publicOperationMetadata.BuilderaddStages(Stage.BuilderbuilderForValue)

Mechanism for reporting in-progress stages

repeated .google.cloud.functions.v2alpha.Stage stages = 9;

Parameter
Name Description
builderForValue Stage.Builder
Returns
Type Description
OperationMetadata.Builder

addStages(int index, Stage value)

publicOperationMetadata.BuilderaddStages(intindex,Stagevalue)

Mechanism for reporting in-progress stages

repeated .google.cloud.functions.v2alpha.Stage stages = 9;

Parameters
Name Description
index int
value Stage
Returns
Type Description
OperationMetadata.Builder

addStages(int index, Stage.Builder builderForValue)

publicOperationMetadata.BuilderaddStages(intindex,Stage.BuilderbuilderForValue)

Mechanism for reporting in-progress stages

repeated .google.cloud.functions.v2alpha.Stage stages = 9;

Parameters
Name Description
index int
builderForValue Stage.Builder
Returns
Type Description
OperationMetadata.Builder

addStagesBuilder()

publicStage.BuilderaddStagesBuilder()

Mechanism for reporting in-progress stages

repeated .google.cloud.functions.v2alpha.Stage stages = 9;

Returns
Type Description
Stage.Builder

addStagesBuilder(int index)

publicStage.BuilderaddStagesBuilder(intindex)

Mechanism for reporting in-progress stages

repeated .google.cloud.functions.v2alpha.Stage stages = 9;

Parameter
Name Description
index int
Returns
Type Description
Stage.Builder

build()

publicOperationMetadatabuild()
Returns
Type Description
OperationMetadata

buildPartial()

publicOperationMetadatabuildPartial()
Returns
Type Description
OperationMetadata

clear()

publicOperationMetadata.Builderclear()
Returns
Type Description
OperationMetadata.Builder
Overrides

clearApiVersion()

publicOperationMetadata.BuilderclearApiVersion()

API version used to start the operation.

string api_version = 7;

Returns
Type Description
OperationMetadata.Builder

This builder for chaining.

clearCancelRequested()

publicOperationMetadata.BuilderclearCancelRequested()

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;

Returns
Type Description
OperationMetadata.Builder

This builder for chaining.

clearCreateTime()

publicOperationMetadata.BuilderclearCreateTime()

The time the operation was created.

.google.protobuf.Timestamp create_time = 1;

Returns
Type Description
OperationMetadata.Builder

clearEndTime()

publicOperationMetadata.BuilderclearEndTime()

The time the operation finished running.

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
OperationMetadata.Builder

clearField(Descriptors.FieldDescriptor field)

publicOperationMetadata.BuilderclearField(Descriptors.FieldDescriptorfield)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
OperationMetadata.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

publicOperationMetadata.BuilderclearOneof(Descriptors.OneofDescriptoroneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
OperationMetadata.Builder
Overrides

clearRequestResource()

publicOperationMetadata.BuilderclearRequestResource()

The original request that started the operation.

.google.protobuf.Any request_resource = 8;

Returns
Type Description
OperationMetadata.Builder

clearStages()

publicOperationMetadata.BuilderclearStages()

Mechanism for reporting in-progress stages

repeated .google.cloud.functions.v2alpha.Stage stages = 9;

Returns
Type Description
OperationMetadata.Builder

clearStatusDetail()

publicOperationMetadata.BuilderclearStatusDetail()

Human-readable status of the operation, if any.

string status_detail = 5;

Returns
Type Description
OperationMetadata.Builder

This builder for chaining.

clearTarget()

publicOperationMetadata.BuilderclearTarget()

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

string target = 3;

Returns
Type Description
OperationMetadata.Builder

This builder for chaining.

clearVerb()

publicOperationMetadata.BuilderclearVerb()

Name of the verb executed by the operation.

string verb = 4;

Returns
Type Description
OperationMetadata.Builder

This builder for chaining.

clone()

publicOperationMetadata.Builderclone()
Returns
Type Description
OperationMetadata.Builder
Overrides

getApiVersion()

publicStringgetApiVersion()

API version used to start the operation.

string api_version = 7;

Returns
Type Description
String

The apiVersion.

getApiVersionBytes()

publicByteStringgetApiVersionBytes()

API version used to start the operation.

string api_version = 7;

Returns
Type Description
ByteString

The bytes for apiVersion.

getCancelRequested()

publicbooleangetCancelRequested()

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;

Returns
Type Description
boolean

The cancelRequested.

getCreateTime()

publicTimestampgetCreateTime()

The time the operation was created.

.google.protobuf.Timestamp create_time = 1;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

publicTimestamp.BuildergetCreateTimeBuilder()

The time the operation was created.

.google.protobuf.Timestamp create_time = 1;

Returns
Type Description
Builder

getCreateTimeOrBuilder()

publicTimestampOrBuildergetCreateTimeOrBuilder()

The time the operation was created.

.google.protobuf.Timestamp create_time = 1;

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

publicOperationMetadatagetDefaultInstanceForType()
Returns
Type Description
OperationMetadata

getDescriptorForType()

publicDescriptors.DescriptorgetDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEndTime()

publicTimestampgetEndTime()

The time the operation finished running.

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
Timestamp

The endTime.

getEndTimeBuilder()

publicTimestamp.BuildergetEndTimeBuilder()

The time the operation finished running.

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
Builder

getEndTimeOrBuilder()

publicTimestampOrBuildergetEndTimeOrBuilder()

The time the operation finished running.

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
TimestampOrBuilder

getRequestResource()

publicAnygetRequestResource()

The original request that started the operation.

.google.protobuf.Any request_resource = 8;

Returns
Type Description
Any

The requestResource.

getRequestResourceBuilder()

publicAny.BuildergetRequestResourceBuilder()

The original request that started the operation.

.google.protobuf.Any request_resource = 8;

Returns
Type Description
Builder

getRequestResourceOrBuilder()

publicAnyOrBuildergetRequestResourceOrBuilder()

The original request that started the operation.

.google.protobuf.Any request_resource = 8;

Returns
Type Description
AnyOrBuilder

getStages(int index)

publicStagegetStages(intindex)

Mechanism for reporting in-progress stages

repeated .google.cloud.functions.v2alpha.Stage stages = 9;

Parameter
Name Description
index int
Returns
Type Description
Stage

getStagesBuilder(int index)

publicStage.BuildergetStagesBuilder(intindex)

Mechanism for reporting in-progress stages

repeated .google.cloud.functions.v2alpha.Stage stages = 9;

Parameter
Name Description
index int
Returns
Type Description
Stage.Builder

getStagesBuilderList()

publicList<Stage.Builder>getStagesBuilderList()

Mechanism for reporting in-progress stages

repeated .google.cloud.functions.v2alpha.Stage stages = 9;

Returns
Type Description
List<Builder>

getStagesCount()

publicintgetStagesCount()

Mechanism for reporting in-progress stages

repeated .google.cloud.functions.v2alpha.Stage stages = 9;

Returns
Type Description
int

getStagesList()

publicList<Stage>getStagesList()

Mechanism for reporting in-progress stages

repeated .google.cloud.functions.v2alpha.Stage stages = 9;

Returns
Type Description
List<Stage>

getStagesOrBuilder(int index)

publicStageOrBuildergetStagesOrBuilder(intindex)

Mechanism for reporting in-progress stages

repeated .google.cloud.functions.v2alpha.Stage stages = 9;

Parameter
Name Description
index int
Returns
Type Description
StageOrBuilder

getStagesOrBuilderList()

publicList<?extendsStageOrBuilder>getStagesOrBuilderList()

Mechanism for reporting in-progress stages

repeated .google.cloud.functions.v2alpha.Stage stages = 9;

Returns
Type Description
List<? extends com.google.cloud.functions.v2alpha.StageOrBuilder>

getStatusDetail()

publicStringgetStatusDetail()

Human-readable status of the operation, if any.

string status_detail = 5;

Returns
Type Description
String

The statusDetail.

getStatusDetailBytes()

publicByteStringgetStatusDetailBytes()

Human-readable status of the operation, if any.

string status_detail = 5;

Returns
Type Description
ByteString

The bytes for statusDetail.

getTarget()

publicStringgetTarget()

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

string target = 3;

Returns
Type Description
String

The target.

getTargetBytes()

publicByteStringgetTargetBytes()

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

string target = 3;

Returns
Type Description
ByteString

The bytes for target.

getVerb()

publicStringgetVerb()

Name of the verb executed by the operation.

string verb = 4;

Returns
Type Description
String

The verb.

getVerbBytes()

publicByteStringgetVerbBytes()

Name of the verb executed by the operation.

string verb = 4;

Returns
Type Description
ByteString

The bytes for verb.

hasCreateTime()

publicbooleanhasCreateTime()

The time the operation was created.

.google.protobuf.Timestamp create_time = 1;

Returns
Type Description
boolean

Whether the createTime field is set.

hasEndTime()

publicbooleanhasEndTime()

The time the operation finished running.

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
boolean

Whether the endTime field is set.

hasRequestResource()

publicbooleanhasRequestResource()

The original request that started the operation.

.google.protobuf.Any request_resource = 8;

Returns
Type Description
boolean

Whether the requestResource field is set.

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

publicOperationMetadata.BuildermergeCreateTime(Timestampvalue)

The time the operation was created.

.google.protobuf.Timestamp create_time = 1;

Parameter
Name Description
value Timestamp
Returns
Type Description
OperationMetadata.Builder

mergeEndTime(Timestamp value)

publicOperationMetadata.BuildermergeEndTime(Timestampvalue)

The time the operation finished running.

.google.protobuf.Timestamp end_time = 2;

Parameter
Name Description
value Timestamp
Returns
Type Description
OperationMetadata.Builder

mergeFrom(OperationMetadata other)

publicOperationMetadata.BuildermergeFrom(OperationMetadataother)
Parameter
Name Description
other OperationMetadata
Returns
Type Description
OperationMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicOperationMetadata.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OperationMetadata.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

publicOperationMetadata.BuildermergeFrom(Messageother)
Parameter
Name Description
other Message
Returns
Type Description
OperationMetadata.Builder
Overrides

mergeRequestResource(Any value)

publicOperationMetadata.BuildermergeRequestResource(Anyvalue)

The original request that started the operation.

.google.protobuf.Any request_resource = 8;

Parameter
Name Description
value Any
Returns
Type Description
OperationMetadata.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

publicfinalOperationMetadata.BuildermergeUnknownFields(UnknownFieldSetunknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
OperationMetadata.Builder
Overrides

removeStages(int index)

publicOperationMetadata.BuilderremoveStages(intindex)

Mechanism for reporting in-progress stages

repeated .google.cloud.functions.v2alpha.Stage stages = 9;

Parameter
Name Description
index int
Returns
Type Description
OperationMetadata.Builder

setApiVersion(String value)

publicOperationMetadata.BuildersetApiVersion(Stringvalue)

API version used to start the operation.

string api_version = 7;

Parameter
Name Description
value String

The apiVersion to set.

Returns
Type Description
OperationMetadata.Builder

This builder for chaining.

setApiVersionBytes(ByteString value)

publicOperationMetadata.BuildersetApiVersionBytes(ByteStringvalue)

API version used to start the operation.

string api_version = 7;

Parameter
Name Description
value ByteString

The bytes for apiVersion to set.

Returns
Type Description
OperationMetadata.Builder

This builder for chaining.

setCancelRequested(boolean value)

publicOperationMetadata.BuildersetCancelRequested(booleanvalue)

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;

Parameter
Name Description
value boolean

The cancelRequested to set.

Returns
Type Description
OperationMetadata.Builder

This builder for chaining.

setCreateTime(Timestamp value)

publicOperationMetadata.BuildersetCreateTime(Timestampvalue)

The time the operation was created.

.google.protobuf.Timestamp create_time = 1;

Parameter
Name Description
value Timestamp
Returns
Type Description
OperationMetadata.Builder

setCreateTime(Timestamp.Builder builderForValue)

publicOperationMetadata.BuildersetCreateTime(Timestamp.BuilderbuilderForValue)

The time the operation was created.

.google.protobuf.Timestamp create_time = 1;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
OperationMetadata.Builder

setEndTime(Timestamp value)

publicOperationMetadata.BuildersetEndTime(Timestampvalue)

The time the operation finished running.

.google.protobuf.Timestamp end_time = 2;

Parameter
Name Description
value Timestamp
Returns
Type Description
OperationMetadata.Builder

setEndTime(Timestamp.Builder builderForValue)

publicOperationMetadata.BuildersetEndTime(Timestamp.BuilderbuilderForValue)

The time the operation finished running.

.google.protobuf.Timestamp end_time = 2;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
OperationMetadata.Builder

setField(Descriptors.FieldDescriptor field, Object value)

publicOperationMetadata.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
OperationMetadata.Builder
Overrides

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

publicOperationMetadata.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
OperationMetadata.Builder
Overrides

setRequestResource(Any value)

publicOperationMetadata.BuildersetRequestResource(Anyvalue)

The original request that started the operation.

.google.protobuf.Any request_resource = 8;

Parameter
Name Description
value Any
Returns
Type Description
OperationMetadata.Builder

setRequestResource(Any.Builder builderForValue)

publicOperationMetadata.BuildersetRequestResource(Any.BuilderbuilderForValue)

The original request that started the operation.

.google.protobuf.Any request_resource = 8;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
OperationMetadata.Builder

setStages(int index, Stage value)

publicOperationMetadata.BuildersetStages(intindex,Stagevalue)

Mechanism for reporting in-progress stages

repeated .google.cloud.functions.v2alpha.Stage stages = 9;

Parameters
Name Description
index int
value Stage
Returns
Type Description
OperationMetadata.Builder

setStages(int index, Stage.Builder builderForValue)

publicOperationMetadata.BuildersetStages(intindex,Stage.BuilderbuilderForValue)

Mechanism for reporting in-progress stages

repeated .google.cloud.functions.v2alpha.Stage stages = 9;

Parameters
Name Description
index int
builderForValue Stage.Builder
Returns
Type Description
OperationMetadata.Builder

setStatusDetail(String value)

publicOperationMetadata.BuildersetStatusDetail(Stringvalue)

Human-readable status of the operation, if any.

string status_detail = 5;

Parameter
Name Description
value String

The statusDetail to set.

Returns
Type Description
OperationMetadata.Builder

This builder for chaining.

setStatusDetailBytes(ByteString value)

publicOperationMetadata.BuildersetStatusDetailBytes(ByteStringvalue)

Human-readable status of the operation, if any.

string status_detail = 5;

Parameter
Name Description
value ByteString

The bytes for statusDetail to set.

Returns
Type Description
OperationMetadata.Builder

This builder for chaining.

setTarget(String value)

publicOperationMetadata.BuildersetTarget(Stringvalue)

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

string target = 3;

Parameter
Name Description
value String

The target to set.

Returns
Type Description
OperationMetadata.Builder

This builder for chaining.

setTargetBytes(ByteString value)

publicOperationMetadata.BuildersetTargetBytes(ByteStringvalue)

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

string target = 3;

Parameter
Name Description
value ByteString

The bytes for target to set.

Returns
Type Description
OperationMetadata.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

publicfinalOperationMetadata.BuildersetUnknownFields(UnknownFieldSetunknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
OperationMetadata.Builder
Overrides

setVerb(String value)

publicOperationMetadata.BuildersetVerb(Stringvalue)

Name of the verb executed by the operation.

string verb = 4;

Parameter
Name Description
value String

The verb to set.

Returns
Type Description
OperationMetadata.Builder

This builder for chaining.

setVerbBytes(ByteString value)

publicOperationMetadata.BuildersetVerbBytes(ByteStringvalue)

Name of the verb executed by the operation.

string verb = 4;

Parameter
Name Description
value ByteString

The bytes for verb to set.

Returns
Type Description
OperationMetadata.Builder

This builder for chaining.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.