software.amazon.awssdk.services.backup.model

Interface ListCopyJobsRequest.Builder

All Superinterfaces:

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

Enclosing class:

ListCopyJobsRequest

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

Method Summary

Modifier and Type	Method and Description
ListCopyJobsRequest.Builder	byAccountId(String byAccountId) The account ID to list the jobs from.
ListCopyJobsRequest.Builder	byCompleteAfter(Instant byCompleteAfter) Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).
ListCopyJobsRequest.Builder	byCompleteBefore(Instant byCompleteBefore) Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).
ListCopyJobsRequest.Builder	byCreatedAfter(Instant byCreatedAfter) Returns only copy jobs that were created after the specified date.
ListCopyJobsRequest.Builder	byCreatedBefore(Instant byCreatedBefore) Returns only copy jobs that were created before the specified date.
ListCopyJobsRequest.Builder	byDestinationVaultArn(String byDestinationVaultArn) An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
ListCopyJobsRequest.Builder	byParentJobId(String byParentJobId) This is a filter to list child (nested) jobs based on parent job ID.
ListCopyJobsRequest.Builder	byResourceArn(String byResourceArn) Returns only copy jobs that match the specified resource Amazon Resource Name (ARN).
ListCopyJobsRequest.Builder	byResourceType(String byResourceType) Returns only backup jobs for the specified resources:
ListCopyJobsRequest.Builder	byState(CopyJobState byState) Returns only copy jobs that are in the specified state.
ListCopyJobsRequest.Builder	byState(String byState) Returns only copy jobs that are in the specified state.
ListCopyJobsRequest.Builder	maxResults(Integer maxResults) The maximum number of items to be returned.
ListCopyJobsRequest.Builder	nextToken(String nextToken) The next item following a partial list of returned items.
ListCopyJobsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
ListCopyJobsRequest.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

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

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

ListCopyJobsRequest.Builder byResourceArn(String byResourceArn)

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

Parameters:

byResourceArn - Returns only copy 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

ListCopyJobsRequest.Builder byState(String byState)

Returns only copy jobs that are in the specified state.

Parameters:

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

Returns:

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

See Also:

CopyJobState, CopyJobState

byState

ListCopyJobsRequest.Builder byState(CopyJobState byState)

Returns only copy jobs that are in the specified state.

Parameters:

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

Returns:

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

See Also:

CopyJobState, CopyJobState

byCreatedBefore

ListCopyJobsRequest.Builder byCreatedBefore(Instant byCreatedBefore)

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

Parameters:

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

Returns:

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

byCreatedAfter

ListCopyJobsRequest.Builder byCreatedAfter(Instant byCreatedAfter)

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

Parameters:

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

Returns:

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

byResourceType

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

byDestinationVaultArn

ListCopyJobsRequest.Builder byDestinationVaultArn(String byDestinationVaultArn)

An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

Parameters:

byDestinationVaultArn - An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

Returns:

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

byAccountId

ListCopyJobsRequest.Builder byAccountId(String byAccountId)

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

Parameters:

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

Returns:

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

byCompleteBefore

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

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

byParentJobId

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

ListCopyJobsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder