Class MigrationSubtask

  • All Implemented Interfaces:
    MigrationSubtaskOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class MigrationSubtask
    extends com.google.protobuf.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
    See Also:
    Serialized Form
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • 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];
        Specified by:
        getName in interface MigrationSubtaskOrBuilder
        Returns:
        The name.
      • getNameBytes

        public com.google.protobuf.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];
        Specified by:
        getNameBytes in interface MigrationSubtaskOrBuilder
        Returns:
        The bytes for name.
      • getTaskId

        public String getTaskId()
         The unique ID of the task to which this subtask belongs.
         
        string task_id = 2;
        Specified by:
        getTaskId in interface MigrationSubtaskOrBuilder
        Returns:
        The taskId.
      • getTaskIdBytes

        public com.google.protobuf.ByteString getTaskIdBytes()
         The unique ID of the task to which this subtask belongs.
         
        string task_id = 2;
        Specified by:
        getTaskIdBytes in interface MigrationSubtaskOrBuilder
        Returns:
        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;
        Specified by:
        getType in interface MigrationSubtaskOrBuilder
        Returns:
        The type.
      • getTypeBytes

        public com.google.protobuf.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;
        Specified by:
        getTypeBytes in interface MigrationSubtaskOrBuilder
        Returns:
        The bytes for type.
      • 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];
        Specified by:
        getStateValue in interface MigrationSubtaskOrBuilder
        Returns:
        The enum numeric value on the wire for state.
      • 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];
        Specified by:
        getState in interface MigrationSubtaskOrBuilder
        Returns:
        The state.
      • 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];
        Specified by:
        hasProcessingError in interface MigrationSubtaskOrBuilder
        Returns:
        Whether the processingError field is set.
      • getProcessingError

        public 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];
        Specified by:
        getProcessingError in interface MigrationSubtaskOrBuilder
        Returns:
        The processingError.
      • getProcessingErrorOrBuilder

        public com.google.rpc.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];
        Specified by:
        getProcessingErrorOrBuilder in interface MigrationSubtaskOrBuilder
      • 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];
        Specified by:
        getResourceErrorDetailsList in interface MigrationSubtaskOrBuilder
      • 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];
        Specified by:
        getResourceErrorDetailsOrBuilderList in interface MigrationSubtaskOrBuilder
      • 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];
        Specified by:
        getResourceErrorDetailsCount in interface MigrationSubtaskOrBuilder
      • getResourceErrorDetails

        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];
        Specified by:
        getResourceErrorDetails in interface MigrationSubtaskOrBuilder
      • getResourceErrorDetailsOrBuilder

        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];
        Specified by:
        getResourceErrorDetailsOrBuilder in interface MigrationSubtaskOrBuilder
      • 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;
        Specified by:
        getResourceErrorCount in interface MigrationSubtaskOrBuilder
        Returns:
        The resourceErrorCount.
      • hasCreateTime

        public boolean hasCreateTime()
         Time when the subtask was created.
         
        .google.protobuf.Timestamp create_time = 7;
        Specified by:
        hasCreateTime in interface MigrationSubtaskOrBuilder
        Returns:
        Whether the createTime field is set.
      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Time when the subtask was created.
         
        .google.protobuf.Timestamp create_time = 7;
        Specified by:
        getCreateTime in interface MigrationSubtaskOrBuilder
        Returns:
        The createTime.
      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Time when the subtask was created.
         
        .google.protobuf.Timestamp create_time = 7;
        Specified by:
        getCreateTimeOrBuilder in interface MigrationSubtaskOrBuilder
      • hasLastUpdateTime

        public boolean hasLastUpdateTime()
         Time when the subtask was last updated.
         
        .google.protobuf.Timestamp last_update_time = 8;
        Specified by:
        hasLastUpdateTime in interface MigrationSubtaskOrBuilder
        Returns:
        Whether the lastUpdateTime field is set.
      • getLastUpdateTime

        public com.google.protobuf.Timestamp getLastUpdateTime()
         Time when the subtask was last updated.
         
        .google.protobuf.Timestamp last_update_time = 8;
        Specified by:
        getLastUpdateTime in interface MigrationSubtaskOrBuilder
        Returns:
        The lastUpdateTime.
      • getLastUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getLastUpdateTimeOrBuilder()
         Time when the subtask was last updated.
         
        .google.protobuf.Timestamp last_update_time = 8;
        Specified by:
        getLastUpdateTimeOrBuilder in interface MigrationSubtaskOrBuilder
      • getMetricsCount

        public int getMetricsCount()
         The metrics for the subtask.
         
        repeated .google.cloud.bigquery.migration.v2.TimeSeries metrics = 11;
        Specified by:
        getMetricsCount in interface MigrationSubtaskOrBuilder
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static MigrationSubtask parseFrom​(ByteBuffer data)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static MigrationSubtask parseFrom​(ByteBuffer data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static MigrationSubtask parseFrom​(com.google.protobuf.ByteString data)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static MigrationSubtask parseFrom​(com.google.protobuf.ByteString data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static MigrationSubtask parseFrom​(byte[] data)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static MigrationSubtask parseFrom​(byte[] data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static MigrationSubtask parseFrom​(com.google.protobuf.CodedInputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws IOException
        Throws:
        IOException
      • newBuilderForType

        public MigrationSubtask.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public MigrationSubtask.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected MigrationSubtask.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<MigrationSubtask> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public MigrationSubtask getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder