# Google Cloud Talent Solution V4 Client - Class BatchOperationMetadata (2.3.0)

2.3.0 (latest) 2.2.1 2.1.3 2.0.2 1.3.5 1.2.2 1.1.1 1.0.5 Reference documentation and code samples for the Google Cloud Talent Solution V4 Client class BatchOperationMetadata.

Metadata used for long running operations returned by CTS batch APIs.

It's used to replace
google.longrunning.Operation.metadata.

Generated from protobuf message `google.cloud.talent.v4.BatchOperationMetadata`

## Namespace

Google \\ Cloud \\ Talent \\ V4

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ state` | `int` The state of a long running operation. |
| `↳ state_description` | `string` More detailed information about operation state. |
| `↳ success_count` | `int` Count of successful item(s) inside an operation. |
| `↳ failure_count` | `int` Count of failed item(s) inside an operation. |
| `↳ total_count` | `int` Count of total item(s) inside an operation. |
| `↳ create_time` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` The time when the batch operation is created. |
| `↳ update_time` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` The time when the batch operation status is updated. The metadata and the [update_time](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.BatchOperationMetadata#_Google_Cloud_Talent_V4_BatchOperationMetadata__getUpdateTime__) is refreshed every minute otherwise cached data is returned. |
| `↳ end_time` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` The time when the batch operation is finished and google.longrunning.Operation.done is set to `true`. |

### getState

The state of a long running operation.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [State](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.BatchOperationMetadata.State). |

### setState

The state of a long running operation.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [State](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.BatchOperationMetadata.State). |

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

### getStateDescription

More detailed information about operation state.

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

### setStateDescription

More detailed information about operation state.

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

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

### getSuccessCount

Count of successful item(s) inside an operation.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` |   |

### setSuccessCount

Count of successful item(s) inside an operation.

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

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

### getFailureCount

Count of failed item(s) inside an operation.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` |   |

### setFailureCount

Count of failed item(s) inside an operation.

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

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

### getTotalCount

Count of total item(s) inside an operation.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` |   |

### setTotalCount

Count of total item(s) inside an operation.

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

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

### getCreateTime

The time when the batch operation is created.

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

### hasCreateTime

### clearCreateTime

### setCreateTime

The time when the batch operation is created.

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

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

### getUpdateTime

The time when the batch operation status is updated. The metadata and the
[update_time](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.BatchOperationMetadata#_Google_Cloud_Talent_V4_BatchOperationMetadata__getUpdateTime__) is
refreshed every minute otherwise cached data is returned.

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

### hasUpdateTime

### clearUpdateTime

### setUpdateTime

The time when the batch operation status is updated. The metadata and the
[update_time](https://docs.cloud.google.com/php/docs/reference/cloud-talent/latest/V4.BatchOperationMetadata#_Google_Cloud_Talent_V4_BatchOperationMetadata__getUpdateTime__) is
refreshed every minute otherwise cached data is returned.

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

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

### getEndTime

The time when the batch operation is finished and
google.longrunning.Operation.done is
set to `true`.

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

### hasEndTime

### clearEndTime

### setEndTime

The time when the batch operation is finished and
google.longrunning.Operation.done is
set to `true`.

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

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