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

Interface ScheduleOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
All Known Implementing Classes:
Schedule, Schedule.Builder
@Generated public interface ScheduleOrBuilder extends com.google.protobuf.MessageLiteOrBuilder

  • Method Details

    • hasScheduleId

      boolean hasScheduleId()
       *
 This schedule's ID within the global network state.
 <p>
 This value SHALL be unique within the network.
      .proto.ScheduleID schedule_id = 1;
      Returns:
      Whether the scheduleId field is set.

    • getScheduleId

      ScheduleID getScheduleId()
       *
 This schedule's ID within the global network state.
 <p>
 This value SHALL be unique within the network.
      .proto.ScheduleID schedule_id = 1;
      Returns:
      The scheduleId.

    • getDeleted

      boolean getDeleted()
       *
 A flag indicating this schedule is deleted.
 <p>
 A schedule SHALL either be executed or deleted, but never both.
      bool deleted = 2;
      Returns:
      The deleted.

    • getExecuted

      boolean getExecuted()
       *
 A flag indicating this schedule has executed.
 <p>
 A schedule SHALL either be executed or deleted, but never both.
      bool executed = 3;
      Returns:
      The executed.

    • getWaitForExpiry

      boolean getWaitForExpiry()
       *
 A schedule flag to wait for expiration before executing.
 <p>
 A schedule SHALL be executed immediately when all necessary signatures
 are gathered, unless this flag is set.<br/>
 If this flag is set, the schedule SHALL wait until the consensus time
 reaches `expiration_time_provided`, when signatures MUST again be
 verified. If all required signatures are present at that time, the
 schedule SHALL be executed. Otherwise the schedule SHALL expire without
 execution.
 <p>
 Note that a schedule is always removed from state after it expires,
 regardless of whether it was executed or not.
      bool wait_for_expiry = 4;
      Returns:
      The waitForExpiry.

    • getMemo

      String getMemo()
       *
 A short description for this schedule.
 <p>
 This value, if set, MUST NOT exceed `transaction.maxMemoUtf8Bytes`
 (default 100) bytes when encoded as UTF-8.
      string memo = 5;
      Returns:
      The memo.

    • getMemoBytes

      com.google.protobuf.ByteString getMemoBytes()
       *
 A short description for this schedule.
 <p>
 This value, if set, MUST NOT exceed `transaction.maxMemoUtf8Bytes`
 (default 100) bytes when encoded as UTF-8.
      string memo = 5;
      Returns:
      The bytes for memo.

    • hasSchedulerAccountId

      boolean hasSchedulerAccountId()
       *
 The scheduler account for this schedule.
 <p>
 This SHALL be the account that submitted the original
 ScheduleCreate transaction.
      .proto.AccountID scheduler_account_id = 6;
      Returns:
      Whether the schedulerAccountId field is set.

    • getSchedulerAccountId

      AccountID getSchedulerAccountId()
       *
 The scheduler account for this schedule.
 <p>
 This SHALL be the account that submitted the original
 ScheduleCreate transaction.
      .proto.AccountID scheduler_account_id = 6;
      Returns:
      The schedulerAccountId.

    • hasPayerAccountId

      boolean hasPayerAccountId()
       *
 The explicit payer account for the scheduled transaction.
 <p>
 If set, this account SHALL be added to the accounts that MUST sign the
 schedule before it may execute.
      .proto.AccountID payer_account_id = 7;
      Returns:
      Whether the payerAccountId field is set.

    • getPayerAccountId

      AccountID getPayerAccountId()
       *
 The explicit payer account for the scheduled transaction.
 <p>
 If set, this account SHALL be added to the accounts that MUST sign the
 schedule before it may execute.
      .proto.AccountID payer_account_id = 7;
      Returns:
      The payerAccountId.

    • hasAdminKey

      boolean hasAdminKey()
       *
 The admin key for this schedule.
 <p>
 This key, if set, MUST sign any `schedule_delete` transaction.<br/>
 If not set, then this schedule SHALL NOT be deleted, and any
 `schedule_delete` transaction for this schedule SHALL fail.
      .proto.Key admin_key = 8;
      Returns:
      Whether the adminKey field is set.

    • getAdminKey

      Key getAdminKey()
       *
 The admin key for this schedule.
 <p>
 This key, if set, MUST sign any `schedule_delete` transaction.<br/>
 If not set, then this schedule SHALL NOT be deleted, and any
 `schedule_delete` transaction for this schedule SHALL fail.
      .proto.Key admin_key = 8;
      Returns:
      The adminKey.

    • hasScheduleValidStart

      boolean hasScheduleValidStart()
       *
 The transaction valid start value for this schedule.
 <p>
 This MUST be set, and SHALL be copied from the `TransactionID` of
 the original `schedule_create` transaction.
      .proto.Timestamp schedule_valid_start = 9;
      Returns:
      Whether the scheduleValidStart field is set.

    • getScheduleValidStart

      Timestamp getScheduleValidStart()
       *
 The transaction valid start value for this schedule.
 <p>
 This MUST be set, and SHALL be copied from the `TransactionID` of
 the original `schedule_create` transaction.
      .proto.Timestamp schedule_valid_start = 9;
      Returns:
      The scheduleValidStart.

    • getProvidedExpirationSecond

      long getProvidedExpirationSecond()
       *
 The requested expiration time of the schedule if provided by the user.
 <p>
 If not provided in the `schedule_create` transaction, this SHALL be set
 to a default value equal to the current consensus time, forward offset by
 the maximum schedule expiration time in the current dynamic network
 configuration (typically 62 days).<br/>
 The actual `calculated_expiration_second` MAY be "earlier" than this,
 but MUST NOT be later.
      int64 provided_expiration_second = 10;
      Returns:
      The providedExpirationSecond.

    • getCalculatedExpirationSecond

      long getCalculatedExpirationSecond()
       *
 The calculated expiration time of the schedule.
 <p>
 This SHALL be calculated from the requested expiration time in the
 `schedule_create` transaction, and limited by the maximum expiration time
 in the current dynamic network configuration (typically 62 days).
 <p>
 The schedule SHALL be removed from global network state after the network
 reaches a consensus time greater than or equal to this value.
      int64 calculated_expiration_second = 11;
      Returns:
      The calculatedExpirationSecond.

    • hasResolutionTime

      boolean hasResolutionTime()
       *
 The consensus timestamp of the transaction that executed or deleted this schedule.
 <p>
 This value SHALL be set to the `current_consensus_time` when a
 `schedule_delete` transaction is completed.<br/>
 This value SHALL be set to the `current_consensus_time` when the
 scheduled transaction is executed, either as a result of gathering the
 final required signature, or, if long-term schedule execution is enabled,
 at the requested execution time.
      .proto.Timestamp resolution_time = 12;
      Returns:
      Whether the resolutionTime field is set.

    • getResolutionTime

      Timestamp getResolutionTime()
       *
 The consensus timestamp of the transaction that executed or deleted this schedule.
 <p>
 This value SHALL be set to the `current_consensus_time` when a
 `schedule_delete` transaction is completed.<br/>
 This value SHALL be set to the `current_consensus_time` when the
 scheduled transaction is executed, either as a result of gathering the
 final required signature, or, if long-term schedule execution is enabled,
 at the requested execution time.
      .proto.Timestamp resolution_time = 12;
      Returns:
      The resolutionTime.

    • hasScheduledTransaction

      boolean hasScheduledTransaction()
       *
 The scheduled transaction to execute.
 <p>
 This MUST be one of the transaction types permitted in the current value
 of the `schedule.whitelist` in the dynamic network configuration.
      .proto.SchedulableTransactionBody scheduled_transaction = 13;
      Returns:
      Whether the scheduledTransaction field is set.

    • getScheduledTransaction

      SchedulableTransactionBody getScheduledTransaction()
       *
 The scheduled transaction to execute.
 <p>
 This MUST be one of the transaction types permitted in the current value
 of the `schedule.whitelist` in the dynamic network configuration.
      .proto.SchedulableTransactionBody scheduled_transaction = 13;
      Returns:
      The scheduledTransaction.

    • hasOriginalCreateTransaction

      boolean hasOriginalCreateTransaction()
       *
 The full transaction that created this schedule.
 <p>
 This is primarily used for duplicate schedule create detection. This is
 also the source of the parent transaction ID, from which the child
 transaction ID is derived when the `scheduled_transaction` is executed.
      .proto.TransactionBody original_create_transaction = 14;
      Returns:
      Whether the originalCreateTransaction field is set.

    • getOriginalCreateTransaction

      TransactionBody getOriginalCreateTransaction()
       *
 The full transaction that created this schedule.
 <p>
 This is primarily used for duplicate schedule create detection. This is
 also the source of the parent transaction ID, from which the child
 transaction ID is derived when the `scheduled_transaction` is executed.
      .proto.TransactionBody original_create_transaction = 14;
      Returns:
      The originalCreateTransaction.

    • getSignatoriesList

      List<Key> getSignatoriesList()
       *
 All of the "primitive" keys that have already signed this schedule.
 <p>
 The scheduled transaction SHALL NOT be executed before this list is
 sufficient to "activate" the required keys for the scheduled transaction.<br/>
 A Key SHALL NOT be stored in this list unless the corresponding private
 key has signed either the original `schedule_create` transaction or a
 subsequent `schedule_sign` transaction intended for, and referencing to,
 this specific schedule.
 <p>
 The only keys stored are "primitive" keys (ED25519 or ECDSA_SECP256K1) in
 order to ensure that any key list or threshold keys are correctly handled,
 regardless of signing order, intervening changes, or other situations.
 The `scheduled_transaction` SHALL execute only if, at the time of
 execution, this list contains sufficient public keys to satisfy the
 full requirements for signature on that transaction.
      repeated .proto.Key signatories = 15;

    • getSignatories

      Key getSignatories(int index)
       *
 All of the "primitive" keys that have already signed this schedule.
 <p>
 The scheduled transaction SHALL NOT be executed before this list is
 sufficient to "activate" the required keys for the scheduled transaction.<br/>
 A Key SHALL NOT be stored in this list unless the corresponding private
 key has signed either the original `schedule_create` transaction or a
 subsequent `schedule_sign` transaction intended for, and referencing to,
 this specific schedule.
 <p>
 The only keys stored are "primitive" keys (ED25519 or ECDSA_SECP256K1) in
 order to ensure that any key list or threshold keys are correctly handled,
 regardless of signing order, intervening changes, or other situations.
 The `scheduled_transaction` SHALL execute only if, at the time of
 execution, this list contains sufficient public keys to satisfy the
 full requirements for signature on that transaction.
      repeated .proto.Key signatories = 15;

    • getSignatoriesCount

      int getSignatoriesCount()
       *
 All of the "primitive" keys that have already signed this schedule.
 <p>
 The scheduled transaction SHALL NOT be executed before this list is
 sufficient to "activate" the required keys for the scheduled transaction.<br/>
 A Key SHALL NOT be stored in this list unless the corresponding private
 key has signed either the original `schedule_create` transaction or a
 subsequent `schedule_sign` transaction intended for, and referencing to,
 this specific schedule.
 <p>
 The only keys stored are "primitive" keys (ED25519 or ECDSA_SECP256K1) in
 order to ensure that any key list or threshold keys are correctly handled,
 regardless of signing order, intervening changes, or other situations.
 The `scheduled_transaction` SHALL execute only if, at the time of
 execution, this list contains sufficient public keys to satisfy the
 full requirements for signature on that transaction.
      repeated .proto.Key signatories = 15;