Class OperationMetadata (3.40.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
Type Description
int

RESOURCE_NAMES_FIELD_NUMBER

public static final int RESOURCE_NAMES_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
Type Description
int

STEPS_FIELD_NUMBER

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

getDefaultInstanceForType()

public OperationMetadata getDefaultInstanceForType()
Returns
Type Description
OperationMetadata

getParserForType()

public Parser<OperationMetadata> getParserForType()
Returns
Type Description
Parser<OperationMetadata>
Overrides

getProgressPercentage()

public int getProgressPercentage()

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

int32 progress_percentage = 3;

Returns
Type Description
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
Name Description
index int

The index of the element to return.

Returns
Type Description
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
Name Description
index int

The index of the value to return.

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

A list containing the resourceNames.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStartTime()

public Timestamp getStartTime()

The start time of the operation.

.google.protobuf.Timestamp start_time = 4;

Returns
Type Description
Timestamp

The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

The start time of the operation.

.google.protobuf.Timestamp start_time = 4;

Returns
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
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
Type Description
boolean

Whether the startTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public OperationMetadata.Builder toBuilder()
Returns
Type Description
OperationMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException