Class CommonMetadata (2.20.1)

public final class CommonMetadata extends GeneratedMessageV3 implements CommonMetadataOrBuilder

Metadata common to all Datastore Admin operations.

Protobuf type google.datastore.admin.v1.CommonMetadata

Static Fields

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

OPERATION_TYPE_FIELD_NUMBER

public static final int OPERATION_TYPE_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CommonMetadata getDefaultInstance()
Returns
Type Description
CommonMetadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static CommonMetadata.Builder newBuilder()
Returns
Type Description
CommonMetadata.Builder

newBuilder(CommonMetadata prototype)

public static CommonMetadata.Builder newBuilder(CommonMetadata prototype)
Parameter
Name Description
prototype CommonMetadata
Returns
Type Description
CommonMetadata.Builder

parseDelimitedFrom(InputStream input)

public static CommonMetadata parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CommonMetadata
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CommonMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CommonMetadata
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CommonMetadata parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CommonMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CommonMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CommonMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CommonMetadata parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CommonMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CommonMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CommonMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CommonMetadata parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CommonMetadata
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CommonMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CommonMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CommonMetadata parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CommonMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CommonMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CommonMetadata
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CommonMetadata parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CommonMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CommonMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CommonMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CommonMetadata> parser()
Returns
Type Description
Parser<CommonMetadata>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

The client-assigned labels which were provided when the operation was created. May also include additional labels.

map<string, string> labels = 4;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public CommonMetadata getDefaultInstanceForType()
Returns
Type Description
CommonMetadata

getEndTime()

public Timestamp getEndTime()

The time the operation ended, either successfully or otherwise.

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
Timestamp

The endTime.

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

The time the operation ended, either successfully or otherwise.

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
TimestampOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

The client-assigned labels which were provided when the operation was created. May also include additional labels.

map<string, string> labels = 4;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

The client-assigned labels which were provided when the operation was created. May also include additional labels.

map<string, string> labels = 4;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

The client-assigned labels which were provided when the operation was created. May also include additional labels.

map<string, string> labels = 4;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

The client-assigned labels which were provided when the operation was created. May also include additional labels.

map<string, string> labels = 4;

Parameter
Name Description
key String
Returns
Type Description
String

getOperationType()

public OperationType getOperationType()

The type of the operation. Can be used as a filter in ListOperationsRequest.

.google.datastore.admin.v1.OperationType operation_type = 3;

Returns
Type Description
OperationType

The operationType.

getOperationTypeValue()

public int getOperationTypeValue()

The type of the operation. Can be used as a filter in ListOperationsRequest.

.google.datastore.admin.v1.OperationType operation_type = 3;

Returns
Type Description
int

The enum numeric value on the wire for operationType.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStartTime()

public Timestamp getStartTime()

The time that work began on the operation.

.google.protobuf.Timestamp start_time = 1;

Returns
Type Description
Timestamp

The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

The time that work began on the operation.

.google.protobuf.Timestamp start_time = 1;

Returns
Type Description
TimestampOrBuilder

getState()

public CommonMetadata.State getState()

The current state of the Operation.

.google.datastore.admin.v1.CommonMetadata.State state = 5;

Returns
Type Description
CommonMetadata.State

The state.

getStateValue()

public int getStateValue()

The current state of the Operation.

.google.datastore.admin.v1.CommonMetadata.State state = 5;

Returns
Type Description
int

The enum numeric value on the wire for state.

hasEndTime()

public boolean hasEndTime()

The time the operation ended, either successfully or otherwise.

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
boolean

Whether the endTime field is set.

hasStartTime()

public boolean hasStartTime()

The time that work began on the operation.

.google.protobuf.Timestamp start_time = 1;

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CommonMetadata.Builder newBuilderForType()
Returns
Type Description
CommonMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CommonMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CommonMetadata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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