Class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQuery

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/apigee_v1/classes.rb,
lib/google/apis/apigee_v1/representations.rb,
lib/google/apis/apigee_v1/representations.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudApigeeV1AsyncQuery

Returns a new instance of GoogleCloudApigeeV1AsyncQuery.



1873
1874
1875
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1873

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

Instance Attribute Details

#created ⇒ String

Creation time of the query. Corresponds to the JSON property created

Returns:

  • (String) 


1808
1809
1810
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1808

def created
  @created
end

#envgroup_hostname ⇒ String

Hostname is available only when query is executed at host level. Corresponds to the JSON property envgroupHostname

Returns:

  • (String) 


1813
1814
1815
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1813

def envgroup_hostname
  @envgroup_hostname
end

#error ⇒ String

Error is set when query fails. Corresponds to the JSON property error

Returns:

  • (String) 


1818
1819
1820
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1818

def error
  @error
end

#execution_time ⇒ String

ExecutionTime is available only after the query is completed. Corresponds to the JSON property executionTime

Returns:

  • (String) 


1823
1824
1825
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1823

def execution_time
  @execution_time
end

#name ⇒ String

Asynchronous Query Name. Corresponds to the JSON property name

Returns:

  • (String) 


1828
1829
1830
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1828

def name
  @name
end

#query_params ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1QueryMetadata

Contains information like metrics, dimenstions etc of the AsyncQuery. Corresponds to the JSON property queryParams

Returns:



1833
1834
1835
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1833

def query_params
  @query_params
end

#report_definition_id ⇒ String

Asynchronous Report ID. Corresponds to the JSON property reportDefinitionId

Returns:

  • (String) 


1838
1839
1840
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1838

def report_definition_id
  @report_definition_id
end

#result ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQueryResult

Result is available only after the query is completed. Corresponds to the JSON property result

Returns:



1843
1844
1845
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1843

def result
  @result
end

#result_file_size ⇒ String

ResultFileSize is available only after the query is completed. Corresponds to the JSON property resultFileSize

Returns:

  • (String) 


1848
1849
1850
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1848

def result_file_size
  @result_file_size
end

#result_rows ⇒ Fixnum

ResultRows is available only after the query is completed. Corresponds to the JSON property resultRows

Returns:

  • (Fixnum) 


1853
1854
1855
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1853

def result_rows
  @result_rows
end

#self ⇒ String

Self link of the query. Example: /organizations/myorg/environments/myenv/ queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd or following format if query is running at host level: /organizations/myorg/hostQueries/9cfc0d85-0f30-46d6- ae6f-318d0cb961bd Corresponds to the JSON property self

Returns:

  • (String) 


1861
1862
1863
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1861

def self
  @self
end

#state ⇒ String

Query state could be "enqueued", "running", "completed", "failed". Corresponds to the JSON property state

Returns:

  • (String) 


1866
1867
1868
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1866

def state
  @state
end

#updated ⇒ String

Last updated timestamp for the query. Corresponds to the JSON property updated

Returns:

  • (String) 


1871
1872
1873
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1871

def updated
  @updated
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1878

def update!(**args)
  @created = args[:created] if args.key?(:created)
  @envgroup_hostname = args[:envgroup_hostname] if args.key?(:envgroup_hostname)
  @error = args[:error] if args.key?(:error)
  @execution_time = args[:execution_time] if args.key?(:execution_time)
  @name = args[:name] if args.key?(:name)
  @query_params = args[:query_params] if args.key?(:query_params)
  @report_definition_id = args[:report_definition_id] if args.key?(:report_definition_id)
  @result = args[:result] if args.key?(:result)
  @result_file_size = args[:result_file_size] if args.key?(:result_file_size)
  @result_rows = args[:result_rows] if args.key?(:result_rows)
  @self = args[:self] if args.key?(:self)
  @state = args[:state] if args.key?(:state)
  @updated = args[:updated] if args.key?(:updated)
end