com.google.api.services.batch.v1.model.ComputeResource Maven / Gradle / Ivy

Go to download
/*
 * 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.batch.v1.model;

/**
 * Compute resource requirements. ComputeResource defines the amount of resources required for each
 * task. Make sure your tasks have enough resources to successfully run. If you also define the
 * types of resources for a job to use with the [InstancePolicyOrTemplate](https://cloud.google.com/
 * batch/docs/reference/rest/v1/projects.locations.jobs#instancepolicyortemplate) field, make sure
 * both fields are compatible with each other.
 *
 *  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 Batch 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 ComputeResource extends com.google.api.client.json.GenericJson {

  /**
   * Extra boot disk size in MiB for each task.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key @com.google.api.client.json.JsonString
  private java.lang.Long bootDiskMib;

  /**
   * The milliCPU count. `cpuMilli` defines the amount of CPU resources per task in milliCPU units.
   * For example, `1000` corresponds to 1 vCPU per task. If undefined, the default value is `2000`.
   * If you also define the VM's machine type using the `machineType` in [InstancePolicy](https://cl
   * oud.google.com/batch/docs/reference/rest/v1/projects.locations.jobs#instancepolicy) field or
   * inside the `instanceTemplate` in the [InstancePolicyOrTemplate](https://cloud.google.com/batch/
   * docs/reference/rest/v1/projects.locations.jobs#instancepolicyortemplate) field, make sure the
   * CPU resources for both fields are compatible with each other and with how many tasks you want
   * to allow to run on the same VM at the same time. For example, if you specify the
   * `n2-standard-2` machine type, which has 2 vCPUs each, you are recommended to set `cpuMilli` no
   * more than `2000`, or you are recommended to run two tasks on the same VM if you set `cpuMilli`
   * to `1000` or less.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key @com.google.api.client.json.JsonString
  private java.lang.Long cpuMilli;

  /**
   * Memory in MiB. `memoryMib` defines the amount of memory per task in MiB units. If undefined,
   * the default value is `2000`. If you also define the VM's machine type using the `machineType`
   * in [InstancePolicy](https://cloud.google.com/batch/docs/reference/rest/v1/projects.locations.jo
   * bs#instancepolicy) field or inside the `instanceTemplate` in the [InstancePolicyOrTemplate](htt
   * ps://cloud.google.com/batch/docs/reference/rest/v1/projects.locations.jobs#instancepolicyortemp
   * late) field, make sure the memory resources for both fields are compatible with each other and
   * with how many tasks you want to allow to run on the same VM at the same time. For example, if
   * you specify the `n2-standard-2` machine type, which has 8 GiB each, you are recommended to set
   * `memoryMib` to no more than `8192`, or you are recommended to run two tasks on the same VM if
   * you set `memoryMib` to `4096` or less.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key @com.google.api.client.json.JsonString
  private java.lang.Long memoryMib;

  /**
   * Extra boot disk size in MiB for each task.
   * @return value or {@code null} for none
   */
  public java.lang.Long getBootDiskMib() {
    return bootDiskMib;
  }

  /**
   * Extra boot disk size in MiB for each task.
   * @param bootDiskMib bootDiskMib or {@code null} for none
   */
  public ComputeResource setBootDiskMib(java.lang.Long bootDiskMib) {
    this.bootDiskMib = bootDiskMib;
    return this;
  }

  /**
   * The milliCPU count. `cpuMilli` defines the amount of CPU resources per task in milliCPU units.
   * For example, `1000` corresponds to 1 vCPU per task. If undefined, the default value is `2000`.
   * If you also define the VM's machine type using the `machineType` in [InstancePolicy](https://cl
   * oud.google.com/batch/docs/reference/rest/v1/projects.locations.jobs#instancepolicy) field or
   * inside the `instanceTemplate` in the [InstancePolicyOrTemplate](https://cloud.google.com/batch/
   * docs/reference/rest/v1/projects.locations.jobs#instancepolicyortemplate) field, make sure the
   * CPU resources for both fields are compatible with each other and with how many tasks you want
   * to allow to run on the same VM at the same time. For example, if you specify the
   * `n2-standard-2` machine type, which has 2 vCPUs each, you are recommended to set `cpuMilli` no
   * more than `2000`, or you are recommended to run two tasks on the same VM if you set `cpuMilli`
   * to `1000` or less.
   * @return value or {@code null} for none
   */
  public java.lang.Long getCpuMilli() {
    return cpuMilli;
  }

  /**
   * The milliCPU count. `cpuMilli` defines the amount of CPU resources per task in milliCPU units.
   * For example, `1000` corresponds to 1 vCPU per task. If undefined, the default value is `2000`.
   * If you also define the VM's machine type using the `machineType` in [InstancePolicy](https://cl
   * oud.google.com/batch/docs/reference/rest/v1/projects.locations.jobs#instancepolicy) field or
   * inside the `instanceTemplate` in the [InstancePolicyOrTemplate](https://cloud.google.com/batch/
   * docs/reference/rest/v1/projects.locations.jobs#instancepolicyortemplate) field, make sure the
   * CPU resources for both fields are compatible with each other and with how many tasks you want
   * to allow to run on the same VM at the same time. For example, if you specify the
   * `n2-standard-2` machine type, which has 2 vCPUs each, you are recommended to set `cpuMilli` no
   * more than `2000`, or you are recommended to run two tasks on the same VM if you set `cpuMilli`
   * to `1000` or less.
   * @param cpuMilli cpuMilli or {@code null} for none
   */
  public ComputeResource setCpuMilli(java.lang.Long cpuMilli) {
    this.cpuMilli = cpuMilli;
    return this;
  }

  /**
   * Memory in MiB. `memoryMib` defines the amount of memory per task in MiB units. If undefined,
   * the default value is `2000`. If you also define the VM's machine type using the `machineType`
   * in [InstancePolicy](https://cloud.google.com/batch/docs/reference/rest/v1/projects.locations.jo
   * bs#instancepolicy) field or inside the `instanceTemplate` in the [InstancePolicyOrTemplate](htt
   * ps://cloud.google.com/batch/docs/reference/rest/v1/projects.locations.jobs#instancepolicyortemp
   * late) field, make sure the memory resources for both fields are compatible with each other and
   * with how many tasks you want to allow to run on the same VM at the same time. For example, if
   * you specify the `n2-standard-2` machine type, which has 8 GiB each, you are recommended to set
   * `memoryMib` to no more than `8192`, or you are recommended to run two tasks on the same VM if
   * you set `memoryMib` to `4096` or less.
   * @return value or {@code null} for none
   */
  public java.lang.Long getMemoryMib() {
    return memoryMib;
  }

  /**
   * Memory in MiB. `memoryMib` defines the amount of memory per task in MiB units. If undefined,
   * the default value is `2000`. If you also define the VM's machine type using the `machineType`
   * in [InstancePolicy](https://cloud.google.com/batch/docs/reference/rest/v1/projects.locations.jo
   * bs#instancepolicy) field or inside the `instanceTemplate` in the [InstancePolicyOrTemplate](htt
   * ps://cloud.google.com/batch/docs/reference/rest/v1/projects.locations.jobs#instancepolicyortemp
   * late) field, make sure the memory resources for both fields are compatible with each other and
   * with how many tasks you want to allow to run on the same VM at the same time. For example, if
   * you specify the `n2-standard-2` machine type, which has 8 GiB each, you are recommended to set
   * `memoryMib` to no more than `8192`, or you are recommended to run two tasks on the same VM if
   * you set `memoryMib` to `4096` or less.
   * @param memoryMib memoryMib or {@code null} for none
   */
  public ComputeResource setMemoryMib(java.lang.Long memoryMib) {
    this.memoryMib = memoryMib;
    return this;
  }

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

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

}