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



2175
2176
2177
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2175

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


2142
2143
2144
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2142

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) 


2148
2149
2150
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2148

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) 


2154
2155
2156
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2154

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) 


2161
2162
2163
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2161

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) 


2167
2168
2169
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2167

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


2173
2174
2175
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2173

def types
  @types
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2180
2181
2182
2183
2184
2185
2186
2187
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 2180

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