BigQuery Migration V2 API - Class Google::Cloud::Bigquery::Migration::V2::MigrationSubtask (v0.8.0)

Reference documentation and code samples for the BigQuery Migration V2 API class Google::Cloud::Bigquery::Migration::V2::MigrationSubtask.

A subtask for a migration which carries details about the configuration of the subtask. The content of the details should not matter to the end user, but is a contract between the subtask creator and subtask worker.

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) — Time when the subtask was created.

#create_time=

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

Parameter

value (::Google::Protobuf::Timestamp) — Time when the subtask was created.

Returns

(::Google::Protobuf::Timestamp) — Time when the subtask was created.

#last_update_time

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

Returns

(::Google::Protobuf::Timestamp) — Time when the subtask was last updated.

#last_update_time=

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

Parameter

value (::Google::Protobuf::Timestamp) — Time when the subtask was last updated.

Returns

(::Google::Protobuf::Timestamp) — Time when the subtask was last updated.

#metrics

def metrics() -> ::Array<::Google::Cloud::Bigquery::Migration::V2::TimeSeries>

Returns

(::Array<::Google::Cloud::Bigquery::Migration::V2::TimeSeries>) — The metrics for the subtask.

#metrics=

def metrics=(value) -> ::Array<::Google::Cloud::Bigquery::Migration::V2::TimeSeries>

Parameter

value (::Array<::Google::Cloud::Bigquery::Migration::V2::TimeSeries>) — The metrics for the subtask.

Returns

(::Array<::Google::Cloud::Bigquery::Migration::V2::TimeSeries>) — The metrics for the subtask.

#name

def name() -> ::String

Returns

(::String) — Output only. Immutable. The resource name for the migration subtask. The ID is server-generated.

Example: projects/123/locations/us/workflows/345/subtasks/678

#processing_error

def processing_error() -> ::Google::Rpc::ErrorInfo

Returns

(::Google::Rpc::ErrorInfo) — Output only. An explanation that may be populated when the task is in FAILED state.

#resource_error_count

def resource_error_count() -> ::Integer

Returns

(::Integer) — The number or resources with errors. Note: This is not the total number of errors as each resource can have more than one error. This is used to indicate truncation by having a resource_error_count that is higher than the size of resource_error_details.

#resource_error_count=

def resource_error_count=(value) -> ::Integer

Parameter

value (::Integer) — The number or resources with errors. Note: This is not the total number of errors as each resource can have more than one error. This is used to indicate truncation by having a resource_error_count that is higher than the size of resource_error_details.

Returns

(::Integer) — The number or resources with errors. Note: This is not the total number of errors as each resource can have more than one error. This is used to indicate truncation by having a resource_error_count that is higher than the size of resource_error_details.

#resource_error_details

def resource_error_details() -> ::Array<::Google::Cloud::Bigquery::Migration::V2::ResourceErrorDetail>

Returns

(::Array<::Google::Cloud::Bigquery::Migration::V2::ResourceErrorDetail>) — Output only. Provides details to errors and issues encountered while processing the subtask. Presence of error details does not mean that the subtask failed.

#state

def state() -> ::Google::Cloud::Bigquery::Migration::V2::MigrationSubtask::State

Returns

(::Google::Cloud::Bigquery::Migration::V2::MigrationSubtask::State) — Output only. The current state of the subtask.

#task_id

def task_id() -> ::String

Returns

(::String) — The unique ID of the task to which this subtask belongs.

#task_id=

def task_id=(value) -> ::String

Parameter

value (::String) — The unique ID of the task to which this subtask belongs.

Returns

(::String) — The unique ID of the task to which this subtask belongs.

#type

def type() -> ::String

Returns

(::String) — The type of the Subtask. The migration service does not check whether this is a known type. It is up to the task creator (i.e. orchestrator or worker) to ensure it only creates subtasks for which there are compatible workers polling for Subtasks.

#type=

def type=(value) -> ::String

Parameter

value (::String) — The type of the Subtask. The migration service does not check whether this is a known type. It is up to the task creator (i.e. orchestrator or worker) to ensure it only creates subtasks for which there are compatible workers polling for Subtasks.

Returns

(::String) — The type of the Subtask. The migration service does not check whether this is a known type. It is up to the task creator (i.e. orchestrator or worker) to ensure it only creates subtasks for which there are compatible workers polling for Subtasks.