Show / Hide Table of Contents

Namespace Google.Apis.Storagetransfer.v1

Classes

GoogleServiceAccountsResource

The "googleServiceAccounts" collection of methods.

GoogleServiceAccountsResource.GetRequest

Returns the Google service account that is used by Storage Transfer Service to access buckets in the project where transfers run or in other projects. Each Google service account is associated with one Google Cloud project. Users should add this service account to the Google Cloud Storage bucket ACLs to grant access to Storage Transfer Service. This service account is created and owned by Storage Transfer Service and can only be used by Storage Transfer Service.

ProjectsResource

The "projects" collection of methods.

ProjectsResource.AgentPoolsResource

The "agentPools" collection of methods.

ProjectsResource.AgentPoolsResource.CreateRequest

Creates an agent pool resource.

ProjectsResource.AgentPoolsResource.DeleteRequest

Deletes an agent pool.

ProjectsResource.AgentPoolsResource.GetRequest

Gets an agent pool.

ProjectsResource.AgentPoolsResource.ListRequest

Lists agent pools.

ProjectsResource.AgentPoolsResource.PatchRequest

Updates an existing agent pool resource.

StoragetransferBaseServiceRequest<TResponse>

A base abstract class for Storagetransfer requests.

StoragetransferService

The Storagetransfer Service.

StoragetransferService.Scope

Available OAuth 2.0 scopes for use with the Storage Transfer API.

StoragetransferService.ScopeConstants

Available OAuth 2.0 scope constants for use with the Storage Transfer API.

TransferJobsResource

The "transferJobs" collection of methods.

TransferJobsResource.CreateRequest

Creates a transfer job that runs periodically.

TransferJobsResource.DeleteRequest

Deletes a transfer job. Deleting a transfer job sets its status to DELETED.

TransferJobsResource.GetRequest

Gets a transfer job.

TransferJobsResource.ListRequest

Lists transfer jobs.

TransferJobsResource.PatchRequest

Updates a transfer job. Updating a job's transfer spec does not affect transfer operations that are running already. Note: The job's status field can be modified using this RPC (for example, to set a job's status to DELETED, DISABLED, or ENABLED).

TransferJobsResource.RunRequest

Starts a new operation for the specified transfer job. A TransferJob has a maximum of one active TransferOperation. If this method is called while a TransferOperation is active, an error is returned.

TransferOperationsResource

The "transferOperations" collection of methods.

TransferOperationsResource.CancelRequest

Cancels a transfer. Use the transferOperations.get method to check if the cancellation succeeded or if the operation completed despite the cancel request. When you cancel an operation, the currently running transfer is interrupted. For recurring transfer jobs, the next instance of the transfer job will still run. For example, if your job is configured to run every day at 1pm and you cancel Monday's operation at 1:05pm, Monday's transfer will stop. However, a transfer job will still be attempted on Tuesday. This applies only to currently running operations. If an operation is not currently running, cancel does nothing. Caution: Canceling a transfer job can leave your data in an unknown state. We recommend that you restore the state at both the destination and the source after the cancel request completes so that your data is in a consistent state. When you cancel a job, the next job computes a delta of files and may repair any inconsistent state. For instance, if you run a job every day, and today's job found 10 new files and transferred five files before you canceled the job, tomorrow's transfer operation will compute a new delta with the five files that were not copied today plus any new files discovered tomorrow.

TransferOperationsResource.GetRequest

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

TransferOperationsResource.ListRequest

Lists transfer operations. Operations are ordered by their creation time in reverse chronological order.

TransferOperationsResource.PauseRequest

Pauses a transfer operation.

TransferOperationsResource.ResumeRequest

Resumes a transfer operation that is paused.

Enums

StoragetransferBaseServiceRequest<TResponse>.AltEnum

Data format for response.

StoragetransferBaseServiceRequest<TResponse>.XgafvEnum

V1 error format.

In this article
Back to top Generated by DocFX