Class OperationMetadata (1.35.0)

public final class OperationMetadata extends GeneratedMessageV3 implements OperationMetadataOrBuilder

Represents the metadata of a long-running operation.

Protobuf type google.cloud.dataplex.v1.OperationMetadata

Static Fields

API_VERSION_FIELD_NUMBER

public static final int API_VERSION_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

REQUESTED_CANCELLATION_FIELD_NUMBER

public static final int REQUESTED_CANCELLATION_FIELD_NUMBER
Field Value
TypeDescription
int

STATUS_MESSAGE_FIELD_NUMBER

public static final int STATUS_MESSAGE_FIELD_NUMBER
Field Value
TypeDescription
int

TARGET_FIELD_NUMBER

public static final int TARGET_FIELD_NUMBER
Field Value
TypeDescription
int

VERB_FIELD_NUMBER

public static final int VERB_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static OperationMetadata getDefaultInstance()
Returns
TypeDescription
OperationMetadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static OperationMetadata.Builder newBuilder()
Returns
TypeDescription
OperationMetadata.Builder

newBuilder(OperationMetadata prototype)

public static OperationMetadata.Builder newBuilder(OperationMetadata prototype)
Parameter
NameDescription
prototypeOperationMetadata
Returns
TypeDescription
OperationMetadata.Builder

parseDelimitedFrom(InputStream input)

public static OperationMetadata parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
OperationMetadata
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OperationMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OperationMetadata
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static OperationMetadata parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
OperationMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static OperationMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OperationMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static OperationMetadata parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
OperationMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static OperationMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OperationMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static OperationMetadata parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
OperationMetadata
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static OperationMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OperationMetadata
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static OperationMetadata parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
OperationMetadata
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OperationMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OperationMetadata
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static OperationMetadata parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
OperationMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static OperationMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OperationMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<OperationMetadata> parser()
Returns
TypeDescription
Parser<OperationMetadata>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getApiVersion()

public String getApiVersion()

Output only. API version used to start the operation.

string api_version = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The apiVersion.

getApiVersionBytes()

public ByteString getApiVersionBytes()

Output only. API version used to start the operation.

string api_version = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for apiVersion.

getCreateTime()

public Timestamp getCreateTime()

Output only. The time the operation was created.

.google.protobuf.Timestamp create_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time the operation was created.

.google.protobuf.Timestamp create_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public OperationMetadata getDefaultInstanceForType()
Returns
TypeDescription
OperationMetadata

getEndTime()

public Timestamp getEndTime()

Output only. The time the operation finished running.

.google.protobuf.Timestamp end_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The endTime.

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

Output only. The time the operation finished running.

.google.protobuf.Timestamp end_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getParserForType()

public Parser<OperationMetadata> getParserForType()
Returns
TypeDescription
Parser<OperationMetadata>
Overrides

getRequestedCancellation()

public boolean getRequestedCancellation()

Output only. 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 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

The requestedCancellation.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getStatusMessage()

public String getStatusMessage()

Output only. Human-readable status of the operation, if any.

string status_message = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The statusMessage.

getStatusMessageBytes()

public ByteString getStatusMessageBytes()

Output only. Human-readable status of the operation, if any.

string status_message = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for statusMessage.

getTarget()

public String getTarget()

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

string target = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The target.

getTargetBytes()

public ByteString getTargetBytes()

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

string target = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for target.

getVerb()

public String getVerb()

Output only. Name of the verb executed by the operation.

string verb = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The verb.

getVerbBytes()

public ByteString getVerbBytes()

Output only. Name of the verb executed by the operation.

string verb = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for verb.

hasCreateTime()

public boolean hasCreateTime()

Output only. The time the operation was created.

.google.protobuf.Timestamp create_time = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasEndTime()

public boolean hasEndTime()

Output only. The time the operation finished running.

.google.protobuf.Timestamp end_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the endTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public OperationMetadata.Builder newBuilderForType()
Returns
TypeDescription
OperationMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected OperationMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
OperationMetadata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public OperationMetadata.Builder toBuilder()
Returns
TypeDescription
OperationMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException