Google Cloud Storage Transfer V1 Client - Class StorageTransferServiceClient (1.3.1)

Reference documentation and code samples for the Google Cloud Storage Transfer V1 Client class StorageTransferServiceClient.

Service Description: Storage Transfer Service and its protos.

Transfers data between between Google Cloud Storage buckets or from a data source external to Google to a Cloud Storage bucket.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

This class is currently experimental and may be subject to changes. See Google\Cloud\StorageTransfer\V1\StorageTransferServiceClient for the stable implementation

Namespace

Google \ Cloud \ StorageTransfer \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
`options`	`array` Optional. Options for configuring the service API wrapper.
`↳ apiEndpoint`	`string` The address of the API remote host. May optionally include the port, formatted as "
`↳ credentials`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ credentialsConfig`	`array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ clientConfig`	`string\|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
`↳ transport`	`string\|TransportInterface` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ transportConfig`	`array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
`↳ clientCertSource`	`callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

createAgentPool

Creates an agent pool resource.

The async variant is Google\Cloud\StorageTransfer\V1\Client\StorageTransferServiceClient::createAgentPoolAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\StorageTransfer\V1\CreateAgentPoolRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\StorageTransfer\V1\AgentPool`

createTransferJob

Creates a transfer job that runs periodically.

The async variant is Google\Cloud\StorageTransfer\V1\Client\StorageTransferServiceClient::createTransferJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\StorageTransfer\V1\CreateTransferJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\StorageTransfer\V1\TransferJob`

deleteAgentPool

Deletes an agent pool.

The async variant is Google\Cloud\StorageTransfer\V1\Client\StorageTransferServiceClient::deleteAgentPoolAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\StorageTransfer\V1\DeleteAgentPoolRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

deleteTransferJob

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

The async variant is Google\Cloud\StorageTransfer\V1\Client\StorageTransferServiceClient::deleteTransferJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\StorageTransfer\V1\DeleteTransferJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

getAgentPool

Gets an agent pool.

The async variant is Google\Cloud\StorageTransfer\V1\Client\StorageTransferServiceClient::getAgentPoolAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\StorageTransfer\V1\GetAgentPoolRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\StorageTransfer\V1\AgentPool`

getGoogleServiceAccount

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.

The async variant is Google\Cloud\StorageTransfer\V1\Client\StorageTransferServiceClient::getGoogleServiceAccountAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\StorageTransfer\V1\GetGoogleServiceAccountRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\StorageTransfer\V1\GoogleServiceAccount`

getTransferJob

Gets a transfer job.

The async variant is Google\Cloud\StorageTransfer\V1\Client\StorageTransferServiceClient::getTransferJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\StorageTransfer\V1\GetTransferJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\StorageTransfer\V1\TransferJob`

listAgentPools

Lists agent pools.

The async variant is Google\Cloud\StorageTransfer\V1\Client\StorageTransferServiceClient::listAgentPoolsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\StorageTransfer\V1\ListAgentPoolsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

listTransferJobs

Lists transfer jobs.

The async variant is Google\Cloud\StorageTransfer\V1\Client\StorageTransferServiceClient::listTransferJobsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\StorageTransfer\V1\ListTransferJobsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

pauseTransferOperation

Pauses a transfer operation.

The async variant is Google\Cloud\StorageTransfer\V1\Client\StorageTransferServiceClient::pauseTransferOperationAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\StorageTransfer\V1\PauseTransferOperationRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

resumeTransferOperation

Resumes a transfer operation that is paused.

The async variant is Google\Cloud\StorageTransfer\V1\Client\StorageTransferServiceClient::resumeTransferOperationAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\StorageTransfer\V1\ResumeTransferOperationRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

runTransferJob

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.

The async variant is Google\Cloud\StorageTransfer\V1\Client\StorageTransferServiceClient::runTransferJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\StorageTransfer\V1\RunTransferJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

updateAgentPool

Updates an existing agent pool resource.

The async variant is Google\Cloud\StorageTransfer\V1\Client\StorageTransferServiceClient::updateAgentPoolAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\StorageTransfer\V1\UpdateAgentPoolRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\StorageTransfer\V1\AgentPool`

updateTransferJob

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).

The async variant is Google\Cloud\StorageTransfer\V1\Client\StorageTransferServiceClient::updateTransferJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\StorageTransfer\V1\UpdateTransferJobRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\StorageTransfer\V1\TransferJob`

createAgentPoolAsync

Parameters
Name	Description
`request`	`Google\Cloud\StorageTransfer\V1\CreateAgentPoolRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

createTransferJobAsync

Parameters
Name	Description
`request`	`Google\Cloud\StorageTransfer\V1\CreateTransferJobRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteAgentPoolAsync

Parameters
Name	Description
`request`	`Google\Cloud\StorageTransfer\V1\DeleteAgentPoolRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteTransferJobAsync

Parameters
Name	Description
`request`	`Google\Cloud\StorageTransfer\V1\DeleteTransferJobRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getAgentPoolAsync

Parameters
Name	Description
`request`	`Google\Cloud\StorageTransfer\V1\GetAgentPoolRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getGoogleServiceAccountAsync

Parameters
Name	Description
`request`	`Google\Cloud\StorageTransfer\V1\GetGoogleServiceAccountRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getTransferJobAsync

Parameters
Name	Description
`request`	`Google\Cloud\StorageTransfer\V1\GetTransferJobRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listAgentPoolsAsync

Parameters
Name	Description
`request`	`Google\Cloud\StorageTransfer\V1\ListAgentPoolsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listTransferJobsAsync

Parameters
Name	Description
`request`	`Google\Cloud\StorageTransfer\V1\ListTransferJobsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

pauseTransferOperationAsync

Parameters
Name	Description
`request`	`Google\Cloud\StorageTransfer\V1\PauseTransferOperationRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

resumeTransferOperationAsync

Parameters
Name	Description
`request`	`Google\Cloud\StorageTransfer\V1\ResumeTransferOperationRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

runTransferJobAsync

Parameters
Name	Description
`request`	`Google\Cloud\StorageTransfer\V1\RunTransferJobRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateAgentPoolAsync

Parameters
Name	Description
`request`	`Google\Cloud\StorageTransfer\V1\UpdateAgentPoolRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateTransferJobAsync

Parameters
Name	Description
`request`	`Google\Cloud\StorageTransfer\V1\UpdateTransferJobRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type	Description
`Google\ApiCore\LongRunning\OperationsClient`

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name	Description
`operationName`	`string` The name of the long running operation
`methodName`	`string` The name of the method used to start the operation

Returns
Type	Description
`Google\ApiCore\OperationResponse`

static::agentPoolsName

Formats a string containing the fully-qualified path to represent a agent_pools resource.

Parameters
Name	Description
`projectId`	`string`
`agentPoolId`	`string`

Returns
Type	Description
`string`	The formatted agent_pools resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

agentPools: projects/{project_id}/agentPools/{agent_pool_id}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
`formattedName`	`string` The formatted name string
`template`	`string` Optional name of template to match

Returns
Type	Description
`array`	An associative array from name component IDs to component values.