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

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<ListCopyJobsRequest.Builder,ListCopyJobsRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ListCopyJobsRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ListCopyJobsRequest.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 copy jobs that were created after the specified date.
`Instant`	`byCreatedBefore()`	Returns only copy jobs that were created before the specified date.
`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`.
`String`	`byMessageCategory()`	This is an optional parameter that can be used to filter out jobs with a MessageCategory which matches the value you input.
`String`	`byParentJobId()`	This is a filter to list child (nested) jobs based on parent job ID.
`String`	`byResourceArn()`	Returns only copy jobs that match the specified resource Amazon Resource Name (ARN).
`String`	`byResourceType()`	Returns only backup jobs for the specified resources:
`CopyJobState`	`byState()`	Returns only copy jobs that are in the specified state.
`String`	`byStateAsString()`	Returns only copy jobs that are in the specified state.
`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 ListCopyJobsRequest.Builder>`	`serializableBuilderClass()`
`ListCopyJobsRequest.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.
  - byResourceArn
```
public final String byResourceArn()
```
    Returns only copy jobs that match the specified resource Amazon Resource Name (ARN).
    
    Returns:
    
    Returns only copy jobs that match the specified resource Amazon Resource Name (ARN).
  - byState
```
public final CopyJobState byState()
```
    Returns only copy jobs that are in the specified state.
    
    If the service returns an enum value that is not available in the current SDK version, byState will return CopyJobState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from byStateAsString().
    
    Returns:
    
    Returns only copy jobs that are in the specified state.
    
    See Also:
    
    CopyJobState
  - byStateAsString
```
public final String byStateAsString()
```
    Returns only copy jobs that are in the specified state.
    
    If the service returns an enum value that is not available in the current SDK version, byState will return CopyJobState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from byStateAsString().
    
    Returns:
    
    Returns only copy jobs that are in the specified state.
    
    See Also:
    
    CopyJobState
  - byCreatedBefore
```
public final Instant byCreatedBefore()
```
    Returns only copy jobs that were created before the specified date.
    
    Returns:
    
    Returns only copy jobs that were created before the specified date.
  - byCreatedAfter
```
public final Instant byCreatedAfter()
```
    Returns only copy jobs that were created after the specified date.
    
    Returns:
    
    Returns only copy jobs that were created after the specified date.
  - byResourceType
```
public final 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
    Returns:
    
    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
  - byDestinationVaultArn
```
public final 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.
    
    Returns:
    
    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.
  - byAccountId
```
public final String byAccountId()
```
    The account ID to list the jobs from. Returns only copy jobs associated with the specified account ID.
    
    Returns:
    
    The account ID to list the jobs from. Returns only copy jobs associated with the specified account ID.
  - 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).
  - byParentJobId
```
public final String byParentJobId()
```
    This is a filter to list child (nested) jobs based on parent job ID.
    
    Returns:
    
    This is a filter to list child (nested) jobs based on parent job ID.
  - byMessageCategory
```
public final 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.
    
    Returns:
    
    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.
  - toBuilder
```
public ListCopyJobsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ListCopyJobsRequest.Builder,ListCopyJobsRequest>
    
    Specified by:
    
    toBuilder in class BackupRequest
  - builder
```
public static ListCopyJobsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListCopyJobsRequest.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

Class ListCopyJobsRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

nextToken

maxResults

byResourceArn

byState

byStateAsString

byCreatedBefore

byCreatedAfter

byResourceType

byDestinationVaultArn

byAccountId

byCompleteBefore

byCompleteAfter

byParentJobId

byMessageCategory

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields