com.google.cloud.dataflow.sdk.runners.DataflowPipelineRunnerHooks Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of google-cloud-dataflow-java-sdk-all Show documentation

Google Cloud Dataflow Java SDK provides a simple, Java-based interface for processing virtually any size data using Google cloud resources. This artifact includes entire Dataflow Java SDK.

There is a newer version: 2.5.0

Show newest version

/*
 * Copyright (C) 2015 Google Inc.
 *
 * 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.
 */

package com.google.cloud.dataflow.sdk.runners;

import com.google.api.services.dataflow.model.Environment;
import com.google.cloud.dataflow.sdk.annotations.Experimental;

/**
 * An instance of this class can be passed to the
 * {@link DataflowPipelineRunner} to add user defined hooks to be
 * invoked at various times during pipeline execution.
 */
@Experimental
public class DataflowPipelineRunnerHooks {
  /**
   * Allows the user to modify the environment of their job before their job is submitted
   * to the service for execution.
   *
   * @param environment The environment of the job. Users can make change to this instance in order
   *     to change the environment with which their job executes on the service.
   */
  public void modifyEnvironmentBeforeSubmission(Environment environment) {}

  /** Allows the user to specify whether the job should actually be executed. */
  public boolean shouldActuallyRunJob() {
    return true;
  }

  /** Specifies whether the runner should fail if it fails to write to a job file. */
  public boolean failOnJobFileWriteFailure() {
    return false;
  }
}