Class ArchiveJobsResource
The "archiveJobs" collection of methods.
Inherited Members
Namespace: Google.Apis.DataPortability.v1beta
Assembly: Google.Apis.DataPortability.v1beta.dll
Syntax
public class ArchiveJobsResourceConstructors
ArchiveJobsResource(IClientService)
Constructs a new resource.
Declaration
public ArchiveJobsResource(IClientService service)Parameters
| Type | Name | Description |
|---|---|---|
| IClientService | service |
Methods
Cancel(CancelPortabilityArchiveRequest, string)
Cancels a Portability Archive job.
Declaration
public virtual ArchiveJobsResource.CancelRequest Cancel(CancelPortabilityArchiveRequest body, string name)Parameters
| Type | Name | Description |
|---|---|---|
| CancelPortabilityArchiveRequest | body | The body of the request. |
| string | name | 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. |
Returns
| Type | Description |
|---|---|
| ArchiveJobsResource.CancelRequest |
GetPortabilityArchiveState(string)
Retrieves the state of an Archive job for the Portability API.
Declaration
public virtual ArchiveJobsResource.GetPortabilityArchiveStateRequest GetPortabilityArchiveState(string name)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | 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. |
Returns
| Type | Description |
|---|---|
| ArchiveJobsResource.GetPortabilityArchiveStateRequest |
Retry(RetryPortabilityArchiveRequest, string)
Retries a failed Portability Archive job.
Declaration
public virtual ArchiveJobsResource.RetryRequest Retry(RetryPortabilityArchiveRequest body, string name)Parameters
| Type | Name | Description |
|---|---|---|
| RetryPortabilityArchiveRequest | body | The body of the request. |
| string | name | Required. The Archive job ID you're retrying. This is returned by the InitiatePortabilityArchiveResponse. Retrying is only executed if the initial job failed. |
Returns
| Type | Description |
|---|---|
| ArchiveJobsResource.RetryRequest |