com.google.api.services.genomics.model.ExportReadGroupSetRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-genomics Show documentation
There is a newer version: v2alpha1-rev20220913-2.0.0
Show newest version
/*
 * Copyright 2010 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.
 */
/*
 * This code was generated by https://github.com/google/apis-client-generator/
 * (build: 2016-05-27 16:00:31 UTC)
 * on 2016-07-28 at 21:58:52 UTC 
 * Modify at your own risk.
 */

package com.google.api.services.genomics.model;

/**
 * The read group set export request.
 *
 *  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 Genomics 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 ExportReadGroupSetRequest extends com.google.api.client.json.GenericJson {

  /**
   * Required. A Google Cloud Storage URI for the exported BAM file. The currently authenticated
   * user must have write access to the new file. An error will be returned if the URI already
   * contains data.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String exportUri;

  /**
   * Required. The Google Developers Console project ID that owns this export. The caller must have
   * WRITE access to this project.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String projectId;

  /**
   * The reference names to export. If this is not specified, all reference sequences, including
   * unmapped reads, are exported. Use `*` to export only unmapped reads.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List referenceNames;

  /**
   * Required. A Google Cloud Storage URI for the exported BAM file. The currently authenticated
   * user must have write access to the new file. An error will be returned if the URI already
   * contains data.
   * @return value or {@code null} for none
   */
  public java.lang.String getExportUri() {
    return exportUri;
  }

  /**
   * Required. A Google Cloud Storage URI for the exported BAM file. The currently authenticated
   * user must have write access to the new file. An error will be returned if the URI already
   * contains data.
   * @param exportUri exportUri or {@code null} for none
   */
  public ExportReadGroupSetRequest setExportUri(java.lang.String exportUri) {
    this.exportUri = exportUri;
    return this;
  }

  /**
   * Required. The Google Developers Console project ID that owns this export. The caller must have
   * WRITE access to this project.
   * @return value or {@code null} for none
   */
  public java.lang.String getProjectId() {
    return projectId;
  }

  /**
   * Required. The Google Developers Console project ID that owns this export. The caller must have
   * WRITE access to this project.
   * @param projectId projectId or {@code null} for none
   */
  public ExportReadGroupSetRequest setProjectId(java.lang.String projectId) {
    this.projectId = projectId;
    return this;
  }

  /**
   * The reference names to export. If this is not specified, all reference sequences, including
   * unmapped reads, are exported. Use `*` to export only unmapped reads.
   * @return value or {@code null} for none
   */
  public java.util.List getReferenceNames() {
    return referenceNames;
  }

  /**
   * The reference names to export. If this is not specified, all reference sequences, including
   * unmapped reads, are exported. Use `*` to export only unmapped reads.
   * @param referenceNames referenceNames or {@code null} for none
   */
  public ExportReadGroupSetRequest setReferenceNames(java.util.List referenceNames) {
    this.referenceNames = referenceNames;
    return this;
  }

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

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

}