com.google.cloud.dataplex.v1.RunTaskRequestOrBuilder Maven / Gradle / Ivy

Go to download
/*
 * 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/service.proto

// Protobuf Java Version: 3.25.4
package com.google.cloud.dataplex.v1;

public interface RunTaskRequestOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.dataplex.v1.RunTaskRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Required. The resource name of the task:
   * `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}`.
   * 
   *
   * 
   * string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The name.
   */
  java.lang.String getName();
  /**
   *
   *
   *    * Required. The resource name of the task:
   * `projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}`.
   * 
   *
   * 
   * string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString getNameBytes();

  /**
   *
   *
   *    * Optional. User-defined labels for the task. If the map is left empty, the
   * task will run with existing labels from task definition. If the map
   * contains an entry with a new key, the same will be added to existing set of
   * labels. If the map contains an entry with an existing label key in task
   * definition, the task will run with new label value for that entry. Clearing
   * an existing label will require label value to be explicitly set to a hyphen
   * "-". The label value cannot be empty.
   * 
   *
   * map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];
   */
  int getLabelsCount();
  /**
   *
   *
   *    * Optional. User-defined labels for the task. If the map is left empty, the
   * task will run with existing labels from task definition. If the map
   * contains an entry with a new key, the same will be added to existing set of
   * labels. If the map contains an entry with an existing label key in task
   * definition, the task will run with new label value for that entry. Clearing
   * an existing label will require label value to be explicitly set to a hyphen
   * "-". The label value cannot be empty.
   * 
   *
   * map<string, string> labels = 3 [(.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. If the map is left empty, the
   * task will run with existing labels from task definition. If the map
   * contains an entry with a new key, the same will be added to existing set of
   * labels. If the map contains an entry with an existing label key in task
   * definition, the task will run with new label value for that entry. Clearing
   * an existing label will require label value to be explicitly set to a hyphen
   * "-". The label value cannot be empty.
   * 
   *
   * map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];
   */
  java.util.Map getLabelsMap();
  /**
   *
   *
   *    * Optional. User-defined labels for the task. If the map is left empty, the
   * task will run with existing labels from task definition. If the map
   * contains an entry with a new key, the same will be added to existing set of
   * labels. If the map contains an entry with an existing label key in task
   * definition, the task will run with new label value for that entry. Clearing
   * an existing label will require label value to be explicitly set to a hyphen
   * "-". The label value cannot be empty.
   * 
   *
   * map<string, string> labels = 3 [(.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. If the map is left empty, the
   * task will run with existing labels from task definition. If the map
   * contains an entry with a new key, the same will be added to existing set of
   * labels. If the map contains an entry with an existing label key in task
   * definition, the task will run with new label value for that entry. Clearing
   * an existing label will require label value to be explicitly set to a hyphen
   * "-". The label value cannot be empty.
   * 
   *
   * map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];
   */
  java.lang.String getLabelsOrThrow(java.lang.String key);

  /**
   *
   *
   *    * Optional. Execution spec arguments. If the map is left empty, the task will
   * run with existing execution spec args from task definition. If the map
   * contains an entry with a new key, the same will be added to existing set of
   * args. If the map contains an entry with an existing arg key in task
   * definition, the task will run with new arg value for that entry. Clearing
   * an existing arg will require arg value to be explicitly set to a hyphen
   * "-". The arg value cannot be empty.
   * 
   *
   * map<string, string> args = 4 [(.google.api.field_behavior) = OPTIONAL];
   */
  int getArgsCount();
  /**
   *
   *
   *    * Optional. Execution spec arguments. If the map is left empty, the task will
   * run with existing execution spec args from task definition. If the map
   * contains an entry with a new key, the same will be added to existing set of
   * args. If the map contains an entry with an existing arg key in task
   * definition, the task will run with new arg value for that entry. Clearing
   * an existing arg will require arg value to be explicitly set to a hyphen
   * "-". The arg value cannot be empty.
   * 
   *
   * map<string, string> args = 4 [(.google.api.field_behavior) = OPTIONAL];
   */
  boolean containsArgs(java.lang.String key);
  /** Use {@link #getArgsMap()} instead. */
  @java.lang.Deprecated
  java.util.Map getArgs();
  /**
   *
   *
   *    * Optional. Execution spec arguments. If the map is left empty, the task will
   * run with existing execution spec args from task definition. If the map
   * contains an entry with a new key, the same will be added to existing set of
   * args. If the map contains an entry with an existing arg key in task
   * definition, the task will run with new arg value for that entry. Clearing
   * an existing arg will require arg value to be explicitly set to a hyphen
   * "-". The arg value cannot be empty.
   * 
   *
   * map<string, string> args = 4 [(.google.api.field_behavior) = OPTIONAL];
   */
  java.util.Map getArgsMap();
  /**
   *
   *
   *    * Optional. Execution spec arguments. If the map is left empty, the task will
   * run with existing execution spec args from task definition. If the map
   * contains an entry with a new key, the same will be added to existing set of
   * args. If the map contains an entry with an existing arg key in task
   * definition, the task will run with new arg value for that entry. Clearing
   * an existing arg will require arg value to be explicitly set to a hyphen
   * "-". The arg value cannot be empty.
   * 
   *
   * map<string, string> args = 4 [(.google.api.field_behavior) = OPTIONAL];
   */
  /* nullable */
  java.lang.String getArgsOrDefault(
      java.lang.String key,
      /* nullable */
      java.lang.String defaultValue);
  /**
   *
   *
   *    * Optional. Execution spec arguments. If the map is left empty, the task will
   * run with existing execution spec args from task definition. If the map
   * contains an entry with a new key, the same will be added to existing set of
   * args. If the map contains an entry with an existing arg key in task
   * definition, the task will run with new arg value for that entry. Clearing
   * an existing arg will require arg value to be explicitly set to a hyphen
   * "-". The arg value cannot be empty.
   * 
   *
   * map<string, string> args = 4 [(.google.api.field_behavior) = OPTIONAL];
   */
  java.lang.String getArgsOrThrow(java.lang.String key);
}