class documentation
class S3CompatibleProvider(pb_classes.Message): (source)
Constructor: TransferDestination.S3CompatibleProvider(initial_message, endpoint, region, bucket_name, ...)
Undocumented
| Class | __ |
Undocumented |
| Class | __ |
Undocumented |
| Class | __ |
Undocumented |
| Method | __dir__ |
Undocumented |
| Method | __init__ |
Create a wrapper around a protobuf message instance. |
| Method | access |
Undocumented |
| Method | anonymous |
Undocumented |
| Method | bucket |
Undocumented |
| Method | endpoint |
Undocumented |
| Method | region |
Undocumented |
| Constant | __PB2 |
Undocumented |
| Constant | __PY |
Undocumented |
| Class Variable | __mask |
Undocumented |
| Property | access |
Undocumented |
| Property | anonymous |
Undocumented |
| Property | bucket |
Name of the destination bucket. |
| Property | credentials |
Credentials for accessing the destination bucket. These credentials must have head, write permissions. |
| 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.some-cloud". |
| Property | region |
S3-compatible provider region where destination bucket is located. |
Inherited from Message:
| Class Method | get |
Return the protobuf descriptor for this message class. |
| Class Method | is |
Return True if the field contains credentials. |
| Class Method | is |
Return True if the field is marked as sensitive. |
| Method | __repr__ |
Return a human-readable representation of the message, sanitizing sensitive fields. |
| Method | check |
Check explicit presence for a field in the protobuf message. |
| Method | get |
Build a reset mask for a full update of this message. |
| Method | get |
Return the tracked reset mask. |
| Method | is |
Return True if a field equals its default value. |
| Method | set |
Replace the tracked reset mask. |
| Method | which |
Return the set field name for a given oneof. |
| Instance Variable | __PB2 |
Protobuf message class associated with this wrapper. |
| Instance Variable | __pb2 |
Underlying protobuf message instance. |
| Method | _clear |
Clear a field and record it in the reset mask. |
| Method | _get |
Return a field value with optional wrapping and presence handling. |
| Method | _set |
Set a field value and update the reset mask. |
| Class Variable | __credentials |
Undocumented |
| Class Variable | __default |
Undocumented |
| Class Variable | __sensitive |
Undocumented |
| Instance Variable | __recorded |
Mask tracking fields cleared or set to default. |
def __init__(self, initial_message:
message_1.Message | None = None, *, endpoint: builtins.str | None | unset.UnsetType = unset.Unset, region: builtins.str | None | unset.UnsetType = unset.Unset, bucket_name: builtins.str | None | unset.UnsetType = unset.Unset, anonymous: TransferCredentialsAnonymous | transfer_pb2.TransferCredentialsAnonymous | None | unset.UnsetType = unset.Unset, access_key: TransferCredentialsAccessKey | transfer_pb2.TransferCredentialsAccessKey | None | unset.UnsetType = unset.Unset):
(source)
¶
Create a wrapper around a protobuf message instance.
| Raises | |
AttributeError | If the wrapper is missing required class metadata. |
@access_key.setter
def access_key(self, value:
def access_key(self, value:
TransferCredentialsAccessKey | transfer_pb2.TransferCredentialsAccessKey | None):
(source)
¶
Undocumented
@anonymous.setter
def anonymous(self, value:
def anonymous(self, value:
TransferCredentialsAnonymous | transfer_pb2.TransferCredentialsAnonymous | None):
(source)
¶
Undocumented
Undocumented
| Value |
|
Undocumented
| Value |
|
@builtins.property
credentials:
credentials:
__OneOfClass_credentials_anonymous__ | __OneOfClass_credentials_access_key__ | None =
(source)
¶
Credentials for accessing the destination bucket. These credentials must have head, write permissions.
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.some-cloud".