nebius.api.nebius.storage.v1alpha1.TransferSpec.SourceBucket

class documentation

class SourceBucket(pb_classes.Message): (source)

Constructor: TransferSpec.SourceBucket(initial_message, endpoint, bucket_name, region, ...)

Undocumented

Method	`__dir__`	Undocumented
Method	`__init__`	Create a wrapper around a protobuf message instance.
Method	`bucket_name.setter`	Undocumented
Method	`credentials.setter`	Undocumented
Method	`endpoint.setter`	Undocumented
Method	`limiters.setter`	Undocumented
Method	`prefix.setter`	Undocumented
Method	`region.setter`	Undocumented
Constant	`__PB2_DESCRIPTOR__`	Undocumented
Constant	`__PY_TO_PB2__`	Undocumented
Class Variable	`__mask_functions__`	Undocumented
Property	`bucket_name`	Undocumented
Property	`credentials`	Credentials for accessing the source bucket. These credentials must have list and get permissions. This parameter must be specified only during create operations.
Property	`endpoint`	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
Property	`limiters`	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: ...
Property	`prefix`	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...
Property	`region`	Undocumented

Inherited from Message:

Class Method	`get_descriptor`	Return the protobuf descriptor for this message class.
Class Method	`is_credentials`	Return True if the field contains credentials.
Class Method	`is_sensitive`	Return True if the field is marked as sensitive.
Method	`__repr__`	Return a human-readable representation of the message, sanitizing sensitive fields.
Method	`check_presence`	Check explicit presence for a field in the protobuf message.
Method	`get_full_update_reset_mask`	Build a reset mask for a full update of this message.
Method	`get_mask`	Return the tracked reset mask.
Method	`is_default`	Return True if a field equals its default value.
Method	`set_mask`	Replace the tracked reset mask.
Method	`which_field_in_oneof`	Return the set field name for a given oneof.
Instance Variable	`__PB2_CLASS__`	Protobuf message class associated with this wrapper.
Instance Variable	`__pb2_message__`	Underlying protobuf message instance.
Method	`_clear_field`	Clear a field and record it in the reset mask.
Method	`_get_field`	Return a field value with optional wrapping and presence handling.
Method	`_set_field`	Set a field value and update the reset mask.
Class Variable	`__credentials_fields`	Undocumented
Class Variable	`__default`	Undocumented
Class Variable	`__sensitive_fields`	Undocumented
Instance Variable	`__recorded_reset_mask`	Mask tracking fields cleared or set to default.

def __dir__(self) -> abc.Iterable[builtins.str]: (source) ¶

Undocumented

overrides nebius.base.protos.pb_classes.Message.__init__

Create a wrapper around a protobuf message instance.

Raises
`AttributeError`	If the wrapper is missing required class metadata.

@bucket_name.setter
def bucket_name(self, value: builtins.str | None): (source) ¶

Undocumented

@credentials.setter
def credentials(self, value: TransferSpec.BucketCredentials | transfer_pb2.TransferSpec.BucketCredentials | None): (source) ¶

Undocumented

@endpoint.setter
def endpoint(self, value: builtins.str | None): (source) ¶

Undocumented

@limiters.setter
def limiters(self, value: TransferSpec.Limiters | transfer_pb2.TransferSpec.Limiters | None): (source) ¶

Undocumented

@prefix.setter
def prefix(self, value: builtins.str | None): (source) ¶

Undocumented

@region.setter
def region(self, value: builtins.str | None): (source) ¶

Undocumented

__PB2_DESCRIPTOR__ = (source) ¶

overrides nebius.base.protos.pb_classes.Message.__PB2_DESCRIPTOR__

Undocumented

Value

descriptor.DescriptorWrap[descriptor_1.Descriptor]('.nebius.storage.v1alpha1.Tra↵
nsferSpec.SourceBucket',
                                                   transfer_pb2.DESCRIPTOR,
                                                   descriptor_1.Descriptor)

__PY_TO_PB2__: builtins.dict[builtins.str, builtins.str] = (source) ¶

overrides nebius.base.protos.pb_classes.Message.__PY_TO_PB2__

Undocumented

Value

{'endpoint': 'endpoint',
 'bucket_name': 'bucket_name',
 'region': 'region',
 'prefix': 'prefix',
 'credentials': 'credentials',
 'limiters': 'limiters'}

__mask_functions__: dict = (source) ¶

overrides nebius.base.protos.pb_classes.Message.__mask_functions__

Undocumented

@builtins.property
bucket_name: builtins.str = (source) ¶

Undocumented

@builtins.property
credentials: TransferSpec.BucketCredentials = (source) ¶

Credentials for accessing the source bucket. These credentials must have list and get permissions. This parameter must be specified only during create operations.

@builtins.property
endpoint: builtins.str = (source) ¶

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

@builtins.property
limiters: TransferSpec.Limiters = (source) ¶

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.

@builtins.property
prefix: builtins.str = (source) ¶

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.

@builtins.property
region: builtins.str = (source) ¶

Undocumented