object acs extends Helpful
- Annotations
- @Summary(s = "Read active contracts", flag = FeatureFlag.Testing) @Group(name = "Active Contracts")
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- acs
- Helpful
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def active_contracts_of_party(party: PartyId, limit: PositiveInt = defaultLimit, verbose: Boolean = true, filterTemplates: Seq[TemplateId] = Seq.empty, activeAtOffsetO: Option[Long] = None, timeout: NonNegativeDuration = timeouts.unbounded, includeCreatedEventBlob: Boolean = false): Seq[ActiveContract]
- Annotations
- @Summary(s = "List the set of active contracts of a given party", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """This command will return the current set of active contracts for the given party.
|
|Supported arguments:
|- party: for which party you want to load the acs
|- limit: limit (default set via canton.parameter.console)
|- verbose: whether the resulting events should contain detailed type information
|- filterTemplate: list of templates ids to filter for, empty sequence acts as a wildcard
|- activeAtOffsetO: the offset at which the snapshot of the active contracts will be computed, it
| must be no greater than the current ledger end offset and must be greater than or equal to the
| last pruning offset. If no offset is specified then the current participant end will be used.
|- timeout: the maximum wait time for the complete acs to arrive
|- includeCreatedEventBlob: whether the result should contain the createdEventBlobs, it works only
| if the filterTemplate is non-empty""")
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def await_active_contract(party: PartyId, contractId: LfContractId, timeout: NonNegativeDuration = timeouts.ledgerCommand): Unit
- Annotations
- @Summary(s = "Wait until the party sees the given contract in the active contract service", flag = FeatureFlag.Testing) @Description(s = "Will throw an exception if the contract is not found to be active within the given timeout")
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def find_generic(partyId: PartyId, filter: (WrappedContractEntry) => Boolean, timeout: NonNegativeDuration = timeouts.ledgerCommand): WrappedContractEntry
- Annotations
- @Summary(s = "Generic search for contracts", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """This search function returns an untyped ledger-api event.
|The find will wait until the contract appears or throw an exception once it times out.""")
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def help(methodName: String)(implicit consoleEnvironment: ConsoleEnvironment): Unit
- Definition Classes
- Helpful
- Annotations
- @Summary(s = "Help for specific commands (use help() or help(\"method\") for more information)", flag = console.this.Help.Summary.<init>$default$2) @Topic(t = Seq("Top-level Commands"))
- def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
- Definition Classes
- Helpful
- def incomplete_assigned_of_party(party: PartyId, limit: PositiveInt = defaultLimit, verbose: Boolean = true, filterTemplates: Seq[TemplateId] = Seq.empty, activeAtOffsetO: Option[Long] = None, timeout: NonNegativeDuration = timeouts.unbounded, includeCreatedEventBlob: Boolean = false): Seq[WrappedIncompleteAssigned]
- Annotations
- @Summary(s = "List the set of incomplete assigned events of a given party", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """This command will return the current set of incomplete assigned events for the given party.
|
|Supported arguments:
|- party: for which party you want to load the acs
|- limit: limit (default set via canton.parameter.console)
|- verbose: whether the resulting events should contain detailed type information
|- filterTemplate: list of templates ids to filter for, empty sequence acts as a wildcard
|- activeAtOffsetO: the offset at which the snapshot of the events will be computed, it must be no
| greater than the current ledger end offset and must be greater than or equal to the last
| pruning offset. If no offset is specified then the current participant end will be used.
|- timeout: the maximum wait time for the complete acs to arrive
|- includeCreatedEventBlob: whether the result should contain the createdEventBlobs, it works only
| if the filterTemplate is non-empty""")
- def incomplete_unassigned_of_party(party: PartyId, limit: PositiveInt = defaultLimit, verbose: Boolean = true, filterTemplates: Seq[TemplateId] = Seq.empty, activeAtOffsetO: Option[Long] = None, timeout: NonNegativeDuration = timeouts.unbounded, includeCreatedEventBlob: Boolean = false): Seq[WrappedIncompleteUnassigned]
- Annotations
- @Summary(s = "List the set of incomplete unassigned events of a given party", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """This command will return the current set of incomplete unassigned events for the given party.
|
|Supported arguments:
|- party: for which party you want to load the acs
|- limit: limit (default set via canton.parameter.console)
|- verbose: whether the resulting events should contain detailed type information
|- filterTemplate: list of templates ids to filter for, empty sequence acts as a wildcard
|- activeAtOffsetO: the offset at which the snapshot of the events will be computed, it
| must be no greater than the current ledger end offset and must be greater than or equal to the
| last pruning offset. If no offset is specified then the current participant end will be used.
|- timeout: the maximum wait time for the complete acs to arrive
|- includeCreatedEventBlob: whether the result should contain the createdEventBlobs, it works only
| if the filterTemplate is non-empty""")
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def of_all(limit: PositiveInt = defaultLimit, verbose: Boolean = true, filterTemplates: Seq[TemplateId] = Seq.empty, activeAtOffsetO: Option[Long] = None, timeout: NonNegativeDuration = timeouts.unbounded, identityProviderId: String = "", includeCreatedEventBlob: Boolean = false, resultFilter: (GetActiveContractsResponse) => Boolean = _.contractEntry.isDefined): Seq[WrappedContractEntry]
- Annotations
- @Summary(s = "List the set of active contracts for all parties hosted on this participant", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """This command will return the current set of active contracts for all parties.
Supported arguments:
- limit: limit (default set via canton.parameter.console)
- verbose: whether the resulting events should contain detailed type information
- filterTemplate: list of templates ids to filter for, empty sequence acts as a wildcard
- activeAtOffsetO: the offset at which the snapshot of the active contracts will be computed, it
must be no greater than the current ledger end offset and must be greater than or equal to the
last pruning offset. If no offset is specified then the current participant end will be used.
- timeout: the maximum wait time for the complete acs to arrive
- identityProviderId: limit the response to parties governed by the given identity provider
- includeCreatedEventBlob: whether the result should contain the createdEventBlobs, it works only
if the filterTemplate is non-empty
- resultFilter: custom filter of the results, applies before limit
""")
- def of_party(party: PartyId, limit: PositiveInt = defaultLimit, verbose: Boolean = true, filterTemplates: Seq[TemplateId] = Seq.empty, activeAtOffsetO: Option[Long] = None, timeout: NonNegativeDuration = timeouts.unbounded, includeCreatedEventBlob: Boolean = false, resultFilter: (GetActiveContractsResponse) => Boolean = _.contractEntry.isDefined): Seq[WrappedContractEntry]
- Annotations
- @Summary(s = "List the set of active contract entries of a given party", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """This command will return the current set of active contracts and incomplete reassignments for the given party.
|
|Supported arguments:
|- party: for which party you want to load the acs
|- limit: limit (default set via canton.parameter.console)
|- verbose: whether the resulting events should contain detailed type information
|- filterTemplate: list of templates ids to filter for, empty sequence acts as a wildcard
|- activeAtOffsetO: the offset at which the snapshot of the active contracts will be computed, it
| must be no greater than the current ledger end offset and must be greater than or equal to the
| last pruning offset. If no offset is specified then the current participant end will be used.
|- timeout: the maximum wait time for the complete acs to arrive
|- includeCreatedEventBlob: whether the result should contain the createdEventBlobs, it works only
| if the filterTemplate is non-empty
|- resultFilter: custom filter of the results, applies before limit""")
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])