com.google.api.services.genomics.model.SearchReadsRequest Maven / Gradle / Ivy
/*
* 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 search 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 SearchReadsRequest extends com.google.api.client.json.GenericJson {
/**
* The end position of the range on the reference, 0-based exclusive. If specified,
* `referenceName` must also be specified.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key @com.google.api.client.json.JsonString
private java.lang.Long end;
/**
* The maximum number of results to return in a single page. If unspecified, defaults to 256. The
* maximum value is 2048.
* 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;
/**
* The IDs of the read groups within which to search for reads. All specified read groups must
* belong to the same read group sets. Must specify one of `readGroupSetIds` or `readGroupIds`.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List readGroupIds;
/**
* The IDs of the read groups sets within which to search for reads. All specified read group sets
* must be aligned against a common set of reference sequences; this defines the genomic
* coordinates for the query. Must specify one of `readGroupSetIds` or `readGroupIds`.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List readGroupSetIds;
/**
* The reference sequence name, for example `chr1`, `1`, or `chrX`. If set to `*`, only unmapped
* reads are returned. If unspecified, all reads (mapped and unmapped) are returned.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String referenceName;
/**
* The start position of the range on the reference, 0-based inclusive. If specified,
* `referenceName` must also be specified.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key @com.google.api.client.json.JsonString
private java.lang.Long start;
/**
* The end position of the range on the reference, 0-based exclusive. If specified,
* `referenceName` must also be specified.
* @return value or {@code null} for none
*/
public java.lang.Long getEnd() {
return end;
}
/**
* The end position of the range on the reference, 0-based exclusive. If specified,
* `referenceName` must also be specified.
* @param end end or {@code null} for none
*/
public SearchReadsRequest setEnd(java.lang.Long end) {
this.end = end;
return this;
}
/**
* The maximum number of results to return in a single page. If unspecified, defaults to 256. The
* maximum value is 2048.
* @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 256. The
* maximum value is 2048.
* @param pageSize pageSize or {@code null} for none
*/
public SearchReadsRequest 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 SearchReadsRequest setPageToken(java.lang.String pageToken) {
this.pageToken = pageToken;
return this;
}
/**
* The IDs of the read groups within which to search for reads. All specified read groups must
* belong to the same read group sets. Must specify one of `readGroupSetIds` or `readGroupIds`.
* @return value or {@code null} for none
*/
public java.util.List getReadGroupIds() {
return readGroupIds;
}
/**
* The IDs of the read groups within which to search for reads. All specified read groups must
* belong to the same read group sets. Must specify one of `readGroupSetIds` or `readGroupIds`.
* @param readGroupIds readGroupIds or {@code null} for none
*/
public SearchReadsRequest setReadGroupIds(java.util.List readGroupIds) {
this.readGroupIds = readGroupIds;
return this;
}
/**
* The IDs of the read groups sets within which to search for reads. All specified read group sets
* must be aligned against a common set of reference sequences; this defines the genomic
* coordinates for the query. Must specify one of `readGroupSetIds` or `readGroupIds`.
* @return value or {@code null} for none
*/
public java.util.List getReadGroupSetIds() {
return readGroupSetIds;
}
/**
* The IDs of the read groups sets within which to search for reads. All specified read group sets
* must be aligned against a common set of reference sequences; this defines the genomic
* coordinates for the query. Must specify one of `readGroupSetIds` or `readGroupIds`.
* @param readGroupSetIds readGroupSetIds or {@code null} for none
*/
public SearchReadsRequest setReadGroupSetIds(java.util.List readGroupSetIds) {
this.readGroupSetIds = readGroupSetIds;
return this;
}
/**
* The reference sequence name, for example `chr1`, `1`, or `chrX`. If set to `*`, only unmapped
* reads are returned. If unspecified, all reads (mapped and unmapped) are returned.
* @return value or {@code null} for none
*/
public java.lang.String getReferenceName() {
return referenceName;
}
/**
* The reference sequence name, for example `chr1`, `1`, or `chrX`. If set to `*`, only unmapped
* reads are returned. If unspecified, all reads (mapped and unmapped) are returned.
* @param referenceName referenceName or {@code null} for none
*/
public SearchReadsRequest setReferenceName(java.lang.String referenceName) {
this.referenceName = referenceName;
return this;
}
/**
* The start position of the range on the reference, 0-based inclusive. If specified,
* `referenceName` must also be specified.
* @return value or {@code null} for none
*/
public java.lang.Long getStart() {
return start;
}
/**
* The start position of the range on the reference, 0-based inclusive. If specified,
* `referenceName` must also be specified.
* @param start start or {@code null} for none
*/
public SearchReadsRequest setStart(java.lang.Long start) {
this.start = start;
return this;
}
@Override
public SearchReadsRequest set(String fieldName, Object value) {
return (SearchReadsRequest) super.set(fieldName, value);
}
@Override
public SearchReadsRequest clone() {
return (SearchReadsRequest) super.clone();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy