Cloud Bigtable API - Class Google::Cloud::Bigtable::LongrunningJob (v2.12.1)

Reference documentation and code samples for the Cloud Bigtable API class Google::Cloud::Bigtable::LongrunningJob.

LongrunningJob

A resource representing the long-running, asynchronous processing operation. The job can be refreshed to retrieve the result object once the operation has been completed.

Inherits

  • Object

Methods

#done?

def done?() -> boolean

Checks if the processing of the instance operation is complete.

Returns
  • (boolean) — true when complete, false otherwise.

#error

def error() -> Object, Google::Rpc::Status, nil

The status when the operation associated with this job produced an error.

Returns
  • (Object, Google::Rpc::Status, nil) — A status object with the status code and message, or nil if no error occurred.

#error?

def error?() -> boolean

Checks if the processing of the instance operation has errored.

Returns
  • (boolean) — true when errored, false otherwise.

#reload!

def reload!() -> Google::Cloud::Bigtable::Instance::Job

Reloads the job with current data from the long-running, asynchronous processing of an operation.

Returns

#results

def results() -> Object, nil

Gets the result object of the operation.

Returns
  • (Object, nil) — nil if the operation is not complete.

#wait_until_done!

def wait_until_done!()

Reloads the job until the operation is complete. The delay between reloads will incrementally increase.