Class: Google::Apis::BigqueryV2::JobStatistics2

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

Overview

Statistics for a query job.

Defined Under Namespace

Classes: ReservationUsage

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ JobStatistics2

Returns a new instance of JobStatistics2.



5864
5865
5866
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5864

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

Instance Attribute Details

#bi_engine_statistics ⇒ Google::Apis::BigqueryV2::BiEngineStatistics

Statistics for a BI Engine specific query. Populated as part of JobStatistics2 Corresponds to the JSON property biEngineStatistics

Returns:



5545
5546
5547
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5545

def bi_engine_statistics
  @bi_engine_statistics
end

#billing_tier ⇒ Fixnum

Output only. Billing tier for the job. This is a BigQuery-specific concept which is not related to the Google Cloud notion of "free tier". The value here is a measure of the query's resource consumption relative to the amount of data scanned. For on-demand queries, the limit is 100, and all queries within this limit are billed at the standard on-demand rates. On-demand queries that exceed this limit will fail with a billingTierLimitExceeded error. Corresponds to the JSON property billingTier

Returns:

  • (Fixnum) 


5555
5556
5557
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5555

def billing_tier
  @billing_tier
end

#cache_hit ⇒ Boolean Also known as: cache_hit?

Output only. Whether the query result was fetched from the query cache. Corresponds to the JSON property cacheHit

Returns:

  • (Boolean) 


5560
5561
5562
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5560

def cache_hit
  @cache_hit
end

#dcl_target_dataset ⇒ Google::Apis::BigqueryV2::DatasetReference

Output only. Referenced dataset for DCL statement. Corresponds to the JSON property dclTargetDataset

Returns:



5566
5567
5568
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5566

def dcl_target_dataset
  @dcl_target_dataset
end

#dcl_target_table ⇒ Google::Apis::BigqueryV2::TableReference

Output only. Referenced table for DCL statement. Corresponds to the JSON property dclTargetTable

Returns:



5571
5572
5573
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5571

def dcl_target_table
  @dcl_target_table
end

#dcl_target_view ⇒ Google::Apis::BigqueryV2::TableReference

Output only. Referenced view for DCL statement. Corresponds to the JSON property dclTargetView

Returns:



5576
5577
5578
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5576

def dcl_target_view
  @dcl_target_view
end

#ddl_affected_row_access_policy_count ⇒ Fixnum

Output only. The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries. Corresponds to the JSON property ddlAffectedRowAccessPolicyCount

Returns:

  • (Fixnum) 


5582
5583
5584
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5582

def ddl_affected_row_access_policy_count
  @ddl_affected_row_access_policy_count
end

#ddl_destination_table ⇒ Google::Apis::BigqueryV2::TableReference

Output only. The table after rename. Present only for ALTER TABLE RENAME TO query. Corresponds to the JSON property ddlDestinationTable

Returns:



5588
5589
5590
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5588

def ddl_destination_table
  @ddl_destination_table
end

#ddl_operation_performed ⇒ String

Output only. The DDL operation performed, possibly dependent on the pre- existence of the DDL target. Corresponds to the JSON property ddlOperationPerformed

Returns:

  • (String) 


5594
5595
5596
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5594

def ddl_operation_performed
  @ddl_operation_performed
end

#ddl_target_dataset ⇒ Google::Apis::BigqueryV2::DatasetReference

Output only. The DDL target dataset. Present only for CREATE/ALTER/DROP SCHEMA( dataset) queries. Corresponds to the JSON property ddlTargetDataset

Returns:



5600
5601
5602
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5600

def ddl_target_dataset
  @ddl_target_dataset
end

#ddl_target_routine ⇒ Google::Apis::BigqueryV2::RoutineReference

Id path of a routine. Corresponds to the JSON property ddlTargetRoutine

Returns:



5605
5606
5607
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5605

def ddl_target_routine
  @ddl_target_routine
end

#ddl_target_row_access_policy ⇒ Google::Apis::BigqueryV2::RowAccessPolicyReference

Id path of a row access policy. Corresponds to the JSON property ddlTargetRowAccessPolicy

Returns:



5610
5611
5612
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5610

def ddl_target_row_access_policy
  @ddl_target_row_access_policy
end

#ddl_target_table ⇒ Google::Apis::BigqueryV2::TableReference

Output only. The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries. Corresponds to the JSON property ddlTargetTable

Returns:



5616
5617
5618
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5616

def ddl_target_table
  @ddl_target_table
end

#dml_stats ⇒ Google::Apis::BigqueryV2::DmlStatistics

Detailed statistics for DML statements Corresponds to the JSON property dmlStats

Returns:



5621
5622
5623
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5621

def dml_stats
  @dml_stats
end

#estimated_bytes_processed ⇒ Fixnum

Output only. The original estimate of bytes processed for the job. Corresponds to the JSON property estimatedBytesProcessed

Returns:

  • (Fixnum) 


5626
5627
5628
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5626

def estimated_bytes_processed
  @estimated_bytes_processed
end

#export_data_statistics ⇒ Google::Apis::BigqueryV2::ExportDataStatistics

Statistics for the EXPORT DATA statement as part of Query Job. EXTRACT JOB statistics are populated in JobStatistics4. Corresponds to the JSON property exportDataStatistics

Returns:



5632
5633
5634
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5632

def export_data_statistics
  @export_data_statistics
end

#external_service_costs ⇒ Array<Google::Apis::BigqueryV2::ExternalServiceCost>

Output only. Job cost breakdown as bigquery internal cost and external service costs. Corresponds to the JSON property externalServiceCosts

Returns:



5638
5639
5640
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5638

def external_service_costs
  @external_service_costs
end

#load_query_statistics ⇒ Google::Apis::BigqueryV2::LoadQueryStatistics

Statistics for a LOAD query. Corresponds to the JSON property loadQueryStatistics

Returns:



5643
5644
5645
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5643

def load_query_statistics
  @load_query_statistics
end

#materialized_view_statistics ⇒ Google::Apis::BigqueryV2::MaterializedViewStatistics

Statistics of materialized views considered in a query job. Corresponds to the JSON property materializedViewStatistics

Returns:



5648
5649
5650
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5648

def materialized_view_statistics
  @materialized_view_statistics
end

#metadata_cache_statistics ⇒ Google::Apis::BigqueryV2::MetadataCacheStatistics

Statistics for metadata caching in BigLake tables. Corresponds to the JSON property metadataCacheStatistics

Returns:



5653
5654
5655
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5653

def metadata_cache_statistics
  @metadata_cache_statistics
end

#ml_statistics ⇒ Google::Apis::BigqueryV2::MlStatistics

Job statistics specific to a BigQuery ML training job. Corresponds to the JSON property mlStatistics

Returns:



5658
5659
5660
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5658

def ml_statistics
  @ml_statistics
end

#model_training ⇒ Google::Apis::BigqueryV2::BigQueryModelTraining

Deprecated. Corresponds to the JSON property modelTraining

Returns:



5663
5664
5665
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5663

def model_training
  @model_training
end

#model_training_current_iteration ⇒ Fixnum

Deprecated. Corresponds to the JSON property modelTrainingCurrentIteration

Returns:

  • (Fixnum) 


5668
5669
5670
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5668

def model_training_current_iteration
  @model_training_current_iteration
end

#model_training_expected_total_iteration ⇒ Fixnum

Deprecated. Corresponds to the JSON property modelTrainingExpectedTotalIteration

Returns:

  • (Fixnum) 


5673
5674
5675
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5673

def model_training_expected_total_iteration
  @model_training_expected_total_iteration
end

#num_dml_affected_rows ⇒ Fixnum

Output only. The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. Corresponds to the JSON property numDmlAffectedRows

Returns:

  • (Fixnum) 


5679
5680
5681
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5679

def num_dml_affected_rows
  @num_dml_affected_rows
end

#performance_insights ⇒ Google::Apis::BigqueryV2::PerformanceInsights

Performance insights for the job. Corresponds to the JSON property performanceInsights

Returns:



