Module com.hedera.hashgraph.sdk

Package com.hedera.hashgraph.sdk

Class FileUpdateTransaction

java.lang.Object

com.hedera.hashgraph.sdk.Executable<FileUpdateTransaction,Transaction,TransactionResponse,TransactionResponse>

com.hedera.hashgraph.sdk.Transaction<FileUpdateTransaction>

com.hedera.hashgraph.sdk.FileUpdateTransaction

public final class FileUpdateTransaction
extends Transaction<FileUpdateTransaction>

Update the metadata, and/or replace the content, of a file in the Hedera File Service (HFS). Any field which is not set (i.e. is null) in this message, other than `fileID`, SHALL be ignored.
If the `keys` list for the identified file is an empty `KeyList`, then this message MUST NOT set any field except `expirationTime`. #### Signature Requirements Every `Key` in the `keys` list for the identified file MUST sign this transaction, if any field other than `expirationTime` is to be updated.
If the `keys` list for the identified file is an empty `KeyList` (because this file was previously created or updated to have an empty `KeyList`), then the file is considered immutable and this message MUST NOT set any field except `expirationTime`.
See the [File Service](#FileService) specification for a detailed explanation of the signature requirements for all file transactions. ### Block Stream Effects None See Hedera Documentation

Nested Class Summary

Nested classes/interfaces inherited from class com.hedera.hashgraph.sdk.Transaction

Transaction.SignableNodeTransactionBodyBytes

Nested classes/interfaces inherited from class com.hedera.hashgraph.sdk.Executable

Executable.GrpcRequest

Field Summary

Fields inherited from class com.hedera.hashgraph.sdk.Transaction

customFeeLimits, DEFAULT_AUTO_RENEW_PERIOD, defaultMaxTransactionFee, DUMMY_ACCOUNT_ID, DUMMY_TRANSACTION_ID, frozenBodyBuilder, innerSignedTransactions, outerTransactions, publicKeys, regenerateTransactionId, signers, sigPairLists, sourceTransactionBody, transactionIds

Fields inherited from class com.hedera.hashgraph.sdk.Executable

attemptedAllNodes, blockingUnaryCall, grpcDeadline, logger, maxAttempts, maxBackoff, minBackoff, nodeAccountIds, nodes, random, RST_STREAM

Constructor Summary

Constructors

Constructor	Description
FileUpdateTransaction()	Constructor.
FileUpdateTransaction(TransactionBody txBody)	Constructor.
FileUpdateTransaction(LinkedHashMap<TransactionId,LinkedHashMap<AccountId,Transaction>> txs)	Constructor.

Method Summary

Modifier and Type	Method	Description
(package private) FileUpdateTransactionBody.Builder	build()	Build the correct transaction body.
FileUpdateTransaction	clearMemo()	Remove the file memo.
com.google.protobuf.ByteString	getContents()	Extract the files contents as a byte string.
Instant	getExpirationTime()	Extract the expiration time.
FileId	getFileId()	Extract the file id.
String	getFileMemo()	Extract the file's memo up to 100 bytes.
Collection<Key>	getKeys()	Get the keys which must sign any transactions modifying this file.
(package private) io.grpc.MethodDescriptor<Transaction,TransactionResponse>	getMethodDescriptor()	Called to direct the invocation of the query to the appropriate gRPC service.
(package private) void	initFromTransactionBody()	Initialize from the transaction body.
(package private) void	onFreeze(TransactionBody.Builder bodyBuilder)	Called in Transaction.freezeWith(Client) just before the transaction body is built.
(package private) void	onScheduled(SchedulableTransactionBody.Builder scheduled)	Called in Transaction.schedule() when converting transaction into a scheduled version.
FileUpdateTransaction	setContents(byte[] bytes)	If set, replace contents of the file identified by setFileId(FileId) with the given bytes.
FileUpdateTransaction	setContents(String text)	If set, encode the given String as UTF-8 and replace the contents of the file identified by setFileId(FileId).
FileUpdateTransaction	setExpirationTime(Duration expirationTime)
FileUpdateTransaction	setExpirationTime(Instant expirationTime)	An expiration timestamp.
FileUpdateTransaction	setFileId(FileId fileId)	Set the ID of the file to update; required.
FileUpdateTransaction	setFileMemo(String memo)	A short description of this file.
FileUpdateTransaction	setKeys(Key... keys)	The new list of keys that "own" this file.
(package private) void	validateChecksums(Client client)

Methods inherited from class com.hedera.hashgraph.sdk.Transaction

addSignature, addSignature, batchify, buildAllTransactions, buildTransaction, doSchedule, estimateFee, freeze, freezeWith, fromBytes, fromScheduledTransaction, generateTransactionIds, getBatchKey, getDefaultMaxTransactionFee, getExecutionState, getHighVolume, getMaxTransactionFee, getRegenerateTransactionId, getRequiredChunks, getSignableNodeBodyBytesList, getSignatures, getSignaturesAtOffset, getTransactionBodySize, getTransactionHash, getTransactionHashPerNode, getTransactionId, getTransactionIdInternal, getTransactionMemo, getTransactionSize, getTransactionValidDuration, hash, isBatchedAndNotBatchTransaction, isFrozen, keyAlreadySigned, makeRequest, mapResponse, mapResponseStatus, onExecute, onExecuteAsync, regenerateTransactionId, requireNotFrozen, requireOneNodeAccountId, schedule, setBatchKey, setHighVolume, setMaxTransactionFee, setNodeAccountIds, setRegenerateTransactionId, setTransactionId, setTransactionMemo, setTransactionValidDuration, sign, signTransaction, signWith, signWithOperator, spawnBodyBuilder, toBytes, toString, wipeTransactionLists

Methods inherited from class com.hedera.hashgraph.sdk.Executable

advanceRequest, checkNodeAccountIds, execute, execute, executeAsync, executeAsync, executeAsync, executeAsync, executeAsync, executeAsync, getGrpcRequest, getMaxAttempts, getMaxBackoff, getMaxRetry, getMinBackoff, getNodeAccountIds, getNodeForExecute, grpcDeadline, logTransaction, mergeFromClient, setGrpcDeadline, setLogger, setMaxAttempts, setMaxBackoff, setMaxRetry, setMinBackoff, setNodesFromNodeAccountIds, setRequestListener, setResponseListener, shouldRetryExceptionally

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

FileUpdateTransaction

public FileUpdateTransaction()

Constructor.

FileUpdateTransaction

FileUpdateTransaction(LinkedHashMap<TransactionId,LinkedHashMap<AccountId,Transaction>> txs)
               throws com.google.protobuf.InvalidProtocolBufferException

Constructor.

Parameters:

txs - Compound list of transaction id's list of (AccountId, Transaction) records

Throws:

com.google.protobuf.InvalidProtocolBufferException - when there is an issue with the protobuf

FileUpdateTransaction

FileUpdateTransaction(TransactionBody txBody)

Constructor.

Parameters:

txBody - protobuf TransactionBody

Method Details

getFileId

@Nullable
public FileId getFileId()

Extract the file id.

Returns:

the file id

setFileId

public FileUpdateTransaction setFileId(FileId fileId)

Set the ID of the file to update; required.

Parameters:

fileId - the ID of the file to update.

Returns:

this

getKeys

@Nullable
public Collection<Key> getKeys()

Get the keys which must sign any transactions modifying this file.

Returns:

the list of keys

setKeys

public FileUpdateTransaction setKeys(Key... keys)

The new list of keys that "own" this file.

If set, every key in this `KeyList` MUST sign this transaction.
If set, every key in the _previous_ `KeyList` MUST _also_ sign this transaction.
If this value is an empty `KeyList`, then the file SHALL be immutable after completion of this transaction.

Parameters:

keys - The Key or Keys to be set

Returns:

this

getExpirationTime

@Nullable
public Instant getExpirationTime()

Extract the expiration time.

Returns:

the expiration time

setExpirationTime

public FileUpdateTransaction setExpirationTime(Instant expirationTime)

An expiration timestamp.

If set, this value MUST be strictly later than the existing `expirationTime` value, or else it will be ignored.
If set, this value SHALL replace the existing `expirationTime`.
If this field is the only field set, then this transaction SHALL NOT require any signature other than the `payer` for the transaction.
When the network consensus time exceeds the then-current `expirationTime`, the network SHALL expire the file.

Parameters:

expirationTime - the new Instant at which the transaction will expire.

Returns:

this

setExpirationTime

public FileUpdateTransaction setExpirationTime(Duration expirationTime)

getContents

public com.google.protobuf.ByteString getContents()

Extract the files contents as a byte string.

Returns:

the files contents as a byte string

setContents

public FileUpdateTransaction setContents(byte[] bytes)

If set, replace contents of the file identified by setFileId(FileId) with the given bytes.

If the contents of the file are longer than the given byte array, then the file will be truncated.

Note that total size for a given transaction is limited to 6KiB (as of March 2020) by the network; if you exceed this you may receive a Status.TRANSACTION_OVERSIZE.

In this case, you will need to keep the initial file contents under ~6KiB and then use FileAppendTransaction, which automatically breaks the contents into chunks for you, to append contents of arbitrary size.

Parameters:

bytes - the bytes to replace the contents of the file with.

Returns:

this

See Also:

• for an overload which takes a String.
• if you merely want to add data to a file's existing contents.

setContents

public FileUpdateTransaction setContents(String text)

If set, encode the given String as UTF-8 and replace the contents of the file identified by setFileId(FileId).

If the contents of the file are longer than the UTF-8 encoding of the given string, then the file will be truncated.

The string can later be recovered from Executable.execute(Client) via String(byte[], java.nio.charset.Charset) using StandardCharsets.UTF_8.

Note that total size for a given transaction is limited to 6KiB (as of March 2020) by the network; if you exceed this you may receive a Status.TRANSACTION_OVERSIZE.

In this case, you will need to keep the initial file contents under ~6KiB and then use FileAppendTransaction, which automatically breaks the contents into chunks for you, to append contents of arbitrary size.

Parameters:

text - the string to replace the contents of the file with.

Returns:

this

See Also:

• for replacing the contents with arbitrary data.
• if you merely want to add data to a file's existing contents.

getFileMemo

@Nullable
public String getFileMemo()

Extract the file's memo up to 100 bytes.

Returns:

the file's memo up to 100 bytes

setFileMemo

public FileUpdateTransaction setFileMemo(String memo)

A short description of this file.

This value, if set, MUST NOT exceed `transaction.maxMemoUtf8Bytes` (default 100) bytes when encoded as UTF-8.

Parameters:

memo - the file's memo

Returns:

this

clearMemo

public FileUpdateTransaction clearMemo()

Remove the file memo.

Returns:

this

initFromTransactionBody

void initFromTransactionBody()

Initialize from the transaction body.

build

FileUpdateTransactionBody.Builder build()

Build the correct transaction body.

Returns:

builder

validateChecksums

void validateChecksums(Client client)
                throws BadEntityIdException

Specified by:

validateChecksums in class Transaction<FileUpdateTransaction>

Throws:

BadEntityIdException

getMethodDescriptor

io.grpc.MethodDescriptor<Transaction,TransactionResponse> getMethodDescriptor()

Description copied from class: Executable

Called to direct the invocation of the query to the appropriate gRPC service.

Specified by:

getMethodDescriptor in class Executable<FileUpdateTransaction,Transaction,TransactionResponse,TransactionResponse>

onFreeze

void onFreeze(TransactionBody.Builder bodyBuilder)

Description copied from class: Transaction

Called in Transaction.freezeWith(Client) just before the transaction body is built. The intent is for the derived class to assign their data variant to the transaction body.

Specified by:

onFreeze in class Transaction<FileUpdateTransaction>

onScheduled

void onScheduled(SchedulableTransactionBody.Builder scheduled)

Description copied from class: Transaction

Called in Transaction.schedule() when converting transaction into a scheduled version.

Specified by:

onScheduled in class Transaction<FileUpdateTransaction>