Stores and retrieves potentially large, immutable data objects.
Permanently deletes the ACL entry for the specified entity on the specified bucket.
Name | Data Type | Description |
---|---|---|
entity
|
string |
The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. |
bucket
|
string |
Name of a bucket. |
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
Returns the ACL entry for the specified entity on the specified bucket.
Name | Data Type | Description |
---|---|---|
entity
|
string |
The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. |
bucket
|
string |
Name of a bucket. |
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
BucketAccessControl | ||||||||||||||||||||||||||||||||||||||
Properties
|
Patches an ACL entry on the specified bucket.
Name | Data Type | Description |
---|---|---|
entity
|
string |
The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. |
bucket
|
string |
Name of a bucket. |
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
BucketAccessControl | ||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
BucketAccessControl | ||||||||||||||||||||||||||||||||||||||
Properties
|
Updates an ACL entry on the specified bucket.
Name | Data Type | Description |
---|---|---|
entity
|
string |
The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. |
bucket
|
string |
Name of a bucket. |
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
BucketAccessControl | ||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
BucketAccessControl | ||||||||||||||||||||||||||||||||||||||
Properties
|
Retrieves ACL entries on the specified bucket.
Name | Data Type | Description |
---|---|---|
bucket
|
string |
Name of a bucket. |
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
BucketAccessControls | |||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Creates a new ACL entry on the specified bucket.
Name | Data Type | Description |
---|---|---|
bucket
|
string |
Name of a bucket. |
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
BucketAccessControl | ||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
BucketAccessControl | ||||||||||||||||||||||||||||||||||||||
Properties
|
Tests a set of permissions on the given bucket to see which, if any, are held by the caller.
Name | Data Type | Description |
---|---|---|
bucket
|
string |
Name of a bucket. |
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
permissions
|
array |
Permissions to test. |
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
TestIamPermissionsResponse | |||||||||||
Properties
|
Returns an IAM policy for the specified bucket.
Name | Data Type | Description |
---|---|---|
bucket
|
string |
Name of a bucket. |
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
optionsRequestedPolicyVersion
|
integer Minimum: 1 |
The IAM policy format version to be returned. If the optionsRequestedPolicyVersion is for an older version that doesn't support part of the requested IAM policy, the request fails. |
Name | Data Type | Description | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Policy | ||||||||||||||||||||
Properties
|
Updates an IAM policy for the specified bucket.
Name | Data Type | Description |
---|---|---|
bucket
|
string |
Name of a bucket. |
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
Name | Data Type | Description | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Policy | ||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Policy | ||||||||||||||||||||
Properties
|
Locks retention policy on a bucket.
Name | Data Type | Description |
---|---|---|
bucket
|
string |
Name of a bucket. |
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
ifMetagenerationMatch
|
string |
Makes the operation conditional on whether bucket's current metageneration matches the given value. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Bucket | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Permanently deletes an empty bucket.
Name | Data Type | Description |
---|---|---|
bucket
|
string |
Name of a bucket. |
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
ifMetagenerationNotMatch
|
string |
If set, only deletes the bucket if its metageneration does not match this value. |
ifMetagenerationMatch
|
string |
If set, only deletes the bucket if its metageneration matches this value. |
Returns metadata for the specified bucket.
Name | Data Type | Description |
---|---|---|
bucket
|
string |
Name of a bucket. |
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
projection
|
string Allowed values: - full - noAcl |
Set of properties to return. Defaults to noAcl. |
ifMetagenerationNotMatch
|
string |
Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value. |
ifMetagenerationMatch
|
string |
Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Bucket | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Patches a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.
Name | Data Type | Description |
---|---|---|
bucket
|
string |
Name of a bucket. |
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
projection
|
string Allowed values: - full - noAcl |
Set of properties to return. Defaults to full. |
predefinedDefaultObjectAcl
|
string Allowed values: - authenticatedRead - bucketOwnerFullControl - bucketOwnerRead - private - projectPrivate - publicRead |
Apply a predefined set of default object access controls to this bucket. |
predefinedAcl
|
string Allowed values: - authenticatedRead - private - projectPrivate - publicRead - publicReadWrite |
Apply a predefined set of access controls to this bucket. |
ifMetagenerationNotMatch
|
string |
Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value. |
ifMetagenerationMatch
|
string |
Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Bucket | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Bucket | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.
Name | Data Type | Description |
---|---|---|
bucket
|
string |
Name of a bucket. |
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
projection
|
string Allowed values: - full - noAcl |
Set of properties to return. Defaults to full. |
predefinedDefaultObjectAcl
|
string Allowed values: - authenticatedRead - bucketOwnerFullControl - bucketOwnerRead - private - projectPrivate - publicRead |
Apply a predefined set of default object access controls to this bucket. |
predefinedAcl
|
string Allowed values: - authenticatedRead - private - projectPrivate - publicRead - publicReadWrite |
Apply a predefined set of access controls to this bucket. |
ifMetagenerationNotMatch
|
string |
Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value. |
ifMetagenerationMatch
|
string |
Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Bucket | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Bucket | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Retrieves a list of buckets for a given project.
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
projection
|
string Allowed values: - full - noAcl |
Set of properties to return. Defaults to noAcl. |
prefix
|
string |
Filter results to buckets whose names begin with this prefix. |
pageToken
|
string |
A previously-returned page token representing part of the larger set of results to view. |
maxResults
|
integer Default value: 1000 Minimum: 0 |
Maximum number of buckets to return in a single response. The service will use this parameter or 1,000 items, whichever is smaller. |
project
|
string |
A valid API project identifier. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Buckets | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Creates a new bucket.
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
projection
|
string Allowed values: - full - noAcl |
Set of properties to return. Defaults to noAcl, unless the bucket resource specifies acl or defaultObjectAcl properties, when it defaults to full. |
predefinedDefaultObjectAcl
|
string Allowed values: - authenticatedRead - bucketOwnerFullControl - bucketOwnerRead - private - projectPrivate - publicRead |
Apply a predefined set of default object access controls to this bucket. |
predefinedAcl
|
string Allowed values: - authenticatedRead - private - projectPrivate - publicRead - publicReadWrite |
Apply a predefined set of access controls to this bucket. |
project
|
string |
A valid API project identifier. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Bucket | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Stop watching resources through this channel
Permanently deletes the default object ACL entry for the specified entity on the specified bucket.
Name | Data Type | Description |
---|---|---|
entity
|
string |
The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. |
bucket
|
string |
Name of a bucket. |
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
Returns the default object ACL entry for the specified entity on the specified bucket.
Name | Data Type | Description |
---|---|---|
entity
|
string |
The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. |
bucket
|
string |
Name of a bucket. |
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ObjectAccessControl | ||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Patches a default object ACL entry on the specified bucket.
Name | Data Type | Description |
---|---|---|
entity
|
string |
The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. |
bucket
|
string |
Name of a bucket. |
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ObjectAccessControl | ||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ObjectAccessControl | ||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Updates a default object ACL entry on the specified bucket.
Name | Data Type | Description |
---|---|---|
entity
|
string |
The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. |
bucket
|
string |
Name of a bucket. |
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ObjectAccessControl | ||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ObjectAccessControl | ||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Retrieves default object ACL entries on the specified bucket.
Name | Data Type | Description |
---|---|---|
bucket
|
string |
Name of a bucket. |
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
ifMetagenerationNotMatch
|
string |
If present, only return default ACL listing if the bucket's current metageneration does not match the given value. |
ifMetagenerationMatch
|
string |
If present, only return default ACL listing if the bucket's current metageneration matches this value. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ObjectAccessControls | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Creates a new default object ACL entry on the specified bucket.
Name | Data Type | Description |
---|---|---|
bucket
|
string |
Name of a bucket. |
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ObjectAccessControl | ||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ObjectAccessControl | ||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Permanently deletes a notification subscription.
Name | Data Type | Description |
---|---|---|
notification
|
string |
ID of the notification to delete. |
bucket
|
string |
The parent bucket of the notification. |
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
View a notification configuration.
Name | Data Type | Description |
---|---|---|
notification
|
string |
Notification ID |
bucket
|
string |
The parent bucket of the notification. |
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Notification | ||||||||||||||||||||||||||||||||
Properties
|
Retrieves a list of notification subscriptions for a given bucket.
Name | Data Type | Description |
---|---|---|
bucket
|
string |
Name of a Google Cloud Storage bucket. |
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Notifications | |||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Creates a notification subscription for a given bucket.
Name | Data Type | Description |
---|---|---|
bucket
|
string |
The parent bucket of the notification. |
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Notification | ||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Notification | ||||||||||||||||||||||||||||||||
Properties
|
Permanently deletes the ACL entry for the specified entity on the specified object.
Name | Data Type | Description |
---|---|---|
entity
|
string |
The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. |
object
|
string |
Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. |
bucket
|
string |
Name of a bucket. |
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
generation
|
string |
If present, selects a specific revision of this object (as opposed to the latest version, the default). |
Returns the ACL entry for the specified entity on the specified object.
Name | Data Type | Description |
---|---|---|
entity
|
string |
The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. |
object
|
string |
Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. |
bucket
|
string |
Name of a bucket. |
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
generation
|
string |
If present, selects a specific revision of this object (as opposed to the latest version, the default). |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ObjectAccessControl | ||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Patches an ACL entry on the specified object.
Name | Data Type | Description |
---|---|---|
entity
|
string |
The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. |
object
|
string |
Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. |
bucket
|
string |
Name of a bucket. |
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
generation
|
string |
If present, selects a specific revision of this object (as opposed to the latest version, the default). |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ObjectAccessControl | ||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ObjectAccessControl | ||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Updates an ACL entry on the specified object.
Name | Data Type | Description |
---|---|---|
entity
|
string |
The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. |
object
|
string |
Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. |
bucket
|
string |
Name of a bucket. |
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
generation
|
string |
If present, selects a specific revision of this object (as opposed to the latest version, the default). |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ObjectAccessControl | ||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ObjectAccessControl | ||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Retrieves ACL entries on the specified object.
Name | Data Type | Description |
---|---|---|
object
|
string |
Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. |
bucket
|
string |
Name of a bucket. |
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
generation
|
string |
If present, selects a specific revision of this object (as opposed to the latest version, the default). |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ObjectAccessControls | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Creates a new ACL entry on the specified object.
Name | Data Type | Description |
---|---|---|
object
|
string |
Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. |
bucket
|
string |
Name of a bucket. |
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
generation
|
string |
If present, selects a specific revision of this object (as opposed to the latest version, the default). |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ObjectAccessControl | ||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ObjectAccessControl | ||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Watch for changes on all objects in a bucket.
Name | Data Type | Description |
---|---|---|
bucket
|
string |
Name of the bucket in which to look for objects. |
Name | Data Type | Description |
---|---|---|
versions
|
boolean |
If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning. |
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
projection
|
string Allowed values: - full - noAcl |
Set of properties to return. Defaults to noAcl. |
prefix
|
string |
Filter results to objects whose names begin with this prefix. |
pageToken
|
string |
A previously-returned page token representing part of the larger set of results to view. |
maxResults
|
integer Default value: 1000 Minimum: 0 |
Maximum number of items plus prefixes to return in a single page of responses. As duplicate prefixes are omitted, fewer total results may be returned than requested. The service will use this parameter or 1,000 items, whichever is smaller. |
includeTrailingDelimiter
|
boolean |
If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes. |
delimiter
|
string |
Returns results in a directory-like mode. items will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter will have their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Channel | |||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Channel | |||||||||||||||||||||||||||||||||||
Properties
|
Tests a set of permissions on the given object to see which, if any, are held by the caller.
Name | Data Type | Description |
---|---|---|
object
|
string |
Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. |
bucket
|
string |
Name of the bucket in which the object resides. |
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
generation
|
string |
If present, selects a specific revision of this object (as opposed to the latest version, the default). |
permissions
|
array |
Permissions to test. |
Name | Data Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
TestIamPermissionsResponse | |||||||||||
Properties
|
Returns an IAM policy for the specified object.
Name | Data Type | Description |
---|---|---|
object
|
string |
Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. |
bucket
|
string |
Name of the bucket in which the object resides. |
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
generation
|
string |
If present, selects a specific revision of this object (as opposed to the latest version, the default). |
Name | Data Type | Description | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Policy | ||||||||||||||||||||
Properties
|
Updates an IAM policy for the specified object.
Name | Data Type | Description |
---|---|---|
object
|
string |
Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. |
bucket
|
string |
Name of the bucket in which the object resides. |
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
generation
|
string |
If present, selects a specific revision of this object (as opposed to the latest version, the default). |
Name | Data Type | Description | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Policy | ||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Policy | ||||||||||||||||||||
Properties
|
Deletes an object and its metadata. Deletions are permanent if versioning is not enabled for the bucket, or if the generation parameter is used.
Name | Data Type | Description |
---|---|---|
object
|
string |
Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. |
bucket
|
string |
Name of the bucket in which the object resides. |
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
ifMetagenerationNotMatch
|
string |
Makes the operation conditional on whether the object's current metageneration does not match the given value. |
ifMetagenerationMatch
|
string |
Makes the operation conditional on whether the object's current metageneration matches the given value. |
ifGenerationNotMatch
|
string |
Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object. |
ifGenerationMatch
|
string |
Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object. |
generation
|
string |
If present, permanently deletes a specific revision of this object (as opposed to the latest version, the default). |
Retrieves an object or its metadata.
Name | Data Type | Description |
---|---|---|
object
|
string |
Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. |
bucket
|
string |
Name of the bucket in which the object resides. |
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
projection
|
string Allowed values: - full - noAcl |
Set of properties to return. Defaults to noAcl. |
ifMetagenerationNotMatch
|
string |
Makes the operation conditional on whether the object's current metageneration does not match the given value. |
ifMetagenerationMatch
|
string |
Makes the operation conditional on whether the object's current metageneration matches the given value. |
ifGenerationNotMatch
|
string |
Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object. |
ifGenerationMatch
|
string |
Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object. |
generation
|
string |
If present, selects a specific revision of this object (as opposed to the latest version, the default). |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Patches an object's metadata.
Name | Data Type | Description |
---|---|---|
object
|
string |
Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. |
bucket
|
string |
Name of the bucket in which the object resides. |
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request, for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
projection
|
string Allowed values: - full - noAcl |
Set of properties to return. Defaults to full. |
predefinedAcl
|
string Allowed values: - authenticatedRead - bucketOwnerFullControl - bucketOwnerRead - private - projectPrivate - publicRead |
Apply a predefined set of access controls to this object. |
ifMetagenerationNotMatch
|
string |
Makes the operation conditional on whether the object's current metageneration does not match the given value. |
ifMetagenerationMatch
|
string |
Makes the operation conditional on whether the object's current metageneration matches the given value. |
ifGenerationNotMatch
|
string |
Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object. |
ifGenerationMatch
|
string |
Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object. |
generation
|
string |
If present, selects a specific revision of this object (as opposed to the latest version, the default). |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Updates an object's metadata.
Name | Data Type | Description |
---|---|---|
object
|
string |
Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. |
bucket
|
string |
Name of the bucket in which the object resides. |
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
projection
|
string Allowed values: - full - noAcl |
Set of properties to return. Defaults to full. |
predefinedAcl
|
string Allowed values: - authenticatedRead - bucketOwnerFullControl - bucketOwnerRead - private - projectPrivate - publicRead |
Apply a predefined set of access controls to this object. |
ifMetagenerationNotMatch
|
string |
Makes the operation conditional on whether the object's current metageneration does not match the given value. |
ifMetagenerationMatch
|
string |
Makes the operation conditional on whether the object's current metageneration matches the given value. |
ifGenerationNotMatch
|
string |
Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object. |
ifGenerationMatch
|
string |
Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object. |
generation
|
string |
If present, selects a specific revision of this object (as opposed to the latest version, the default). |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Retrieves a list of objects matching the criteria.
Name | Data Type | Description |
---|---|---|
bucket
|
string |
Name of the bucket in which to look for objects. |
Name | Data Type | Description |
---|---|---|
versions
|
boolean |
If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning. |
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
projection
|
string Allowed values: - full - noAcl |
Set of properties to return. Defaults to noAcl. |
prefix
|
string |
Filter results to objects whose names begin with this prefix. |
pageToken
|
string |
A previously-returned page token representing part of the larger set of results to view. |
maxResults
|
integer Default value: 1000 Minimum: 0 |
Maximum number of items plus prefixes to return in a single page of responses. As duplicate prefixes are omitted, fewer total results may be returned than requested. The service will use this parameter or 1,000 items, whichever is smaller. |
includeTrailingDelimiter
|
boolean |
If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes. |
delimiter
|
string |
Returns results in a directory-like mode. items will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter will have their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted. |
Name | Data Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Objects | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Stores a new object and metadata.
Name | Data Type | Description |
---|---|---|
bucket
|
string |
Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any. |
Name | Data Type | Description |
---|---|---|
userProject
|
string |
The project to be billed for this request. Required for Requester Pays buckets. |
provisionalUserProject
|
string |
The project to be billed for this request if the target bucket is requester-pays bucket. |
projection
|
string Allowed values: - full - noAcl |
Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full. |
predefinedAcl
|
string Allowed values: - authenticatedRead - bucketOwnerFullControl - bucketOwnerRead - private - projectPrivate - publicRead |
Apply a predefined set of access controls to this object. |
name
|
string |
Name of the object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. |
kmsKeyName
|
string |
Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any. |
ifMetagenerationNotMatch
|
string |
Makes the operation conditional on whether the object's current metageneration does not match the given value. |
ifMetagenerationMatch
|
string |
Makes the operation conditional on whether the object's current metageneration matches the given value. |
ifGenerationNotMatch
|
string |
Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object. |
ifGenerationMatch
|
string |
Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object. |
contentEncoding
|
string |
If set, sets the contentEncoding property of the final object to this value. Setting this parameter is equivalent to setting the contentEncoding metadata property. This can be useful when uploading an object with uploadType=media to indicate the encoding of the content being uploaded. |
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
Name | Data Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|