Class BlueGreenDeployment
- java.lang.Object
-
- software.amazon.awssdk.services.rds.model.BlueGreenDeployment
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<BlueGreenDeployment.Builder,BlueGreenDeployment>
@Generated("software.amazon.awssdk:codegen") public final class BlueGreenDeployment extends Object implements SdkPojo, Serializable, ToCopyableBuilder<BlueGreenDeployment.Builder,BlueGreenDeployment>
Details about a blue/green deployment.
For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
BlueGreenDeployment.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
blueGreenDeploymentIdentifier()
The unique identifier of the blue/green deployment.String
blueGreenDeploymentName()
The user-supplied name of the blue/green deployment.static BlueGreenDeployment.Builder
builder()
Instant
createTime()
The time when the blue/green deployment was created, in Universal Coordinated Time (UTC).Instant
deleteTime()
The time when the blue/green deployment was deleted, in Universal Coordinated Time (UTC).boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasSwitchoverDetails()
For responses, this returns true if the service returned a value for the SwitchoverDetails property.boolean
hasTagList()
For responses, this returns true if the service returned a value for the TagList property.boolean
hasTasks()
For responses, this returns true if the service returned a value for the Tasks property.Map<String,SdkField<?>>
sdkFieldNameToField()
List<SdkField<?>>
sdkFields()
static Class<? extends BlueGreenDeployment.Builder>
serializableBuilderClass()
String
source()
The source database for the blue/green deployment.String
status()
The status of the blue/green deployment.String
statusDetails()
Additional information about the status of the blue/green deployment.List<SwitchoverDetail>
switchoverDetails()
The details about each source and target resource in the blue/green deployment.List<Tag>
tagList()
Returns the value of the TagList property for this object.String
target()
The target database for the blue/green deployment.List<BlueGreenDeploymentTask>
tasks()
Either tasks to be performed or tasks that have been completed on the target database before switchover.BlueGreenDeployment.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
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
-
blueGreenDeploymentIdentifier
public final String blueGreenDeploymentIdentifier()
The unique identifier of the blue/green deployment.
- Returns:
- The unique identifier of the blue/green deployment.
-
blueGreenDeploymentName
public final String blueGreenDeploymentName()
The user-supplied name of the blue/green deployment.
- Returns:
- The user-supplied name of the blue/green deployment.
-
source
public final String source()
The source database for the blue/green deployment.
Before switchover, the source database is the production database in the blue environment.
- Returns:
- The source database for the blue/green deployment.
Before switchover, the source database is the production database in the blue environment.
-
target
public final String target()
The target database for the blue/green deployment.
Before switchover, the target database is the clone database in the green environment.
- Returns:
- The target database for the blue/green deployment.
Before switchover, the target database is the clone database in the green environment.
-
hasSwitchoverDetails
public final boolean hasSwitchoverDetails()
For responses, this returns true if the service returned a value for the SwitchoverDetails 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.
-
switchoverDetails
public final List<SwitchoverDetail> switchoverDetails()
The details about each source and target resource in the blue/green deployment.
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
hasSwitchoverDetails()
method.- Returns:
- The details about each source and target resource in the blue/green deployment.
-
hasTasks
public final boolean hasTasks()
For responses, this returns true if the service returned a value for the Tasks 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.
-
tasks
public final List<BlueGreenDeploymentTask> tasks()
Either tasks to be performed or tasks that have been completed on the target database before switchover.
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
hasTasks()
method.- Returns:
- Either tasks to be performed or tasks that have been completed on the target database before switchover.
-
status
public final String status()
The status of the blue/green deployment.
Valid Values:
-
PROVISIONING
- Resources are being created in the green environment. -
AVAILABLE
- Resources are available in the green environment. -
SWITCHOVER_IN_PROGRESS
- The deployment is being switched from the blue environment to the green environment. -
SWITCHOVER_COMPLETED
- Switchover from the blue environment to the green environment is complete. -
INVALID_CONFIGURATION
- Resources in the green environment are invalid, so switchover isn't possible. -
SWITCHOVER_FAILED
- Switchover was attempted but failed. -
DELETING
- The blue/green deployment is being deleted.
- Returns:
- The status of the blue/green deployment.
Valid Values:
-
PROVISIONING
- Resources are being created in the green environment. -
AVAILABLE
- Resources are available in the green environment. -
SWITCHOVER_IN_PROGRESS
- The deployment is being switched from the blue environment to the green environment. -
SWITCHOVER_COMPLETED
- Switchover from the blue environment to the green environment is complete. -
INVALID_CONFIGURATION
- Resources in the green environment are invalid, so switchover isn't possible. -
SWITCHOVER_FAILED
- Switchover was attempted but failed. -
DELETING
- The blue/green deployment is being deleted.
-
-
-
statusDetails
public final String statusDetails()
Additional information about the status of the blue/green deployment.
- Returns:
- Additional information about the status of the blue/green deployment.
-
createTime
public final Instant createTime()
The time when the blue/green deployment was created, in Universal Coordinated Time (UTC).
- Returns:
- The time when the blue/green deployment was created, in Universal Coordinated Time (UTC).
-
deleteTime
public final Instant deleteTime()
The time when the blue/green deployment was deleted, in Universal Coordinated Time (UTC).
- Returns:
- The time when the blue/green deployment was deleted, in Universal Coordinated Time (UTC).
-
hasTagList
public final boolean hasTagList()
For responses, this returns true if the service returned a value for the TagList 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.
-
tagList
public final List<Tag> tagList()
Returns the value of the TagList property for this object.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
hasTagList()
method.- Returns:
- The value of the TagList property for this object.
-
toBuilder
public BlueGreenDeployment.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<BlueGreenDeployment.Builder,BlueGreenDeployment>
-
builder
public static BlueGreenDeployment.Builder builder()
-
serializableBuilderClass
public static Class<? extends BlueGreenDeployment.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in 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:
sdkFieldNameToField
in interfaceSdkPojo
-
-