xref: /aosp_15_r20/external/googleapis/google/genomics/v1/readgroupset.proto (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
1// Copyright 2016 Google Inc.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15syntax = "proto3";
16
17package google.genomics.v1;
18
19import "google/api/annotations.proto";
20import "google/genomics/v1/readgroup.proto";
21import "google/protobuf/struct.proto";
22
23option cc_enable_arenas = true;
24option go_package = "google.golang.org/genproto/googleapis/genomics/v1;genomics";
25option java_multiple_files = true;
26option java_outer_classname = "ReadGroupSetProto";
27option java_package = "com.google.genomics.v1";
28
29// A read group set is a logical collection of read groups, which are
30// collections of reads produced by a sequencer. A read group set typically
31// models reads corresponding to one sample, sequenced one way, and aligned one
32// way.
33//
34// * A read group set belongs to one dataset.
35// * A read group belongs to one read group set.
36// * A read belongs to one read group.
37//
38// For more genomics resource definitions, see [Fundamentals of Google
39// Genomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)
40message ReadGroupSet {
41  // The server-generated read group set ID, unique for all read group sets.
42  string id = 1;
43
44  // The dataset to which this read group set belongs.
45  string dataset_id = 2;
46
47  // The reference set to which the reads in this read group set are aligned.
48  string reference_set_id = 3;
49
50  // The read group set name. By default this will be initialized to the sample
51  // name of the sequenced data contained in this set.
52  string name = 4;
53
54  // The filename of the original source file for this read group set, if any.
55  string filename = 5;
56
57  // The read groups in this set. There are typically 1-10 read groups in a read
58  // group set.
59  repeated ReadGroup read_groups = 6;
60
61  // A map of additional read group set information.
62  map<string, google.protobuf.ListValue> info = 7;
63}
64