# Google Cloud Storage Transfer V1 Client - Class TransferOperation (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 TransferOperation.

A description of the execution of a transfer.

Generated from protobuf message `google.storagetransfer.v1.TransferOperation`

## Namespace

Google \\ Cloud \\ StorageTransfer \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ name` | `string` A globally unique ID assigned by the system. |
| `↳ project_id` | `string` The ID of the Google Cloud project that owns the operation. |
| `↳ transfer_spec` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferSpec` Transfer specification. |
| `↳ notification_config` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.NotificationConfig` Notification configuration. |
| `↳ logging_config` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.LoggingConfig` Cloud Logging configuration. |
| `↳ start_time` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` Start time of this transfer execution. |
| `↳ end_time` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` End time of this transfer execution. |
| `↳ status` | `int` Status of the transfer operation. |
| `↳ counters` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferCounters` Information about the progress of the transfer operation. |
| `↳ error_breakdowns` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.ErrorSummary>` Summarizes errors encountered with sample error log entries. |
| `↳ transfer_job_name` | `string` The name of the transfer job that triggers this transfer operation. |

### getName

A globally unique ID assigned by the system.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setName

A globally unique ID assigned by the system.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

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

### getProjectId

The ID of the Google Cloud project that owns the operation.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setProjectId

The ID of the Google Cloud project that owns the operation.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

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

### getTransferSpec

Transfer specification.

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

### hasTransferSpec

### clearTransferSpec

### setTransferSpec

Transfer specification.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferSpec` |

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

### getNotificationConfig

Notification configuration.

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

### hasNotificationConfig

### clearNotificationConfig

### setNotificationConfig

Notification configuration.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.NotificationConfig` |

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

### getLoggingConfig

Cloud Logging configuration.

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

### hasLoggingConfig

### clearLoggingConfig

### setLoggingConfig

Cloud Logging configuration.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.LoggingConfig` |

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

### getStartTime

Start time of this transfer execution.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp|null` |   |

### hasStartTime

### clearStartTime

### setStartTime

Start time of this transfer execution.

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

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

### getEndTime

End time of this transfer execution.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp|null` |   |

### hasEndTime

### clearEndTime

### setEndTime

End time of this transfer execution.

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

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

### getStatus

Status of the transfer operation.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [Status](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferOperation.Status). |

### setStatus

Status of the transfer operation.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [Status](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferOperation.Status). |

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

### getCounters

Information about the progress of the transfer operation.

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

### hasCounters

### clearCounters

### setCounters

Information about the progress of the transfer operation.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.TransferCounters` |

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

### getErrorBreakdowns

Summarizes errors encountered with sample error log entries.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/RepeatedField<https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.ErrorSummary>` |   |

### setErrorBreakdowns

Summarizes errors encountered with sample error log entries.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.ErrorSummary>` |

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

### getTransferJobName

The name of the transfer job that triggers this transfer operation.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setTransferJobName

The name of the transfer job that triggers this transfer operation.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

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