shgraph.hapi.0.54.0.source-code.file_get_contents.proto Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hapi Show documentation
Hedera API
The newest version!
syntax = "proto3";

package proto;

/*-
 * ‌
 * Hedera Network Services Protobuf
 * 
 * Copyright (C) 2018 - 2021 Hedera Hashgraph, LLC
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * ‍
 */

option java_package = "com.hederahashgraph.api.proto.java";
// <<>> This comment is special code for setting PBJ Compiler java package
option java_multiple_files = true;

import "basic_types.proto";
import "query_header.proto";
import "response_header.proto";

/**
 * Get the contents of a file. The content field is empty (no bytes) if the file is empty.
 */
message FileGetContentsQuery {
    /**
     * Standard info sent from client to node, including the signed payment, and what kind of
     * response is requested (cost, state proof, both, or neither).
     */
    QueryHeader header = 1;

    /**
     * The file ID of the file whose contents are requested
     */
    FileID fileID = 2;
}

/**
 * Response when the client sends the node FileGetContentsQuery
 */
message FileGetContentsResponse {
    /**
     * Standard response from node to client, including the requested fields: cost, or state proof,
     * or both, or neither
     */
    ResponseHeader header = 1;

    message FileContents {
        /**
         * The file ID of the file whose contents are being returned
         */
        FileID fileID = 1;

        /**
         * The bytes contained in the file
         */
        bytes contents = 2;
    }

    /**
     * the file ID and contents (a state proof can be generated for this)
     */
    FileContents fileContents = 2;
}