google_api_storage v0.6.0 GoogleApi.Storage.V1.Api.Buckets View Source

API calls for all endpoints tagged Buckets.

Link to this section Summary

Functions

Retrieves a list of buckets for a given project.

Patches a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.

Tests a set of permissions on the given bucket to see which, if any, are held by the caller.

Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.

Link to this section Functions

Link to this function

storage_buckets_delete(connection, bucket, optional_params \\ [], opts \\ []) View Source

Permanently deletes an empty bucket.

Parameters

  • connection (GoogleApi.Storage.V1.Connection): Connection to server
  • bucket (String.t): Name of a bucket.
  • 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.
    • :ifMetagenerationMatch (String.t): If set, only deletes the bucket if its metageneration matches this value.
    • :ifMetagenerationNotMatch (String.t): If set, only deletes the bucket if its metageneration does not match this value.
    • :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_buckets_get(connection, bucket, optional_params \\ [], opts \\ []) View Source

Returns metadata for the specified bucket.

Parameters

  • connection (GoogleApi.Storage.V1.Connection): Connection to server
  • bucket (String.t): Name of a bucket.
  • 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.
    • :ifMetagenerationMatch (String.t): Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.
    • :ifMetagenerationNotMatch (String.t): Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.
    • :projection (String.t): Set of properties to return. Defaults to noAcl.
    • :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.Bucket{}} on success {:error, info} on failure

Link to this function

storage_buckets_get_iam_policy(connection, bucket, optional_params \\ [], opts \\ []) View Source

Returns an IAM policy for the specified bucket.

Parameters

  • connection (GoogleApi.Storage.V1.Connection): Connection to server
  • bucket (String.t): Name of a bucket.
  • 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.
    • :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.Policy{}} on success {:error, info} on failure

Link to this function

storage_buckets_insert(connection, project, optional_params \\ [], opts \\ []) View Source

Creates a new bucket.

Parameters

  • connection (GoogleApi.Storage.V1.Connection): Connection to server
  • project (String.t): A valid API project identifier.
  • 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.
    • :predefinedAcl (String.t): Apply a predefined set of access controls to this bucket.
    • :predefinedDefaultObjectAcl (String.t): Apply a predefined set of default object access controls to this bucket.
    • :projection (String.t): Set of properties to return. Defaults to noAcl, unless the bucket resource specifies acl or defaultObjectAcl properties, when it defaults to full.
    • :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.
    • :body (Bucket):

Returns

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

Link to this function

storage_buckets_list(connection, project, optional_params \\ [], opts \\ []) View Source

Retrieves a list of buckets for a given project.

Parameters

  • connection (GoogleApi.Storage.V1.Connection): Connection to server
  • project (String.t): A valid API project identifier.
  • 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.
    • :maxResults (integer()): Maximum number of buckets to return in a single response. The service will use this parameter or 1,000 items, whichever is smaller.
    • :pageToken (String.t): A previously-returned page token representing part of the larger set of results to view.
    • :prefix (String.t): Filter results to buckets whose names begin with this prefix.
    • :projection (String.t): Set of properties to return. Defaults to noAcl.
    • :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.

Returns

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

Link to this function

storage_buckets_lock_retention_policy(connection, bucket, if_metageneration_match, optional_params \\ [], opts \\ []) View Source

Locks retention policy on a bucket.

Parameters

  • connection (GoogleApi.Storage.V1.Connection): Connection to server
  • bucket (String.t): Name of a bucket.
  • if_metageneration_match (String.t): Makes the operation conditional on whether bucket's current metageneration matches the given value.
  • 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.
    • :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.Bucket{}} on success {:error, info} on failure

Link to this function

storage_buckets_patch(connection, bucket, optional_params \\ [], opts \\ []) View Source

Patches a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.

Parameters

  • connection (GoogleApi.Storage.V1.Connection): Connection to server
  • bucket (String.t): Name of a bucket.
  • 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.
    • :ifMetagenerationMatch (String.t): Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.
    • :ifMetagenerationNotMatch (String.t): Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.
    • :predefinedAcl (String.t): Apply a predefined set of access controls to this bucket.
    • :predefinedDefaultObjectAcl (String.t): Apply a predefined set of default object access controls to this bucket.
    • :projection (String.t): Set of properties to return. Defaults to full.
    • :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 (Bucket):

Returns

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

Link to this function

storage_buckets_set_iam_policy(connection, bucket, optional_params \\ [], opts \\ []) View Source

Updates an IAM policy for the specified bucket.

Parameters

  • connection (GoogleApi.Storage.V1.Connection): Connection to server
  • bucket (String.t): Name of a bucket.
  • 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.
    • :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 (Policy):

Returns

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

Link to this function

storage_buckets_test_iam_permissions(connection, bucket, permissions, optional_params \\ [], opts \\ []) View Source

Tests a set of permissions on the given bucket to see which, if any, are held by the caller.

Parameters

  • connection (GoogleApi.Storage.V1.Connection): Connection to server
  • bucket (String.t): Name of a bucket.
  • permissions ([String.t]): Permissions to test.
  • 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.
    • :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.TestIamPermissionsResponse{}} on success {:error, info} on failure

Link to this function

storage_buckets_update(connection, bucket, optional_params \\ [], opts \\ []) View Source

Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.

Parameters

  • connection (GoogleApi.Storage.V1.Connection): Connection to server
  • bucket (String.t): Name of a bucket.
  • 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.
    • :ifMetagenerationMatch (String.t): Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.
    • :ifMetagenerationNotMatch (String.t): Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.
    • :predefinedAcl (String.t): Apply a predefined set of access controls to this bucket.
    • :predefinedDefaultObjectAcl (String.t): Apply a predefined set of default object access controls to this bucket.
    • :projection (String.t): Set of properties to return. Defaults to full.
    • :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 (Bucket):

Returns

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