com.google.api.services.genomics.model.StreamReadsRequest 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-07-08 17:28:43 UTC)
* on 2016-10-05 at 01:24:23 UTC
* Modify at your own risk.
*/
package com.google.api.services.genomics.model;
/**
* The stream reads 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 StreamReadsRequest 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 Google Cloud project ID which will be billed for this access. The caller must have WRITE
* access to this project. Required.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String projectId;
/**
* The ID of the read group set from which to stream reads.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String readGroupSetId;
/**
* The reference sequence name, for example `chr1`, `1`, or `chrX`. If set to *, only unmapped
* reads are returned.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String referenceName;
/**
* Restricts results to a shard containing approximately `1/totalShards` of the normal response
* payload for this query. Results from a sharded request are disjoint from those returned by all
* queries which differ only in their shard parameter. A shard may yield 0 results; this is
* especially likely for large values of `totalShards`. Valid values are `[0, totalShards)`.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Integer shard;
/**
* 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;
/**
* Specifying `totalShards` causes a disjoint subset of the normal response payload to be returned
* for each query with a unique `shard` parameter specified. A best effort is made to yield
* equally sized shards. Sharding can be used to distribute processing amongst workers, where each
* worker is assigned a unique `shard` number and all workers specify the same `totalShards`
* number. The union of reads returned for all sharded queries `[0, totalShards)` is equal to
* those returned by a single unsharded query. Queries for different values of `totalShards` with
* common divisors will share shard boundaries. For example, streaming `shard` 2 of 5
* `totalShards` yields the same results as streaming `shard`s 4 and 5 of 10 `totalShards`. This
* property can be leveraged for adaptive retries.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Integer totalShards;
/**
* 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 StreamReadsRequest setEnd(java.lang.Long end) {
this.end = end;
return this;
}
/**
* The Google Cloud project ID which will be billed for this access. The caller must have WRITE
* access to this project. Required.
* @return value or {@code null} for none
*/
public java.lang.String getProjectId() {
return projectId;
}
/**
* The Google Cloud project ID which will be billed for this access. The caller must have WRITE
* access to this project. Required.
* @param projectId projectId or {@code null} for none
*/
public StreamReadsRequest setProjectId(java.lang.String projectId) {
this.projectId = projectId;
return this;
}
/**
* The ID of the read group set from which to stream reads.
* @return value or {@code null} for none
*/
public java.lang.String getReadGroupSetId() {
return readGroupSetId;
}
/**
* The ID of the read group set from which to stream reads.
* @param readGroupSetId readGroupSetId or {@code null} for none
*/
public StreamReadsRequest setReadGroupSetId(java.lang.String readGroupSetId) {
this.readGroupSetId = readGroupSetId;
return this;
}
/**
* The reference sequence name, for example `chr1`, `1`, or `chrX`. If set to *, only unmapped
* reads 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.
* @param referenceName referenceName or {@code null} for none
*/
public StreamReadsRequest setReferenceName(java.lang.String referenceName) {
this.referenceName = referenceName;
return this;
}
/**
* Restricts results to a shard containing approximately `1/totalShards` of the normal response
* payload for this query. Results from a sharded request are disjoint from those returned by all
* queries which differ only in their shard parameter. A shard may yield 0 results; this is
* especially likely for large values of `totalShards`. Valid values are `[0, totalShards)`.
* @return value or {@code null} for none
*/
public java.lang.Integer getShard() {
return shard;
}
/**
* Restricts results to a shard containing approximately `1/totalShards` of the normal response
* payload for this query. Results from a sharded request are disjoint from those returned by all
* queries which differ only in their shard parameter. A shard may yield 0 results; this is
* especially likely for large values of `totalShards`. Valid values are `[0, totalShards)`.
* @param shard shard or {@code null} for none
*/
public StreamReadsRequest setShard(java.lang.Integer shard) {
this.shard = shard;
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 StreamReadsRequest setStart(java.lang.Long start) {
this.start = start;
return this;
}
/**
* Specifying `totalShards` causes a disjoint subset of the normal response payload to be returned
* for each query with a unique `shard` parameter specified. A best effort is made to yield
* equally sized shards. Sharding can be used to distribute processing amongst workers, where each
* worker is assigned a unique `shard` number and all workers specify the same `totalShards`
* number. The union of reads returned for all sharded queries `[0, totalShards)` is equal to
* those returned by a single unsharded query. Queries for different values of `totalShards` with
* common divisors will share shard boundaries. For example, streaming `shard` 2 of 5
* `totalShards` yields the same results as streaming `shard`s 4 and 5 of 10 `totalShards`. This
* property can be leveraged for adaptive retries.
* @return value or {@code null} for none
*/
public java.lang.Integer getTotalShards() {
return totalShards;
}
/**
* Specifying `totalShards` causes a disjoint subset of the normal response payload to be returned
* for each query with a unique `shard` parameter specified. A best effort is made to yield
* equally sized shards. Sharding can be used to distribute processing amongst workers, where each
* worker is assigned a unique `shard` number and all workers specify the same `totalShards`
* number. The union of reads returned for all sharded queries `[0, totalShards)` is equal to
* those returned by a single unsharded query. Queries for different values of `totalShards` with
* common divisors will share shard boundaries. For example, streaming `shard` 2 of 5
* `totalShards` yields the same results as streaming `shard`s 4 and 5 of 10 `totalShards`. This
* property can be leveraged for adaptive retries.
* @param totalShards totalShards or {@code null} for none
*/
public StreamReadsRequest setTotalShards(java.lang.Integer totalShards) {
this.totalShards = totalShards;
return this;
}
@Override
public StreamReadsRequest set(String fieldName, Object value) {
return (StreamReadsRequest) super.set(fieldName, value);
}
@Override
public StreamReadsRequest clone() {
return (StreamReadsRequest) super.clone();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy