@Generated(value="software.amazon.awssdk:codegen") public final class ReplicationJob extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ReplicationJob.Builder,ReplicationJob>
Represents a replication job.
Modifier and Type | Class and Description |
---|---|
static interface |
ReplicationJob.Builder |
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.
|
copy
public final String replicationJobId()
The ID of the replication job.
public final String serverId()
The ID of the server.
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()
.
ServerType
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()
.
ServerType
public final VmServer vmServer()
Information about the VM server.
public final Instant seedReplicationTime()
The seed replication time.
public final Integer frequency()
The time between consecutive replication runs, in hours.
public final Boolean runOnce()
Indicates whether to run the replication job one time.
public final Instant nextReplicationRunStartTime()
The start time of the next replication run.
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()
.
LicenseType
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()
.
LicenseType
public final String roleName()
The name of the IAM role to be used by AWS SMS.
public final String latestAmiId()
The ID of the latest Amazon Machine Image (AMI).
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()
.
ReplicationJobState
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()
.
ReplicationJobState
public final String statusMessage()
The description of the current status of the replication job.
public final String description()
The description of the replication job.
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.
public final Boolean encrypted()
Indicates whether the replication job should produce encrypted AMIs.
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.
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.
public final boolean hasReplicationRunList()
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.
public ReplicationJob.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ReplicationJob.Builder,ReplicationJob>
public static ReplicationJob.Builder builder()
public static Class<? extends ReplicationJob.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()