com.google.cloud.dataproc.v1.InstantiateWorkflowTemplateRequestOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-dataproc-v1 Show documentation
PROTO library for proto-google-cloud-dataproc-v1
There is a newer version: 4.53.0
Show newest version
/*
 * 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/dataproc/v1/workflow_templates.proto

// Protobuf Java Version: 3.25.5
package com.google.cloud.dataproc.v1;

public interface InstantiateWorkflowTemplateRequestOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.dataproc.v1.InstantiateWorkflowTemplateRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Required. The resource name of the workflow template, as described
   * in https://cloud.google.com/apis/design/resource_names.
   *
   * * For `projects.regions.workflowTemplates.instantiate`, the resource name
   * of the template has the following format:
   *   `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`
   *
   * * For `projects.locations.workflowTemplates.instantiate`, the resource name
   *   of the template has the following format:
   *   `projects/{project_id}/locations/{location}/workflowTemplates/{template_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 workflow template, as described
   * in https://cloud.google.com/apis/design/resource_names.
   *
   * * For `projects.regions.workflowTemplates.instantiate`, the resource name
   * of the template has the following format:
   *   `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}`
   *
   * * For `projects.locations.workflowTemplates.instantiate`, the resource name
   *   of the template has the following format:
   *   `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}`
   * 
   *
   * 
   * string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
   * 
   *
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString getNameBytes();

  /**
   *
   *
   *    * Optional. The version of workflow template to instantiate. If specified,
   * the workflow will be instantiated only if the current version of
   * the workflow template has the supplied version.
   *
   * This option cannot be used to instantiate a previous version of
   * workflow template.
   * 
   *
   * int32 version = 2 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The version.
   */
  int getVersion();

  /**
   *
   *
   *    * Optional. A tag that prevents multiple concurrent workflow
   * instances with the same tag from running. This mitigates risk of
   * concurrent instances started due to retries.
   *
   * It is recommended to always set this value to a
   * [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier).
   *
   * The tag must contain only letters (a-z, A-Z), numbers (0-9),
   * underscores (_), and hyphens (-). The maximum length is 40 characters.
   * 
   *
   * string request_id = 5 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The requestId.
   */
  java.lang.String getRequestId();
  /**
   *
   *
   *    * Optional. A tag that prevents multiple concurrent workflow
   * instances with the same tag from running. This mitigates risk of
   * concurrent instances started due to retries.
   *
   * It is recommended to always set this value to a
   * [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier).
   *
   * The tag must contain only letters (a-z, A-Z), numbers (0-9),
   * underscores (_), and hyphens (-). The maximum length is 40 characters.
   * 
   *
   * string request_id = 5 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The bytes for requestId.
   */
  com.google.protobuf.ByteString getRequestIdBytes();

  /**
   *
   *
   *    * Optional. Map from parameter names to values that should be used for those
   * parameters. Values may not exceed 1000 characters.
   * 
   *
   * map<string, string> parameters = 6 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  int getParametersCount();
  /**
   *
   *
   *    * Optional. Map from parameter names to values that should be used for those
   * parameters. Values may not exceed 1000 characters.
   * 
   *
   * map<string, string> parameters = 6 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  boolean containsParameters(java.lang.String key);
  /** Use {@link #getParametersMap()} instead. */
  @java.lang.Deprecated
  java.util.Map getParameters();
  /**
   *
   *
   *    * Optional. Map from parameter names to values that should be used for those
   * parameters. Values may not exceed 1000 characters.
   * 
   *
   * map<string, string> parameters = 6 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  java.util.Map getParametersMap();
  /**
   *
   *
   *    * Optional. Map from parameter names to values that should be used for those
   * parameters. Values may not exceed 1000 characters.
   * 
   *
   * map<string, string> parameters = 6 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  /* nullable */
  java.lang.String getParametersOrDefault(
      java.lang.String key,
      /* nullable */
      java.lang.String defaultValue);
  /**
   *
   *
   *    * Optional. Map from parameter names to values that should be used for those
   * parameters. Values may not exceed 1000 characters.
   * 
   *
   * map<string, string> parameters = 6 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  java.lang.String getParametersOrThrow(java.lang.String key);
}