software.amazon.awssdk.services.backup.model

Interface ListBackupJobsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, BackupRequest.Builder, Buildable, CopyableBuilder<ListBackupJobsRequest.Builder,ListBackupJobsRequest>, SdkBuilder<ListBackupJobsRequest.Builder,ListBackupJobsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ListBackupJobsRequest

public static interface ListBackupJobsRequest.Builder
extends BackupRequest.Builder, SdkPojo, CopyableBuilder<ListBackupJobsRequest.Builder,ListBackupJobsRequest>

Method Summary

Modifier and Type	Method and Description
ListBackupJobsRequest.Builder	byAccountId(String byAccountId) The account ID to list the jobs from.
ListBackupJobsRequest.Builder	byBackupVaultName(String byBackupVaultName) Returns only backup jobs that will be stored in the specified backup vault.
ListBackupJobsRequest.Builder	byCompleteAfter(Instant byCompleteAfter) Returns only backup jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).
ListBackupJobsRequest.Builder	byCompleteBefore(Instant byCompleteBefore) Returns only backup jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).
ListBackupJobsRequest.Builder	byCreatedAfter(Instant byCreatedAfter) Returns only backup jobs that were created after the specified date.
ListBackupJobsRequest.Builder	byCreatedBefore(Instant byCreatedBefore) Returns only backup jobs that were created before the specified date.
ListBackupJobsRequest.Builder	byParentJobId(String byParentJobId) This is a filter to list child (nested) jobs based on parent job ID.
ListBackupJobsRequest.Builder	byResourceArn(String byResourceArn) Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).
ListBackupJobsRequest.Builder	byResourceType(String byResourceType) Returns only backup jobs for the specified resources:
ListBackupJobsRequest.Builder	byState(BackupJobState byState) Returns only backup jobs that are in the specified state.
ListBackupJobsRequest.Builder	byState(String byState) Returns only backup jobs that are in the specified state.
ListBackupJobsRequest.Builder	maxResults(Integer maxResults) The maximum number of items to be returned.
ListBackupJobsRequest.Builder	nextToken(String nextToken) The next item following a partial list of returned items.
ListBackupJobsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
ListBackupJobsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Methods inherited from interface software.amazon.awssdk.services.backup.model.BackupRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

nextToken

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

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

byResourceArn

ListBackupJobsRequest.Builder byResourceArn(String byResourceArn)

Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).

Parameters:

byResourceArn - Returns only backup 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.

byState

ListBackupJobsRequest.Builder byState(String byState)

Returns only backup jobs that are in the specified state.

Parameters:

byState - Returns only backup jobs that are in the specified state.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BackupJobState, BackupJobState

byState

ListBackupJobsRequest.Builder byState(BackupJobState byState)

Returns only backup jobs that are in the specified state.

Parameters:

byState - Returns only backup jobs that are in the specified state.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

BackupJobState, BackupJobState

byBackupVaultName

ListBackupJobsRequest.Builder byBackupVaultName(String byBackupVaultName)

Returns only backup jobs that will be stored in the specified backup vault. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Parameters:

byBackupVaultName - Returns only backup jobs that will be stored in the specified backup vault. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

Returns:

Returns a reference to this object so that method calls can be chained together.

byCreatedBefore

ListBackupJobsRequest.Builder byCreatedBefore(Instant byCreatedBefore)

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

Parameters:

byCreatedBefore - Returns only backup jobs that were created before the specified date.

Returns:

Returns a reference to this object so that method calls can be chained together.

byCreatedAfter

ListBackupJobsRequest.Builder byCreatedAfter(Instant byCreatedAfter)

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

Parameters:

byCreatedAfter - Returns only backup jobs that were created after the specified date.

Returns:

Returns a reference to this object so that method calls can be chained together.

byResourceType

ListBackupJobsRequest.Builder byResourceType(String byResourceType)

Returns only backup jobs for the specified resources:

• Aurora for Amazon Aurora

• 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

• RDS for Amazon Relational Database Service

• Storage Gateway for Storage Gateway

• S3 for Amazon S3

• VirtualMachine for virtual machines

Parameters:

byResourceType - Returns only backup jobs for the specified resources:

• Aurora for Amazon Aurora

• 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

• RDS for Amazon Relational Database Service

• Storage Gateway for Storage Gateway

• S3 for Amazon S3

• VirtualMachine for virtual machines

Returns:

Returns a reference to this object so that method calls can be chained together.

byAccountId

ListBackupJobsRequest.Builder byAccountId(String byAccountId)

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

If used from an Organizations management account, passing * returns all jobs across the organization.

Parameters:

byAccountId - The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.

If used from an Organizations management account, passing * returns all jobs across the organization.

Returns:

Returns a reference to this object so that method calls can be chained together.

byCompleteAfter

ListBackupJobsRequest.Builder byCompleteAfter(Instant byCompleteAfter)

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

Parameters:

byCompleteAfter - Returns only backup 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.

byCompleteBefore

ListBackupJobsRequest.Builder byCompleteBefore(Instant byCompleteBefore)

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

Parameters:

byCompleteBefore - Returns only backup 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.

byParentJobId

ListBackupJobsRequest.Builder byParentJobId(String byParentJobId)

This is a filter to list child (nested) jobs based on parent job ID.

Parameters:

byParentJobId - This is a filter to list child (nested) jobs based on parent job ID.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

ListBackupJobsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

ListBackupJobsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder