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

Interface FileOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.ByteString
    getContents()
    * The contents of the file.
    boolean
    getDeleted()
    * A flag indicating that this file is deleted.
    long
    getExpirationSecond()
    * The file's expiration time in seconds since the epoch.<br/> This value should be compared against consensus time, which may not exactly match clock time at the moment of expiration.
    FileID
    getFileId()
    * This file's ID within the global network state.
    KeyList
    getKeys()
    * A list of keys that MUST sign any transaction to create or update this file.
    String
    getMemo()
    * A short description of the file.
    com.google.protobuf.ByteString
    getMemoBytes()
    * A short description of the file.
    long
    getPreSystemDeleteExpirationSecond()
    * The pre-system-delete expiration time of a deleted "system" file, in seconds.
    boolean
    hasFileId()
    * This file's ID within the global network state.
    boolean
    hasKeys()
    * A list of keys that MUST sign any transaction to create or update this file.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • hasFileId

      boolean hasFileId()
       *
 This file's ID within the global network state.
 <p>
 This value SHALL be unique within the network.
      .proto.FileID file_id = 1;
      Returns:
      Whether the fileId field is set.

    • getFileId

      FileID getFileId()
       *
 This file's ID within the global network state.
 <p>
 This value SHALL be unique within the network.
      .proto.FileID file_id = 1;
      Returns:
      The fileId.

    • getExpirationSecond

      long getExpirationSecond()
       *
 The file's expiration time in seconds since the epoch.<br/>
 This value should be compared against consensus time, which may not
 exactly match clock time at the moment of expiration.
 <p>
 For this purpose, `epoch` SHALL be the UNIX epoch with 0 at `1970-01-01T00:00:00.000Z`.
      int64 expiration_second = 2;
      Returns:
      The expirationSecond.

    • hasKeys

      boolean hasKeys()
       *
 A list of keys that MUST sign any transaction to create
 or update this file.
 <p>
 Only _one_ of these keys must sign a transaction to delete the file.<br/>
 This field MAY be `null` or an empty list.<br/>
 If this field is null or an empty `KeyList`, then the file SHALL be
 immutable.<br/>
 For an immutable file, the only transaction permitted to modify that
 file SHALL be a `fileUpdate` transaction with _only_ the
 `expirationTime` set.
      .proto.KeyList keys = 3;
      Returns:
      Whether the keys field is set.

    • getKeys

      KeyList getKeys()
       *
 A list of keys that MUST sign any transaction to create
 or update this file.
 <p>
 Only _one_ of these keys must sign a transaction to delete the file.<br/>
 This field MAY be `null` or an empty list.<br/>
 If this field is null or an empty `KeyList`, then the file SHALL be
 immutable.<br/>
 For an immutable file, the only transaction permitted to modify that
 file SHALL be a `fileUpdate` transaction with _only_ the
 `expirationTime` set.
      .proto.KeyList keys = 3;
      Returns:
      The keys.

    • getContents

      com.google.protobuf.ByteString getContents()
       *
 The contents of the file.
 <p>
 This SHALL be limited to the current maximum file size; typically no
 more than 1 Megabyte (1048576 bytes).
      bytes contents = 4;
      Returns:
      The contents.

    • getMemo

      String getMemo()
       *
 A short description of the file.
 <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 of the file.
 <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.

    • getDeleted

      boolean getDeleted()
       *
 A flag indicating that this file is deleted.
 <p>
 The `contents` of a deleted "regular" file SHALL be an empty
 (zero length) bytes.
      bool deleted = 6;
      Returns:
      The deleted.

    • getPreSystemDeleteExpirationSecond

      long getPreSystemDeleteExpirationSecond()
       *
 The pre-system-delete expiration time of a deleted "system" file, in seconds.
 <p>
 This field SHALL contain the original expiration time of a "system" file
 that is deleted. This SHOULD be used to restore that expiration time if
 the file is subsequently "un-deleted" before it is purged from the
 system.<br/>
 A "regular" file cannot be "un-deleted", so this field SHALL NOT be set
 for those files.
      int64 pre_system_delete_expiration_second = 7;
      Returns:
      The preSystemDeleteExpirationSecond.