/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/bigquery/migration/v2/migration_entities.proto
package com.google.cloud.bigquery.migration.v2;
public interface MigrationSubtaskOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.bigquery.migration.v2.MigrationSubtask)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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];
*
*
* @return The name.
*/
java.lang.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];
*
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* The unique ID of the task to which this subtask belongs.
*
*
* string task_id = 2;
*
* @return The taskId.
*/
java.lang.String getTaskId();
/**
*
*
*
* The unique ID of the task to which this subtask belongs.
*
*
* string task_id = 2;
*
* @return The bytes for taskId.
*/
com.google.protobuf.ByteString getTaskIdBytes();
/**
*
*
*
* 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;
*
* @return The type.
*/
java.lang.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;
*
* @return The bytes for type.
*/
com.google.protobuf.ByteString getTypeBytes();
/**
*
*
*
* Output only. The current state of the subtask.
*
*
*
* .google.cloud.bigquery.migration.v2.MigrationSubtask.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The enum numeric value on the wire for state.
*/
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];
*
*
* @return The state.
*/
com.google.cloud.bigquery.migration.v2.MigrationSubtask.State getState();
/**
*
*
*
* 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];
*
*
* @return Whether the processingError field is set.
*/
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];
*
*
* @return The processingError.
*/
com.google.rpc.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];
*
*/
com.google.rpc.ErrorInfoOrBuilder getProcessingErrorOrBuilder();
/**
*
*
*
* 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];
*
*/
java.util.List
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];
*
*/
com.google.cloud.bigquery.migration.v2.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];
*
*/
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];
*
*/
java.util.List
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];
*
*/
com.google.cloud.bigquery.migration.v2.ResourceErrorDetailOrBuilder
getResourceErrorDetailsOrBuilder(int index);
/**
*
*
*
* 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;
*
* @return The resourceErrorCount.
*/
int getResourceErrorCount();
/**
*
*
*
* Time when the subtask was created.
*
*
* .google.protobuf.Timestamp create_time = 7;
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Time when the subtask was created.
*
*
* .google.protobuf.Timestamp create_time = 7;
*
* @return The createTime.
*/
com.google.protobuf.Timestamp getCreateTime();
/**
*
*
*
* Time when the subtask was created.
*
*
* .google.protobuf.Timestamp create_time = 7;
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* Time when the subtask was last updated.
*
*
* .google.protobuf.Timestamp last_update_time = 8;
*
* @return Whether the lastUpdateTime field is set.
*/
boolean hasLastUpdateTime();
/**
*
*
*
* Time when the subtask was last updated.
*
*
* .google.protobuf.Timestamp last_update_time = 8;
*
* @return The lastUpdateTime.
*/
com.google.protobuf.Timestamp getLastUpdateTime();
/**
*
*
*
* Time when the subtask was last updated.
*
*
* .google.protobuf.Timestamp last_update_time = 8;
*/
com.google.protobuf.TimestampOrBuilder getLastUpdateTimeOrBuilder();
/**
*
*
*
* The metrics for the subtask.
*
*
* repeated .google.cloud.bigquery.migration.v2.TimeSeries metrics = 11;
*/
java.util.List getMetricsList();
/**
*
*
*
* The metrics for the subtask.
*
*
* repeated .google.cloud.bigquery.migration.v2.TimeSeries metrics = 11;
*/
com.google.cloud.bigquery.migration.v2.TimeSeries getMetrics(int index);
/**
*
*
*
* The metrics for the subtask.
*
*
* repeated .google.cloud.bigquery.migration.v2.TimeSeries metrics = 11;
*/
int getMetricsCount();
/**
*
*
*
* The metrics for the subtask.
*
*
* repeated .google.cloud.bigquery.migration.v2.TimeSeries metrics = 11;
*/
java.util.List
getMetricsOrBuilderList();
/**
*
*
*
* The metrics for the subtask.
*
*
* repeated .google.cloud.bigquery.migration.v2.TimeSeries metrics = 11;
*/
com.google.cloud.bigquery.migration.v2.TimeSeriesOrBuilder getMetricsOrBuilder(int index);
}