Reference documentation and code samples for the Google Cloud Storage Transfer V1 Client class TransferJob.
This resource represents the configuration of a transfer job that runs periodically.
Generated from protobuf message google.storagetransfer.v1.TransferJob
Namespace
Google \ Cloud \ StorageTransfer \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ 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 ALREADY_EXISTS
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.
↳ project_id
string
The ID of the Google Cloud project that owns the job.
↳ service_account
string
Optional. The user-managed service account to which to delegate service agent permissions. You can grant Cloud Storage bucket permissions to this service account instead of to the Transfer Service service agent. Format is projects/-/serviceAccounts/ACCOUNT_EMAIL_OR_UNIQUEID
Either the service account email ( SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
) or the unique ID ( 123456789012345678901
) are accepted in the string. The -
wildcard character is required; replacing it with a project ID is invalid. See https://cloud.google.com//storage-transfer/docs/delegate-service-agent-permissions
for required permissions.
↳ transfer_spec
↳ replication_spec
↳ notification_config
↳ logging_config
↳ schedule
Schedule
Specifies schedule for the transfer job. This is an optional field. When the field is not set, the job never executes a transfer, unless you invoke RunTransferJob or update the job to have a non-empty schedule.
↳ event_stream
EventStream
Specifies the event stream for the transfer job for event-driven transfers. When EventStream is specified, the Schedule fields are ignored.
↳ status
int
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.
↳ creation_time
↳ last_modification_time
↳ deletion_time
↳ latest_operation_name
string
The name of the most recently started TransferOperation of this JobConfig. Present if a TransferOperation has been created for this JobConfig.
getName
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 ALREADY_EXISTS
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.
string
setName
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 ALREADY_EXISTS
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.
var
string
$this
getDescription
A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
string
setDescription
A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
var
string
$this
getProjectId
The ID of the Google Cloud project that owns the job.
string
setProjectId
The ID of the Google Cloud project that owns the job.
var
string
$this
getServiceAccount
Optional. The user-managed service account to which to delegate service agent permissions. You can grant Cloud Storage bucket permissions to this service account instead of to the Transfer Service service agent.
Format is projects/-/serviceAccounts/ACCOUNT_EMAIL_OR_UNIQUEID
Either the service account email
( SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
) or the unique
ID ( 123456789012345678901
) are accepted in the string. The -
wildcard character is required; replacing it with a project ID is invalid.
See https://cloud.google.com//storage-transfer/docs/delegate-service-agent-permissions
for required permissions.
string
setServiceAccount
Optional. The user-managed service account to which to delegate service agent permissions. You can grant Cloud Storage bucket permissions to this service account instead of to the Transfer Service service agent.
Format is projects/-/serviceAccounts/ACCOUNT_EMAIL_OR_UNIQUEID
Either the service account email
( SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
) or the unique
ID ( 123456789012345678901
) are accepted in the string. The -
wildcard character is required; replacing it with a project ID is invalid.
See https://cloud.google.com//storage-transfer/docs/delegate-service-agent-permissions
for required permissions.
var
string
$this
getTransferSpec
Transfer specification.
hasTransferSpec
clearTransferSpec
setTransferSpec
Transfer specification.
$this
getReplicationSpec
Replication specification.
hasReplicationSpec
clearReplicationSpec
setReplicationSpec
Replication specification.
$this
getNotificationConfig
Notification configuration.
hasNotificationConfig
clearNotificationConfig
setNotificationConfig
Notification configuration.
$this
getLoggingConfig
Logging configuration.
hasLoggingConfig
clearLoggingConfig
setLoggingConfig
Logging configuration.
$this
getSchedule
Specifies schedule for the transfer job.
This is an optional field. When the field is not set, the job never executes a transfer, unless you invoke RunTransferJob or update the job to have a non-empty schedule.
hasSchedule
clearSchedule
setSchedule
Specifies schedule for the transfer job.
This is an optional field. When the field is not set, the job never executes a transfer, unless you invoke RunTransferJob or update the job to have a non-empty schedule.
$this
getEventStream
Specifies the event stream for the transfer job for event-driven transfers.
When EventStream is specified, the Schedule fields are ignored.
hasEventStream
clearEventStream
setEventStream
Specifies the event stream for the transfer job for event-driven transfers.
When EventStream is specified, the Schedule fields are ignored.
$this
getStatus
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.
int
setStatus
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.
var
int
$this
getCreationTime
Output only. The time that the transfer job was created.
hasCreationTime
clearCreationTime
setCreationTime
Output only. The time that the transfer job was created.
$this
getLastModificationTime
Output only. The time that the transfer job was last modified.
hasLastModificationTime
clearLastModificationTime
setLastModificationTime
Output only. The time that the transfer job was last modified.
$this
getDeletionTime
Output only. The time that the transfer job was deleted.
hasDeletionTime
clearDeletionTime
setDeletionTime
Output only. The time that the transfer job was deleted.
$this
getLatestOperationName
The name of the most recently started TransferOperation of this JobConfig.
Present if a TransferOperation has been created for this JobConfig.
string
setLatestOperationName
The name of the most recently started TransferOperation of this JobConfig.
Present if a TransferOperation has been created for this JobConfig.
var
string
$this
