Class: Google::Apis::GenomicsV1::SearchAnnotationsRequest

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

Returns a new instance of SearchAnnotationsRequest



2459
2460
2461
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2459

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

Instance Attribute Details

#annotation_set_ids ⇒ Array<String>

Required. The annotation sets to search within. The caller must have READ access to these annotation sets. All queried annotation sets must have the same type. Corresponds to the JSON property annotationSetIds

Returns:

  • (Array<String>) 


2416
2417
2418
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2416

def annotation_set_ids
  @annotation_set_ids
end

#end ⇒ Fixnum

The end position of the range on the reference, 0-based exclusive. If referenceId or referenceName must be specified, Defaults to the length of the reference. Corresponds to the JSON property end

Returns:

  • (Fixnum) 


2424
2425
2426
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2424

def end
  @end
end

#page_size ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2430
2431
2432
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2430

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) 


2437
2438
2439
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2437

def page_token
  @page_token
end

#reference_id ⇒ String

The ID of the reference to query. Corresponds to the JSON property referenceId

Returns:

  • (String) 


2442
2443
2444
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2442

def reference_id
  @reference_id
end

#reference_name ⇒ String

The name of the reference to query, within the reference set associated with this query. Corresponds to the JSON property referenceName

Returns:

  • (String) 


2448
2449
2450
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2448

def reference_name
  @reference_name
end

#start ⇒ Fixnum

The start position of the range on the reference, 0-based inclusive. If specified, referenceId or referenceName must be specified. Defaults to 0. Corresponds to the JSON property start

Returns:

  • (Fixnum) 


2457
2458
2459
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2457

def start
  @start
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2464
2465
2466
2467
2468
2469
2470
2471
2472
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2464

def update!(**args)
  @annotation_set_ids = args[:annotation_set_ids] if args.key?(:annotation_set_ids)
  @end = args[:end] if args.key?(:end)
  @page_size = args[:page_size] if args.key?(:page_size)
  @page_token = args[:page_token] if args.key?(:page_token)
  @reference_id = args[:reference_id] if args.key?(:reference_id)
  @reference_name = args[:reference_name] if args.key?(:reference_name)
  @start = args[:start] if args.key?(:start)
end