Package software.amazon.awssdk.services.backup.model

Class ListRestoreJobsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.backup.model.BackupRequest

software.amazon.awssdk.services.backup.model.ListRestoreJobsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListRestoreJobsRequest.Builder,ListRestoreJobsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListRestoreJobsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListRestoreJobsRequest.Builder	builder()
String	byAccountId()	The account ID to list the jobs from.
Instant	byCompleteAfter()	Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).
Instant	byCompleteBefore()	Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).
Instant	byCreatedAfter()	Returns only restore jobs that were created after the specified date.
Instant	byCreatedBefore()	Returns only restore jobs that were created before the specified date.
String	byResourceType()	Include this parameter to return only restore jobs for the specified resources:
String	byRestoreTestingPlanArn()	This returns only restore testing jobs that match the specified resource Amazon Resource Name (ARN).
RestoreJobStatus	byStatus()	Returns only restore jobs associated with the specified job status.
String	byStatusAsString()	Returns only restore jobs associated with the specified job status.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults()	The maximum number of items to be returned.
String	nextToken()	The next item following a partial list of returned items.
List<SdkField<?>>	sdkFields()
static Class<? extends ListRestoreJobsRequest.Builder>	serializableBuilderClass()
ListRestoreJobsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

nextToken

public final String nextToken()

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Returns:

The next item following a partial list of returned items. For example, if a request is made to return MaxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

maxResults

public final Integer maxResults()

The maximum number of items to be returned.

Returns:

The maximum number of items to be returned.

byAccountId

public final String byAccountId()

The account ID to list the jobs from. Returns only restore jobs associated with the specified account ID.

Returns:

The account ID to list the jobs from. Returns only restore jobs associated with the specified account ID.

byResourceType

public final String byResourceType()

Include this parameter to return only restore jobs for the specified resources:

• Aurora for Amazon Aurora

• CloudFormation for CloudFormation

• DocumentDB for Amazon DocumentDB (with MongoDB compatibility)

• DynamoDB for Amazon DynamoDB

• EBS for Amazon Elastic Block Store

• EC2 for Amazon Elastic Compute Cloud

• EFS for Amazon Elastic File System

• FSx for Amazon FSx

• Neptune for Amazon Neptune

• Redshift for Amazon Redshift

• RDS for Amazon Relational Database Service

• SAP HANA on Amazon EC2 for SAP HANA databases

• Storage Gateway for Storage Gateway

• S3 for Amazon S3

• Timestream for Amazon Timestream

• VirtualMachine for virtual machines

Returns:

Include this parameter to return only restore jobs for the specified resources:

• Aurora for Amazon Aurora

• CloudFormation for CloudFormation

• DocumentDB for Amazon DocumentDB (with MongoDB compatibility)

• DynamoDB for Amazon DynamoDB

• EBS for Amazon Elastic Block Store

• EC2 for Amazon Elastic Compute Cloud

• EFS for Amazon Elastic File System

• FSx for Amazon FSx

• Neptune for Amazon Neptune

• Redshift for Amazon Redshift

• RDS for Amazon Relational Database Service

• SAP HANA on Amazon EC2 for SAP HANA databases

• Storage Gateway for Storage Gateway

• S3 for Amazon S3

• Timestream for Amazon Timestream

• VirtualMachine for virtual machines

byCreatedBefore

public final Instant byCreatedBefore()

Returns only restore jobs that were created before the specified date.

Returns:

Returns only restore jobs that were created before the specified date.

byCreatedAfter

public final Instant byCreatedAfter()

Returns only restore jobs that were created after the specified date.

Returns:

Returns only restore jobs that were created after the specified date.

byStatus

public final RestoreJobStatus byStatus()

Returns only restore jobs associated with the specified job status.

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

Returns:

Returns only restore jobs associated with the specified job status.

See Also:

RestoreJobStatus

byStatusAsString

public final String byStatusAsString()

Returns only restore jobs associated with the specified job status.

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

Returns:

Returns only restore jobs associated with the specified job status.

See Also:

RestoreJobStatus

byCompleteBefore

public final Instant byCompleteBefore()

Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).

Returns:

Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).

byCompleteAfter

public final Instant byCompleteAfter()

Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).

Returns:

Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).

byRestoreTestingPlanArn

public final String byRestoreTestingPlanArn()

This returns only restore testing jobs that match the specified resource Amazon Resource Name (ARN).

Returns:

This returns only restore testing jobs that match the specified resource Amazon Resource Name (ARN).

toBuilder

public ListRestoreJobsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListRestoreJobsRequest.Builder,ListRestoreJobsRequest>

Specified by:

toBuilder in class BackupRequest

builder

public static ListRestoreJobsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo