Class FailoverShareOptions

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.cloud.is.vpc.v1.model.FailoverShareOptions

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class FailoverShareOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel

The failoverShare options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FailoverShareOptions.Builder	Builder.
static interface	FailoverShareOptions.FallbackPolicy	The action to take if the failover request is accepted but cannot be performed or times out: - `fail`: Fail the operation, resulting in the replication relationship being unchanged.

Method Summary

Modifier and Type	Method	Description
String	fallbackPolicy()	Gets the fallbackPolicy.
FailoverShareOptions.Builder	newBuilder()	New builder.
String	shareId()	Gets the shareId.
Long	timeout()	Gets the timeout.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

newBuilder

public FailoverShareOptions.Builder newBuilder()

New builder.

Returns:

a FailoverShareOptions builder

shareId

public String shareId()

Gets the shareId. The file share identifier.

Returns:

the shareId

fallbackPolicy

public String fallbackPolicy()

Gets the fallbackPolicy. The action to take if the failover request is accepted but cannot be performed or times out: - `fail`: Fail the operation, resulting in the replication relationship being unchanged. - `split`: Split the replica from its source, resulting in two individual read-write file shares. Because the final sync was not completed, the replica may be out-of-date. This occurs in disaster recovery scenarios where the source is known to be unreachable.

Returns:

the fallbackPolicy

timeout

public Long timeout()

Gets the timeout. The failover timeout in seconds. If the timeout is reached, the `fallback_policy` will be triggered.

Returns:

the timeout