com.google.cloud.dataflow.sdk.options.DataflowProfilingOptions Maven / Gradle / Ivy

Go to download

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.options;

import com.google.cloud.dataflow.sdk.annotations.Experimental;

import java.util.HashMap;

/**
 * Options for controlling profiling of pipeline execution.
 */
@Description("[Experimental] Used to configure profiling of the Dataflow pipeline")
@Experimental
@Hidden
public interface DataflowProfilingOptions {

  @Description("Whether to periodically dump profiling information to local disk.\n"
      + "WARNING: Enabling this option may fill local disk with profiling information.")
  boolean getEnableProfilingAgent();
  void setEnableProfilingAgent(boolean enabled);

  @Description(
      "[INTERNAL] Additional configuration for the profiling agent. Not typically necessary.")
  @Hidden
  DataflowProfilingAgentConfiguration getProfilingAgentConfiguration();
  void setProfilingAgentConfiguration(DataflowProfilingAgentConfiguration configuration);

  /**
   * Configuration the for profiling agent.
   */
  public static class DataflowProfilingAgentConfiguration extends HashMap {
  }
}