Package com.daml.ledger.api.v1.admin

Class ObjectMetaOuterClass.ObjectMeta.Builder

  • All Implemented Interfaces:
    ObjectMetaOuterClass.ObjectMetaOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable
    Enclosing class:
    ObjectMetaOuterClass.ObjectMeta
    public static final class ObjectMetaOuterClass.ObjectMeta.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ObjectMetaOuterClass.ObjectMeta.Builder>
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.v1.admin.ObjectMeta

    • Method Detail

      • 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.Builder<ObjectMetaOuterClass.ObjectMeta.Builder>

      • internalGetMutableMapField

        protected com.google.protobuf.MapField internalGetMutableMapField​(int number)
        Overrides:
        internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<ObjectMetaOuterClass.ObjectMeta.Builder>

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ObjectMetaOuterClass.ObjectMeta.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ObjectMetaOuterClass.ObjectMeta.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ObjectMetaOuterClass.ObjectMeta.Builder>

      • mergeFrom

        public ObjectMetaOuterClass.ObjectMeta.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ObjectMetaOuterClass.ObjectMeta.Builder>
        Throws:
        java.io.IOException

      • getResourceVersion

        public java.lang.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.

      • setResourceVersion

        public ObjectMetaOuterClass.ObjectMeta.Builder setResourceVersion​(java.lang.String value)
         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"];
        Parameters:
        value - The resourceVersion to set.
        Returns:
        This builder for chaining.

      • clearResourceVersion

        public ObjectMetaOuterClass.ObjectMeta.Builder clearResourceVersion()
         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"];
        Returns:
        This builder for chaining.

      • setResourceVersionBytes

        public ObjectMetaOuterClass.ObjectMeta.Builder setResourceVersionBytes​(com.google.protobuf.ByteString value)
         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"];
        Parameters:
        value - The bytes for resourceVersion to set.
        Returns:
        This builder for chaining.

      • 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.
 2. 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​(java.lang.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.
 2. 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

      • getAnnotationsMap

        public java.util.Map<java.lang.String,​java.lang.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.
 2. 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 java.lang.String getAnnotationsOrDefault​(java.lang.String key,
                                                java.lang.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.
 2. 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 java.lang.String getAnnotationsOrThrow​(java.lang.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.
 2. 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

      • removeAnnotations

        public ObjectMetaOuterClass.ObjectMeta.Builder removeAnnotations​(java.lang.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.
 2. 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"];

      • getMutableAnnotations

        @Deprecated
public java.util.Map<java.lang.String,​java.lang.String> getMutableAnnotations()
        Deprecated.
        Use alternate mutation accessors instead.

      • putAnnotations

        public ObjectMetaOuterClass.ObjectMeta.Builder putAnnotations​(java.lang.String key,
                                                              java.lang.String value)
         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.
 2. 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"];

      • putAllAnnotations

        public ObjectMetaOuterClass.ObjectMeta.Builder putAllAnnotations​(java.util.Map<java.lang.String,​java.lang.String> values)
         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.
 2. 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"];