class documentation
class BucketStatus(pb_classes.Message): (source)
Constructor: BucketStatus(initial_message, counters, state, suspension_state, ...)
Undocumented
| Class | |
No class docstring; 4/6 constants documented |
| Class | |
Undocumented |
| Method | __dir__ |
Undocumented |
| Method | __init__ |
Create a wrapper around a protobuf message instance. |
| Method | counters |
Undocumented |
| Method | deleted |
Undocumented |
| Method | domain |
Undocumented |
| Method | purge |
Undocumented |
| Method | region |
Undocumented |
| Method | state |
Undocumented |
| Method | suspension |
Undocumented |
| Constant | __PB2 |
Undocumented |
| Constant | __PY |
Undocumented |
| Class Variable | __mask |
Undocumented |
| Property | counters |
Undocumented |
| Property | deleted |
The time when the bucket was deleted (or scheduled for deletion). It resets to null if the bucket is undeleted. |
| Property | domain |
The domain of the endpoint where the bucket can be accessed. It omits the scheme (HTTPS) and the port (443) and contains only the FQDN address. |
| Property | purge |
The time when the bucket will be automatically purged in case it was soft-deleted. |
| Property | region |
The name of the region where the bucket is located for use with S3 clients, i.e. "eu-west1". |
| Property | state |
Undocumented |
| Property | suspension |
Undocumented |
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, *, counters: abc.Iterable[ BucketCounters] | None | unset.UnsetType = unset.Unset, state: BucketStatus.State | bucket_pb2.BucketStatus.State | None | unset.UnsetType = unset.Unset, suspension_state: BucketStatus.SuspensionState | bucket_pb2.BucketStatus.SuspensionState | None | unset.UnsetType = unset.Unset, deleted_at: timestamp_pb2.Timestamp | datetime.datetime | None | unset.UnsetType = unset.Unset, purge_at: timestamp_pb2.Timestamp | datetime.datetime | None | unset.UnsetType = unset.Unset, domain_name: builtins.str | None | unset.UnsetType = unset.Unset, region: builtins.str | None | unset.UnsetType = unset.Unset):
(source)
¶
Create a wrapper around a protobuf message instance.
| Raises | |
AttributeError | If the wrapper is missing required class metadata. |
@deleted_at.setter
def deleted_at(self, value:
def deleted_at(self, value:
timestamp_pb2.Timestamp | datetime.datetime | None):
(source)
¶
Undocumented
@purge_at.setter
def purge_at(self, value:
def purge_at(self, value:
timestamp_pb2.Timestamp | datetime.datetime | None):
(source)
¶
Undocumented
@state.setter
def state(self, value:
def state(self, value:
BucketStatus.State | bucket_pb2.BucketStatus.State | None):
(source)
¶
Undocumented
@suspension_state.setter
def suspension_state(self, value:
def suspension_state(self, value:
BucketStatus.SuspensionState | bucket_pb2.BucketStatus.SuspensionState | None):
(source)
¶
Undocumented
Undocumented
| Value |
|
Undocumented
| Value |
|
The time when the bucket was deleted (or scheduled for deletion). It resets to null if the bucket is undeleted.
The domain of the endpoint where the bucket can be accessed. It omits the scheme (HTTPS) and the port (443) and contains only the FQDN address.