ydb_replication.proto

syntax = "proto3";
option cc_enable_arenas = true;

import "src/api/protos/annotations/validation.proto";
import "src/api/protos/ydb_issue_message.proto";
import "src/api/protos/ydb_operation.proto";
import "src/api/protos/ydb_scheme.proto";

import "google/protobuf/duration.proto";

package Ydb.Replication;
option java_package = "com.yandex.ydb.replication";

message DescribeReplicationRequest {
    Ydb.Operations.OperationParams operation_params = 1;
    // Replication path.
    string path = 2 [(required) = true];
    // Include statistics.
    bool include_stats = 3;
}

message DescribeReplicationResponse {
    // Result of request will be inside operation.
    Ydb.Operations.Operation operation = 1;
}

message ConnectionParams {
    message StaticCredentials {
        string user = 1;
        string password_secret_name = 2;
    }

    message OAuth {
        string token_secret_name = 1;
    }

    string endpoint = 1;
    string database = 2;
    bool enable_ssl = 5;
    string connection_string = 6;

    oneof credentials {
        StaticCredentials static_credentials = 3;
        OAuth oauth = 4;
    }
}

message ConsistencyLevelRow {
}

message ConsistencyLevelGlobal {
    google.protobuf.Duration commit_interval = 1;
}

message DescribeReplicationResult {
    message Stats {
        optional google.protobuf.Duration lag = 1;
        optional float initial_scan_progress = 2;
    }

    message Item {
        string source_path = 1;
        string destination_path = 2;
        optional string source_changefeed_name = 3;
        uint64 id = 4;
        Stats stats = 5;
    }

    message RunningState {
        Stats stats = 1;
    }

    message ErrorState {
        repeated Ydb.Issue.IssueMessage issues = 1;
    }

    message DoneState {
    }

    message PausedState {
    }

    // Description of scheme object.
    Ydb.Scheme.Entry self = 1;

    ConnectionParams connection_params = 2;
    oneof consistency_level {
        ConsistencyLevelRow row_consistency = 7;
        ConsistencyLevelGlobal global_consistency = 8;
    }
    repeated Item items = 3;
    oneof state {
        RunningState running = 4;
        ErrorState error = 5;
        DoneState done = 6;
        PausedState paused = 9;
    }
}