Package com.daml.ledger.api.v1.admin
Class UserManagementServiceOuterClass.User.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderType>
-
- com.google.protobuf.GeneratedMessageV3.Builder<UserManagementServiceOuterClass.User.Builder>
-
- com.daml.ledger.api.v1.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,java.lang.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. Read the :doc:`Authorization documentation </app-dev/authorization>` to learn more.
Protobuf typecom.daml.ledger.api.v1.admin.User
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description UserManagementServiceOuterClass.User.BuilderaddRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)UserManagementServiceOuterClass.Userbuild()UserManagementServiceOuterClass.UserbuildPartial()UserManagementServiceOuterClass.User.Builderclear()UserManagementServiceOuterClass.User.BuilderclearField(com.google.protobuf.Descriptors.FieldDescriptor field)UserManagementServiceOuterClass.User.BuilderclearId()The user identifier, which must be a non-empty string of at most 128 characters that are either lowercase alphanumeric ASCII characters or one of the symbols "@^$.!`-#+'~_|:".UserManagementServiceOuterClass.User.BuilderclearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)UserManagementServiceOuterClass.User.BuilderclearPrimaryParty()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.UserManagementServiceOuterClass.User.Builderclone()UserManagementServiceOuterClass.UsergetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()com.google.protobuf.Descriptors.DescriptorgetDescriptorForType()java.lang.StringgetId()The user identifier, which must be a non-empty string of at most 128 characters that are either lowercase alphanumeric ASCII characters or one of the symbols "@^$.!`-#+'~_|:".com.google.protobuf.ByteStringgetIdBytes()The user identifier, which must be a non-empty string of at most 128 characters that are either lowercase alphanumeric ASCII characters or one of the symbols "@^$.!`-#+'~_|:".java.lang.StringgetPrimaryParty()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.com.google.protobuf.ByteStringgetPrimaryPartyBytes()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.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()booleanisInitialized()UserManagementServiceOuterClass.User.BuildermergeFrom(UserManagementServiceOuterClass.User other)UserManagementServiceOuterClass.User.BuildermergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)UserManagementServiceOuterClass.User.BuildermergeFrom(com.google.protobuf.Message other)UserManagementServiceOuterClass.User.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)UserManagementServiceOuterClass.User.BuildersetField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)UserManagementServiceOuterClass.User.BuildersetId(java.lang.String value)The user identifier, which must be a non-empty string of at most 128 characters that are either lowercase alphanumeric ASCII characters or one of the symbols "@^$.!`-#+'~_|:".UserManagementServiceOuterClass.User.BuildersetIdBytes(com.google.protobuf.ByteString value)The user identifier, which must be a non-empty string of at most 128 characters that are either lowercase alphanumeric ASCII characters or one of the symbols "@^$.!`-#+'~_|:".UserManagementServiceOuterClass.User.BuildersetPrimaryParty(java.lang.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.UserManagementServiceOuterClass.User.BuildersetPrimaryPartyBytes(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.UserManagementServiceOuterClass.User.BuildersetRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)UserManagementServiceOuterClass.User.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)-
Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException
-
-
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<UserManagementServiceOuterClass.User.Builder>
-
clear
public UserManagementServiceOuterClass.User.Builder clear()
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<UserManagementServiceOuterClass.User.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<UserManagementServiceOuterClass.User.Builder>
-
getDefaultInstanceForType
public UserManagementServiceOuterClass.User getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
public UserManagementServiceOuterClass.User build()
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public UserManagementServiceOuterClass.User buildPartial()
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
public UserManagementServiceOuterClass.User.Builder clone()
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<UserManagementServiceOuterClass.User.Builder>
-
setField
public UserManagementServiceOuterClass.User.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
- Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<UserManagementServiceOuterClass.User.Builder>
-
clearField
public UserManagementServiceOuterClass.User.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<UserManagementServiceOuterClass.User.Builder>
-
clearOneof
public UserManagementServiceOuterClass.User.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<UserManagementServiceOuterClass.User.Builder>
-
setRepeatedField
public UserManagementServiceOuterClass.User.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
- Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<UserManagementServiceOuterClass.User.Builder>
-
addRepeatedField
public UserManagementServiceOuterClass.User.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
- Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<UserManagementServiceOuterClass.User.Builder>
-
mergeFrom
public UserManagementServiceOuterClass.User.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<UserManagementServiceOuterClass.User.Builder>
-
mergeFrom
public UserManagementServiceOuterClass.User.Builder mergeFrom(UserManagementServiceOuterClass.User other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3.Builder<UserManagementServiceOuterClass.User.Builder>
-
mergeFrom
public UserManagementServiceOuterClass.User.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<UserManagementServiceOuterClass.User.Builder>- Throws:
java.io.IOException
-
getId
public java.lang.String getId()
The user identifier, which must be a non-empty string of at most 128 characters that are either lowercase alphanumeric ASCII characters or one of the symbols "@^$.!`-#+'~_|:". Required
string id = 1 [json_name = "id"];- Specified by:
getIdin interfaceUserManagementServiceOuterClass.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 lowercase alphanumeric ASCII characters or one of the symbols "@^$.!`-#+'~_|:". Required
string id = 1 [json_name = "id"];- Specified by:
getIdBytesin interfaceUserManagementServiceOuterClass.UserOrBuilder- Returns:
- The bytes for id.
-
setId
public UserManagementServiceOuterClass.User.Builder setId(java.lang.String value)
The user identifier, which must be a non-empty string of at most 128 characters that are either lowercase 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 lowercase 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 lowercase 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 java.lang.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
string primary_party = 2 [json_name = "primaryParty"];- Specified by:
getPrimaryPartyin interfaceUserManagementServiceOuterClass.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
string primary_party = 2 [json_name = "primaryParty"];- Specified by:
getPrimaryPartyBytesin interfaceUserManagementServiceOuterClass.UserOrBuilder- Returns:
- The bytes for primaryParty.
-
setPrimaryParty
public UserManagementServiceOuterClass.User.Builder setPrimaryParty(java.lang.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
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
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
string primary_party = 2 [json_name = "primaryParty"];- Parameters:
value- The bytes for primaryParty to set.- Returns:
- This builder for chaining.
-
setUnknownFields
public final UserManagementServiceOuterClass.User.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<UserManagementServiceOuterClass.User.Builder>
-
mergeUnknownFields
public final UserManagementServiceOuterClass.User.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<UserManagementServiceOuterClass.User.Builder>
-
-