Package com.daml.ledger.api.v2

Class StateServiceOuterClass.GetActiveContractsRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.daml.ledger.api.v2.StateServiceOuterClass.GetActiveContractsRequest
All Implemented Interfaces:
StateServiceOuterClass.GetActiveContractsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
StateServiceOuterClass
public static final class StateServiceOuterClass.GetActiveContractsRequest extends com.google.protobuf.GeneratedMessageV3 implements StateServiceOuterClass.GetActiveContractsRequestOrBuilder
 If the given offset is different than the ledger end, and there are (un)assignments in-flight at the given offset,
 the snapshot may fail with "FAILED_PRECONDITION/PARTICIPANT_PRUNED_DATA_ACCESSED".
 Note that it is ok to request acs snapshots for party migration with offsets other than ledger end, because party
 migration is not concerned with incomplete (un)assignments.
Protobuf type com.daml.ledger.api.v2.GetActiveContractsRequest
See Also:

  • Field Details

    • FILTER_FIELD_NUMBER

      public static final int FILTER_FIELD_NUMBER
      See Also:

    • VERBOSE_FIELD_NUMBER

      public static final int VERBOSE_FIELD_NUMBER
      See Also:

    • ACTIVE_AT_OFFSET_FIELD_NUMBER

      public static final int ACTIVE_AT_OFFSET_FIELD_NUMBER
      See Also:

    • EVENT_FORMAT_FIELD_NUMBER

      public static final int EVENT_FORMAT_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • hasFilter

      public boolean hasFilter()
       Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
 Templates to include in the served snapshot, per party.
 Optional, if specified event_format must be unset, if not specified event_format must be set.
      .com.daml.ledger.api.v2.TransactionFilter filter = 1 [json_name = "filter"];
      Specified by:
      hasFilter in interface StateServiceOuterClass.GetActiveContractsRequestOrBuilder
      Returns:
      Whether the filter field is set.

    • getFilter

      public TransactionFilterOuterClass.TransactionFilter getFilter()
       Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
 Templates to include in the served snapshot, per party.
 Optional, if specified event_format must be unset, if not specified event_format must be set.
      .com.daml.ledger.api.v2.TransactionFilter filter = 1 [json_name = "filter"];
      Specified by:
      getFilter in interface StateServiceOuterClass.GetActiveContractsRequestOrBuilder
      Returns:
      The filter.

    • getFilterOrBuilder

      public TransactionFilterOuterClass.TransactionFilterOrBuilder getFilterOrBuilder()
       Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
 Templates to include in the served snapshot, per party.
 Optional, if specified event_format must be unset, if not specified event_format must be set.
      .com.daml.ledger.api.v2.TransactionFilter filter = 1 [json_name = "filter"];
      Specified by:
      getFilterOrBuilder in interface StateServiceOuterClass.GetActiveContractsRequestOrBuilder

    • getVerbose

      public boolean getVerbose()
       Provided for backwards compatibility, it will be removed in the Canton version 3.4.0.
 If enabled, values served over the API will contain more information than strictly necessary to interpret the data.
 In particular, setting the verbose flag to true triggers the ledger to include labels for record fields.
 Optional, if specified event_format must be unset.
      bool verbose = 2 [json_name = "verbose"];
      Specified by:
      getVerbose in interface StateServiceOuterClass.GetActiveContractsRequestOrBuilder
      Returns:
      The verbose.

    • getActiveAtOffset

      public long getActiveAtOffset()
       The offset at which the snapshot of the active contracts will be computed.
 Must be no greater than the current ledger end offset.
 Must be greater than or equal to the last pruning offset.
 Required, must be a valid absolute offset (positive integer) or ledger begin offset (zero).
 If zero, the empty set will be returned.
      int64 active_at_offset = 3 [json_name = "activeAtOffset"];
      Specified by:
      getActiveAtOffset in interface StateServiceOuterClass.GetActiveContractsRequestOrBuilder
      Returns:
      The activeAtOffset.

    • hasEventFormat

      public boolean hasEventFormat()
       Format of the contract_entries in the result. In case of CreatedEvent the presentation will be of
 TRANSACTION_SHAPE_ACS_DELTA.
 Optional for backwards compatibility, defaults to an EventFormat where:

 - filters_by_party is the filter.filters_by_party from this request
 - filters_for_any_party is the filter.filters_for_any_party from this request
 - verbose is the verbose field from this request
      .com.daml.ledger.api.v2.EventFormat event_format = 4 [json_name = "eventFormat"];
      Specified by:
      hasEventFormat in interface StateServiceOuterClass.GetActiveContractsRequestOrBuilder
      Returns:
      Whether the eventFormat field is set.

    • getEventFormat

      public TransactionFilterOuterClass.EventFormat getEventFormat()
       Format of the contract_entries in the result. In case of CreatedEvent the presentation will be of
 TRANSACTION_SHAPE_ACS_DELTA.
 Optional for backwards compatibility, defaults to an EventFormat where:

 - filters_by_party is the filter.filters_by_party from this request
 - filters_for_any_party is the filter.filters_for_any_party from this request
 - verbose is the verbose field from this request
      .com.daml.ledger.api.v2.EventFormat event_format = 4 [json_name = "eventFormat"];
      Specified by:
      getEventFormat in interface StateServiceOuterClass.GetActiveContractsRequestOrBuilder
      Returns:
      The eventFormat.

    • getEventFormatOrBuilder

      public TransactionFilterOuterClass.EventFormatOrBuilder getEventFormatOrBuilder()
       Format of the contract_entries in the result. In case of CreatedEvent the presentation will be of
 TRANSACTION_SHAPE_ACS_DELTA.
 Optional for backwards compatibility, defaults to an EventFormat where:

 - filters_by_party is the filter.filters_by_party from this request
 - filters_for_any_party is the filter.filters_for_any_party from this request
 - verbose is the verbose field from this request
      .com.daml.ledger.api.v2.EventFormat event_format = 4 [json_name = "eventFormat"];
      Specified by:
      getEventFormatOrBuilder in interface StateServiceOuterClass.GetActiveContractsRequestOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static StateServiceOuterClass.GetActiveContractsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StateServiceOuterClass.GetActiveContractsRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StateServiceOuterClass.GetActiveContractsRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StateServiceOuterClass.GetActiveContractsRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StateServiceOuterClass.GetActiveContractsRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StateServiceOuterClass.GetActiveContractsRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StateServiceOuterClass.GetActiveContractsRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StateServiceOuterClass.GetActiveContractsRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static StateServiceOuterClass.GetActiveContractsRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static StateServiceOuterClass.GetActiveContractsRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StateServiceOuterClass.GetActiveContractsRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static StateServiceOuterClass.GetActiveContractsRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public StateServiceOuterClass.GetActiveContractsRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static StateServiceOuterClass.GetActiveContractsRequest.Builder newBuilder()

    • newBuilder

      public static StateServiceOuterClass.GetActiveContractsRequest.Builder newBuilder(StateServiceOuterClass.GetActiveContractsRequest prototype)

    • toBuilder

      public StateServiceOuterClass.GetActiveContractsRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected StateServiceOuterClass.GetActiveContractsRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static StateServiceOuterClass.GetActiveContractsRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<StateServiceOuterClass.GetActiveContractsRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<StateServiceOuterClass.GetActiveContractsRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public StateServiceOuterClass.GetActiveContractsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder