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

Interface PartyManagementServiceOuterClass.UpdatePartyDetailsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
PartyManagementServiceOuterClass.UpdatePartyDetailsRequest, PartyManagementServiceOuterClass.UpdatePartyDetailsRequest.Builder
Enclosing class:
PartyManagementServiceOuterClass
public static interface PartyManagementServiceOuterClass.UpdatePartyDetailsRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    PartyManagementServiceOuterClass.PartyDetails
    getPartyDetails()
    Party to be updated Required, Modifiable
    PartyManagementServiceOuterClass.PartyDetailsOrBuilder
    getPartyDetailsOrBuilder()
    Party to be updated Required, Modifiable
    com.google.protobuf.FieldMask
    getUpdateMask()
    An update mask specifies how and which properties of the ``PartyDetails`` message are to be updated.
    com.google.protobuf.FieldMaskOrBuilder
    getUpdateMaskOrBuilder()
    An update mask specifies how and which properties of the ``PartyDetails`` message are to be updated.
    boolean
    hasPartyDetails()
    Party to be updated Required, Modifiable
    boolean
    hasUpdateMask()
    An update mask specifies how and which properties of the ``PartyDetails`` message are to be updated.

    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 Details

    • hasPartyDetails

      boolean hasPartyDetails()
       Party to be updated
 Required,
 Modifiable
      .com.daml.ledger.api.v2.admin.PartyDetails party_details = 1 [json_name = "partyDetails"];
      Returns:
      Whether the partyDetails field is set.

    • getPartyDetails

      PartyManagementServiceOuterClass.PartyDetails getPartyDetails()
       Party to be updated
 Required,
 Modifiable
      .com.daml.ledger.api.v2.admin.PartyDetails party_details = 1 [json_name = "partyDetails"];
      Returns:
      The partyDetails.

    • getPartyDetailsOrBuilder

      PartyManagementServiceOuterClass.PartyDetailsOrBuilder getPartyDetailsOrBuilder()
       Party to be updated
 Required,
 Modifiable
      .com.daml.ledger.api.v2.admin.PartyDetails party_details = 1 [json_name = "partyDetails"];

    • hasUpdateMask

      boolean hasUpdateMask()
       An update mask specifies how and which properties of the ``PartyDetails`` 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 ``PartyDetails`` 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 non-``Modifiable`` fields such as 'party' and 'local_metadata.resource_version'
 because they are used:

 1. to identify the party details resource subject to the update,
 2. for concurrent change control.

 An update path can also point to non-``Modifiable`` fields such as 'is_local'
 as long as the values provided in the update request match the server values.
 Examples of update paths: 'local_metadata.annotations', 'local_metadata'.
 For additional information see the documentation for standard protobuf3's ``google.protobuf.FieldMask``.
 For similar Ledger API see ``com.daml.ledger.api.v2.admin.UpdateUserRequest``.
 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 ``PartyDetails`` 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 ``PartyDetails`` 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 non-``Modifiable`` fields such as 'party' and 'local_metadata.resource_version'
 because they are used:

 1. to identify the party details resource subject to the update,
 2. for concurrent change control.

 An update path can also point to non-``Modifiable`` fields such as 'is_local'
 as long as the values provided in the update request match the server values.
 Examples of update paths: 'local_metadata.annotations', 'local_metadata'.
 For additional information see the documentation for standard protobuf3's ``google.protobuf.FieldMask``.
 For similar Ledger API see ``com.daml.ledger.api.v2.admin.UpdateUserRequest``.
 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 ``PartyDetails`` 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 ``PartyDetails`` 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 non-``Modifiable`` fields such as 'party' and 'local_metadata.resource_version'
 because they are used:

 1. to identify the party details resource subject to the update,
 2. for concurrent change control.

 An update path can also point to non-``Modifiable`` fields such as 'is_local'
 as long as the values provided in the update request match the server values.
 Examples of update paths: 'local_metadata.annotations', 'local_metadata'.
 For additional information see the documentation for standard protobuf3's ``google.protobuf.FieldMask``.
 For similar Ledger API see ``com.daml.ledger.api.v2.admin.UpdateUserRequest``.
 Required
      .google.protobuf.FieldMask update_mask = 2 [json_name = "updateMask"];