/*
 * 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.aiplatform.v1beta1.model;

/**
 * Represents the spec of a CustomJob.
 *
 * <p> 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 Vertex AI API. For a detailed explanation see:
 * <a href="https://developers.google.com/api-client-library/java/google-http-java-client/json">https://developers.google.com/api-client-library/java/google-http-java-client/json</a>
 * </p>
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class GoogleCloudAiplatformV1beta1CustomJobSpec extends com.google.api.client.json.GenericJson {

  /**
   * The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob.
   * For HyperparameterTuningJob, the baseOutputDirectory of each child CustomJob backing a Trial is
   * set to a subdirectory of name id under its parent HyperparameterTuningJob's
   * baseOutputDirectory. The following Vertex AI environment variables will be passed to containers
   * or python modules when this field is set: For CustomJob: * AIP_MODEL_DIR = `/model/` *
   * AIP_CHECKPOINT_DIR = `/checkpoints/` * AIP_TENSORBOARD_LOG_DIR = `/logs/` For CustomJob backing
   * a Trial of HyperparameterTuningJob: * AIP_MODEL_DIR = `//model/` * AIP_CHECKPOINT_DIR =
   * `//checkpoints/` * AIP_TENSORBOARD_LOG_DIR = `//logs/`
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudAiplatformV1beta1GcsDestination baseOutputDirectory;

  /**
   * Optional. Whether you want Vertex AI to enable access to the customized dashboard in training
   * chief container. If set to `true`, you can access the dashboard at the URIs given by
   * CustomJob.web_access_uris or Trial.web_access_uris (within HyperparameterTuningJob.trials).
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean enableDashboardAccess;

  /**
   * Optional. Whether you want Vertex AI to enable [interactive shell
   * access](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) to
   * training containers. If set to `true`, you can access interactive shells at the URIs given by
   * CustomJob.web_access_uris or Trial.web_access_uris (within HyperparameterTuningJob.trials).
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean enableWebAccess;

  /**
   * Optional. The Experiment associated with this job. Format:
   * `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-
   * name}`
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String experiment;

  /**
   * Optional. The Experiment Run associated with this job. Format:
   * `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-
   * name}-{experiment-run-name}`
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String experimentRun;

  /**
   * Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-
   * firewalls#networks) to which the Job should be peered. For example,
   * `projects/12345/global/networks/myVPC`.
   * [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form
   * `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in
   * `12345`, and {network} is a network name. To specify this field, you must have already
   * [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general
   * /vpc-peering). If this field is left unspecified, the job is not peered with any network.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String network;

  /**
   * Optional. The ID of the PersistentResource in the same Project and Location which to run If
   * this is specified, the job will be run on existing machines held by the PersistentResource
   * instead of on-demand short-live machines. The network and CMEK configs on the job should be
   * consistent with those on the PersistentResource, otherwise, the job will be rejected.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String persistentResourceId;

  /**
   * Optional. A list of names for the reserved ip ranges under the VPC network that can be used for
   * this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will
   * be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List<java.lang.String> reservedIpRanges;

  /**
   * Scheduling options for a CustomJob.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudAiplatformV1beta1Scheduling scheduling;

  /**
   * Specifies the service account for workload run-as account. Users submitting jobs must have act-
   * as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service
   * Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the
   * CustomJob's project is used.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String serviceAccount;

  /**
   * Optional. The name of a Vertex AI Tensorboard resource to which this CustomJob will upload
   * Tensorboard logs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String tensorboard;

  /**
   * Required. The spec of the worker pools including machine type and Docker image. All worker
   * pools except the first one are optional and can be skipped by providing an empty value.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List<GoogleCloudAiplatformV1beta1WorkerPoolSpec> workerPoolSpecs;

  /**
   * The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob.
   * For HyperparameterTuningJob, the baseOutputDirectory of each child CustomJob backing a Trial is
   * set to a subdirectory of name id under its parent HyperparameterTuningJob's
   * baseOutputDirectory. The following Vertex AI environment variables will be passed to containers
   * or python modules when this field is set: For CustomJob: * AIP_MODEL_DIR = `/model/` *
   * AIP_CHECKPOINT_DIR = `/checkpoints/` * AIP_TENSORBOARD_LOG_DIR = `/logs/` For CustomJob backing
   * a Trial of HyperparameterTuningJob: * AIP_MODEL_DIR = `//model/` * AIP_CHECKPOINT_DIR =
   * `//checkpoints/` * AIP_TENSORBOARD_LOG_DIR = `//logs/`
   * @return value or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1GcsDestination getBaseOutputDirectory() {
    return baseOutputDirectory;
  }

  /**
   * The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob.
   * For HyperparameterTuningJob, the baseOutputDirectory of each child CustomJob backing a Trial is
   * set to a subdirectory of name id under its parent HyperparameterTuningJob's
   * baseOutputDirectory. The following Vertex AI environment variables will be passed to containers
   * or python modules when this field is set: For CustomJob: * AIP_MODEL_DIR = `/model/` *
   * AIP_CHECKPOINT_DIR = `/checkpoints/` * AIP_TENSORBOARD_LOG_DIR = `/logs/` For CustomJob backing
   * a Trial of HyperparameterTuningJob: * AIP_MODEL_DIR = `//model/` * AIP_CHECKPOINT_DIR =
   * `//checkpoints/` * AIP_TENSORBOARD_LOG_DIR = `//logs/`
   * @param baseOutputDirectory baseOutputDirectory or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1CustomJobSpec setBaseOutputDirectory(GoogleCloudAiplatformV1beta1GcsDestination baseOutputDirectory) {
    this.baseOutputDirectory = baseOutputDirectory;
    return this;
  }

  /**
   * Optional. Whether you want Vertex AI to enable access to the customized dashboard in training
   * chief container. If set to `true`, you can access the dashboard at the URIs given by
   * CustomJob.web_access_uris or Trial.web_access_uris (within HyperparameterTuningJob.trials).
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getEnableDashboardAccess() {
    return enableDashboardAccess;
  }

  /**
   * Optional. Whether you want Vertex AI to enable access to the customized dashboard in training
   * chief container. If set to `true`, you can access the dashboard at the URIs given by
   * CustomJob.web_access_uris or Trial.web_access_uris (within HyperparameterTuningJob.trials).
   * @param enableDashboardAccess enableDashboardAccess or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1CustomJobSpec setEnableDashboardAccess(java.lang.Boolean enableDashboardAccess) {
    this.enableDashboardAccess = enableDashboardAccess;
    return this;
  }

  /**
   * Optional. Whether you want Vertex AI to enable [interactive shell
   * access](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) to
   * training containers. If set to `true`, you can access interactive shells at the URIs given by
   * CustomJob.web_access_uris or Trial.web_access_uris (within HyperparameterTuningJob.trials).
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getEnableWebAccess() {
    return enableWebAccess;
  }

  /**
   * Optional. Whether you want Vertex AI to enable [interactive shell
   * access](https://cloud.google.com/vertex-ai/docs/training/monitor-debug-interactive-shell) to
   * training containers. If set to `true`, you can access interactive shells at the URIs given by
   * CustomJob.web_access_uris or Trial.web_access_uris (within HyperparameterTuningJob.trials).
   * @param enableWebAccess enableWebAccess or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1CustomJobSpec setEnableWebAccess(java.lang.Boolean enableWebAccess) {
    this.enableWebAccess = enableWebAccess;
    return this;
  }

  /**
   * Optional. The Experiment associated with this job. Format:
   * `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-
   * name}`
   * @return value or {@code null} for none
   */
  public java.lang.String getExperiment() {
    return experiment;
  }

  /**
   * Optional. The Experiment associated with this job. Format:
   * `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-
   * name}`
   * @param experiment experiment or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1CustomJobSpec setExperiment(java.lang.String experiment) {
    this.experiment = experiment;
    return this;
  }

  /**
   * Optional. The Experiment Run associated with this job. Format:
   * `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-
   * name}-{experiment-run-name}`
   * @return value or {@code null} for none
   */
  public java.lang.String getExperimentRun() {
    return experimentRun;
  }

  /**
   * Optional. The Experiment Run associated with this job. Format:
   * `projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-
   * name}-{experiment-run-name}`
   * @param experimentRun experimentRun or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1CustomJobSpec setExperimentRun(java.lang.String experimentRun) {
    this.experimentRun = experimentRun;
    return this;
  }

  /**
   * Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-
   * firewalls#networks) to which the Job should be peered. For example,
   * `projects/12345/global/networks/myVPC`.
   * [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form
   * `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in
   * `12345`, and {network} is a network name. To specify this field, you must have already
   * [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general
   * /vpc-peering). If this field is left unspecified, the job is not peered with any network.
   * @return value or {@code null} for none
   */
  public java.lang.String getNetwork() {
    return network;
  }

  /**
   * Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-
   * firewalls#networks) to which the Job should be peered. For example,
   * `projects/12345/global/networks/myVPC`.
   * [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form
   * `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in
   * `12345`, and {network} is a network name. To specify this field, you must have already
   * [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general
   * /vpc-peering). If this field is left unspecified, the job is not peered with any network.
   * @param network network or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1CustomJobSpec setNetwork(java.lang.String network) {
    this.network = network;
    return this;
  }

  /**
   * Optional. The ID of the PersistentResource in the same Project and Location which to run If
   * this is specified, the job will be run on existing machines held by the PersistentResource
   * instead of on-demand short-live machines. The network and CMEK configs on the job should be
   * consistent with those on the PersistentResource, otherwise, the job will be rejected.
   * @return value or {@code null} for none
   */
  public java.lang.String getPersistentResourceId() {
    return persistentResourceId;
  }

  /**
   * Optional. The ID of the PersistentResource in the same Project and Location which to run If
   * this is specified, the job will be run on existing machines held by the PersistentResource
   * instead of on-demand short-live machines. The network and CMEK configs on the job should be
   * consistent with those on the PersistentResource, otherwise, the job will be rejected.
   * @param persistentResourceId persistentResourceId or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1CustomJobSpec setPersistentResourceId(java.lang.String persistentResourceId) {
    this.persistentResourceId = persistentResourceId;
    return this;
  }

  /**
   * Optional. A list of names for the reserved ip ranges under the VPC network that can be used for
   * this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will
   * be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
   * @return value or {@code null} for none
   */
  public java.util.List<java.lang.String> getReservedIpRanges() {
    return reservedIpRanges;
  }

  /**
   * Optional. A list of names for the reserved ip ranges under the VPC network that can be used for
   * this job. If set, we will deploy the job within the provided ip ranges. Otherwise, the job will
   * be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
   * @param reservedIpRanges reservedIpRanges or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1CustomJobSpec setReservedIpRanges(java.util.List<java.lang.String> reservedIpRanges) {
    this.reservedIpRanges = reservedIpRanges;
    return this;
  }

  /**
   * Scheduling options for a CustomJob.
   * @return value or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1Scheduling getScheduling() {
    return scheduling;
  }

  /**
   * Scheduling options for a CustomJob.
   * @param scheduling scheduling or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1CustomJobSpec setScheduling(GoogleCloudAiplatformV1beta1Scheduling scheduling) {
    this.scheduling = scheduling;
    return this;
  }

  /**
   * Specifies the service account for workload run-as account. Users submitting jobs must have act-
   * as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service
   * Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the
   * CustomJob's project is used.
   * @return value or {@code null} for none
   */
  public java.lang.String getServiceAccount() {
    return serviceAccount;
  }

  /**
   * Specifies the service account for workload run-as account. Users submitting jobs must have act-
   * as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service
   * Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the
   * CustomJob's project is used.
   * @param serviceAccount serviceAccount or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1CustomJobSpec setServiceAccount(java.lang.String serviceAccount) {
    this.serviceAccount = serviceAccount;
    return this;
  }

  /**
   * Optional. The name of a Vertex AI Tensorboard resource to which this CustomJob will upload
   * Tensorboard logs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
   * @return value or {@code null} for none
   */
  public java.lang.String getTensorboard() {
    return tensorboard;
  }

  /**
   * Optional. The name of a Vertex AI Tensorboard resource to which this CustomJob will upload
   * Tensorboard logs. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}`
   * @param tensorboard tensorboard or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1CustomJobSpec setTensorboard(java.lang.String tensorboard) {
    this.tensorboard = tensorboard;
    return this;
  }

  /**
   * Required. The spec of the worker pools including machine type and Docker image. All worker
   * pools except the first one are optional and can be skipped by providing an empty value.
   * @return value or {@code null} for none
   */
  public java.util.List<GoogleCloudAiplatformV1beta1WorkerPoolSpec> getWorkerPoolSpecs() {
    return workerPoolSpecs;
  }

  /**
   * Required. The spec of the worker pools including machine type and Docker image. All worker
   * pools except the first one are optional and can be skipped by providing an empty value.
   * @param workerPoolSpecs workerPoolSpecs or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1CustomJobSpec setWorkerPoolSpecs(java.util.List<GoogleCloudAiplatformV1beta1WorkerPoolSpec> workerPoolSpecs) {
    this.workerPoolSpecs = workerPoolSpecs;
    return this;
  }

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

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

}
