View Source GoogleApi.Storage.V1.Api.ManagedFolders (google_api_storage v0.46.0)

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

Permanently deletes a managed folder.

Parameters

connection (type: GoogleApi.Storage.V1.Connection.t) - Connection to server
bucket (type: String.t) - Name of the bucket containing the managed folder.
managed_folder (type: String.t) - The managed folder name/path.
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.
- :uploadType (type: String.t) - Upload protocol for media (e.g. "media", "multipart", "resumable").
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :allowNonEmpty (type: boolean()) - Allows the deletion of a managed folder even if it is not empty. A managed folder is empty if there are no objects or managed folders that it applies to. Callers must have storage.managedFolders.setIamPolicy permission.
- :ifMetagenerationMatch (type: String.t) - If set, only deletes the managed folder if its metageneration matches this value.
- :ifMetagenerationNotMatch (type: String.t) - If set, only deletes the managed folder if its metageneration does not match this value.
opts (type: keyword()) - Call options

Returns

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

storage_managed_folders_get(connection, bucket, managed_folder, optional_params \\ [], opts \\ [])

@spec storage_managed_folders_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Storage.V1.Model.ManagedFolder.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns metadata of the specified managed folder.

Parameters

connection (type: GoogleApi.Storage.V1.Connection.t) - Connection to server
bucket (type: String.t) - Name of the bucket containing the managed folder.
managed_folder (type: String.t) - The managed folder name/path.
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.
- :uploadType (type: String.t) - Upload protocol for media (e.g. "media", "multipart", "resumable").
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :ifMetagenerationMatch (type: String.t) - Makes the return of the managed folder metadata conditional on whether the managed folder's current metageneration matches the given value.
- :ifMetagenerationNotMatch (type: String.t) - Makes the return of the managed folder metadata conditional on whether the managed folder's current metageneration does not match the given value.
opts (type: keyword()) - Call options

Returns

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

storage_managed_folders_get_iam_policy(connection, bucket, managed_folder, optional_params \\ [], opts \\ [])

@spec storage_managed_folders_get_iam_policy(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Storage.V1.Model.Policy.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns an IAM policy for the specified managed folder.

Parameters

connection (type: GoogleApi.Storage.V1.Connection.t) - Connection to server
bucket (type: String.t) - Name of the bucket containing the managed folder.
managed_folder (type: String.t) - The managed folder name/path.
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.
- :uploadType (type: String.t) - Upload protocol for media (e.g. "media", "multipart", "resumable").
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :optionsRequestedPolicyVersion (type: integer()) - The IAM policy format version to be returned. If the optionsRequestedPolicyVersion is for an older version that doesn't support part of the requested IAM policy, the request fails.
- :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.Policy{}} on success
{:error, info} on failure

storage_managed_folders_insert(connection, bucket, optional_params \\ [], opts \\ [])

@spec storage_managed_folders_insert(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Storage.V1.Model.ManagedFolder.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a new managed folder.

Parameters

connection (type: GoogleApi.Storage.V1.Connection.t) - Connection to server
bucket (type: String.t) - Name of the bucket containing the managed folder.
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.
- :uploadType (type: String.t) - Upload protocol for media (e.g. "media", "multipart", "resumable").
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :body (type: GoogleApi.Storage.V1.Model.ManagedFolder.t) -
opts (type: keyword()) - Call options

Returns

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

storage_managed_folders_list(connection, bucket, optional_params \\ [], opts \\ [])

@spec storage_managed_folders_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Storage.V1.Model.ManagedFolders.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists managed folders in the given bucket.

Parameters

connection (type: GoogleApi.Storage.V1.Connection.t) - Connection to server
bucket (type: String.t) - Name of the bucket containing the managed folder.
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.
- :uploadType (type: String.t) - Upload protocol for media (e.g. "media", "multipart", "resumable").
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :pageSize (type: integer()) - Maximum number of items to return in a single page of responses.
- :pageToken (type: String.t) - A previously-returned page token representing part of the larger set of results to view.
- :prefix (type: String.t) - The managed folder name/path prefix to filter the output list of results.
opts (type: keyword()) - Call options

Returns

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

storage_managed_folders_set_iam_policy(connection, bucket, managed_folder, optional_params \\ [], opts \\ [])

@spec storage_managed_folders_set_iam_policy(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Storage.V1.Model.Policy.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates an IAM policy for the specified managed folder.

Parameters

connection (type: GoogleApi.Storage.V1.Connection.t) - Connection to server
bucket (type: String.t) - Name of the bucket containing the managed folder.
managed_folder (type: String.t) - The managed folder name/path.
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.
- :uploadType (type: String.t) - Upload protocol for media (e.g. "media", "multipart", "resumable").
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :userProject (type: String.t) - The project to be billed for this request. Required for Requester Pays buckets.
- :body (type: GoogleApi.Storage.V1.Model.Policy.t) -
opts (type: keyword()) - Call options

Returns

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

storage_managed_folders_test_iam_permissions(connection, bucket, managed_folder, permissions, optional_params \\ [], opts \\ [])

@spec storage_managed_folders_test_iam_permissions(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  [String.t()],
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Storage.V1.Model.TestIamPermissionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

connection (type: GoogleApi.Storage.V1.Connection.t) - Connection to server
bucket (type: String.t) - Name of the bucket containing the managed folder.
managed_folder (type: String.t) - The managed folder name/path.
permissions (type: list(String.t)) - Permissions to test.
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.
- :uploadType (type: String.t) - Upload protocol for media (e.g. "media", "multipart", "resumable").
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :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.TestIamPermissionsResponse{}} on success
{:error, info} on failure