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

API calls for all endpoints tagged Folders.

Summary

Functions

storage_folders_delete(connection, bucket, folder, optional_params \\ [], opts \\ [])

Permanently deletes a folder. Only applicable to buckets with hierarchical namespace enabled.

storage_folders_get(connection, bucket, folder, optional_params \\ [], opts \\ [])

Returns metadata for the specified folder. Only applicable to buckets with hierarchical namespace enabled.

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

Creates a new folder. Only applicable to buckets with hierarchical namespace enabled.

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

Retrieves a list of folders matching the criteria. Only applicable to buckets with hierarchical namespace enabled.

storage_folders_rename(connection, bucket, source_folder, destination_folder, optional_params \\ [], opts \\ [])

Renames a source folder to a destination folder. Only applicable to buckets with hierarchical namespace enabled.

Functions

storage_folders_delete(connection, bucket, folder, optional_params \\ [], opts \\ [])

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

Permanently deletes a folder. Only applicable to buckets with hierarchical namespace enabled.

Parameters

  • connection (type: GoogleApi.Storage.V1.Connection.t) - Connection to server
  • bucket (type: String.t) - Name of the bucket in which the folder resides.
  • folder (type: String.t) - Name of a 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.
    • :ifMetagenerationMatch (type: String.t) - If set, only deletes the folder if its metageneration matches this value.
    • :ifMetagenerationNotMatch (type: String.t) - If set, only deletes the folder if its metageneration does not match this value.
  • opts (type: keyword()) - Call options

Returns

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

storage_folders_get(connection, bucket, folder, optional_params \\ [], opts \\ [])

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

Returns metadata for the specified folder. Only applicable to buckets with hierarchical namespace enabled.

Parameters

  • connection (type: GoogleApi.Storage.V1.Connection.t) - Connection to server
  • bucket (type: String.t) - Name of the bucket in which the folder resides.
  • folder (type: String.t) - Name of a 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.
    • :ifMetagenerationMatch (type: String.t) - Makes the return of the folder metadata conditional on whether the folder's current metageneration matches the given value.
    • :ifMetagenerationNotMatch (type: String.t) - Makes the return of the folder metadata conditional on whether the folder's current metageneration does not match the given value.
  • opts (type: keyword()) - Call options

Returns

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

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

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

Creates a new folder. Only applicable to buckets with hierarchical namespace enabled.

Parameters

  • connection (type: GoogleApi.Storage.V1.Connection.t) - Connection to server
  • bucket (type: String.t) - Name of the bucket in which the folder resides.
  • 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.
    • :recursive (type: boolean()) - If true, any parent folder which doesn’t exist will be created automatically.
    • :body (type: GoogleApi.Storage.V1.Model.Folder.t) -
  • opts (type: keyword()) - Call options

Returns

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

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

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

Retrieves a list of folders matching the criteria. Only applicable to buckets with hierarchical namespace enabled.

Parameters

  • connection (type: GoogleApi.Storage.V1.Connection.t) - Connection to server
  • bucket (type: String.t) - Name of the bucket in which to look for folders.
  • 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.
    • :delimiter (type: String.t) - Returns results in a directory-like mode. The only supported value is '/'. If set, items will only contain folders that either exactly match the prefix, or are one level below the prefix.
    • :endOffset (type: String.t) - Filter results to folders whose names are lexicographically before endOffset. If startOffset is also set, the folders listed will have names between startOffset (inclusive) and endOffset (exclusive).
    • :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) - Filter results to folders whose paths begin with this prefix. If set, the value must either be an empty string or end with a '/'.
    • :startOffset (type: String.t) - Filter results to folders whose names are lexicographically equal to or after startOffset. If endOffset is also set, the folders listed will have names between startOffset (inclusive) and endOffset (exclusive).
  • opts (type: keyword()) - Call options

Returns

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

storage_folders_rename(connection, bucket, source_folder, destination_folder, optional_params \\ [], opts \\ [])

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

Renames a source folder to a destination folder. Only applicable to buckets with hierarchical namespace enabled.

Parameters

  • connection (type: GoogleApi.Storage.V1.Connection.t) - Connection to server
  • bucket (type: String.t) - Name of the bucket in which the folders are in.
  • source_folder (type: String.t) - Name of the source folder.
  • destination_folder (type: String.t) - Name of the destination 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.
    • :ifSourceMetagenerationMatch (type: String.t) - Makes the operation conditional on whether the source object's current metageneration matches the given value.
    • :ifSourceMetagenerationNotMatch (type: String.t) - Makes the operation conditional on whether the source object's current metageneration does not match the given value.
  • opts (type: keyword()) - Call options

Returns

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