Bucket
A bucket.Fields | |
---|---|
acl[] |
Access controls on the bucket.
|
autoclass |
The bucket's Autoclass configuration.
|
autoclass.enabled |
Whether or not Autoclass is enabled on this bucket
|
autoclass.toggleTime |
A date and time in RFC 3339 format representing the instant at which "enabled" was last toggled.
|
billing |
The bucket's billing configuration.
|
billing.requesterPays |
When set to true, Requester Pays is enabled for this bucket.
|
cors[] |
The bucket's Cross-Origin Resource Sharing (CORS) configuration.
|
cors.maxAgeSeconds |
The value, in seconds, to return in the Access-Control-Max-Age header used in preflight responses.
|
cors.method[] |
The list of HTTP methods on which to include CORS response headers, (GET, OPTIONS, POST, etc) Note: "*" is permitted in the list of methods, and means "any method".
|
cors.origin[] |
The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin".
|
cors.responseHeader[] |
The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.
|
customPlacementConfig |
The bucket's custom placement configuration for Custom Dual Regions.
|
customPlacementConfig.dataLocations[] |
The list of regional locations in which data is placed.
|
defaultEventBasedHold |
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.
|
defaultObjectAcl[] |
Default access controls to apply to new objects when no ACL is provided.
|
encryption |
Encryption configuration for a bucket.
|
encryption.defaultKmsKeyName |
A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified.
|
etag |
HTTP 1.1 Entity tag for the bucket.
|
iamConfiguration |
The bucket's IAM configuration.
|
iamConfiguration.bucketPolicyOnly |
The bucket's uniform bucket-level access configuration. The feature was formerly known as Bucket Policy Only. For backward compatibility, this field will be populated with identical information as the uniformBucketLevelAccess field. We recommend using the uniformBucketLevelAccess field to enable and disable the feature.
|
iamConfiguration.bucketPolicyOnly.enabled |
If set, access is controlled only by bucket-level or above IAM policies.
|
iamConfiguration.bucketPolicyOnly.lockedTime |
The deadline for changing iamConfiguration.bucketPolicyOnly.enabled from true to false in RFC 3339 format. iamConfiguration.bucketPolicyOnly.enabled may be changed from true to false until the locked time, after which the field is immutable.
|
iamConfiguration.publicAccessPrevention |
The bucket's Public Access Prevention configuration. Currently, 'inherited' and 'enforced' are supported.
|
iamConfiguration.uniformBucketLevelAccess |
The bucket's uniform bucket-level access configuration.
|
iamConfiguration.uniformBucketLevelAccess.enabled |
If set, access is controlled only by bucket-level or above IAM policies.
|
iamConfiguration.uniformBucketLevelAccess.lockedTime |
The deadline for changing iamConfiguration.uniformBucketLevelAccess.enabled from true to false in RFC 3339 format. iamConfiguration.uniformBucketLevelAccess.enabled may be changed from true to false until the locked time, after which the field is immutable.
|
id |
The ID of the bucket. For buckets, the id and name properties are the same.
|
kind |
The kind of item this is. For buckets, this is always storage#bucket.
|
labels |
User-provided labels, in key/value pairs.
|
lifecycle |
The bucket's lifecycle configuration. See lifecycle management for more information.
|
lifecycle.rule[] |
A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.
|
lifecycle.rule.action |
The action to take.
|
lifecycle.rule.action.storageClass |
Target storage class. Required iff the type of the action is SetStorageClass.
|
lifecycle.rule.action.type |
Type of the action. Currently, only Delete, SetStorageClass, and AbortIncompleteMultipartUpload are supported.
|
lifecycle.rule.condition |
The condition(s) under which the action will be taken.
|
lifecycle.rule.condition.age |
Age of an object (in days). This condition is satisfied when an object reaches the specified age.
|
lifecycle.rule.condition.createdBefore |
A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when an object is created before midnight of the specified date in UTC.
|
lifecycle.rule.condition.customTimeBefore |
A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when the custom time on an object is before this date in UTC.
|
lifecycle.rule.condition.daysSinceCustomTime |
Number of days elapsed since the user-specified timestamp set on an object. The condition is satisfied if the days elapsed is at least this number. If no custom timestamp is specified on an object, the condition does not apply.
|
lifecycle.rule.condition.daysSinceNoncurrentTime |
Number of days elapsed since the noncurrent timestamp of an object. The condition is satisfied if the days elapsed is at least this number. This condition is relevant only for versioned objects. The value of the field must be a nonnegative integer. If it's zero, the object version will become eligible for Lifecycle action as soon as it becomes noncurrent.
|
lifecycle.rule.condition.isLive |
Relevant only for versioned objects. If the value is true, this condition matches live objects; if the value is false, it matches archived objects.
|
lifecycle.rule.condition.matchesPattern |
A regular expression that satisfies the RE2 syntax. This condition is satisfied when the name of the object matches the RE2 pattern. Note: This feature is currently in the "Early Access" launch stage and is only available to a whitelisted set of users; that means that this feature may be changed in backward-incompatible ways and that it is not guaranteed to be released.
|
lifecycle.rule.condition.matchesPrefix[] |
List of object name prefixes. This condition will be satisfied when at least one of the prefixes exactly matches the beginning of the object name.
|
lifecycle.rule.condition.matchesStorageClass[] |
Objects having any of the storage classes specified by this condition will be matched. Values include MULTI_REGIONAL, REGIONAL, NEARLINE, COLDLINE, ARCHIVE, STANDARD, and DURABLE_REDUCED_AVAILABILITY.
|
lifecycle.rule.condition.matchesSuffix[] |
List of object name suffixes. This condition will be satisfied when at least one of the suffixes exactly matches the end of the object name.
|
lifecycle.rule.condition.noncurrentTimeBefore |
A date in RFC 3339 format with only the date part (for instance, "2013-01-15"). This condition is satisfied when the noncurrent time on an object is before this date in UTC. This condition is relevant only for versioned objects.
|
lifecycle.rule.condition.numNewerVersions |
Relevant only for versioned objects. If the value is N, this condition is satisfied when there are at least N versions (including the live version) newer than this version of the object.
|
location |
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.
|
locationType |
The type of the bucket location.
|
logging |
The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.
|
logging.logBucket |
The destination bucket where the current bucket's logs should be placed.
|
logging.logObjectPrefix |
A prefix for log object names.
|
metageneration |
The metadata generation of this bucket.
|
name |
The name of the bucket.
|
owner |
The owner of the bucket. This is always the project team's owner group.
|
owner.entity |
The entity, in the form project-owner-projectId.
|
owner.entityId |
The ID for the entity.
|
projectNumber |
The project number of the project the bucket belongs to.
|
retentionPolicy |
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.
|
retentionPolicy.effectiveTime |
Server-determined value that indicates the time from which policy was enforced and effective. This value is in RFC 3339 format.
|
retentionPolicy.isLocked |
Once locked, an object retention policy cannot be modified.
|
retentionPolicy.retentionPeriod |
The duration in seconds that objects need to be retained. Retention duration must be greater than zero and less than 100 years. Note that enforcement of retention periods less than a day is not guaranteed. Such periods should only be used for testing purposes.
|
rpo |
The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a bucket.
|
satisfiesPZS |
Reserved for future use.
|
selfLink |
The URI of this bucket.
|
storageClass |
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.
|
timeCreated |
The creation time of the bucket in RFC 3339 format.
|
updated |
The modification time of the bucket in RFC 3339 format.
|
versioning |
The bucket's versioning configuration.
|
versioning.enabled |
While set to true, versioning is fully enabled for this bucket.
|
website |
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.
|
website.mainPageSuffix |
If the requested object path is missing, the service will ensure the path has a trailing '/', append this suffix, and attempt to retrieve the resulting object. This allows the creation of index.html objects to represent directory pages.
|
website.notFoundPage |
If the requested object path is missing, and any mainPageSuffix object is missing, if applicable, the service will return the named object from this bucket as the content for a 404 Not Found result.
|
BucketAccessControl
An access-control entry.Fields | |
---|---|
bucket |
The name of the bucket.
|
domain |
The domain associated with the entity, if any.
|
email |
The email address associated with the entity, if any.
|
entity |
The entity holding the permission, in one of the following forms: - user-userId - user-email - group-groupId - group-email - domain-domain - project-team-projectId - allUsers - allAuthenticatedUsers Examples: - The user liz@example.com would be user-liz@example.com. - The group example@googlegroups.com would be group-example@googlegroups.com. - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
|
entityId |
The ID for the entity, if any.
|
etag |
HTTP 1.1 Entity tag for the access-control entry.
|
id |
The ID of the access-control entry.
|
kind |
The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
|
projectTeam |
The project team associated with the entity, if any.
|
projectTeam.projectNumber |
The project number.
|
projectTeam.team |
The team.
|
role |
The access permission for the entity.
|
selfLink |
The link to this access-control entry.
|
BucketAccessControls
An access-control list.Fields | |
---|---|
items[] |
The list of items.
|
kind |
The kind of item this is. For lists of bucket access control entries, this is always storage#bucketAccessControls.
|
Buckets
A list of buckets.Fields | |
---|---|
items[] |
The list of items.
|
kind |
The kind of item this is. For lists of buckets, this is always storage#buckets.
|
nextPageToken |
The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
|
Channel
An notification channel used to watch for resource changes.Fields | |
---|---|
address |
The address where notifications are delivered for this channel.
|
expiration |
Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
|
id |
A UUID or similar unique string that identifies this channel.
|
kind |
Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
|
params |
Additional parameters controlling delivery channel behavior. Optional.
|
payload |
A Boolean value to indicate whether payload is wanted. Optional.
|
resourceId |
An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
|
resourceUri |
A version-specific identifier for the watched resource.
|
token |
An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
|
type |
The type of delivery mechanism used for this channel.
|
ComposeRequest
A Compose request.Fields | |
---|---|
destination |
Properties of the resulting object.
|
destination.customerEncryption.encryptionAlgorithm |
The encryption algorithm.
|
destination.customerEncryption.keySha256 |
SHA256 hash value of the encryption key.
|
destination.owner.entity |
The entity, in the form user-userId.
|
destination.owner.entityId |
The ID for the entity.
|
kind |
The kind of item this is.
|
sourceObjects[] |
The list of source objects that will be concatenated into a single object.
|
sourceObjects.generation |
The generation of this object to use as the source.
|
sourceObjects.name |
The source object's name. All source objects must reside in the same bucket.
|
sourceObjects.objectPreconditions |
Conditions that must be met for this operation to execute.
|
sourceObjects.objectPreconditions.ifGenerationMatch |
Only perform the composition if the generation of the source object that would be used matches this value. If this value and a generation are both specified, they must be the same value or the call will fail.
|
Expr
Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0"Fields | |
---|---|
description |
An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
|
expression |
Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported.
|
location |
An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
|
title |
An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
|
HmacKey
JSON template to produce a JSON-style HMAC Key resource for Create responses.Fields | |
---|---|
kind |
The kind of item this is. For HMAC keys, this is always storage#hmacKey.
|
metadata |
Key metadata.
|
secret |
HMAC secret key material.
|
HmacKeyMetadata
JSON template to produce a JSON-style HMAC Key metadata resource.Fields | |
---|---|
accessId |
The ID of the HMAC Key.
|
etag |
HTTP 1.1 Entity tag for the HMAC key.
|
id |
The ID of the HMAC key, including the Project ID and the Access ID.
|
kind |
The kind of item this is. For HMAC Key metadata, this is always storage#hmacKeyMetadata.
|
projectId |
Project ID owning the service account to which the key authenticates.
|
selfLink |
The link to this resource.
|
serviceAccountEmail |
The email address of the key's associated service account.
|
state |
The state of the key. Can be one of ACTIVE, INACTIVE, or DELETED.
|
timeCreated |
The creation time of the HMAC key in RFC 3339 format.
|
updated |
The last modification time of the HMAC key metadata in RFC 3339 format.
|
HmacKeysMetadata
A list of hmacKeys.Fields | |
---|---|
items[] |
The list of items.
|
kind |
The kind of item this is. For lists of hmacKeys, this is always storage#hmacKeysMetadata.
|
nextPageToken |
The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
|
Notification
A subscription to receive Google PubSub notifications.Fields | |
---|---|
custom_attributes |
An optional list of additional attributes to attach to each Cloud PubSub message published for this notification subscription.
|
etag |
HTTP 1.1 Entity tag for this subscription notification.
|
event_types[] |
If present, only send notifications about listed event types. If empty, sent notifications for all event types.
|
id |
The ID of the notification.
|
kind |
The kind of item this is. For notifications, this is always storage#notification.
|
object_name_prefix |
If present, only apply this notification configuration to object names that begin with this prefix.
|
payload_format |
The desired content of the Payload.
|
selfLink |
The canonical URL of this notification.
|
topic |
The Cloud PubSub topic to which this subscription publishes. Formatted as: '//pubsub.googleapis.com/projects/{project-identifier}/topics/{my-topic}'
|
Notifications
A list of notification subscriptions.Fields | |
---|---|
items[] |
The list of items.
|
kind |
The kind of item this is. For lists of notifications, this is always storage#notifications.
|
Object
An object.Fields | |
---|---|
acl[] |
Access controls on the object.
|
bucket |
The name of the bucket containing this object.
|
cacheControl |
Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.
|
componentCount |
Number of underlying components that make up this object. Components are accumulated by compose operations.
|
contentDisposition |
Content-Disposition of the object data.
|
contentEncoding |
Content-Encoding of the object data.
|
contentLanguage |
Content-Language of the object data.
|
contentType |
Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream.
|
crc32c |
CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.
|
customTime |
A timestamp in RFC 3339 format specified by the user for an object.
|
customerEncryption |
Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
|
customerEncryption.encryptionAlgorithm |
The encryption algorithm.
|
customerEncryption.keySha256 |
SHA256 hash value of the encryption key.
|
etag |
HTTP 1.1 Entity tag for the object.
|
eventBasedHold |
Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), 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 the 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.
|
generation |
The content generation of this object. Used for object versioning.
|
id |
The ID of the object, including the bucket name, object name, and generation number.
|
kind |
The kind of item this is. For objects, this is always storage#object.
|
kmsKeyName |
Not currently supported. Specifying the parameter causes the request to fail with status code 400 - Bad Request.
|
md5Hash |
MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
|
mediaLink |
Media download link.
|
metadata |
User-provided metadata, in key/value pairs.
|
metageneration |
The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object.
|
name |
The name of the object. Required if not specified by URL parameter.
|
owner |
The owner of the object. This will always be the uploader of the object.
|
owner.entity |
The entity, in the form user-userId.
|
owner.entityId |
The ID for the entity.
|
retentionExpirationTime |
A server-determined value that specifies the earliest time that the object's retention period expires. This value is in RFC 3339 format. Note 1: This field is not provided for objects with an active event-based hold, since retention expiration is unknown until the hold is removed. Note 2: This value can be provided even when temporary hold is set (so that the user can reason about policy without having to first unset the temporary hold).
|
selfLink |
The link to this object.
|
size |
Content-Length of the data in bytes.
|
storageClass |
Storage class of the object.
|
temporaryHold |
Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites. A common use case of this flag is regulatory investigations where objects need to be retained while the investigation is ongoing. Note that unlike event-based hold, temporary hold does not impact retention expiration time of an object.
|
timeCreated |
The creation time of the object in RFC 3339 format.
|
timeDeleted |
The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
|
timeStorageClassUpdated |
The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated.
|
updated |
The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration.
|
ObjectAccessControl
An access-control entry.Fields | |
---|---|
bucket |
The name of the bucket.
|
domain |
The domain associated with the entity, if any.
|
email |
The email address associated with the entity, if any.
|
entity |
The entity holding the permission, in one of the following forms: - user-userId - user-email - group-groupId - group-email - domain-domain - project-team-projectId - allUsers - allAuthenticatedUsers Examples: - The user liz@example.com would be user-liz@example.com. - The group example@googlegroups.com would be group-example@googlegroups.com. - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
|
entityId |
The ID for the entity, if any.
|
etag |
HTTP 1.1 Entity tag for the access-control entry.
|
generation |
The content generation of the object, if applied to an object.
|
id |
The ID of the access-control entry.
|
kind |
The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
|
object |
The name of the object, if applied to an object.
|
projectTeam |
The project team associated with the entity, if any.
|
projectTeam.projectNumber |
The project number.
|
projectTeam.team |
The team.
|
role |
The access permission for the entity.
|
selfLink |
The link to this access-control entry.
|
ObjectAccessControls
An access-control list.Fields | |
---|---|
items[] |
The list of items.
|
kind |
The kind of item this is. For lists of object access control entries, this is always storage#objectAccessControls.
|
Objects
A list of objects.Fields | |
---|---|
items[] |
The list of items.
|
kind |
The kind of item this is. For lists of objects, this is always storage#objects.
|
nextPageToken |
The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
|
prefixes[] |
The list of prefixes of objects matching-but-not-listed up to and including the requested delimiter.
|
Policy
A bucket/object IAM policy.Fields | |
---|---|
bindings[] |
An association between a role, which comes with a set of permissions, and members who may assume that role.
|
bindings.condition |
The condition that is associated with this binding. NOTE: an unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.
|
bindings.members[] |
A collection of identifiers for members who may assume the provided role. Recognized identifiers are as follows:
|
bindings.role |
The role to which members belong. Two types of roles are supported: new IAM roles, which grant permissions that do not map directly to those provided by ACLs, and legacy IAM roles, which do map directly to ACL permissions. All roles are of the format roles/storage.specificRole.
The new IAM roles are:
|
etag |
HTTP 1.1 Entity tag for the policy.
|
kind |
The kind of item this is. For policies, this is always storage#policy. This field is ignored on input.
|
resourceId |
The ID of the resource to which this policy belongs. Will be of the form projects//buckets/bucket for buckets, and projects//buckets/bucket/objects/object for objects. A specific generation may be specified by appending #generationNumber to the end of the object name, e.g. projects/_/buckets/my-bucket/objects/data.txt#17. The current generation can be denoted with #0. This field is ignored on input.
|
version |
The IAM policy format version.
|
RewriteResponse
A rewrite response.Fields | |
---|---|
done |
true if the copy is finished; otherwise, false if the copy is in progress. This property is always present in the response.
|
kind |
The kind of item this is.
|
objectSize |
The total size of the object being copied in bytes. This property is always present in the response.
|
resource |
A resource containing the metadata for the copied-to object. This property is present in the response only when copying completes.
|
resource.customerEncryption.encryptionAlgorithm |
The encryption algorithm.
|
resource.customerEncryption.keySha256 |
SHA256 hash value of the encryption key.
|
resource.owner.entity |
The entity, in the form user-userId.
|
resource.owner.entityId |
The ID for the entity.
|
rewriteToken |
A token to use in subsequent requests to continue copying data. This token is present in the response only when there is more data to copy.
|
totalBytesRewritten |
The total bytes written so far, which can be used to provide a waiting user with a progress indicator. This property is always present in the response.
|
ServiceAccount
A subscription to receive Google PubSub notifications.Fields | |
---|---|
email_address |
The ID of the notification.
|
kind |
The kind of item this is. For notifications, this is always storage#notification.
|
TestIamPermissionsResponse
A storage.(buckets|objects).testIamPermissions response.Fields | |
---|---|
kind |
The kind of item this is.
|
permissions[] |
The permissions held by the caller. Permissions are always of the format storage.resource.capability, where resource is one of buckets or objects. The supported permissions are as follows:
|