StartRestoreJobRequest (AWS Java SDK for AWS Backup 1.12.141 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.backup.model.StartRestoreJobRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartRestoreJobRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

StartRestoreJobRequest()

Constructors
Constructor and Description
`StartRestoreJobRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StartRestoreJobRequest`	`addMetadataEntry(String key, String value)` Add a single Metadata entry
`StartRestoreJobRequest`	`clearMetadataEntries()` Removes all the entries added into Metadata.
`StartRestoreJobRequest`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getIamRoleArn()` The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target recovery point; for example, `arn:aws:iam::123456789012:role/S3Access`.
`String`	`getIdempotencyToken()` A customer-chosen string that you can use to distinguish between otherwise identical calls to `StartRestoreJob`.
`Map<String,String>`	`getMetadata()` A set of metadata key-value pairs.
`String`	`getRecoveryPointArn()` An ARN that uniquely identifies a recovery point; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
`String`	`getResourceType()` Starts a job to restore a recovery point for one of the following resources:
`int`	`hashCode()`
`void`	`setIamRoleArn(String iamRoleArn)` The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target recovery point; for example, `arn:aws:iam::123456789012:role/S3Access`.
`void`	`setIdempotencyToken(String idempotencyToken)` A customer-chosen string that you can use to distinguish between otherwise identical calls to `StartRestoreJob`.
`void`	`setMetadata(Map<String,String> metadata)` A set of metadata key-value pairs.
`void`	`setRecoveryPointArn(String recoveryPointArn)` An ARN that uniquely identifies a recovery point; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
`void`	`setResourceType(String resourceType)` Starts a job to restore a recovery point for one of the following resources:
`String`	`toString()` Returns a string representation of this object.
`StartRestoreJobRequest`	`withIamRoleArn(String iamRoleArn)` The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target recovery point; for example, `arn:aws:iam::123456789012:role/S3Access`.
`StartRestoreJobRequest`	`withIdempotencyToken(String idempotencyToken)` A customer-chosen string that you can use to distinguish between otherwise identical calls to `StartRestoreJob`.
`StartRestoreJobRequest`	`withMetadata(Map<String,String> metadata)` A set of metadata key-value pairs.
`StartRestoreJobRequest`	`withRecoveryPointArn(String recoveryPointArn)` An ARN that uniquely identifies a recovery point; for example, `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
`StartRestoreJobRequest`	`withResourceType(String resourceType)` Starts a job to restore a recovery point for one of the following resources:

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - StartRestoreJobRequest
```
public StartRestoreJobRequest()
```
- Method Detail
  - setRecoveryPointArn
```
public void setRecoveryPointArn(String recoveryPointArn)
```
    An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
    
    Parameters:
    
    recoveryPointArn - An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
  - getRecoveryPointArn
```
public String getRecoveryPointArn()
```
    An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
    
    Returns:
    
    An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
  - withRecoveryPointArn
```
public StartRestoreJobRequest withRecoveryPointArn(String recoveryPointArn)
```
    An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
    
    Parameters:
    
    recoveryPointArn - An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getMetadata
```
public Map<String,String> getMetadata()
```
    A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.
    
    You can get configuration metadata about a resource at the time it was backed up by calling GetRecoveryPointRestoreMetadata. However, values in addition to those provided by GetRecoveryPointRestoreMetadata might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.
    
    You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:
    - file-system-id: The ID of the Amazon EFS file system that is backed up by Backup. Returned in GetRecoveryPointRestoreMetadata.
    - Encrypted: A Boolean value that, if true, specifies that the file system is encrypted. If KmsKeyId is specified, Encrypted must be set to true.
    - KmsKeyId: Specifies the Amazon Web Services KMS key that is used to encrypt the restored file system. You can specify a key from another Amazon Web Services account provided that key it is properly shared with your account via Amazon Web Services KMS.
    - PerformanceMode: Specifies the throughput mode of the file system.
    - CreationToken: A user-supplied value that ensures the uniqueness (idempotency) of the request.
    - newFileSystem: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.
    - ItemsToRestore: An array of one to five strings where each string is a file path. Use ItemsToRestore to restore specific files or directories rather than the entire file system. This parameter is optional. For example, "itemsToRestore":"[\"/my.test\"]".
    Returns:
    A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.
    
    You can get configuration metadata about a resource at the time it was backed up by calling GetRecoveryPointRestoreMetadata. However, values in addition to those provided by GetRecoveryPointRestoreMetadata might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.
    
    You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:
    
    file-system-id: The ID of the Amazon EFS file system that is backed up by Backup. Returned in GetRecoveryPointRestoreMetadata.
    
    Encrypted: A Boolean value that, if true, specifies that the file system is encrypted. If KmsKeyId is specified, Encrypted must be set to true.
    
    KmsKeyId: Specifies the Amazon Web Services KMS key that is used to encrypt the restored file system. You can specify a key from another Amazon Web Services account provided that key it is properly shared with your account via Amazon Web Services KMS.
    
    PerformanceMode: Specifies the throughput mode of the file system.
    
    CreationToken: A user-supplied value that ensures the uniqueness (idempotency) of the request.
    
    newFileSystem: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.
    
    ItemsToRestore: An array of one to five strings where each string is a file path. Use ItemsToRestore to restore specific files or directories rather than the entire file system. This parameter is optional. For example, "itemsToRestore":"[\"/my.test\"]".
  - setMetadata
```
public void setMetadata(Map<String,String> metadata)
```
    A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.
    
    You can get configuration metadata about a resource at the time it was backed up by calling GetRecoveryPointRestoreMetadata. However, values in addition to those provided by GetRecoveryPointRestoreMetadata might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.
    
    You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:
    - file-system-id: The ID of the Amazon EFS file system that is backed up by Backup. Returned in GetRecoveryPointRestoreMetadata.
    - Encrypted: A Boolean value that, if true, specifies that the file system is encrypted. If KmsKeyId is specified, Encrypted must be set to true.
    - KmsKeyId: Specifies the Amazon Web Services KMS key that is used to encrypt the restored file system. You can specify a key from another Amazon Web Services account provided that key it is properly shared with your account via Amazon Web Services KMS.
    - PerformanceMode: Specifies the throughput mode of the file system.
    - CreationToken: A user-supplied value that ensures the uniqueness (idempotency) of the request.
    - newFileSystem: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.
    - ItemsToRestore: An array of one to five strings where each string is a file path. Use ItemsToRestore to restore specific files or directories rather than the entire file system. This parameter is optional. For example, "itemsToRestore":"[\"/my.test\"]".
    Parameters:
    metadata - A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.
    
    You can get configuration metadata about a resource at the time it was backed up by calling GetRecoveryPointRestoreMetadata. However, values in addition to those provided by GetRecoveryPointRestoreMetadata might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.
    
    You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:
    
    file-system-id: The ID of the Amazon EFS file system that is backed up by Backup. Returned in GetRecoveryPointRestoreMetadata.
    
    Encrypted: A Boolean value that, if true, specifies that the file system is encrypted. If KmsKeyId is specified, Encrypted must be set to true.
    
    KmsKeyId: Specifies the Amazon Web Services KMS key that is used to encrypt the restored file system. You can specify a key from another Amazon Web Services account provided that key it is properly shared with your account via Amazon Web Services KMS.
    
    PerformanceMode: Specifies the throughput mode of the file system.
    
    CreationToken: A user-supplied value that ensures the uniqueness (idempotency) of the request.
    
    newFileSystem: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.
    
    ItemsToRestore: An array of one to five strings where each string is a file path. Use ItemsToRestore to restore specific files or directories rather than the entire file system. This parameter is optional. For example, "itemsToRestore":"[\"/my.test\"]".
  - withMetadata
```
public StartRestoreJobRequest withMetadata(Map<String,String> metadata)
```
    A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.
    
    You can get configuration metadata about a resource at the time it was backed up by calling GetRecoveryPointRestoreMetadata. However, values in addition to those provided by GetRecoveryPointRestoreMetadata might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.
    
    You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:
    - file-system-id: The ID of the Amazon EFS file system that is backed up by Backup. Returned in GetRecoveryPointRestoreMetadata.
    - Encrypted: A Boolean value that, if true, specifies that the file system is encrypted. If KmsKeyId is specified, Encrypted must be set to true.
    - KmsKeyId: Specifies the Amazon Web Services KMS key that is used to encrypt the restored file system. You can specify a key from another Amazon Web Services account provided that key it is properly shared with your account via Amazon Web Services KMS.
    - PerformanceMode: Specifies the throughput mode of the file system.
    - CreationToken: A user-supplied value that ensures the uniqueness (idempotency) of the request.
    - newFileSystem: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.
    - ItemsToRestore: An array of one to five strings where each string is a file path. Use ItemsToRestore to restore specific files or directories rather than the entire file system. This parameter is optional. For example, "itemsToRestore":"[\"/my.test\"]".
    Parameters:
    metadata - A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.
    
    You can get configuration metadata about a resource at the time it was backed up by calling GetRecoveryPointRestoreMetadata. However, values in addition to those provided by GetRecoveryPointRestoreMetadata might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.
    
    You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:
    
    file-system-id: The ID of the Amazon EFS file system that is backed up by Backup. Returned in GetRecoveryPointRestoreMetadata.
    
    Encrypted: A Boolean value that, if true, specifies that the file system is encrypted. If KmsKeyId is specified, Encrypted must be set to true.
    
    KmsKeyId: Specifies the Amazon Web Services KMS key that is used to encrypt the restored file system. You can specify a key from another Amazon Web Services account provided that key it is properly shared with your account via Amazon Web Services KMS.
    
    PerformanceMode: Specifies the throughput mode of the file system.
    
    CreationToken: A user-supplied value that ensures the uniqueness (idempotency) of the request.
    
    newFileSystem: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.
    
    ItemsToRestore: An array of one to five strings where each string is a file path. Use ItemsToRestore to restore specific files or directories rather than the entire file system. This parameter is optional. For example, "itemsToRestore":"[\"/my.test\"]".
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addMetadataEntry
```
public StartRestoreJobRequest addMetadataEntry(String key,
                                               String value)
```
    Add a single Metadata entry
    
    See Also:
    
    withMetadata(java.util.Map<java.lang.String, java.lang.String>)
  - clearMetadataEntries
```
public StartRestoreJobRequest clearMetadataEntries()
```
    Removes all the entries added into Metadata.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIamRoleArn
```
public void setIamRoleArn(String iamRoleArn)
```
    The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
    
    Parameters:
    
    iamRoleArn - The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
  - getIamRoleArn
```
public String getIamRoleArn()
```
    The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
  - withIamRoleArn
```
public StartRestoreJobRequest withIamRoleArn(String iamRoleArn)
```
    The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
    
    Parameters:
    
    iamRoleArn - The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIdempotencyToken
```
public void setIdempotencyToken(String idempotencyToken)
```
    A customer-chosen string that you can use to distinguish between otherwise identical calls to StartRestoreJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.
    
    Parameters:
    
    idempotencyToken - A customer-chosen string that you can use to distinguish between otherwise identical calls to StartRestoreJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.
  - getIdempotencyToken
```
public String getIdempotencyToken()
```
    A customer-chosen string that you can use to distinguish between otherwise identical calls to StartRestoreJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.
    
    Returns:
    
    A customer-chosen string that you can use to distinguish between otherwise identical calls to StartRestoreJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.
  - withIdempotencyToken
```
public StartRestoreJobRequest withIdempotencyToken(String idempotencyToken)
```
    A customer-chosen string that you can use to distinguish between otherwise identical calls to StartRestoreJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.
    
    Parameters:
    
    idempotencyToken - A customer-chosen string that you can use to distinguish between otherwise identical calls to StartRestoreJob. Retrying a successful request with the same idempotency token results in a success message with no action taken.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResourceType
```
public void setResourceType(String resourceType)
```
    Starts a job to restore a recovery point for one of the following resources:
    - DynamoDB for Amazon DynamoDB
    - EBS for Amazon Elastic Block Store
    - EC2 for Amazon Elastic Compute Cloud
    - EFS for Amazon Elastic File System
    - RDS for Amazon Relational Database Service
    - Aurora for Amazon Aurora
    - Storage Gateway for Storage Gateway
    Parameters:
    resourceType - Starts a job to restore a recovery point for one of the following resources:
    
    DynamoDB for Amazon DynamoDB
    
    EBS for Amazon Elastic Block Store
    
    EC2 for Amazon Elastic Compute Cloud
    
    EFS for Amazon Elastic File System
    
    RDS for Amazon Relational Database Service
    
    Aurora for Amazon Aurora
    
    Storage Gateway for Storage Gateway
  - getResourceType
```
public String getResourceType()
```
    Starts a job to restore a recovery point for one of the following resources:
    - DynamoDB for Amazon DynamoDB
    - EBS for Amazon Elastic Block Store
    - EC2 for Amazon Elastic Compute Cloud
    - EFS for Amazon Elastic File System
    - RDS for Amazon Relational Database Service
    - Aurora for Amazon Aurora
    - Storage Gateway for Storage Gateway
    Returns:
    Starts a job to restore a recovery point for one of the following resources:
    
    DynamoDB for Amazon DynamoDB
    
    EBS for Amazon Elastic Block Store
    
    EC2 for Amazon Elastic Compute Cloud
    
    EFS for Amazon Elastic File System
    
    RDS for Amazon Relational Database Service
    
    Aurora for Amazon Aurora
    
    Storage Gateway for Storage Gateway
  - withResourceType
```
public StartRestoreJobRequest withResourceType(String resourceType)
```
    Starts a job to restore a recovery point for one of the following resources:
    - DynamoDB for Amazon DynamoDB
    - EBS for Amazon Elastic Block Store
    - EC2 for Amazon Elastic Compute Cloud
    - EFS for Amazon Elastic File System
    - RDS for Amazon Relational Database Service
    - Aurora for Amazon Aurora
    - Storage Gateway for Storage Gateway
    Parameters:
    resourceType - Starts a job to restore a recovery point for one of the following resources:
    
    DynamoDB for Amazon DynamoDB
    
    EBS for Amazon Elastic Block Store
    
    EC2 for Amazon Elastic Compute Cloud
    
    EFS for Amazon Elastic File System
    
    RDS for Amazon Relational Database Service
    
    Aurora for Amazon Aurora
    
    Storage Gateway for Storage Gateway
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public StartRestoreJobRequest clone()
```
    Overrides:
    
    clone in class AmazonWebServiceRequest

Class StartRestoreJobRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

StartRestoreJobRequest

Method Detail

setRecoveryPointArn

getRecoveryPointArn

withRecoveryPointArn

getMetadata

setMetadata

withMetadata

addMetadataEntry

clearMetadataEntries

setIamRoleArn

getIamRoleArn

withIamRoleArn

setIdempotencyToken

getIdempotencyToken

withIdempotencyToken

setResourceType

getResourceType

withResourceType

toString

equals

hashCode

clone