GoogleApi.DataPortability.V1.Api.ArchiveJobs (google_api_data_portability v0.10.0)
View SourceAPI calls for all endpoints tagged ArchiveJobs
.
Summary
Functions
Cancels a Portability Archive job.
Retrieves the state of an Archive job for the Portability API.
Retries a failed Portability Archive job.
Functions
@spec dataportability_archive_jobs_cancel( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DataPortability.V1.Model.CancelPortabilityArchiveResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Cancels a Portability Archive job.
Parameters
-
connection
(type:GoogleApi.DataPortability.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The Archive job ID you're canceling. This is returned by the InitiatePortabilityArchive response. The format is: archiveJobs/{archive_job}. Canceling is only executed if the job is in progress. -
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.DataPortability.V1.Model.CancelPortabilityArchiveRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.DataPortability.V1.Model.CancelPortabilityArchiveResponse{}}
on success -
{:error, info}
on failure
@spec dataportability_archive_jobs_get_portability_archive_state( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DataPortability.V1.Model.PortabilityArchiveState.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves the state of an Archive job for the Portability API.
Parameters
-
connection
(type:GoogleApi.DataPortability.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The archive job ID that is returned when you request the state of the job. The format is: archiveJobs/{archive_job}/portabilityArchiveState. archive_job is the job ID returned by the InitiatePortabilityArchiveResponse. -
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.DataPortability.V1.Model.PortabilityArchiveState{}}
on success -
{:error, info}
on failure
@spec dataportability_archive_jobs_retry( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.DataPortability.V1.Model.RetryPortabilityArchiveResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retries a failed Portability Archive job.
Parameters
-
connection
(type:GoogleApi.DataPortability.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The Archive job ID you're retrying. This is returned by the InitiatePortabilityArchiveResponse. Retrying is only executed if the initial job failed. -
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.DataPortability.V1.Model.RetryPortabilityArchiveRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.DataPortability.V1.Model.RetryPortabilityArchiveResponse{}}
on success -
{:error, info}
on failure