GoogleApi.FirebaseStorage.V1beta.Api.Projects (google_api_firebase_storage v0.5.0)

View Source

API calls for all endpoints tagged Projects.

Summary

Functions

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

Links a Google Cloud Storage bucket to a Firebase project.

firebasestorage_projects_buckets_get(connection, name, optional_params \\ [], opts \\ [])

Gets a single linked storage bucket.

firebasestorage_projects_buckets_list(connection, parent, optional_params \\ [], opts \\ [])

Lists the linked storage buckets for a project.

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

Unlinks a linked Google Cloud Storage bucket from a Firebase project.

firebasestorage_projects_default_bucket_create(connection, parent, optional_params \\ [], opts \\ [])

Creates a Spark tier-eligible Cloud Storage bucket and links it to your Firebase project. If the default bucket already exists, this method will re-link it to your Firebase project. See https://firebase.google.com/pricing for pricing details.

firebasestorage_projects_delete_default_bucket(connection, name, optional_params \\ [], opts \\ [])

Unlinks and deletes the default bucket.

firebasestorage_projects_get_default_bucket(connection, name, optional_params \\ [], opts \\ [])

Gets the default bucket.

Functions

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

@spec firebasestorage_projects_buckets_add_firebase(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.FirebaseStorage.V1beta.Model.Bucket.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Links a Google Cloud Storage bucket to a Firebase project.

Parameters

  • connection (type: GoogleApi.FirebaseStorage.V1beta.Connection.t) - Connection to server
  • bucket (type: String.t) - Required. Resource name of the bucket, mirrors the ID of the underlying Google Cloud Storage bucket, projects/{project_id_or_number}/buckets/{bucket_id}.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.FirebaseStorage.V1beta.Model.AddFirebaseRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.FirebaseStorage.V1beta.Model.Bucket{}} on success
  • {:error, info} on failure

firebasestorage_projects_buckets_get(connection, name, optional_params \\ [], opts \\ [])

@spec firebasestorage_projects_buckets_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.FirebaseStorage.V1beta.Model.Bucket.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets a single linked storage bucket.

Parameters

  • connection (type: GoogleApi.FirebaseStorage.V1beta.Connection.t) - Connection to server
  • name (type: String.t) - Required. Resource name of the bucket, mirrors the ID of the underlying Google Cloud Storage bucket, projects/{project_id_or_number}/buckets/{bucket_id}.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.FirebaseStorage.V1beta.Model.Bucket{}} on success
  • {:error, info} on failure

firebasestorage_projects_buckets_list(connection, parent, optional_params \\ [], opts \\ [])

@spec firebasestorage_projects_buckets_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.FirebaseStorage.V1beta.Model.ListBucketsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists the linked storage buckets for a project.

Parameters

  • connection (type: GoogleApi.FirebaseStorage.V1beta.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Resource name of the parent Firebase project, projects/{project_id_or_number}.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - The maximum number of buckets to return. If not set, the server will use a reasonable default.
    • :pageToken (type: String.t) - A page token, received from a previous ListBuckets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListBuckets must match the call that provided the page token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.FirebaseStorage.V1beta.Model.ListBucketsResponse{}} on success
  • {:error, info} on failure

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

@spec firebasestorage_projects_buckets_remove_firebase(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.FirebaseStorage.V1beta.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Unlinks a linked Google Cloud Storage bucket from a Firebase project.

Parameters

  • connection (type: GoogleApi.FirebaseStorage.V1beta.Connection.t) - Connection to server
  • bucket (type: String.t) - Required. Resource name of the bucket, mirrors the ID of the underlying Google Cloud Storage bucket, projects/{project_id_or_number}/buckets/{bucket_id}.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.FirebaseStorage.V1beta.Model.RemoveFirebaseRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.FirebaseStorage.V1beta.Model.Empty{}} on success
  • {:error, info} on failure

firebasestorage_projects_default_bucket_create(connection, parent, optional_params \\ [], opts \\ [])

@spec firebasestorage_projects_default_bucket_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.FirebaseStorage.V1beta.Model.DefaultBucket.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a Spark tier-eligible Cloud Storage bucket and links it to your Firebase project. If the default bucket already exists, this method will re-link it to your Firebase project. See https://firebase.google.com/pricing for pricing details.

Parameters

  • connection (type: GoogleApi.FirebaseStorage.V1beta.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent resource where the default bucket will be created, projects/{project_id_or_number}.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.FirebaseStorage.V1beta.Model.DefaultBucket.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.FirebaseStorage.V1beta.Model.DefaultBucket{}} on success
  • {:error, info} on failure

firebasestorage_projects_delete_default_bucket(connection, name, optional_params \\ [], opts \\ [])

@spec firebasestorage_projects_delete_default_bucket(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.FirebaseStorage.V1beta.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Unlinks and deletes the default bucket.

Parameters

  • connection (type: GoogleApi.FirebaseStorage.V1beta.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the default bucket to delete, projects/{project_id_or_number}/defaultBucket.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.FirebaseStorage.V1beta.Model.Empty{}} on success
  • {:error, info} on failure

firebasestorage_projects_get_default_bucket(connection, name, optional_params \\ [], opts \\ [])

@spec firebasestorage_projects_get_default_bucket(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.FirebaseStorage.V1beta.Model.DefaultBucket.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the default bucket.

Parameters

  • connection (type: GoogleApi.FirebaseStorage.V1beta.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the default bucket to retrieve, projects/{project_id_or_number}/defaultBucket.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.FirebaseStorage.V1beta.Model.DefaultBucket{}} on success
  • {:error, info} on failure