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



3399
3400
3401
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3399

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


3365
3366
3367
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3365

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) 


3384
3385
3386
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3384

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) 


3397
3398
3399
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3397

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) 


3391
3392
3393
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3391

def page_token
  @page_token
end

#reference_id ⇒ String

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

Returns:

  • (String) 


3376
3377
3378
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3376

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) 


3371
3372
3373
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3371

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) 


3358
3359
3360
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3358

def start
  @start
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3404
3405
3406
3407
3408
3409
3410
3411
3412
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 3404

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