UpdateBrokerRequest (AWS SDK for Java

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.UpdateBrokerRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<UpdateBrokerRequest.Builder,UpdateBrokerRequest>

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

Updates the broker using the specified properties.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface UpdateBrokerRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`UpdateBrokerRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AuthenticationStrategy`	`authenticationStrategy()` Optional.
`String`	`authenticationStrategyAsString()` Optional.
`Boolean`	`autoMinorVersionUpgrade()` Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ.
`String`	`brokerId()` The unique ID that Amazon MQ generates for the broker.
`static UpdateBrokerRequest.Builder`	`builder()`
`ConfigurationId`	`configuration()` A list of information about the configuration.
`String`	`engineVersion()` The broker engine version.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)` Indicates whether some other object is "equal to" this one by SDK fields.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`boolean`	`hasSecurityGroups()` For responses, this returns true if the service returned a value for the SecurityGroups property.
`String`	`hostInstanceType()` The broker's host instance type to upgrade to.
`LdapServerMetadataInput`	`ldapServerMetadata()` Optional.
`Logs`	`logs()` Enables Amazon CloudWatch logging for brokers.
`WeeklyStartTime`	`maintenanceWindowStartTime()` The parameters that determine the WeeklyStartTime.
`List<SdkField<?>>`	`sdkFields()`
`List<String>`	`securityGroups()` The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
`static Class<? extends UpdateBrokerRequest.Builder>`	`serializableBuilderClass()`
`UpdateBrokerRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`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
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - authenticationStrategy
```
public final AuthenticationStrategy authenticationStrategy()
```
    Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
    
    If the service returns an enum value that is not available in the current SDK version, authenticationStrategy will return AuthenticationStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationStrategyAsString().
    
    Returns:
    
    Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
    
    See Also:
    
    AuthenticationStrategy
  - authenticationStrategyAsString
```
public final String authenticationStrategyAsString()
```
    Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
    
    If the service returns an enum value that is not available in the current SDK version, authenticationStrategy will return AuthenticationStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationStrategyAsString().
    
    Returns:
    
    Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
    
    See Also:
    
    AuthenticationStrategy
  - autoMinorVersionUpgrade
```
public final Boolean autoMinorVersionUpgrade()
```
    Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.
    
    Returns:
    
    Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.
  - 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.
  - configuration
```
public final ConfigurationId configuration()
```
    A list of information about the configuration.
    
    Returns:
    
    A list of information about the configuration.
  - engineVersion
```
public final String engineVersion()
```
    The broker engine version. For a list of supported engine versions, see Supported engines.
    
    Returns:
    
    The broker engine version. For a list of supported engine versions, see Supported engines.
  - hostInstanceType
```
public final String hostInstanceType()
```
    The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.
    
    Returns:
    
    The broker's host instance type to upgrade to. For a list of supported instance types, see Broker instance types.
  - ldapServerMetadata
```
public final LdapServerMetadataInput ldapServerMetadata()
```
    Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
    
    Returns:
    
    Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
  - logs
```
public final Logs logs()
```
    Enables Amazon CloudWatch logging for brokers.
    
    Returns:
    
    Enables Amazon CloudWatch logging for brokers.
  - maintenanceWindowStartTime
```
public final WeeklyStartTime maintenanceWindowStartTime()
```
    The parameters that determine the WeeklyStartTime.
    
    Returns:
    
    The parameters that determine the WeeklyStartTime.
  - hasSecurityGroups
```
public final boolean hasSecurityGroups()
```
    For responses, this returns true if the service returned a value for the SecurityGroups 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.
  - securityGroups
```
public final List<String> securityGroups()
```
    The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
    
    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 hasSecurityGroups() method.
    
    Returns:
    
    The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
  - toBuilder
```
public UpdateBrokerRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UpdateBrokerRequest.Builder,UpdateBrokerRequest>
    
    Specified by:
    
    toBuilder in class MqRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static UpdateBrokerRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UpdateBrokerRequest.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)
```
    Description copied from interface: SdkPojo
    
    Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.
    If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - 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)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

AWS SDK for Java API Reference - 2.17.62

Class UpdateBrokerRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

authenticationStrategy

authenticationStrategyAsString

autoMinorVersionUpgrade

brokerId

configuration

engineVersion

hostInstanceType

ldapServerMetadata

logs

maintenanceWindowStartTime

hasSecurityGroups

securityGroups

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields