Package com.daml.ledger.api.v2.admin

Class ObjectMetaOuterClass.ObjectMeta

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.daml.ledger.api.v2.admin.ObjectMetaOuterClass.ObjectMeta
All Implemented Interfaces:
ObjectMetaOuterClass.ObjectMetaOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
ObjectMetaOuterClass
public static final class ObjectMetaOuterClass.ObjectMeta extends com.google.protobuf.GeneratedMessageV3 implements ObjectMetaOuterClass.ObjectMetaOrBuilder
 Represents metadata corresponding to a participant resource (e.g. a participant user or participant local information about a party).

 Based on ``ObjectMeta`` meta used in Kubernetes API.
 See https://github.com/kubernetes/apimachinery/blob/master/pkg/apis/meta/v1/generated.proto#L640
Protobuf type com.daml.ledger.api.v2.admin.ObjectMeta
See Also:

  • Field Details

    • RESOURCE_VERSION_FIELD_NUMBER

      public static final int RESOURCE_VERSION_FIELD_NUMBER
      See Also:

    • ANNOTATIONS_FIELD_NUMBER

      public static final int ANNOTATIONS_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()

    • 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

    • getResourceVersion

      public String getResourceVersion()
       An opaque, non-empty value, populated by a participant server which represents the internal version of the resource
 this ``ObjectMeta`` message is attached to. The participant server will change it to a unique value each time the corresponding resource is updated.
 You must not rely on the format of resource version. The participant server might change it without notice.
 You can obtain the newest resource version value by issuing a read request.
 You may use it for concurrent change detection by passing it back unmodified in an update request.
 The participant server will then compare the passed value with the value maintained by the system to determine
 if any other updates took place since you had read the resource version.
 Upon a successful update you are guaranteed that no other update took place during your read-modify-write sequence.
 However, if another update took place during your read-modify-write sequence then your update will fail with an appropriate error.
 Concurrent change control is optional. It will be applied only if you include a resource version in an update request.
 When creating a new instance of a resource you must leave the resource version empty.
 Its value will be populated by the participant server upon successful resource creation.
 Optional
      string resource_version = 6 [json_name = "resourceVersion"];
      Specified by:
      getResourceVersion in interface ObjectMetaOuterClass.ObjectMetaOrBuilder
      Returns:
      The resourceVersion.

    • getResourceVersionBytes

      public com.google.protobuf.ByteString getResourceVersionBytes()
       An opaque, non-empty value, populated by a participant server which represents the internal version of the resource
 this ``ObjectMeta`` message is attached to. The participant server will change it to a unique value each time the corresponding resource is updated.
 You must not rely on the format of resource version. The participant server might change it without notice.
 You can obtain the newest resource version value by issuing a read request.
 You may use it for concurrent change detection by passing it back unmodified in an update request.
 The participant server will then compare the passed value with the value maintained by the system to determine
 if any other updates took place since you had read the resource version.
 Upon a successful update you are guaranteed that no other update took place during your read-modify-write sequence.
 However, if another update took place during your read-modify-write sequence then your update will fail with an appropriate error.
 Concurrent change control is optional. It will be applied only if you include a resource version in an update request.
 When creating a new instance of a resource you must leave the resource version empty.
 Its value will be populated by the participant server upon successful resource creation.
 Optional
      string resource_version = 6 [json_name = "resourceVersion"];
      Specified by:
      getResourceVersionBytes in interface ObjectMetaOuterClass.ObjectMetaOrBuilder
      Returns:
      The bytes for resourceVersion.

    • getAnnotationsCount

      public int getAnnotationsCount()
      Description copied from interface: ObjectMetaOuterClass.ObjectMetaOrBuilder
       A set of modifiable key-value pairs that can be used to represent arbitrary, client-specific metadata.
 Constraints:

 1. The total size over all keys and values cannot exceed 256kb in UTF-8 encoding.
 2. Keys are composed of an optional prefix segment and a required name segment such that:

    - key prefix, when present, must be a valid DNS subdomain with at most 253 characters, followed by a '/' (forward slash) character,
    - name segment must have at most 63 characters that are either alphanumeric ([a-z0-9A-Z]), or a '.' (dot), '-' (dash) or '_' (underscore);
      and it must start and end with an alphanumeric character.

 3. Values can be any non-empty strings.

 Keys with empty prefix are reserved for end-users.
 Properties set by external tools or internally by the participant server must use non-empty key prefixes.
 Duplicate keys are disallowed by the semantics of the protobuf3 maps.
 See: https://developers.google.com/protocol-buffers/docs/proto3#maps
 Annotations may be a part of a modifiable resource.
 Use the resource's update RPC to update its annotations.
 In order to add a new annotation or update an existing one using an update RPC, provide the desired annotation in the update request.
 In order to remove an annotation using an update RPC, provide the target annotation's key but set its value to the empty string in the update request.
 Optional
 Modifiable
      map<string, string> annotations = 12 [json_name = "annotations"];
      Specified by:
      getAnnotationsCount in interface ObjectMetaOuterClass.ObjectMetaOrBuilder

    • containsAnnotations

      public boolean containsAnnotations(String key)
       A set of modifiable key-value pairs that can be used to represent arbitrary, client-specific metadata.
 Constraints:

 1. The total size over all keys and values cannot exceed 256kb in UTF-8 encoding.
 2. Keys are composed of an optional prefix segment and a required name segment such that:

    - key prefix, when present, must be a valid DNS subdomain with at most 253 characters, followed by a '/' (forward slash) character,
    - name segment must have at most 63 characters that are either alphanumeric ([a-z0-9A-Z]), or a '.' (dot), '-' (dash) or '_' (underscore);
      and it must start and end with an alphanumeric character.

 3. Values can be any non-empty strings.

 Keys with empty prefix are reserved for end-users.
 Properties set by external tools or internally by the participant server must use non-empty key prefixes.
 Duplicate keys are disallowed by the semantics of the protobuf3 maps.
 See: https://developers.google.com/protocol-buffers/docs/proto3#maps
 Annotations may be a part of a modifiable resource.
 Use the resource's update RPC to update its annotations.
 In order to add a new annotation or update an existing one using an update RPC, provide the desired annotation in the update request.
 In order to remove an annotation using an update RPC, provide the target annotation's key but set its value to the empty string in the update request.
 Optional
 Modifiable
      map<string, string> annotations = 12 [json_name = "annotations"];
      Specified by:
      containsAnnotations in interface ObjectMetaOuterClass.ObjectMetaOrBuilder

    • getAnnotations

      @Deprecated public Map<String,String> getAnnotations()
      Deprecated.
      Use getAnnotationsMap() instead.
      Specified by:
      getAnnotations in interface ObjectMetaOuterClass.ObjectMetaOrBuilder

    • getAnnotationsMap

      public Map<String,String> getAnnotationsMap()
       A set of modifiable key-value pairs that can be used to represent arbitrary, client-specific metadata.
 Constraints:

 1. The total size over all keys and values cannot exceed 256kb in UTF-8 encoding.
 2. Keys are composed of an optional prefix segment and a required name segment such that:

    - key prefix, when present, must be a valid DNS subdomain with at most 253 characters, followed by a '/' (forward slash) character,
    - name segment must have at most 63 characters that are either alphanumeric ([a-z0-9A-Z]), or a '.' (dot), '-' (dash) or '_' (underscore);
      and it must start and end with an alphanumeric character.

 3. Values can be any non-empty strings.

 Keys with empty prefix are reserved for end-users.
 Properties set by external tools or internally by the participant server must use non-empty key prefixes.
 Duplicate keys are disallowed by the semantics of the protobuf3 maps.
 See: https://developers.google.com/protocol-buffers/docs/proto3#maps
 Annotations may be a part of a modifiable resource.
 Use the resource's update RPC to update its annotations.
 In order to add a new annotation or update an existing one using an update RPC, provide the desired annotation in the update request.
 In order to remove an annotation using an update RPC, provide the target annotation's key but set its value to the empty string in the update request.
 Optional
 Modifiable
      map<string, string> annotations = 12 [json_name = "annotations"];
      Specified by:
      getAnnotationsMap in interface ObjectMetaOuterClass.ObjectMetaOrBuilder

    • getAnnotationsOrDefault

      public String getAnnotationsOrDefault(String key, String defaultValue)
       A set of modifiable key-value pairs that can be used to represent arbitrary, client-specific metadata.
 Constraints:

 1. The total size over all keys and values cannot exceed 256kb in UTF-8 encoding.
 2. Keys are composed of an optional prefix segment and a required name segment such that:

    - key prefix, when present, must be a valid DNS subdomain with at most 253 characters, followed by a '/' (forward slash) character,
    - name segment must have at most 63 characters that are either alphanumeric ([a-z0-9A-Z]), or a '.' (dot), '-' (dash) or '_' (underscore);
      and it must start and end with an alphanumeric character.

 3. Values can be any non-empty strings.

 Keys with empty prefix are reserved for end-users.
 Properties set by external tools or internally by the participant server must use non-empty key prefixes.
 Duplicate keys are disallowed by the semantics of the protobuf3 maps.
 See: https://developers.google.com/protocol-buffers/docs/proto3#maps
 Annotations may be a part of a modifiable resource.
 Use the resource's update RPC to update its annotations.
 In order to add a new annotation or update an existing one using an update RPC, provide the desired annotation in the update request.
 In order to remove an annotation using an update RPC, provide the target annotation's key but set its value to the empty string in the update request.
 Optional
 Modifiable
      map<string, string> annotations = 12 [json_name = "annotations"];
      Specified by:
      getAnnotationsOrDefault in interface ObjectMetaOuterClass.ObjectMetaOrBuilder

    • getAnnotationsOrThrow

      public String getAnnotationsOrThrow(String key)
       A set of modifiable key-value pairs that can be used to represent arbitrary, client-specific metadata.
 Constraints:

 1. The total size over all keys and values cannot exceed 256kb in UTF-8 encoding.
 2. Keys are composed of an optional prefix segment and a required name segment such that:

    - key prefix, when present, must be a valid DNS subdomain with at most 253 characters, followed by a '/' (forward slash) character,
    - name segment must have at most 63 characters that are either alphanumeric ([a-z0-9A-Z]), or a '.' (dot), '-' (dash) or '_' (underscore);
      and it must start and end with an alphanumeric character.

 3. Values can be any non-empty strings.

 Keys with empty prefix are reserved for end-users.
 Properties set by external tools or internally by the participant server must use non-empty key prefixes.
 Duplicate keys are disallowed by the semantics of the protobuf3 maps.
 See: https://developers.google.com/protocol-buffers/docs/proto3#maps
 Annotations may be a part of a modifiable resource.
 Use the resource's update RPC to update its annotations.
 In order to add a new annotation or update an existing one using an update RPC, provide the desired annotation in the update request.
 In order to remove an annotation using an update RPC, provide the target annotation's key but set its value to the empty string in the update request.
 Optional
 Modifiable
      map<string, string> annotations = 12 [json_name = "annotations"];
      Specified by:
      getAnnotationsOrThrow in interface ObjectMetaOuterClass.ObjectMetaOrBuilder

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

    • parseFrom

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

    • parseFrom

      public static ObjectMetaOuterClass.ObjectMeta parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static ObjectMetaOuterClass.ObjectMeta parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static ObjectMetaOuterClass.ObjectMeta parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static ObjectMetaOuterClass.ObjectMeta parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ObjectMetaOuterClass.ObjectMeta.Builder newBuilder()

    • newBuilder

      public static ObjectMetaOuterClass.ObjectMeta.Builder newBuilder(ObjectMetaOuterClass.ObjectMeta prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static ObjectMetaOuterClass.ObjectMeta getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ObjectMetaOuterClass.ObjectMeta> parser()

    • getParserForType

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