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

Class ScheduleInfo

java.lang.Object
com.google.protobuf.AbstractMessageLite<ScheduleInfo,ScheduleInfo.Builder>
com.google.protobuf.GeneratedMessageLite<ScheduleInfo,ScheduleInfo.Builder>
com.hedera.hashgraph.sdk.proto.ScheduleInfo
All Implemented Interfaces:
com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, ScheduleInfoOrBuilder
@Generated public final class ScheduleInfo extends com.google.protobuf.GeneratedMessageLite<ScheduleInfo,ScheduleInfo.Builder> implements ScheduleInfoOrBuilder
 *
 Information summarizing schedule state
Protobuf type proto.ScheduleInfo

  • Field Details

    • SCHEDULEID_FIELD_NUMBER

      public static final int SCHEDULEID_FIELD_NUMBER
      See Also:

    • DELETION_TIME_FIELD_NUMBER

      public static final int DELETION_TIME_FIELD_NUMBER
      See Also:

    • EXECUTION_TIME_FIELD_NUMBER

      public static final int EXECUTION_TIME_FIELD_NUMBER
      See Also:

    • EXPIRATIONTIME_FIELD_NUMBER

      public static final int EXPIRATIONTIME_FIELD_NUMBER
      See Also:

    • SCHEDULEDTRANSACTIONBODY_FIELD_NUMBER

      public static final int SCHEDULEDTRANSACTIONBODY_FIELD_NUMBER
      See Also:

    • MEMO_FIELD_NUMBER

      public static final int MEMO_FIELD_NUMBER
      See Also:

    • ADMINKEY_FIELD_NUMBER

      public static final int ADMINKEY_FIELD_NUMBER
      See Also:

    • SIGNERS_FIELD_NUMBER

      public static final int SIGNERS_FIELD_NUMBER
      See Also:

    • CREATORACCOUNTID_FIELD_NUMBER

      public static final int CREATORACCOUNTID_FIELD_NUMBER
      See Also:

    • PAYERACCOUNTID_FIELD_NUMBER

      public static final int PAYERACCOUNTID_FIELD_NUMBER
      See Also:

    • SCHEDULEDTRANSACTIONID_FIELD_NUMBER

      public static final int SCHEDULEDTRANSACTIONID_FIELD_NUMBER
      See Also:

    • LEDGER_ID_FIELD_NUMBER

      public static final int LEDGER_ID_FIELD_NUMBER
      See Also:

    • WAIT_FOR_EXPIRY_FIELD_NUMBER

      public static final int WAIT_FOR_EXPIRY_FIELD_NUMBER
      See Also:

  • Method Details

    • getDataCase

      public ScheduleInfo.DataCase getDataCase()
      Specified by:
      getDataCase in interface ScheduleInfoOrBuilder

    • hasScheduleID

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

    • getScheduleID

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

    • hasDeletionTime

      public 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;
      Specified by:
      hasDeletionTime in interface ScheduleInfoOrBuilder
      Returns:
      Whether the deletionTime field is set.

    • getDeletionTime

      public 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;
      Specified by:
      getDeletionTime in interface ScheduleInfoOrBuilder
      Returns:
      The deletionTime.

    • hasExecutionTime

      public 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;
      Specified by:
      hasExecutionTime in interface ScheduleInfoOrBuilder
      Returns:
      Whether the executionTime field is set.

    • getExecutionTime

      public 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;
      Specified by:
      getExecutionTime in interface ScheduleInfoOrBuilder
      Returns:
      The executionTime.

    • hasExpirationTime

      public 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;
      Specified by:
      hasExpirationTime in interface ScheduleInfoOrBuilder
      Returns:
      Whether the expirationTime field is set.

    • getExpirationTime

      public 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;
      Specified by:
      getExpirationTime in interface ScheduleInfoOrBuilder
      Returns:
      The expirationTime.

    • hasScheduledTransactionBody

      public 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;
      Specified by:
      hasScheduledTransactionBody in interface ScheduleInfoOrBuilder
      Returns:
      Whether the scheduledTransactionBody field is set.

    • getScheduledTransactionBody

      public 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;
      Specified by:
      getScheduledTransactionBody in interface ScheduleInfoOrBuilder
      Returns:
      The scheduledTransactionBody.

    • getMemo

      public 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;
      Specified by:
      getMemo in interface ScheduleInfoOrBuilder
      Returns:
      The memo.

    • getMemoBytes

      public 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;
      Specified by:
      getMemoBytes in interface ScheduleInfoOrBuilder
      Returns:
      The bytes for memo.

    • hasAdminKey

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

    • getAdminKey

      public Key getAdminKey()
       *
 The key used to delete the schedule from state
      .proto.Key adminKey = 7;
      Specified by:
      getAdminKey in interface ScheduleInfoOrBuilder
      Returns:
      The adminKey.

    • hasSigners

      public 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;
      Specified by:
      hasSigners in interface ScheduleInfoOrBuilder
      Returns:
      Whether the signers field is set.

    • getSigners

      public 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;
      Specified by:
      getSigners in interface ScheduleInfoOrBuilder
      Returns:
      The signers.

    • hasCreatorAccountID

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

    • getCreatorAccountID

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

    • hasPayerAccountID

      public 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;
      Specified by:
      hasPayerAccountID in interface ScheduleInfoOrBuilder
      Returns:
      Whether the payerAccountID field is set.

    • getPayerAccountID

      public 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;
      Specified by:
      getPayerAccountID in interface ScheduleInfoOrBuilder
      Returns:
      The payerAccountID.

    • hasScheduledTransactionID

      public 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;
      Specified by:
      hasScheduledTransactionID in interface ScheduleInfoOrBuilder
      Returns:
      Whether the scheduledTransactionID field is set.

    • getScheduledTransactionID

      public 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;
      Specified by:
      getScheduledTransactionID in interface ScheduleInfoOrBuilder
      Returns:
      The scheduledTransactionID.

    • getLedgerId

      public 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;
      Specified by:
      getLedgerId in interface ScheduleInfoOrBuilder
      Returns:
      The ledgerId.

    • getWaitForExpiry

      public 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;
      Specified by:
      getWaitForExpiry in interface ScheduleInfoOrBuilder
      Returns:
      The waitForExpiry.

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilder

      public static ScheduleInfo.Builder newBuilder()

    • newBuilder

      public static ScheduleInfo.Builder newBuilder(ScheduleInfo 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<ScheduleInfo,ScheduleInfo.Builder>

    • getDefaultInstance

      public static ScheduleInfo getDefaultInstance()

    • parser

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