Interface OperationMetadataOrBuilder (2.56.0)

Version 2.56.0

• 2.57.0 (latest)
• 2.56.0
• 2.55.0
• 2.54.0
• 2.53.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.4
• 2.4.3
• 2.3.6

public interface OperationMetadataOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getApiVersion()

public abstract String getApiVersion()

API version used to start the operation.

string api_version = 7;

Returns
Type	Description
String	The apiVersion.

getApiVersionBytes()

public abstract ByteString getApiVersionBytes()

API version used to start the operation.

string api_version = 7;

Returns
Type	Description
ByteString	The bytes for apiVersion.

getBuildName()

public abstract 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 abstract 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 abstract 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 abstract Timestamp getCreateTime()

The time the operation was created.

.google.protobuf.Timestamp create_time = 1;

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

The time the operation was created.

.google.protobuf.Timestamp create_time = 1;

Returns
Type	Description
TimestampOrBuilder

getEndTime()

public abstract Timestamp getEndTime()

The time the operation finished running.

.google.protobuf.Timestamp end_time = 2;

Returns
Type	Description
Timestamp	The endTime.

getEndTimeOrBuilder()

public abstract TimestampOrBuilder getEndTimeOrBuilder()

The time the operation finished running.

.google.protobuf.Timestamp end_time = 2;

Returns
Type	Description
TimestampOrBuilder

getOperationType()

public abstract OperationType getOperationType()

The operation type.

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

Returns
Type	Description
OperationType	The operationType.

getOperationTypeValue()

public abstract int getOperationTypeValue()

The operation type.

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

Returns
Type	Description
int	The enum numeric value on the wire for operationType.

getRequestResource()

public abstract Any getRequestResource()

The original request that started the operation.

.google.protobuf.Any request_resource = 8;

Returns
Type	Description
Any	The requestResource.

getRequestResourceOrBuilder()

public abstract AnyOrBuilder getRequestResourceOrBuilder()

The original request that started the operation.

.google.protobuf.Any request_resource = 8;

Returns
Type	Description
AnyOrBuilder

getSourceToken()

public abstract String getSourceToken()

An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.

string source_token = 10;

Returns
Type	Description
String	The sourceToken.

getSourceTokenBytes()

public abstract ByteString getSourceTokenBytes()

An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.

string source_token = 10;

Returns
Type	Description
ByteString	The bytes for sourceToken.

getStages(int index)

public abstract Stage getStages(int index)

Mechanism for reporting in-progress stages

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

Parameter
Name	Description
index	int

Returns
Type	Description
Stage

getStagesCount()

public abstract int getStagesCount()

Mechanism for reporting in-progress stages

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

Returns
Type	Description
int

getStagesList()

public abstract List<Stage> getStagesList()

Mechanism for reporting in-progress stages

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

Returns
Type	Description
List<Stage>

getStagesOrBuilder(int index)

public abstract StageOrBuilder getStagesOrBuilder(int index)

Mechanism for reporting in-progress stages

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

Parameter
Name	Description
index	int

Returns
Type	Description
StageOrBuilder

getStagesOrBuilderList()

public abstract List<? extends StageOrBuilder> getStagesOrBuilderList()

Mechanism for reporting in-progress stages

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

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

getStatusDetail()

public abstract String getStatusDetail()

Human-readable status of the operation, if any.

string status_detail = 5;

Returns
Type	Description
String	The statusDetail.

getStatusDetailBytes()

public abstract ByteString getStatusDetailBytes()

Human-readable status of the operation, if any.

string status_detail = 5;

Returns
Type	Description
ByteString	The bytes for statusDetail.

getTarget()

public abstract String getTarget()

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

string target = 3;

Returns
Type	Description
String	The target.

getTargetBytes()

public abstract 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 abstract String getVerb()

Name of the verb executed by the operation.

string verb = 4;

Returns
Type	Description
String	The verb.

getVerbBytes()

public abstract ByteString getVerbBytes()

Name of the verb executed by the operation.

string verb = 4;

Returns
Type	Description
ByteString	The bytes for verb.

hasCreateTime()

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