Package software.amazon.awssdk.services.backupsearch.model

Class GetSearchJobResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.backupsearch.model.BackupSearchResponse

software.amazon.awssdk.services.backupsearch.model.GetSearchJobResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetSearchJobResponse.Builder,GetSearchJobResponse>

@Generated("software.amazon.awssdk:codegen")
public final class GetSearchJobResponse
extends BackupSearchResponse
implements ToCopyableBuilder<GetSearchJobResponse.Builder,GetSearchJobResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetSearchJobResponse.Builder

Method Summary

Modifier and Type	Method	Description
static GetSearchJobResponse.Builder	builder()
Instant	completionTime()	The date and time that a search job completed, in Unix format and Coordinated Universal Time (UTC).
Instant	creationTime()	The date and time that a search job was created, in Unix format and Coordinated Universal Time (UTC).
CurrentSearchProgress	currentSearchProgress()	Returns numbers representing BackupsScannedCount, ItemsScanned, and ItemsMatched.
String	encryptionKeyArn()	The encryption key for the specified search job.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
ItemFilters	itemFilters()	Item Filters represent all input item properties specified when the search was created.
String	name()	Returned name of the specified search job.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
String	searchJobArn()	The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.
String	searchJobIdentifier()	The unique string that identifies the specified search job.
SearchScope	searchScope()	The search scope is all backup properties input into a search.
SearchScopeSummary	searchScopeSummary()	Returned summary of the specified search job scope, including:
static Class<? extends GetSearchJobResponse.Builder>	serializableBuilderClass()
SearchJobState	status()	The current status of the specified search job.
String	statusAsString()	The current status of the specified search job.
String	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.
GetSearchJobResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.backupsearch.model.BackupSearchResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public final String name()

Returned name of the specified search job.

Returns:

Returned name of the specified search job.

searchScopeSummary

public final SearchScopeSummary 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:

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.

currentSearchProgress

public final CurrentSearchProgress currentSearchProgress()

Returns numbers representing BackupsScannedCount, ItemsScanned, and ItemsMatched.

Returns:

Returns numbers representing BackupsScannedCount, ItemsScanned, and ItemsMatched.

statusMessage

public final String 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.

Returns:

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.

encryptionKeyArn

public final String encryptionKeyArn()

The encryption key for the specified search job.

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

Returns:

The encryption key for the specified search job.

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

completionTime

public final Instant 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.

Returns:

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.

status

public final SearchJobState 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 .

If the service returns an enum value that is not available in the current SDK version, status will return SearchJobState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

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 .

See Also:

SearchJobState

statusAsString

public final String statusAsString()

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 .

If the service returns an enum value that is not available in the current SDK version, status will return SearchJobState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

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 .

See Also:

SearchJobState

searchScope

public final SearchScope searchScope()

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

Returns:

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

itemFilters

public final ItemFilters itemFilters()

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

Returns:

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

creationTime

public final Instant 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.

Returns:

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.

searchJobIdentifier

public final String searchJobIdentifier()

The unique string that identifies the specified search job.

Returns:

The unique string that identifies the specified search job.

searchJobArn

public final String searchJobArn()

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

Returns:

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

toBuilder

public GetSearchJobResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetSearchJobResponse.Builder,GetSearchJobResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetSearchJobResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetSearchJobResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo