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()` Indicates whether the replication job should produce encrypted AMIs.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)` Indicates whether some other object is "equal to" this one by SDK fields.
`Integer`	`frequency()` The time between consecutive replication runs, in hours.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasReplicationRunList()` Returns true if the ReplicationRunList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`kmsKeyId()` The ID of the KMS key 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()` The number of recent AMIs to keep in the customer's account for a replication job.
`String`	`replicationJobId()` The ID of the replication job.
`List<ReplicationRun>`	`replicationRunList()` Information about the replication runs.
`String`	`roleName()` The name of the IAM role to be used by AWS SMS.
`Boolean`	`runOnce()` Indicates whether to run the replication job one time.
`List<SdkField<?>>`	`sdkFields()`
`Instant`	`seedReplicationTime()` The seed replication time.
`static Class<? extends ReplicationJob.Builder>`	`serializableBuilderClass()`
`String`	`serverId()` The ID 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()` Returns a string representation of this object.
`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 final String replicationJobId()
```
    The ID of the replication job.
    
    Returns:
    
    The ID of the replication job.
  - serverId
```
public final String serverId()
```
    The ID of the server.
    
    Returns:
    
    The ID of the server.
  - serverType
```
public final 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 final 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 final VmServer vmServer()
```
    Information about the VM server.
    
    Returns:
    
    Information about the VM server.
  - seedReplicationTime
```
public final Instant seedReplicationTime()
```
    The seed replication time.
    
    Returns:
    
    The seed replication time.
  - frequency
```
public final Integer frequency()
```
    The time between consecutive replication runs, in hours.
    
    Returns:
    
    The time between consecutive replication runs, in hours.
  - runOnce
```
public final Boolean runOnce()
```
    Indicates whether to run the replication job one time.
    
    Returns:
    
    Indicates whether to run the replication job one time.
  - nextReplicationRunStartTime
```
public final Instant nextReplicationRunStartTime()
```
    The start time of the next replication run.
    
    Returns:
    
    The start time of the next replication run.
  - licenseType
```
public final 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 final 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 final String roleName()
```
    The name of the IAM role to be used by AWS SMS.
    
    Returns:
    
    The name of the IAM role to be used by AWS SMS.
  - latestAmiId
```
public final String latestAmiId()
```
    The ID of the latest Amazon Machine Image (AMI).
    
    Returns:
    
    The ID of the latest Amazon Machine Image (AMI).
  - state
```
public final 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 final 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 final 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 final String description()
```
    The description of the replication job.
    
    Returns:
    
    The description of the replication job.
  - numberOfRecentAmisToKeep
```
public final Integer numberOfRecentAmisToKeep()
```
    The 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:
    
    The 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 final Boolean encrypted()
```
    Indicates whether the replication job should produce encrypted AMIs.
    
    Returns:
    
    Indicates whether the replication job should produce encrypted AMIs.
  - kmsKeyId
```
public final String kmsKeyId()
```
    The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:
    - KMS key ID
    - KMS key alias
    - ARN referring to the KMS key ID
    - ARN referring to the KMS key alias
    If encrypted is enabled but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.
    Returns:
    The ID of the KMS key for replication jobs that produce encrypted AMIs. This value can be any of the following:
    
    KMS key ID
    
    KMS key alias
    
    ARN referring to the KMS key ID
    
    ARN referring to the KMS key alias
    
    If encrypted is enabled but a KMS key ID is not specified, the customer's default KMS key for Amazon EBS is used.
  - hasReplicationRunList
```
public final boolean hasReplicationRunList()
```
    Returns true if the ReplicationRunList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - replicationRunList
```
public final List<ReplicationRun> replicationRunList()
```
    Information about the replication runs.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasReplicationRunList() to see if a value was sent in this field.
    
    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 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)
```
    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 an SdkPojo class, and is generated based on a service model.
    If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - 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
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

AWS SDK for Java API Reference - 2.16.42

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

hasReplicationRunList

replicationRunList

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields