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



2469
2470
2471
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2469

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


2426
2427
2428
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2426

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) 


2434
2435
2436
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2434

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) 


2440
2441
2442
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2440

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) 


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

def page_token
  @page_token
end

#reference_id ⇒ String

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

Returns:

  • (String) 


2452
2453
2454
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2452

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) 


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

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) 


2467
2468
2469
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2467

def start
  @start
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2474
2475
2476
2477
2478
2479
2480
2481
2482
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2474

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