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

Class SearchJobSummary

java.lang.Object

software.amazon.awssdk.services.backupsearch.model.SearchJobSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SearchJobSummary.Builder,SearchJobSummary>

@Generated("software.amazon.awssdk:codegen")
public final class SearchJobSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SearchJobSummary.Builder,SearchJobSummary>

This is information pertaining to a search job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SearchJobSummary.Builder

Method Summary

Modifier and Type	Method	Description
static SearchJobSummary.Builder	builder()
Instant	completionTime()	This is the completion time of the search job.
Instant	creationTime()	This is the creation time of the search job.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	This is the name of the 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 specifies the search job.
SearchScopeSummary	searchScopeSummary()	Returned summary of the specified search job scope, including:
static Class<? extends SearchJobSummary.Builder>	serializableBuilderClass()
SearchJobState	status()	This is the status of the search job.
String	statusAsString()	This is the status of the 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.
SearchJobSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

searchJobIdentifier

public final String searchJobIdentifier()

The unique string that specifies the search job.

Returns:

The unique string that specifies the 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.

name

public final String name()

This is the name of the search job.

Returns:

This is the name of the search job.

status

public final SearchJobState status()

This is the status of the search job.

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:

This is the status of the search job.

See Also:

SearchJobState

statusAsString

public final String statusAsString()

This is the status of the search job.

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:

This is the status of the search job.

See Also:

SearchJobState

creationTime

public final Instant creationTime()

This is the creation time of the search job.

Returns:

This is the creation time of the search job.

completionTime

public final Instant completionTime()

This is the completion time of the search job.

Returns:

This is the completion time of the 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.

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.

toBuilder

public SearchJobSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchJobSummary.Builder,SearchJobSummary>

builder

public static SearchJobSummary.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

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