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

Class UserManagementServiceOuterClass.User.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<UserManagementServiceOuterClass.User.Builder>
com.daml.ledger.api.v2.admin.UserManagementServiceOuterClass.User.Builder
All Implemented Interfaces:
UserManagementServiceOuterClass.UserOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
UserManagementServiceOuterClass.User
public static final class UserManagementServiceOuterClass.User.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<UserManagementServiceOuterClass.User.Builder> implements UserManagementServiceOuterClass.UserOrBuilder
 Users are used to dynamically manage the rights given to Daml applications.
 They are stored and managed per participant node.
Protobuf type com.daml.ledger.api.v2.admin.User

  • Method Details

    • 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.Builder<UserManagementServiceOuterClass.User.Builder>

    • clear

      public UserManagementServiceOuterClass.User.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<UserManagementServiceOuterClass.User.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<UserManagementServiceOuterClass.User.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

      public UserManagementServiceOuterClass.User.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<UserManagementServiceOuterClass.User.Builder>

    • setField

      public UserManagementServiceOuterClass.User.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<UserManagementServiceOuterClass.User.Builder>

    • clearField

      public UserManagementServiceOuterClass.User.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<UserManagementServiceOuterClass.User.Builder>

    • clearOneof

      public UserManagementServiceOuterClass.User.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<UserManagementServiceOuterClass.User.Builder>

    • setRepeatedField

      public UserManagementServiceOuterClass.User.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<UserManagementServiceOuterClass.User.Builder>

    • addRepeatedField

      public UserManagementServiceOuterClass.User.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<UserManagementServiceOuterClass.User.Builder>

    • mergeFrom

      public UserManagementServiceOuterClass.User.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<UserManagementServiceOuterClass.User.Builder>

    • mergeFrom

      public UserManagementServiceOuterClass.User.Builder mergeFrom(UserManagementServiceOuterClass.User other)

    • isInitialized

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

    • mergeFrom

      public UserManagementServiceOuterClass.User.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws 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<UserManagementServiceOuterClass.User.Builder>
      Throws:
      IOException

    • getId

      public String getId()
       The user identifier, which must be a non-empty string of at most 128
 characters that are either alphanumeric ASCII characters or one of the symbols "@^$.!`-#+'~_|:".
 Required
      string id = 1 [json_name = "id"];
      Specified by:
      getId in interface UserManagementServiceOuterClass.UserOrBuilder
      Returns:
      The id.

    • getIdBytes

      public com.google.protobuf.ByteString getIdBytes()
       The user identifier, which must be a non-empty string of at most 128
 characters that are either alphanumeric ASCII characters or one of the symbols "@^$.!`-#+'~_|:".
 Required
      string id = 1 [json_name = "id"];
      Specified by:
      getIdBytes in interface UserManagementServiceOuterClass.UserOrBuilder
      Returns:
      The bytes for id.

    • setId

      public UserManagementServiceOuterClass.User.Builder setId(String value)
       The user identifier, which must be a non-empty string of at most 128
 characters that are either alphanumeric ASCII characters or one of the symbols "@^$.!`-#+'~_|:".
 Required
      string id = 1 [json_name = "id"];
      Parameters:
      value - The id to set.
      Returns:
      This builder for chaining.

    • clearId

      public UserManagementServiceOuterClass.User.Builder clearId()
       The user identifier, which must be a non-empty string of at most 128
 characters that are either alphanumeric ASCII characters or one of the symbols "@^$.!`-#+'~_|:".
 Required
      string id = 1 [json_name = "id"];
      Returns:
      This builder for chaining.

    • setIdBytes

      public UserManagementServiceOuterClass.User.Builder setIdBytes(com.google.protobuf.ByteString value)
       The user identifier, which must be a non-empty string of at most 128
 characters that are either alphanumeric ASCII characters or one of the symbols "@^$.!`-#+'~_|:".
 Required
      string id = 1 [json_name = "id"];
      Parameters:
      value - The bytes for id to set.
      Returns:
      This builder for chaining.

    • getPrimaryParty

      public String getPrimaryParty()
       The primary party as which this user reads and acts by default on the ledger
 *provided* it has the corresponding ``CanReadAs(primary_party)`` or
 ``CanActAs(primary_party)`` rights.
 Ledger API clients SHOULD set this field to a non-empty value for all users to
 enable the users to act on the ledger using their own Daml party.
 Users for participant administrators MAY have an associated primary party.
 Optional,
 Modifiable
      string primary_party = 2 [json_name = "primaryParty"];
      Specified by:
      getPrimaryParty in interface UserManagementServiceOuterClass.UserOrBuilder
      Returns:
      The primaryParty.

    • getPrimaryPartyBytes

      public com.google.protobuf.ByteString getPrimaryPartyBytes()
       The primary party as which this user reads and acts by default on the ledger
 *provided* it has the corresponding ``CanReadAs(primary_party)`` or
 ``CanActAs(primary_party)`` rights.
 Ledger API clients SHOULD set this field to a non-empty value for all users to
 enable the users to act on the ledger using their own Daml party.
 Users for participant administrators MAY have an associated primary party.
 Optional,
 Modifiable
      string primary_party = 2 [json_name = "primaryParty"];
      Specified by:
      getPrimaryPartyBytes in interface UserManagementServiceOuterClass.UserOrBuilder
      Returns:
      The bytes for primaryParty.

    • setPrimaryParty

      public UserManagementServiceOuterClass.User.Builder setPrimaryParty(String value)
       The primary party as which this user reads and acts by default on the ledger
 *provided* it has the corresponding ``CanReadAs(primary_party)`` or
 ``CanActAs(primary_party)`` rights.
 Ledger API clients SHOULD set this field to a non-empty value for all users to
 enable the users to act on the ledger using their own Daml party.
 Users for participant administrators MAY have an associated primary party.
 Optional,
 Modifiable
      string primary_party = 2 [json_name = "primaryParty"];
      Parameters:
      value - The primaryParty to set.
      Returns:
      This builder for chaining.

    • clearPrimaryParty

      public UserManagementServiceOuterClass.User.Builder clearPrimaryParty()
       The primary party as which this user reads and acts by default on the ledger
 *provided* it has the corresponding ``CanReadAs(primary_party)`` or
 ``CanActAs(primary_party)`` rights.
 Ledger API clients SHOULD set this field to a non-empty value for all users to
 enable the users to act on the ledger using their own Daml party.
 Users for participant administrators MAY have an associated primary party.
 Optional,
 Modifiable
      string primary_party = 2 [json_name = "primaryParty"];
      Returns:
      This builder for chaining.

    • setPrimaryPartyBytes

      public UserManagementServiceOuterClass.User.Builder setPrimaryPartyBytes(com.google.protobuf.ByteString value)
       The primary party as which this user reads and acts by default on the ledger
 *provided* it has the corresponding ``CanReadAs(primary_party)`` or
 ``CanActAs(primary_party)`` rights.
 Ledger API clients SHOULD set this field to a non-empty value for all users to
 enable the users to act on the ledger using their own Daml party.
 Users for participant administrators MAY have an associated primary party.
 Optional,
 Modifiable
      string primary_party = 2 [json_name = "primaryParty"];
      Parameters:
      value - The bytes for primaryParty to set.
      Returns:
      This builder for chaining.

    • getIsDeactivated

      public boolean getIsDeactivated()
       When set, then the user is denied all access to the Ledger API.
 Otherwise, the user has access to the Ledger API as per the user's rights.
 Optional,
 Modifiable
      bool is_deactivated = 3 [json_name = "isDeactivated"];
      Specified by:
      getIsDeactivated in interface UserManagementServiceOuterClass.UserOrBuilder
      Returns:
      The isDeactivated.

    • setIsDeactivated

      public UserManagementServiceOuterClass.User.Builder setIsDeactivated(boolean value)
       When set, then the user is denied all access to the Ledger API.
 Otherwise, the user has access to the Ledger API as per the user's rights.
 Optional,
 Modifiable
      bool is_deactivated = 3 [json_name = "isDeactivated"];
      Parameters:
      value - The isDeactivated to set.
      Returns:
      This builder for chaining.

    • clearIsDeactivated

      public UserManagementServiceOuterClass.User.Builder clearIsDeactivated()
       When set, then the user is denied all access to the Ledger API.
 Otherwise, the user has access to the Ledger API as per the user's rights.
 Optional,
 Modifiable
      bool is_deactivated = 3 [json_name = "isDeactivated"];
      Returns:
      This builder for chaining.

    • hasMetadata

      public boolean hasMetadata()
       The metadata of this user.
 Note that the ``metadata.resource_version`` tracks changes to the properties described by the ``User`` message and not the user's rights.
 Optional,
 Modifiable
      .com.daml.ledger.api.v2.admin.ObjectMeta metadata = 4 [json_name = "metadata"];
      Specified by:
      hasMetadata in interface UserManagementServiceOuterClass.UserOrBuilder
      Returns:
      Whether the metadata field is set.

    • getMetadata

      public ObjectMetaOuterClass.ObjectMeta getMetadata()
       The metadata of this user.
 Note that the ``metadata.resource_version`` tracks changes to the properties described by the ``User`` message and not the user's rights.
 Optional,
 Modifiable
      .com.daml.ledger.api.v2.admin.ObjectMeta metadata = 4 [json_name = "metadata"];
      Specified by:
      getMetadata in interface UserManagementServiceOuterClass.UserOrBuilder
      Returns:
      The metadata.

    • setMetadata

      public UserManagementServiceOuterClass.User.Builder setMetadata(ObjectMetaOuterClass.ObjectMeta value)
       The metadata of this user.
 Note that the ``metadata.resource_version`` tracks changes to the properties described by the ``User`` message and not the user's rights.
 Optional,
 Modifiable
      .com.daml.ledger.api.v2.admin.ObjectMeta metadata = 4 [json_name = "metadata"];

    • setMetadata

      public UserManagementServiceOuterClass.User.Builder setMetadata(ObjectMetaOuterClass.ObjectMeta.Builder builderForValue)
       The metadata of this user.
 Note that the ``metadata.resource_version`` tracks changes to the properties described by the ``User`` message and not the user's rights.
 Optional,
 Modifiable
      .com.daml.ledger.api.v2.admin.ObjectMeta metadata = 4 [json_name = "metadata"];

    • mergeMetadata

      public UserManagementServiceOuterClass.User.Builder mergeMetadata(ObjectMetaOuterClass.ObjectMeta value)
       The metadata of this user.
 Note that the ``metadata.resource_version`` tracks changes to the properties described by the ``User`` message and not the user's rights.
 Optional,
 Modifiable
      .com.daml.ledger.api.v2.admin.ObjectMeta metadata = 4 [json_name = "metadata"];

    • clearMetadata

      public UserManagementServiceOuterClass.User.Builder clearMetadata()
       The metadata of this user.
 Note that the ``metadata.resource_version`` tracks changes to the properties described by the ``User`` message and not the user's rights.
 Optional,
 Modifiable
      .com.daml.ledger.api.v2.admin.ObjectMeta metadata = 4 [json_name = "metadata"];

    • getMetadataBuilder

      public ObjectMetaOuterClass.ObjectMeta.Builder getMetadataBuilder()
       The metadata of this user.
 Note that the ``metadata.resource_version`` tracks changes to the properties described by the ``User`` message and not the user's rights.
 Optional,
 Modifiable
      .com.daml.ledger.api.v2.admin.ObjectMeta metadata = 4 [json_name = "metadata"];

    • getMetadataOrBuilder

      public ObjectMetaOuterClass.ObjectMetaOrBuilder getMetadataOrBuilder()
       The metadata of this user.
 Note that the ``metadata.resource_version`` tracks changes to the properties described by the ``User`` message and not the user's rights.
 Optional,
 Modifiable
      .com.daml.ledger.api.v2.admin.ObjectMeta metadata = 4 [json_name = "metadata"];
      Specified by:
      getMetadataOrBuilder in interface UserManagementServiceOuterClass.UserOrBuilder

    • getIdentityProviderId

      public String getIdentityProviderId()
       The ID of the identity provider configured by ``Identity Provider Config``
 Optional, if not set, assume the user is managed by the default identity provider.
      string identity_provider_id = 5 [json_name = "identityProviderId"];
      Specified by:
      getIdentityProviderId in interface UserManagementServiceOuterClass.UserOrBuilder
      Returns:
      The identityProviderId.

    • getIdentityProviderIdBytes

      public com.google.protobuf.ByteString getIdentityProviderIdBytes()
       The ID of the identity provider configured by ``Identity Provider Config``
 Optional, if not set, assume the user is managed by the default identity provider.
      string identity_provider_id = 5 [json_name = "identityProviderId"];
      Specified by:
      getIdentityProviderIdBytes in interface UserManagementServiceOuterClass.UserOrBuilder
      Returns:
      The bytes for identityProviderId.

    • setIdentityProviderId

      public UserManagementServiceOuterClass.User.Builder setIdentityProviderId(String value)
       The ID of the identity provider configured by ``Identity Provider Config``
 Optional, if not set, assume the user is managed by the default identity provider.
      string identity_provider_id = 5 [json_name = "identityProviderId"];
      Parameters:
      value - The identityProviderId to set.
      Returns:
      This builder for chaining.

    • clearIdentityProviderId

      public UserManagementServiceOuterClass.User.Builder clearIdentityProviderId()
       The ID of the identity provider configured by ``Identity Provider Config``
 Optional, if not set, assume the user is managed by the default identity provider.
      string identity_provider_id = 5 [json_name = "identityProviderId"];
      Returns:
      This builder for chaining.

    • setIdentityProviderIdBytes

      public UserManagementServiceOuterClass.User.Builder setIdentityProviderIdBytes(com.google.protobuf.ByteString value)
       The ID of the identity provider configured by ``Identity Provider Config``
 Optional, if not set, assume the user is managed by the default identity provider.
      string identity_provider_id = 5 [json_name = "identityProviderId"];
      Parameters:
      value - The bytes for identityProviderId to set.
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final UserManagementServiceOuterClass.User.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<UserManagementServiceOuterClass.User.Builder>

    • mergeUnknownFields

      public final UserManagementServiceOuterClass.User.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<UserManagementServiceOuterClass.User.Builder>