// 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;

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

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

    // The target is in an erroneous state.
    //
    // Targets are marked as erroneous when transfers to the desired destination fail
    // or when periodic checks of the destination don't succeed.
    ERROR = 1;

    // The status of the target is currently being evaluated.
    PENDING = 2;

    // The target is fully operational.
    //
    // Transfers may still fail if the destination doesn't have the necessary disk space
    // capacity for instance.
    OPERATIONAL = 3;
  }

  message FtpConfig {
    // The host of the FTP server.
    //
    // This may be a host name or IP address.
    string host = 1;

    // The port of the FTP server.
    int32 port = 2;

    // The username.
    string username = 3;

    // The password.
    //
    // Input only. This field is never exposed to a client.
    string password = 4;

    // Path at which to store files.
    //
    // [optional]
    string path = 5;
  }

  message SftpConfig {
    // The host of the SFTP server.
    //
    // This may be a host name or IP address.
    string host = 1;

    // The port of the SFTP server.
    int32 port = 2;

    // The username.
    string username = 3;

    // The password.
    //
    // Input only. This field is never exposed to a client.
    string password = 4;

    // Path at which to store files.
    //
    // [optional]
    string path = 5;
  }

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

  // The unique identifier of the owning team
  string team_id = 2;

  // The display name of the target.
  string display_name = 3;

  // Status of this target.
  //
  // Output only.
  Status status = 4;

  oneof config_type {
    // FTP configuration for this target.
    FtpConfig ftp = 5;
    // SFTP configuration for this target.
    SftpConfig sftp = 6;
  }
}