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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/apigee_v1/classes.rb,
generated/google/apis/apigee_v1/representations.rb,
generated/google/apis/apigee_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) ⇒ GoogleCloudApigeeV1AsyncQuery

Returns a new instance of GoogleCloudApigeeV1AsyncQuery.


795
796
797
# File 'generated/google/apis/apigee_v1/classes.rb', line 795

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

Instance Attribute Details

#createdString

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

Returns:

  • (String)

737
738
739
# File 'generated/google/apis/apigee_v1/classes.rb', line 737

def created
  @created
end

#errorString

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

Returns:

  • (String)

742
743
744
# File 'generated/google/apis/apigee_v1/classes.rb', line 742

def error
  @error
end

#execution_timeString

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

Returns:

  • (String)

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

def execution_time
  @execution_time
end

#nameString

Asynchronous Query Name. Corresponds to the JSON property name

Returns:

  • (String)

752
753
754
# File 'generated/google/apis/apigee_v1/classes.rb', line 752

def name
  @name
end

#query_paramsGoogle::Apis::ApigeeV1::GoogleCloudApigeeV1QueryMetadata

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


757
758
759
# File 'generated/google/apis/apigee_v1/classes.rb', line 757

def query_params
  @query_params
end

#report_definition_idString

Asynchronous Report ID. Corresponds to the JSON property reportDefinitionId

Returns:

  • (String)

762
763
764
# File 'generated/google/apis/apigee_v1/classes.rb', line 762

def report_definition_id
  @report_definition_id
end

#resultGoogle::Apis::ApigeeV1::GoogleCloudApigeeV1AsyncQueryResult

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


767
768
769
# File 'generated/google/apis/apigee_v1/classes.rb', line 767

def result
  @result
end

#result_file_sizeString

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

Returns:

  • (String)

772
773
774
# File 'generated/google/apis/apigee_v1/classes.rb', line 772

def result_file_size
  @result_file_size
end

#result_rowsFixnum

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

Returns:

  • (Fixnum)

777
778
779
# File 'generated/google/apis/apigee_v1/classes.rb', line 777

def result_rows
  @result_rows
end

#selfString

Self link of the query. Example: /organizations/myorg/environments/myenv/ queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd Corresponds to the JSON property self

Returns:

  • (String)

783
784
785
# File 'generated/google/apis/apigee_v1/classes.rb', line 783

def self
  @self
end

#stateString

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

Returns:

  • (String)

788
789
790
# File 'generated/google/apis/apigee_v1/classes.rb', line 788

def state
  @state
end

#updatedString

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

Returns:

  • (String)

793
794
795
# File 'generated/google/apis/apigee_v1/classes.rb', line 793

def updated
  @updated
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


800
801
802
803
804
805
806
807
808
809
810
811
812
813
# File 'generated/google/apis/apigee_v1/classes.rb', line 800

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