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



2701
2702
2703
# File 'generated/google/apis/genomics_v1/classes.rb', line 2701

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>)


2680
2681
2682
# File 'generated/google/apis/genomics_v1/classes.rb', line 2680

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)


2686
2687
2688
# File 'generated/google/apis/genomics_v1/classes.rb', line 2686

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)


2692
2693
2694
# File 'generated/google/apis/genomics_v1/classes.rb', line 2692

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)


2699
2700
2701
# File 'generated/google/apis/genomics_v1/classes.rb', line 2699

def page_token
  @page_token
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2706
2707
2708
2709
2710
2711
# File 'generated/google/apis/genomics_v1/classes.rb', line 2706

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