MFTTransferApi.proto

syntax = "proto3";

option java_multiple_files = true;
package org.apache.airavata.mft.api.service;

import "google/api/annotations.proto";
import "google/protobuf/empty.proto";
import "CredCommon.proto";

message CallbackEndpoint {
    enum CallbackType {
        HTTP = 0;
        KAFKA = 1;
    }
    CallbackType type = 1;
    string endpoint = 2;
}

message TransferApiRequest {
    string sourceResourceId = 1;
    string sourceChildResourcePath = 2;
    string sourceType = 3;
    string sourceToken = 4;
    string destinationResourceId = 5;
    string destinationChildResourcePath = 6;
    string destinationType = 7;
    string destinationToken = 8;
    bool affinityTransfer = 9;
    map<string, int32> targetAgents = 10;
    org.apache.airavata.mft.common.AuthToken mftAuthorizationToken = 11;
    repeated CallbackEndpoint callbackEndpoints = 12;
}

message TransferApiResponse {
    string transferId = 1;
}

message HttpUploadApiRequest {
    string destinationResourceId = 1;
    string destinationResourceChildPath = 2;
    string destinationToken = 3;
    string destinationType = 4;
    string targetAgent = 5;
    org.apache.airavata.mft.common.AuthToken mftAuthorizationToken = 6;
}

message HttpUploadApiResponse {
    string url = 1;
    string targetAgent = 2;
}

message HttpDownloadApiRequest {
    string sourceResourceId = 1;
    string sourceResourceChildPath = 2;
    string sourceToken = 3;
    string sourceType = 4;
    string targetAgent = 5;
    org.apache.airavata.mft.common.AuthToken mftAuthorizationToken = 6;
}

message HttpDownloadApiResponse {
    string url = 1;
    string targetAgent = 2;
}

message TransferStateApiRequest {
    string transferId = 1;
    org.apache.airavata.mft.common.AuthToken mftAuthorizationToken = 2;
}

message TransferStateApiResponse {
    string state = 1;
    int64 updateTimeMils = 2;
    double percentage = 3;
    string description = 4;
}

message ResourceAvailabilityRequest {
    string resourceId = 1;
    string childResourcePath = 2;
    string resourceType = 3;
    string resourceToken = 4;
    string resourceBackend = 5;
    string resourceCredentialBackend = 6;
    org.apache.airavata.mft.common.AuthToken mftAuthorizationToken = 7;
}

message ResourceAvailabilityResponse {
    bool available = 1;
}

message FileMetadataResponse {
    string friendlyName = 1;
    int64 resourceSize = 2;
    int64 createdTime = 3;
    int64 updateTime = 4;
    string md5sum = 5;
    string resourcePath = 6;
    string parentResourceId = 7;
    string parentResourceType = 8;
}

message DirectoryMetadataResponse {
    string friendlyName = 1;
    int64 createdTime = 2;
    int64 updateTime = 3;
    string resourcePath = 4;
    string parentResourceId = 5;
    string parentResourceType = 6;
    repeated DirectoryMetadataResponse directories = 7;
    repeated FileMetadataResponse files = 8;
    bool lazyInitialized = 9;
}

message FetchResourceMetadataRequest {
    string resourceId = 1;
    string childResourcePath = 2;
    string resourceType = 3;
    string resourceToken = 4;
    string resourceBackend = 5;
    string resourceCredentialBackend = 6;
    string targetAgentId = 7;
    string childPath = 8; // if the child entities of the parent resource are required, set this field
    org.apache.airavata.mft.common.AuthToken mftAuthorizationToken = 9;
}

service  MFTTransferService {

    rpc submitTransfer(TransferApiRequest) returns (TransferApiResponse) {
        option (google.api.http) = {
           post: "/v1.0/api/transfer"
        };
    }

    rpc submitHttpUpload(HttpUploadApiRequest) returns (HttpUploadApiResponse) {
        option (google.api.http) = {
           post: "/v1.0/api/http-upload"
        };
    }

    rpc submitHttpDownload(HttpDownloadApiRequest) returns (HttpDownloadApiResponse) {
        option (google.api.http) = {
           post: "/v1.0/api/http-download"
        };
    }

    rpc getTransferStates(TransferStateApiRequest) returns (stream TransferStateApiResponse) {
        option (google.api.http) = {
           get: "/v1.0/api/transfer/states"
        };
    }

    rpc getTransferState(TransferStateApiRequest) returns (TransferStateApiResponse) {
        option (google.api.http) = {
           get: "/v1.0/api/transfer/state"
        };
    }

    rpc getResourceAvailability(ResourceAvailabilityRequest) returns (ResourceAvailabilityResponse) {}

    rpc getFileResourceMetadata(FetchResourceMetadataRequest) returns (FileMetadataResponse) {
        option (google.api.http) = {
           get: "/v1.0/api/resource/metadata/file"
        };
    }

    rpc getDirectoryResourceMetadata(FetchResourceMetadataRequest) returns (DirectoryMetadataResponse) {
        option (google.api.http) = {
           get: "/v1.0/api/resource/metadata/directory"
        };
    }
}