# Cloud Talent Solution V4 API - Class Google::Cloud::Talent::V4::BatchOperationMetadata (v1.9.0)

1.9.0 (latest) 1.8.1 1.7.0 1.6.1 1.5.0 1.4.0 1.3.1 1.2.0 1.1.0 1.0.1 0.13.0 0.12.2 0.11.0 0.10.1 0.9.1 0.8.1 0.7.0 0.6.4 Reference documentation and code samples for the Cloud Talent Solution V4 API class Google::Cloud::Talent::V4::BatchOperationMetadata.

Metadata used for long running operations returned by CTS batch APIs.
It's used to replace
[google.longrunning.Operation.metadata](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-talent-v4/latest/Google-Longrunning-Operation#Google__Longrunning__Operation_metadata_instance_ "Google::Longrunning::Operation#metadata (method)").

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #create_time

    def create_time() -> ::Google::Protobuf::Timestamp

**Returns**

- ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-talent-v4/latest/Google-Protobuf-Timestamp)) --- The time when the batch operation is created.

### #create_time=

    def create_time=(value) -> ::Google::Protobuf::Timestamp

**Parameter**

- **value** ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-talent-v4/latest/Google-Protobuf-Timestamp)) --- The time when the batch operation is created.
**Returns**

- ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-talent-v4/latest/Google-Protobuf-Timestamp)) --- The time when the batch operation is created.

### #end_time

    def end_time() -> ::Google::Protobuf::Timestamp

**Returns**

- ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-talent-v4/latest/Google-Protobuf-Timestamp)) --- The time when the batch operation is finished and [google.longrunning.Operation.done](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-talent-v4/latest/Google-Longrunning-Operation#Google__Longrunning__Operation_done_instance_ "Google::Longrunning::Operation#done (method)") is set to `true`.

### #end_time=

    def end_time=(value) -> ::Google::Protobuf::Timestamp

**Parameter**

- **value** ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-talent-v4/latest/Google-Protobuf-Timestamp)) --- The time when the batch operation is finished and [google.longrunning.Operation.done](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-talent-v4/latest/Google-Longrunning-Operation#Google__Longrunning__Operation_done_instance_ "Google::Longrunning::Operation#done (method)") is set to `true`.
**Returns**

- ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-talent-v4/latest/Google-Protobuf-Timestamp)) --- The time when the batch operation is finished and [google.longrunning.Operation.done](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-talent-v4/latest/Google-Longrunning-Operation#Google__Longrunning__Operation_done_instance_ "Google::Longrunning::Operation#done (method)") is set to `true`.

### #failure_count

    def failure_count() -> ::Integer

**Returns**

- (::Integer) --- Count of failed item(s) inside an operation.

### #failure_count=

    def failure_count=(value) -> ::Integer

**Parameter**

- **value** (::Integer) --- Count of failed item(s) inside an operation.
**Returns**

- (::Integer) --- Count of failed item(s) inside an operation.

### #state

    def state() -> ::Google::Cloud::Talent::V4::BatchOperationMetadata::State

**Returns**

- ([::Google::Cloud::Talent::V4::BatchOperationMetadata::State](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-talent-v4/latest/Google-Cloud-Talent-V4-BatchOperationMetadata-State)) --- The state of a long running operation.

### #state=

    def state=(value) -> ::Google::Cloud::Talent::V4::BatchOperationMetadata::State

**Parameter**

- **value** ([::Google::Cloud::Talent::V4::BatchOperationMetadata::State](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-talent-v4/latest/Google-Cloud-Talent-V4-BatchOperationMetadata-State)) --- The state of a long running operation.
**Returns**

- ([::Google::Cloud::Talent::V4::BatchOperationMetadata::State](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-talent-v4/latest/Google-Cloud-Talent-V4-BatchOperationMetadata-State)) --- The state of a long running operation.

### #state_description

    def state_description() -> ::String

**Returns**

- (::String) --- More detailed information about operation state.

### #state_description=

    def state_description=(value) -> ::String

**Parameter**

- **value** (::String) --- More detailed information about operation state.
**Returns**

- (::String) --- More detailed information about operation state.

### #success_count

    def success_count() -> ::Integer

**Returns**

- (::Integer) --- Count of successful item(s) inside an operation.

### #success_count=

    def success_count=(value) -> ::Integer

**Parameter**

- **value** (::Integer) --- Count of successful item(s) inside an operation.
**Returns**

- (::Integer) --- Count of successful item(s) inside an operation.

### #total_count

    def total_count() -> ::Integer

**Returns**

- (::Integer) --- Count of total item(s) inside an operation.

### #total_count=

    def total_count=(value) -> ::Integer

**Parameter**

- **value** (::Integer) --- Count of total item(s) inside an operation.
**Returns**

- (::Integer) --- Count of total item(s) inside an operation.

### #update_time

    def update_time() -> ::Google::Protobuf::Timestamp

**Returns**

- ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-talent-v4/latest/Google-Protobuf-Timestamp)) --- The time when the batch operation status is updated. The metadata and the [update_time](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-talent-v4/latest/Google-Cloud-Talent-V4-BatchOperationMetadata#Google__Cloud__Talent__V4__BatchOperationMetadata_update_time_instance_ "Google::Cloud::Talent::V4::BatchOperationMetadata#update_time (method)") is refreshed every minute otherwise cached data is returned.

### #update_time=

    def update_time=(value) -> ::Google::Protobuf::Timestamp

**Parameter**

- **value** ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-talent-v4/latest/Google-Protobuf-Timestamp)) --- The time when the batch operation status is updated. The metadata and the [update_time](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-talent-v4/latest/Google-Cloud-Talent-V4-BatchOperationMetadata#Google__Cloud__Talent__V4__BatchOperationMetadata_update_time_instance_ "Google::Cloud::Talent::V4::BatchOperationMetadata#update_time (method)") is refreshed every minute otherwise cached data is returned.
**Returns**

- ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-talent-v4/latest/Google-Protobuf-Timestamp)) --- The time when the batch operation status is updated. The metadata and the [update_time](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-talent-v4/latest/Google-Cloud-Talent-V4-BatchOperationMetadata#Google__Cloud__Talent__V4__BatchOperationMetadata_update_time_instance_ "Google::Cloud::Talent::V4::BatchOperationMetadata#update_time (method)") is refreshed every minute otherwise cached data is returned.