Package software.amazon.awssdk.services.arczonalshift.model

Class CancelZonalShiftResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.arczonalshift.model.ArcZonalShiftResponse

software.amazon.awssdk.services.arczonalshift.model.CancelZonalShiftResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CancelZonalShiftResponse.Builder,CancelZonalShiftResponse>

@Generated("software.amazon.awssdk:codegen")
public final class CancelZonalShiftResponse
extends ArcZonalShiftResponse
implements ToCopyableBuilder<CancelZonalShiftResponse.Builder,CancelZonalShiftResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CancelZonalShiftResponse.Builder

Method Summary

Modifier and Type	Method	Description
String	awayFrom()	The Availability Zone (for example, use1-az1) that traffic is moved away from for a resource when you start a zonal shift.
static CancelZonalShiftResponse.Builder	builder()
String	comment()	A comment that you enter about the zonal shift.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Instant	expiryTime()	The expiry time (expiration time) for a customer-initiated zonal shift.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	resourceIdentifier()	The identifier for the resource that Amazon Web Services shifts traffic for.
List<SdkField<?>>	sdkFields()
static Class<? extends CancelZonalShiftResponse.Builder>	serializableBuilderClass()
Instant	startTime()	The time (UTC) when the zonal shift starts.
ZonalShiftStatus	status()	A status for a zonal shift.
String	statusAsString()	A status for a zonal shift.
CancelZonalShiftResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	zonalShiftId()	The identifier of a zonal shift.

Methods inherited from class software.amazon.awssdk.services.arczonalshift.model.ArcZonalShiftResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

awayFrom

public final String awayFrom()

The Availability Zone (for example, use1-az1) that traffic is moved away from for a resource when you start a zonal shift. Until the zonal shift expires or you cancel it, traffic for the resource is instead moved to other Availability Zones in the Amazon Web Services Region.

Returns:

The Availability Zone (for example, use1-az1) that traffic is moved away from for a resource when you start a zonal shift. Until the zonal shift expires or you cancel it, traffic for the resource is instead moved to other Availability Zones in the Amazon Web Services Region.

comment

public final String comment()

A comment that you enter about the zonal shift. Only the latest comment is retained; no comment history is maintained. A new comment overwrites any existing comment string.

Returns:

A comment that you enter about the zonal shift. Only the latest comment is retained; no comment history is maintained. A new comment overwrites any existing comment string.

expiryTime

public final Instant expiryTime()

The expiry time (expiration time) for a customer-initiated zonal shift. A zonal shift is temporary and must be set to expire when you start the zonal shift. You can initially set a zonal shift to expire in a maximum of three days (72 hours). However, you can update a zonal shift to set a new expiration at any time.

When you start a zonal shift, you specify how long you want it to be active, which Route 53 ARC converts to an expiry time (expiration time). You can cancel a zonal shift when you're ready to restore traffic to the Availability Zone, or just wait for it to expire. Or you can update the zonal shift to specify another length of time to expire in.

Returns:

The expiry time (expiration time) for a customer-initiated zonal shift. A zonal shift is temporary and must be set to expire when you start the zonal shift. You can initially set a zonal shift to expire in a maximum of three days (72 hours). However, you can update a zonal shift to set a new expiration at any time.

When you start a zonal shift, you specify how long you want it to be active, which Route 53 ARC converts to an expiry time (expiration time). You can cancel a zonal shift when you're ready to restore traffic to the Availability Zone, or just wait for it to expire. Or you can update the zonal shift to specify another length of time to expire in.

resourceIdentifier

public final String resourceIdentifier()

The identifier for the resource that Amazon Web Services shifts traffic for. The identifier is the Amazon Resource Name (ARN) for the resource.

At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.

Returns:

The identifier for the resource that Amazon Web Services shifts traffic for. The identifier is the Amazon Resource Name (ARN) for the resource.

At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.

startTime

public final Instant startTime()

The time (UTC) when the zonal shift starts.

Returns:

The time (UTC) when the zonal shift starts.

status

public final ZonalShiftStatus status()

A status for a zonal shift.

The Status for a zonal shift can have one of the following values:

• ACTIVE: The zonal shift has been started and active.

• EXPIRED: The zonal shift has expired (the expiry time was exceeded).

• CANCELED: The zonal shift was canceled.

If the service returns an enum value that is not available in the current SDK version, status will return ZonalShiftStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

A status for a zonal shift.

The Status for a zonal shift can have one of the following values:

• ACTIVE: The zonal shift has been started and active.

• EXPIRED: The zonal shift has expired (the expiry time was exceeded).

• CANCELED: The zonal shift was canceled.

See Also:

ZonalShiftStatus

statusAsString

public final String statusAsString()

A status for a zonal shift.

The Status for a zonal shift can have one of the following values:

• ACTIVE: The zonal shift has been started and active.

• EXPIRED: The zonal shift has expired (the expiry time was exceeded).

• CANCELED: The zonal shift was canceled.

If the service returns an enum value that is not available in the current SDK version, status will return ZonalShiftStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

A status for a zonal shift.

The Status for a zonal shift can have one of the following values:

• ACTIVE: The zonal shift has been started and active.

• EXPIRED: The zonal shift has expired (the expiry time was exceeded).

• CANCELED: The zonal shift was canceled.

See Also:

ZonalShiftStatus

zonalShiftId

public final String zonalShiftId()

The identifier of a zonal shift.

Returns:

The identifier of a zonal shift.

toBuilder

public CancelZonalShiftResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CancelZonalShiftResponse.Builder,CancelZonalShiftResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static CancelZonalShiftResponse.Builder builder()

serializableBuilderClass

public static Class<? extends CancelZonalShiftResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo