/*
 * 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;

/**
 * DataLabelingJob is used to trigger a human labeling job on unlabeled data from the following
 * Dataset:
 *
 * <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 GoogleCloudAiplatformV1beta1DataLabelingJob extends com.google.api.client.json.GenericJson {

  /**
   * Parameters that configure the active learning pipeline. Active learning will label the data
   * incrementally via several iterations. For every iteration, it will select a batch of data based
   * on the sampling strategy.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudAiplatformV1beta1ActiveLearningConfig activeLearningConfig;

  /**
   * Labels to assign to annotations generated by this DataLabelingJob. Label keys and values can be
   * no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric
   * characters, underscores and dashes. International characters are allowed. See
   * https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys
   * are prefixed with "aiplatform.googleapis.com/" and are immutable.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.Map<String, java.lang.String> annotationLabels;

  /**
   * Output only. Timestamp when this DataLabelingJob was created.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private String createTime;

  /**
   * Output only. Estimated cost(in US dollars) that the DataLabelingJob has incurred to date.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleTypeMoney currentSpend;

  /**
   * Required. Dataset resource names. Right now we only support labeling from a single Dataset.
   * Format: `projects/{project}/locations/{location}/datasets/{dataset}`
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List<java.lang.String> datasets;

  /**
   * Required. The user-defined name of the DataLabelingJob. The name can be up to 128 characters
   * long and can consist of any UTF-8 characters. Display name of a DataLabelingJob.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String displayName;

  /**
   * Customer-managed encryption key spec for a DataLabelingJob. If set, this DataLabelingJob will
   * be secured by this key. Note: Annotations created in the DataLabelingJob are associated with
   * the EncryptionSpec of the Dataset they are exported to.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudAiplatformV1beta1EncryptionSpec encryptionSpec;

  /**
   * Output only. DataLabelingJob errors. It is only populated when job's state is
   * `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleRpcStatus error;

  /**
   * Required. Input config parameters for the DataLabelingJob.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Object inputs;

  /**
   * Required. Points to a YAML file stored on Google Cloud Storage describing the config for a
   * specific type of DataLabelingJob. The schema files that can be used here are found in the
   * https://storage.googleapis.com/google-cloud-aiplatform bucket in the
   * /schema/datalabelingjob/inputs/ folder.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String inputsSchemaUri;

  /**
   * Required. The Google Cloud Storage location of the instruction pdf. This pdf is shared with
   * labelers, and provides detailed description on how to label DataItems in Datasets.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String instructionUri;

  /**
   * Required. Number of labelers to work on each DataItem.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer labelerCount;

  /**
   * Output only. Current labeling job progress percentage scaled in interval [0, 100], indicating
   * the percentage of DataItems that has been finished.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer labelingProgress;

  /**
   * The labels with user-defined metadata to organize your DataLabelingJobs. Label keys and values
   * can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters,
   * numeric characters, underscores and dashes. International characters are allowed. See
   * https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys
   * are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist
   * for each DataLabelingJob: * "aiplatform.googleapis.com/schema": output only, its value is the
   * inputs_schema's title.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.Map<String, java.lang.String> labels;

  /**
   * Output only. Resource name of the DataLabelingJob.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String name;

  /**
   * The SpecialistPools' resource names associated with this job.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List<java.lang.String> specialistPools;

  /**
   * Output only. The detailed state of the job.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String state;

  /**
   * Output only. Timestamp when this DataLabelingJob was updated most recently.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private String updateTime;

  /**
   * Parameters that configure the active learning pipeline. Active learning will label the data
   * incrementally via several iterations. For every iteration, it will select a batch of data based
   * on the sampling strategy.
   * @return value or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1ActiveLearningConfig getActiveLearningConfig() {
    return activeLearningConfig;
  }

  /**
   * Parameters that configure the active learning pipeline. Active learning will label the data
   * incrementally via several iterations. For every iteration, it will select a batch of data based
   * on the sampling strategy.
   * @param activeLearningConfig activeLearningConfig or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1DataLabelingJob setActiveLearningConfig(GoogleCloudAiplatformV1beta1ActiveLearningConfig activeLearningConfig) {
    this.activeLearningConfig = activeLearningConfig;
    return this;
  }

  /**
   * Labels to assign to annotations generated by this DataLabelingJob. Label keys and values can be
   * no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric
   * characters, underscores and dashes. International characters are allowed. See
   * https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys
   * are prefixed with "aiplatform.googleapis.com/" and are immutable.
   * @return value or {@code null} for none
   */
  public java.util.Map<String, java.lang.String> getAnnotationLabels() {
    return annotationLabels;
  }

  /**
   * Labels to assign to annotations generated by this DataLabelingJob. Label keys and values can be
   * no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric
   * characters, underscores and dashes. International characters are allowed. See
   * https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys
   * are prefixed with "aiplatform.googleapis.com/" and are immutable.
   * @param annotationLabels annotationLabels or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1DataLabelingJob setAnnotationLabels(java.util.Map<String, java.lang.String> annotationLabels) {
    this.annotationLabels = annotationLabels;
    return this;
  }

  /**
   * Output only. Timestamp when this DataLabelingJob was created.
   * @return value or {@code null} for none
   */
  public String getCreateTime() {
    return createTime;
  }

  /**
   * Output only. Timestamp when this DataLabelingJob was created.
   * @param createTime createTime or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1DataLabelingJob setCreateTime(String createTime) {
    this.createTime = createTime;
    return this;
  }

  /**
   * Output only. Estimated cost(in US dollars) that the DataLabelingJob has incurred to date.
   * @return value or {@code null} for none
   */
  public GoogleTypeMoney getCurrentSpend() {
    return currentSpend;
  }

  /**
   * Output only. Estimated cost(in US dollars) that the DataLabelingJob has incurred to date.
   * @param currentSpend currentSpend or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1DataLabelingJob setCurrentSpend(GoogleTypeMoney currentSpend) {
    this.currentSpend = currentSpend;
    return this;
  }

  /**
   * Required. Dataset resource names. Right now we only support labeling from a single Dataset.
   * Format: `projects/{project}/locations/{location}/datasets/{dataset}`
   * @return value or {@code null} for none
   */
  public java.util.List<java.lang.String> getDatasets() {
    return datasets;
  }

  /**
   * Required. Dataset resource names. Right now we only support labeling from a single Dataset.
   * Format: `projects/{project}/locations/{location}/datasets/{dataset}`
   * @param datasets datasets or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1DataLabelingJob setDatasets(java.util.List<java.lang.String> datasets) {
    this.datasets = datasets;
    return this;
  }

  /**
   * Required. The user-defined name of the DataLabelingJob. The name can be up to 128 characters
   * long and can consist of any UTF-8 characters. Display name of a DataLabelingJob.
   * @return value or {@code null} for none
   */
  public java.lang.String getDisplayName() {
    return displayName;
  }

  /**
   * Required. The user-defined name of the DataLabelingJob. The name can be up to 128 characters
   * long and can consist of any UTF-8 characters. Display name of a DataLabelingJob.
   * @param displayName displayName or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1DataLabelingJob setDisplayName(java.lang.String displayName) {
    this.displayName = displayName;
    return this;
  }

  /**
   * Customer-managed encryption key spec for a DataLabelingJob. If set, this DataLabelingJob will
   * be secured by this key. Note: Annotations created in the DataLabelingJob are associated with
   * the EncryptionSpec of the Dataset they are exported to.
   * @return value or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1EncryptionSpec getEncryptionSpec() {
    return encryptionSpec;
  }

  /**
   * Customer-managed encryption key spec for a DataLabelingJob. If set, this DataLabelingJob will
   * be secured by this key. Note: Annotations created in the DataLabelingJob are associated with
   * the EncryptionSpec of the Dataset they are exported to.
   * @param encryptionSpec encryptionSpec or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1DataLabelingJob setEncryptionSpec(GoogleCloudAiplatformV1beta1EncryptionSpec encryptionSpec) {
    this.encryptionSpec = encryptionSpec;
    return this;
  }

  /**
   * Output only. DataLabelingJob errors. It is only populated when job's state is
   * `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.
   * @return value or {@code null} for none
   */
  public GoogleRpcStatus getError() {
    return error;
  }

  /**
   * Output only. DataLabelingJob errors. It is only populated when job's state is
   * `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.
   * @param error error or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1DataLabelingJob setError(GoogleRpcStatus error) {
    this.error = error;
    return this;
  }

  /**
   * Required. Input config parameters for the DataLabelingJob.
   * @return value or {@code null} for none
   */
  public java.lang.Object getInputs() {
    return inputs;
  }

  /**
   * Required. Input config parameters for the DataLabelingJob.
   * @param inputs inputs or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1DataLabelingJob setInputs(java.lang.Object inputs) {
    this.inputs = inputs;
    return this;
  }

  /**
   * Required. Points to a YAML file stored on Google Cloud Storage describing the config for a
   * specific type of DataLabelingJob. The schema files that can be used here are found in the
   * https://storage.googleapis.com/google-cloud-aiplatform bucket in the
   * /schema/datalabelingjob/inputs/ folder.
   * @return value or {@code null} for none
   */
  public java.lang.String getInputsSchemaUri() {
    return inputsSchemaUri;
  }

  /**
   * Required. Points to a YAML file stored on Google Cloud Storage describing the config for a
   * specific type of DataLabelingJob. The schema files that can be used here are found in the
   * https://storage.googleapis.com/google-cloud-aiplatform bucket in the
   * /schema/datalabelingjob/inputs/ folder.
   * @param inputsSchemaUri inputsSchemaUri or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1DataLabelingJob setInputsSchemaUri(java.lang.String inputsSchemaUri) {
    this.inputsSchemaUri = inputsSchemaUri;
    return this;
  }

  /**
   * Required. The Google Cloud Storage location of the instruction pdf. This pdf is shared with
   * labelers, and provides detailed description on how to label DataItems in Datasets.
   * @return value or {@code null} for none
   */
  public java.lang.String getInstructionUri() {
    return instructionUri;
  }

  /**
   * Required. The Google Cloud Storage location of the instruction pdf. This pdf is shared with
   * labelers, and provides detailed description on how to label DataItems in Datasets.
   * @param instructionUri instructionUri or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1DataLabelingJob setInstructionUri(java.lang.String instructionUri) {
    this.instructionUri = instructionUri;
    return this;
  }

  /**
   * Required. Number of labelers to work on each DataItem.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getLabelerCount() {
    return labelerCount;
  }

  /**
   * Required. Number of labelers to work on each DataItem.
   * @param labelerCount labelerCount or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1DataLabelingJob setLabelerCount(java.lang.Integer labelerCount) {
    this.labelerCount = labelerCount;
    return this;
  }

  /**
   * Output only. Current labeling job progress percentage scaled in interval [0, 100], indicating
   * the percentage of DataItems that has been finished.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getLabelingProgress() {
    return labelingProgress;
  }

  /**
   * Output only. Current labeling job progress percentage scaled in interval [0, 100], indicating
   * the percentage of DataItems that has been finished.
   * @param labelingProgress labelingProgress or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1DataLabelingJob setLabelingProgress(java.lang.Integer labelingProgress) {
    this.labelingProgress = labelingProgress;
    return this;
  }

  /**
   * The labels with user-defined metadata to organize your DataLabelingJobs. Label keys and values
   * can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters,
   * numeric characters, underscores and dashes. International characters are allowed. See
   * https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys
   * are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist
   * for each DataLabelingJob: * "aiplatform.googleapis.com/schema": output only, its value is the
   * inputs_schema's title.
   * @return value or {@code null} for none
   */
  public java.util.Map<String, java.lang.String> getLabels() {
    return labels;
  }

  /**
   * The labels with user-defined metadata to organize your DataLabelingJobs. Label keys and values
   * can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters,
   * numeric characters, underscores and dashes. International characters are allowed. See
   * https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys
   * are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist
   * for each DataLabelingJob: * "aiplatform.googleapis.com/schema": output only, its value is the
   * inputs_schema's title.
   * @param labels labels or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1DataLabelingJob setLabels(java.util.Map<String, java.lang.String> labels) {
    this.labels = labels;
    return this;
  }

  /**
   * Output only. Resource name of the DataLabelingJob.
   * @return value or {@code null} for none
   */
  public java.lang.String getName() {
    return name;
  }

  /**
   * Output only. Resource name of the DataLabelingJob.
   * @param name name or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1DataLabelingJob setName(java.lang.String name) {
    this.name = name;
    return this;
  }

  /**
   * The SpecialistPools' resource names associated with this job.
   * @return value or {@code null} for none
   */
  public java.util.List<java.lang.String> getSpecialistPools() {
    return specialistPools;
  }

  /**
   * The SpecialistPools' resource names associated with this job.
   * @param specialistPools specialistPools or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1DataLabelingJob setSpecialistPools(java.util.List<java.lang.String> specialistPools) {
    this.specialistPools = specialistPools;
    return this;
  }

  /**
   * Output only. The detailed state of the job.
   * @return value or {@code null} for none
   */
  public java.lang.String getState() {
    return state;
  }

  /**
   * Output only. The detailed state of the job.
   * @param state state or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1DataLabelingJob setState(java.lang.String state) {
    this.state = state;
    return this;
  }

  /**
   * Output only. Timestamp when this DataLabelingJob was updated most recently.
   * @return value or {@code null} for none
   */
  public String getUpdateTime() {
    return updateTime;
  }

  /**
   * Output only. Timestamp when this DataLabelingJob was updated most recently.
   * @param updateTime updateTime or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1DataLabelingJob setUpdateTime(String updateTime) {
    this.updateTime = updateTime;
    return this;
  }

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

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

}
