Retrieving the Data Source
This data source can be retrieved by one of ID or name.Retrieve by ID
To retrieve by ID, fill in only theid field:
Retrieve by Name
To retrieve by name, fill in only thename and parent_id fields:
Schema
Optional
id(String) Identifier for the resource, unique for its resource type.name(String) Human readable name for the resource.parent_id(String) Identifier of the parent resource to which the resource belongs.
Read-Only
-
after_n_empty_iterations(Attributes) Cannot be set alongside after_one_iteration or infinite. (see below for nested schema) -
after_one_iteration(Attributes) Cannot be set alongside after_n_empty_iterations or infinite. (see below for nested schema) -
created_at(String) : Timestamp indicating when the resource was created. A string representing a timestamp in ISO 8601 format:YYYY-MM-DDTHH:MM:SSZorYYYY-MM-DDTHH:MM:SS.SSS±HH:MM -
destination(Attributes) (see below for nested schema) -
infinite(Attributes) : Infinite transfers do not stop automatically and can be stopped manually by the user. Cannot be set alongside after_one_iteration or after_n_empty_iterations. (see below for nested schema) -
inter_iteration_interval(String) : Time to wait between transfer iterations. Default is 15 minutes if not specified. Duration as a string: possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as300ms,-1.5hor2h45m. Valid time units arens,us(orµs),ms,s,m,h,d. -
labels(Map of String) : Labels associated with the resource. -
metadata(Attributes) :Inner value description
Common resource metadata. (see below for nested schema) -
overwrite_strategy(String) : Overwrite strategy set logic of overwrite already existed objects in destination bucket.Supported values
Possible values:-
OVERWRITE_STRATEGY_UNSPECIFIED -
NEVER: Never overwrite objects that exist in the destination. If object exists in destination bucket, skip it. Safest option to prevent data loss. -
IF_NEWER: Overwrite only if source object is newer than destination. Comparison based on Last-Modified timestamp. Recommended for incremental sync scenarios. -
ALWAYS: Always overwrite destination objects unconditionally. Use with caution - may cause data loss in destination. Suitable for full bucket synchronization.
-
-
resource_version(Number) : Version of the resource for safe concurrent modifications and consistent reads. Positive and monotonically increases on each resource spec change (but not on each change of the resource’s container(s) or status). Service allows zero value or current. -
source(Attributes) (see below for nested schema) -
status(Attributes) (see below for nested schema) -
updated_at(String) : Timestamp indicating when the resource was last updated. A string representing a timestamp in ISO 8601 format:YYYY-MM-DDTHH:MM:SSZorYYYY-MM-DDTHH:MM:SS.SSS±HH:MM
Nested Schema for after_n_empty_iterations
Read-Only:
empty_iterations_threshold(Number) Number of consecutive iterations with zero transferred objects required to stop transfer.
Nested Schema for after_one_iteration
Nested Schema for destination
Read-Only:
-
bucket_name(String) -
endpoint(String) : The endpoint must be in the form of a URL, starting with the protocol (https), followed by the endpoint address without a trailing slash. Example: https://storage.us-central1.nebius.cloud -
prefix(String) : Prefix to add to the beginning of each transferred object key in the destination bucket. During transfer, the resulting object key in the destination bucket is computed by removing source.prefix (if provided) from the original key and then prepending destination.prefix. Important: This transformation may result in an empty object key or one that exceeds allowed length limits. Use prefixes that guarantee valid resulting object keys for your objects after transformation. -
region(String)
Nested Schema for infinite
Nested Schema for metadata
Nested Schema for source
Read-Only:
-
bucket_name(String) -
endpoint(String) : The endpoint must be in the form of a URL, starting with the protocol (https), followed by the endpoint address without a trailing slash. Example: https://storage.us-central1.nebius.cloud -
limiters(Attributes) : Limiters applied to source bucket operations. These limits include all operations required for transfer (HeadObject, GetObject, ListObjects). For details about which operations are used, see public documentation: http://docs.nebius.com/object-storage/transfer/quickstart#background. Note: Since the service performs comparable request volumes and data transfers to both source and destination, these limits will indirectly constrain destination operations as well. (see below for nested schema) -
prefix(String) : Prefix to filter objects in the source bucket. Only objects whose keys start with this prefix will be transferred. During transfer, the resulting object key in the destination bucket is computed by removing source.prefix from the original key and then prepending destination.prefix (if provided). Important: This transformation may result in an empty object key or one that exceeds allowed length limits. Use prefixes that guarantee valid resulting object keys for your objects after transformation. -
region(String)
Nested Schema for source.limiters
Read-Only:
bandwidth_bytes_per_second(Number) Maximum bandwidth in bytes per second. If set to zero, default limit will be applied.requests_per_second(Number) Maximum number of requests per second. If set to zero, default limit will be applied.
Nested Schema for status
Read-Only:
-
error(String) Error information if the transfer has failed. -
last_iteration(Attributes) (see below for nested schema) -
state(String) :Supported values
Possible values:STATE_UNSPECIFIEDACTIVESTOPPINGSTOPPEDFAILINGFAILED
-
suspension_state(String) :Supported values
Possible values:SUSPENSION_STATE_UNSPECIFIEDNOT_SUSPENDEDSUSPENDED
Nested Schema for status.last_iteration
Read-Only:
-
average_throughput_bytes(Number) -
end_time(String) A string representing a timestamp in ISO 8601 format:YYYY-MM-DDTHH:MM:SSZorYYYY-MM-DDTHH:MM:SS.SSS±HH:MM -
error(String) Human-readable error description. Populated only if state is FAILED. -
objects_discovered_count(Number) -
objects_migrated_count(Number) -
objects_migrated_size(Number) -
objects_skipped_count(Number) -
sequence_number(Number) -
start_time(String) A string representing a timestamp in ISO 8601 format:YYYY-MM-DDTHH:MM:SSZorYYYY-MM-DDTHH:MM:SS.SSS±HH:MM -
state(String) :Supported values
Possible values:STATE_UNSPECIFIEDIN_PROGRESSCOMPLETEDSTOPPEDFAILED