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()` The authentication strategy used to secure the broker.
`String`	`authenticationStrategyAsString()` The authentication strategy used to secure the broker.
`Boolean`	`autoMinorVersionUpgrade()` Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions.
`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 version of the broker engine.
`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()` Returns true if the SecurityGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`hostInstanceType()` The host instance type of the broker to upgrade to.
`LdapServerMetadataInput`	`ldapServerMetadata()` The metadata of the LDAP server used to authenticate and authorize connections to the broker.
`Logs`	`logs()` Enables Amazon CloudWatch logging for brokers.
`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()
```
    The authentication strategy used to secure the broker.
    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:
    
    The authentication strategy used to secure the broker.
    
    See Also:
    
    AuthenticationStrategy
  - authenticationStrategyAsString
```
public final String authenticationStrategyAsString()
```
    The authentication strategy used to secure the broker.
    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:
    
    The authentication strategy used to secure the broker.
    
    See Also:
    
    AuthenticationStrategy
  - autoMinorVersionUpgrade
```
public final Boolean autoMinorVersionUpgrade()
```
    Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot.
    
    Returns:
    
    Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the 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 version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
    
    Returns:
    
    The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html
  - hostInstanceType
```
public final String hostInstanceType()
```
    The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types
    
    Returns:
    
    The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types
  - ldapServerMetadata
```
public final LdapServerMetadataInput ldapServerMetadata()
```
    The metadata of the LDAP server used to authenticate and authorize connections to the broker.
    
    Returns:
    
    The metadata of the LDAP server used to authenticate and authorize connections to the broker.
  - logs
```
public final Logs logs()
```
    Enables Amazon CloudWatch logging for brokers.
    
    Returns:
    
    Enables Amazon CloudWatch logging for brokers.
  - hasSecurityGroups
```
public final boolean hasSecurityGroups()
```
    Returns true if the SecurityGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasSecurityGroups() to see if a value was sent in this field.
    
    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.16.39

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

hasSecurityGroups

securityGroups

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields