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
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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 |
Google\Cloud\StorageTransfer\V1\TransferJob
Required. The job to update. |
↳ update_transfer_job_field_mask |
Google\Protobuf\FieldMask
The field mask of the fields in |
getJobName
Required. The name of job to update.
| Returns | |
|---|---|
| Type | Description |
string | |
setJobName
Required. The name of job to update.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getProjectId
Required. The ID of the Google Cloud project that owns the job.
| Returns | |
|---|---|
| Type | Description |
string | |
setProjectId
Required. The ID of the Google Cloud project that owns the job.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\StorageTransfer\V1\TransferJob|null | |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\StorageTransfer\V1\TransferJob
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\FieldMask|null | |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\FieldMask
|
| Returns | |
|---|---|
| Type | Description |
$this | |