Module com.hedera.hashgraph.sdk

Package com.hedera.hashgraph.sdk

Class FileDeleteTransaction

java.lang.Object

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

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

com.hedera.hashgraph.sdk.FileDeleteTransaction

public final class FileDeleteTransaction
extends Transaction<FileDeleteTransaction>

A transaction to delete a file on the Hedera network.

When deleted, a file's contents are truncated to zero length and it can no longer be updated or appended to, or its expiration time extended. FileContentsQuery and FileInfoQuery will throw PrecheckStatusException with a status of Status.FILE_DELETED.

Only one of the file's keys needs to sign to delete the file, unless the key you have is part of a KeyList.

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
FileDeleteTransaction()	Constructor.
FileDeleteTransaction(TransactionBody txBody)	Constructor.
FileDeleteTransaction(LinkedHashMap<TransactionId,LinkedHashMap<AccountId,Transaction>> txs)	Constructor.

Method Summary

Modifier and Type	Method	Description
(package private) FileDeleteTransactionBody.Builder	build()	Build the transaction body.
FileId	getFileId()	Extract the file id.
(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.
FileDeleteTransaction	setFileId(FileId fileId)	A file identifier. This identifies the file to delete.
(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

FileDeleteTransaction

public FileDeleteTransaction()

Constructor.

FileDeleteTransaction

FileDeleteTransaction(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

FileDeleteTransaction

FileDeleteTransaction(TransactionBody txBody)

Constructor.

Parameters:

txBody - protobuf TransactionBody

Method Details

getFileId

@Nullable
public FileId getFileId()

Extract the file id.

Returns:

the file id

setFileId

public FileDeleteTransaction setFileId(FileId fileId)

A file identifier.
This identifies the file to delete.

The identified file MUST NOT be a "system" file.
This field is REQUIRED.

Parameters:

fileId - the ID of the file to delete.

Returns:

this

initFromTransactionBody

void initFromTransactionBody()

Initialize from the transaction body.

build

FileDeleteTransactionBody.Builder build()

Build the transaction body.

Returns:

builder

validateChecksums

void validateChecksums(Client client)
                throws BadEntityIdException

Specified by:

validateChecksums in class Transaction<FileDeleteTransaction>

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<FileDeleteTransaction,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<FileDeleteTransaction>

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<FileDeleteTransaction>