Skip to content

/AWS1/CL_BURGETSEARCHJOBOUTPUT

GetSearchJobOutput

CONSTRUCTOR

IMPORTING

Required arguments:

iv_status TYPE /AWS1/BURSEARCHJOBSTATE /AWS1/BURSEARCHJOBSTATE

The current status of the specified search job.

A search job may have one of the following statuses: RUNNING; COMPLETED; STOPPED; FAILED; TIMED_OUT; or EXPIRED .

io_searchscope TYPE REF TO /AWS1/CL_BURSEARCHSCOPE /AWS1/CL_BURSEARCHSCOPE

The search scope is all backup properties input into a search.

io_itemfilters TYPE REF TO /AWS1/CL_BURITEMFILTERS /AWS1/CL_BURITEMFILTERS

Item Filters represent all input item properties specified when the search was created.

iv_creationtime TYPE /AWS1/BURTIMESTAMP /AWS1/BURTIMESTAMP

The date and time that a search job was created, in Unix format and Coordinated Universal Time (UTC). The value of CompletionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

iv_searchjobidentifier TYPE /AWS1/BURGENERICID /AWS1/BURGENERICID

The unique string that identifies the specified search job.

iv_searchjobarn TYPE /AWS1/BURSEARCHJOBARN /AWS1/BURSEARCHJOBARN

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

Optional arguments:

iv_name TYPE /AWS1/BURSTRING /AWS1/BURSTRING

Returned name of the specified search job.

io_searchscopesummary TYPE REF TO /AWS1/CL_BURSEARCHSCOPESUMMARY /AWS1/CL_BURSEARCHSCOPESUMMARY

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.

io_currentsearchprogress TYPE REF TO /AWS1/CL_BURCURRENTSEARCHPRGSS /AWS1/CL_BURCURRENTSEARCHPRGSS

Returns numbers representing BackupsScannedCount, ItemsScanned, and ItemsMatched.

iv_statusmessage TYPE /AWS1/BURSTRING /AWS1/BURSTRING

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.

iv_encryptionkeyarn TYPE /AWS1/BURENCRYPTIONKEYARN /AWS1/BURENCRYPTIONKEYARN

The encryption key for the specified search job.

Example: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

iv_completiontime TYPE /AWS1/BURTIMESTAMP /AWS1/BURTIMESTAMP

The date and time that a search job completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Queryable Attributes

Name

Returned name of the specified search job.

Accessible with the following methods

Method Description
GET_NAME() Getter for NAME, with configurable default
ASK_NAME() Getter for NAME w/ exceptions if field has no value
HAS_NAME() Determine if NAME has a value

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.

Accessible with the following methods

Method Description
GET_SEARCHSCOPESUMMARY() Getter for SEARCHSCOPESUMMARY

CurrentSearchProgress

Returns numbers representing BackupsScannedCount, ItemsScanned, and ItemsMatched.

Accessible with the following methods

Method Description
GET_CURRENTSEARCHPROGRESS() Getter for CURRENTSEARCHPROGRESS

StatusMessage

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.

Accessible with the following methods

Method Description
GET_STATUSMESSAGE() Getter for STATUSMESSAGE, with configurable default
ASK_STATUSMESSAGE() Getter for STATUSMESSAGE w/ exceptions if field has no value
HAS_STATUSMESSAGE() Determine if STATUSMESSAGE has a value

EncryptionKeyArn

The encryption key for the specified search job.

Example: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

Accessible with the following methods

Method Description
GET_ENCRYPTIONKEYARN() Getter for ENCRYPTIONKEYARN, with configurable default
ASK_ENCRYPTIONKEYARN() Getter for ENCRYPTIONKEYARN w/ exceptions if field has no va
HAS_ENCRYPTIONKEYARN() Determine if ENCRYPTIONKEYARN has a value

CompletionTime

The date and time that a search job completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Accessible with the following methods

Method Description
GET_COMPLETIONTIME() Getter for COMPLETIONTIME, with configurable default
ASK_COMPLETIONTIME() Getter for COMPLETIONTIME w/ exceptions if field has no valu
HAS_COMPLETIONTIME() Determine if COMPLETIONTIME has a value

Status

The current status of the specified search job.

A search job may have one of the following statuses: RUNNING; COMPLETED; STOPPED; FAILED; TIMED_OUT; or EXPIRED .

Accessible with the following methods

Method Description
GET_STATUS() Getter for STATUS, with configurable default
ASK_STATUS() Getter for STATUS w/ exceptions if field has no value
HAS_STATUS() Determine if STATUS has a value

SearchScope

The search scope is all backup properties input into a search.

Accessible with the following methods

Method Description
GET_SEARCHSCOPE() Getter for SEARCHSCOPE

ItemFilters

Item Filters represent all input item properties specified when the search was created.

Accessible with the following methods

Method Description
GET_ITEMFILTERS() Getter for ITEMFILTERS

CreationTime

The date and time that a search job was created, in Unix format and Coordinated Universal Time (UTC). The value of CompletionTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

Accessible with the following methods

Method Description
GET_CREATIONTIME() Getter for CREATIONTIME, with configurable default
ASK_CREATIONTIME() Getter for CREATIONTIME w/ exceptions if field has no value
HAS_CREATIONTIME() Determine if CREATIONTIME has a value

SearchJobIdentifier

The unique string that identifies the specified search job.

Accessible with the following methods

Method Description
GET_SEARCHJOBIDENTIFIER() Getter for SEARCHJOBIDENTIFIER, with configurable default
ASK_SEARCHJOBIDENTIFIER() Getter for SEARCHJOBIDENTIFIER w/ exceptions if field has no
HAS_SEARCHJOBIDENTIFIER() Determine if SEARCHJOBIDENTIFIER has a value

SearchJobArn

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

Accessible with the following methods

Method Description
GET_SEARCHJOBARN() Getter for SEARCHJOBARN, with configurable default
ASK_SEARCHJOBARN() Getter for SEARCHJOBARN w/ exceptions if field has no value
HAS_SEARCHJOBARN() Determine if SEARCHJOBARN has a value