google_api_storage

v0.1.0

google_api_storage v0.1.0 GoogleApi.Storage.V1.Api.BucketAccessControls View Source

API calls for all endpoints tagged BucketAccessControls.

Link to this section Summary

Functions

storage_bucket_access_controls_delete(connection, bucket, entity, opts \\ [])

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

storage_bucket_access_controls_get(connection, bucket, entity, opts \\ [])

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

storage_bucket_access_controls_insert(connection, bucket, opts \\ [])

Creates a new ACL entry on the specified bucket

storage_bucket_access_controls_list(connection, bucket, opts \\ [])

Retrieves ACL entries on the specified bucket

storage_bucket_access_controls_patch(connection, bucket, entity, opts \\ [])

Patches an ACL entry on the specified bucket

storage_bucket_access_controls_update(connection, bucket, entity, opts \\ [])

Updates an ACL entry on the specified bucket

Link to this section Functions

Link to this function storage_bucket_access_controls_delete(connection, bucket, entity, opts \\ []) View Source 
storage_bucket_access_controls_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

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

Parameters

  • connection (GoogleApi.Storage.V1.Connection): Connection to server
  • bucket (String.t): Name of a bucket.
  • entity (String.t): The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :userProject (String.t): The project to be billed for this request. Required for Requester Pays buckets.

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function storage_bucket_access_controls_get(connection, bucket, entity, opts \\ []) View Source 
storage_bucket_access_controls_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.Storage.V1.Model.BucketAccessControl.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

  • connection (GoogleApi.Storage.V1.Connection): Connection to server
  • bucket (String.t): Name of a bucket.
  • entity (String.t): The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :userProject (String.t): The project to be billed for this request. Required for Requester Pays buckets.

Returns

{:ok, %GoogleApi.Storage.V1.Model.BucketAccessControl{}} on success {:error, info} on failure

Link to this function storage_bucket_access_controls_insert(connection, bucket, opts \\ []) View Source 
storage_bucket_access_controls_insert(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.Storage.V1.Model.BucketAccessControl.t()}
  | {:error, Tesla.Env.t()}

Creates a new ACL entry on the specified bucket.

Parameters

  • connection (GoogleApi.Storage.V1.Connection): Connection to server
  • bucket (String.t): Name of a bucket.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :userProject (String.t): The project to be billed for this request. Required for Requester Pays buckets.
    • :body (BucketAccessControl):

Returns

{:ok, %GoogleApi.Storage.V1.Model.BucketAccessControl{}} on success {:error, info} on failure

Link to this function storage_bucket_access_controls_list(connection, bucket, opts \\ []) View Source 
storage_bucket_access_controls_list(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.Storage.V1.Model.BucketAccessControls.t()}
  | {:error, Tesla.Env.t()}

Retrieves ACL entries on the specified bucket.

Parameters

  • connection (GoogleApi.Storage.V1.Connection): Connection to server
  • bucket (String.t): Name of a bucket.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :userProject (String.t): The project to be billed for this request. Required for Requester Pays buckets.

Returns

{:ok, %GoogleApi.Storage.V1.Model.BucketAccessControls{}} on success {:error, info} on failure

Link to this function storage_bucket_access_controls_patch(connection, bucket, entity, opts \\ []) View Source 
storage_bucket_access_controls_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.Storage.V1.Model.BucketAccessControl.t()}
  | {:error, Tesla.Env.t()}

Patches an ACL entry on the specified bucket.

Parameters

  • connection (GoogleApi.Storage.V1.Connection): Connection to server
  • bucket (String.t): Name of a bucket.
  • entity (String.t): The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :userProject (String.t): The project to be billed for this request. Required for Requester Pays buckets.
    • :body (BucketAccessControl):

Returns

{:ok, %GoogleApi.Storage.V1.Model.BucketAccessControl{}} on success {:error, info} on failure

Link to this function storage_bucket_access_controls_update(connection, bucket, entity, opts \\ []) View Source 
storage_bucket_access_controls_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.Storage.V1.Model.BucketAccessControl.t()}
  | {:error, Tesla.Env.t()}

Updates an ACL entry on the specified bucket.

Parameters

  • connection (GoogleApi.Storage.V1.Connection): Connection to server
  • bucket (String.t): Name of a bucket.
  • entity (String.t): The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String.t): Data format for the response.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (String.t): Deprecated. Please use quotaUser instead.
    • :userProject (String.t): The project to be billed for this request. Required for Requester Pays buckets.
    • :body (BucketAccessControl):

Returns

{:ok, %GoogleApi.Storage.V1.Model.BucketAccessControl{}} on success {:error, info} on failure