Class: Google::Apis::GenomicsV1::SearchReadGroupSetsRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/genomics_v1/classes.rb,
generated/google/apis/genomics_v1/representations.rb,
generated/google/apis/genomics_v1/representations.rb

Overview

The read group set search request.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ SearchReadGroupSetsRequest

Returns a new instance of SearchReadGroupSetsRequest



1622
1623
1624
# File 'generated/google/apis/genomics_v1/classes.rb', line 1622

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#dataset_idsArray<String>

Restricts this query to read group sets within the given datasets. At least one ID must be provided. Corresponds to the JSON property datasetIds

Returns:

  • (Array<String>)


1601
1602
1603
# File 'generated/google/apis/genomics_v1/classes.rb', line 1601

def dataset_ids
  @dataset_ids
end

#nameString

Only return read group sets for which a substring of the name matches this string. Corresponds to the JSON property name

Returns:

  • (String)


1607
1608
1609
# File 'generated/google/apis/genomics_v1/classes.rb', line 1607

def name
  @name
end

#page_sizeFixnum

The maximum number of results to return in a single page. If unspecified, defaults to 256. The maximum value is 1024. Corresponds to the JSON property pageSize

Returns:

  • (Fixnum)


1620
1621
1622
# File 'generated/google/apis/genomics_v1/classes.rb', line 1620

def page_size
  @page_size
end

#page_tokenString

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. Corresponds to the JSON property pageToken

Returns:

  • (String)


1614
1615
1616
# File 'generated/google/apis/genomics_v1/classes.rb', line 1614

def page_token
  @page_token
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1627
1628
1629
1630
1631
1632
# File 'generated/google/apis/genomics_v1/classes.rb', line 1627

def update!(**args)
  @dataset_ids = args[:dataset_ids] if args.key?(:dataset_ids)
  @name = args[:name] if args.key?(:name)
  @page_token = args[:page_token] if args.key?(:page_token)
  @page_size = args[:page_size] if args.key?(:page_size)
end