// Copyright 2022 LTN Global Communications, Inc.
//
// 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.

syntax = "proto3";

package tv.make.api;

import "transfertarget/transfertarget.proto";

import "google/protobuf/timestamp.proto";

option go_package = "git.ltnglobal.com/make.tv/genproto/api;api";

message Transfer {
  enum Status {
    // The status of the transfer is not specified.
    STATUS_UNSPECIFIED = 0;

    // Transfer did not complete due to an error.
    ERROR = 1;

    // The asset is actively being transferred.
    ACTIVE = 2;

    // Transfer is currently queued and will be started at a later time.
    QUEUED = 3;

    // Transfer completed successfully.
    COMPLETED = 4;
  }

  // The unique identifier of the transfer.
  string id = 1;

  // The name of the transferred file.
  //
  // Output only.
  string file_name = 2;

  // The asset that's being transferred.
  string asset_id = 3;

  // Start time within the asset in seconds.
  int32 start_time_seconds = 4;

  // End time within the asset in seconds.
  int32 end_time_seconds = 5;

  // The transfer target at the time of creation of this transfer.
  TransferTarget transfer_target = 6;

  // When has this transfer been created.
  //
  // Output only.
  google.protobuf.Timestamp create_time = 7;

  // When has this transfer been completed.
  //
  // Output only.
  google.protobuf.Timestamp complete_time = 8;

  // The status of this transfer.
  //
  // Output only.
  Status status = 9;

  // Additional status information that describes the current progress or error reason.
  //
  // - Errors contain "type:message".
  // - Progress is reported via "n% completed".
  //
  // Output only.
  string status_message = 10;
}