Class MigrationTask (0.50.0)

public final class MigrationTask extends GeneratedMessageV3 implements MigrationTaskOrBuilder

A single task for a migration which has details about the configuration of the task.

Protobuf type google.cloud.bigquery.migration.v2.MigrationTask

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

LAST_UPDATE_TIME_FIELD_NUMBER

public static final int LAST_UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

METRICS_FIELD_NUMBER

public static final int METRICS_FIELD_NUMBER
Field Value
Type Description
int

PROCESSING_ERROR_FIELD_NUMBER

public static final int PROCESSING_ERROR_FIELD_NUMBER
Field Value
Type Description
int

RESOURCE_ERROR_COUNT_FIELD_NUMBER

public static final int RESOURCE_ERROR_COUNT_FIELD_NUMBER
Field Value
Type Description
int

RESOURCE_ERROR_DETAILS_FIELD_NUMBER

public static final int RESOURCE_ERROR_DETAILS_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

TASK_RESULT_FIELD_NUMBER

public static final int TASK_RESULT_FIELD_NUMBER
Field Value
Type Description
int

TOTAL_PROCESSING_ERROR_COUNT_FIELD_NUMBER

public static final int TOTAL_PROCESSING_ERROR_COUNT_FIELD_NUMBER
Field Value
Type Description
int

TOTAL_RESOURCE_ERROR_COUNT_FIELD_NUMBER

public static final int TOTAL_RESOURCE_ERROR_COUNT_FIELD_NUMBER
Field Value
Type Description
int

TRANSLATION_CONFIG_DETAILS_FIELD_NUMBER

public static final int TRANSLATION_CONFIG_DETAILS_FIELD_NUMBER
Field Value
Type Description
int

TRANSLATION_DETAILS_FIELD_NUMBER

public static final int TRANSLATION_DETAILS_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static MigrationTask getDefaultInstance()
Returns
Type Description
MigrationTask

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static MigrationTask.Builder newBuilder()
Returns
Type Description
MigrationTask.Builder

newBuilder(MigrationTask prototype)

public static MigrationTask.Builder newBuilder(MigrationTask prototype)
Parameter
Name Description
prototype MigrationTask
Returns
Type Description
MigrationTask.Builder

parseDelimitedFrom(InputStream input)

public static MigrationTask parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MigrationTask
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MigrationTask parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MigrationTask
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static MigrationTask parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
MigrationTask
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static MigrationTask parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MigrationTask
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static MigrationTask parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
MigrationTask
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static MigrationTask parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MigrationTask
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static MigrationTask parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
MigrationTask
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static MigrationTask parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MigrationTask
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static MigrationTask parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MigrationTask
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MigrationTask parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MigrationTask
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static MigrationTask parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
MigrationTask
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static MigrationTask parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MigrationTask
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<MigrationTask> parser()
Returns
Type Description
Parser<MigrationTask>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCreateTime()

public Timestamp getCreateTime()

Time when the task was created.

.google.protobuf.Timestamp create_time = 6;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Time when the task was created.

.google.protobuf.Timestamp create_time = 6;

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public MigrationTask getDefaultInstanceForType()
Returns
Type Description
MigrationTask

getId()

public String getId()

Output only. Immutable. The unique identifier for the migration task. The ID is server-generated.

string id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The id.

getIdBytes()

public ByteString getIdBytes()

Output only. Immutable. The unique identifier for the migration task. The ID is server-generated.

string id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for id.

getLastUpdateTime()

public Timestamp getLastUpdateTime()

Time when the task was last updated.

.google.protobuf.Timestamp last_update_time = 7;

Returns
Type Description
Timestamp

The lastUpdateTime.

getLastUpdateTimeOrBuilder()

public TimestampOrBuilder getLastUpdateTimeOrBuilder()

Time when the task was last updated.

.google.protobuf.Timestamp last_update_time = 7;

Returns
Type Description
TimestampOrBuilder

getMetrics(int index)

public TimeSeries getMetrics(int index)

The metrics for the task.

repeated .google.cloud.bigquery.migration.v2.TimeSeries metrics = 19;

Parameter
Name Description
index int
Returns
Type Description
TimeSeries

getMetricsCount()

public int getMetricsCount()

The metrics for the task.

repeated .google.cloud.bigquery.migration.v2.TimeSeries metrics = 19;

Returns
Type Description
int

getMetricsList()

public List<TimeSeries> getMetricsList()

The metrics for the task.

repeated .google.cloud.bigquery.migration.v2.TimeSeries metrics = 19;

