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

Class UserManagementServiceOuterClass.User

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.daml.ledger.api.v2.admin.UserManagementServiceOuterClass.User
All Implemented Interfaces:
UserManagementServiceOuterClass.UserOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
UserManagementServiceOuterClass
public static final class UserManagementServiceOuterClass.User extends com.google.protobuf.GeneratedMessageV3 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
See Also:

  • Field Details

    • ID_FIELD_NUMBER

      public static final int ID_FIELD_NUMBER
      See Also:

    • PRIMARY_PARTY_FIELD_NUMBER

      public static final int PRIMARY_PARTY_FIELD_NUMBER
      See Also:

    • IS_DEACTIVATED_FIELD_NUMBER

      public static final int IS_DEACTIVATED_FIELD_NUMBER
      See Also:

    • METADATA_FIELD_NUMBER

      public static final int METADATA_FIELD_NUMBER
      See Also:

    • IDENTITY_PROVIDER_ID_FIELD_NUMBER

      public static final int IDENTITY_PROVIDER_ID_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

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

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

    • parseFrom

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

    • parseFrom

      public static UserManagementServiceOuterClass.User parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static UserManagementServiceOuterClass.User parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static UserManagementServiceOuterClass.User parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static UserManagementServiceOuterClass.User parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static UserManagementServiceOuterClass.User.Builder newBuilder()

    • newBuilder

      public static UserManagementServiceOuterClass.User.Builder newBuilder(UserManagementServiceOuterClass.User prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static UserManagementServiceOuterClass.User getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<UserManagementServiceOuterClass.User> parser()

    • getParserForType

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