class documentation
class BucketSpec(pb_classes.Message): (source)
Constructor: BucketSpec(initial_message, versioning_policy, max_size_bytes, lifecycle_configuration, ...)
Undocumented
| Class | |
No class docstring; 3/5 constants documented |
| Method | __dir__ |
Undocumented |
| Method | __init__ |
Create a wrapper around a protobuf message instance. |
| Method | bucket |
Undocumented |
| Method | cors |
Undocumented |
| Method | default |
Undocumented |
| Method | force |
Undocumented |
| Method | lifecycle |
Undocumented |
| Method | max |
Undocumented |
| Method | object |
Undocumented |
| Method | versioning |
Undocumented |
| Constant | __PB2 |
Undocumented |
| Constant | __PY |
Undocumented |
| Class Variable | __mask |
Undocumented |
| Property | bucket |
Bucket policy specifies granular permissions for a bucket. |
| Property | cors |
Cross-origin resource sharing configuration. |
| Property | default |
Storage class to use by default for uploads to the bucket. It may be overridden by x-amz-storage-class header. If not set - STANDARD is used as a default storage class. |
| Property | force |
Flag to force usage of default_storage_class, ignoring x-amz-storage-class header. |
| Property | lifecycle |
Undocumented |
| Property | max |
Maximum bucket size. Zero means unlimited. Actual limit can be lower if customer doesn't have enough quota. Real bucket size can go a little higher if customer writes too fast. |
| Property | object |
Object audit logging specifies which requests must be logged - none, all or mutational only. |
| Property | versioning |
Supports transitions: |
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, *, versioning_policy: VersioningPolicy | base_pb2.VersioningPolicy | None | unset.UnsetType = unset.Unset, max_size_bytes: builtins.int | None | unset.UnsetType = unset.Unset, lifecycle_configuration: LifecycleConfiguration | lifecycle_pb2.LifecycleConfiguration | None | unset.UnsetType = unset.Unset, cors: CORSConfiguration | cors_pb2.CORSConfiguration | None | unset.UnsetType = unset.Unset, default_storage_class: StorageClass | base_pb2.StorageClass | None | unset.UnsetType = unset.Unset, force_storage_class: builtins.bool | None | unset.UnsetType = unset.Unset, object_audit_logging: BucketSpec.ObjectAuditLogging | bucket_pb2.BucketSpec.ObjectAuditLogging | None | unset.UnsetType = unset.Unset, bucket_policy: BucketPolicy | bucket_policy_pb2.BucketPolicy | None | unset.UnsetType = unset.Unset):
(source)
¶
Create a wrapper around a protobuf message instance.
| Raises | |
AttributeError | If the wrapper is missing required class metadata. |
@bucket_policy.setter
def bucket_policy(self, value:
def bucket_policy(self, value:
BucketPolicy | bucket_policy_pb2.BucketPolicy | None):
(source)
¶
Undocumented
@cors.setter
def cors(self, value:
def cors(self, value:
CORSConfiguration | cors_pb2.CORSConfiguration | None):
(source)
¶
Undocumented
@default_storage_class.setter
def default_storage_class(self, value:
def default_storage_class(self, value:
StorageClass | base_pb2.StorageClass | None):
(source)
¶
Undocumented
@lifecycle_configuration.setter
def lifecycle_configuration(self, value:
def lifecycle_configuration(self, value:
LifecycleConfiguration | lifecycle_pb2.LifecycleConfiguration | None):
(source)
¶
Undocumented
@object_audit_logging.setter
def object_audit_logging(self, value:
def object_audit_logging(self, value:
BucketSpec.ObjectAuditLogging | bucket_pb2.BucketSpec.ObjectAuditLogging | None):
(source)
¶
Undocumented
@versioning_policy.setter
def versioning_policy(self, value:
def versioning_policy(self, value:
VersioningPolicy | base_pb2.VersioningPolicy | None):
(source)
¶
Undocumented
Undocumented
| Value |
|
Undocumented
| Value |
|
Storage class to use by default for uploads to the bucket. It may be overridden by x-amz-storage-class header. If not set - STANDARD is used as a default storage class.
Maximum bucket size. Zero means unlimited. Actual limit can be lower if customer doesn't have enough quota. Real bucket size can go a little higher if customer writes too fast.