Package com.daml.ledger.api.v2

Class StateServiceOuterClass.GetActiveContractsPageRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.daml.ledger.api.v2.StateServiceOuterClass.GetActiveContractsPageRequest
All Implemented Interfaces:
StateServiceOuterClass.GetActiveContractsPageRequestOrBuilder, 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.GetActiveContractsPageRequest extends com.google.protobuf.GeneratedMessageV3 implements StateServiceOuterClass.GetActiveContractsPageRequestOrBuilder
Protobuf type com.daml.ledger.api.v2.GetActiveContractsPageRequest
See Also:

  • Field Details

    • 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:

    • MAX_PAGE_SIZE_FIELD_NUMBER

      public static final int MAX_PAGE_SIZE_FIELD_NUMBER
      See Also:

    • PAGE_TOKEN_FIELD_NUMBER

      public static final int PAGE_TOKEN_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

    • hasActiveAtOffset

      public boolean hasActiveAtOffset()
       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.
 Optional, if defined, it must be a valid absolute offset (positive integer) or ledger begin offset (zero).
 If zero, the empty set will be returned.
 If not defined, the current ledger end will be used and it will be populated in the response.

 Optional
      optional int64 active_at_offset = 1;
      Specified by:
      hasActiveAtOffset in interface StateServiceOuterClass.GetActiveContractsPageRequestOrBuilder
      Returns:
      Whether the activeAtOffset field is set.

    • 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.
 Optional, if defined, it must be a valid absolute offset (positive integer) or ledger begin offset (zero).
 If zero, the empty set will be returned.
 If not defined, the current ledger end will be used and it will be populated in the response.

 Optional
      optional int64 active_at_offset = 1;
      Specified by:
      getActiveAtOffset in interface StateServiceOuterClass.GetActiveContractsPageRequestOrBuilder
      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.

 Required
      .com.daml.ledger.api.v2.EventFormat event_format = 2;
      Specified by:
      hasEventFormat in interface StateServiceOuterClass.GetActiveContractsPageRequestOrBuilder
      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.

 Required
      .com.daml.ledger.api.v2.EventFormat event_format = 2;
      Specified by:
      getEventFormat in interface StateServiceOuterClass.GetActiveContractsPageRequestOrBuilder
      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.

 Required
      .com.daml.ledger.api.v2.EventFormat event_format = 2;
      Specified by:
      getEventFormatOrBuilder in interface StateServiceOuterClass.GetActiveContractsPageRequestOrBuilder

    • hasMaxPageSize

      public boolean hasMaxPageSize()
       The result page will contain at most max_page_size entries of the respective active contract snapshot.
 The server might reject max_page_size breaching the server-specified limit.
 Optional, if not defined, the default will be determined by the server.

 Optional
      optional int32 max_page_size = 3;
      Specified by:
      hasMaxPageSize in interface StateServiceOuterClass.GetActiveContractsPageRequestOrBuilder
      Returns:
      Whether the maxPageSize field is set.

    • getMaxPageSize

      public int getMaxPageSize()
       The result page will contain at most max_page_size entries of the respective active contract snapshot.
 The server might reject max_page_size breaching the server-specified limit.
 Optional, if not defined, the default will be determined by the server.

 Optional
      optional int32 max_page_size = 3;
      Specified by:
      getMaxPageSize in interface StateServiceOuterClass.GetActiveContractsPageRequestOrBuilder
      Returns:
      The maxPageSize.

    • hasPageToken

      public boolean hasPageToken()
       To get the next page of the active contracts snapshot, the ``page_token`` should be set to the
 ``next_page_token`` of the last ``GetActiveContractsPageResponse``.
 The page token only works if subsequent requests:

 - are executed on the same participant,
 - use the same active_at_offset and event_format,
 - and the participant's store was not pruned to after the active_at_offset.

 If not specified, the first page of the active contracts snapshot will be returned.

 Optional: can be empty
      optional bytes page_token = 4;
      Specified by:
      hasPageToken in interface StateServiceOuterClass.GetActiveContractsPageRequestOrBuilder
      Returns:
      Whether the pageToken field is set.

    • getPageToken

      public com.google.protobuf.ByteString getPageToken()
       To get the next page of the active contracts snapshot, the ``page_token`` should be set to the
 ``next_page_token`` of the last ``GetActiveContractsPageResponse``.
 The page token only works if subsequent requests:

 - are executed on the same participant,
 - use the same active_at_offset and event_format,
 - and the participant's store was not pruned to after the active_at_offset.

 If not specified, the first page of the active contracts snapshot will be returned.

 Optional: can be empty
      optional bytes page_token = 4;
      Specified by:
      getPageToken in interface StateServiceOuterClass.GetActiveContractsPageRequestOrBuilder
      Returns:
      The pageToken.

    • 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.GetActiveContractsPageRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static StateServiceOuterClass.GetActiveContractsPageRequest 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.GetActiveContractsPageRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static StateServiceOuterClass.GetActiveContractsPageRequest.Builder newBuilder()

    • newBuilder

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

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static StateServiceOuterClass.GetActiveContractsPageRequest getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<StateServiceOuterClass.GetActiveContractsPageRequest> 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.GetActiveContractsPageRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder