Class: Aws::QBusiness::Types::DataSourceSyncJob

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-qbusiness/types.rb

Overview

Provides information about an Amazon Q Business data source connector synchronization job.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#data_source_error_code ⇒ String

If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error.

Returns:

  • (String) 


2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2487

class DataSourceSyncJob < Struct.new(
  :execution_id,
  :start_time,
  :end_time,
  :status,
  :error,
  :data_source_error_code,
  :metrics)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

The Unix timestamp when the synchronization job completed.

Returns:

  • (Time) 


2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2487

class DataSourceSyncJob < Struct.new(
  :execution_id,
  :start_time,
  :end_time,
  :status,
  :error,
  :data_source_error_code,
  :metrics)
  SENSITIVE = []
  include Aws::Structure
end

#error ⇒ Types::ErrorDetail

If the ‘Status` field is set to `FAILED`, the `ErrorCode` field indicates the reason the synchronization failed.

Returns:



2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2487

class DataSourceSyncJob < Struct.new(
  :execution_id,
  :start_time,
  :end_time,
  :status,
  :error,
  :data_source_error_code,
  :metrics)
  SENSITIVE = []
  include Aws::Structure
end

#execution_id ⇒ String

The identifier of a data source synchronization job.

Returns:

  • (String) 


2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2487

class DataSourceSyncJob < Struct.new(
  :execution_id,
  :start_time,
  :end_time,
  :status,
  :error,
  :data_source_error_code,
  :metrics)
  SENSITIVE = []
  include Aws::Structure
end

#metrics ⇒ Types::DataSourceSyncJobMetrics

Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector.

Returns:



2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2487

class DataSourceSyncJob < Struct.new(
  :execution_id,
  :start_time,
  :end_time,
  :status,
  :error,
  :data_source_error_code,
  :metrics)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The Unix time stamp when the data source synchronization job started.

Returns:

  • (Time) 


2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2487

class DataSourceSyncJob < Struct.new(
  :execution_id,
  :start_time,
  :end_time,
  :status,
  :error,
  :data_source_error_code,
  :metrics)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the synchronization job. When the ‘Status` field is set to `SUCCEEDED`, the synchronization job is done. If the status code is `FAILED`, the `ErrorCode` and `ErrorMessage` fields give you the reason for the failure.

Returns:

  • (String) 


2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 2487

class DataSourceSyncJob < Struct.new(
  :execution_id,
  :start_time,
  :end_time,
  :status,
  :error,
  :data_source_error_code,
  :metrics)
  SENSITIVE = []
  include Aws::Structure
end