transfer_jobs

Overview

Name	transfer_jobs
Type	Resource
Id	google.storagetransfer.transfer_jobs

Fields

Name	Datatype	Description
name	string	A unique name (within the transfer project) assigned when the job is created. If this field is empty in a CreateTransferJobRequest, Storage Transfer Service assigns a unique name. Otherwise, the specified name is used as the unique name for this job. If the specified name is in use by a job, the creation request fails with an ALREADYEXISTS error. This name must start with "transferJobs/" prefix and end with a letter or a number, and should be no more than 128 characters. For transfers involving PosixFilesystem, this name must start with transferJobs/OPI specifically. For all other transfer types, this name must not start with transferJobs/OPI. Non-PosixFilesystem example: `"transferJobs/^(?!OPI)[A-Za-z0-9-.~][A-Za-z0-9]$"PosixFilesystem example:"transferJobs/OPI^[A-Za-z0-9-._~][A-Za-z0-9]$"` Applications must not rely on the enforcement of naming requirements involving OPI. Invalid job names fail with an INVALID_ARGUMENT error.
description	string	A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
creationTime	string	Output only. The time that the transfer job was created.
deletionTime	string	Output only. The time that the transfer job was deleted.
eventStream	object	Specifies the Event-driven transfer options. Event-driven transfers listen to an event stream to transfer updated files.
lastModificationTime	string	Output only. The time that the transfer job was last modified.
latestOperationName	string	The name of the most recently started TransferOperation of this JobConfig. Present if a TransferOperation has been created for this JobConfig.
loggingConfig	object	Specifies the logging behavior for transfer operations. For cloud-to-cloud transfers, logs are sent to Cloud Logging. See Read transfer logs for details. For transfers to or from a POSIX file system, logs are stored in the Cloud Storage bucket that is the source or sink of the transfer. See [Managing Transfer for on-premises jobs] (https://cloud.google.com/storage-transfer/docs/managing-on-prem-jobs#viewing-logs) for details.
notificationConfig	object	Specification to configure notifications published to Pub/Sub. Notifications are published to the customer-provided topic using the following PubsubMessage.attributes: "eventType": one of the EventType values "payloadFormat": one of the PayloadFormat values "projectId": the project_id of the TransferOperation "transferJobName": the transfer_job_name of the TransferOperation * "transferOperationName": the name of the TransferOperation The PubsubMessage.data contains a TransferOperation resource formatted according to the specified PayloadFormat.
projectId	string	The ID of the Google Cloud project that owns the job.
schedule	object	Transfers can be scheduled to recur or to run just once.
status	string	Status of the job. This value MUST be specified for CreateTransferJobRequests. Note: The effect of the new job status takes place during a subsequent job run. For example, if you change the job status from ENABLED to DISABLED, and an operation spawned by the transfer is running, the status change would not affect the current operation.
transferSpec	object	Configuration for running a transfer.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	projectId, transferJobsId	Gets a transfer job.
list	SELECT	filter	Lists transfer jobs.
create	INSERT		Creates a transfer job that runs periodically.
delete	DELETE	projectId, transferJobsId	Deletes a transfer job. Deleting a transfer job sets its status to DELETED.
_list	EXEC	filter	Lists transfer jobs.
patch	EXEC	transferJobsId	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).
run	EXEC	transferJobsId	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.