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



3345
3346
3347
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3345

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


3325
3326
3327
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3325

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) 


3337
3338
3339
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3337

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) 


3319
3320
3321
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3319

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) 


3313
3314
3315
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3313

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) 


3343
3344
3345
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3343

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


3331
3332
3333
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3331

def types
  @types
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3350
3351
3352
3353
3354
3355
3356
3357
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3350

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