Class MigrationSubtask (0.58.0) 

public final class MigrationSubtask extends GeneratedMessageV3 implements MigrationSubtaskOrBuilder

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.

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > MigrationSubtask

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_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

NAME_FIELD_NUMBER

public static final int NAME_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_ID_FIELD_NUMBER

public static final int TASK_ID_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 MigrationSubtask getDefaultInstance()
Returns
Type Description
MigrationSubtask

getDescriptor()

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

newBuilder()

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

newBuilder(MigrationSubtask prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

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 subtask was created.

.google.protobuf.Timestamp create_time = 7;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Time when the subtask was created.

.google.protobuf.Timestamp create_time = 7;

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public MigrationSubtask getDefaultInstanceForType()
Returns
Type Description
MigrationSubtask

getLastUpdateTime()

public Timestamp getLastUpdateTime()

Time when the subtask was last updated.

.google.protobuf.Timestamp last_update_time = 8;

Returns
Type Description
Timestamp

The lastUpdateTime.

getLastUpdateTimeOrBuilder()

public TimestampOrBuilder getLastUpdateTimeOrBuilder()

Time when the subtask was last updated.

.google.protobuf.Timestamp last_update_time = 8;

Returns
Type Description
TimestampOrBuilder

getMetrics(int index)

public TimeSeries getMetrics(int index)

The metrics for the subtask.

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

Parameter
Name Description
index int
Returns
Type Description
TimeSeries

getMetricsCount()

public int getMetricsCount()

The metrics for the subtask.

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

Returns
Type Description
int

getMetricsList()

public List<TimeSeries> getMetricsList()

The metrics for the subtask.

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

Returns
Type Description
List<TimeSeries>

getMetricsOrBuilder(int index)

public TimeSeriesOrBuilder getMetricsOrBuilder(int index)

The metrics for the subtask.

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

Parameter
Name Description
index int
Returns
Type Description
TimeSeriesOrBuilder

getMetricsOrBuilderList()

public List<? extends TimeSeriesOrBuilder> getMetricsOrBuilderList()

The metrics for the subtask.

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

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

getName()

public String getName()

Output only. Immutable. The resource name for the migration subtask. The ID is server-generated.

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

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Immutable. The resource name for the migration subtask. The ID is server-generated.

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

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<MigrationSubtask> getParserForType()
Returns
Type Description
Parser<MigrationSubtask>
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 = 6 [(.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 = 6 [(.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 = 13;

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 subtask. Presence of error details does not mean that the subtask failed.

repeated .google.cloud.bigquery.migration.v2.ResourceErrorDetail resource_error_details = 12 [(.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 subtask. Presence of error details does not mean that the subtask failed.

repeated .google.cloud.bigquery.migration.v2.ResourceErrorDetail resource_error_details = 12 [(.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 subtask. Presence of error details does not mean that the subtask failed.

repeated .google.cloud.bigquery.migration.v2.ResourceErrorDetail resource_error_details = 12 [(.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 subtask. Presence of error details does not mean that the subtask failed.

repeated .google.cloud.bigquery.migration.v2.ResourceErrorDetail resource_error_details = 12 [(.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 subtask. Presence of error details does not mean that the subtask failed.

repeated .google.cloud.bigquery.migration.v2.ResourceErrorDetail resource_error_details = 12 [(.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 MigrationSubtask.State getState()

Output only. The current state of the subtask.

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

Returns
Type Description
MigrationSubtask.State

The state.

getStateValue()

public int getStateValue()

Output only. The current state of the subtask.

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

Returns
Type Description
int

The enum numeric value on the wire for state.

getTaskId()

public String getTaskId()

The unique ID of the task to which this subtask belongs.

string task_id = 2;

Returns
Type Description
String

The taskId.

getTaskIdBytes()

public ByteString getTaskIdBytes()

The unique ID of the task to which this subtask belongs.

string task_id = 2;

Returns
Type Description
ByteString

The bytes for taskId.

getType()

public String getType()

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.

string type = 3;

Returns
Type Description
String

The type.

getTypeBytes()

public ByteString getTypeBytes()

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.

string type = 3;

Returns
Type Description
ByteString

The bytes for type.

hasCreateTime()

public boolean hasCreateTime()

Time when the subtask was created.

.google.protobuf.Timestamp create_time = 7;

Returns
Type Description
boolean

Whether the createTime field is set.

hasLastUpdateTime()

public boolean hasLastUpdateTime()

Time when the subtask was last updated.

.google.protobuf.Timestamp last_update_time = 8;

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 = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the processingError 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 MigrationSubtask.Builder newBuilderForType()
Returns
Type Description
MigrationSubtask.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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