Class OperationMetadata (2.47.0)

Version 2.47.0

• 2.51.0 (latest)
• 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.40.0
• 2.39.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.28.0
• 2.27.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.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.7
• 2.2.1
• 2.1.12

public final class OperationMetadata extends GeneratedMessageV3 implements OperationMetadataOrBuilder

Represents the metadata of the long-running operation.

Protobuf type google.cloud.apigateway.v1.OperationMetadata

Inheritance

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

Implements

OperationMetadataOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

API_VERSION_FIELD_NUMBER

public static final int API_VERSION_FIELD_NUMBER

Field Value
Type	Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

Field Value
Type	Description
int

DIAGNOSTICS_FIELD_NUMBER

public static final int DIAGNOSTICS_FIELD_NUMBER

Field Value
Type	Description
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER

Field Value
Type	Description
int

REQUESTED_CANCELLATION_FIELD_NUMBER

public static final int REQUESTED_CANCELLATION_FIELD_NUMBER

Field Value
Type	Description
int

STATUS_MESSAGE_FIELD_NUMBER

public static final int STATUS_MESSAGE_FIELD_NUMBER

Field Value
Type	Description
int

TARGET_FIELD_NUMBER

public static final int TARGET_FIELD_NUMBER

Field Value
Type	Description
int

VERB_FIELD_NUMBER

public static final int VERB_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static OperationMetadata getDefaultInstance()

Returns
Type	Description
OperationMetadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static OperationMetadata.Builder newBuilder()

Returns
Type	Description
OperationMetadata.Builder

newBuilder(OperationMetadata prototype)

public static OperationMetadata.Builder newBuilder(OperationMetadata prototype)

Parameter
Name	Description
prototype	OperationMetadata

Returns
Type	Description
OperationMetadata.Builder

parseDelimitedFrom(InputStream input)

public static OperationMetadata parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
OperationMetadata

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OperationMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
OperationMetadata

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static OperationMetadata parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
OperationMetadata

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static OperationMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
OperationMetadata

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static OperationMetadata parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
OperationMetadata

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static OperationMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
OperationMetadata

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static OperationMetadata parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
OperationMetadata

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static OperationMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
OperationMetadata

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static OperationMetadata parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
OperationMetadata

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OperationMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
OperationMetadata

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static OperationMetadata parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
OperationMetadata

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static OperationMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
OperationMetadata

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<OperationMetadata> parser()

Returns
Type	Description
Parser<OperationMetadata>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getApiVersion()

public String getApiVersion()

Output only. API version used to start the operation.

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

Returns
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
TimestampOrBuilder

getDefaultInstanceForType()

public OperationMetadata getDefaultInstanceForType()

Returns
Type	Description
OperationMetadata

getDiagnostics(int index)

public OperationMetadata.Diagnostic getDiagnostics(int index)

Output only. Diagnostics generated during processing of configuration source files.

repeated .google.cloud.apigateway.v1.OperationMetadata.Diagnostic diagnostics = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
OperationMetadata.Diagnostic

getDiagnosticsCount()

public int getDiagnosticsCount()

Output only. Diagnostics generated during processing of configuration source files.

repeated .google.cloud.apigateway.v1.OperationMetadata.Diagnostic diagnostics = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int

getDiagnosticsList()

public List<OperationMetadata.Diagnostic> getDiagnosticsList()

Output only. Diagnostics generated during processing of configuration source files.

repeated .google.cloud.apigateway.v1.OperationMetadata.Diagnostic diagnostics = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<Diagnostic>

getDiagnosticsOrBuilder(int index)

public OperationMetadata.DiagnosticOrBuilder getDiagnosticsOrBuilder(int index)

Output only. Diagnostics generated during processing of configuration source files.

repeated .google.cloud.apigateway.v1.OperationMetadata.Diagnostic diagnostics = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
OperationMetadata.DiagnosticOrBuilder

getDiagnosticsOrBuilderList()

public List<? extends OperationMetadata.DiagnosticOrBuilder> getDiagnosticsOrBuilderList()

Output only. Diagnostics generated during processing of configuration source files.

repeated .google.cloud.apigateway.v1.OperationMetadata.Diagnostic diagnostics = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<? extends com.google.cloud.apigateway.v1.OperationMetadata.DiagnosticOrBuilder>

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
Type	Description
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
Type	Description
TimestampOrBuilder

getParserForType()

public Parser<OperationMetadata> getParserForType()

Returns
Type	Description
Parser<OperationMetadata>

Overrides

GeneratedMessageV3.getParserForType()

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
Type	Description
boolean	The requestedCancellation.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
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
Type	Description
boolean	Whether the endTime field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public OperationMetadata.Builder newBuilderForType()

Returns
Type	Description
OperationMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected OperationMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
OperationMetadata.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public OperationMetadata.Builder toBuilder()

Returns
Type	Description
OperationMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException