Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1beta/classes.rb,
lib/google/apis/discoveryengine_v1beta/representations.rb,
lib/google/apis/discoveryengine_v1beta/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.



9917
9918
9919
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 9917

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

Instance Attribute Details

#deleted_record_count ⇒ Fixnum

Optional. The number of documents deleted. Corresponds to the JSON property deletedRecordCount

Returns:

  • (Fixnum) 


9851
9852
9853
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 9851

def deleted_record_count
  @deleted_record_count
end

#entity_name ⇒ String

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

Returns:

  • (String) 


9856
9857
9858
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 9856

def entity_name
  @entity_name
end

#error_record_count ⇒ Fixnum

Optional. The total number of documents failed at sync at indexing stage. Corresponds to the JSON property errorRecordCount

Returns:

  • (Fixnum) 


9861
9862
9863
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 9861

def error_record_count
  @error_record_count
end

#errors ⇒ Array<Google::Apis::DiscoveryengineV1beta::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:



9867
9868
9869
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 9867

def errors
  @errors
end

#extracted_record_count ⇒ Fixnum

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

Returns:

  • (Fixnum) 


9873
9874
9875
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 9873

def extracted_record_count
  @extracted_record_count
end

#indexed_record_count ⇒ Fixnum

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

Returns:

  • (Fixnum) 


9878
9879
9880
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 9878

def indexed_record_count
  @indexed_record_count
end

#progress ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress

Represents the progress of a sync run. Corresponds to the JSON property progress

Returns:



9883
9884
9885
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 9883

def progress
  @progress
end

#scheduled_record_count ⇒ Fixnum

Optional. The number of documents scheduled to be crawled/extracted from connector source. This only applies to third party connectors. Corresponds to the JSON property scheduledRecordCount

Returns:

  • (Fixnum) 


9889
9890
9891
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 9889

def scheduled_record_count
  @scheduled_record_count
end

#source_api_request_count ⇒ Fixnum

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

Returns:

  • (Fixnum) 


9894
9895
9896
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 9894

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) 


9899
9900
9901
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 9899

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) 


9904
9905
9906
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 9904

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) 


9910
9911
9912
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 9910

def stats_update_time
  @stats_update_time
end

#sync_type ⇒ String

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

Returns:

  • (String) 


9915
9916
9917
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 9915

def sync_type
  @sync_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9922
9923
9924
9925
9926
9927
9928
9929
9930
9931
9932
9933
9934
9935
9936
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 9922

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