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

Class GetSearchResultExportJobResponse

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.GetSearchResultExportJobResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetSearchResultExportJobResponse.Builder,GetSearchResultExportJobResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetSearchResultExportJobResponse.Builder

Method Summary

Modifier and Type	Method	Description
static GetSearchResultExportJobResponse.Builder	builder()
Instant	completionTime()	The date and time that an export job completed, in Unix format and Coordinated Universal Time (UTC).
Instant	creationTime()	The date and time that an export job was created, in Unix format and Coordinated Universal Time (UTC).
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	exportJobArn()	The unique Amazon Resource Name (ARN) that uniquely identifies the export job.
String	exportJobIdentifier()	This is the unique string that identifies the specified export job.
ExportSpecification	exportSpecification()	The export specification consists of the destination S3 bucket to which the search results were exported, along with the destination prefix.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
String	searchJobArn()	The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.
static Class<? extends GetSearchResultExportJobResponse.Builder>	serializableBuilderClass()
ExportJobStatus	status()	This is the current status of the export job.
String	statusAsString()	This is the current status of the export job.
String	statusMessage()	A status message is a string that is returned for search job with a status of FAILED, along with steps to remedy and retry the operation.
GetSearchResultExportJobResponse.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

exportJobIdentifier

public final String exportJobIdentifier()

This is the unique string that identifies the specified export job.

Returns:

This is the unique string that identifies the specified export job.

exportJobArn

public final String exportJobArn()

The unique Amazon Resource Name (ARN) that uniquely identifies the export job.

Returns:

The unique Amazon Resource Name (ARN) that uniquely identifies the export job.

status

public final ExportJobStatus status()

This is the current status of the export job.

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

Returns:

This is the current status of the export job.

See Also:

ExportJobStatus

statusAsString

public final String statusAsString()

This is the current status of the export job.

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

Returns:

This is the current status of the export job.

See Also:

ExportJobStatus

creationTime

public final Instant creationTime()

The date and time that an export job was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime 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 an export job was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

completionTime

public final Instant completionTime()

The date and time that an export job completed, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime 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 an export job completed, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

statusMessage

public final String statusMessage()

A status message is a string that is returned for search job with a status of FAILED, along with steps to remedy and retry the operation.

Returns:

A status message is a string that is returned for search job with a status of FAILED, along with steps to remedy and retry the operation.

exportSpecification

public final ExportSpecification exportSpecification()

The export specification consists of the destination S3 bucket to which the search results were exported, along with the destination prefix.

Returns:

The export specification consists of the destination S3 bucket to which the search results were exported, along with the destination prefix.

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 GetSearchResultExportJobResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetSearchResultExportJobResponse.Builder,GetSearchResultExportJobResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetSearchResultExportJobResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetSearchResultExportJobResponse.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