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

Interface ScheduleInfoOrBuilder

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

  • Method Details

    • hasScheduleID

      boolean hasScheduleID()
       *
 A schedule identifier.
 <p>
 This SHALL identify the schedule retrieved.
      .proto.ScheduleID scheduleID = 1;
      Returns:
      Whether the scheduleID field is set.

    • getScheduleID

      ScheduleID getScheduleID()
       *
 A schedule identifier.
 <p>
 This SHALL identify the schedule retrieved.
      .proto.ScheduleID scheduleID = 1;
      Returns:
      The scheduleID.

    • hasDeletionTime

      boolean hasDeletionTime()
       *
 A deletion timestamp.
 <p>
 If the schedule was deleted, this SHALL be set to the consensus
 timestamp of the `deleteSchedule` transaction.<br/>
 If the schedule is _not_ deleted, this field SHALL NOT be set.
      .proto.Timestamp deletion_time = 2;
      Returns:
      Whether the deletionTime field is set.

    • getDeletionTime

      Timestamp getDeletionTime()
       *
 A deletion timestamp.
 <p>
 If the schedule was deleted, this SHALL be set to the consensus
 timestamp of the `deleteSchedule` transaction.<br/>
 If the schedule is _not_ deleted, this field SHALL NOT be set.
      .proto.Timestamp deletion_time = 2;
      Returns:
      The deletionTime.

    • hasExecutionTime

      boolean hasExecutionTime()
       *
 An execution timestamp.
 <p>
 If the schedule was completed, and the _scheduled_ transaction
 executed, this SHALL be set to the consensus timestamp of the
 transaction that initiated that execution.<br/>
 If the schedule is _not_ complete, this field SHALL NOT be set.
      .proto.Timestamp execution_time = 3;
      Returns:
      Whether the executionTime field is set.

    • getExecutionTime

      Timestamp getExecutionTime()
       *
 An execution timestamp.
 <p>
 If the schedule was completed, and the _scheduled_ transaction
 executed, this SHALL be set to the consensus timestamp of the
 transaction that initiated that execution.<br/>
 If the schedule is _not_ complete, this field SHALL NOT be set.
      .proto.Timestamp execution_time = 3;
      Returns:
      The executionTime.

    • hasExpirationTime

      boolean hasExpirationTime()
       *
 An expiration timestamp.<br/>
 This represents the time at which the schedule will expire. For a
 long-term schedule (if enabled) this is when the schedule will be
 executed, assuming it meets signature requirements at that time.
 For a short-term schedule, this is the deadline to complete the
 signature requirements for the scheduled transaction to execute.
 Regardless of schedule type, the schedule will be removed from
 state when it expires.
 <p>
 A schedule SHALL be removed from state when it expires.<br/>
 A short-term schedule MUST meet signature requirements strictly
 before expiration or it SHALL NOT be executed.<br/>
 A long-term schedule SHALL be executed if, and only if, all signature
 requirements for the scheduled transaction are met at expiration.<br/>
 A long-term schedule SHALL NOT be executed if any signature requirement
 for the scheduled transaction are not met at expiration.<br/>
      .proto.Timestamp expirationTime = 4;
      Returns:
      Whether the expirationTime field is set.

    • getExpirationTime

      Timestamp getExpirationTime()
       *
 An expiration timestamp.<br/>
 This represents the time at which the schedule will expire. For a
 long-term schedule (if enabled) this is when the schedule will be
 executed, assuming it meets signature requirements at that time.
 For a short-term schedule, this is the deadline to complete the
 signature requirements for the scheduled transaction to execute.
 Regardless of schedule type, the schedule will be removed from
 state when it expires.
 <p>
 A schedule SHALL be removed from state when it expires.<br/>
 A short-term schedule MUST meet signature requirements strictly
 before expiration or it SHALL NOT be executed.<br/>
 A long-term schedule SHALL be executed if, and only if, all signature
 requirements for the scheduled transaction are met at expiration.<br/>
 A long-term schedule SHALL NOT be executed if any signature requirement
 for the scheduled transaction are not met at expiration.<br/>
      .proto.Timestamp expirationTime = 4;
      Returns:
      The expirationTime.

    • hasScheduledTransactionBody

      boolean hasScheduledTransactionBody()
       *
 A scheduled transaction.
 <p>
 This SHALL be a transaction type enabled in the network property
 `scheduling.whitelist`, and SHALL NOT be any other
 transaction type.<br/>
 This transaction SHALL be executed if the schedule meets all signature
 and execution time requirements for this transaction.<br/>
 The signature requirements for this transaction SHALL be evaluated
 at schedule creation, SHALL be reevaluated with each `signSchedule`
 transaction, and, for long-term schedules, SHALL be reevaluated when
 the schedule expires.<br/>
      .proto.SchedulableTransactionBody scheduledTransactionBody = 5;
      Returns:
      Whether the scheduledTransactionBody field is set.

    • getScheduledTransactionBody

      SchedulableTransactionBody getScheduledTransactionBody()
       *
 A scheduled transaction.
 <p>
 This SHALL be a transaction type enabled in the network property
 `scheduling.whitelist`, and SHALL NOT be any other
 transaction type.<br/>
 This transaction SHALL be executed if the schedule meets all signature
 and execution time requirements for this transaction.<br/>
 The signature requirements for this transaction SHALL be evaluated
 at schedule creation, SHALL be reevaluated with each `signSchedule`
 transaction, and, for long-term schedules, SHALL be reevaluated when
 the schedule expires.<br/>
      .proto.SchedulableTransactionBody scheduledTransactionBody = 5;
      Returns:
      The scheduledTransactionBody.

    • 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 = 6;
      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 = 6;
      Returns:
      The bytes for memo.

    • hasAdminKey

      boolean hasAdminKey()
       *
 The key used to delete the schedule from state
      .proto.Key adminKey = 7;
      Returns:
      Whether the adminKey field is set.

    • getAdminKey

      Key getAdminKey()
       *
 The key used to delete the schedule from state
      .proto.Key adminKey = 7;
      Returns:
      The adminKey.

    • hasSigners

      boolean hasSigners()
       *
 A list of "valid" signatures for this schedule.<br/>
 This list contains only "primitive" (i.e. cryptographic or contract)
 signatures. The full signature requirements for the scheduled
 transaction are evaluated as if this list of keys had signed the
 scheduled transaction directly.
 <p>
 This list SHALL contain every "primitive" key that has signed the
 original `createSchedule`, or any subsequent
 `signSchedule` transaction.<br/>
 This list MAY elide any signature not likely to be required by the
 scheduled transaction. Such requirement SHOULD be evaluated when the
 signature is presented (i.e. during evaluation of a `createSchedule` or
 `signSchedule` transaction).
      .proto.KeyList signers = 8;
      Returns:
      Whether the signers field is set.

    • getSigners

      KeyList getSigners()
       *
 A list of "valid" signatures for this schedule.<br/>
 This list contains only "primitive" (i.e. cryptographic or contract)
 signatures. The full signature requirements for the scheduled
 transaction are evaluated as if this list of keys had signed the
 scheduled transaction directly.
 <p>
 This list SHALL contain every "primitive" key that has signed the
 original `createSchedule`, or any subsequent
 `signSchedule` transaction.<br/>
 This list MAY elide any signature not likely to be required by the
 scheduled transaction. Such requirement SHOULD be evaluated when the
 signature is presented (i.e. during evaluation of a `createSchedule` or
 `signSchedule` transaction).
      .proto.KeyList signers = 8;
      Returns:
      The signers.

    • hasCreatorAccountID

      boolean hasCreatorAccountID()
       *
 An account identifier.
 <p>
 This SHALL identify the account that created this schedule.
      .proto.AccountID creatorAccountID = 9;
      Returns:
      Whether the creatorAccountID field is set.

    • getCreatorAccountID

      AccountID getCreatorAccountID()
       *
 An account identifier.
 <p>
 This SHALL identify the account that created this schedule.
      .proto.AccountID creatorAccountID = 9;
      Returns:
      The creatorAccountID.

    • hasPayerAccountID

      boolean hasPayerAccountID()
       *
 An account identifier.
 <p>
 The identified account SHALL pay the full transaction fee for the
 scheduled transaction _when it executes_.
      .proto.AccountID payerAccountID = 10;
      Returns:
      Whether the payerAccountID field is set.

    • getPayerAccountID

      AccountID getPayerAccountID()
       *
 An account identifier.
 <p>
 The identified account SHALL pay the full transaction fee for the
 scheduled transaction _when it executes_.
      .proto.AccountID payerAccountID = 10;
      Returns:
      The payerAccountID.

    • hasScheduledTransactionID

      boolean hasScheduledTransactionID()
       *
 A transaction identifier.
 <p>
 This SHALL be recorded as the transaction identifier for the
 _scheduled_ transaction, if (and when) it is executed.
      .proto.TransactionID scheduledTransactionID = 11;
      Returns:
      Whether the scheduledTransactionID field is set.

    • getScheduledTransactionID

      TransactionID getScheduledTransactionID()
       *
 A transaction identifier.
 <p>
 This SHALL be recorded as the transaction identifier for the
 _scheduled_ transaction, if (and when) it is executed.
      .proto.TransactionID scheduledTransactionID = 11;
      Returns:
      The scheduledTransactionID.

    • getLedgerId

      com.google.protobuf.ByteString getLedgerId()
       *
 The ledger ID of the network that generated this response.
 <p>
 This value SHALL identify the distributed ledger that responded to
 this query.
      bytes ledger_id = 12;
      Returns:
      The ledgerId.

    • getWaitForExpiry

      boolean getWaitForExpiry()
       *
 A flag indicating this schedule will execute when it expires.
 <p>
 If this field is set
 <ul>
 <li>This schedule SHALL be considered a "long-term" schedule.</li>
 <li>This schedule SHALL be evaluated when the network consensus time
 reaches the `expirationTime`, and if the signature requirements
 for the scheduled transaction are met at that time, the
 scheduled transaction SHALL be executed.</li>
 <li>This schedule SHALL NOT be executed before the network consensus
 time reaches the `expirationTime`.</li>
 </ul>
 If this field is not set
 <ul>
 <li>This schedule SHALL be considered a "short-term" schedule.</li>
 <li>This schedule SHALL be evaluated when created, and reevaluated
 with each `signSchedule` transaction, and if the signature
 requirements for the scheduled transaction are met at that time,
 the scheduled transaction SHALL be executed immediately.</li>
 <li>This schedule SHALL be executed as soon as the signature
 requirements are met, and MUST be executed before the network
 consensus time reaches the `expirationTime`, if at all.</li>
 </ul>
      bool wait_for_expiry = 13;
      Returns:
      The waitForExpiry.

    • getDataCase

      ScheduleInfo.DataCase getDataCase()