google_api_storage v0.11.0 GoogleApi.Storage.V1.Api.Buckets View Source
API calls for all endpoints tagged Buckets
.
Link to this section Summary
Functions
Permanently deletes an empty bucket.
Returns metadata for the specified bucket.
Returns an IAM policy for the specified bucket.
Creates a new bucket.
Retrieves a list of buckets for a given project.
Locks retention policy on a bucket.
Patches a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.
Updates an IAM policy for the specified bucket.
Tests a set of permissions on the given bucket to see which, if any, are held by the caller.
Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.
Link to this section Functions
storage_buckets_delete(connection, bucket, optional_params \\ [], opts \\ [])
View Sourcestorage_buckets_delete(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
Permanently deletes an empty bucket.
Parameters
connection
(type:GoogleApi.Storage.V1.Connection.t
) - Connection to serverbucket
(type:String.t
) - Name of a bucket.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:ifMetagenerationMatch
(type:String.t
) - If set, only deletes the bucket if its metageneration matches this value.:ifMetagenerationNotMatch
(type:String.t
) - If set, only deletes the bucket if its metageneration does not match this value.:provisionalUserProject
(type:String.t
) - The project to be billed for this request if the target bucket is requester-pays bucket.:userProject
(type:String.t
) - The project to be billed for this request. Required for Requester Pays buckets.
opts
(type:keyword()
) - Call options
Returns
{:ok, %{}}
on success{:error, info}
on failure
storage_buckets_get(connection, bucket, optional_params \\ [], opts \\ [])
View Sourcestorage_buckets_get(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Storage.V1.Model.Bucket.t()} | {:error, Tesla.Env.t()}
Returns metadata for the specified bucket.
Parameters
connection
(type:GoogleApi.Storage.V1.Connection.t
) - Connection to serverbucket
(type:String.t
) - Name of a bucket.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:ifMetagenerationMatch
(type:String.t
) - Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.:ifMetagenerationNotMatch
(type:String.t
) - Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.:projection
(type:String.t
) - Set of properties to return. Defaults to noAcl.:provisionalUserProject
(type:String.t
) - The project to be billed for this request if the target bucket is requester-pays bucket.:userProject
(type:String.t
) - The project to be billed for this request. Required for Requester Pays buckets.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Storage.V1.Model.Bucket{}}
on success{:error, info}
on failure
storage_buckets_get_iam_policy(connection, bucket, optional_params \\ [], opts \\ [])
View Sourcestorage_buckets_get_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Storage.V1.Model.Policy.t()} | {:error, Tesla.Env.t()}
Returns an IAM policy for the specified bucket.
Parameters
connection
(type:GoogleApi.Storage.V1.Connection.t
) - Connection to serverbucket
(type:String.t
) - Name of a bucket.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:provisionalUserProject
(type:String.t
) - The project to be billed for this request if the target bucket is requester-pays bucket.:userProject
(type:String.t
) - The project to be billed for this request. Required for Requester Pays buckets.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Storage.V1.Model.Policy{}}
on success{:error, info}
on failure
storage_buckets_insert(connection, project, optional_params \\ [], opts \\ [])
View Sourcestorage_buckets_insert(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Storage.V1.Model.Bucket.t()} | {:error, Tesla.Env.t()}
Creates a new bucket.
Parameters
connection
(type:GoogleApi.Storage.V1.Connection.t
) - Connection to serverproject
(type:String.t
) - A valid API project identifier.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:predefinedAcl
(type:String.t
) - Apply a predefined set of access controls to this bucket.:predefinedDefaultObjectAcl
(type:String.t
) - Apply a predefined set of default object access controls to this bucket.:projection
(type:String.t
) - Set of properties to return. Defaults to noAcl, unless the bucket resource specifies acl or defaultObjectAcl properties, when it defaults to full.:provisionalUserProject
(type:String.t
) - The project to be billed for this request if the target bucket is requester-pays bucket.:userProject
(type:String.t
) - The project to be billed for this request.:body
(type:GoogleApi.Storage.V1.Model.Bucket.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Storage.V1.Model.Bucket{}}
on success{:error, info}
on failure
storage_buckets_list(connection, project, optional_params \\ [], opts \\ [])
View Sourcestorage_buckets_list(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Storage.V1.Model.Buckets.t()} | {:error, Tesla.Env.t()}
Retrieves a list of buckets for a given project.
Parameters
connection
(type:GoogleApi.Storage.V1.Connection.t
) - Connection to serverproject
(type:String.t
) - A valid API project identifier.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:maxResults
(type:integer()
) - Maximum number of buckets to return in a single response. The service will use this parameter or 1,000 items, whichever is smaller.:pageToken
(type:String.t
) - A previously-returned page token representing part of the larger set of results to view.:prefix
(type:String.t
) - Filter results to buckets whose names begin with this prefix.:projection
(type:String.t
) - Set of properties to return. Defaults to noAcl.:provisionalUserProject
(type:String.t
) - The project to be billed for this request if the target bucket is requester-pays bucket.:userProject
(type:String.t
) - The project to be billed for this request.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Storage.V1.Model.Buckets{}}
on success{:error, info}
on failure
storage_buckets_lock_retention_policy(connection, bucket, if_metageneration_match, optional_params \\ [], opts \\ [])
View Sourcestorage_buckets_lock_retention_policy( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Storage.V1.Model.Bucket.t()} | {:error, Tesla.Env.t()}
Locks retention policy on a bucket.
Parameters
connection
(type:GoogleApi.Storage.V1.Connection.t
) - Connection to serverbucket
(type:String.t
) - Name of a bucket.if_metageneration_match
(type:String.t
) - Makes the operation conditional on whether bucket's current metageneration matches the given value.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:provisionalUserProject
(type:String.t
) - The project to be billed for this request if the target bucket is requester-pays bucket.:userProject
(type:String.t
) - The project to be billed for this request. Required for Requester Pays buckets.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Storage.V1.Model.Bucket{}}
on success{:error, info}
on failure
storage_buckets_patch(connection, bucket, optional_params \\ [], opts \\ [])
View Sourcestorage_buckets_patch(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Storage.V1.Model.Bucket.t()} | {:error, Tesla.Env.t()}
Patches a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.
Parameters
connection
(type:GoogleApi.Storage.V1.Connection.t
) - Connection to serverbucket
(type:String.t
) - Name of a bucket.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:ifMetagenerationMatch
(type:String.t
) - Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.:ifMetagenerationNotMatch
(type:String.t
) - Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.:predefinedAcl
(type:String.t
) - Apply a predefined set of access controls to this bucket.:predefinedDefaultObjectAcl
(type:String.t
) - Apply a predefined set of default object access controls to this bucket.:projection
(type:String.t
) - Set of properties to return. Defaults to full.:provisionalUserProject
(type:String.t
) - The project to be billed for this request if the target bucket is requester-pays bucket.:userProject
(type:String.t
) - The project to be billed for this request. Required for Requester Pays buckets.:body
(type:GoogleApi.Storage.V1.Model.Bucket.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Storage.V1.Model.Bucket{}}
on success{:error, info}
on failure
storage_buckets_set_iam_policy(connection, bucket, optional_params \\ [], opts \\ [])
View Sourcestorage_buckets_set_iam_policy( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Storage.V1.Model.Policy.t()} | {:error, Tesla.Env.t()}
Updates an IAM policy for the specified bucket.
Parameters
connection
(type:GoogleApi.Storage.V1.Connection.t
) - Connection to serverbucket
(type:String.t
) - Name of a bucket.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:provisionalUserProject
(type:String.t
) - The project to be billed for this request if the target bucket is requester-pays bucket.:userProject
(type:String.t
) - The project to be billed for this request. Required for Requester Pays buckets.:body
(type:GoogleApi.Storage.V1.Model.Policy.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Storage.V1.Model.Policy{}}
on success{:error, info}
on failure
storage_buckets_test_iam_permissions(connection, bucket, permissions, optional_params \\ [], opts \\ [])
View Sourcestorage_buckets_test_iam_permissions( Tesla.Env.client(), String.t(), [String.t()], keyword(), keyword() ) :: {:ok, GoogleApi.Storage.V1.Model.TestIamPermissionsResponse.t()} | {:error, Tesla.Env.t()}
Tests a set of permissions on the given bucket to see which, if any, are held by the caller.
Parameters
connection
(type:GoogleApi.Storage.V1.Connection.t
) - Connection to serverbucket
(type:String.t
) - Name of a bucket.permissions
(type:list(String.t)
) - Permissions to test.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:provisionalUserProject
(type:String.t
) - The project to be billed for this request if the target bucket is requester-pays bucket.:userProject
(type:String.t
) - The project to be billed for this request. Required for Requester Pays buckets.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Storage.V1.Model.TestIamPermissionsResponse{}}
on success{:error, info}
on failure
storage_buckets_update(connection, bucket, optional_params \\ [], opts \\ [])
View Sourcestorage_buckets_update(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Storage.V1.Model.Bucket.t()} | {:error, Tesla.Env.t()}
Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.
Parameters
connection
(type:GoogleApi.Storage.V1.Connection.t
) - Connection to serverbucket
(type:String.t
) - Name of a bucket.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:ifMetagenerationMatch
(type:String.t
) - Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.:ifMetagenerationNotMatch
(type:String.t
) - Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.:predefinedAcl
(type:String.t
) - Apply a predefined set of access controls to this bucket.:predefinedDefaultObjectAcl
(type:String.t
) - Apply a predefined set of default object access controls to this bucket.:projection
(type:String.t
) - Set of properties to return. Defaults to full.:provisionalUserProject
(type:String.t
) - The project to be billed for this request if the target bucket is requester-pays bucket.:userProject
(type:String.t
) - The project to be billed for this request. Required for Requester Pays buckets.:body
(type:GoogleApi.Storage.V1.Model.Bucket.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Storage.V1.Model.Bucket{}}
on success{:error, info}
on failure