Returns
Type Description
List<TimeSeries>

getMetricsOrBuilder(int index)

public TimeSeriesOrBuilder getMetricsOrBuilder(int index)

The metrics for the task.

repeated .google.cloud.bigquery.migration.v2.TimeSeries metrics = 19;

Parameter
Name Description
index int
Returns
Type Description
TimeSeriesOrBuilder

getMetricsOrBuilderList()

public List<? extends TimeSeriesOrBuilder> getMetricsOrBuilderList()

The metrics for the task.

repeated .google.cloud.bigquery.migration.v2.TimeSeries metrics = 19;

Returns
Type Description
List<? extends com.google.cloud.bigquery.migration.v2.TimeSeriesOrBuilder>

getParserForType()

public Parser<MigrationTask> getParserForType()
Returns
Type Description
Parser<MigrationTask>
Overrides

getProcessingError()

public ErrorInfo getProcessingError()

Output only. An explanation that may be populated when the task is in FAILED state.

.google.rpc.ErrorInfo processing_error = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.rpc.ErrorInfo

The processingError.

getProcessingErrorOrBuilder()

public ErrorInfoOrBuilder getProcessingErrorOrBuilder()

Output only. An explanation that may be populated when the task is in FAILED state.

.google.rpc.ErrorInfo processing_error = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.rpc.ErrorInfoOrBuilder

getResourceErrorCount()

public int getResourceErrorCount()

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.

int32 resource_error_count = 18;

Returns
Type Description
int

The resourceErrorCount.

getResourceErrorDetails(int index)

public ResourceErrorDetail getResourceErrorDetails(int index)

Output only. Provides details to errors and issues encountered while processing the task. Presence of error details does not mean that the task failed.

repeated .google.cloud.bigquery.migration.v2.ResourceErrorDetail resource_error_details = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
ResourceErrorDetail

getResourceErrorDetailsCount()

public int getResourceErrorDetailsCount()

Output only. Provides details to errors and issues encountered while processing the task. Presence of error details does not mean that the task failed.

repeated .google.cloud.bigquery.migration.v2.ResourceErrorDetail resource_error_details = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getResourceErrorDetailsList()

public List<ResourceErrorDetail> getResourceErrorDetailsList()

Output only. Provides details to errors and issues encountered while processing the task. Presence of error details does not mean that the task failed.

repeated .google.cloud.bigquery.migration.v2.ResourceErrorDetail resource_error_details = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<ResourceErrorDetail>

getResourceErrorDetailsOrBuilder(int index)

public ResourceErrorDetailOrBuilder getResourceErrorDetailsOrBuilder(int index)

Output only. Provides details to errors and issues encountered while processing the task. Presence of error details does not mean that the task failed.

repeated .google.cloud.bigquery.migration.v2.ResourceErrorDetail resource_error_details = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
ResourceErrorDetailOrBuilder

getResourceErrorDetailsOrBuilderList()

public List<? extends ResourceErrorDetailOrBuilder> getResourceErrorDetailsOrBuilderList()

Output only. Provides details to errors and issues encountered while processing the task. Presence of error details does not mean that the task failed.

repeated .google.cloud.bigquery.migration.v2.ResourceErrorDetail resource_error_details = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.bigquery.migration.v2.ResourceErrorDetailOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public MigrationTask.State getState()

Output only. The current state of the task.

.google.cloud.bigquery.migration.v2.MigrationTask.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
MigrationTask.State

The state.

getStateValue()

public int getStateValue()

Output only. The current state of the task.

.google.cloud.bigquery.migration.v2.MigrationTask.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getTaskDetailsCase()

public MigrationTask.TaskDetailsCase getTaskDetailsCase()
Returns
Type Description
MigrationTask.TaskDetailsCase

getTaskResult()

public MigrationTaskResult getTaskResult()

Output only. The result of the task.

.google.cloud.bigquery.migration.v2.MigrationTaskResult task_result = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
MigrationTaskResult

The taskResult.

getTaskResultOrBuilder()

public MigrationTaskResultOrBuilder getTaskResultOrBuilder()

Output only. The result of the task.

.google.cloud.bigquery.migration.v2.MigrationTaskResult task_result = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
MigrationTaskResultOrBuilder

getTotalProcessingErrorCount()

public int getTotalProcessingErrorCount()

Count of all the processing errors in this task and its subtasks.

int32 total_processing_error_count = 21;

Returns
Type Description
int

The totalProcessingErrorCount.

