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.



1508
1509
1510
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1508

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

Instance Attribute Details

#created ⇒ String

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

Returns:

  • (String) 


1443
1444
1445
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1443

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) 


1448
1449
1450
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1448

def envgroup_hostname
  @envgroup_hostname
end

#error ⇒ String

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

Returns:

  • (String) 


1453
1454
1455
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1453

def error
  @error
end

#execution_time ⇒ String

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

Returns:

  • (String) 


1458
1459
1460
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1458

def execution_time
  @execution_time
end

#name ⇒ String

Asynchronous Query Name. Corresponds to the JSON property name

Returns:

  • (String) 


1463
1464
1465
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1463

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:



1468
1469
1470
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1468

def query_params
  @query_params
end

#report_definition_id ⇒ String

Asynchronous Report ID. Corresponds to the JSON property reportDefinitionId

Returns:

  • (String) 


1473
1474
1475
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1473

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:



1478
1479
1480
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1478

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) 


1483
1484
1485
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1483

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) 


1488
1489
1490
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1488

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) 


1496
1497
1498
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1496

def self
  @self
end

#state ⇒ String

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

Returns:

  • (String) 


1501
1502
1503
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1501

def state
  @state
end

#updated ⇒ String

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

Returns:

  • (String) 


1506
1507
1508
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1506

def updated
  @updated
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1513

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