Package io.dapr.v1

Class DaprProtos.TryLockRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.dapr.v1.DaprProtos.TryLockRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, DaprProtos.TryLockRequestOrBuilder, Serializable
Enclosing class:
DaprProtos
public static final class DaprProtos.TryLockRequest extends com.google.protobuf.GeneratedMessageV3 implements DaprProtos.TryLockRequestOrBuilder
Protobuf type dapr.proto.runtime.v1.TryLockRequest
See Also:

  • Field Details

    • STORE_NAME_FIELD_NUMBER

      public static final int STORE_NAME_FIELD_NUMBER
      See Also:

    • RESOURCE_ID_FIELD_NUMBER

      public static final int RESOURCE_ID_FIELD_NUMBER
      See Also:

    • LOCK_OWNER_FIELD_NUMBER

      public static final int LOCK_OWNER_FIELD_NUMBER
      See Also:

    • EXPIRY_IN_SECONDS_FIELD_NUMBER

      public static final int EXPIRY_IN_SECONDS_FIELD_NUMBER
      See Also:

  • Method Details

    • 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()

    • internalGetFieldAccessorTable

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

    • getStoreName

      public String getStoreName()
       Required. The lock store name,e.g. `redis`.
      string store_name = 1 [json_name = "storeName"];
      Specified by:
      getStoreName in interface DaprProtos.TryLockRequestOrBuilder
      Returns:
      The storeName.

    • getStoreNameBytes

      public com.google.protobuf.ByteString getStoreNameBytes()
       Required. The lock store name,e.g. `redis`.
      string store_name = 1 [json_name = "storeName"];
      Specified by:
      getStoreNameBytes in interface DaprProtos.TryLockRequestOrBuilder
      Returns:
      The bytes for storeName.

    • getResourceId

      public String getResourceId()
       Required. resource_id is the lock key. e.g. `order_id_111`
 It stands for "which resource I want to protect"
      string resource_id = 2 [json_name = "resourceId"];
      Specified by:
      getResourceId in interface DaprProtos.TryLockRequestOrBuilder
      Returns:
      The resourceId.

    • getResourceIdBytes

      public com.google.protobuf.ByteString getResourceIdBytes()
       Required. resource_id is the lock key. e.g. `order_id_111`
 It stands for "which resource I want to protect"
      string resource_id = 2 [json_name = "resourceId"];
      Specified by:
      getResourceIdBytes in interface DaprProtos.TryLockRequestOrBuilder
      Returns:
      The bytes for resourceId.

    • getLockOwner

      public String getLockOwner()
       Required. lock_owner indicate the identifier of lock owner.
 You can generate a uuid as lock_owner.For example,in golang:

 req.LockOwner = uuid.New().String()

 This field is per request,not per process,so it is different for each request,
 which aims to prevent multi-thread in the same process trying the same lock concurrently.

 The reason why we don't make it automatically generated is:
 1. If it is automatically generated,there must be a 'my_lock_owner_id' field in the response.
   This name is so weird that we think it is inappropriate to put it into the api spec
 2. If we change the field 'my_lock_owner_id' in the response to 'lock_owner',which means the current lock owner of this lock,
   we find that in some lock services users can't get the current lock owner.Actually users don't need it at all.
 3. When reentrant lock is needed,the existing lock_owner is required to identify client and check "whether this client can reenter this lock".
   So this field in the request shouldn't be removed.
      string lock_owner = 3 [json_name = "lockOwner"];
      Specified by:
      getLockOwner in interface DaprProtos.TryLockRequestOrBuilder
      Returns:
      The lockOwner.

    • getLockOwnerBytes

      public com.google.protobuf.ByteString getLockOwnerBytes()
       Required. lock_owner indicate the identifier of lock owner.
 You can generate a uuid as lock_owner.For example,in golang:

 req.LockOwner = uuid.New().String()

 This field is per request,not per process,so it is different for each request,
 which aims to prevent multi-thread in the same process trying the same lock concurrently.

 The reason why we don't make it automatically generated is:
 1. If it is automatically generated,there must be a 'my_lock_owner_id' field in the response.
   This name is so weird that we think it is inappropriate to put it into the api spec
 2. If we change the field 'my_lock_owner_id' in the response to 'lock_owner',which means the current lock owner of this lock,
   we find that in some lock services users can't get the current lock owner.Actually users don't need it at all.
 3. When reentrant lock is needed,the existing lock_owner is required to identify client and check "whether this client can reenter this lock".
   So this field in the request shouldn't be removed.
      string lock_owner = 3 [json_name = "lockOwner"];
      Specified by:
      getLockOwnerBytes in interface DaprProtos.TryLockRequestOrBuilder
      Returns:
      The bytes for lockOwner.

    • getExpiryInSeconds

      public int getExpiryInSeconds()
       Required. The time before expiry.The time unit is second.
      int32 expiry_in_seconds = 4 [json_name = "expiryInSeconds"];
      Specified by:
      getExpiryInSeconds in interface DaprProtos.TryLockRequestOrBuilder
      Returns:
      The expiryInSeconds.

    • 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 DaprProtos.TryLockRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DaprProtos.TryLockRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DaprProtos.TryLockRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DaprProtos.TryLockRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DaprProtos.TryLockRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static DaprProtos.TryLockRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DaprProtos.TryLockRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DaprProtos.TryLockRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DaprProtos.TryLockRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DaprProtos.TryLockRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DaprProtos.TryLockRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static DaprProtos.TryLockRequest.Builder newBuilder()

    • newBuilder

      public static DaprProtos.TryLockRequest.Builder newBuilder(DaprProtos.TryLockRequest prototype)

    • toBuilder

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

    • newBuilderForType

      protected DaprProtos.TryLockRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static DaprProtos.TryLockRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<DaprProtos.TryLockRequest> parser()

    • getParserForType

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