Module com.hedera.hashgraph.sdk

Package com.hedera.hashgraph.sdk

Class FileContentsQuery

java.lang.Object

com.hedera.hashgraph.sdk.Executable<FileContentsQuery,Query,Response,com.google.protobuf.ByteString>

com.hedera.hashgraph.sdk.Query<com.google.protobuf.ByteString,FileContentsQuery>

com.hedera.hashgraph.sdk.FileContentsQuery

public final class FileContentsQuery
extends Query<com.google.protobuf.ByteString,FileContentsQuery>

Get the contents of a file. The content field is empty (no bytes) if the file is empty. A query to get the contents of a file. Queries do not change the state of the file or require network consensus. The information is returned from a single node processing the query. See Hedera Documentation

Nested Class Summary

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

Executable.GrpcRequest

Field Summary

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

paymentTransactionId, paymentTransactions

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
FileContentsQuery()	Constructor.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Hbar>	getCostAsync(Client client)	Fetch the expected cost asynchronously.
FileId	getFileId()	Extract the file id.
(package private) io.grpc.MethodDescriptor<Query,Response>	getMethodDescriptor()	Called to direct the invocation of the query to the appropriate gRPC service.
(package private) QueryHeader	mapRequestHeader(Query request)	The derived class should access its request header and return.
(package private) com.google.protobuf.ByteString	mapResponse(Response response, AccountId nodeId, Query request)	Called after receiving the query response from Hedera.
(package private) ResponseHeader	mapResponseHeader(Response response)	The derived class should access its response header and return.
(package private) void	onMakeRequest(Query.Builder queryBuilder, QueryHeader header)	Called in Query.makeRequest() just before the query is built.
FileContentsQuery	setFileId(FileId fileId)	Sets the file ID of the file whose contents are requested.
(package private) void	validateChecksums(Client client)	Validate the checksums.

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

getCost, getCost, getCostAsync, getCostAsync, getCostAsync, getCostAsync, getCostAsync, getOperatorFromClient, getPaymentTransaction, getPaymentTransactionId, getTransactionIdInternal, isPaymentRequired, makeRequest, mapResponseStatus, onExecute, onExecuteAsync, setMaxQueryPayment, setPaymentTransactionId, setQueryPayment, toString

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

FileContentsQuery

public FileContentsQuery()

Constructor.

Method Details

getFileId

@Nullable
public FileId getFileId()

Extract the file id.

Returns:

the file id

setFileId

public FileContentsQuery setFileId(FileId fileId)

Sets the file ID of the file whose contents are requested.

Parameters:

fileId - The FileId to be set

Returns:

this

getCostAsync

public CompletableFuture<Hbar> getCostAsync(Client client)

Description copied from class: Query

Fetch the expected cost asynchronously.

Overrides:

getCostAsync in class Query<com.google.protobuf.ByteString,FileContentsQuery>

Parameters:

client - the client

Returns:

Future result of the cost in hbar

validateChecksums

void validateChecksums(Client client)
                throws BadEntityIdException

Description copied from class: Query

Validate the checksums.

Specified by:

validateChecksums in class Query<com.google.protobuf.ByteString,FileContentsQuery>

Throws:

BadEntityIdException

onMakeRequest

void onMakeRequest(Query.Builder queryBuilder,
 QueryHeader header)

Description copied from class: Query

Called in Query.makeRequest() just before the query is built. The intent is for the derived class to assign their data variant to the query.

Specified by:

onMakeRequest in class Query<com.google.protobuf.ByteString,FileContentsQuery>

mapResponseHeader

ResponseHeader mapResponseHeader(Response response)

Description copied from class: Query

The derived class should access its response header and return.

Specified by:

mapResponseHeader in class Query<com.google.protobuf.ByteString,FileContentsQuery>

mapRequestHeader

QueryHeader mapRequestHeader(Query request)

Description copied from class: Query

The derived class should access its request header and return.

Specified by:

mapRequestHeader in class Query<com.google.protobuf.ByteString,FileContentsQuery>

mapResponse

com.google.protobuf.ByteString mapResponse(Response response,
 AccountId nodeId,
 Query request)

Description copied from class: Executable

Called after receiving the query response from Hedera. The derived class should map into its output type.

Specified by:

mapResponse in class Executable<FileContentsQuery,Query,Response,com.google.protobuf.ByteString>

getMethodDescriptor

io.grpc.MethodDescriptor<Query,Response> 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<FileContentsQuery,Query,Response,com.google.protobuf.ByteString>