Package software.amazon.awssdk.services.mq.model

Class PromoteRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.mq.model.MqRequest

software.amazon.awssdk.services.mq.model.PromoteRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PromoteRequest.Builder,PromoteRequest>

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

Promotes a data replication replica broker to the primary broker role.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PromoteRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	brokerId()	The unique ID that Amazon MQ generates for the broker.
static PromoteRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
PromoteMode	mode()	The Promote mode requested.
String	modeAsString()	The Promote mode requested.
List<SdkField<?>>	sdkFields()
static Class<? extends PromoteRequest.Builder>	serializableBuilderClass()
PromoteRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

brokerId

public final String brokerId()

The unique ID that Amazon MQ generates for the broker.

Returns:

The unique ID that Amazon MQ generates for the broker.

mode

public final PromoteMode mode()

The Promote mode requested. Note: Valid values for the parameter are SWITCHOVER, FAILOVER.

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

Returns:

The Promote mode requested. Note: Valid values for the parameter are SWITCHOVER, FAILOVER.

See Also:

PromoteMode

modeAsString

public final String modeAsString()

The Promote mode requested. Note: Valid values for the parameter are SWITCHOVER, FAILOVER.

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

Returns:

The Promote mode requested. Note: Valid values for the parameter are SWITCHOVER, FAILOVER.

See Also:

PromoteMode

toBuilder

public PromoteRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PromoteRequest.Builder,PromoteRequest>

Specified by:

toBuilder in class MqRequest

builder

public static PromoteRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo