Service doublecloud.transfer.v1.TransferService

Create

Request

Field

Description

source_id

string

target_id

string

description

string

project_id

string

runtime

doublecloud.transfer.v1.Runtime

type

doublecloud.transfer.v1.TransferType

name

string

labels

list

labels[]

doublecloud.transfer.v1.CreateTransferRequest.LabelsEntry

regular_snapshot

doublecloud.transfer.v1.RegularSnapshot

transformation

doublecloud.transfer.v1.Transformation

data_objects

doublecloud.transfer.v1.DataObjects

Response

Field

Description

id

string ID of the operation.

project_id

string ID of the project where operation performed.

description

string Description of the operation.

created_by

string ID of the user or service account who initiated the operation.

metadata

list Operation metadata (e.g. cluster_id for create cluster operation).

metadata[]

doublecloud.v1.Operation.MetadataEntry

create_time

google.protobuf.Timestamp The time when the operation was created.

start_time

google.protobuf.Timestamp The time when the operation was started.

finish_time

google.protobuf.Timestamp The time when the operation was finished.

status

doublecloud.v1.Operation.Status The status of the operation.

error

google.rpc.Status The error result of the operation in case of failure or cancellation.

resource_id

string ID of the resource operation performed on.

Update

Request

Field

Description

transfer_id

string Identifier of the transfer to be updated.

description

string The new description for the transfer.

runtime

doublecloud.transfer.v1.Runtime

name

string The new transfer name. Must be unique within the folder.

labels

list

labels[]

doublecloud.transfer.v1.UpdateTransferRequest.LabelsEntry

regular_snapshot

doublecloud.transfer.v1.RegularSnapshot

transformation

doublecloud.transfer.v1.Transformation

data_objects

doublecloud.transfer.v1.DataObjects

Response

Field

Description

id

string ID of the operation.

project_id

string ID of the project where operation performed.

description

string Description of the operation.

created_by

string ID of the user or service account who initiated the operation.

metadata

list Operation metadata (e.g. cluster_id for create cluster operation).

metadata[]

doublecloud.v1.Operation.MetadataEntry

create_time

google.protobuf.Timestamp The time when the operation was created.

start_time

google.protobuf.Timestamp The time when the operation was started.

finish_time

google.protobuf.Timestamp The time when the operation was finished.

status

doublecloud.v1.Operation.Status The status of the operation.

error

google.rpc.Status The error result of the operation in case of failure or cancellation.

resource_id

string ID of the resource operation performed on.

Delete

Request

Field

Description

transfer_id

string

Response

Field

Description

id

string ID of the operation.

project_id

string ID of the project where operation performed.

description

string Description of the operation.

created_by

string ID of the user or service account who initiated the operation.

metadata

list Operation metadata (e.g. cluster_id for create cluster operation).

metadata[]

doublecloud.v1.Operation.MetadataEntry

create_time

google.protobuf.Timestamp The time when the operation was created.

start_time

google.protobuf.Timestamp The time when the operation was started.

finish_time

google.protobuf.Timestamp The time when the operation was finished.

status

doublecloud.v1.Operation.Status The status of the operation.

error

google.rpc.Status The error result of the operation in case of failure or cancellation.

resource_id

string ID of the resource operation performed on.

List

Request

Field

Description

project_id

string Identifier of the folder containing the transfers to be listed.

page

doublecloud.v1.Paging The maximum number of transfers to be sent in the response message. If the folder contains more transfers than page_size, next_page_token will be included in the response message. Include it into the subsequent ListTransfersRequest to fetch the next page. Defaults to 100 if not specified. The maximum allowed value for this field is 500.

Response

Field

Description

transfers

list The list of transfers. If there are more transfers in the folder, then next_page_token is a non-empty string to be included into the subsequent ListTransfersRequest to fetch the next transfers page.

transfers[]

doublecloud.transfer.v1.Transfer

next_page_token

string Opaque value identifying the next transfers page. This field is empty if there are no more transfers in the folder. Otherwise it is non-empty and should be included in the subsequent ListTransfersRequest to fetch the next transfers page.

Get

Request

Field

Description

transfer_id

string

Response

Field

Description

id

string

project_id

string

name

string

description

string

labels

list

labels[]

doublecloud.transfer.v1.Transfer.LabelsEntry

source

doublecloud.transfer.v1.Endpoint

target

doublecloud.transfer.v1.Endpoint

runtime

doublecloud.transfer.v1.Runtime

status

doublecloud.transfer.v1.TransferStatus

type

doublecloud.transfer.v1.TransferType

warning

string

regular_snapshot

doublecloud.transfer.v1.RegularSnapshot

transformation

doublecloud.transfer.v1.Transformation

data_objects

doublecloud.transfer.v1.DataObjects

Deactivate

Request

Field

Description

transfer_id

string

Response

Field

Description

id

string ID of the operation.

project_id

string ID of the project where operation performed.

description

string Description of the operation.

created_by

string ID of the user or service account who initiated the operation.

metadata

list Operation metadata (e.g. cluster_id for create cluster operation).

metadata[]

doublecloud.v1.Operation.MetadataEntry

create_time

google.protobuf.Timestamp The time when the operation was created.

start_time

google.protobuf.Timestamp The time when the operation was started.

finish_time

google.protobuf.Timestamp The time when the operation was finished.

status

doublecloud.v1.Operation.Status The status of the operation.

error

google.rpc.Status The error result of the operation in case of failure or cancellation.

resource_id

string ID of the resource operation performed on.

Activate

Request

Field

Description

transfer_id

string

Response

Field

Description

id

string ID of the operation.

project_id

string ID of the project where operation performed.

description

string Description of the operation.

created_by

string ID of the user or service account who initiated the operation.

metadata

list Operation metadata (e.g. cluster_id for create cluster operation).

metadata[]

doublecloud.v1.Operation.MetadataEntry

create_time

google.protobuf.Timestamp The time when the operation was created.

start_time

google.protobuf.Timestamp The time when the operation was started.

finish_time

google.protobuf.Timestamp The time when the operation was finished.

status

doublecloud.v1.Operation.Status The status of the operation.

error

google.rpc.Status The error result of the operation in case of failure or cancellation.

resource_id

string ID of the resource operation performed on.

GetMetrics

Allows scraping of metrics by a prometheus scraper

Request

Field

Description

transfer_id

string The ID of Transfer

Response

Field

Description

metrics

list The list of the transfer metrics

metrics[]

doublecloud.transfer.v1.TransferMetrics.Metric

GetMetricExporterConnectionInfo

Request

Field

Description

transfer_id

string The ID of the Transfer

Response

Field

Description

connection_string

string String to use in clients. i.e. url for config

user

string User for HTTP basic auth.

password

string Password for HTTP basic auth.

DeleteMetricExporterConnectionInfo

Request

Field

Description

transfer_id

string The ID of the Transfer

Response

Field

Description

id

string ID of the operation.

project_id

string ID of the project where operation performed.

description

string Description of the operation.

created_by

string ID of the user or service account who initiated the operation.

metadata

list Operation metadata (e.g. cluster_id for create cluster operation).

metadata[]

doublecloud.v1.Operation.MetadataEntry

create_time

google.protobuf.Timestamp The time when the operation was created.

start_time

google.protobuf.Timestamp The time when the operation was started.

finish_time

google.protobuf.Timestamp The time when the operation was finished.

status

doublecloud.v1.Operation.Status The status of the operation.

error

google.rpc.Status The error result of the operation in case of failure or cancellation.

resource_id

string ID of the resource operation performed on.