com.google.api.services.genomics.model.SearchAnnotationSetsRequest 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;

/**
 * Model definition for SearchAnnotationSetsRequest.
 *
 *  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 SearchAnnotationSetsRequest extends com.google.api.client.json.GenericJson {

  /**
   * Required. The dataset IDs to search within. Caller must have `READ` access to these datasets.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List datasetIds;

  /**
   * Only return annotations sets for which a substring of the name matches this string (case
   * insensitive).
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String name;

  /**
   * The maximum number of results to return in a single page. If unspecified, defaults to 128. The
   * maximum value is 1024.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer pageSize;

  /**
   * The continuation token, which is used to page through large result sets. To get the next page
   * of results, set this parameter to the value of `nextPageToken` from the previous response.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String pageToken;

  /**
   * If specified, only annotation sets associated with the given reference set are returned.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String referenceSetId;

  /**
   * If specified, only annotation sets that have any of these types are returned.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List types;

  /**
   * Required. The dataset IDs to search within. Caller must have `READ` access to these datasets.
   * @return value or {@code null} for none
   */
  public java.util.List getDatasetIds() {
    return datasetIds;
  }

  /**
   * Required. The dataset IDs to search within. Caller must have `READ` access to these datasets.
   * @param datasetIds datasetIds or {@code null} for none
   */
  public SearchAnnotationSetsRequest setDatasetIds(java.util.List datasetIds) {
    this.datasetIds = datasetIds;
    return this;
  }

  /**
   * Only return annotations sets for which a substring of the name matches this string (case
   * insensitive).
   * @return value or {@code null} for none
   */
  public java.lang.String getName() {
    return name;
  }

  /**
   * Only return annotations sets for which a substring of the name matches this string (case
   * insensitive).
   * @param name name or {@code null} for none
   */
  public SearchAnnotationSetsRequest setName(java.lang.String name) {
    this.name = name;
    return this;
  }

  /**
   * The maximum number of results to return in a single page. If unspecified, defaults to 128. The
   * maximum value is 1024.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getPageSize() {
    return pageSize;
  }

  /**
   * The maximum number of results to return in a single page. If unspecified, defaults to 128. The
   * maximum value is 1024.
   * @param pageSize pageSize or {@code null} for none
   */
  public SearchAnnotationSetsRequest setPageSize(java.lang.Integer pageSize) {
    this.pageSize = pageSize;
    return this;
  }

  /**
   * The continuation token, which is used to page through large result sets. To get the next page
   * of results, set this parameter to the value of `nextPageToken` from the previous response.
   * @return value or {@code null} for none
   */
  public java.lang.String getPageToken() {
    return pageToken;
  }

  /**
   * The continuation token, which is used to page through large result sets. To get the next page
   * of results, set this parameter to the value of `nextPageToken` from the previous response.
   * @param pageToken pageToken or {@code null} for none
   */
  public SearchAnnotationSetsRequest setPageToken(java.lang.String pageToken) {
    this.pageToken = pageToken;
    return this;
  }

  /**
   * If specified, only annotation sets associated with the given reference set are returned.
   * @return value or {@code null} for none
   */
  public java.lang.String getReferenceSetId() {
    return referenceSetId;
  }

  /**
   * If specified, only annotation sets associated with the given reference set are returned.
   * @param referenceSetId referenceSetId or {@code null} for none
   */
  public SearchAnnotationSetsRequest setReferenceSetId(java.lang.String referenceSetId) {
    this.referenceSetId = referenceSetId;
    return this;
  }

  /**
   * If specified, only annotation sets that have any of these types are returned.
   * @return value or {@code null} for none
   */
  public java.util.List getTypes() {
    return types;
  }

  /**
   * If specified, only annotation sets that have any of these types are returned.
   * @param types types or {@code null} for none
   */
  public SearchAnnotationSetsRequest setTypes(java.util.List types) {
    this.types = types;
    return this;
  }

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

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

}