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

Interface ListCopyJobsRequest.Builder

    • 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

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

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

      • byMessageCategory

        ListCopyJobsRequest.Builder byMessageCategory​(String byMessageCategory)

        This is an optional parameter that can be used to filter out jobs with a MessageCategory which matches the value you input.

        Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS.

        View Monitoring for a list of accepted strings.

        The the value ANY returns count of all message categories.

        AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.

        Parameters:
        byMessageCategory - This is an optional parameter that can be used to filter out jobs with a MessageCategory which matches the value you input.

        Example strings may include AccessDenied, SUCCESS, AGGREGATE_ALL, and INVALIDPARAMETERS.

        View Monitoring for a list of accepted strings.

        The the value ANY returns count of all message categories.

        AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.

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