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.


749
750
751
# File 'generated/google/apis/genomics_v1/classes.rb', line 749

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

Instance Attribute Details

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

710
711
712
# File 'generated/google/apis/genomics_v1/classes.rb', line 710

def annotation_set_ids
  @annotation_set_ids
end

#endString

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:

  • (String)

734
735
736
# File 'generated/google/apis/genomics_v1/classes.rb', line 734

def end
  @end
end

#page_sizeFixnum

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)

747
748
749
# File 'generated/google/apis/genomics_v1/classes.rb', line 747

def page_size
  @page_size
end

#page_tokenString

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)

741
742
743
# File 'generated/google/apis/genomics_v1/classes.rb', line 741

def page_token
  @page_token
end

#reference_idString

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

Returns:

  • (String)

715
716
717
# File 'generated/google/apis/genomics_v1/classes.rb', line 715

def reference_id
  @reference_id
end

#reference_nameString

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

Returns:

  • (String)

721
722
723
# File 'generated/google/apis/genomics_v1/classes.rb', line 721

def reference_name
  @reference_name
end

#startString

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:

  • (String)

727
728
729
# File 'generated/google/apis/genomics_v1/classes.rb', line 727

def start
  @start
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


754
755
756
757
758
759
760
761
762
# File 'generated/google/apis/genomics_v1/classes.rb', line 754

def update!(**args)
  @annotation_set_ids = args[:annotation_set_ids] if args.key?(:annotation_set_ids)
  @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 = 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