5684
5685
5686
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5684

def performance_insights
  @performance_insights
end

#query_info ⇒ Google::Apis::BigqueryV2::QueryInfo

Query optimization information for a QUERY job. Corresponds to the JSON property queryInfo

Returns:



5689
5690
5691
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5689

def query_info
  @query_info
end

#query_plan ⇒ Array<Google::Apis::BigqueryV2::ExplainQueryStage>

Output only. Describes execution plan for the query. Corresponds to the JSON property queryPlan

Returns:



5694
5695
5696
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5694

def query_plan
  @query_plan
end

#referenced_routines ⇒ Array<Google::Apis::BigqueryV2::RoutineReference>

Output only. Referenced routines for the job. Corresponds to the JSON property referencedRoutines

Returns:



5699
5700
5701
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5699

def referenced_routines
  @referenced_routines
end

#referenced_tables ⇒ Array<Google::Apis::BigqueryV2::TableReference>

Output only. Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list. Corresponds to the JSON property referencedTables

Returns:



5705
5706
5707
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5705

def referenced_tables
  @referenced_tables
end

#reservation_usage ⇒ Array<Google::Apis::BigqueryV2::JobStatistics2::ReservationUsage>

Output only. Job resource usage breakdown by reservation. This field reported misleading information and will no longer be populated. Corresponds to the JSON property reservationUsage

Returns:



5711
5712
5713
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5711

def reservation_usage
  @reservation_usage
end

#schema ⇒ Google::Apis::BigqueryV2::TableSchema

Schema of a table Corresponds to the JSON property schema

Returns:



5716
5717
5718
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5716

def schema
  @schema
end

#search_statistics ⇒ Google::Apis::BigqueryV2::SearchStatistics

Statistics for a search query. Populated as part of JobStatistics2. Corresponds to the JSON property searchStatistics

Returns:



5721
5722
5723
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5721

def search_statistics
  @search_statistics
end

#spark_statistics ⇒ Google::Apis::BigqueryV2::SparkStatistics

Statistics for a BigSpark query. Populated as part of JobStatistics2 Corresponds to the JSON property sparkStatistics

Returns:



5726
5727
5728
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5726

def spark_statistics
  @spark_statistics
end

#statement_type ⇒ String

Output only. The type of query statement, if valid. Possible values: * SELECT : SELECT statement. * ASSERT: ASSERT statement. * INSERT: INSERT statement. * UPDATE: UPDATE statement. * DELETE: DELETE statement. * MERGE: MERGE statement. * CREATE_TABLE: CREATE TABLE statement, without AS SELECT. * CREATE_TABLE_AS_SELECT: CREATE TABLE AS SELECT statement. * CREATE_VIEW: CREATE VIEW statement. * CREATE_MODEL: CREATE MODEL statement. * CREATE_MATERIALIZED_VIEW: CREATE MATERIALIZED VIEW statement. * CREATE_FUNCTION: CREATE FUNCTION statement. * CREATE_TABLE_FUNCTION: CREATE TABLE FUNCTION statement. * CREATE_PROCEDURE: CREATE PROCEDURE statement. * CREATE_ROW_ACCESS_POLICY: CREATE ROW ACCESS POLICY statement. * CREATE_SCHEMA: CREATE SCHEMA statement. * CREATE_SNAPSHOT_TABLE: CREATE SNAPSHOT TABLE statement. * CREATE_SEARCH_INDEX: CREATE SEARCH INDEX statement. * DROP_TABLE: DROP TABLE statement. * DROP_EXTERNAL_TABLE: DROP EXTERNAL TABLE statement. * DROP_VIEW: DROP VIEW statement. * DROP_MODEL: DROP MODEL statement. * DROP_MATERIALIZED_VIEW: DROP MATERIALIZED VIEW statement. * DROP_FUNCTION : DROP FUNCTION statement. * DROP_TABLE_FUNCTION : DROP TABLE FUNCTION statement. * DROP_PROCEDURE: DROP PROCEDURE statement. * DROP_SEARCH_INDEX: DROP SEARCH INDEX statement. * DROP_SCHEMA: DROP SCHEMA statement. * DROP_SNAPSHOT_TABLE: DROP SNAPSHOT TABLE statement. * DROP_ROW_ACCESS_POLICY: DROP [ ALL] ROW ACCESS POLICY|POLICIES statement. * ALTER_TABLE: ALTER TABLE statement. * ALTER_VIEW: ALTER VIEW statement. * ALTER_MATERIALIZED_VIEW: ALTER MATERIALIZED VIEW statement. * ALTER_SCHEMA: ALTER SCHEMA statement. * SCRIPT: SCRIPT. * TRUNCATE_TABLE: TRUNCATE TABLE statement. * CREATE_EXTERNAL_TABLE: CREATE EXTERNAL TABLE statement. * EXPORT_DATA: EXPORT DATA statement. * EXPORT_MODEL: EXPORT MODEL statement. * LOAD_DATA: LOAD DATA statement. * CALL: CALL statement. Corresponds to the JSON property statementType

Returns:

  • (String) 


5807
5808
5809
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5807

def statement_type
  @statement_type
end

#timeline ⇒ Array<Google::Apis::BigqueryV2::QueryTimelineSample>

Output only. Describes a timeline of job execution. Corresponds to the JSON property timeline

Returns:



5812
5813
5814
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5812

def timeline
  @timeline
end

#total_bytes_billed ⇒ Fixnum

Output only. If the project is configured to use on-demand pricing, then this field contains the total bytes billed for the job. If the project is configured to use flat-rate pricing, then you are not billed for bytes and this field is informational only. Corresponds to the JSON property totalBytesBilled

Returns:

  • (Fixnum) 


5820
5821
5822
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5820

def total_bytes_billed
  @total_bytes_billed
end

#total_bytes_processed ⇒ Fixnum

Output only. Total bytes processed for the job. Corresponds to the JSON property totalBytesProcessed

Returns:

  • (Fixnum) 


5825
5826
5827
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5825

def total_bytes_processed
  @total_bytes_processed
end

#total_bytes_processed_accuracy ⇒ String

Output only. For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost. Corresponds to the JSON property totalBytesProcessedAccuracy

Returns:

  • (String) 


5834
5835
5836
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5834

def total_bytes_processed_accuracy
  @total_bytes_processed_accuracy
end

#total_partitions_processed ⇒ Fixnum

Output only. Total number of partitions processed from all partitioned tables referenced in the job. Corresponds to the JSON property totalPartitionsProcessed

Returns:

  • (Fixnum) 


5840
5841
5842
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5840

def total_partitions_processed
  @total_partitions_processed
end

#total_slot_ms ⇒ Fixnum

Output only. Slot-milliseconds for the job. Corresponds to the JSON property totalSlotMs

Returns:

  • (Fixnum) 


5845
5846
5847
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5845

def total_slot_ms
  @total_slot_ms
end

#transferred_bytes ⇒ Fixnum

Output only. Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS). Corresponds to the JSON property transferredBytes

Returns:

  • (Fixnum) 


5851
5852
5853
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5851

def transferred_bytes
  @transferred_bytes
end

#undeclared_query_parameters ⇒ Array<Google::Apis::BigqueryV2::QueryParameter>

Output only. GoogleSQL only: list of undeclared query parameters detected during a dry run validation. Corresponds to the JSON property undeclaredQueryParameters

Returns:



5857
5858
5859
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5857

def undeclared_query_parameters
  @undeclared_query_parameters
end

#vector_search_statistics ⇒ Google::Apis::BigqueryV2::VectorSearchStatistics

Statistics for a vector search query. Populated as part of JobStatistics2. Corresponds to the JSON property vectorSearchStatistics

Returns:



5862
5863
5864
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5862

def vector_search_statistics
  @vector_search_statistics
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
 
# File 'lib/google/apis/bigquery_v2/classes.rb', line 5869

def update!(**args)
  @bi_engine_statistics = args[:bi_engine_statistics] if args.key?(:bi_engine_statistics)
  @billing_tier = args[:billing_tier] if args.key?(:billing_tier)
  @cache_hit = args[:cache_hit] if args.key?(:cache_hit)
  @dcl_target_dataset = args[:dcl_target_dataset] if args.key?(:dcl_target_dataset)
  @dcl_target_table = args[:dcl_target_table] if args.key?(:dcl_target_table)
  @dcl_target_view = args[:dcl_target_view] if args.key?(:dcl_target_view)
  @ddl_affected_row_access_policy_count = args[:ddl_affected_row_access_policy_count] if args.key?(:ddl_affected_row_access_policy_count)
  @ddl_destination_table = args[:ddl_destination_table] if args.key?(:ddl_destination_table)
  @ddl_operation_performed = args[:ddl_operation_performed] if args.key?(:ddl_operation_performed)
  @ddl_target_dataset = args[:ddl_target_dataset] if args.key?(:ddl_target_dataset)
  @ddl_target_routine = args[:ddl_target_routine] if args.key?(:ddl_target_routine)
  @ddl_target_row_access_policy = args[:ddl_target_row_access_policy] if args.key?(:ddl_target_row_access_policy)
  @ddl_target_table = args[:ddl_target_table] if args.key?(:ddl_target_table)
  @dml_stats = args[:dml_stats] if args.key?(:dml_stats)
  @estimated_bytes_processed = args[:estimated_bytes_processed] if args.key?(:estimated_bytes_processed)
  @export_data_statistics = args[:export_data_statistics] if args.key?(:export_data_statistics)
  @external_service_costs = args[:external_service_costs] if args.key?(:external_service_costs)
  @load_query_statistics = args[:load_query_statistics] if args.key?(:load_query_statistics)
  @materialized_view_statistics = args[:materialized_view_statistics] if args.key?(:materialized_view_statistics)
  @metadata_cache_statistics = args[:metadata_cache_statistics] if args.key?(:metadata_cache_statistics)
  @ml_statistics = args[:ml_statistics] if args.key?(:ml_statistics)
  @model_training = args[:model_training] if args.key?(:model_training)
  @model_training_current_iteration = args[:model_training_current_iteration] if args.key?(:model_training_current_iteration)
  @model_training_expected_total_iteration = args[:model_training_expected_total_iteration] if args.key?(:model_training_expected_total_iteration)
  @num_dml_affected_rows = args[:num_dml_affected_rows] if args.key?(:num_dml_affected_rows)
  @performance_insights = args[:performance_insights] if args.key?(:performance_insights)
  @query_info = args[:query_info] if args.key?(:query_info)
  @query_plan = args[:query_plan] if args.key?(:query_plan)
  @referenced_routines = args[:referenced_routines] if args.key?(:referenced_routines)
  @referenced_tables = args[:referenced_tables] if args.key?(:referenced_tables)
  @reservation_usage = args[:reservation_usage] if args.key?(:reservation_usage)
  @schema = args[:schema] if args.key?(:schema)
  @search_statistics = args[:search_statistics] if args.key?(:search_statistics)
  @spark_statistics = args[:spark_statistics] if args.key?(:spark_statistics)
  @statement_type = args[:statement_type] if args.key?(:statement_type)
  @timeline = args[:timeline] if args.key?(:timeline)
  @total_bytes_billed = args[:total_bytes_billed] if args.key?(:total_bytes_billed)
  @total_bytes_processed = args[:total_bytes_processed] if args.key?(:total_bytes_processed)
  @total_bytes_processed_accuracy = args[:total_bytes_processed_accuracy] if args.key?(:total_bytes_processed_accuracy)
  @total_partitions_processed = args[:total_partitions_processed] if args.key?(:total_partitions_processed)
  @total_slot_ms = args[:total_slot_ms] if args.key?(:total_slot_ms)
  @transferred_bytes = args[:transferred_bytes] if args.key?(:transferred_bytes)
  @undeclared_query_parameters = args[:undeclared_query_parameters] if args.key?(:undeclared_query_parameters)
  @vector_search_statistics = args[:vector_search_statistics] if args.key?(:vector_search_statistics)
end