Package com.daml.ledger.api.v2
Class StateServiceOuterClass.GetActiveContractsPageRequest.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<StateServiceOuterClass.GetActiveContractsPageRequest.Builder>
com.google.protobuf.GeneratedMessageV3.Builder<StateServiceOuterClass.GetActiveContractsPageRequest.Builder>
com.daml.ledger.api.v2.StateServiceOuterClass.GetActiveContractsPageRequest.Builder
- All Implemented Interfaces:
StateServiceOuterClass.GetActiveContractsPageRequestOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable
- Enclosing class:
StateServiceOuterClass.GetActiveContractsPageRequest
public static final class StateServiceOuterClass.GetActiveContractsPageRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<StateServiceOuterClass.GetActiveContractsPageRequest.Builder>
implements StateServiceOuterClass.GetActiveContractsPageRequestOrBuilder
Protobuf type
com.daml.ledger.api.v2.GetActiveContractsPageRequest-
Method Summary
Modifier and TypeMethodDescriptionaddRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) build()clear()The offset at which the snapshot of the active contracts will be computed.Format of the contract_entries in the result.clearField(com.google.protobuf.Descriptors.FieldDescriptor field) The result page will contain at most max_page_size entries of the respective active contract snapshot.clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) 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``.clone()longThe offset at which the snapshot of the active contracts will be computed.static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorFormat of the contract_entries in the result.Format of the contract_entries in the result.Format of the contract_entries in the result.intThe result page will contain at most max_page_size entries of the respective active contract snapshot.com.google.protobuf.ByteStringTo get the next page of the active contracts snapshot, the ``page_token`` should be set to the ``next_page_token`` of the last ``GetActiveContractsPageResponse``.booleanThe offset at which the snapshot of the active contracts will be computed.booleanFormat of the contract_entries in the result.booleanThe result page will contain at most max_page_size entries of the respective active contract snapshot.booleanTo get the next page of the active contracts snapshot, the ``page_token`` should be set to the ``next_page_token`` of the last ``GetActiveContractsPageResponse``.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanFormat of the contract_entries in the result.mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) setActiveAtOffset(long value) The offset at which the snapshot of the active contracts will be computed.Format of the contract_entries in the result.setEventFormat(TransactionFilterOuterClass.EventFormat.Builder builderForValue) Format of the contract_entries in the result.setMaxPageSize(int value) The result page will contain at most max_page_size entries of the respective active contract snapshot.setPageToken(com.google.protobuf.ByteString value) 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``.setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<StateServiceOuterClass.GetActiveContractsPageRequest.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<StateServiceOuterClass.GetActiveContractsPageRequest.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<StateServiceOuterClass.GetActiveContractsPageRequest.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<StateServiceOuterClass.GetActiveContractsPageRequest.Builder>
-
setField
public StateServiceOuterClass.GetActiveContractsPageRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<StateServiceOuterClass.GetActiveContractsPageRequest.Builder>
-
clearField
public StateServiceOuterClass.GetActiveContractsPageRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field) - Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<StateServiceOuterClass.GetActiveContractsPageRequest.Builder>
-
clearOneof
public StateServiceOuterClass.GetActiveContractsPageRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) - Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<StateServiceOuterClass.GetActiveContractsPageRequest.Builder>
-
setRepeatedField
public StateServiceOuterClass.GetActiveContractsPageRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) - Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<StateServiceOuterClass.GetActiveContractsPageRequest.Builder>
-
addRepeatedField
public StateServiceOuterClass.GetActiveContractsPageRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<StateServiceOuterClass.GetActiveContractsPageRequest.Builder>
-
mergeFrom
public StateServiceOuterClass.GetActiveContractsPageRequest.Builder mergeFrom(com.google.protobuf.Message other) - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<StateServiceOuterClass.GetActiveContractsPageRequest.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3.Builder<StateServiceOuterClass.GetActiveContractsPageRequest.Builder>
-
mergeFrom
public StateServiceOuterClass.GetActiveContractsPageRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<StateServiceOuterClass.GetActiveContractsPageRequest.Builder>- Throws:
IOException
-
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:
hasActiveAtOffsetin interfaceStateServiceOuterClass.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:
getActiveAtOffsetin interfaceStateServiceOuterClass.GetActiveContractsPageRequestOrBuilder- Returns:
- The activeAtOffset.
-
setActiveAtOffset
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;- Parameters:
value- The activeAtOffset to set.- Returns:
- This builder for chaining.
-
clearActiveAtOffset
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;- Returns:
- This builder for chaining.
-
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:
hasEventFormatin interfaceStateServiceOuterClass.GetActiveContractsPageRequestOrBuilder- Returns:
- Whether the eventFormat field is set.
-
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:
getEventFormatin interfaceStateServiceOuterClass.GetActiveContractsPageRequestOrBuilder- Returns:
- The eventFormat.
-
setEventFormat
public StateServiceOuterClass.GetActiveContractsPageRequest.Builder setEventFormat(TransactionFilterOuterClass.EventFormat value) 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; -
setEventFormat
public StateServiceOuterClass.GetActiveContractsPageRequest.Builder setEventFormat(TransactionFilterOuterClass.EventFormat.Builder builderForValue) 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; -
mergeEventFormat
public StateServiceOuterClass.GetActiveContractsPageRequest.Builder mergeEventFormat(TransactionFilterOuterClass.EventFormat value) 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; -
clearEventFormat
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; -
getEventFormatBuilder
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; -
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:
getEventFormatOrBuilderin interfaceStateServiceOuterClass.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:
hasMaxPageSizein interfaceStateServiceOuterClass.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:
getMaxPageSizein interfaceStateServiceOuterClass.GetActiveContractsPageRequestOrBuilder- Returns:
- The maxPageSize.
-
setMaxPageSize
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;- Parameters:
value- The maxPageSize to set.- Returns:
- This builder for chaining.
-
clearMaxPageSize
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;- Returns:
- This builder for chaining.
-
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:
hasPageTokenin interfaceStateServiceOuterClass.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:
getPageTokenin interfaceStateServiceOuterClass.GetActiveContractsPageRequestOrBuilder- Returns:
- The pageToken.
-
setPageToken
public StateServiceOuterClass.GetActiveContractsPageRequest.Builder setPageToken(com.google.protobuf.ByteString value) 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;- Parameters:
value- The pageToken to set.- Returns:
- This builder for chaining.
-
clearPageToken
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;- Returns:
- This builder for chaining.
-
setUnknownFields
public final StateServiceOuterClass.GetActiveContractsPageRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<StateServiceOuterClass.GetActiveContractsPageRequest.Builder>
-
mergeUnknownFields
public final StateServiceOuterClass.GetActiveContractsPageRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<StateServiceOuterClass.GetActiveContractsPageRequest.Builder>
-