Package com.daml.ledger.api.v2

Interface CommandsOuterClass.PrefetchContractKeyOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
CommandsOuterClass.PrefetchContractKey, CommandsOuterClass.PrefetchContractKey.Builder
Enclosing class:
CommandsOuterClass
public static interface CommandsOuterClass.PrefetchContractKeyOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    com.daml.ledger.api.v2.ValueOuterClass.Value
    getContractKey()
    The key of the contract the client wants to prefetch.
    com.daml.ledger.api.v2.ValueOuterClass.ValueOrBuilder
    getContractKeyOrBuilder()
    The key of the contract the client wants to prefetch.
    int
    getLimit()
    The number of contracts to prefetch for this key, if available.
    com.daml.ledger.api.v2.ValueOuterClass.Identifier
    getTemplateId()
    The template of contract the client wants to prefetch.
    com.daml.ledger.api.v2.ValueOuterClass.IdentifierOrBuilder
    getTemplateIdOrBuilder()
    The template of contract the client wants to prefetch.
    boolean
    hasContractKey()
    The key of the contract the client wants to prefetch.
    boolean
    hasLimit()
    The number of contracts to prefetch for this key, if available.
    boolean
    hasTemplateId()
    The template of contract the client wants to prefetch.

    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

    • hasTemplateId

      boolean hasTemplateId()
       The template of contract the client wants to prefetch.
 Both package-name and package-id reference identifier formats for the template-id are supported.
 Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4.

 Required
      .com.daml.ledger.api.v2.Identifier template_id = 1;
      Returns:
      Whether the templateId field is set.

    • getTemplateId

      com.daml.ledger.api.v2.ValueOuterClass.Identifier getTemplateId()
       The template of contract the client wants to prefetch.
 Both package-name and package-id reference identifier formats for the template-id are supported.
 Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4.

 Required
      .com.daml.ledger.api.v2.Identifier template_id = 1;
      Returns:
      The templateId.

    • getTemplateIdOrBuilder

      com.daml.ledger.api.v2.ValueOuterClass.IdentifierOrBuilder getTemplateIdOrBuilder()
       The template of contract the client wants to prefetch.
 Both package-name and package-id reference identifier formats for the template-id are supported.
 Note: The package-id reference identifier format is deprecated. We plan to end support for this format in version 3.4.

 Required
      .com.daml.ledger.api.v2.Identifier template_id = 1;

    • hasContractKey

      boolean hasContractKey()
       The key of the contract the client wants to prefetch.

 Required
      .com.daml.ledger.api.v2.Value contract_key = 2;
      Returns:
      Whether the contractKey field is set.

    • getContractKey

      com.daml.ledger.api.v2.ValueOuterClass.Value getContractKey()
       The key of the contract the client wants to prefetch.

 Required
      .com.daml.ledger.api.v2.Value contract_key = 2;
      Returns:
      The contractKey.

    • getContractKeyOrBuilder

      com.daml.ledger.api.v2.ValueOuterClass.ValueOrBuilder getContractKeyOrBuilder()
       The key of the contract the client wants to prefetch.

 Required
      .com.daml.ledger.api.v2.Value contract_key = 2;

    • hasLimit

      boolean hasLimit()
       The number of contracts to prefetch for this key, if available.
 This is in addition to disclosed contracts.
 - for backward compatibility reason, absence is interpreted as 1
 - 0 is forbidden
 - capped at 2^31 - 1. The system may impose further limits.

 Optional
      optional uint32 limit = 3;
      Returns:
      Whether the limit field is set.

    • getLimit

      int getLimit()
       The number of contracts to prefetch for this key, if available.
 This is in addition to disclosed contracts.
 - for backward compatibility reason, absence is interpreted as 1
 - 0 is forbidden
 - capped at 2^31 - 1. The system may impose further limits.

 Optional
      optional uint32 limit = 3;
      Returns:
      The limit.