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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-qbusiness/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) 


3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3096

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) 


3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3096

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:



3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3096

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) 


3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3096

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:



3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3096

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) 


3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3096

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) 


3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 3096

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