Class: Google::Apis::GenomicsV1::SearchAnnotationSetsRequest

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

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

Returns a new instance of SearchAnnotationSetsRequest



2353
2354
2355
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2353

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

Instance Attribute Details

#dataset_ids ⇒ Array<String>

Required. The dataset IDs to search within. Caller must have READ access to these datasets. Corresponds to the JSON property datasetIds

Returns:

  • (Array<String>) 


2320
2321
2322
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2320

def dataset_ids
  @dataset_ids
end

#name ⇒ String

Only return annotations sets for which a substring of the name matches this string (case insensitive). Corresponds to the JSON property name

Returns:

  • (String) 


2326
2327
2328
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2326

def name
  @name
end

#page_size ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2332
2333
2334
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2332

def page_size
  @page_size
end

#page_token ⇒ String

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) 


2339
2340
2341
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2339

def page_token
  @page_token
end

#reference_set_id ⇒ String

If specified, only annotation sets associated with the given reference set are returned. Corresponds to the JSON property referenceSetId

Returns:

  • (String) 


2345
2346
2347
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2345

def reference_set_id
  @reference_set_id
end

#types ⇒ Array<String>

If specified, only annotation sets that have any of these types are returned. Corresponds to the JSON property types

Returns:

  • (Array<String>) 


2351
2352
2353
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2351

def types
  @types
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2358
2359
2360
2361
2362
2363
2364
2365
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2358

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)
  @reference_set_id = args[:reference_set_id] if args.key?(:reference_set_id)
  @types = args[:types] if args.key?(:types)
end