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

Interface ListRestoreJobsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, BackupRequest.Builder, Buildable, CopyableBuilder<ListRestoreJobsRequest.Builder,ListRestoreJobsRequest>, SdkBuilder<ListRestoreJobsRequest.Builder,ListRestoreJobsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ListRestoreJobsRequest
public static interface ListRestoreJobsRequest.Builder extends BackupRequest.Builder, SdkPojo, CopyableBuilder<ListRestoreJobsRequest.Builder,ListRestoreJobsRequest>

  • Method Details

    • nextToken

      ListRestoreJobsRequest.Builder nextToken(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      ListRestoreJobsRequest.Builder maxResults(Integer maxResults)

      The maximum number of items to be returned.

      Parameters:
      maxResults - The maximum number of items to be returned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • byAccountId

      ListRestoreJobsRequest.Builder byAccountId(String byAccountId)

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

      Parameters:
      byAccountId - The account ID to list the jobs from. Returns only restore jobs associated with the specified account ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • byResourceType

      ListRestoreJobsRequest.Builder byResourceType(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • byCreatedBefore

      ListRestoreJobsRequest.Builder byCreatedBefore(Instant byCreatedBefore)

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

      Parameters:
      byCreatedBefore - Returns only restore jobs that were created before the specified date.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • byCreatedAfter

      ListRestoreJobsRequest.Builder byCreatedAfter(Instant byCreatedAfter)

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

      Parameters:
      byCreatedAfter - Returns only restore jobs that were created after the specified date.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • byStatus

      ListRestoreJobsRequest.Builder byStatus(String byStatus)

      Returns only restore jobs associated with the specified job status.

      Parameters:
      byStatus - Returns only restore jobs associated with the specified job status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • byStatus

      ListRestoreJobsRequest.Builder byStatus(RestoreJobStatus byStatus)

      Returns only restore jobs associated with the specified job status.

      Parameters:
      byStatus - Returns only restore jobs associated with the specified job status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • byCompleteBefore

      ListRestoreJobsRequest.Builder byCompleteBefore(Instant byCompleteBefore)

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

      Parameters:
      byCompleteBefore - Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • byCompleteAfter

      ListRestoreJobsRequest.Builder byCompleteAfter(Instant byCompleteAfter)

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

      Parameters:
      byCompleteAfter - Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • byRestoreTestingPlanArn

      ListRestoreJobsRequest.Builder byRestoreTestingPlanArn(String byRestoreTestingPlanArn)

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

      Parameters:
      byRestoreTestingPlanArn - This returns only restore testing jobs that match the specified resource Amazon Resource Name (ARN).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      ListRestoreJobsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ListRestoreJobsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.