Interface OperationMetadataOrBuilder (0.37.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.

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

getRequestedCancellation()

public abstract boolean getRequestedCancellation()

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;

Returns
TypeDescription
boolean

The requestedCancellation.

getStatusMessage()

public abstract String getStatusMessage()

Human-readable status of the operation, if any.

string status_message = 5;

Returns
TypeDescription
String

The statusMessage.

getStatusMessageBytes()

public abstract ByteString getStatusMessageBytes()

Human-readable status of the operation, if any.

string status_message = 5;

Returns
TypeDescription
ByteString

The bytes for statusMessage.

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

The verb executed by the operation.

string verb = 4;

Returns
TypeDescription
String

The verb.

getVerbBytes()

public abstract ByteString getVerbBytes()

The verb executed by the operation.

string verb = 4;

Returns
TypeDescription
ByteString

The bytes for verb.

getWarnings(int index)

public abstract String getWarnings(int index)

Warnings that do not block the operation, but still hold relevant information for the end user to receive.

repeated string warnings = 8;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The warnings at the given index.

getWarningsBytes(int index)

public abstract ByteString getWarningsBytes(int index)

Warnings that do not block the operation, but still hold relevant information for the end user to receive.

repeated string warnings = 8;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the warnings at the given index.

getWarningsCount()

public abstract int getWarningsCount()

Warnings that do not block the operation, but still hold relevant information for the end user to receive.

repeated string warnings = 8;

Returns
TypeDescription
int

The count of warnings.

getWarningsList()

public abstract List<String> getWarningsList()

Warnings that do not block the operation, but still hold relevant information for the end user to receive.

repeated string warnings = 8;

Returns
TypeDescription
List<String>

A list containing the warnings.

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.