Class OperationMetadata (3.25.0)

public final class OperationMetadata extends GeneratedMessageV3 implements OperationMetadataOrBuilder

The metadata associated with a long running operation resource.

Protobuf type google.api.servicemanagement.v1.OperationMetadata

Static Fields

PROGRESS_PERCENTAGE_FIELD_NUMBER

public static final int PROGRESS_PERCENTAGE_FIELD_NUMBER
Field Value
TypeDescription
int

RESOURCE_NAMES_FIELD_NUMBER

public static final int RESOURCE_NAMES_FIELD_NUMBER
Field Value
TypeDescription
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

STEPS_FIELD_NUMBER

public static final int STEPS_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

getDefaultInstanceForType()

public OperationMetadata getDefaultInstanceForType()
Returns
TypeDescription
OperationMetadata

getParserForType()

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

getProgressPercentage()

public int getProgressPercentage()

Percentage of completion of this operation, ranging from 0 to 100.

int32 progress_percentage = 3;

Returns
TypeDescription
int

The progressPercentage.

getResourceNames(int index)

public String getResourceNames(int index)

The full name of the resources that this operation is directly associated with.

repeated string resource_names = 1;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The resourceNames at the given index.

getResourceNamesBytes(int index)

public ByteString getResourceNamesBytes(int index)

The full name of the resources that this operation is directly associated with.

repeated string resource_names = 1;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the resourceNames at the given index.

getResourceNamesCount()

public int getResourceNamesCount()

The full name of the resources that this operation is directly associated with.

repeated string resource_names = 1;

Returns
TypeDescription
int

The count of resourceNames.

getResourceNamesList()

public ProtocolStringList getResourceNamesList()

The full name of the resources that this operation is directly associated with.

repeated string resource_names = 1;

Returns
TypeDescription
ProtocolStringList

A list containing the resourceNames.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getStartTime()

public Timestamp getStartTime()

The start time of the operation.

.google.protobuf.Timestamp start_time = 4;

Returns
TypeDescription
Timestamp

The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

The start time of the operation.

.google.protobuf.Timestamp start_time = 4;

Returns
TypeDescription
TimestampOrBuilder

getSteps(int index)

public OperationMetadata.Step getSteps(int index)

Detailed status information for each step. The order is undetermined.

repeated .google.api.servicemanagement.v1.OperationMetadata.Step steps = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
OperationMetadata.Step

getStepsCount()

public int getStepsCount()

Detailed status information for each step. The order is undetermined.

repeated .google.api.servicemanagement.v1.OperationMetadata.Step steps = 2;

Returns
TypeDescription
int

getStepsList()

public List<OperationMetadata.Step> getStepsList()

Detailed status information for each step. The order is undetermined.

repeated .google.api.servicemanagement.v1.OperationMetadata.Step steps = 2;

Returns
TypeDescription
List<Step>

getStepsOrBuilder(int index)

public OperationMetadata.StepOrBuilder getStepsOrBuilder(int index)

Detailed status information for each step. The order is undetermined.

repeated .google.api.servicemanagement.v1.OperationMetadata.Step steps = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
OperationMetadata.StepOrBuilder

getStepsOrBuilderList()

public List<? extends OperationMetadata.StepOrBuilder> getStepsOrBuilderList()

Detailed status information for each step. The order is undetermined.

repeated .google.api.servicemanagement.v1.OperationMetadata.Step steps = 2;

Returns
TypeDescription
List<? extends com.google.api.servicemanagement.v1.OperationMetadata.StepOrBuilder>

hasStartTime()

public boolean hasStartTime()

The start time of the operation.

.google.protobuf.Timestamp start_time = 4;

Returns
TypeDescription
boolean

Whether the startTime 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