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.Builder
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
UserManagementServiceOuterClass.User
build()
UserManagementServiceOuterClass.User
buildPartial()
UserManagementServiceOuterClass.User.Builder
clear()
UserManagementServiceOuterClass.User.Builder
clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
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 "@^$.!`-#+'~_|:".UserManagementServiceOuterClass.User.Builder
clearIsDeactivated()
When set, then the user is denied all access to the Ledger API.UserManagementServiceOuterClass.User.Builder
clearMetadata()
The metadata of this user.UserManagementServiceOuterClass.User.Builder
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
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.UserManagementServiceOuterClass.User.Builder
clone()
UserManagementServiceOuterClass.User
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
com.google.protobuf.Descriptors.Descriptor
getDescriptorForType()
java.lang.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 "@^$.!`-#+'~_|:".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 "@^$.!`-#+'~_|:".boolean
getIsDeactivated()
When set, then the user is denied all access to the Ledger API.ObjectMetaOuterClass.ObjectMeta
getMetadata()
The metadata of this user.ObjectMetaOuterClass.ObjectMeta.Builder
getMetadataBuilder()
The metadata of this user.ObjectMetaOuterClass.ObjectMetaOrBuilder
getMetadataOrBuilder()
The metadata of this user.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.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.boolean
hasMetadata()
The metadata of this user.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
UserManagementServiceOuterClass.User.Builder
mergeFrom(UserManagementServiceOuterClass.User other)
UserManagementServiceOuterClass.User.Builder
mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
UserManagementServiceOuterClass.User.Builder
mergeFrom(com.google.protobuf.Message other)
UserManagementServiceOuterClass.User.Builder
mergeMetadata(ObjectMetaOuterClass.ObjectMeta value)
The metadata of this user.UserManagementServiceOuterClass.User.Builder
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
UserManagementServiceOuterClass.User.Builder
setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
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 alphanumeric ASCII characters or one of the symbols "@^$.!`-#+'~_|:".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 "@^$.!`-#+'~_|:".UserManagementServiceOuterClass.User.Builder
setIsDeactivated(boolean value)
When set, then the user is denied all access to the Ledger API.UserManagementServiceOuterClass.User.Builder
setMetadata(ObjectMetaOuterClass.ObjectMeta value)
The metadata of this user.UserManagementServiceOuterClass.User.Builder
setMetadata(ObjectMetaOuterClass.ObjectMeta.Builder builderForValue)
The metadata of this user.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.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.UserManagementServiceOuterClass.User.Builder
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
UserManagementServiceOuterClass.User.Builder
setUnknownFields(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:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3.Builder<UserManagementServiceOuterClass.User.Builder>
-
clear
public UserManagementServiceOuterClass.User.Builder clear()
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessageV3.Builder<UserManagementServiceOuterClass.User.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessageV3.Builder<UserManagementServiceOuterClass.User.Builder>
-
getDefaultInstanceForType
public UserManagementServiceOuterClass.User getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
public UserManagementServiceOuterClass.User build()
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public UserManagementServiceOuterClass.User buildPartial()
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
clone
public UserManagementServiceOuterClass.User.Builder clone()
- Specified by:
clone
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clone
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clone
in 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:
setField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setField
in classcom.google.protobuf.GeneratedMessageV3.Builder<UserManagementServiceOuterClass.User.Builder>
-
clearField
public UserManagementServiceOuterClass.User.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearField
in classcom.google.protobuf.GeneratedMessageV3.Builder<UserManagementServiceOuterClass.User.Builder>
-
clearOneof
public UserManagementServiceOuterClass.User.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneof
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearOneof
in 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:
setRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setRepeatedField
in 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:
addRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
addRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<UserManagementServiceOuterClass.User.Builder>
-
mergeFrom
public UserManagementServiceOuterClass.User.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.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 interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in 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:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in 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 alphanumeric ASCII characters or one of the symbols "@^$.!`-#+'~_|:". Required
string id = 1 [json_name = "id"];
- Specified by:
getId
in 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 alphanumeric ASCII characters or one of the symbols "@^$.!`-#+'~_|:". Required
string id = 1 [json_name = "id"];
- Specified by:
getIdBytes
in 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 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 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, Modifiable
string primary_party = 2 [json_name = "primaryParty"];
- Specified by:
getPrimaryParty
in 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, Modifiable
string primary_party = 2 [json_name = "primaryParty"];
- Specified by:
getPrimaryPartyBytes
in 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, 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 interfaceUserManagementServiceOuterClass.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.v1.admin.ObjectMeta metadata = 4 [json_name = "metadata"];
- Specified by:
hasMetadata
in interfaceUserManagementServiceOuterClass.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.v1.admin.ObjectMeta metadata = 4 [json_name = "metadata"];
- Specified by:
getMetadata
in interfaceUserManagementServiceOuterClass.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.admin.ObjectMeta metadata = 4 [json_name = "metadata"];
- Specified by:
getMetadataOrBuilder
in interfaceUserManagementServiceOuterClass.UserOrBuilder
-
setUnknownFields
public final UserManagementServiceOuterClass.User.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
setUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<UserManagementServiceOuterClass.User.Builder>
-
mergeUnknownFields
public final UserManagementServiceOuterClass.User.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<UserManagementServiceOuterClass.User.Builder>
-
-