google_api_storage v0.5.0 GoogleApi.Storage.V1.Api.ObjectAccessControls View Source

API calls for all endpoints tagged ObjectAccessControls.

Link to this section Summary

Link to this section Functions

Link to this function

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

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

Parameters

  • connection (GoogleApi.Storage.V1.Connection): Connection to server
  • bucket (String.t): Name of a bucket.
  • object (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 (String.t): The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
  • optional_params (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.
    • :generation (String.t): If present, selects a specific revision of this object (as opposed to the latest version, the default).
    • :provisionalUserProject (String.t): The project to be billed for this request if the target bucket is requester-pays bucket.
    • :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_object_access_controls_get(connection, bucket, object, entity, optional_params \\ [], opts \\ []) View Source

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

Parameters

  • connection (GoogleApi.Storage.V1.Connection): Connection to server
  • bucket (String.t): Name of a bucket.
  • object (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 (String.t): The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
  • optional_params (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.
    • :generation (String.t): If present, selects a specific revision of this object (as opposed to the latest version, the default).
    • :provisionalUserProject (String.t): The project to be billed for this request if the target bucket is requester-pays bucket.
    • :userProject (String.t): The project to be billed for this request. Required for Requester Pays buckets.

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

Creates a new ACL entry on the specified object.

Parameters

  • connection (GoogleApi.Storage.V1.Connection): Connection to server
  • bucket (String.t): Name of a bucket.
  • object (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 (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.
    • :generation (String.t): If present, selects a specific revision of this object (as opposed to the latest version, the default).
    • :provisionalUserProject (String.t): The project to be billed for this request if the target bucket is requester-pays bucket.
    • :userProject (String.t): The project to be billed for this request. Required for Requester Pays buckets.
    • :body (ObjectAccessControl):

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

Retrieves ACL entries on the specified object.

Parameters

  • connection (GoogleApi.Storage.V1.Connection): Connection to server
  • bucket (String.t): Name of a bucket.
  • object (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 (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.
    • :generation (String.t): If present, selects a specific revision of this object (as opposed to the latest version, the default).
    • :provisionalUserProject (String.t): The project to be billed for this request if the target bucket is requester-pays bucket.
    • :userProject (String.t): The project to be billed for this request. Required for Requester Pays buckets.

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

Patches an ACL entry on the specified object.

Parameters

  • connection (GoogleApi.Storage.V1.Connection): Connection to server
  • bucket (String.t): Name of a bucket.
  • object (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 (String.t): The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
  • optional_params (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.
    • :generation (String.t): If present, selects a specific revision of this object (as opposed to the latest version, the default).
    • :provisionalUserProject (String.t): The project to be billed for this request if the target bucket is requester-pays bucket.
    • :userProject (String.t): The project to be billed for this request. Required for Requester Pays buckets.
    • :body (ObjectAccessControl):

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

Updates an ACL entry on the specified object.

Parameters

  • connection (GoogleApi.Storage.V1.Connection): Connection to server
  • bucket (String.t): Name of a bucket.
  • object (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 (String.t): The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
  • optional_params (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.
    • :generation (String.t): If present, selects a specific revision of this object (as opposed to the latest version, the default).
    • :provisionalUserProject (String.t): The project to be billed for this request if the target bucket is requester-pays bucket.
    • :userProject (String.t): The project to be billed for this request. Required for Requester Pays buckets.
    • :body (ObjectAccessControl):

Returns

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