Backup (AWS Java SDK :: Services :: AWS OpsWorks for Chef Automate 2.20.125 API)

java.lang.Object
- software.amazon.awssdk.services.opsworkscm.model.Backup

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Backup.Builder,Backup>

@Generated(value="software.amazon.awssdk:codegen")
public final class Backup
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Backup.Builder,Backup>

Describes a single backup.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Backup.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Backup.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`backupArn()` The ARN of the backup.
`String`	`backupId()` The generated ID of the backup.
`BackupType`	`backupType()` The backup type.
`String`	`backupTypeAsString()` The backup type.
`static Backup.Builder`	`builder()`
`Instant`	`createdAt()` The time stamp when the backup was created in the database.
`String`	`description()` A user-provided description for a manual backup.
`String`	`engine()` The engine type that is obtained from the server when the backup is created.
`String`	`engineModel()` The engine model that is obtained from the server when the backup is created.
`String`	`engineVersion()` The engine version that is obtained from the server when the backup is created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasSecurityGroupIds()` For responses, this returns true if the service returned a value for the SecurityGroupIds property.
`boolean`	`hasSubnetIds()` For responses, this returns true if the service returned a value for the SubnetIds property.
`String`	`instanceProfileArn()` The EC2 instance profile ARN that is obtained from the server when the backup is created.
`String`	`instanceType()` The instance type that is obtained from the server when the backup is created.
`String`	`keyPair()` The key pair that is obtained from the server when the backup is created.
`String`	`preferredBackupWindow()` The preferred backup period that is obtained from the server when the backup is created.
`String`	`preferredMaintenanceWindow()` The preferred maintenance period that is obtained from the server when the backup is created.
`Integer`	`s3DataSize()` Deprecated.
`String`	`s3DataUrl()` Deprecated.
`String`	`s3LogUrl()` The Amazon S3 URL of the backup's log file.
`List<SdkField<?>>`	`sdkFields()`
`List<String>`	`securityGroupIds()` The security group IDs that are obtained from the server when the backup is created.
`static Class<? extends Backup.Builder>`	`serializableBuilderClass()`
`String`	`serverName()` The name of the server from which the backup was made.
`String`	`serviceRoleArn()` The service role ARN that is obtained from the server when the backup is created.
`BackupStatus`	`status()` The status of a backup while in progress.
`String`	`statusAsString()` The status of a backup while in progress.
`String`	`statusDescription()` An informational message about backup status.
`List<String>`	`subnetIds()` The subnet IDs that are obtained from the server when the backup is created.
`Backup.Builder`	`toBuilder()`
`String`	`toolsVersion()` The version of AWS OpsWorks CM-specific tools that is obtained from the server when the backup is created.
`String`	`toString()` Returns a string representation of this object.
`String`	`userArn()` The IAM user ARN of the requester for manual backups.

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
  - backupArn
```
public final String backupArn()
```
    The ARN of the backup.
    
    Returns:
    
    The ARN of the backup.
  - backupId
```
public final String backupId()
```
    The generated ID of the backup. Example: myServerName-yyyyMMddHHmmssSSS
    
    Returns:
    
    The generated ID of the backup. Example: myServerName-yyyyMMddHHmmssSSS
  - backupType
```
public final BackupType backupType()
```
    The backup type. Valid values are automated or manual.
    
    If the service returns an enum value that is not available in the current SDK version, backupType will return BackupType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from backupTypeAsString().
    
    Returns:
    
    The backup type. Valid values are automated or manual.
    
    See Also:
    
    BackupType
  - backupTypeAsString
```
public final String backupTypeAsString()
```
    The backup type. Valid values are automated or manual.
    
    If the service returns an enum value that is not available in the current SDK version, backupType will return BackupType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from backupTypeAsString().
    
    Returns:
    
    The backup type. Valid values are automated or manual.
    
    See Also:
    
    BackupType
  - createdAt
```
public final Instant createdAt()
```
    The time stamp when the backup was created in the database. Example: 2016-07-29T13:38:47.520Z
    
    Returns:
    
    The time stamp when the backup was created in the database. Example: 2016-07-29T13:38:47.520Z
  - description
```
public final String description()
```
    A user-provided description for a manual backup. This field is empty for automated backups.
    
    Returns:
    
    A user-provided description for a manual backup. This field is empty for automated backups.
  - engine
```
public final String engine()
```
    The engine type that is obtained from the server when the backup is created.
    
    Returns:
    
    The engine type that is obtained from the server when the backup is created.
  - engineModel
```
public final String engineModel()
```
    The engine model that is obtained from the server when the backup is created.
    
    Returns:
    
    The engine model that is obtained from the server when the backup is created.
  - engineVersion
```
public final String engineVersion()
```
    The engine version that is obtained from the server when the backup is created.
    
    Returns:
    
    The engine version that is obtained from the server when the backup is created.
  - instanceProfileArn
```
public final String instanceProfileArn()
```
    The EC2 instance profile ARN that is obtained from the server when the backup is created. Because this value is stored, you are not required to provide the InstanceProfileArn again if you restore a backup.
    
    Returns:
    
    The EC2 instance profile ARN that is obtained from the server when the backup is created. Because this value is stored, you are not required to provide the InstanceProfileArn again if you restore a backup.
  - instanceType
```
public final String instanceType()
```
    The instance type that is obtained from the server when the backup is created.
    
    Returns:
    
    The instance type that is obtained from the server when the backup is created.
  - keyPair
```
public final String keyPair()
```
    The key pair that is obtained from the server when the backup is created.
    
    Returns:
    
    The key pair that is obtained from the server when the backup is created.
  - preferredBackupWindow
```
public final String preferredBackupWindow()
```
    The preferred backup period that is obtained from the server when the backup is created.
    
    Returns:
    
    The preferred backup period that is obtained from the server when the backup is created.
  - preferredMaintenanceWindow
```
public final String preferredMaintenanceWindow()
```
    The preferred maintenance period that is obtained from the server when the backup is created.
    
    Returns:
    
    The preferred maintenance period that is obtained from the server when the backup is created.
  - s3DataSize
```
@Deprecated
public final Integer s3DataSize()
```
    Deprecated.
    
    This field is deprecated and is no longer used.
    
    Returns:
    
    This field is deprecated and is no longer used.
  - s3DataUrl
```
@Deprecated
public final String s3DataUrl()
```
    Deprecated.
    
    This field is deprecated and is no longer used.
    
    Returns:
    
    This field is deprecated and is no longer used.
  - s3LogUrl
```
public final String s3LogUrl()
```
    The Amazon S3 URL of the backup's log file.
    
    Returns:
    
    The Amazon S3 URL of the backup's log file.
  - hasSecurityGroupIds
```
public final boolean hasSecurityGroupIds()
```
    For responses, this returns true if the service returned a value for the SecurityGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - securityGroupIds
```
public final List<String> securityGroupIds()
```
    The security group IDs that are obtained from the server when the backup is created.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSecurityGroupIds() method.
    
    Returns:
    
    The security group IDs that are obtained from the server when the backup is created.
  - serverName
```
public final String serverName()
```
    The name of the server from which the backup was made.
    
    Returns:
    
    The name of the server from which the backup was made.
  - serviceRoleArn
```
public final String serviceRoleArn()
```
    The service role ARN that is obtained from the server when the backup is created.
    
    Returns:
    
    The service role ARN that is obtained from the server when the backup is created.
  - status
```
public final BackupStatus status()
```
    The status of a backup while in progress.
    
    If the service returns an enum value that is not available in the current SDK version, status will return BackupStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of a backup while in progress.
    
    See Also:
    
    BackupStatus
  - statusAsString
```
public final String statusAsString()
```
    The status of a backup while in progress.
    
    If the service returns an enum value that is not available in the current SDK version, status will return BackupStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of a backup while in progress.
    
    See Also:
    
    BackupStatus
  - statusDescription
```
public final String statusDescription()
```
    An informational message about backup status.
    
    Returns:
    
    An informational message about backup status.
  - hasSubnetIds
```
public final boolean hasSubnetIds()
```
    For responses, this returns true if the service returned a value for the SubnetIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - subnetIds
```
public final List<String> subnetIds()
```
    The subnet IDs that are obtained from the server when the backup is created.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSubnetIds() method.
    
    Returns:
    
    The subnet IDs that are obtained from the server when the backup is created.
  - toolsVersion
```
public final String toolsVersion()
```
    The version of AWS OpsWorks CM-specific tools that is obtained from the server when the backup is created.
    
    Returns:
    
    The version of AWS OpsWorks CM-specific tools that is obtained from the server when the backup is created.
  - userArn
```
public final String userArn()
```
    The IAM user ARN of the requester for manual backups. This field is empty for automated backups.
    
    Returns:
    
    The IAM user ARN of the requester for manual backups. This field is empty for automated backups.
  - toBuilder
```
public Backup.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Backup.Builder,Backup>
  - builder
```
public static Backup.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Backup.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Backup

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

backupArn

backupId

backupType

backupTypeAsString

createdAt

description

engine

engineModel

engineVersion

instanceProfileArn

instanceType

keyPair

preferredBackupWindow

preferredMaintenanceWindow

s3DataSize

s3DataUrl

s3LogUrl

hasSecurityGroupIds

securityGroupIds

serverName

serviceRoleArn

status

statusAsString

statusDescription

hasSubnetIds

subnetIds

toolsVersion

userArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields