Class OperationMetadata.Builder (2.57.0) 

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.functions.v2beta.OperationMetadata

Inheritance

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

Static Methods

getDescriptor()

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

Methods

addAllStages(Iterable<? extends Stage> values)

public OperationMetadata.Builder addAllStages(Iterable<? extends Stage> values)

Mechanism for reporting in-progress stages

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

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

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

addStages(Stage value)

public OperationMetadata.Builder addStages(Stage value)

Mechanism for reporting in-progress stages

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

Parameter
Name Description
value Stage
Returns
Type Description
OperationMetadata.Builder

addStages(Stage.Builder builderForValue)

public OperationMetadata.Builder addStages(Stage.Builder builderForValue)

Mechanism for reporting in-progress stages

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

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

addStages(int index, Stage value)

public OperationMetadata.Builder addStages(int index, Stage value)

Mechanism for reporting in-progress stages

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

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

addStages(int index, Stage.Builder builderForValue)

public OperationMetadata.Builder addStages(int index, Stage.Builder builderForValue)

Mechanism for reporting in-progress stages

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

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

addStagesBuilder()

public Stage.Builder addStagesBuilder()

Mechanism for reporting in-progress stages

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

Returns
Type Description
Stage.Builder

addStagesBuilder(int index)

public Stage.Builder addStagesBuilder(int index)

Mechanism for reporting in-progress stages

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

Parameter
Name Description
index int
Returns
Type Description
Stage.Builder

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

API version used to start the operation.

string api_version = 7;

Returns
Type Description
OperationMetadata.Builder

This builder for chaining.

clearBuildName()

public OperationMetadata.Builder clearBuildName()

The build name of the function for create and update operations.

string build_name = 13;

Returns
Type Description
OperationMetadata.Builder

This builder for chaining.

clearCancelRequested()

public OperationMetadata.Builder clearCancelRequested()

Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.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()

public OperationMetadata.Builder clearCreateTime()

The time the operation was created.

.google.protobuf.Timestamp create_time = 1;

Returns
Type Description
OperationMetadata.Builder

clearEndTime()

public OperationMetadata.Builder clearEndTime()

The time the operation finished running.

.google.protobuf.Timestamp end_time = 2;

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

clearOperationType()

public OperationMetadata.Builder clearOperationType()

The operation type.

.google.cloud.functions.v2beta.OperationType operation_type = 11;

Returns
Type Description
OperationMetadata.Builder

This builder for chaining.

clearRequestResource()

public OperationMetadata.Builder clearRequestResource()

The original request that started the operation.

.google.protobuf.Any request_resource = 8;

Returns
Type Description
OperationMetadata.Builder

clearStages()

public OperationMetadata.Builder clearStages()

Mechanism for reporting in-progress stages

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

Returns
Type Description
OperationMetadata.Builder

clearStatusDetail()

public OperationMetadata.Builder clearStatusDetail()

Human-readable status of the operation, if any.

string status_detail = 5;

Returns
Type Description
OperationMetadata.Builder

This builder for chaining.

clearTarget()

public OperationMetadata.Builder clearTarget()

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

string target = 3;

Returns
Type Description
OperationMetadata.Builder

This builder for chaining.

clearVerb()

public OperationMetadata.Builder clearVerb()

Name of the verb executed by the operation.

string verb = 4;

Returns
Type Description
OperationMetadata.Builder

This builder for chaining.

clone()

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

getApiVersion()

public String getApiVersion()

API version used to start the operation.

string api_version = 7;

Returns
Type Description
String

The apiVersion.

getApiVersionBytes()

public ByteString getApiVersionBytes()

API version used to start the operation.

string api_version = 7;

Returns
Type Description
ByteString

The bytes for apiVersion.

getBuildName()

public String getBuildName()

The build name of the function for create and update operations.

string build_name = 13;

Returns
Type Description
String

The buildName.

getBuildNameBytes()

public ByteString getBuildNameBytes()

The build name of the function for create and update operations.

string build_name = 13;

Returns
Type Description
ByteString

The bytes for buildName.

getCancelRequested()

public boolean getCancelRequested()

Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.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()

public Timestamp getCreateTime()

The time the operation was created.

.google.protobuf.Timestamp create_time = 1;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

The time the operation was created.

.google.protobuf.Timestamp create_time = 1;

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

The time the operation was created.

.google.protobuf.Timestamp create_time = 1;

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

The time the operation finished running.

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
Timestamp

The endTime.

getEndTimeBuilder()

public Timestamp.Builder getEndTimeBuilder()

The time the operation finished running.

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
Builder

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

The time the operation finished running.

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
TimestampOrBuilder

getOperationType()

public OperationType getOperationType()

The operation type.

.google.cloud.functions.v2beta.OperationType operation_type = 11;

Returns
Type Description
OperationType

The operationType.

getOperationTypeValue()

public int getOperationTypeValue()

The operation type.

.google.cloud.functions.v2beta.OperationType operation_type = 11;

Returns
Type Description
int

The enum numeric value on the wire for operationType.

getRequestResource()

public Any getRequestResource()

The original request that started the operation.

.google.protobuf.Any request_resource = 8;

Returns
Type Description
Any

The requestResource.

getRequestResourceBuilder()

public Any.Builder getRequestResourceBuilder()

The original request that started the operation.

.google.protobuf.Any request_resource = 8;

Returns
Type Description
Builder

getRequestResourceOrBuilder()

public AnyOrBuilder getRequestResourceOrBuilder()

The original request that started the operation.

.google.protobuf.Any request_resource = 8;

Returns
Type Description
AnyOrBuilder

getStages(int index)

public Stage getStages(int index)

Mechanism for reporting in-progress stages

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

Parameter
Name Description
index int
Returns
Type Description
Stage

getStagesBuilder(int index)

public Stage.Builder getStagesBuilder(int index)

Mechanism for reporting in-progress stages

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

Parameter
Name Description
index int
Returns
Type Description
Stage.Builder

getStagesBuilderList()

public List<Stage.Builder> getStagesBuilderList()

Mechanism for reporting in-progress stages

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

Returns
Type Description
List<Builder>

getStagesCount()

public int getStagesCount()

Mechanism for reporting in-progress stages

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

Returns
Type Description
int

getStagesList()

public List<Stage> getStagesList()

Mechanism for reporting in-progress stages

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

Returns
Type Description
List<Stage>

getStagesOrBuilder(int index)

public StageOrBuilder getStagesOrBuilder(int index)

Mechanism for reporting in-progress stages

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

Parameter
Name Description
index int
Returns
Type Description
StageOrBuilder

getStagesOrBuilderList()

public List<? extends StageOrBuilder> getStagesOrBuilderList()

Mechanism for reporting in-progress stages

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

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

getStatusDetail()

public String getStatusDetail()

Human-readable status of the operation, if any.

string status_detail = 5;

Returns
Type Description
String

The statusDetail.

getStatusDetailBytes()

public ByteString getStatusDetailBytes()

Human-readable status of the operation, if any.

string status_detail = 5;

Returns
Type Description
ByteString

The bytes for statusDetail.

getTarget()

public String getTarget()

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

string target = 3;

Returns
Type Description
String

The target.

getTargetBytes()

public ByteString getTargetBytes()

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

string target = 3;

Returns
Type Description
ByteString

The bytes for target.

getVerb()

public String getVerb()

Name of the verb executed by the operation.

string verb = 4;

Returns
Type Description
String

The verb.

getVerbBytes()

public ByteString getVerbBytes()

Name of the verb executed by the operation.

string verb = 4;

Returns
Type Description
ByteString

The bytes for verb.

hasCreateTime()

public boolean hasCreateTime()

The time the operation was created.

.google.protobuf.Timestamp create_time = 1;

Returns
Type Description
boolean

Whether the createTime field is set.

hasEndTime()

public boolean hasEndTime()

The time the operation finished running.

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
boolean

Whether the endTime field is set.

hasRequestResource()

public boolean hasRequestResource()

The original request that started the operation.

.google.protobuf.Any request_resource = 8;

Returns
Type Description
boolean

Whether the requestResource 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)

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)

public OperationMetadata.Builder mergeEndTime(Timestamp value)

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)

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

mergeRequestResource(Any value)

public OperationMetadata.Builder mergeRequestResource(Any value)

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)

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

removeStages(int index)

public OperationMetadata.Builder removeStages(int index)

Mechanism for reporting in-progress stages

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

Parameter
Name Description
index int
Returns
Type Description
OperationMetadata.Builder

setApiVersion(String value)

public OperationMetadata.Builder setApiVersion(String value)

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)

public OperationMetadata.Builder setApiVersionBytes(ByteString value)

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.

setBuildName(String value)

public OperationMetadata.Builder setBuildName(String value)

The build name of the function for create and update operations.

string build_name = 13;

Parameter
Name Description
value String

The buildName to set.
Returns
Type Description
OperationMetadata.Builder

This builder for chaining.

setBuildNameBytes(ByteString value)

public OperationMetadata.Builder setBuildNameBytes(ByteString value)

The build name of the function for create and update operations.

string build_name = 13;

Parameter
Name Description
value ByteString

The bytes for buildName to set.
Returns
Type Description
OperationMetadata.Builder

This builder for chaining.

setCancelRequested(boolean value)

public OperationMetadata.Builder setCancelRequested(boolean value)

Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.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)

public OperationMetadata.Builder setCreateTime(Timestamp value)

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)

public OperationMetadata.Builder setCreateTime(Timestamp.Builder builderForValue)

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)

public OperationMetadata.Builder setEndTime(Timestamp value)

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)

public OperationMetadata.Builder setEndTime(Timestamp.Builder builderForValue)

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)

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

setOperationType(OperationType value)

public OperationMetadata.Builder setOperationType(OperationType value)

The operation type.

.google.cloud.functions.v2beta.OperationType operation_type = 11;

Parameter
Name Description
value OperationType

The operationType to set.
Returns
Type Description
OperationMetadata.Builder

This builder for chaining.

setOperationTypeValue(int value)

public OperationMetadata.Builder setOperationTypeValue(int value)

The operation type.

.google.cloud.functions.v2beta.OperationType operation_type = 11;

Parameter
Name Description
value int

The enum numeric value on the wire for operationType to set.
Returns
Type Description
OperationMetadata.Builder

This builder for chaining.

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

setRequestResource(Any value)

public OperationMetadata.Builder setRequestResource(Any value)

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)

public OperationMetadata.Builder setRequestResource(Any.Builder builderForValue)

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)

public OperationMetadata.Builder setStages(int index, Stage value)

Mechanism for reporting in-progress stages

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

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

setStages(int index, Stage.Builder builderForValue)

public OperationMetadata.Builder setStages(int index, Stage.Builder builderForValue)

Mechanism for reporting in-progress stages

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

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

setStatusDetail(String value)

public OperationMetadata.Builder setStatusDetail(String value)

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)

public OperationMetadata.Builder setStatusDetailBytes(ByteString value)

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)

public OperationMetadata.Builder setTarget(String value)

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)

public OperationMetadata.Builder setTargetBytes(ByteString value)

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)

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)

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)

public OperationMetadata.Builder setVerbBytes(ByteString value)

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.