/*
* 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.3
package com.google.cloud.dataplex.v1;
public interface JobOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.dataplex.v1.Job)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Output only. The relative resource name of the job, of the form:
* `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_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 job, of the form:
* `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_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 job.
*
*
* 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 job.
*
*
* 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 job was started.
*
*
* .google.protobuf.Timestamp start_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the startTime field is set.
*/
boolean hasStartTime();
/**
*
*
*
* Output only. The time when the job was started.
*
*
* .google.protobuf.Timestamp start_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The startTime.
*/
com.google.protobuf.Timestamp getStartTime();
/**
*
*
*
* Output only. The time when the job was started.
*
*
* .google.protobuf.Timestamp start_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder();
/**
*
*
*
* Output only. The time when the job ended.
*
*
* .google.protobuf.Timestamp end_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the endTime field is set.
*/
boolean hasEndTime();
/**
*
*
*
* Output only. The time when the job ended.
*
*
* .google.protobuf.Timestamp end_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The endTime.
*/
com.google.protobuf.Timestamp getEndTime();
/**
*
*
*
* Output only. The time when the job ended.
*
*
* .google.protobuf.Timestamp end_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder();
/**
*
*
*
* Output only. Execution state for the job.
*
*
*
* .google.cloud.dataplex.v1.Job.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The enum numeric value on the wire for state.
*/
int getStateValue();
/**
*
*
*
* Output only. Execution state for the job.
*
*
*
* .google.cloud.dataplex.v1.Job.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The state.
*/
com.google.cloud.dataplex.v1.Job.State getState();
/**
*
*
*
* Output only. The number of times the job has been retried (excluding the
* initial attempt).
*
*
* uint32 retry_count = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The retryCount.
*/
int getRetryCount();
/**
*
*
*
* Output only. The underlying service running a job.
*
*
*
* .google.cloud.dataplex.v1.Job.Service service = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The enum numeric value on the wire for service.
*/
int getServiceValue();
/**
*
*
*
* Output only. The underlying service running a job.
*
*
*
* .google.cloud.dataplex.v1.Job.Service service = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The service.
*/
com.google.cloud.dataplex.v1.Job.Service getService();
/**
*
*
*
* Output only. The full resource name for the job run under a particular
* service.
*
*
* string service_job = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The serviceJob.
*/
java.lang.String getServiceJob();
/**
*
*
*
* Output only. The full resource name for the job run under a particular
* service.
*
*
* string service_job = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for serviceJob.
*/
com.google.protobuf.ByteString getServiceJobBytes();
/**
*
*
*
* Output only. Additional information about the current state.
*
*
* string message = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The message.
*/
java.lang.String getMessage();
/**
*
*
*
* Output only. Additional information about the current state.
*
*
* string message = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for message.
*/
com.google.protobuf.ByteString getMessageBytes();
/**
*
*
*
* Output only. User-defined labels for the task.
*
*
* map<string, string> labels = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
int getLabelsCount();
/**
*
*
*
* Output only. User-defined labels for the task.
*
*
* map<string, string> labels = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* Output only. User-defined labels for the task.
*
*
* map<string, string> labels = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
java.util.Map getLabelsMap();
/**
*
*
*
* Output only. User-defined labels for the task.
*
*
* map<string, string> labels = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* Output only. User-defined labels for the task.
*
*
* map<string, string> labels = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
/**
*
*
*
* Output only. Job execution trigger.
*
*
*
* .google.cloud.dataplex.v1.Job.Trigger trigger = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The enum numeric value on the wire for trigger.
*/
int getTriggerValue();
/**
*
*
*
* Output only. Job execution trigger.
*
*
*
* .google.cloud.dataplex.v1.Job.Trigger trigger = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The trigger.
*/
com.google.cloud.dataplex.v1.Job.Trigger getTrigger();
/**
*
*
*
* Output only. Spec related to how a task is executed.
*
*
*
* .google.cloud.dataplex.v1.Task.ExecutionSpec execution_spec = 100 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the executionSpec field is set.
*/
boolean hasExecutionSpec();
/**
*
*
*
* Output only. Spec related to how a task is executed.
*
*
*
* .google.cloud.dataplex.v1.Task.ExecutionSpec execution_spec = 100 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The executionSpec.
*/
com.google.cloud.dataplex.v1.Task.ExecutionSpec getExecutionSpec();
/**
*
*
*
* Output only. Spec related to how a task is executed.
*
*
*
* .google.cloud.dataplex.v1.Task.ExecutionSpec execution_spec = 100 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.cloud.dataplex.v1.Task.ExecutionSpecOrBuilder getExecutionSpecOrBuilder();
}