# Google Cloud Storage Transfer V1 Client - Class UpdateTransferJobRequest (2.4.0)

2.4.0 (latest) 2.3.2 2.2.1 2.1.1 2.0.2 1.5.0 1.4.5 1.3.1 1.2.0 1.1.1 1.0.6 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 \\ V1

## 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` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob` Required. The job to update. `transferJob` is expected to specify one or more of five fields: [description](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob#_Google_Cloud_StorageTransfer_V1_TransferJob__getDescription__), [transfer_spec](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob#_Google_Cloud_StorageTransfer_V1_TransferJob__getTransferSpec__), [notification_config](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob#_Google_Cloud_StorageTransfer_V1_TransferJob__getNotificationConfig__), [logging_config](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob#_Google_Cloud_StorageTransfer_V1_TransferJob__getLoggingConfig__), and [status](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob#_Google_Cloud_StorageTransfer_V1_TransferJob__getStatus__). An `UpdateTransferJobRequest` that specifies other fields are rejected with the error [INVALID_ARGUMENT](https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Rpc.Code.html#_Google_Rpc_Code__INVALID_ARGUMENT). Updating a job status to [DELETED](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob.Status#_Google_Cloud_StorageTransfer_V1_TransferJob_Status__DELETED) requires `storagetransfer.jobs.delete` permission. |
| `↳ update_transfer_job_field_mask` | `https://protobuf.dev/reference/php/api-docs/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](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob#_Google_Cloud_StorageTransfer_V1_TransferJob__getDescription__), [transfer_spec](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob#_Google_Cloud_StorageTransfer_V1_TransferJob__getTransferSpec__), [notification_config](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob#_Google_Cloud_StorageTransfer_V1_TransferJob__getNotificationConfig__), [logging_config](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob#_Google_Cloud_StorageTransfer_V1_TransferJob__getLoggingConfig__), and [status](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob#_Google_Cloud_StorageTransfer_V1_TransferJob__getStatus__). 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](https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Rpc.Code.html#_Google_Rpc_Code__INVALID_ARGUMENT). |

### 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](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob#_Google_Cloud_StorageTransfer_V1_TransferJob__getDescription__),
[transfer_spec](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob#_Google_Cloud_StorageTransfer_V1_TransferJob__getTransferSpec__),
[notification_config](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob#_Google_Cloud_StorageTransfer_V1_TransferJob__getNotificationConfig__),
[logging_config](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob#_Google_Cloud_StorageTransfer_V1_TransferJob__getLoggingConfig__), and
[status](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob#_Google_Cloud_StorageTransfer_V1_TransferJob__getStatus__). An
`UpdateTransferJobRequest` that specifies other fields are rejected with
the error [INVALID_ARGUMENT](https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Rpc.Code.html#_Google_Rpc_Code__INVALID_ARGUMENT). Updating a
job status to
[DELETED](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob.Status#_Google_Cloud_StorageTransfer_V1_TransferJob_Status__DELETED) requires
`storagetransfer.jobs.delete` permission.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob|null` |   |

### hasTransferJob

### clearTransferJob

### setTransferJob

Required. The job to update. `transferJob` is expected to specify one or
more of five fields:
[description](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob#_Google_Cloud_StorageTransfer_V1_TransferJob__getDescription__),
[transfer_spec](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob#_Google_Cloud_StorageTransfer_V1_TransferJob__getTransferSpec__),
[notification_config](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob#_Google_Cloud_StorageTransfer_V1_TransferJob__getNotificationConfig__),
[logging_config](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob#_Google_Cloud_StorageTransfer_V1_TransferJob__getLoggingConfig__), and
[status](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob#_Google_Cloud_StorageTransfer_V1_TransferJob__getStatus__). An
`UpdateTransferJobRequest` that specifies other fields are rejected with
the error [INVALID_ARGUMENT](https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Rpc.Code.html#_Google_Rpc_Code__INVALID_ARGUMENT). Updating a
job status to
[DELETED](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob.Status#_Google_Cloud_StorageTransfer_V1_TransferJob_Status__DELETED) requires
`storagetransfer.jobs.delete` permission.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/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](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob#_Google_Cloud_StorageTransfer_V1_TransferJob__getDescription__),
[transfer_spec](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob#_Google_Cloud_StorageTransfer_V1_TransferJob__getTransferSpec__),
[notification_config](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob#_Google_Cloud_StorageTransfer_V1_TransferJob__getNotificationConfig__),
[logging_config](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob#_Google_Cloud_StorageTransfer_V1_TransferJob__getLoggingConfig__), and
[status](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob#_Google_Cloud_StorageTransfer_V1_TransferJob__getStatus__). 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](https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Rpc.Code.html#_Google_Rpc_Code__INVALID_ARGUMENT).

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/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](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob#_Google_Cloud_StorageTransfer_V1_TransferJob__getDescription__),
[transfer_spec](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob#_Google_Cloud_StorageTransfer_V1_TransferJob__getTransferSpec__),
[notification_config](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob#_Google_Cloud_StorageTransfer_V1_TransferJob__getNotificationConfig__),
[logging_config](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob#_Google_Cloud_StorageTransfer_V1_TransferJob__getLoggingConfig__), and
[status](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferJob#_Google_Cloud_StorageTransfer_V1_TransferJob__getStatus__). 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](https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Rpc.Code.html#_Google_Rpc_Code__INVALID_ARGUMENT).

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/FieldMask` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |