Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConnectorRun

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

Overview

A data sync run of DataConnector. After DataConnector is successfully initialized, data syncs are scheduled at DataConnector.refresh_interval. A ConnectorRun represents a data sync either in the past or onging that the moment. //

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaConnectorRun

Returns a new instance of GoogleCloudDiscoveryengineV1alphaConnectorRun.



7004
7005
7006
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7004

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

Instance Attribute Details

#end_time ⇒ String

Output only. The time when the connector run ended. Corresponds to the JSON property endTime

Returns:

  • (String) 


6957
6958
6959
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6957

def end_time
  @end_time
end

#entity_runs ⇒ Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun>

Output only. The details of the entities synced at the ConnectorRun. Each ConnectorRun consists of syncing one or more entities. Corresponds to the JSON property entityRuns

Returns:



6963
6964
6965
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6963

def entity_runs
  @entity_runs
end

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

Contains info about errors incurred during the sync. Only exist if running into an error state. Contains error code and error message. Use with the state field. Corresponds to the JSON property errors

Returns:



6970
6971
6972
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6970

def errors
  @errors
end

#latest_pause_time ⇒ String

Output only. The time when the connector run was most recently paused. Corresponds to the JSON property latestPauseTime

Returns:

  • (String) 


6975
6976
6977
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6975

def latest_pause_time
  @latest_pause_time
end

#name ⇒ String

Output only. The full resource name of the Connector Run. Format: projects/*/ locations/*/collections/*/dataConnector/connectorRuns/*. The connector_run_id is system-generated. Corresponds to the JSON property name

Returns:

  • (String) 


6982
6983
6984
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6982

def name
  @name
end

#start_time ⇒ String

Output only. The time when the connector run started. Corresponds to the JSON property startTime

Returns:

  • (String) 


6987
6988
6989
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6987

def start_time
  @start_time
end

#state ⇒ String

Output only. The state of the sync run. Corresponds to the JSON property state

Returns:

  • (String) 


6992
6993
6994
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6992

def state
  @state
end

#state_update_time ⇒ String

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

Returns:

  • (String) 


6997
6998
6999
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 6997

def state_update_time
  @state_update_time
end

#trigger ⇒ String

Output only. The trigger for this ConnectorRun. Corresponds to the JSON property trigger

Returns:

  • (String) 


7002
7003
7004
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7002

def trigger
  @trigger
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 7009

def update!(**args)
  @end_time = args[:end_time] if args.key?(:end_time)
  @entity_runs = args[:entity_runs] if args.key?(:entity_runs)
  @errors = args[:errors] if args.key?(:errors)
  @latest_pause_time = args[:latest_pause_time] if args.key?(:latest_pause_time)
  @name = args[:name] if args.key?(:name)
  @start_time = args[:start_time] if args.key?(:start_time)
  @state = args[:state] if args.key?(:state)
  @state_update_time = args[:state_update_time] if args.key?(:state_update_time)
  @trigger = args[:trigger] if args.key?(:trigger)
end