google_api_fusion_tables v0.4.0 GoogleApi.FusionTables.V2.Api.Task View Source

API calls for all endpoints tagged Task.

Link to this section Summary

Functions

fusiontables_task_delete(connection, table_id, task_id, optional_params \\ [], opts \\ [])

Deletes a specific task by its ID, unless that task has already started running.

fusiontables_task_get(connection, table_id, task_id, optional_params \\ [], opts \\ [])

Retrieves a specific task by its ID.

fusiontables_task_list(connection, table_id, optional_params \\ [], opts \\ [])

Retrieves a list of tasks.

Link to this section Functions

fusiontables_task_delete(connection, table_id, task_id, optional_params \\ [], opts \\ [])

fusiontables_task_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Deletes a specific task by its ID, unless that task has already started running.

Parameters

connection (type: GoogleApi.FusionTables.V2.Connection.t) - Connection to server
table_id (type: String.t) - Table from which the task is being deleted.
task_id (type: String.t) - The identifier of the task to delete.
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.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
opts (type: keyword()) - Call options

Returns

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

fusiontables_task_get(connection, table_id, task_id, optional_params \\ [], opts \\ [])

fusiontables_task_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, GoogleApi.FusionTables.V2.Model.Task.t()} | {:error, Tesla.Env.t()}

Retrieves a specific task by its ID.

Parameters

connection (type: GoogleApi.FusionTables.V2.Connection.t) - Connection to server
table_id (type: String.t) - Table to which the task belongs.
task_id (type: String.t) - The identifier of the task to get.
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.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.FusionTables.V2.Model.Task{}} on success
{:error, info} on failure

fusiontables_task_list(connection, table_id, optional_params \\ [], opts \\ [])

fusiontables_task_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.FusionTables.V2.Model.TaskList.t()} | {:error, Tesla.Env.t()}

Retrieves a list of tasks.

Parameters

connection (type: GoogleApi.FusionTables.V2.Connection.t) - Connection to server
table_id (type: String.t) - Table whose tasks are being listed.
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.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :maxResults (type: integer()) - Maximum number of tasks to return. Default is 5.
- :pageToken (type: String.t) - Continuation token specifying which result page to return.
- :startIndex (type: integer()) - Index of the first result returned in the current page.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.FusionTables.V2.Model.TaskList{}} on success
{:error, info} on failure