Package org.apache.kafka.clients.admin

Class AlterConfigsOptions

java.lang.Object

org.apache.kafka.clients.admin.AbstractOptions<AlterConfigsOptions>

org.apache.kafka.clients.admin.AlterConfigsOptions

@Evolving
public class AlterConfigsOptions
extends AbstractOptions<AlterConfigsOptions>

Options for Admin.incrementalAlterConfigs(Map) and Admin.alterConfigs(Map). The API of this class is evolving, see Admin for details.

Field Summary

Fields inherited from class org.apache.kafka.clients.admin.AbstractOptions

timeoutMs

Constructor Summary

Constructors

Constructor	Description
AlterConfigsOptions()

Method Summary

Modifier and Type	Method	Description
boolean	shouldValidateOnly()	Return true if the request should be validated without altering the configs.
AlterConfigsOptions	timeoutMs(Integer timeoutMs)	Set the timeout in milliseconds for this operation or null if the default api timeout for the AdminClient should be used.
AlterConfigsOptions	validateOnly(boolean validateOnly)	Set to true if the request should be validated without altering the configs.

Methods inherited from class org.apache.kafka.clients.admin.AbstractOptions

timeoutMs

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AlterConfigsOptions

public AlterConfigsOptions()

Method Details

timeoutMs

public AlterConfigsOptions timeoutMs(Integer timeoutMs)

Set the timeout in milliseconds for this operation or null if the default api timeout for the AdminClient should be used.

Overrides:

timeoutMs in class AbstractOptions<AlterConfigsOptions>

shouldValidateOnly

public boolean shouldValidateOnly()

Return true if the request should be validated without altering the configs.

validateOnly

public AlterConfigsOptions validateOnly(boolean validateOnly)

Set to true if the request should be validated without altering the configs.