com.google.api.services.run.v1.model.ExecutionSpec Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-run Show documentation
There is a newer version: v2-rev20241213-2.0.0
Show 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.run.v1.model;

/**
 * ExecutionSpec describes how the execution will look.
 *
 *  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 Run Admin 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 ExecutionSpec extends com.google.api.client.json.GenericJson {

  /**
   * Optional. Specifies the maximum desired number of tasks the execution should run at given time.
   * Must be <= task_count. When the job is run, if this field is 0 or unset, the maximum possible
   * value will be used for that execution. The actual number of tasks running in steady state will
   * be less than this number when there are fewer tasks waiting to be completed, i.e. when the work
   * left to do is less than max parallelism.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer parallelism;

  /**
   * Optional. Specifies the desired number of tasks the execution should run. Setting to 1 means
   * that parallelism is limited to 1 and the success of that task signals the success of the
   * execution.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer taskCount;

  /**
   * Optional. Describes the task(s) that will be created when executing an execution.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private TaskTemplateSpec template;

  /**
   * Optional. Specifies the maximum desired number of tasks the execution should run at given time.
   * Must be <= task_count. When the job is run, if this field is 0 or unset, the maximum possible
   * value will be used for that execution. The actual number of tasks running in steady state will
   * be less than this number when there are fewer tasks waiting to be completed, i.e. when the work
   * left to do is less than max parallelism.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getParallelism() {
    return parallelism;
  }

  /**
   * Optional. Specifies the maximum desired number of tasks the execution should run at given time.
   * Must be <= task_count. When the job is run, if this field is 0 or unset, the maximum possible
   * value will be used for that execution. The actual number of tasks running in steady state will
   * be less than this number when there are fewer tasks waiting to be completed, i.e. when the work
   * left to do is less than max parallelism.
   * @param parallelism parallelism or {@code null} for none
   */
  public ExecutionSpec setParallelism(java.lang.Integer parallelism) {
    this.parallelism = parallelism;
    return this;
  }

  /**
   * Optional. Specifies the desired number of tasks the execution should run. Setting to 1 means
   * that parallelism is limited to 1 and the success of that task signals the success of the
   * execution.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getTaskCount() {
    return taskCount;
  }

  /**
   * Optional. Specifies the desired number of tasks the execution should run. Setting to 1 means
   * that parallelism is limited to 1 and the success of that task signals the success of the
   * execution.
   * @param taskCount taskCount or {@code null} for none
   */
  public ExecutionSpec setTaskCount(java.lang.Integer taskCount) {
    this.taskCount = taskCount;
    return this;
  }

  /**
   * Optional. Describes the task(s) that will be created when executing an execution.
   * @return value or {@code null} for none
   */
  public TaskTemplateSpec getTemplate() {
    return template;
  }

  /**
   * Optional. Describes the task(s) that will be created when executing an execution.
   * @param template template or {@code null} for none
   */
  public ExecutionSpec setTemplate(TaskTemplateSpec template) {
    this.template = template;
    return this;
  }

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

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

}