Module com.hedera.hashgraph.sdk
Package com.hedera.hashgraph.sdk.proto

Class AssessedCustomFee

java.lang.Object
com.google.protobuf.AbstractMessageLite<AssessedCustomFee,AssessedCustomFee.Builder>
com.google.protobuf.GeneratedMessageLite<AssessedCustomFee,AssessedCustomFee.Builder>
com.hedera.hashgraph.sdk.proto.AssessedCustomFee
All Implemented Interfaces:
com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, AssessedCustomFeeOrBuilder
@Generated public final class AssessedCustomFee extends com.google.protobuf.GeneratedMessageLite<AssessedCustomFee,AssessedCustomFee.Builder> implements AssessedCustomFeeOrBuilder
 *
 Description of a transfer added to a `cryptoTransfer` transaction that
 satisfies custom fee requirements.

 It is important to note that this is not the actual transfer. The transfer
 of value SHALL be merged into the original transaction to minimize the
 number of actual transfers. This descriptor presents the fee assessed
 separately in the record stream so that the details of the fee assessed
 are not hidden in this process.
Protobuf type proto.AssessedCustomFee

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    AssessedCustomFee.Builder
    * Description of a transfer added to a `cryptoTransfer` transaction that satisfies custom fee requirements.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageLite

    com.google.protobuf.GeneratedMessageLite.DefaultInstanceBasedParser<T extends com.google.protobuf.GeneratedMessageLite<T,?>>, com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.GeneratedExtension<ContainingType extends com.google.protobuf.MessageLite,Type>, com.google.protobuf.GeneratedMessageLite.MethodToInvoke, com.google.protobuf.GeneratedMessageLite.SerializedForm

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    AMOUNT_FIELD_NUMBER
     
    static final int
    EFFECTIVE_PAYER_ACCOUNT_ID_FIELD_NUMBER
     
    static final int
    FEE_COLLECTOR_ACCOUNT_ID_FIELD_NUMBER
     
    static final int
    TOKEN_ID_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageLite

    unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    protected final Object
    dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
     
    long
    getAmount()
    * An amount of tokens assessed for this custom fee.
    static AssessedCustomFee
    getDefaultInstance()
     
    AccountID
    getEffectivePayerAccountId(int index)
    * An account that provided the tokens assessed as a fee.
    int
    getEffectivePayerAccountIdCount()
    * An account that provided the tokens assessed as a fee.
    List<AccountID>
    getEffectivePayerAccountIdList()
    * An account that provided the tokens assessed as a fee.
    AccountIDOrBuilder
    getEffectivePayerAccountIdOrBuilder(int index)
    * An account that provided the tokens assessed as a fee.
    List<? extends AccountIDOrBuilder>
    getEffectivePayerAccountIdOrBuilderList()
    * An account that provided the tokens assessed as a fee.
    AccountID
    getFeeCollectorAccountId()
    * An account that received the fee assessed.
    TokenID
    getTokenId()
    * The token transferred to satisfy this fee.
    boolean
    hasFeeCollectorAccountId()
    * An account that received the fee assessed.
    boolean
    hasTokenId()
    * The token transferred to satisfy this fee.
    static AssessedCustomFee.Builder
    newBuilder()
     
    static AssessedCustomFee.Builder
    newBuilder(AssessedCustomFee prototype)
     
    static AssessedCustomFee
    parseDelimitedFrom(InputStream input)
     
    static AssessedCustomFee
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AssessedCustomFee
    parseFrom(byte[] data)
     
    static AssessedCustomFee
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AssessedCustomFee
    parseFrom(com.google.protobuf.ByteString data)
     
    static AssessedCustomFee
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AssessedCustomFee
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static AssessedCustomFee
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AssessedCustomFee
    parseFrom(InputStream input)
     
    static AssessedCustomFee
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AssessedCustomFee
    parseFrom(ByteBuffer data)
     
    static AssessedCustomFee
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<AssessedCustomFee>
    parser()
     

    Methods inherited from class com.google.protobuf.GeneratedMessageLite

    createBuilder, createBuilder, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, getSerializedSize, hashCode, isInitialized, makeImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newMessageInfo, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parseUnknownField, registerDefaultInstance, toBuilder, toString, writeTo

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Field Details

    • AMOUNT_FIELD_NUMBER

      public static final int AMOUNT_FIELD_NUMBER
      See Also:

    • TOKEN_ID_FIELD_NUMBER

      public static final int TOKEN_ID_FIELD_NUMBER
      See Also:

    • FEE_COLLECTOR_ACCOUNT_ID_FIELD_NUMBER

      public static final int FEE_COLLECTOR_ACCOUNT_ID_FIELD_NUMBER
      See Also:

    • EFFECTIVE_PAYER_ACCOUNT_ID_FIELD_NUMBER

      public static final int EFFECTIVE_PAYER_ACCOUNT_ID_FIELD_NUMBER
      See Also:

  • Method Details

    • getAmount

      public long getAmount()
       *
 An amount of tokens assessed for this custom fee.
 <p>
 This shall be expressed in units of 10<sup>-decimals</sup> tokens.
      int64 amount = 1;
      Specified by:
      getAmount in interface AssessedCustomFeeOrBuilder
      Returns:
      The amount.

    • hasTokenId

      public boolean hasTokenId()
       *
 The token transferred to satisfy this fee.
 <p>
 If the token transferred is HBAR, this field SHALL NOT be set.
      .proto.TokenID token_id = 2;
      Specified by:
      hasTokenId in interface AssessedCustomFeeOrBuilder
      Returns:
      Whether the tokenId field is set.

    • getTokenId

      public TokenID getTokenId()
       *
 The token transferred to satisfy this fee.
 <p>
 If the token transferred is HBAR, this field SHALL NOT be set.
      .proto.TokenID token_id = 2;
      Specified by:
      getTokenId in interface AssessedCustomFeeOrBuilder
      Returns:
      The tokenId.

    • hasFeeCollectorAccountId

      public boolean hasFeeCollectorAccountId()
       *
 An account that received the fee assessed.
 <p>
 This SHALL NOT be the sender or receiver of the original
 cryptoTransfer transaction.
      .proto.AccountID fee_collector_account_id = 3;
      Specified by:
      hasFeeCollectorAccountId in interface AssessedCustomFeeOrBuilder
      Returns:
      Whether the feeCollectorAccountId field is set.

    • getFeeCollectorAccountId

      public AccountID getFeeCollectorAccountId()
       *
 An account that received the fee assessed.
 <p>
 This SHALL NOT be the sender or receiver of the original
 cryptoTransfer transaction.
      .proto.AccountID fee_collector_account_id = 3;
      Specified by:
      getFeeCollectorAccountId in interface AssessedCustomFeeOrBuilder
      Returns:
      The feeCollectorAccountId.

    • getEffectivePayerAccountIdList

      public List<AccountID> getEffectivePayerAccountIdList()
       *
 An account that provided the tokens assessed as a fee.
 <p>
 This SHALL be the account that _would have_ had a higher balance
 absent the fee. In most cases this SHALL be the `sender`, but
 some _fractional_ fees reduce the amount transferred, and in those
 cases the `receiver` SHALL be the effective payer for the fee.<br/>
 There are currently no situations where a third party pays a custom
 fee. This MAY change in a future release.
      repeated .proto.AccountID effective_payer_account_id = 4;
      Specified by:
      getEffectivePayerAccountIdList in interface AssessedCustomFeeOrBuilder

    • getEffectivePayerAccountIdOrBuilderList

      public List<? extends AccountIDOrBuilder> getEffectivePayerAccountIdOrBuilderList()
       *
 An account that provided the tokens assessed as a fee.
 <p>
 This SHALL be the account that _would have_ had a higher balance
 absent the fee. In most cases this SHALL be the `sender`, but
 some _fractional_ fees reduce the amount transferred, and in those
 cases the `receiver` SHALL be the effective payer for the fee.<br/>
 There are currently no situations where a third party pays a custom
 fee. This MAY change in a future release.
      repeated .proto.AccountID effective_payer_account_id = 4;

    • getEffectivePayerAccountIdCount

      public int getEffectivePayerAccountIdCount()
       *
 An account that provided the tokens assessed as a fee.
 <p>
 This SHALL be the account that _would have_ had a higher balance
 absent the fee. In most cases this SHALL be the `sender`, but
 some _fractional_ fees reduce the amount transferred, and in those
 cases the `receiver` SHALL be the effective payer for the fee.<br/>
 There are currently no situations where a third party pays a custom
 fee. This MAY change in a future release.
      repeated .proto.AccountID effective_payer_account_id = 4;
      Specified by:
      getEffectivePayerAccountIdCount in interface AssessedCustomFeeOrBuilder

    • getEffectivePayerAccountId

      public AccountID getEffectivePayerAccountId(int index)
       *
 An account that provided the tokens assessed as a fee.
 <p>
 This SHALL be the account that _would have_ had a higher balance
 absent the fee. In most cases this SHALL be the `sender`, but
 some _fractional_ fees reduce the amount transferred, and in those
 cases the `receiver` SHALL be the effective payer for the fee.<br/>
 There are currently no situations where a third party pays a custom
 fee. This MAY change in a future release.
      repeated .proto.AccountID effective_payer_account_id = 4;
      Specified by:
      getEffectivePayerAccountId in interface AssessedCustomFeeOrBuilder

    • getEffectivePayerAccountIdOrBuilder

      public AccountIDOrBuilder getEffectivePayerAccountIdOrBuilder(int index)
       *
 An account that provided the tokens assessed as a fee.
 <p>
 This SHALL be the account that _would have_ had a higher balance
 absent the fee. In most cases this SHALL be the `sender`, but
 some _fractional_ fees reduce the amount transferred, and in those
 cases the `receiver` SHALL be the effective payer for the fee.<br/>
 There are currently no situations where a third party pays a custom
 fee. This MAY change in a future release.
      repeated .proto.AccountID effective_payer_account_id = 4;

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static AssessedCustomFee parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static AssessedCustomFee parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilder

      public static AssessedCustomFee.Builder newBuilder()

    • newBuilder

      public static AssessedCustomFee.Builder newBuilder(AssessedCustomFee prototype)

    • dynamicMethod

      protected final Object dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
      Specified by:
      dynamicMethod in class com.google.protobuf.GeneratedMessageLite<AssessedCustomFee,AssessedCustomFee.Builder>

    • getDefaultInstance

      public static AssessedCustomFee getDefaultInstance()

    • parser

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