Reference documentation and code samples for the Google Cloud Storage Transfer V1 Client class UpdateTransferJobRequest.
Request passed to UpdateTransferJob.
Generated from protobuf message google.storagetransfer.v1.UpdateTransferJobRequest
Namespace
Google \ Cloud \ StorageTransfer \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ job_name
string
Required. The name of job to update.
↳ project_id
string
Required. The ID of the Google Cloud project that owns the job.
↳ transfer_job
TransferJob
Required. The job to update. transferJob
is expected to specify one or more of five fields: description
, transfer_spec
, notification_config
, logging_config
, and status
. An UpdateTransferJobRequest
that specifies other fields are rejected with the error INVALID_ARGUMENT
. Updating a job status to DELETED
requires storagetransfer.jobs.delete
permission.
↳ update_transfer_job_field_mask
Google\Protobuf\FieldMask
The field mask of the fields in transferJob
that are to be updated in this request. Fields in transferJob
that can be updated are: description
, transfer_spec
, notification_config
, logging_config
, and status
. To update the transfer_spec
of the job, a complete transfer specification must be provided. An incomplete specification missing any required fields is rejected with the error INVALID_ARGUMENT
.
getJobName
Required. The name of job to update.
string
setJobName
Required. The name of job to update.
var
string
$this
getProjectId
Required. The ID of the Google Cloud project that owns the job.
string
setProjectId
Required. The ID of the Google Cloud project that owns the job.
var
string
$this
getTransferJob
Required. The job to update. transferJob
is expected to specify one or
more of five fields: description
, transfer_spec
, notification_config
, logging_config
, and status
. An UpdateTransferJobRequest
that specifies other fields are rejected with
the error INVALID_ARGUMENT
. Updating a
job status to DELETED
requires storagetransfer.jobs.delete
permission.
hasTransferJob
clearTransferJob
setTransferJob
Required. The job to update. transferJob
is expected to specify one or
more of five fields: description
, transfer_spec
, notification_config
, logging_config
, and status
. An UpdateTransferJobRequest
that specifies other fields are rejected with
the error INVALID_ARGUMENT
. Updating a
job status to DELETED
requires storagetransfer.jobs.delete
permission.
$this
getUpdateTransferJobFieldMask
The field mask of the fields in transferJob
that are to be updated in
this request. Fields in transferJob
that can be updated are: description
, transfer_spec
, notification_config
, logging_config
, and status
. To update the transfer_spec
of the job, a complete transfer specification must be
provided. An incomplete specification missing any required fields is
rejected with the error INVALID_ARGUMENT
.
hasUpdateTransferJobFieldMask
clearUpdateTransferJobFieldMask
setUpdateTransferJobFieldMask
The field mask of the fields in transferJob
that are to be updated in
this request. Fields in transferJob
that can be updated are: description
, transfer_spec
, notification_config
, logging_config
, and status
. To update the transfer_spec
of the job, a complete transfer specification must be
provided. An incomplete specification missing any required fields is
rejected with the error INVALID_ARGUMENT
.
$this
