com.google.cloud.dataproc.v1.FlinkJobOrBuilder 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/jobs.proto

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

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

  /**
   *
   *
   *    * The HCFS URI of the jar file that contains the main class.
   * 
   *
   * string main_jar_file_uri = 1;
   *
   * @return Whether the mainJarFileUri field is set.
   */
  boolean hasMainJarFileUri();
  /**
   *
   *
   *    * The HCFS URI of the jar file that contains the main class.
   * 
   *
   * string main_jar_file_uri = 1;
   *
   * @return The mainJarFileUri.
   */
  java.lang.String getMainJarFileUri();
  /**
   *
   *
   *    * The HCFS URI of the jar file that contains the main class.
   * 
   *
   * string main_jar_file_uri = 1;
   *
   * @return The bytes for mainJarFileUri.
   */
  com.google.protobuf.ByteString getMainJarFileUriBytes();

  /**
   *
   *
   *    * The name of the driver's main class. The jar file that contains the class
   * must be in the default CLASSPATH or specified in
   * [jarFileUris][google.cloud.dataproc.v1.FlinkJob.jar_file_uris].
   * 
   *
   * string main_class = 2;
   *
   * @return Whether the mainClass field is set.
   */
  boolean hasMainClass();
  /**
   *
   *
   *    * The name of the driver's main class. The jar file that contains the class
   * must be in the default CLASSPATH or specified in
   * [jarFileUris][google.cloud.dataproc.v1.FlinkJob.jar_file_uris].
   * 
   *
   * string main_class = 2;
   *
   * @return The mainClass.
   */
  java.lang.String getMainClass();
  /**
   *
   *
   *    * The name of the driver's main class. The jar file that contains the class
   * must be in the default CLASSPATH or specified in
   * [jarFileUris][google.cloud.dataproc.v1.FlinkJob.jar_file_uris].
   * 
   *
   * string main_class = 2;
   *
   * @return The bytes for mainClass.
   */
  com.google.protobuf.ByteString getMainClassBytes();

  /**
   *
   *
   *    * Optional. The arguments to pass to the driver. Do not include arguments,
   * such as `--conf`, that can be set as job properties, since a collision
   * might occur that causes an incorrect job submission.
   * 
   *
   * repeated string args = 3 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return A list containing the args.
   */
  java.util.List getArgsList();
  /**
   *
   *
   *    * Optional. The arguments to pass to the driver. Do not include arguments,
   * such as `--conf`, that can be set as job properties, since a collision
   * might occur that causes an incorrect job submission.
   * 
   *
   * repeated string args = 3 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The count of args.
   */
  int getArgsCount();
  /**
   *
   *
   *    * Optional. The arguments to pass to the driver. Do not include arguments,
   * such as `--conf`, that can be set as job properties, since a collision
   * might occur that causes an incorrect job submission.
   * 
   *
   * repeated string args = 3 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @param index The index of the element to return.
   * @return The args at the given index.
   */
  java.lang.String getArgs(int index);
  /**
   *
   *
   *    * Optional. The arguments to pass to the driver. Do not include arguments,
   * such as `--conf`, that can be set as job properties, since a collision
   * might occur that causes an incorrect job submission.
   * 
   *
   * repeated string args = 3 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @param index The index of the value to return.
   * @return The bytes of the args at the given index.
   */
  com.google.protobuf.ByteString getArgsBytes(int index);

  /**
   *
   *
   *    * Optional. HCFS URIs of jar files to add to the CLASSPATHs of the
   * Flink driver and tasks.
   * 
   *
   * repeated string jar_file_uris = 4 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return A list containing the jarFileUris.
   */
  java.util.List getJarFileUrisList();
  /**
   *
   *
   *    * Optional. HCFS URIs of jar files to add to the CLASSPATHs of the
   * Flink driver and tasks.
   * 
   *
   * repeated string jar_file_uris = 4 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The count of jarFileUris.
   */
  int getJarFileUrisCount();
  /**
   *
   *
   *    * Optional. HCFS URIs of jar files to add to the CLASSPATHs of the
   * Flink driver and tasks.
   * 
   *
   * repeated string jar_file_uris = 4 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @param index The index of the element to return.
   * @return The jarFileUris at the given index.
   */
  java.lang.String getJarFileUris(int index);
  /**
   *
   *
   *    * Optional. HCFS URIs of jar files to add to the CLASSPATHs of the
   * Flink driver and tasks.
   * 
   *
   * repeated string jar_file_uris = 4 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @param index The index of the value to return.
   * @return The bytes of the jarFileUris at the given index.
   */
  com.google.protobuf.ByteString getJarFileUrisBytes(int index);

  /**
   *
   *
   *    * Optional. HCFS URI of the savepoint, which contains the last saved progress
   * for starting the current job.
   * 
   *
   * string savepoint_uri = 9 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The savepointUri.
   */
  java.lang.String getSavepointUri();
  /**
   *
   *
   *    * Optional. HCFS URI of the savepoint, which contains the last saved progress
   * for starting the current job.
   * 
   *
   * string savepoint_uri = 9 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The bytes for savepointUri.
   */
  com.google.protobuf.ByteString getSavepointUriBytes();

  /**
   *
   *
   *    * Optional. A mapping of property names to values, used to configure Flink.
   * Properties that conflict with values set by the Dataproc API might be
   * overwritten. Can include properties set in
   * `/etc/flink/conf/flink-defaults.conf` and classes in user code.
   * 
   *
   * map<string, string> properties = 7 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  int getPropertiesCount();
  /**
   *
   *
   *    * Optional. A mapping of property names to values, used to configure Flink.
   * Properties that conflict with values set by the Dataproc API might be
   * overwritten. Can include properties set in
   * `/etc/flink/conf/flink-defaults.conf` and classes in user code.
   * 
   *
   * map<string, string> properties = 7 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  boolean containsProperties(java.lang.String key);
  /** Use {@link #getPropertiesMap()} instead. */
  @java.lang.Deprecated
  java.util.Map getProperties();
  /**
   *
   *
   *    * Optional. A mapping of property names to values, used to configure Flink.
   * Properties that conflict with values set by the Dataproc API might be
   * overwritten. Can include properties set in
   * `/etc/flink/conf/flink-defaults.conf` and classes in user code.
   * 
   *
   * map<string, string> properties = 7 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  java.util.Map getPropertiesMap();
  /**
   *
   *
   *    * Optional. A mapping of property names to values, used to configure Flink.
   * Properties that conflict with values set by the Dataproc API might be
   * overwritten. Can include properties set in
   * `/etc/flink/conf/flink-defaults.conf` and classes in user code.
   * 
   *
   * map<string, string> properties = 7 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  /* nullable */
  java.lang.String getPropertiesOrDefault(
      java.lang.String key,
      /* nullable */
      java.lang.String defaultValue);
  /**
   *
   *
   *    * Optional. A mapping of property names to values, used to configure Flink.
   * Properties that conflict with values set by the Dataproc API might be
   * overwritten. Can include properties set in
   * `/etc/flink/conf/flink-defaults.conf` and classes in user code.
   * 
   *
   * map<string, string> properties = 7 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  java.lang.String getPropertiesOrThrow(java.lang.String key);

  /**
   *
   *
   *    * Optional. The runtime log config for job execution.
   * 
   *
   * 
   * .google.cloud.dataproc.v1.LoggingConfig logging_config = 8 [(.google.api.field_behavior) = OPTIONAL];
   * 
   *
   * @return Whether the loggingConfig field is set.
   */
  boolean hasLoggingConfig();
  /**
   *
   *
   *    * Optional. The runtime log config for job execution.
   * 
   *
   * 
   * .google.cloud.dataproc.v1.LoggingConfig logging_config = 8 [(.google.api.field_behavior) = OPTIONAL];
   * 
   *
   * @return The loggingConfig.
   */
  com.google.cloud.dataproc.v1.LoggingConfig getLoggingConfig();
  /**
   *
   *
   *    * Optional. The runtime log config for job execution.
   * 
   *
   * 
   * .google.cloud.dataproc.v1.LoggingConfig logging_config = 8 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  com.google.cloud.dataproc.v1.LoggingConfigOrBuilder getLoggingConfigOrBuilder();

  com.google.cloud.dataproc.v1.FlinkJob.DriverCase getDriverCase();
}