ReplicationJob (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.sms.model.ReplicationJob

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

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

Represents a replication job.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ReplicationJob.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ReplicationJob.Builder`	`builder()`
`String`	`description()` The description of the replication job.
`Boolean`	`encrypted()` Whether the replication job should produce encrypted AMIs or not.
`boolean`	`equals(Object obj)`
`Integer`	`frequency()` The time between consecutive replication runs, in hours.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`kmsKeyId()` KMS key ID for replication jobs that produce encrypted AMIs.
`String`	`latestAmiId()` The ID of the latest Amazon Machine Image (AMI).
`LicenseType`	`licenseType()` The license type to be used for the AMI created by a successful replication run.
`String`	`licenseTypeAsString()` The license type to be used for the AMI created by a successful replication run.
`Instant`	`nextReplicationRunStartTime()` The start time of the next replication run.
`Integer`	`numberOfRecentAmisToKeep()` Number of recent AMIs to keep in the customer's account for a replication job.
`String`	`replicationJobId()` The identifier of the replication job.
`List<ReplicationRun>`	`replicationRunList()` Information about the replication runs.
`String`	`roleName()` The name of the IAM role to be used by the Server Migration Service.
`Boolean`	`runOnce()`
`List<SdkField<?>>`	`sdkFields()`
`Instant`	`seedReplicationTime()` The seed replication time.
`static Class<? extends ReplicationJob.Builder>`	`serializableBuilderClass()`
`String`	`serverId()` The identifier of the server.
`ServerType`	`serverType()` The type of server.
`String`	`serverTypeAsString()` The type of server.
`ReplicationJobState`	`state()` The state of the replication job.
`String`	`stateAsString()` The state of the replication job.
`String`	`statusMessage()` The description of the current status of the replication job.
`ReplicationJob.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`VmServer`	`vmServer()` Information about the VM server.

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

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

- Method Detail
  - replicationJobId
```
public String replicationJobId()
```
    The identifier of the replication job.
    
    Returns:
    
    The identifier of the replication job.
  - serverId
```
public String serverId()
```
    The identifier of the server.
    
    Returns:
    
    The identifier of the server.
  - serverType
```
public ServerType serverType()
```
    The type of server.
    
    If the service returns an enum value that is not available in the current SDK version, serverType will return ServerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from serverTypeAsString().
    
    Returns:
    
    The type of server.
    
    See Also:
    
    ServerType
  - serverTypeAsString
```
public String serverTypeAsString()
```
    The type of server.
    
    If the service returns an enum value that is not available in the current SDK version, serverType will return ServerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from serverTypeAsString().
    
    Returns:
    
    The type of server.
    
    See Also:
    
    ServerType
  - vmServer
```
public VmServer vmServer()
```
    Information about the VM server.
    
    Returns:
    
    Information about the VM server.
  - seedReplicationTime
```
public Instant seedReplicationTime()
```
    The seed replication time.
    
    Returns:
    
    The seed replication time.
  - frequency
```
public Integer frequency()
```
    The time between consecutive replication runs, in hours.
    
    Returns:
    
    The time between consecutive replication runs, in hours.
  - runOnce
```
public Boolean runOnce()
```
    Returns:
  - nextReplicationRunStartTime
```
public Instant nextReplicationRunStartTime()
```
    The start time of the next replication run.
    
    Returns:
    
    The start time of the next replication run.
  - licenseType
```
public LicenseType licenseType()
```
    The license type to be used for the AMI created by a successful replication run.
    
    If the service returns an enum value that is not available in the current SDK version, licenseType will return LicenseType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from licenseTypeAsString().
    
    Returns:
    
    The license type to be used for the AMI created by a successful replication run.
    
    See Also:
    
    LicenseType
  - licenseTypeAsString
```
public String licenseTypeAsString()
```
    The license type to be used for the AMI created by a successful replication run.
    
    If the service returns an enum value that is not available in the current SDK version, licenseType will return LicenseType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from licenseTypeAsString().
    
    Returns:
    
    The license type to be used for the AMI created by a successful replication run.
    
    See Also:
    
    LicenseType
  - roleName
```
public String roleName()
```
    The name of the IAM role to be used by the Server Migration Service.
    
    Returns:
    
    The name of the IAM role to be used by the Server Migration Service.
  - latestAmiId
```
public String latestAmiId()
```
    The ID of the latest Amazon Machine Image (AMI).
    
    Returns:
    
    The ID of the latest Amazon Machine Image (AMI).
  - state
```
public ReplicationJobState state()
```
    The state of the replication job.
    
    If the service returns an enum value that is not available in the current SDK version, state will return ReplicationJobState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The state of the replication job.
    
    See Also:
    
    ReplicationJobState
  - stateAsString
```
public String stateAsString()
```
    The state of the replication job.
    
    If the service returns an enum value that is not available in the current SDK version, state will return ReplicationJobState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The state of the replication job.
    
    See Also:
    
    ReplicationJobState
  - statusMessage
```
public String statusMessage()
```
    The description of the current status of the replication job.
    
    Returns:
    
    The description of the current status of the replication job.
  - description
```
public String description()
```
    The description of the replication job.
    
    Returns:
    
    The description of the replication job.
  - numberOfRecentAmisToKeep
```
public Integer numberOfRecentAmisToKeep()
```
    Number of recent AMIs to keep in the customer's account for a replication job. By default the value is set to zero, meaning that all AMIs are kept.
    
    Returns:
    
    Number of recent AMIs to keep in the customer's account for a replication job. By default the value is set to zero, meaning that all AMIs are kept.
  - encrypted
```
public Boolean encrypted()
```
    Whether the replication job should produce encrypted AMIs or not. See also KmsKeyId below.
    
    Returns:
    
    Whether the replication job should produce encrypted AMIs or not. See also KmsKeyId below.
  - kmsKeyId
```
public String kmsKeyId()
```
    KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following:
    - KMS key ID
    - KMS key alias
    - ARN referring to KMS key ID
    - ARN referring to KMS key alias
    If encrypted is true but a KMS key id is not specified, the customer's default KMS key for EBS is used.
    Returns:
    KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following:
    
    KMS key ID
    
    KMS key alias
    
    ARN referring to KMS key ID
    
    ARN referring to KMS key alias
    
    If encrypted is true but a KMS key id is not specified, the customer's default KMS key for EBS is used.
  - replicationRunList
```
public List<ReplicationRun> replicationRunList()
```
    Information about the replication runs.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Information about the replication runs.
  - toBuilder
```
public ReplicationJob.Builder 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 interface ToCopyableBuilder<ReplicationJob.Builder,ReplicationJob>
    
    Returns:
    
    a builder for type T
  - builder
```
public static ReplicationJob.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ReplicationJob.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class ReplicationJob

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

replicationJobId

serverId

serverType

serverTypeAsString

vmServer

seedReplicationTime

frequency

runOnce

nextReplicationRunStartTime

licenseType

licenseTypeAsString

roleName

latestAmiId

state

stateAsString

statusMessage

description

numberOfRecentAmisToKeep

encrypted

kmsKeyId

replicationRunList

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields