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.



11876
11877
11878
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11876

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) 


11825
11826
11827
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11825

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) 


11831
11832
11833
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11831

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:



11837
11838
11839
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11837

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) 


11843
11844
11845
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11843

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) 


11848
11849
11850
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11848

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) 


11853
11854
11855
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11853

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) 


11858
11859
11860
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11858

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) 


11863
11864
11865
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11863

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) 


11869
11870
11871
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11869

def stats_update_time
  @stats_update_time
end

#sync_type ⇒ String

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

Returns:

  • (String) 


11874
11875
11876
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11874

def sync_type
  @sync_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11881
11882
11883
11884
11885
11886
11887
11888
11889
11890
11891
11892
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11881

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