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

Class DescribeBrokerResponse

    • Method Detail

      • hasActionsRequired

        public final boolean hasActionsRequired()
        For responses, this returns true if the service returned a value for the ActionsRequired 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.

      • actionsRequired

        public final List<ActionRequired> actionsRequired()

        Actions required for a broker.

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

        Returns:
        Actions required for a broker.

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

      • brokerArn

        public final String brokerArn()

        The broker's Amazon Resource Name (ARN).

        Returns:
        The broker's Amazon Resource Name (ARN).

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

      • hasBrokerInstances

        public final boolean hasBrokerInstances()
        For responses, this returns true if the service returned a value for the BrokerInstances 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.

      • brokerInstances

        public final List<BrokerInstance> brokerInstances()

        A list of information about allocated 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 hasBrokerInstances() method.

        Returns:
        A list of information about allocated brokers.

      • brokerName

        public final String brokerName()

        The broker's name. This value must be unique in your Amazon Web Services account account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.

        Returns:
        The broker's name. This value must be unique in your Amazon Web Services account account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.

      • configurations

        public final Configurations configurations()

        The list of all revisions for the specified configuration.

        Returns:
        The list of all revisions for the specified configuration.

      • created

        public final Instant created()

        The time when the broker was created.

        Returns:
        The time when the broker was created.

      • encryptionOptions

        public final EncryptionOptions encryptionOptions()

        Encryption options for the broker.

        Returns:
        Encryption options for the broker.

      • engineType

        public final EngineType engineType()

        The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.

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

        Returns:
        The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
        See Also:
        EngineType

      • engineTypeAsString

        public final String engineTypeAsString()

        The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.

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

        Returns:
        The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
        See Also:
        EngineType

      • engineVersion

        public final String engineVersion()

        The broker engine's version. For a list of supported engine versions, see Supported engines.

        Returns:
        The broker engine's version. For a list of supported engine versions, see Supported engines.

      • hostInstanceType

        public final String hostInstanceType()

        The broker's instance type.

        Returns:
        The broker's instance type.

      • ldapServerMetadata

        public final LdapServerMetadataOutput 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 LogsSummary logs()

        The list of information about logs currently enabled and pending to be deployed for the specified broker.

        Returns:
        The list of information about logs currently enabled and pending to be deployed for the specified broker.

      • maintenanceWindowStartTime

        public final WeeklyStartTime maintenanceWindowStartTime()

        The parameters that determine the WeeklyStartTime.

        Returns:
        The parameters that determine the WeeklyStartTime.

      • pendingEngineVersion

        public final String pendingEngineVersion()

        The broker engine version to upgrade to. For a list of supported engine versions, see Supported engines.

        Returns:
        The broker engine version to upgrade to. For a list of supported engine versions, see Supported engines.

      • pendingHostInstanceType

        public final String pendingHostInstanceType()

        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.

      • pendingLdapServerMetadata

        public final LdapServerMetadataOutput pendingLdapServerMetadata()

        The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker after it is rebooted.

        Returns:
        The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker after it is rebooted.

      • hasPendingSecurityGroups

        public final boolean hasPendingSecurityGroups()
        For responses, this returns true if the service returned a value for the PendingSecurityGroups 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.

      • pendingSecurityGroups

        public final List<String> pendingSecurityGroups()

        The list of pending security groups to authorize 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 hasPendingSecurityGroups() method.

        Returns:
        The list of pending security groups to authorize connections to brokers.

      • publiclyAccessible

        public final Boolean publiclyAccessible()

        Enables connections from applications outside of the VPC that hosts the broker's subnets.

        Returns:
        Enables connections from applications outside of the VPC that hosts the broker's subnets.

      • 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 rules (1 minimum, 125 maximum) that authorize 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 rules (1 minimum, 125 maximum) that authorize connections to brokers.

      • hasSubnetIds

        public final boolean hasSubnetIds()
        For responses, this returns true if the service returned a value for the SubnetIds 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.

      • subnetIds

        public final List<String> subnetIds()

        The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.

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

        Returns:
        The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags 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.

      • tags

        public final Map<String,​String> tags()

        The list of all tags associated with this broker.

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

        Returns:
        The list of all tags associated with this broker.

      • hasUsers

        public final boolean hasUsers()
        For responses, this returns true if the service returned a value for the Users 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.

      • users

        public final List<UserSummary> users()

        The list of all broker usernames for the specified broker.

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

        Returns:
        The list of all broker usernames for the specified broker.

      • dataReplicationMetadata

        public final DataReplicationMetadataOutput dataReplicationMetadata()

        The replication details of the data replication-enabled broker. Only returned if dataReplicationMode is set to CRDR.

        Returns:
        The replication details of the data replication-enabled broker. Only returned if dataReplicationMode is set to CRDR.

      • pendingDataReplicationMetadata

        public final DataReplicationMetadataOutput pendingDataReplicationMetadata()

        The pending replication details of the data replication-enabled broker. Only returned if pendingDataReplicationMode is set to CRDR.

        Returns:
        The pending replication details of the data replication-enabled broker. Only returned if pendingDataReplicationMode is set to CRDR.

      • 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