com.google.appengine.tools.pipeline.JobSetting Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of appengine-pipeline Show documentation
Google App Engine API for connecting together complex workflows
The newest version!
// Copyright 2011 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.appengine.tools.pipeline;

import java.io.Serializable;


/**
 * A setting for specifying to the framework some aspect of a Job's execution.
 *
 * @author [email protected] (Mitch Rudominer)
 */
public interface JobSetting extends Serializable {

  /**
   * A setting for specifying that a Job should not be run until the value slot
   * represented by the given {@code FutureValue} has been filled.
   */
  final class WaitForSetting implements JobSetting {

    private static final long serialVersionUID = 1961952679964049657L;
    private final Value futureValue;

    public WaitForSetting(Value value) {
      futureValue = value;
    }

    public Value getValue() {
      return futureValue;
    }
  }

  /**
   * An abstract parent object for integer settings.
   */
  abstract class IntValuedSetting implements JobSetting {

    private static final long serialVersionUID = -4853437803222515955L;
    private final int value;

    protected IntValuedSetting(int value) {
      this.value = value;
    }

    public int getValue() {
      return value;
    }

    @Override
    public String toString() {
      return getClass() + "[" + value + "]";
    }
  }

  /**
   * An abstract parent object for String settings.
   */
  abstract class StringValuedSetting implements JobSetting {

    private static final long serialVersionUID = 7756646651569386669L;
    private final String value;

    protected StringValuedSetting(String value) {
      this.value = value;
    }

    public String getValue() {
      return value;
    }

    @Override
    public String toString() {
      return getClass() + "[" + value + "]";
    }
  }

  /**
   * A setting for specifying how long to wait before retrying a failed job. The
   * wait time will be
   *
   *    * 
   * backoffSeconds * backoffFactor ^ attemptNumber
   * 
   * 
   *
   */
  final class BackoffSeconds extends IntValuedSetting {

    private static final long serialVersionUID = -8900842071483349275L;
    public static final int DEFAULT = 15;

    public BackoffSeconds(int seconds) {
      super(seconds);
    }
  }

  /**
   * A setting for specifying how long to wait before retrying a failed job. The
   * wait time will be
   *
   *    * 
   * backoffSeconds * backoffFactor ^ attemptNumber
   * 
   * 
   *
   */
  final class BackoffFactor extends IntValuedSetting {

    private static final long serialVersionUID = 5879098639819720213L;
    public static final int DEFAULT = 2;

    public BackoffFactor(int factor) {
      super(factor);
    }
  }

  /**
   * A setting for specifying how many times to retry a failed job.
   */
  final class MaxAttempts extends IntValuedSetting {

    private static final long serialVersionUID = 8389745591294068656L;
    public static final int DEFAULT = 3;

    public MaxAttempts(int attempts) {
      super(attempts);
    }
  }

  /**
   * A setting for specifying what backend to run a job on.
   */
  final class OnBackend extends StringValuedSetting {

    private static final long serialVersionUID = -239968568113511744L;
    public static final String DEFAULT = null;

    public OnBackend(String backend) {
      super(backend);
    }
  }

  /**
   * A setting for specifying what module to run a job on.
   */
  final class OnModule extends StringValuedSetting {

    private static final long serialVersionUID = 3877411731586475273L;
    public static final String DEFAULT = null;

    public OnModule(String module) {
      super(module);
    }
  }

  /**
   * A setting for specifying what version to run a job on. This value is only
   * considered when OnModule is specified.
   */
  final class OnModuleVersion extends StringValuedSetting {

    private static final long serialVersionUID = 3342378839355476626L;
    public static final String DEFAULT = null;

    public OnModuleVersion(String moduleVersion) {
      super(moduleVersion);
    }
  }

  /**
   * A setting for specifying which queue to run a job on.
   */
  final class OnQueue extends StringValuedSetting {

    private static final long serialVersionUID = -5010485721032395432L;
    public static final String DEFAULT = null;

    public OnQueue(String queue) {
      super(queue);
    }
  }

  /**
   * A setting specifying the job's status console URL.
   */
  final class StatusConsoleUrl extends StringValuedSetting {

    private static final long serialVersionUID = -3079475300434663590L;

    public StatusConsoleUrl(String statusConsoleUrl) {
      super(statusConsoleUrl);
    }
  }
}