Class ReplicationJob
- java.lang.Object
-
- software.amazon.awssdk.services.sms.model.ReplicationJob
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<ReplicationJob.Builder,ReplicationJob>
@Generated("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 Description static interfaceReplicationJob.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ReplicationJob.Builderbuilder()Stringdescription()The description of the replication job.Booleanencrypted()Indicates whether the replication job should produce encrypted AMIs.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)Integerfrequency()The time between consecutive replication runs, in hours.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasReplicationRunList()For responses, this returns true if the service returned a value for the ReplicationRunList property.StringkmsKeyId()The ID of the KMS key for replication jobs that produce encrypted AMIs.StringlatestAmiId()The ID of the latest Amazon Machine Image (AMI).LicenseTypelicenseType()The license type to be used for the AMI created by a successful replication run.StringlicenseTypeAsString()The license type to be used for the AMI created by a successful replication run.InstantnextReplicationRunStartTime()The start time of the next replication run.IntegernumberOfRecentAmisToKeep()The number of recent AMIs to keep in the customer's account for a replication job.StringreplicationJobId()The ID of the replication job.List<ReplicationRun>replicationRunList()Information about the replication runs.StringroleName()The name of the IAM role to be used by Server Migration Service.BooleanrunOnce()Indicates whether to run the replication job one time.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()InstantseedReplicationTime()The seed replication time.static Class<? extends ReplicationJob.Builder>serializableBuilderClass()StringserverId()The ID of the server.ServerTypeserverType()The type of server.StringserverTypeAsString()The type of server.ReplicationJobStatestate()The state of the replication job.StringstateAsString()The state of the replication job.StringstatusMessage()The description of the current status of the replication job.ReplicationJob.BuildertoBuilder()StringtoString()Returns a string representation of this object.VmServervmServer()Information about the VM server.-
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
-
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,
serverTypewill returnServerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromserverTypeAsString().- 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,
serverTypewill returnServerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromserverTypeAsString().- 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,
licenseTypewill returnLicenseType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlicenseTypeAsString().- 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,
licenseTypewill returnLicenseType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromlicenseTypeAsString().- 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 Server Migration Service.
- Returns:
- The name of the IAM role to be used by Server Migration Service.
-
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,
statewill returnReplicationJobState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- 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,
statewill returnReplicationJobState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- 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()
For responses, this returns true if the service returned a value for the ReplicationRunList property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
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.
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
hasReplicationRunList()method.- Returns:
- Information about the replication runs.
-
toBuilder
public ReplicationJob.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ReplicationJob.Builder,ReplicationJob>
-
builder
public static ReplicationJob.Builder builder()
-
serializableBuilderClass
public static Class<? extends ReplicationJob.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-