StartBackupJobRequest (AWS SDK for Java

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

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

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartBackupJobRequest
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

StartBackupJobRequest()

Constructors
Constructor and Description
`StartBackupJobRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StartBackupJobRequest`	`addBackupOptionsEntry(String key, String value)` Add a single BackupOptions entry
`StartBackupJobRequest`	`addRecoveryPointTagsEntry(String key, String value)` Add a single RecoveryPointTags entry
`StartBackupJobRequest`	`clearBackupOptionsEntries()` Removes all the entries added into BackupOptions.
`StartBackupJobRequest`	`clearRecoveryPointTagsEntries()` Removes all the entries added into RecoveryPointTags.
`StartBackupJobRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getBackupOptions()` Specifies the backup option for a selected resource.
`String`	`getBackupVaultName()` The name of a logical container where backups are stored.
`Long`	`getCompleteWindowMinutes()` A value in minutes during which a successfully started backup must complete, or else AWS Backup will cancel the job.
`String`	`getIamRoleArn()` Specifies the IAM role ARN used to create the target recovery point; for example, `arn:aws:iam::123456789012:role/S3Access`.
`String`	`getIdempotencyToken()` A customer chosen string that can be used to distinguish between calls to `StartBackupJob`.
`Lifecycle`	`getLifecycle()` The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.
`Map<String,String>`	`getRecoveryPointTags()` To help organize your resources, you can assign your own metadata to the resources that you create.
`String`	`getResourceArn()` An Amazon Resource Name (ARN) that uniquely identifies a resource.
`Long`	`getStartWindowMinutes()` A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully.
`int`	`hashCode()`
`void`	`setBackupOptions(Map<String,String> backupOptions)` Specifies the backup option for a selected resource.
`void`	`setBackupVaultName(String backupVaultName)` The name of a logical container where backups are stored.
`void`	`setCompleteWindowMinutes(Long completeWindowMinutes)` A value in minutes during which a successfully started backup must complete, or else AWS Backup will cancel the job.
`void`	`setIamRoleArn(String iamRoleArn)` Specifies the IAM role ARN used to create the target recovery point; for example, `arn:aws:iam::123456789012:role/S3Access`.
`void`	`setIdempotencyToken(String idempotencyToken)` A customer chosen string that can be used to distinguish between calls to `StartBackupJob`.
`void`	`setLifecycle(Lifecycle lifecycle)` The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.
`void`	`setRecoveryPointTags(Map<String,String> recoveryPointTags)` To help organize your resources, you can assign your own metadata to the resources that you create.
`void`	`setResourceArn(String resourceArn)` An Amazon Resource Name (ARN) that uniquely identifies a resource.
`void`	`setStartWindowMinutes(Long startWindowMinutes)` A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully.
`String`	`toString()` Returns a string representation of this object.
`StartBackupJobRequest`	`withBackupOptions(Map<String,String> backupOptions)` Specifies the backup option for a selected resource.
`StartBackupJobRequest`	`withBackupVaultName(String backupVaultName)` The name of a logical container where backups are stored.
`StartBackupJobRequest`	`withCompleteWindowMinutes(Long completeWindowMinutes)` A value in minutes during which a successfully started backup must complete, or else AWS Backup will cancel the job.
`StartBackupJobRequest`	`withIamRoleArn(String iamRoleArn)` Specifies the IAM role ARN used to create the target recovery point; for example, `arn:aws:iam::123456789012:role/S3Access`.
`StartBackupJobRequest`	`withIdempotencyToken(String idempotencyToken)` A customer chosen string that can be used to distinguish between calls to `StartBackupJob`.
`StartBackupJobRequest`	`withLifecycle(Lifecycle lifecycle)` The lifecycle defines when a protected resource is transitioned to cold storage and when it expires.
`StartBackupJobRequest`	`withRecoveryPointTags(Map<String,String> recoveryPointTags)` To help organize your resources, you can assign your own metadata to the resources that you create.
`StartBackupJobRequest`	`withResourceArn(String resourceArn)` An Amazon Resource Name (ARN) that uniquely identifies a resource.
`StartBackupJobRequest`	`withStartWindowMinutes(Long startWindowMinutes)` A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully.

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

- Constructor Detail
  - StartBackupJobRequest
```
public StartBackupJobRequest()
```
- Method Detail
  - setBackupVaultName
```
public void setBackupVaultName(String backupVaultName)
```
    The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
    
    Parameters:
    
    backupVaultName - The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
  - getBackupVaultName
```
public String getBackupVaultName()
```
    The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
    
    Returns:
    
    The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
  - withBackupVaultName
```
public StartBackupJobRequest withBackupVaultName(String backupVaultName)
```
    The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
    
    Parameters:
    
    backupVaultName - The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResourceArn
```
public void setResourceArn(String resourceArn)
```
    An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
    
    Parameters:
    
    resourceArn - An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
  - getResourceArn
```
public String getResourceArn()
```
    An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
    
    Returns:
    
    An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
  - withResourceArn
```
public StartBackupJobRequest withResourceArn(String resourceArn)
```
    An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
    
    Parameters:
    
    resourceArn - An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIamRoleArn
```
public void setIamRoleArn(String iamRoleArn)
```
    Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
    
    Parameters:
    
    iamRoleArn - Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
  - getIamRoleArn
```
public String getIamRoleArn()
```
    Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
    
    Returns:
    
    Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
  - withIamRoleArn
```
public StartBackupJobRequest withIamRoleArn(String iamRoleArn)
```
    Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
    
    Parameters:
    
    iamRoleArn - Specifies the IAM role ARN used 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 can be used to distinguish between calls to StartBackupJob.
    
    Parameters:
    
    idempotencyToken - A customer chosen string that can be used to distinguish between calls to StartBackupJob.
  - getIdempotencyToken
```
public String getIdempotencyToken()
```
    A customer chosen string that can be used to distinguish between calls to StartBackupJob.
    
    Returns:
    
    A customer chosen string that can be used to distinguish between calls to StartBackupJob.
  - withIdempotencyToken
```
public StartBackupJobRequest withIdempotencyToken(String idempotencyToken)
```
    A customer chosen string that can be used to distinguish between calls to StartBackupJob.
    
    Parameters:
    
    idempotencyToken - A customer chosen string that can be used to distinguish between calls to StartBackupJob.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartWindowMinutes
```
public void setStartWindowMinutes(Long startWindowMinutes)
```
    A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional, and the default is 8 hours.
    
    Parameters:
    
    startWindowMinutes - A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional, and the default is 8 hours.
  - getStartWindowMinutes
```
public Long getStartWindowMinutes()
```
    A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional, and the default is 8 hours.
    
    Returns:
    
    A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional, and the default is 8 hours.
  - withStartWindowMinutes
```
public StartBackupJobRequest withStartWindowMinutes(Long startWindowMinutes)
```
    A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional, and the default is 8 hours.
    
    Parameters:
    
    startWindowMinutes - A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully. This value is optional, and the default is 8 hours.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCompleteWindowMinutes
```
public void setCompleteWindowMinutes(Long completeWindowMinutes)
```
    A value in minutes during which a successfully started backup must complete, or else AWS Backup will cancel the job. This value is optional. This value begins counting down from when the backup was scheduled. It does not add additional time for StartWindowMinutes, or if the backup started later than scheduled.
    
    Parameters:
    
    completeWindowMinutes - A value in minutes during which a successfully started backup must complete, or else AWS Backup will cancel the job. This value is optional. This value begins counting down from when the backup was scheduled. It does not add additional time for StartWindowMinutes, or if the backup started later than scheduled.
  - getCompleteWindowMinutes
```
public Long getCompleteWindowMinutes()
```
    A value in minutes during which a successfully started backup must complete, or else AWS Backup will cancel the job. This value is optional. This value begins counting down from when the backup was scheduled. It does not add additional time for StartWindowMinutes, or if the backup started later than scheduled.
    
    Returns:
    
    A value in minutes during which a successfully started backup must complete, or else AWS Backup will cancel the job. This value is optional. This value begins counting down from when the backup was scheduled. It does not add additional time for StartWindowMinutes, or if the backup started later than scheduled.
  - withCompleteWindowMinutes
```
public StartBackupJobRequest withCompleteWindowMinutes(Long completeWindowMinutes)
```
    A value in minutes during which a successfully started backup must complete, or else AWS Backup will cancel the job. This value is optional. This value begins counting down from when the backup was scheduled. It does not add additional time for StartWindowMinutes, or if the backup started later than scheduled.
    
    Parameters:
    
    completeWindowMinutes - A value in minutes during which a successfully started backup must complete, or else AWS Backup will cancel the job. This value is optional. This value begins counting down from when the backup was scheduled. It does not add additional time for StartWindowMinutes, or if the backup started later than scheduled.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLifecycle
```
public void setLifecycle(Lifecycle lifecycle)
```
    The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup will transition and expire backups automatically according to the lifecycle that you define.
    
    Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
    
    Only Amazon EFS file system backups can be transitioned to cold storage.
    
    Parameters:
    
    lifecycle - The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup will transition and expire backups automatically according to the lifecycle that you define.
    
    Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
    
    Only Amazon EFS file system backups can be transitioned to cold storage.
  - getLifecycle
```
public Lifecycle getLifecycle()
```
    The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup will transition and expire backups automatically according to the lifecycle that you define.
    
    Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
    
    Only Amazon EFS file system backups can be transitioned to cold storage.
    
    Returns:
    
    The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup will transition and expire backups automatically according to the lifecycle that you define.
    
    Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
    
    Only Amazon EFS file system backups can be transitioned to cold storage.
  - withLifecycle
```
public StartBackupJobRequest withLifecycle(Lifecycle lifecycle)
```
    The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup will transition and expire backups automatically according to the lifecycle that you define.
    
    Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
    
    Only Amazon EFS file system backups can be transitioned to cold storage.
    
    Parameters:
    
    lifecycle - The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup will transition and expire backups automatically according to the lifecycle that you define.
    
    Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
    
    Only Amazon EFS file system backups can be transitioned to cold storage.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getRecoveryPointTags
```
public Map<String,String> getRecoveryPointTags()
```
    To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.
    
    Returns:
    
    To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.
  - setRecoveryPointTags
```
public void setRecoveryPointTags(Map<String,String> recoveryPointTags)
```
    To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.
    
    Parameters:
    
    recoveryPointTags - To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.
  - withRecoveryPointTags
```
public StartBackupJobRequest withRecoveryPointTags(Map<String,String> recoveryPointTags)
```
    To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.
    
    Parameters:
    
    recoveryPointTags - To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addRecoveryPointTagsEntry
```
public StartBackupJobRequest addRecoveryPointTagsEntry(String key,
                                                       String value)
```
    Add a single RecoveryPointTags entry
    
    See Also:
    
    withRecoveryPointTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearRecoveryPointTagsEntries
```
public StartBackupJobRequest clearRecoveryPointTagsEntries()
```
    Removes all the entries added into RecoveryPointTags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getBackupOptions
```
public Map<String,String> getBackupOptions()
```
    Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.
    
    Valid values: Set to "WindowsVSS”:“enabled" to enable WindowsVSS backup option and create a VSS Windows backup. Set to “WindowsVSS”:”disabled” to create a regular backup. The WindowsVSS option is not enabled by default.
    
    Returns:
    
    Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.
    
    Valid values: Set to "WindowsVSS”:“enabled" to enable WindowsVSS backup option and create a VSS Windows backup. Set to “WindowsVSS”:”disabled” to create a regular backup. The WindowsVSS option is not enabled by default.
  - setBackupOptions
```
public void setBackupOptions(Map<String,String> backupOptions)
```
    Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.
    
    Valid values: Set to "WindowsVSS”:“enabled" to enable WindowsVSS backup option and create a VSS Windows backup. Set to “WindowsVSS”:”disabled” to create a regular backup. The WindowsVSS option is not enabled by default.
    
    Parameters:
    
    backupOptions - Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.
    
    Valid values: Set to "WindowsVSS”:“enabled" to enable WindowsVSS backup option and create a VSS Windows backup. Set to “WindowsVSS”:”disabled” to create a regular backup. The WindowsVSS option is not enabled by default.
  - withBackupOptions
```
public StartBackupJobRequest withBackupOptions(Map<String,String> backupOptions)
```
    Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.
    
    Valid values: Set to "WindowsVSS”:“enabled" to enable WindowsVSS backup option and create a VSS Windows backup. Set to “WindowsVSS”:”disabled” to create a regular backup. The WindowsVSS option is not enabled by default.
    
    Parameters:
    
    backupOptions - Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.
    
    Valid values: Set to "WindowsVSS”:“enabled" to enable WindowsVSS backup option and create a VSS Windows backup. Set to “WindowsVSS”:”disabled” to create a regular backup. The WindowsVSS option is not enabled by default.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addBackupOptionsEntry
```
public StartBackupJobRequest addBackupOptionsEntry(String key,
                                                   String value)
```
    Add a single BackupOptions entry
    
    See Also:
    
    withBackupOptions(java.util.Map<java.lang.String, java.lang.String>)
  - clearBackupOptionsEntries
```
public StartBackupJobRequest clearBackupOptionsEntries()
```
    Removes all the entries added into BackupOptions.
    
    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 StartBackupJobRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Did this page help you?

Class StartBackupJobRequest

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

StartBackupJobRequest

Method Detail

setBackupVaultName

getBackupVaultName

withBackupVaultName

setResourceArn

getResourceArn

withResourceArn

setIamRoleArn

getIamRoleArn

withIamRoleArn

setIdempotencyToken

getIdempotencyToken

withIdempotencyToken

setStartWindowMinutes

getStartWindowMinutes

withStartWindowMinutes

setCompleteWindowMinutes

getCompleteWindowMinutes

withCompleteWindowMinutes

setLifecycle

getLifecycle

withLifecycle

getRecoveryPointTags

setRecoveryPointTags

withRecoveryPointTags

addRecoveryPointTagsEntry

clearRecoveryPointTagsEntries

getBackupOptions

setBackupOptions

withBackupOptions

addBackupOptionsEntry

clearBackupOptionsEntries

toString

equals

hashCode

clone