Googly.CloudStorage.DefaultObjectAccessControls (googly_cloud_storage v0.1.0)

Copy Markdown View Source

Endpoints for the DefaultObjectAccessControls resource.

Summary

Functions

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

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

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

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

insert(bucket, opts \\ [])

Creates a new default object ACL entry on the specified bucket.

list(bucket, opts \\ [])

Retrieves default object ACL entries on the specified bucket.

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

Patches a default object ACL entry on the specified bucket.

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

Updates a default object 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 default object 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.ObjectAccessControl.t()} | {:error, term()}

Returns the default object 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.ObjectAccessControl{}} on success
  • {:error, %Googly.CloudStorage.Error{}} on failure

insert(bucket, opts \\ [])

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

Creates a new default object 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.ObjectAccessControl.t()) -

Returns

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

list(bucket, opts \\ [])

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

Retrieves default object 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.
    • if_metageneration_match (type: String.t()) - If present, only return default ACL listing if the bucket's current metageneration matches this value.
    • if_metageneration_not_match (type: String.t()) - If present, only return default ACL listing if the bucket's current metageneration does not match the given value.
    • user_project (type: String.t()) - The project to be billed for this request. Required for Requester Pays buckets.

Returns

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

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

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

Patches a default object 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.ObjectAccessControl.t()) -

Returns

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

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

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

Updates a default object 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.ObjectAccessControl.t()) -

Returns

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