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

Interface UserManagementServiceOuterClass.UpdateUserRequestOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com.google.protobuf.FieldMask getUpdateMask()
      An update mask specifies how and which properties of the ``User`` message are to be updated.
      com.google.protobuf.FieldMaskOrBuilder getUpdateMaskOrBuilder()
      An update mask specifies how and which properties of the ``User`` message are to be updated.
      UserManagementServiceOuterClass.User getUser()
      The user to update.
      UserManagementServiceOuterClass.UserOrBuilder getUserOrBuilder()
      The user to update.
      boolean hasUpdateMask()
      An update mask specifies how and which properties of the ``User`` message are to be updated.
      boolean hasUser()
      The user to update.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • hasUser

        boolean hasUser()
         The user to update.
 Required,
 Modifiable
        .com.daml.ledger.api.v1.admin.User user = 1 [json_name = "user"];
        Returns:
        Whether the user field is set.

      • getUser

        UserManagementServiceOuterClass.User getUser()
         The user to update.
 Required,
 Modifiable
        .com.daml.ledger.api.v1.admin.User user = 1 [json_name = "user"];
        Returns:
        The user.

      • hasUpdateMask

        boolean hasUpdateMask()
         An update mask specifies how and which properties of the ``User`` message are to be updated.
 An update mask consists of a set of update paths.
 A valid update path points to a field or a subfield relative to the ``User`` message.
 A valid update mask must:
 (1) contain at least one update path,
 (2) contain only valid update paths.
 Fields that can be updated are marked as ``Modifiable``.
 An update path can also point to a non-``Modifiable`` fields such as 'id' and 'metadata.resource_version'
 because they are used:
 (1) to identify the user resource subject to the update,
 (2) for concurrent change control.
 Examples of valid update paths: 'primary_party', 'metadata', 'metadata.annotations'.
 For additional information see the documentation for standard protobuf3's ``google.protobuf.FieldMask``.
 For similar Ledger API see ``com.daml.ledger.api.v1.admin.UpdatePartyDetailsRequest``.
 Required
        .google.protobuf.FieldMask update_mask = 2 [json_name = "updateMask"];
        Returns:
        Whether the updateMask field is set.

      • getUpdateMask

        com.google.protobuf.FieldMask getUpdateMask()
         An update mask specifies how and which properties of the ``User`` message are to be updated.
 An update mask consists of a set of update paths.
 A valid update path points to a field or a subfield relative to the ``User`` message.
 A valid update mask must:
 (1) contain at least one update path,
 (2) contain only valid update paths.
 Fields that can be updated are marked as ``Modifiable``.
 An update path can also point to a non-``Modifiable`` fields such as 'id' and 'metadata.resource_version'
 because they are used:
 (1) to identify the user resource subject to the update,
 (2) for concurrent change control.
 Examples of valid update paths: 'primary_party', 'metadata', 'metadata.annotations'.
 For additional information see the documentation for standard protobuf3's ``google.protobuf.FieldMask``.
 For similar Ledger API see ``com.daml.ledger.api.v1.admin.UpdatePartyDetailsRequest``.
 Required
        .google.protobuf.FieldMask update_mask = 2 [json_name = "updateMask"];
        Returns:
        The updateMask.

      • getUpdateMaskOrBuilder

        com.google.protobuf.FieldMaskOrBuilder getUpdateMaskOrBuilder()
         An update mask specifies how and which properties of the ``User`` message are to be updated.
 An update mask consists of a set of update paths.
 A valid update path points to a field or a subfield relative to the ``User`` message.
 A valid update mask must:
 (1) contain at least one update path,
 (2) contain only valid update paths.
 Fields that can be updated are marked as ``Modifiable``.
 An update path can also point to a non-``Modifiable`` fields such as 'id' and 'metadata.resource_version'
 because they are used:
 (1) to identify the user resource subject to the update,
 (2) for concurrent change control.
 Examples of valid update paths: 'primary_party', 'metadata', 'metadata.annotations'.
 For additional information see the documentation for standard protobuf3's ``google.protobuf.FieldMask``.
 For similar Ledger API see ``com.daml.ledger.api.v1.admin.UpdatePartyDetailsRequest``.
 Required
        .google.protobuf.FieldMask update_mask = 2 [json_name = "updateMask"];