Interface OperationMetadataOrBuilder (2.23.0)

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
TypeDescription
String

The apiVersion.

getApiVersionBytes()

public abstract ByteString getApiVersionBytes()

API version used to start the operation.

string api_version = 7;

Returns
TypeDescription
ByteString

The bytes for apiVersion.

getCancelRequested()

public abstract boolean getCancelRequested()

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
TypeDescription
boolean

The cancelRequested.

getCreateTime()

public abstract Timestamp getCreateTime()

The time the operation was created.

.google.protobuf.Timestamp create_time = 1;

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

The time the operation was created.

.google.protobuf.Timestamp create_time = 1;

Returns
TypeDescription
TimestampOrBuilder

getEndTime()

public abstract Timestamp getEndTime()

The time the operation finished running.

.google.protobuf.Timestamp end_time = 2;

Returns
TypeDescription
Timestamp

The endTime.

getEndTimeOrBuilder()

public abstract TimestampOrBuilder getEndTimeOrBuilder()

The time the operation finished running.

.google.protobuf.Timestamp end_time = 2;

Returns
TypeDescription
TimestampOrBuilder

getRequestResource()

public abstract Any getRequestResource()

The original request that started the operation.

.google.protobuf.Any request_resource = 8;

Returns
TypeDescription
Any

The requestResource.

getRequestResourceOrBuilder()

public abstract AnyOrBuilder getRequestResourceOrBuilder()

The original request that started the operation.

.google.protobuf.Any request_resource = 8;

Returns
TypeDescription
AnyOrBuilder

getStages(int index)

public abstract Stage getStages(int index)

Mechanism for reporting in-progress stages

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Stage

getStagesCount()

public abstract int getStagesCount()

Mechanism for reporting in-progress stages

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

Returns
TypeDescription
int

getStagesList()

public abstract List<Stage> getStagesList()

Mechanism for reporting in-progress stages

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

Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
StageOrBuilder

getStagesOrBuilderList()

public abstract List<? extends StageOrBuilder> getStagesOrBuilderList()

Mechanism for reporting in-progress stages

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

Returns
TypeDescription
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
TypeDescription
String

The statusDetail.

getStatusDetailBytes()

public abstract ByteString getStatusDetailBytes()

Human-readable status of the operation, if any.

string status_detail = 5;

Returns
TypeDescription
ByteString

The bytes for statusDetail.

getTarget()

public abstract String getTarget()

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

string target = 3;

Returns
TypeDescription
String

The target.

getTargetBytes()

public abstract ByteString getTargetBytes()

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

string target = 3;

Returns
TypeDescription
ByteString

The bytes for target.

getVerb()

public abstract String getVerb()

Name of the verb executed by the operation.

string verb = 4;

Returns
TypeDescription
String

The verb.

getVerbBytes()

public abstract ByteString getVerbBytes()

Name of the verb executed by the operation.

string verb = 4;

Returns
TypeDescription
ByteString

The bytes for verb.

hasCreateTime()

public abstract boolean hasCreateTime()

The time the operation was created.

.google.protobuf.Timestamp create_time = 1;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the requestResource field is set.