Liking cljdoc? Tell your friends :D

happygapi.storage.buckets

Cloud Storage JSON API: buckets. Stores and retrieves potentially large, immutable data objects. See: https://developers.google.com/storage/docs/json_api/api/reference/rest/v1/buckets

Cloud Storage JSON API: buckets.
Stores and retrieves potentially large, immutable data objects.
See: https://developers.google.com/storage/docs/json_api/api/reference/rest/v1/buckets
raw docstring

delete$clj

(delete$ auth parameters)

https://developers.google.com/storage/docs/json_api/api/reference/rest/v1/buckets/delete

Required parameters: bucket

Optional parameters: ifMetagenerationMatch, ifMetagenerationNotMatch, provisionalUserProject, userProject

Permanently deletes an empty bucket.

https://developers.google.com/storage/docs/json_api/api/reference/rest/v1/buckets/delete

Required parameters: bucket

Optional parameters: ifMetagenerationMatch, ifMetagenerationNotMatch, provisionalUserProject, userProject

Permanently deletes an empty bucket.
sourceraw docstring

get$clj

(get$ auth parameters)

https://developers.google.com/storage/docs/json_api/api/reference/rest/v1/buckets/get

Required parameters: bucket

Optional parameters: ifMetagenerationMatch, ifMetagenerationNotMatch, projection, provisionalUserProject, userProject

Returns metadata for the specified bucket.

https://developers.google.com/storage/docs/json_api/api/reference/rest/v1/buckets/get

Required parameters: bucket

Optional parameters: ifMetagenerationMatch, ifMetagenerationNotMatch, projection, provisionalUserProject, userProject

Returns metadata for the specified bucket.
sourceraw docstring

getIamPolicy$clj

(getIamPolicy$ auth parameters)

https://developers.google.com/storage/docs/json_api/api/reference/rest/v1/buckets/getIamPolicy

Required parameters: bucket

Optional parameters: optionsRequestedPolicyVersion, provisionalUserProject, userProject

Returns an IAM policy for the specified bucket.

https://developers.google.com/storage/docs/json_api/api/reference/rest/v1/buckets/getIamPolicy

Required parameters: bucket

Optional parameters: optionsRequestedPolicyVersion, provisionalUserProject, userProject

Returns an IAM policy for the specified bucket.
sourceraw docstring

insert$clj

(insert$ auth parameters body)

https://developers.google.com/storage/docs/json_api/api/reference/rest/v1/buckets/insert

Required parameters: project

Optional parameters: predefinedAcl, predefinedDefaultObjectAcl, projection, provisionalUserProject, userProject

Body:

{:cors [{:maxAgeSeconds integer, :method [string], :origin [string], :responseHeader [string]}], :labels {}, :rpo string, :customPlacementConfig {:dataLocations [string]}, :storageClass string, :timeCreated string, :updated string, :name string, :billing {:requesterPays boolean}, :selfLink string, :etag string, :lifecycle {:rule [{:action {:storageClass string, :type string}, :condition {:customTimeBefore string, :age integer, :createdBefore string, :daysSinceNoncurrentTime integer, :numNewerVersions integer, :matchesStorageClass [string], :matchesPattern string, :noncurrentTimeBefore string, :isLive boolean, :daysSinceCustomTime integer}}]}, :logging {:logBucket string, :logObjectPrefix string}, :projectNumber string, :encryption {:defaultKmsKeyName string}, :defaultObjectAcl [{:role string, :email string, :generation string, :projectTeam {:projectNumber string, :team string}, :selfLink string, :etag string, :id string, :kind string, :domain string, :entity string, :entityId string, :object string, :bucket string}], :satisfiesPZS boolean, :id string, :kind string, :retentionPolicy {:effectiveTime string, :isLocked boolean, :retentionPeriod string}, :website {:mainPageSuffix string, :notFoundPage string}, :acl [{:role string, :email string, :projectTeam {:projectNumber string, :team string}, :selfLink string, :etag string, :id string, :kind string, :domain string, :entity string, :entityId string, :bucket string}], :locationType string, :iamConfiguration {:bucketPolicyOnly {:enabled boolean, :lockedTime string}, :uniformBucketLevelAccess {:enabled boolean, :lockedTime string}, :publicAccessPrevention string}, :defaultEventBasedHold boolean, :versioning {:enabled boolean}, :location string, :owner {:entity string, :entityId string}, :metageneration string}

Creates a new bucket.

https://developers.google.com/storage/docs/json_api/api/reference/rest/v1/buckets/insert

Required parameters: project

Optional parameters: predefinedAcl, predefinedDefaultObjectAcl, projection, provisionalUserProject, userProject

Body: 

{:cors [{:maxAgeSeconds integer,
         :method [string],
         :origin [string],
         :responseHeader [string]}],
 :labels {},
 :rpo string,
 :customPlacementConfig {:dataLocations [string]},
 :storageClass string,
 :timeCreated string,
 :updated string,
 :name string,
 :billing {:requesterPays boolean},
 :selfLink string,
 :etag string,
 :lifecycle {:rule [{:action {:storageClass string, :type string},
                     :condition {:customTimeBefore string,
                                 :age integer,
                                 :createdBefore string,
                                 :daysSinceNoncurrentTime integer,
                                 :numNewerVersions integer,
                                 :matchesStorageClass [string],
                                 :matchesPattern string,
                                 :noncurrentTimeBefore string,
                                 :isLive boolean,
                                 :daysSinceCustomTime integer}}]},
 :logging {:logBucket string, :logObjectPrefix string},
 :projectNumber string,
 :encryption {:defaultKmsKeyName string},
 :defaultObjectAcl [{:role string,
                     :email string,
                     :generation string,
                     :projectTeam {:projectNumber string,
                                   :team string},
                     :selfLink string,
                     :etag string,
                     :id string,
                     :kind string,
                     :domain string,
                     :entity string,
                     :entityId string,
                     :object string,
                     :bucket string}],
 :satisfiesPZS boolean,
 :id string,
 :kind string,
 :retentionPolicy {:effectiveTime string,
                   :isLocked boolean,
                   :retentionPeriod string},
 :website {:mainPageSuffix string, :notFoundPage string},
 :acl [{:role string,
        :email string,
        :projectTeam {:projectNumber string, :team string},
        :selfLink string,
        :etag string,
        :id string,
        :kind string,
        :domain string,
        :entity string,
        :entityId string,
        :bucket string}],
 :locationType string,
 :iamConfiguration {:bucketPolicyOnly {:enabled boolean,
                                       :lockedTime string},
                    :uniformBucketLevelAccess {:enabled boolean,
                                               :lockedTime string},
                    :publicAccessPrevention string},
 :defaultEventBasedHold boolean,
 :versioning {:enabled boolean},
 :location string,
 :owner {:entity string, :entityId string},
 :metageneration string}

Creates a new bucket.
sourceraw docstring

list$clj

(list$ auth parameters)

https://developers.google.com/storage/docs/json_api/api/reference/rest/v1/buckets/list

Required parameters: project

Optional parameters: maxResults, pageToken, prefix, projection, provisionalUserProject, userProject

Retrieves a list of buckets for a given project.

https://developers.google.com/storage/docs/json_api/api/reference/rest/v1/buckets/list

Required parameters: project

Optional parameters: maxResults, pageToken, prefix, projection, provisionalUserProject, userProject

Retrieves a list of buckets for a given project.
sourceraw docstring

lockRetentionPolicy$clj

(lockRetentionPolicy$ auth parameters)

https://developers.google.com/storage/docs/json_api/api/reference/rest/v1/buckets/lockRetentionPolicy

Required parameters: bucket, ifMetagenerationMatch

Optional parameters: provisionalUserProject, userProject

Locks retention policy on a bucket.

https://developers.google.com/storage/docs/json_api/api/reference/rest/v1/buckets/lockRetentionPolicy

Required parameters: bucket, ifMetagenerationMatch

Optional parameters: provisionalUserProject, userProject

Locks retention policy on a bucket.
sourceraw docstring

patch$clj

(patch$ auth parameters body)

https://developers.google.com/storage/docs/json_api/api/reference/rest/v1/buckets/patch

Required parameters: bucket

Optional parameters: ifMetagenerationMatch, ifMetagenerationNotMatch, predefinedAcl, predefinedDefaultObjectAcl, projection, provisionalUserProject, userProject

Body:

{:cors [{:maxAgeSeconds integer, :method [string], :origin [string], :responseHeader [string]}], :labels {}, :rpo string, :customPlacementConfig {:dataLocations [string]}, :storageClass string, :timeCreated string, :updated string, :name string, :billing {:requesterPays boolean}, :selfLink string, :etag string, :lifecycle {:rule [{:action {:storageClass string, :type string}, :condition {:customTimeBefore string, :age integer, :createdBefore string, :daysSinceNoncurrentTime integer, :numNewerVersions integer, :matchesStorageClass [string], :matchesPattern string, :noncurrentTimeBefore string, :isLive boolean, :daysSinceCustomTime integer}}]}, :logging {:logBucket string, :logObjectPrefix string}, :projectNumber string, :encryption {:defaultKmsKeyName string}, :defaultObjectAcl [{:role string, :email string, :generation string, :projectTeam {:projectNumber string, :team string}, :selfLink string, :etag string, :id string, :kind string, :domain string, :entity string, :entityId string, :object string, :bucket string}], :satisfiesPZS boolean, :id string, :kind string, :retentionPolicy {:effectiveTime string, :isLocked boolean, :retentionPeriod string}, :website {:mainPageSuffix string, :notFoundPage string}, :acl [{:role string, :email string, :projectTeam {:projectNumber string, :team string}, :selfLink string, :etag string, :id string, :kind string, :domain string, :entity string, :entityId string, :bucket string}], :locationType string, :iamConfiguration {:bucketPolicyOnly {:enabled boolean, :lockedTime string}, :uniformBucketLevelAccess {:enabled boolean, :lockedTime string}, :publicAccessPrevention string}, :defaultEventBasedHold boolean, :versioning {:enabled boolean}, :location string, :owner {:entity string, :entityId string}, :metageneration string}

Patches a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.

https://developers.google.com/storage/docs/json_api/api/reference/rest/v1/buckets/patch

Required parameters: bucket

Optional parameters: ifMetagenerationMatch, ifMetagenerationNotMatch, predefinedAcl, predefinedDefaultObjectAcl, projection, provisionalUserProject, userProject

Body: 

{:cors [{:maxAgeSeconds integer,
         :method [string],
         :origin [string],
         :responseHeader [string]}],
 :labels {},
 :rpo string,
 :customPlacementConfig {:dataLocations [string]},
 :storageClass string,
 :timeCreated string,
 :updated string,
 :name string,
 :billing {:requesterPays boolean},
 :selfLink string,
 :etag string,
 :lifecycle {:rule [{:action {:storageClass string, :type string},
                     :condition {:customTimeBefore string,
                                 :age integer,
                                 :createdBefore string,
                                 :daysSinceNoncurrentTime integer,
                                 :numNewerVersions integer,
                                 :matchesStorageClass [string],
                                 :matchesPattern string,
                                 :noncurrentTimeBefore string,
                                 :isLive boolean,
                                 :daysSinceCustomTime integer}}]},
 :logging {:logBucket string, :logObjectPrefix string},
 :projectNumber string,
 :encryption {:defaultKmsKeyName string},
 :defaultObjectAcl [{:role string,
                     :email string,
                     :generation string,
                     :projectTeam {:projectNumber string,
                                   :team string},
                     :selfLink string,
                     :etag string,
                     :id string,
                     :kind string,
                     :domain string,
                     :entity string,
                     :entityId string,
                     :object string,
                     :bucket string}],
 :satisfiesPZS boolean,
 :id string,
 :kind string,
 :retentionPolicy {:effectiveTime string,
                   :isLocked boolean,
                   :retentionPeriod string},
 :website {:mainPageSuffix string, :notFoundPage string},
 :acl [{:role string,
        :email string,
        :projectTeam {:projectNumber string, :team string},
        :selfLink string,
        :etag string,
        :id string,
        :kind string,
        :domain string,
        :entity string,
        :entityId string,
        :bucket string}],
 :locationType string,
 :iamConfiguration {:bucketPolicyOnly {:enabled boolean,
                                       :lockedTime string},
                    :uniformBucketLevelAccess {:enabled boolean,
                                               :lockedTime string},
                    :publicAccessPrevention string},
 :defaultEventBasedHold boolean,
 :versioning {:enabled boolean},
 :location string,
 :owner {:entity string, :entityId string},
 :metageneration string}

Patches a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.
sourceraw docstring

setIamPolicy$clj

(setIamPolicy$ auth parameters body)

https://developers.google.com/storage/docs/json_api/api/reference/rest/v1/buckets/setIamPolicy

Required parameters: bucket

Optional parameters: provisionalUserProject, userProject

Body:

{:bindings [{:condition {:description string, :expression string, :location string, :title string}, :members [string], :role string}], :etag string, :kind string, :resourceId string, :version integer}

Updates an IAM policy for the specified bucket.

https://developers.google.com/storage/docs/json_api/api/reference/rest/v1/buckets/setIamPolicy

Required parameters: bucket

Optional parameters: provisionalUserProject, userProject

Body: 

{:bindings [{:condition {:description string,
                         :expression string,
                         :location string,
                         :title string},
             :members [string],
             :role string}],
 :etag string,
 :kind string,
 :resourceId string,
 :version integer}

Updates an IAM policy for the specified bucket.
sourceraw docstring

testIamPermissions$clj

(testIamPermissions$ auth parameters)

https://developers.google.com/storage/docs/json_api/api/reference/rest/v1/buckets/testIamPermissions

Required parameters: bucket, permissions

Optional parameters: provisionalUserProject, userProject

Tests a set of permissions on the given bucket to see which, if any, are held by the caller.

https://developers.google.com/storage/docs/json_api/api/reference/rest/v1/buckets/testIamPermissions

Required parameters: bucket, permissions

Optional parameters: provisionalUserProject, userProject

Tests a set of permissions on the given bucket to see which, if any, are held by the caller.
sourceraw docstring

update$clj

(update$ auth parameters body)

https://developers.google.com/storage/docs/json_api/api/reference/rest/v1/buckets/update

Required parameters: bucket

Optional parameters: ifMetagenerationMatch, ifMetagenerationNotMatch, predefinedAcl, predefinedDefaultObjectAcl, projection, provisionalUserProject, userProject

Body:

{:cors [{:maxAgeSeconds integer, :method [string], :origin [string], :responseHeader [string]}], :labels {}, :rpo string, :customPlacementConfig {:dataLocations [string]}, :storageClass string, :timeCreated string, :updated string, :name string, :billing {:requesterPays boolean}, :selfLink string, :etag string, :lifecycle {:rule [{:action {:storageClass string, :type string}, :condition {:customTimeBefore string, :age integer, :createdBefore string, :daysSinceNoncurrentTime integer, :numNewerVersions integer, :matchesStorageClass [string], :matchesPattern string, :noncurrentTimeBefore string, :isLive boolean, :daysSinceCustomTime integer}}]}, :logging {:logBucket string, :logObjectPrefix string}, :projectNumber string, :encryption {:defaultKmsKeyName string}, :defaultObjectAcl [{:role string, :email string, :generation string, :projectTeam {:projectNumber string, :team string}, :selfLink string, :etag string, :id string, :kind string, :domain string, :entity string, :entityId string, :object string, :bucket string}], :satisfiesPZS boolean, :id string, :kind string, :retentionPolicy {:effectiveTime string, :isLocked boolean, :retentionPeriod string}, :website {:mainPageSuffix string, :notFoundPage string}, :acl [{:role string, :email string, :projectTeam {:projectNumber string, :team string}, :selfLink string, :etag string, :id string, :kind string, :domain string, :entity string, :entityId string, :bucket string}], :locationType string, :iamConfiguration {:bucketPolicyOnly {:enabled boolean, :lockedTime string}, :uniformBucketLevelAccess {:enabled boolean, :lockedTime string}, :publicAccessPrevention string}, :defaultEventBasedHold boolean, :versioning {:enabled boolean}, :location string, :owner {:entity string, :entityId string}, :metageneration string}

Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.

https://developers.google.com/storage/docs/json_api/api/reference/rest/v1/buckets/update

Required parameters: bucket

Optional parameters: ifMetagenerationMatch, ifMetagenerationNotMatch, predefinedAcl, predefinedDefaultObjectAcl, projection, provisionalUserProject, userProject

Body: 

{:cors [{:maxAgeSeconds integer,
         :method [string],
         :origin [string],
         :responseHeader [string]}],
 :labels {},
 :rpo string,
 :customPlacementConfig {:dataLocations [string]},
 :storageClass string,
 :timeCreated string,
 :updated string,
 :name string,
 :billing {:requesterPays boolean},
 :selfLink string,
 :etag string,
 :lifecycle {:rule [{:action {:storageClass string, :type string},
                     :condition {:customTimeBefore string,
                                 :age integer,
                                 :createdBefore string,
                                 :daysSinceNoncurrentTime integer,
                                 :numNewerVersions integer,
                                 :matchesStorageClass [string],
                                 :matchesPattern string,
                                 :noncurrentTimeBefore string,
                                 :isLive boolean,
                                 :daysSinceCustomTime integer}}]},
 :logging {:logBucket string, :logObjectPrefix string},
 :projectNumber string,
 :encryption {:defaultKmsKeyName string},
 :defaultObjectAcl [{:role string,
                     :email string,
                     :generation string,
                     :projectTeam {:projectNumber string,
                                   :team string},
                     :selfLink string,
                     :etag string,
                     :id string,
                     :kind string,
                     :domain string,
                     :entity string,
                     :entityId string,
                     :object string,
                     :bucket string}],
 :satisfiesPZS boolean,
 :id string,
 :kind string,
 :retentionPolicy {:effectiveTime string,
                   :isLocked boolean,
                   :retentionPeriod string},
 :website {:mainPageSuffix string, :notFoundPage string},
 :acl [{:role string,
        :email string,
        :projectTeam {:projectNumber string, :team string},
        :selfLink string,
        :etag string,
        :id string,
        :kind string,
        :domain string,
        :entity string,
        :entityId string,
        :bucket string}],
 :locationType string,
 :iamConfiguration {:bucketPolicyOnly {:enabled boolean,
                                       :lockedTime string},
                    :uniformBucketLevelAccess {:enabled boolean,
                                               :lockedTime string},
                    :publicAccessPrevention string},
 :defaultEventBasedHold boolean,
 :versioning {:enabled boolean},
 :location string,
 :owner {:entity string, :entityId string},
 :metageneration string}

Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close