|
storage
v1
|
#include <bucket.h>
Classes | |
| class | BucketBilling |
| class | BucketCors |
| class | BucketEncryption |
| class | BucketIamConfiguration |
| class | BucketLifecycle |
| class | BucketLogging |
| class | BucketOwner |
| class | BucketRetentionPolicy |
| class | BucketVersioning |
| class | BucketWebsite |
Public Member Functions | |
| Bucket (const Json::Value &storage) | |
| Bucket (Json::Value *storage) | |
| virtual | ~Bucket () |
| const StringPiece | GetTypeName () const |
| bool | has_acl () const |
| void | clear_acl () |
| const client::JsonCppArray< BucketAccessControl > | get_acl () const |
| client::JsonCppArray< BucketAccessControl > | mutable_acl () |
| bool | has_billing () const |
| void | clear_billing () |
| const BucketBilling | get_billing () const |
| BucketBilling | mutable_billing () |
| bool | has_cors () const |
| void | clear_cors () |
| const client::JsonCppArray< BucketCors > | get_cors () const |
| client::JsonCppArray< BucketCors > | mutable_cors () |
| bool | has_default_event_based_hold () const |
| void | clear_default_event_based_hold () |
| bool | get_default_event_based_hold () const |
| void | set_default_event_based_hold (bool value) |
| bool | has_default_object_acl () const |
| void | clear_default_object_acl () |
| const client::JsonCppArray< ObjectAccessControl > | get_default_object_acl () const |
| client::JsonCppArray< ObjectAccessControl > | mutable_defaultObjectAcl () |
| bool | has_encryption () const |
| void | clear_encryption () |
| const BucketEncryption | get_encryption () const |
| BucketEncryption | mutable_encryption () |
| bool | has_etag () const |
| void | clear_etag () |
| const StringPiece | get_etag () const |
| void | set_etag (const StringPiece &value) |
| bool | has_iam_configuration () const |
| void | clear_iam_configuration () |
| const BucketIamConfiguration | get_iam_configuration () const |
| BucketIamConfiguration | mutable_iamConfiguration () |
| bool | has_id () const |
| void | clear_id () |
| const StringPiece | get_id () const |
| void | set_id (const StringPiece &value) |
| bool | has_kind () const |
| void | clear_kind () |
| const StringPiece | get_kind () const |
| void | set_kind (const StringPiece &value) |
| bool | has_labels () const |
| void | clear_labels () |
| const client::JsonCppAssociativeArray< string > | get_labels () const |
| client::JsonCppAssociativeArray< string > | mutable_labels () |
| bool | has_lifecycle () const |
| void | clear_lifecycle () |
| const BucketLifecycle | get_lifecycle () const |
| BucketLifecycle | mutable_lifecycle () |
| bool | has_location () const |
| void | clear_location () |
| const StringPiece | get_location () const |
| void | set_location (const StringPiece &value) |
| bool | has_location_type () const |
| void | clear_location_type () |
| const StringPiece | get_location_type () const |
| void | set_location_type (const StringPiece &value) |
| bool | has_logging () const |
| void | clear_logging () |
| const BucketLogging | get_logging () const |
| BucketLogging | mutable_logging () |
| bool | has_metageneration () const |
| void | clear_metageneration () |
| int64 | get_metageneration () const |
| void | set_metageneration (int64 value) |
| bool | has_name () const |
| void | clear_name () |
| const StringPiece | get_name () const |
| void | set_name (const StringPiece &value) |
| bool | has_owner () const |
| void | clear_owner () |
| const BucketOwner | get_owner () const |
| BucketOwner | mutable_owner () |
| bool | has_project_number () const |
| void | clear_project_number () |
| uint64 | get_project_number () const |
| void | set_project_number (uint64 value) |
| bool | has_retention_policy () const |
| void | clear_retention_policy () |
| const BucketRetentionPolicy | get_retention_policy () const |
| BucketRetentionPolicy | mutable_retentionPolicy () |
| bool | has_self_link () const |
| void | clear_self_link () |
| const StringPiece | get_self_link () const |
| void | set_self_link (const StringPiece &value) |
| bool | has_storage_class () const |
| void | clear_storage_class () |
| const StringPiece | get_storage_class () const |
| void | set_storage_class (const StringPiece &value) |
| bool | has_time_created () const |
| void | clear_time_created () |
| client::DateTime | get_time_created () const |
| void | set_time_created (client::DateTime value) |
| bool | has_updated () const |
| void | clear_updated () |
| client::DateTime | get_updated () const |
| void | set_updated (client::DateTime value) |
| bool | has_versioning () const |
| void | clear_versioning () |
| const BucketVersioning | get_versioning () const |
| BucketVersioning | mutable_versioning () |
| bool | has_website () const |
| void | clear_website () |
| const BucketWebsite | get_website () const |
| BucketWebsite | mutable_website () |
| bool | has_zone_affinity () const |
| void | clear_zone_affinity () |
| const client::JsonCppArray< string > | get_zone_affinity () const |
| client::JsonCppArray< string > | mutable_zone_affinity () |
Static Public Member Functions | |
| static Bucket * | New () |
A bucket.
|
explicit |
Standard constructor for an immutable data object instance.
| [in] | storage | The underlying data storage for this instance. |
|
explicit |
Standard constructor for a mutable data object instance.
| [in] | storage | The underlying data storage for this instance. |
|
virtual |
Standard destructor.
|
inline |
Clears the 'acl' attribute.
|
inline |
Clears the 'billing' attribute.
|
inline |
Clears the 'cors' attribute.
|
inline |
Clears the 'defaultEventBasedHold' attribute.
|
inline |
Clears the 'defaultObjectAcl' attribute.
|
inline |
Clears the 'encryption' attribute.
|
inline |
Clears the 'etag' attribute.
|
inline |
Clears the 'iamConfiguration' attribute.
|
inline |
Clears the 'id' attribute.
|
inline |
Clears the 'kind' attribute.
|
inline |
Clears the 'labels' attribute.
|
inline |
Clears the 'lifecycle' attribute.
|
inline |
Clears the 'location' attribute.
|
inline |
Clears the 'locationType' attribute.
|
inline |
Clears the 'logging' attribute.
|
inline |
Clears the 'metageneration' attribute.
|
inline |
Clears the 'name' attribute.
|
inline |
Clears the 'owner' attribute.
|
inline |
Clears the 'projectNumber' attribute.
|
inline |
Clears the 'retentionPolicy' attribute.
|
inline |
Clears the 'selfLink' attribute.
|
inline |
Clears the 'storageClass' attribute.
|
inline |
Clears the 'timeCreated' attribute.
|
inline |
Clears the 'updated' attribute.
|
inline |
Clears the 'versioning' attribute.
|
inline |
Clears the 'website' attribute.
|
inline |
Clears the 'zone_affinity' attribute.
| const client::JsonCppArray<BucketAccessControl > google_storage_api::Bucket::get_acl | ( | ) | const |
Get a reference to the value of the 'acl' attribute.
|
inline |
Get a reference to the value of the 'billing' attribute.
|
inline |
Get a reference to the value of the 'cors' attribute.
|
inline |
Get the value of the 'defaultEventBasedHold' attribute.
| const client::JsonCppArray<ObjectAccessControl > google_storage_api::Bucket::get_default_object_acl | ( | ) | const |
Get a reference to the value of the 'defaultObjectAcl' attribute.
|
inline |
Get a reference to the value of the 'encryption' attribute.
|
inline |
Get the value of the 'etag' attribute.
|
inline |
Get a reference to the value of the 'iamConfiguration' attribute.
|
inline |
Get the value of the 'id' attribute.
|
inline |
Get the value of the 'kind' attribute.
|
inline |
Get a reference to the value of the 'labels' attribute.
|
inline |
Get a reference to the value of the 'lifecycle' attribute.
|
inline |
Get the value of the 'location' attribute.
|
inline |
Get the value of the 'locationType' attribute.
|
inline |
Get a reference to the value of the 'logging' attribute.
|
inline |
Get the value of the 'metageneration' attribute.
|
inline |
Get the value of the 'name' attribute.
|
inline |
Get a reference to the value of the 'owner' attribute.
|
inline |
Get the value of the 'projectNumber' attribute.
|
inline |
Get a reference to the value of the 'retentionPolicy' attribute.
|
inline |
Get the value of the 'selfLink' attribute.
|
inline |
Get the value of the 'storageClass' attribute.
|
inline |
Get the value of the 'timeCreated' attribute.
|
inline |
Get the value of the 'updated' attribute.
|
inline |
Get a reference to the value of the 'versioning' attribute.
|
inline |
Get a reference to the value of the 'website' attribute.
|
inline |
Get a reference to the value of the 'zone_affinity' attribute.
|
inline |
Returns a string denoting the type of this data object.
google_storage_api::Bucket
|
inline |
Determine if the 'acl' attribute was set.
acl' attribute was set.
|
inline |
Determine if the 'billing' attribute was set.
billing' attribute was set.
|
inline |
Determine if the 'cors' attribute was set.
cors' attribute was set.
|
inline |
Determine if the 'defaultEventBasedHold' attribute was set.
defaultEventBasedHold' attribute was set.
|
inline |
Determine if the 'defaultObjectAcl' attribute was set.
defaultObjectAcl' attribute was set.
|
inline |
Determine if the 'encryption' attribute was set.
encryption' attribute was set.
|
inline |
Determine if the 'etag' attribute was set.
etag' attribute was set.
|
inline |
Determine if the 'iamConfiguration' attribute was set.
iamConfiguration' attribute was set.
|
inline |
Determine if the 'id' attribute was set.
id' attribute was set.
|
inline |
Determine if the 'kind' attribute was set.
kind' attribute was set.
|
inline |
Determine if the 'labels' attribute was set.
labels' attribute was set.
|
inline |
Determine if the 'lifecycle' attribute was set.
lifecycle' attribute was set.
|
inline |
Determine if the 'location' attribute was set.
location' attribute was set.
|
inline |
Determine if the 'locationType' attribute was set.
locationType' attribute was set.
|
inline |
Determine if the 'logging' attribute was set.
logging' attribute was set.
|
inline |
Determine if the 'metageneration' attribute was set.
metageneration' attribute was set.
|
inline |
Determine if the 'name' attribute was set.
name' attribute was set.
|
inline |
Determine if the 'owner' attribute was set.
owner' attribute was set.
|
inline |
Determine if the 'projectNumber' attribute was set.
projectNumber' attribute was set.
|
inline |
Determine if the 'retentionPolicy' attribute was set.
retentionPolicy' attribute was set.
|
inline |
Determine if the 'selfLink' attribute was set.
selfLink' attribute was set.
|
inline |
Determine if the 'storageClass' attribute was set.
storageClass' attribute was set.
|
inline |
Determine if the 'timeCreated' attribute was set.
timeCreated' attribute was set.
|
inline |
Determine if the 'updated' attribute was set.
updated' attribute was set.
|
inline |
Determine if the 'versioning' attribute was set.
versioning' attribute was set.
|
inline |
Determine if the 'website' attribute was set.
website' attribute was set.
|
inline |
Determine if the 'zone_affinity' attribute was set.
zone_affinity' attribute was set. | client::JsonCppArray<BucketAccessControl > google_storage_api::Bucket::mutable_acl | ( | ) |
Gets a reference to a mutable value of the 'acl' property.
Access controls on the bucket.
|
inline |
Gets a reference to a mutable value of the 'billing' property.
The bucket's billing configuration.
|
inline |
Gets a reference to a mutable value of the 'cors' property.
The bucket's Cross-Origin Resource Sharing (CORS) configuration.
| client::JsonCppArray<ObjectAccessControl > google_storage_api::Bucket::mutable_defaultObjectAcl | ( | ) |
Gets a reference to a mutable value of the 'defaultObjectAcl' property.
Default access controls to apply to new objects when no ACL is provided.
|
inline |
Gets a reference to a mutable value of the 'encryption' property.
Encryption configuration for a bucket.
|
inline |
Gets a reference to a mutable value of the 'iamConfiguration' property.
The bucket's IAM configuration.
|
inline |
Gets a reference to a mutable value of the 'labels' property.
User-provided labels, in key/value pairs.
|
inline |
Gets a reference to a mutable value of the 'lifecycle' property.
The bucket's lifecycle configuration. See lifecycle management for more information.
|
inline |
Gets a reference to a mutable value of the 'logging' property.
The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.
|
inline |
Gets a reference to a mutable value of the 'owner' property.
The owner of the bucket. This is always the project team's owner group.
|
inline |
Gets a reference to a mutable value of the 'retentionPolicy' property.
The bucket's retention policy. The retention policy enforces a minimum retention time for all objects contained in the bucket, based on their creation time. Any attempt to overwrite or delete objects younger than the retention period will result in a PERMISSION_DENIED error. An unlocked retention policy can be modified or removed from the bucket via a storage.buckets.update operation. A locked retention policy cannot be removed or shortened in duration for the lifetime of the bucket. Attempting to remove or decrease period of a locked retention policy will result in a PERMISSION_DENIED error.
|
inline |
Gets a reference to a mutable value of the 'versioning' property.
The bucket's versioning configuration.
|
inline |
Gets a reference to a mutable value of the 'website' property.
The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information.
|
inline |
Gets a reference to a mutable value of the 'zone_affinity' property.
The zone or zones from which the bucket is intended to use zonal quota. Requests for data from outside the specified affinities are still allowed but won’t be able to use zonal quota. The zone or zones need to be within the bucket location otherwise the requests will fail with a 400 Bad Request response.
|
static |
Creates a new default instance.
|
inline |
Change the 'defaultEventBasedHold' attribute.
The default value for event-based hold on newly created objects in this bucket. Event-based hold is a way to retain objects indefinitely until an event occurs, signified by the hold's release. After being released, such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event- based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event- based hold transitioned from true to false. Objects under event-based hold cannot be deleted, overwritten or archived until the hold is removed.
| [in] | value | The new value. |
|
inline |
Change the 'etag' attribute.
HTTP 1.1 Entity tag for the bucket.
| [in] | value | The new value. |
|
inline |
Change the 'id' attribute.
The ID of the bucket. For buckets, the id and name properties are the same.
| [in] | value | The new value. |
|
inline |
Change the 'kind' attribute.
The kind of item this is. For buckets, this is always storage::bucket.
| [in] | value | The new value. |
|
inline |
Change the 'location' attribute.
The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list.
| [in] | value | The new value. |
|
inline |
Change the 'locationType' attribute.
The type of the bucket location.
| [in] | value | The new value. |
|
inline |
Change the 'metageneration' attribute.
The metadata generation of this bucket.
| [in] | value | The new value. |
|
inline |
Change the 'name' attribute.
The name of the bucket.
| [in] | value | The new value. |
|
inline |
Change the 'projectNumber' attribute.
The project number of the project the bucket belongs to.
| [in] | value | The new value. |
|
inline |
Change the 'selfLink' attribute.
The URI of this bucket.
| [in] | value | The new value. |
|
inline |
Change the 'storageClass' attribute.
The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.
| [in] | value | The new value. |
|
inline |
Change the 'timeCreated' attribute.
The creation time of the bucket in RFC 3339 format.
| [in] | value | The new value. |
|
inline |
Change the 'updated' attribute.
The modification time of the bucket in RFC 3339 format.
| [in] | value | The new value. |