getTotalResourceErrorCount()

public int getTotalResourceErrorCount()

Count of all the resource errors in this task and its subtasks.

int32 total_resource_error_count = 22;

Returns
Type Description
int

The totalResourceErrorCount.

getTranslationConfigDetails()

public TranslationConfigDetails getTranslationConfigDetails()

Task configuration for CW Batch/Offline SQL Translation.

.google.cloud.bigquery.migration.v2.TranslationConfigDetails translation_config_details = 14;

Returns
Type Description
TranslationConfigDetails

The translationConfigDetails.

getTranslationConfigDetailsOrBuilder()

public TranslationConfigDetailsOrBuilder getTranslationConfigDetailsOrBuilder()

Task configuration for CW Batch/Offline SQL Translation.

.google.cloud.bigquery.migration.v2.TranslationConfigDetails translation_config_details = 14;

Returns
Type Description
TranslationConfigDetailsOrBuilder

getTranslationDetails()

public TranslationDetails getTranslationDetails()

Task details for unified SQL Translation.

.google.cloud.bigquery.migration.v2.TranslationDetails translation_details = 16;

Returns
Type Description
TranslationDetails

The translationDetails.

getTranslationDetailsOrBuilder()

public TranslationDetailsOrBuilder getTranslationDetailsOrBuilder()

Task details for unified SQL Translation.

.google.cloud.bigquery.migration.v2.TranslationDetails translation_details = 16;

Returns
Type Description
TranslationDetailsOrBuilder

getType()

public String getType()

The type of the task. This must be one of the supported task types: Translation_Teradata2BQ, Translation_Redshift2BQ, Translation_Bteq2BQ, Translation_Oracle2BQ, Translation_HiveQL2BQ, Translation_SparkSQL2BQ, Translation_Snowflake2BQ, Translation_Netezza2BQ, Translation_AzureSynapse2BQ, Translation_Vertica2BQ, Translation_SQLServer2BQ, Translation_Presto2BQ, Translation_MySQL2BQ, Translation_Postgresql2BQ, Translation_SQLite2BQ, Translation_Greenplum2BQ.

string type = 2;

Returns
Type Description
String

The type.

getTypeBytes()

public ByteString getTypeBytes()

The type of the task. This must be one of the supported task types: Translation_Teradata2BQ, Translation_Redshift2BQ, Translation_Bteq2BQ, Translation_Oracle2BQ, Translation_HiveQL2BQ, Translation_SparkSQL2BQ, Translation_Snowflake2BQ, Translation_Netezza2BQ, Translation_AzureSynapse2BQ, Translation_Vertica2BQ, Translation_SQLServer2BQ, Translation_Presto2BQ, Translation_MySQL2BQ, Translation_Postgresql2BQ, Translation_SQLite2BQ, Translation_Greenplum2BQ.

string type = 2;

Returns
Type Description
ByteString

The bytes for type.

hasCreateTime()

public boolean hasCreateTime()

Time when the task was created.

.google.protobuf.Timestamp create_time = 6;

Returns
Type Description
boolean

Whether the createTime field is set.

hasLastUpdateTime()

public boolean hasLastUpdateTime()

Time when the task was last updated.

.google.protobuf.Timestamp last_update_time = 7;

Returns
Type Description
boolean

Whether the lastUpdateTime field is set.

hasProcessingError()

public boolean hasProcessingError()

Output only. An explanation that may be populated when the task is in FAILED state.

.google.rpc.ErrorInfo processing_error = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the processingError field is set.

hasTaskResult()

public boolean hasTaskResult()

Output only. The result of the task.

.google.cloud.bigquery.migration.v2.MigrationTaskResult task_result = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the taskResult field is set.

hasTranslationConfigDetails()

public boolean hasTranslationConfigDetails()

Task configuration for CW Batch/Offline SQL Translation.

.google.cloud.bigquery.migration.v2.TranslationConfigDetails translation_config_details = 14;

Returns
Type Description
boolean

Whether the translationConfigDetails field is set.

hasTranslationDetails()

public boolean hasTranslationDetails()

Task details for unified SQL Translation.

.google.cloud.bigquery.migration.v2.TranslationDetails translation_details = 16;

Returns
Type Description
boolean

Whether the translationDetails field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public MigrationTask.Builder newBuilderForType()
Returns
Type Description
MigrationTask.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected MigrationTask.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
MigrationTask.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public MigrationTask.Builder toBuilder()
Returns
Type Description
MigrationTask.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException