Package io.dapr.v1

Class CommonProtos.StateItem

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.dapr.v1.CommonProtos.StateItem
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CommonProtos.StateItemOrBuilder, java.io.Serializable
Enclosing class:
CommonProtos
public static final class CommonProtos.StateItem
extends com.google.protobuf.GeneratedMessageV3
implements CommonProtos.StateItemOrBuilder
 StateItem represents state key, value, and additional options to save state.
Protobuf type dapr.proto.common.v1.StateItem
See Also:
Serialized Form

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  CommonProtos.StateItem.Builder
    StateItem represents state key, value, and additional options to save state.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, 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

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static int ETAG_FIELD_NUMBER  
    static int KEY_FIELD_NUMBER  
    static int METADATA_FIELD_NUMBER  
    static int OPTIONS_FIELD_NUMBER  
    static int VALUE_FIELD_NUMBER  

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type Method Description
    boolean containsMetadata​(java.lang.String key)
    The metadata which will be passed to state store component.
    boolean equals​(java.lang.Object obj)  
    static CommonProtos.StateItem getDefaultInstance()  
    CommonProtos.StateItem getDefaultInstanceForType()  
    static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
    java.lang.String getEtag()
    The entity tag which represents the specific version of data.
    com.google.protobuf.ByteString getEtagBytes()
    The entity tag which represents the specific version of data.
    java.lang.String getKey()
    Required.
    com.google.protobuf.ByteString getKeyBytes()
    Required.
    java.util.Map<java.lang.String,​java.lang.String> getMetadata()
    Deprecated.
    int getMetadataCount()
    The metadata which will be passed to state store component.
    java.util.Map<java.lang.String,​java.lang.String> getMetadataMap()
    The metadata which will be passed to state store component.
    java.lang.String getMetadataOrDefault​(java.lang.String key, java.lang.String defaultValue)
    The metadata which will be passed to state store component.
    java.lang.String getMetadataOrThrow​(java.lang.String key)
    The metadata which will be passed to state store component.
    CommonProtos.StateOptions getOptions()
    Options for concurrency and consistency to save the state.
    CommonProtos.StateOptionsOrBuilder getOptionsOrBuilder()
    Options for concurrency and consistency to save the state.
    com.google.protobuf.Parser<CommonProtos.StateItem> getParserForType()  
    int getSerializedSize()  
    com.google.protobuf.UnknownFieldSet getUnknownFields()  
    com.google.protobuf.ByteString getValue()
    Required.
    int hashCode()  
    boolean hasOptions()
    Options for concurrency and consistency to save the state.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
    protected com.google.protobuf.MapField internalGetMapField​(int number)  
    boolean isInitialized()  
    static CommonProtos.StateItem.Builder newBuilder()  
    static CommonProtos.StateItem.Builder newBuilder​(CommonProtos.StateItem prototype)  
    CommonProtos.StateItem.Builder newBuilderForType()  
    protected CommonProtos.StateItem.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
    protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
    static CommonProtos.StateItem parseDelimitedFrom​(java.io.InputStream input)  
    static CommonProtos.StateItem parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
    static CommonProtos.StateItem parseFrom​(byte[] data)  
    static CommonProtos.StateItem parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
    static CommonProtos.StateItem parseFrom​(com.google.protobuf.ByteString data)  
    static CommonProtos.StateItem parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
    static CommonProtos.StateItem parseFrom​(com.google.protobuf.CodedInputStream input)  
    static CommonProtos.StateItem parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
    static CommonProtos.StateItem parseFrom​(java.io.InputStream input)  
    static CommonProtos.StateItem parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
    static CommonProtos.StateItem parseFrom​(java.nio.ByteBuffer data)  
    static CommonProtos.StateItem parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
    static com.google.protobuf.Parser<CommonProtos.StateItem> parser()  
    CommonProtos.StateItem.Builder toBuilder()  
    void writeTo​(com.google.protobuf.CodedOutputStream output)  

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

  • Field Details

  • Method Details

    • newInstance

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

    • getUnknownFields

      public final com.google.protobuf.UnknownFieldSet getUnknownFields()
      Specified by:
      getUnknownFields in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getUnknownFields 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

    • getKey

      public java.lang.String getKey()
       Required. The state key
      string key = 1;
      Specified by:
      getKey in interface CommonProtos.StateItemOrBuilder
      Returns:
      The key.

    • getKeyBytes

      public com.google.protobuf.ByteString getKeyBytes()
       Required. The state key
      string key = 1;
      Specified by:
      getKeyBytes in interface CommonProtos.StateItemOrBuilder
      Returns:
      The bytes for key.

    • getValue

      public com.google.protobuf.ByteString getValue()
       Required. The state data for key
      bytes value = 2;
      Specified by:
      getValue in interface CommonProtos.StateItemOrBuilder
      Returns:
      The value.

    • getEtag

      public java.lang.String getEtag()
       The entity tag which represents the specific version of data.
 The exact ETag format is defined by the corresponding data store.
      string etag = 3;
      Specified by:
      getEtag in interface CommonProtos.StateItemOrBuilder
      Returns:
      The etag.

    • getEtagBytes

      public com.google.protobuf.ByteString getEtagBytes()
       The entity tag which represents the specific version of data.
 The exact ETag format is defined by the corresponding data store.
      string etag = 3;
      Specified by:
      getEtagBytes in interface CommonProtos.StateItemOrBuilder
      Returns:
      The bytes for etag.

    • getMetadataCount

      public int getMetadataCount()
      Description copied from interface: CommonProtos.StateItemOrBuilder
       The metadata which will be passed to state store component.
      map<string, string> metadata = 4;
      Specified by:
      getMetadataCount in interface CommonProtos.StateItemOrBuilder

    • containsMetadata

      public boolean containsMetadata​(java.lang.String key)
       The metadata which will be passed to state store component.
      map<string, string> metadata = 4;
      Specified by:
      containsMetadata in interface CommonProtos.StateItemOrBuilder

    • getMetadata

      @Deprecated public java.util.Map<java.lang.String,​java.lang.String> getMetadata()
      Deprecated.
      Use getMetadataMap() instead.
      Specified by:
      getMetadata in interface CommonProtos.StateItemOrBuilder

    • getMetadataMap

      public java.util.Map<java.lang.String,​java.lang.String> getMetadataMap()
       The metadata which will be passed to state store component.
      map<string, string> metadata = 4;
      Specified by:
      getMetadataMap in interface CommonProtos.StateItemOrBuilder

    • getMetadataOrDefault

      public java.lang.String getMetadataOrDefault​(java.lang.String key, java.lang.String defaultValue)
       The metadata which will be passed to state store component.
      map<string, string> metadata = 4;
      Specified by:
      getMetadataOrDefault in interface CommonProtos.StateItemOrBuilder

    • getMetadataOrThrow

      public java.lang.String getMetadataOrThrow​(java.lang.String key)
       The metadata which will be passed to state store component.
      map<string, string> metadata = 4;
      Specified by:
      getMetadataOrThrow in interface CommonProtos.StateItemOrBuilder

    • hasOptions

      public boolean hasOptions()
       Options for concurrency and consistency to save the state.
      .dapr.proto.common.v1.StateOptions options = 5;
      Specified by:
      hasOptions in interface CommonProtos.StateItemOrBuilder
      Returns:
      Whether the options field is set.

    • getOptions

      public CommonProtos.StateOptions getOptions()
       Options for concurrency and consistency to save the state.
      .dapr.proto.common.v1.StateOptions options = 5;
      Specified by:
      getOptions in interface CommonProtos.StateItemOrBuilder
      Returns:
      The options.

    • getOptionsOrBuilder

      public CommonProtos.StateOptionsOrBuilder getOptionsOrBuilder()
       Options for concurrency and consistency to save the state.
      .dapr.proto.common.v1.StateOptions options = 5;
      Specified by:
      getOptionsOrBuilder in interface CommonProtos.StateItemOrBuilder

    • 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 java.io.IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      java.io.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​(java.lang.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 CommonProtos.StateItem parseFrom​(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CommonProtos.StateItem parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static CommonProtos.StateItem parseFrom​(java.io.InputStream input) throws java.io.IOException
      Throws:
      java.io.IOException

    • parseFrom

      public static CommonProtos.StateItem parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
      Throws:
      java.io.IOException

    • parseDelimitedFrom

      public static CommonProtos.StateItem parseDelimitedFrom​(java.io.InputStream input) throws java.io.IOException
      Throws:
      java.io.IOException

    • parseDelimitedFrom

      public static CommonProtos.StateItem parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
      Throws:
      java.io.IOException

    • parseFrom

      public static CommonProtos.StateItem parseFrom​(com.google.protobuf.CodedInputStream input) throws java.io.IOException
      Throws:
      java.io.IOException

    • parseFrom

      public static CommonProtos.StateItem parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
      Throws:
      java.io.IOException

    • newBuilderForType

      public CommonProtos.StateItem.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static CommonProtos.StateItem.Builder newBuilder()

    • newBuilder

      public static CommonProtos.StateItem.Builder newBuilder​(CommonProtos.StateItem prototype)

    • toBuilder

      public CommonProtos.StateItem.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected CommonProtos.StateItem.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static CommonProtos.StateItem getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<CommonProtos.StateItem> parser()

    • getParserForType

      public com.google.protobuf.Parser<CommonProtos.StateItem> 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 CommonProtos.StateItem getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder