Googly.CloudStorage.BucketAccessControls (googly_cloud_storage v0.1.0)

Endpoints for the BucketAccessControls resource.

Summary

Functions

delete(bucket, entity, opts \\ [])

Permanently deletes the ACL entry for the specified entity on the specified bucket.

get(bucket, entity, opts \\ [])

Returns the ACL entry for the specified entity on the specified bucket.

insert(bucket, opts \\ [])

Creates a new ACL entry on the specified bucket.

list(bucket, opts \\ [])

Retrieves ACL entries on the specified bucket.

patch(bucket, entity, opts \\ [])

Patches an ACL entry on the specified bucket.

update(bucket, entity, opts \\ [])

Updates an ACL entry on the specified bucket.

Functions

delete(bucket, entity, opts \\ [])

@spec delete(String.t(), String.t(), keyword()) ::
  {:ok, Req.Response.t()} | {:error, term()}

Permanently deletes the ACL entry for the specified entity on the specified bucket.

Parameters

bucket (type: String.t()) - Name of a bucket.
entity (type: String.t()) - The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
opts (type: keyword()) - Query and call options (:token, plus any of the below)
- 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.
- pretty_print (type: boolean()) - Returns response with indentations and line breaks.
- quota_user (type: String.t()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- upload_type (type: String.t()) - Upload protocol for media (e.g. "media", "multipart", "resumable").
- user_ip (type: String.t()) - Deprecated. Please use quotaUser instead.
- user_project (type: String.t()) - The project to be billed for this request. Required for Requester Pays buckets.

Returns

{:ok, Req.Response.t()} on success
{:error, %Googly.CloudStorage.Error{}} on failure

get(bucket, entity, opts \\ [])

@spec get(String.t(), String.t(), keyword()) ::
  {:ok, Googly.CloudStorage.Model.BucketAccessControl.t()} | {:error, term()}

Returns the ACL entry for the specified entity on the specified bucket.

Parameters

bucket (type: String.t()) - Name of a bucket.
entity (type: String.t()) - The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
opts (type: keyword()) - Query and call options (:token, plus any of the below)
- 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.
- pretty_print (type: boolean()) - Returns response with indentations and line breaks.
- quota_user (type: String.t()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- upload_type (type: String.t()) - Upload protocol for media (e.g. "media", "multipart", "resumable").
- user_ip (type: String.t()) - Deprecated. Please use quotaUser instead.
- user_project (type: String.t()) - The project to be billed for this request. Required for Requester Pays buckets.

Returns

{:ok, %Googly.CloudStorage.Model.BucketAccessControl{}} on success
{:error, %Googly.CloudStorage.Error{}} on failure

insert(bucket, opts \\ [])

@spec insert(
  String.t(),
  keyword()
) :: {:ok, Googly.CloudStorage.Model.BucketAccessControl.t()} | {:error, term()}

Creates a new ACL entry on the specified bucket.

Parameters

bucket (type: String.t()) - Name of a bucket.
opts (type: keyword()) - Query and call options (:token, plus any of the below)
- 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.
- pretty_print (type: boolean()) - Returns response with indentations and line breaks.
- quota_user (type: String.t()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- upload_type (type: String.t()) - Upload protocol for media (e.g. "media", "multipart", "resumable").
- user_ip (type: String.t()) - Deprecated. Please use quotaUser instead.
- user_project (type: String.t()) - The project to be billed for this request. Required for Requester Pays buckets.
- body (type: Googly.CloudStorage.Model.BucketAccessControl.t()) -

Returns

{:ok, %Googly.CloudStorage.Model.BucketAccessControl{}} on success
{:error, %Googly.CloudStorage.Error{}} on failure

list(bucket, opts \\ [])

@spec list(
  String.t(),
  keyword()
) ::
  {:ok, Googly.CloudStorage.Model.BucketAccessControls.t()} | {:error, term()}

Retrieves ACL entries on the specified bucket.

Parameters

bucket (type: String.t()) - Name of a bucket.
opts (type: keyword()) - Query and call options (:token, plus any of the below)
- 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.
- pretty_print (type: boolean()) - Returns response with indentations and line breaks.
- quota_user (type: String.t()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- upload_type (type: String.t()) - Upload protocol for media (e.g. "media", "multipart", "resumable").
- user_ip (type: String.t()) - Deprecated. Please use quotaUser instead.
- user_project (type: String.t()) - The project to be billed for this request. Required for Requester Pays buckets.

Returns

{:ok, %Googly.CloudStorage.Model.BucketAccessControls{}} on success
{:error, %Googly.CloudStorage.Error{}} on failure

patch(bucket, entity, opts \\ [])

@spec patch(String.t(), String.t(), keyword()) ::
  {:ok, Googly.CloudStorage.Model.BucketAccessControl.t()} | {:error, term()}

Patches an ACL entry on the specified bucket.

Parameters

bucket (type: String.t()) - Name of a bucket.
entity (type: String.t()) - The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
opts (type: keyword()) - Query and call options (:token, plus any of the below)
- 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.
- pretty_print (type: boolean()) - Returns response with indentations and line breaks.
- quota_user (type: String.t()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- upload_type (type: String.t()) - Upload protocol for media (e.g. "media", "multipart", "resumable").
- user_ip (type: String.t()) - Deprecated. Please use quotaUser instead.
- user_project (type: String.t()) - The project to be billed for this request. Required for Requester Pays buckets.
- body (type: Googly.CloudStorage.Model.BucketAccessControl.t()) -

Returns

{:ok, %Googly.CloudStorage.Model.BucketAccessControl{}} on success
{:error, %Googly.CloudStorage.Error{}} on failure

update(bucket, entity, opts \\ [])

@spec update(String.t(), String.t(), keyword()) ::
  {:ok, Googly.CloudStorage.Model.BucketAccessControl.t()} | {:error, term()}

Updates an ACL entry on the specified bucket.

Parameters

bucket (type: String.t()) - Name of a bucket.
entity (type: String.t()) - The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
opts (type: keyword()) - Query and call options (:token, plus any of the below)
- 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.
- pretty_print (type: boolean()) - Returns response with indentations and line breaks.
- quota_user (type: String.t()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- upload_type (type: String.t()) - Upload protocol for media (e.g. "media", "multipart", "resumable").
- user_ip (type: String.t()) - Deprecated. Please use quotaUser instead.
- user_project (type: String.t()) - The project to be billed for this request. Required for Requester Pays buckets.
- body (type: Googly.CloudStorage.Model.BucketAccessControl.t()) -

Returns

{:ok, %Googly.CloudStorage.Model.BucketAccessControl{}} on success
{:error, %Googly.CloudStorage.Error{}} on failure