- 3.3.1 (latest)
- 3.3.0
- 3.2.0
- 3.1.1
- 3.0.0
- 2.19.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.0
- 2.2.1
- 2.1.0
- 2.0.0
- 1.44.0
- 1.43.0
- 1.42.3
- 1.41.1
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.1
- 1.36.2
- 1.35.1
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.2
- 1.30.0
- 1.29.0
- 1.28.1
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.1
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
Create / interact with Google Cloud Storage buckets.
Classes
Bucket
Bucket
(
client
,
name
=
None
,
user_project
=
None
)
A class representing a Bucket on Cloud Storage.
client
Client
A client which holds credentials and project configuration for the bucket (which requires a project).
name
str
The name of the bucket. Bucket names must start and end with a number or letter.
user_project
str
(Optional) the project ID to be billed for API requests made via this instance.
IAMConfiguration
IAMConfiguration
(
bucket
,
public_access_prevention
=
< object
object
> ,
uniform_bucket_level_access_enabled
=
< object
object
> ,
uniform_bucket_level_access_locked_time
=
< object
object
> ,
bucket_policy_only_enabled
=
< object
object
> ,
bucket_policy_only_locked_time
=
< object
object
> )
Map a bucket's IAM configuration.
LifecycleRuleAbortIncompleteMultipartUpload
LifecycleRuleAbortIncompleteMultipartUpload
(
**
kw
)
Map a rule aborting incomplete multipart uploads of matching items.
The "age" lifecycle condition is the only supported condition for this rule.
LifecycleRuleConditions
LifecycleRuleConditions
(
age
=
None
,
created_before
=
None
,
is_live
=
None
,
matches_storage_class
=
None
,
number_of_newer_versions
=
None
,
days_since_custom_time
=
None
,
custom_time_before
=
None
,
days_since_noncurrent_time
=
None
,
noncurrent_time_before
=
None
,
matches_prefix
=
None
,
matches_suffix
=
None
,
_factory
=
False
,
)
Map a single lifecycle rule for a bucket.
age
int
(Optional) Apply rule action to items whose age, in days, exceeds this value.
created_before
datetime.date
(Optional) Apply rule action to items created before this date.
is_live
bool
(Optional) If true, apply rule action to non-versioned items, or to items with no newer versions. If false, apply rule action to versioned items with at least one newer version.
matches_prefix
list(str)
(Optional) Apply rule action to items which any prefix matches the beginning of the item name.
matches_storage_class
list(str), one or more of Bucket.STORAGE_CLASSES
.
(Optional) Apply rule action to items whose storage class matches this value.
matches_suffix
list(str)
(Optional) Apply rule action to items which any suffix matches the end of the item name.
number_of_newer_versions
int
(Optional) Apply rule action to versioned items having N newer versions.
days_since_custom_time
int
(Optional) Apply rule action to items whose number of days elapsed since the custom timestamp. This condition is relevant only for versioned objects. The value of the field must be a non negative integer. If it's zero, the object version will become eligible for lifecycle action as soon as it becomes custom.
custom_time_before
datetime.date
(Optional) Date object parsed from RFC3339 valid date, apply rule action to items whose custom time is before this date. This condition is relevant only for versioned objects, e.g., 2019-03-16.
days_since_noncurrent_time
int
(Optional) Apply rule action to items whose number of days elapsed since the non current timestamp. This condition is relevant only for versioned objects. The value of the field must be a non negative integer. If it's zero, the object version will become eligible for lifecycle action as soon as it becomes non current.
noncurrent_time_before
datetime.date
(Optional) Date object parsed from RFC3339 valid date, apply rule action to items whose non current time is before this date. This condition is relevant only for versioned objects, e.g, 2019-03-16.
ValueError
LifecycleRuleDelete
LifecycleRuleDelete
(
**
kw
)
Map a lifecycle rule deleting matching items.
LifecycleRuleSetStorageClass
LifecycleRuleSetStorageClass
(
storage_class
,
**
kw
)
Map a lifecycle rule updating storage class of matching items.
storage_class
str, one of Bucket.STORAGE_CLASSES
.
new storage class to assign to matching items.
