Class: Aws::BackupSearch::Types::SearchJobSummary

Inherits:

Struct

• Object
• Struct
• Aws::BackupSearch::Types::SearchJobSummary

Defined in:

gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/types.rb

Overview

This is information pertaining to a search job.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #completion_time ⇒ Time

  This is the completion time of the search job.

• #creation_time ⇒ Time

  This is the creation time of the search job.

• #name ⇒ String

  This is the name of the search job.

• #search_job_arn ⇒ String

  The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.

• #search_job_identifier ⇒ String

  The unique string that specifies the search job.

• #search_scope_summary ⇒ Types::SearchScopeSummary

  Returned summary of the specified search job scope, including:.

• #status ⇒ String

  This is the status of the search job.

• #status_message ⇒ String

  A status message will be returned for either a earch job with a status of ERRORED or a status of COMPLETED jobs with issues.

Instance Attribute Details

#completion_time ⇒ Time

This is the completion time of the search job.

Returns:

• (Time)

# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/types.rb', line 1061

class SearchJobSummary < Struct.new(
  :search_job_identifier,
  :search_job_arn,
  :name,
  :status,
  :creation_time,
  :completion_time,
  :search_scope_summary,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

This is the creation time of the search job.

Returns:

• (Time)

# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/types.rb', line 1061

class SearchJobSummary < Struct.new(
  :search_job_identifier,
  :search_job_arn,
  :name,
  :status,
  :creation_time,
  :completion_time,
  :search_scope_summary,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

This is the name of the search job.

Returns:

• (String)

# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/types.rb', line 1061

class SearchJobSummary < Struct.new(
  :search_job_identifier,
  :search_job_arn,
  :name,
  :status,
  :creation_time,
  :completion_time,
  :search_scope_summary,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end

#search_job_arn ⇒ String

The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.

Returns:

• (String)

# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/types.rb', line 1061

class SearchJobSummary < Struct.new(
  :search_job_identifier,
  :search_job_arn,
  :name,
  :status,
  :creation_time,
  :completion_time,
  :search_scope_summary,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end

#search_job_identifier ⇒ String

The unique string that specifies the search job.

Returns:

• (String)

# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/types.rb', line 1061

class SearchJobSummary < Struct.new(
  :search_job_identifier,
  :search_job_arn,
  :name,
  :status,
  :creation_time,
  :completion_time,
  :search_scope_summary,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end

#search_scope_summary ⇒ Types::SearchScopeSummary

Returned summary of the specified search job scope, including:

• TotalBackupsToScanCount, the number of recovery points returned by the search.

• TotalItemsToScanCount, the number of items returned by the search.

Returns:

• (Types::SearchScopeSummary)

# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/types.rb', line 1061

class SearchJobSummary < Struct.new(
  :search_job_identifier,
  :search_job_arn,
  :name,
  :status,
  :creation_time,
  :completion_time,
  :search_scope_summary,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

This is the status of the search job.

Returns:

• (String)

# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/types.rb', line 1061

class SearchJobSummary < Struct.new(
  :search_job_identifier,
  :search_job_arn,
  :name,
  :status,
  :creation_time,
  :completion_time,
  :search_scope_summary,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end

#status_message ⇒ String

A status message will be returned for either a earch job with a status of ERRORED or a status of COMPLETED jobs with issues.

For example, a message may say that a search contained recovery points unable to be scanned because of a permissions issue.

Returns:

• (String)

# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/types.rb', line 1061

class SearchJobSummary < Struct.new(
  :search_job_identifier,
  :search_job_arn,
  :name,
  :status,
  :creation_time,
  :completion_time,
  :search_scope_summary,
  :status_message)
  SENSITIVE = []
  include Aws::Structure
end