com.google.api.services.dataproc.model.FlinkJob Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-dataproc Show documentation
The newest version!
/*
 * 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
 *
 * http://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.
 */
/*
 * This code was generated by https://github.com/googleapis/google-api-java-client-services/
 * Modify at your own risk.
 */

package com.google.api.services.dataproc.model;

/**
 * A Dataproc job for running Apache Flink applications on YARN.
 *
 *  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 * transmitted over HTTP when working with the Cloud Dataproc API. For a detailed explanation see:
 * https://developers.google.com/api-client-library/java/google-http-java-client/json
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class FlinkJob extends com.google.api.client.json.GenericJson {

  /**
   * 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.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List args;

  /**
   * Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Flink driver and tasks.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List jarFileUris;

  /**
   * Optional. The runtime log config for job execution.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private LoggingConfig loggingConfig;

  /**
   * 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.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String mainClass;

  /**
   * The HCFS URI of the jar file that contains the main class.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String mainJarFileUri;

  /**
   * 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.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.Map properties;

  /**
   * Optional. HCFS URI of the savepoint, which contains the last saved progress for starting the
   * current job.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String savepointUri;

  /**
   * 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.
   * @return value or {@code null} for none
   */
  public java.util.List getArgs() {
    return args;
  }

  /**
   * 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.
   * @param args args or {@code null} for none
   */
  public FlinkJob setArgs(java.util.List args) {
    this.args = args;
    return this;
  }

  /**
   * Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Flink driver and tasks.
   * @return value or {@code null} for none
   */
  public java.util.List getJarFileUris() {
    return jarFileUris;
  }

  /**
   * Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Flink driver and tasks.
   * @param jarFileUris jarFileUris or {@code null} for none
   */
  public FlinkJob setJarFileUris(java.util.List jarFileUris) {
    this.jarFileUris = jarFileUris;
    return this;
  }

  /**
   * Optional. The runtime log config for job execution.
   * @return value or {@code null} for none
   */
  public LoggingConfig getLoggingConfig() {
    return loggingConfig;
  }

  /**
   * Optional. The runtime log config for job execution.
   * @param loggingConfig loggingConfig or {@code null} for none
   */
  public FlinkJob setLoggingConfig(LoggingConfig loggingConfig) {
    this.loggingConfig = loggingConfig;
    return this;
  }

  /**
   * 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.
   * @return value or {@code null} for none
   */
  public java.lang.String getMainClass() {
    return mainClass;
  }

  /**
   * 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.
   * @param mainClass mainClass or {@code null} for none
   */
  public FlinkJob setMainClass(java.lang.String mainClass) {
    this.mainClass = mainClass;
    return this;
  }

  /**
   * The HCFS URI of the jar file that contains the main class.
   * @return value or {@code null} for none
   */
  public java.lang.String getMainJarFileUri() {
    return mainJarFileUri;
  }

  /**
   * The HCFS URI of the jar file that contains the main class.
   * @param mainJarFileUri mainJarFileUri or {@code null} for none
   */
  public FlinkJob setMainJarFileUri(java.lang.String mainJarFileUri) {
    this.mainJarFileUri = mainJarFileUri;
    return this;
  }

  /**
   * 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.
   * @return value or {@code null} for none
   */
  public java.util.Map getProperties() {
    return properties;
  }

  /**
   * 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.
   * @param properties properties or {@code null} for none
   */
  public FlinkJob setProperties(java.util.Map properties) {
    this.properties = properties;
    return this;
  }

  /**
   * Optional. HCFS URI of the savepoint, which contains the last saved progress for starting the
   * current job.
   * @return value or {@code null} for none
   */
  public java.lang.String getSavepointUri() {
    return savepointUri;
  }

  /**
   * Optional. HCFS URI of the savepoint, which contains the last saved progress for starting the
   * current job.
   * @param savepointUri savepointUri or {@code null} for none
   */
  public FlinkJob setSavepointUri(java.lang.String savepointUri) {
    this.savepointUri = savepointUri;
    return this;
  }

  @Override
  public FlinkJob set(String fieldName, Object value) {
    return (FlinkJob) super.set(fieldName, value);
  }

  @Override
  public FlinkJob clone() {
    return (FlinkJob) super.clone();
  }

}