google_api_storage v0.29.0

GoogleApi.Storage.V1.Api.ObjectAccessControls (google_api_storage v0.29.0) View Source

API calls for all endpoints tagged ObjectAccessControls.

Link to this section Summary

Functions

storage_object_access_controls_delete(connection, bucket, object, entity, optional_params \\ [], opts \\ [])

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

storage_object_access_controls_get(connection, bucket, object, entity, optional_params \\ [], opts \\ [])

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

storage_object_access_controls_insert(connection, bucket, object, optional_params \\ [], opts \\ [])

Creates a new ACL entry on the specified object.

storage_object_access_controls_list(connection, bucket, object, optional_params \\ [], opts \\ [])

Retrieves ACL entries on the specified object.

storage_object_access_controls_patch(connection, bucket, object, entity, optional_params \\ [], opts \\ [])

Patches an ACL entry on the specified object.

storage_object_access_controls_update(connection, bucket, object, entity, optional_params \\ [], opts \\ [])

Updates an ACL entry on the specified object.

Link to this section Functions

Link to this function

storage_object_access_controls_delete(connection, bucket, object, entity, optional_params \\ [], opts \\ [])

View Source

Specs

storage_object_access_controls_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Storage.V1.Connection.t) - Connection to server
  • bucket (type: String.t) - Name of a bucket.
  • object (type: String.t) - Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
  • entity (type: String.t) - The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
  • 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.
    • :generation (type: String.t) - If present, selects a specific revision of this object (as opposed to the latest version, the default).
    • :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
Link to this function

storage_object_access_controls_get(connection, bucket, object, entity, optional_params \\ [], opts \\ [])

View Source

Specs

storage_object_access_controls_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Storage.V1.Model.ObjectAccessControl.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Storage.V1.Connection.t) - Connection to server
  • bucket (type: String.t) - Name of a bucket.
  • object (type: String.t) - Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
  • entity (type: String.t) - The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
  • 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.
    • :generation (type: String.t) - If present, selects a specific revision of this object (as opposed to the latest version, the default).
    • :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.ObjectAccessControl{}} on success
  • {:error, info} on failure
Link to this function

storage_object_access_controls_insert(connection, bucket, object, optional_params \\ [], opts \\ [])

View Source

Specs

storage_object_access_controls_insert(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Storage.V1.Model.ObjectAccessControl.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a new ACL entry on the specified object.

Parameters

  • connection (type: GoogleApi.Storage.V1.Connection.t) - Connection to server
  • bucket (type: String.t) - Name of a bucket.
  • object (type: String.t) - Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
  • 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.
    • :generation (type: String.t) - If present, selects a specific revision of this object (as opposed to the latest version, the default).
    • :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.ObjectAccessControl.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Storage.V1.Model.ObjectAccessControl{}} on success
  • {:error, info} on failure
Link to this function

storage_object_access_controls_list(connection, bucket, object, optional_params \\ [], opts \\ [])

View Source

Specs

storage_object_access_controls_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Storage.V1.Model.ObjectAccessControls.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves ACL entries on the specified object.

Parameters

  • connection (type: GoogleApi.Storage.V1.Connection.t) - Connection to server
  • bucket (type: String.t) - Name of a bucket.
  • object (type: String.t) - Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
  • 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.
    • :generation (type: String.t) - If present, selects a specific revision of this object (as opposed to the latest version, the default).
    • :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.ObjectAccessControls{}} on success
  • {:error, info} on failure
Link to this function

storage_object_access_controls_patch(connection, bucket, object, entity, optional_params \\ [], opts \\ [])

View Source

Specs

storage_object_access_controls_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Storage.V1.Model.ObjectAccessControl.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Patches an ACL entry on the specified object.

Parameters

  • connection (type: GoogleApi.Storage.V1.Connection.t) - Connection to server
  • bucket (type: String.t) - Name of a bucket.
  • object (type: String.t) - Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
  • entity (type: String.t) - The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
  • 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.
    • :generation (type: String.t) - If present, selects a specific revision of this object (as opposed to the latest version, the default).
    • :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.ObjectAccessControl.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Storage.V1.Model.ObjectAccessControl{}} on success
  • {:error, info} on failure
Link to this function

storage_object_access_controls_update(connection, bucket, object, entity, optional_params \\ [], opts \\ [])

View Source

Specs

storage_object_access_controls_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Storage.V1.Model.ObjectAccessControl.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates an ACL entry on the specified object.

Parameters

  • connection (type: GoogleApi.Storage.V1.Connection.t) - Connection to server
  • bucket (type: String.t) - Name of a bucket.
  • object (type: String.t) - Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
  • entity (type: String.t) - The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
  • 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.
    • :generation (type: String.t) - If present, selects a specific revision of this object (as opposed to the latest version, the default).
    • :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.ObjectAccessControl.t) -
  • opts (type: keyword()) - Call options

Returns

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