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

Class BrokerInstance

java.lang.Object

software.amazon.awssdk.services.mq.model.BrokerInstance

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<BrokerInstance.Builder,BrokerInstance>

@Generated("software.amazon.awssdk:codegen")
public final class BrokerInstance
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<BrokerInstance.Builder,BrokerInstance>

Returns information about all brokers.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BrokerInstance.Builder

Method Summary

Modifier and Type	Method	Description
static BrokerInstance.Builder	builder()
String	consoleURL()	The brokers web console URL.
List<String>	endpoints()	The broker's wire-level protocol endpoints.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEndpoints()	For responses, this returns true if the service returned a value for the Endpoints property.
int	hashCode()
String	ipAddress()	The IP address of the Elastic Network Interface (ENI) attached to the broker.
List<SdkField<?>>	sdkFields()
static Class<? extends BrokerInstance.Builder>	serializableBuilderClass()
BrokerInstance.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

consoleURL

public final String consoleURL()

The brokers web console URL.

Returns:

The brokers web console URL.

hasEndpoints

public final boolean hasEndpoints()

For responses, this returns true if the service returned a value for the Endpoints property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

endpoints

public final List<String> endpoints()

The broker's wire-level protocol endpoints.

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 hasEndpoints() method.

Returns:

The broker's wire-level protocol endpoints.

ipAddress

public final String ipAddress()

The IP address of the Elastic Network Interface (ENI) attached to the broker. Does not apply to RabbitMQ brokers.

Returns:

The IP address of the Elastic Network Interface (ENI) attached to the broker. Does not apply to RabbitMQ brokers.

toBuilder

public BrokerInstance.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BrokerInstance.Builder,BrokerInstance>

builder

public static BrokerInstance.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo