Class CommonMetadata

  • All Implemented Interfaces:
    CommonMetadataOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class CommonMetadata
    extends com.google.protobuf.GeneratedMessageV3
    implements CommonMetadataOrBuilder
     Metadata common to all Datastore Admin operations.
     
    Protobuf type google.datastore.admin.v1.CommonMetadata
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  CommonMetadata.Builder
      Metadata common to all Datastore Admin operations.
      static class  CommonMetadata.State
      The various possible states for an ongoing Operation.
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • hasStartTime

        public boolean hasStartTime()
         The time that work began on the operation.
         
        .google.protobuf.Timestamp start_time = 1;
        Specified by:
        hasStartTime in interface CommonMetadataOrBuilder
        Returns:
        Whether the startTime field is set.
      • getStartTime

        public com.google.protobuf.Timestamp getStartTime()
         The time that work began on the operation.
         
        .google.protobuf.Timestamp start_time = 1;
        Specified by:
        getStartTime in interface CommonMetadataOrBuilder
        Returns:
        The startTime.
      • getStartTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
         The time that work began on the operation.
         
        .google.protobuf.Timestamp start_time = 1;
        Specified by:
        getStartTimeOrBuilder in interface CommonMetadataOrBuilder
      • hasEndTime

        public boolean hasEndTime()
         The time the operation ended, either successfully or otherwise.
         
        .google.protobuf.Timestamp end_time = 2;
        Specified by:
        hasEndTime in interface CommonMetadataOrBuilder
        Returns:
        Whether the endTime field is set.
      • getEndTime

        public com.google.protobuf.Timestamp getEndTime()
         The time the operation ended, either successfully or otherwise.
         
        .google.protobuf.Timestamp end_time = 2;
        Specified by:
        getEndTime in interface CommonMetadataOrBuilder
        Returns:
        The endTime.
      • getEndTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()
         The time the operation ended, either successfully or otherwise.
         
        .google.protobuf.Timestamp end_time = 2;
        Specified by:
        getEndTimeOrBuilder in interface CommonMetadataOrBuilder
      • 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;
        Specified by:
        getOperationTypeValue in interface CommonMetadataOrBuilder
        Returns:
        The enum numeric value on the wire for operationType.
      • 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;
        Specified by:
        getOperationType in interface CommonMetadataOrBuilder
        Returns:
        The operationType.
      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: CommonMetadataOrBuilder
         The client-assigned labels which were provided when the operation was
         created. May also include additional labels.
         
        map<string, string> labels = 4;
        Specified by:
        getLabelsCount in interface CommonMetadataOrBuilder
      • containsLabels

        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;
        Specified by:
        containsLabels in interface CommonMetadataOrBuilder
      • 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;
        Specified by:
        getLabelsMap in interface CommonMetadataOrBuilder
      • getLabelsOrDefault

        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;
        Specified by:
        getLabelsOrDefault in interface CommonMetadataOrBuilder
      • getLabelsOrThrow

        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;
        Specified by:
        getLabelsOrThrow in interface CommonMetadataOrBuilder
      • getStateValue

        public int getStateValue()
         The current state of the Operation.
         
        .google.datastore.admin.v1.CommonMetadata.State state = 5;
        Specified by:
        getStateValue in interface CommonMetadataOrBuilder
        Returns:
        The enum numeric value on the wire for state.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static CommonMetadata parseFrom​(ByteBuffer data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static CommonMetadata parseFrom​(ByteBuffer data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static CommonMetadata parseFrom​(com.google.protobuf.ByteString data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static CommonMetadata parseFrom​(com.google.protobuf.ByteString data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static CommonMetadata parseFrom​(byte[] data)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static CommonMetadata parseFrom​(byte[] data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static CommonMetadata parseFrom​(com.google.protobuf.CodedInputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException
        Throws:
        IOException
      • newBuilderForType

        public CommonMetadata.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public CommonMetadata.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected CommonMetadata.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstance

        public static CommonMetadata getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<CommonMetadata> parser()
      • getParserForType

        public com.google.protobuf.Parser<CommonMetadata> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public CommonMetadata getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder