Package com.daml.ledger.api.v2

Interface StateServiceOuterClass.GetActiveContractsResponseOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
StateServiceOuterClass.GetActiveContractsResponse, StateServiceOuterClass.GetActiveContractsResponse.Builder
Enclosing class:
StateServiceOuterClass
public static interface StateServiceOuterClass.GetActiveContractsResponseOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    StateServiceOuterClass.ActiveContract
    getActiveContract()
    The contract is active on the assigned synchronizer, meaning: there was an activation event on the given synchronizer ( created, assigned), which is not followed by a deactivation event (archived, unassigned) on the same synchronizer, until the active_at_offset.
    StateServiceOuterClass.ActiveContractOrBuilder
    getActiveContractOrBuilder()
    The contract is active on the assigned synchronizer, meaning: there was an activation event on the given synchronizer ( created, assigned), which is not followed by a deactivation event (archived, unassigned) on the same synchronizer, until the active_at_offset.
    StateServiceOuterClass.GetActiveContractsResponse.ContractEntryCase
    getContractEntryCase()
     
    StateServiceOuterClass.IncompleteAssigned
    getIncompleteAssigned()
    Important: this message is not indicating that the contract is active on the target synchronizer! Included iff the assigned event was before or at the active_at_offset, but there was no corresponding unassigned event before or at the active_at_offset.
    StateServiceOuterClass.IncompleteAssignedOrBuilder
    getIncompleteAssignedOrBuilder()
    Important: this message is not indicating that the contract is active on the target synchronizer! Included iff the assigned event was before or at the active_at_offset, but there was no corresponding unassigned event before or at the active_at_offset.
    StateServiceOuterClass.IncompleteUnassigned
    getIncompleteUnassigned()
    Included iff the unassigned event was before or at the active_at_offset, but there was no corresponding assigned event before or at the active_at_offset.
    StateServiceOuterClass.IncompleteUnassignedOrBuilder
    getIncompleteUnassignedOrBuilder()
    Included iff the unassigned event was before or at the active_at_offset, but there was no corresponding assigned event before or at the active_at_offset.
    com.google.protobuf.ByteString
    getStreamContinuationToken()
    Opaque representation of a continuation token which can be used in the request to bypass the already processed part of the active contracts snapshot.
    String
    getWorkflowId()
    The workflow ID used in command submission which corresponds to the contract_entry.
    com.google.protobuf.ByteString
    getWorkflowIdBytes()
    The workflow ID used in command submission which corresponds to the contract_entry.
    boolean
    hasActiveContract()
    The contract is active on the assigned synchronizer, meaning: there was an activation event on the given synchronizer ( created, assigned), which is not followed by a deactivation event (archived, unassigned) on the same synchronizer, until the active_at_offset.
    boolean
    hasIncompleteAssigned()
    Important: this message is not indicating that the contract is active on the target synchronizer! Included iff the assigned event was before or at the active_at_offset, but there was no corresponding unassigned event before or at the active_at_offset.
    boolean
    hasIncompleteUnassigned()
    Included iff the unassigned event was before or at the active_at_offset, but there was no corresponding assigned event before or at the active_at_offset.

    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

    • getWorkflowId

      String getWorkflowId()
       The workflow ID used in command submission which corresponds to the contract_entry. Only set if
 the ``workflow_id`` for the command was set.
 Must be a valid LedgerString (as described in ``value.proto``).

 Optional
      string workflow_id = 1;
      Returns:
      The workflowId.

    • getWorkflowIdBytes

      com.google.protobuf.ByteString getWorkflowIdBytes()
       The workflow ID used in command submission which corresponds to the contract_entry. Only set if
 the ``workflow_id`` for the command was set.
 Must be a valid LedgerString (as described in ``value.proto``).

 Optional
      string workflow_id = 1;
      Returns:
      The bytes for workflowId.

    • hasActiveContract

      boolean hasActiveContract()
       The contract is active on the assigned synchronizer, meaning: there was an activation event on the given synchronizer (
 created, assigned), which is not followed by a deactivation event (archived, unassigned) on the same
 synchronizer, until the active_at_offset.
 Since activeness is defined as a per synchronizer concept, it is possible, that a contract is active on one
 synchronizer, but already archived on another.
 There will be one such message for each synchronizer the contract is active on.
      .com.daml.ledger.api.v2.ActiveContract active_contract = 2;
      Returns:
      Whether the activeContract field is set.

    • getActiveContract

      StateServiceOuterClass.ActiveContract getActiveContract()
       The contract is active on the assigned synchronizer, meaning: there was an activation event on the given synchronizer (
 created, assigned), which is not followed by a deactivation event (archived, unassigned) on the same
 synchronizer, until the active_at_offset.
 Since activeness is defined as a per synchronizer concept, it is possible, that a contract is active on one
 synchronizer, but already archived on another.
 There will be one such message for each synchronizer the contract is active on.
      .com.daml.ledger.api.v2.ActiveContract active_contract = 2;
      Returns:
      The activeContract.

    • getActiveContractOrBuilder

      StateServiceOuterClass.ActiveContractOrBuilder getActiveContractOrBuilder()
       The contract is active on the assigned synchronizer, meaning: there was an activation event on the given synchronizer (
 created, assigned), which is not followed by a deactivation event (archived, unassigned) on the same
 synchronizer, until the active_at_offset.
 Since activeness is defined as a per synchronizer concept, it is possible, that a contract is active on one
 synchronizer, but already archived on another.
 There will be one such message for each synchronizer the contract is active on.
      .com.daml.ledger.api.v2.ActiveContract active_contract = 2;

    • hasIncompleteUnassigned

      boolean hasIncompleteUnassigned()
       Included iff the unassigned event was before or at the active_at_offset, but there was no corresponding
 assigned event before or at the active_at_offset.
      .com.daml.ledger.api.v2.IncompleteUnassigned incomplete_unassigned = 3;
      Returns:
      Whether the incompleteUnassigned field is set.

    • getIncompleteUnassigned

      StateServiceOuterClass.IncompleteUnassigned getIncompleteUnassigned()
       Included iff the unassigned event was before or at the active_at_offset, but there was no corresponding
 assigned event before or at the active_at_offset.
      .com.daml.ledger.api.v2.IncompleteUnassigned incomplete_unassigned = 3;
      Returns:
      The incompleteUnassigned.

    • getIncompleteUnassignedOrBuilder

      StateServiceOuterClass.IncompleteUnassignedOrBuilder getIncompleteUnassignedOrBuilder()
       Included iff the unassigned event was before or at the active_at_offset, but there was no corresponding
 assigned event before or at the active_at_offset.
      .com.daml.ledger.api.v2.IncompleteUnassigned incomplete_unassigned = 3;

    • hasIncompleteAssigned

      boolean hasIncompleteAssigned()
       Important: this message is not indicating that the contract is active on the target synchronizer!
 Included iff the assigned event was before or at the active_at_offset, but there was no corresponding
 unassigned event before or at the active_at_offset.
      .com.daml.ledger.api.v2.IncompleteAssigned incomplete_assigned = 4;
      Returns:
      Whether the incompleteAssigned field is set.

    • getIncompleteAssigned

      StateServiceOuterClass.IncompleteAssigned getIncompleteAssigned()
       Important: this message is not indicating that the contract is active on the target synchronizer!
 Included iff the assigned event was before or at the active_at_offset, but there was no corresponding
 unassigned event before or at the active_at_offset.
      .com.daml.ledger.api.v2.IncompleteAssigned incomplete_assigned = 4;
      Returns:
      The incompleteAssigned.

    • getIncompleteAssignedOrBuilder

      StateServiceOuterClass.IncompleteAssignedOrBuilder getIncompleteAssignedOrBuilder()
       Important: this message is not indicating that the contract is active on the target synchronizer!
 Included iff the assigned event was before or at the active_at_offset, but there was no corresponding
 unassigned event before or at the active_at_offset.
      .com.daml.ledger.api.v2.IncompleteAssigned incomplete_assigned = 4;

    • getStreamContinuationToken

      com.google.protobuf.ByteString getStreamContinuationToken()
       Opaque representation of a continuation token which can be used in the request to bypass the already processed part
 of the active contracts snapshot.
 Only populated for the streaming ``GetActiveContracts`` rpc call.

 Optional: can be empty
      bytes stream_continuation_token = 5;
      Returns:
      The streamContinuationToken.

    • getContractEntryCase

      StateServiceOuterClass.GetActiveContractsResponse.ContractEntryCase getContractEntryCase()