/*
* Copyright 2024 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/dataplex/v1/tasks.proto
// Protobuf Java Version: 3.25.4
package com.google.cloud.dataplex.v1;
public interface TaskOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.dataplex.v1.Task)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Output only. The relative resource name of the task, of the form:
* projects/{project_number}/locations/{location_id}/lakes/{lake_id}/
* tasks/{task_id}.
*
*
*
* string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
*
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* Output only. The relative resource name of the task, of the form:
* projects/{project_number}/locations/{location_id}/lakes/{lake_id}/
* tasks/{task_id}.
*
*
*
* string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
*
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Output only. System generated globally unique ID for the task. This ID will
* be different if the task is deleted and re-created with the same name.
*
*
* string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The uid.
*/
java.lang.String getUid();
/**
*
*
*
* Output only. System generated globally unique ID for the task. This ID will
* be different if the task is deleted and re-created with the same name.
*
*
* string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for uid.
*/
com.google.protobuf.ByteString getUidBytes();
/**
*
*
*
* Output only. The time when the task was created.
*
*
* .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. The time when the task was created.
*
*
* .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The createTime.
*/
com.google.protobuf.Timestamp getCreateTime();
/**
*
*
*
* Output only. The time when the task was created.
*
*
* .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* Output only. The time when the task was last updated.
*
*
* .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the updateTime field is set.
*/
boolean hasUpdateTime();
/**
*
*
*
* Output only. The time when the task was last updated.
*
*
* .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The updateTime.
*/
com.google.protobuf.Timestamp getUpdateTime();
/**
*
*
*
* Output only. The time when the task was last updated.
*
*
* .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();
/**
*
*
*
* Optional. Description of the task.
*
*
* string description = 5 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The description.
*/
java.lang.String getDescription();
/**
*
*
*
* Optional. Description of the task.
*
*
* string description = 5 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for description.
*/
com.google.protobuf.ByteString getDescriptionBytes();
/**
*
*
*
* Optional. User friendly display name.
*
*
* string display_name = 6 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The displayName.
*/
java.lang.String getDisplayName();
/**
*
*
*
* Optional. User friendly display name.
*
*
* string display_name = 6 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for displayName.
*/
com.google.protobuf.ByteString getDisplayNameBytes();
/**
*
*
*
* Output only. Current state of the task.
*
*
* .google.cloud.dataplex.v1.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The enum numeric value on the wire for state.
*/
int getStateValue();
/**
*
*
*
* Output only. Current state of the task.
*
*
* .google.cloud.dataplex.v1.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The state.
*/
com.google.cloud.dataplex.v1.State getState();
/**
*
*
*
* Optional. User-defined labels for the task.
*
*
* map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
*/
int getLabelsCount();
/**
*
*
*
* Optional. User-defined labels for the task.
*
*
* map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* Optional. User-defined labels for the task.
*
*
* map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
*/
java.util.Map getLabelsMap();
/**
*
*
*
* Optional. User-defined labels for the task.
*
*
* map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* Optional. User-defined labels for the task.
*
*
* map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
/**
*
*
*
* Required. Spec related to how often and when a task should be triggered.
*
*
*
* .google.cloud.dataplex.v1.Task.TriggerSpec trigger_spec = 100 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return Whether the triggerSpec field is set.
*/
boolean hasTriggerSpec();
/**
*
*
*
* Required. Spec related to how often and when a task should be triggered.
*
*
*
* .google.cloud.dataplex.v1.Task.TriggerSpec trigger_spec = 100 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return The triggerSpec.
*/
com.google.cloud.dataplex.v1.Task.TriggerSpec getTriggerSpec();
/**
*
*
*
* Required. Spec related to how often and when a task should be triggered.
*
*
*
* .google.cloud.dataplex.v1.Task.TriggerSpec trigger_spec = 100 [(.google.api.field_behavior) = REQUIRED];
*
*/
com.google.cloud.dataplex.v1.Task.TriggerSpecOrBuilder getTriggerSpecOrBuilder();
/**
*
*
*
* Required. Spec related to how a task is executed.
*
*
*
* .google.cloud.dataplex.v1.Task.ExecutionSpec execution_spec = 101 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return Whether the executionSpec field is set.
*/
boolean hasExecutionSpec();
/**
*
*
*
* Required. Spec related to how a task is executed.
*
*
*
* .google.cloud.dataplex.v1.Task.ExecutionSpec execution_spec = 101 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return The executionSpec.
*/
com.google.cloud.dataplex.v1.Task.ExecutionSpec getExecutionSpec();
/**
*
*
*
* Required. Spec related to how a task is executed.
*
*
*
* .google.cloud.dataplex.v1.Task.ExecutionSpec execution_spec = 101 [(.google.api.field_behavior) = REQUIRED];
*
*/
com.google.cloud.dataplex.v1.Task.ExecutionSpecOrBuilder getExecutionSpecOrBuilder();
/**
*
*
*
* Output only. Status of the latest task executions.
*
*
*
* .google.cloud.dataplex.v1.Task.ExecutionStatus execution_status = 201 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the executionStatus field is set.
*/
boolean hasExecutionStatus();
/**
*
*
*
* Output only. Status of the latest task executions.
*
*
*
* .google.cloud.dataplex.v1.Task.ExecutionStatus execution_status = 201 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The executionStatus.
*/
com.google.cloud.dataplex.v1.Task.ExecutionStatus getExecutionStatus();
/**
*
*
*
* Output only. Status of the latest task executions.
*
*
*
* .google.cloud.dataplex.v1.Task.ExecutionStatus execution_status = 201 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.cloud.dataplex.v1.Task.ExecutionStatusOrBuilder getExecutionStatusOrBuilder();
/**
*
*
*
* Config related to running custom Spark tasks.
*
*
* .google.cloud.dataplex.v1.Task.SparkTaskConfig spark = 300;
*
* @return Whether the spark field is set.
*/
boolean hasSpark();
/**
*
*
*
* Config related to running custom Spark tasks.
*
*
* .google.cloud.dataplex.v1.Task.SparkTaskConfig spark = 300;
*
* @return The spark.
*/
com.google.cloud.dataplex.v1.Task.SparkTaskConfig getSpark();
/**
*
*
*
* Config related to running custom Spark tasks.
*
*
* .google.cloud.dataplex.v1.Task.SparkTaskConfig spark = 300;
*/
com.google.cloud.dataplex.v1.Task.SparkTaskConfigOrBuilder getSparkOrBuilder();
/**
*
*
*
* Config related to running scheduled Notebooks.
*
*
* .google.cloud.dataplex.v1.Task.NotebookTaskConfig notebook = 302;
*
* @return Whether the notebook field is set.
*/
boolean hasNotebook();
/**
*
*
*
* Config related to running scheduled Notebooks.
*
*
* .google.cloud.dataplex.v1.Task.NotebookTaskConfig notebook = 302;
*
* @return The notebook.
*/
com.google.cloud.dataplex.v1.Task.NotebookTaskConfig getNotebook();
/**
*
*
*
* Config related to running scheduled Notebooks.
*
*
* .google.cloud.dataplex.v1.Task.NotebookTaskConfig notebook = 302;
*/
com.google.cloud.dataplex.v1.Task.NotebookTaskConfigOrBuilder getNotebookOrBuilder();
com.google.cloud.dataplex.v1.Task.ConfigCase getConfigCase();
}
