Class ListRestoreJobsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListRestoreJobsRequest.Builder,
ListRestoreJobsRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The account ID to list the jobs from.final Instant
Returns only copy jobs completed after a date expressed in Unix format and Coordinated Universal Time (UTC).final Instant
Returns only copy jobs completed before a date expressed in Unix format and Coordinated Universal Time (UTC).final Instant
Returns only restore jobs that were created after the specified date.final Instant
Returns only restore jobs that were created before the specified date.final String
Include this parameter to return only restore jobs for the specified resources:final String
This returns only restore testing jobs that match the specified resource Amazon Resource Name (ARN).final RestoreJobStatus
byStatus()
Returns only restore jobs associated with the specified job status.final String
Returns only restore jobs associated with the specified job status.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final Integer
The maximum number of items to be returned.final String
The next item following a partial list of returned items.static Class
<? extends ListRestoreJobsRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The maximum number of items to be returned.
- Returns:
- The maximum number of items to be returned.
-
byAccountId
The account ID to list the jobs from. Returns only restore jobs associated with the specified account ID.
- Returns:
- The account ID to list the jobs from. Returns only restore jobs associated with the specified account ID.
-
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:
- 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
-
-
-
byCreatedBefore
Returns only restore jobs that were created before the specified date.
- Returns:
- Returns only restore jobs that were created before the specified date.
-
byCreatedAfter
Returns only restore jobs that were created after the specified date.
- Returns:
- Returns only restore jobs that were created after the specified date.
-
byStatus
Returns only restore jobs associated with the specified job status.
If the service returns an enum value that is not available in the current SDK version,
byStatus
will returnRestoreJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frombyStatusAsString()
.- Returns:
- Returns only restore jobs associated with the specified job status.
- See Also:
-
byStatusAsString
Returns only restore jobs associated with the specified job status.
If the service returns an enum value that is not available in the current SDK version,
byStatus
will returnRestoreJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frombyStatusAsString()
.- Returns:
- Returns only restore jobs associated with the specified job status.
- See Also:
-
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
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).
-
byRestoreTestingPlanArn
This returns only restore testing jobs that match the specified resource Amazon Resource Name (ARN).
- Returns:
- This returns only restore testing jobs that match the specified resource Amazon Resource Name (ARN).
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ListRestoreJobsRequest.Builder,
ListRestoreJobsRequest> - Specified by:
toBuilder
in classBackupRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-