Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun

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

Overview

Represents an entity that was synced in this ConnectorRun.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun

Returns a new instance of GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun.



11731
11732
11733
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11731

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

Instance Attribute Details

#entity_name ⇒ String

The name of the source entity. Corresponds to the JSON property entityName

Returns:

  • (String) 


11680
11681
11682
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11680

def entity_name
  @entity_name
end

#error_record_count ⇒ Fixnum

The total number of documents failed at sync at any stage (extraction, indexing, etc). Corresponds to the JSON property errorRecordCount

Returns:

  • (Fixnum) 


11686
11687
11688
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11686

def error_record_count
  @error_record_count
end

#errors ⇒ Array<Google::Apis::DiscoveryengineV1::GoogleRpcStatus>

The errors from the entity's sync run. Only exist if running into an error state. Contains error code and error message. Corresponds to the JSON property errors

Returns:



11692
11693
11694
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11692

def errors
  @errors
end

#extracted_record_count ⇒ Fixnum

The number of documents extracted from connector source, ready to be ingested to UCS. Corresponds to the JSON property extractedRecordCount

Returns:

  • (Fixnum) 


11698
11699
11700
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11698

def extracted_record_count
  @extracted_record_count
end

#indexed_record_count ⇒ Fixnum

The number of documents indexed. Corresponds to the JSON property indexedRecordCount

Returns:

  • (Fixnum) 


11703
11704
11705
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11703

def indexed_record_count
  @indexed_record_count
end

#source_api_request_count ⇒ Fixnum

The number of requests sent to 3p API. Corresponds to the JSON property sourceApiRequestCount

Returns:

  • (Fixnum) 


11708
11709
11710
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11708

def source_api_request_count
  @source_api_request_count
end

#state ⇒ String

The state of the entity's sync run. Corresponds to the JSON property state

Returns:

  • (String) 


11713
11714
11715
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11713

def state
  @state
end

#state_update_time ⇒ String

Timestamp at which the entity sync state was last updated. Corresponds to the JSON property stateUpdateTime

Returns:

  • (String) 


11718
11719
11720
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11718

def state_update_time
  @state_update_time
end

#stats_update_time ⇒ String

The timestamp for either extracted_documents_count, indexed_documents_count and error_documents_count was last updated. Corresponds to the JSON property statsUpdateTime

Returns:

  • (String) 


11724
11725
11726
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11724

def stats_update_time
  @stats_update_time
end

#sync_type ⇒ String

Sync type of this run. Corresponds to the JSON property syncType

Returns:

  • (String) 


11729
11730
11731
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11729

def sync_type
  @sync_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11736

def update!(**args)
  @entity_name = args[:entity_name] if args.key?(:entity_name)
  @error_record_count = args[:error_record_count] if args.key?(:error_record_count)
  @errors = args[:errors] if args.key?(:errors)
  @extracted_record_count = args[:extracted_record_count] if args.key?(:extracted_record_count)
  @indexed_record_count = args[:indexed_record_count] if args.key?(:indexed_record_count)
  @source_api_request_count = args[:source_api_request_count] if args.key?(:source_api_request_count)
  @state = args[:state] if args.key?(:state)
  @state_update_time = args[:state_update_time] if args.key?(:state_update_time)
  @stats_update_time = args[:stats_update_time] if args.key?(:stats_update_time)
  @sync_type = args[:sync_type] if args.key?(:sync_type)
end