Interface KafkaConnectClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface KafkaConnectClient
extends AwsClient

Service client for accessing Kafka Connect. This can be created using the static builder() method.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static KafkaConnectClientBuilder	builder()	Create a builder that can be used to configure and create a KafkaConnectClient.
static KafkaConnectClient	create()	Create a KafkaConnectClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateConnectorResponse	createConnector(Consumer<CreateConnectorRequest.Builder> createConnectorRequest)	Creates a connector using the specified properties.
default CreateConnectorResponse	createConnector(CreateConnectorRequest createConnectorRequest)	Creates a connector using the specified properties.
default CreateCustomPluginResponse	createCustomPlugin(Consumer<CreateCustomPluginRequest.Builder> createCustomPluginRequest)	Creates a custom plugin using the specified properties.
default CreateCustomPluginResponse	createCustomPlugin(CreateCustomPluginRequest createCustomPluginRequest)	Creates a custom plugin using the specified properties.
default CreateWorkerConfigurationResponse	createWorkerConfiguration(Consumer<CreateWorkerConfigurationRequest.Builder> createWorkerConfigurationRequest)	Creates a worker configuration using the specified properties.
default CreateWorkerConfigurationResponse	createWorkerConfiguration(CreateWorkerConfigurationRequest createWorkerConfigurationRequest)	Creates a worker configuration using the specified properties.
default DeleteConnectorResponse	deleteConnector(Consumer<DeleteConnectorRequest.Builder> deleteConnectorRequest)	Deletes the specified connector.
default DeleteConnectorResponse	deleteConnector(DeleteConnectorRequest deleteConnectorRequest)	Deletes the specified connector.
default DeleteCustomPluginResponse	deleteCustomPlugin(Consumer<DeleteCustomPluginRequest.Builder> deleteCustomPluginRequest)	Deletes a custom plugin.
default DeleteCustomPluginResponse	deleteCustomPlugin(DeleteCustomPluginRequest deleteCustomPluginRequest)	Deletes a custom plugin.
default DeleteWorkerConfigurationResponse	deleteWorkerConfiguration(Consumer<DeleteWorkerConfigurationRequest.Builder> deleteWorkerConfigurationRequest)	Deletes the specified worker configuration.
default DeleteWorkerConfigurationResponse	deleteWorkerConfiguration(DeleteWorkerConfigurationRequest deleteWorkerConfigurationRequest)	Deletes the specified worker configuration.
default DescribeConnectorResponse	describeConnector(Consumer<DescribeConnectorRequest.Builder> describeConnectorRequest)	Returns summary information about the connector.
default DescribeConnectorResponse	describeConnector(DescribeConnectorRequest describeConnectorRequest)	Returns summary information about the connector.
default DescribeCustomPluginResponse	describeCustomPlugin(Consumer<DescribeCustomPluginRequest.Builder> describeCustomPluginRequest)	A summary description of the custom plugin.
default DescribeCustomPluginResponse	describeCustomPlugin(DescribeCustomPluginRequest describeCustomPluginRequest)	A summary description of the custom plugin.
default DescribeWorkerConfigurationResponse	describeWorkerConfiguration(Consumer<DescribeWorkerConfigurationRequest.Builder> describeWorkerConfigurationRequest)	Returns information about a worker configuration.
default DescribeWorkerConfigurationResponse	describeWorkerConfiguration(DescribeWorkerConfigurationRequest describeWorkerConfigurationRequest)	Returns information about a worker configuration.
default ListConnectorsResponse	listConnectors(Consumer<ListConnectorsRequest.Builder> listConnectorsRequest)	Returns a list of all the connectors in this account and Region.
default ListConnectorsResponse	listConnectors(ListConnectorsRequest listConnectorsRequest)	Returns a list of all the connectors in this account and Region.
default ListConnectorsIterable	listConnectorsPaginator(Consumer<ListConnectorsRequest.Builder> listConnectorsRequest)	This is a variant of listConnectors(software.amazon.awssdk.services.kafkaconnect.model.ListConnectorsRequest) operation.
default ListConnectorsIterable	listConnectorsPaginator(ListConnectorsRequest listConnectorsRequest)	This is a variant of listConnectors(software.amazon.awssdk.services.kafkaconnect.model.ListConnectorsRequest) operation.
default ListCustomPluginsResponse	listCustomPlugins(Consumer<ListCustomPluginsRequest.Builder> listCustomPluginsRequest)	Returns a list of all of the custom plugins in this account and Region.
default ListCustomPluginsResponse	listCustomPlugins(ListCustomPluginsRequest listCustomPluginsRequest)	Returns a list of all of the custom plugins in this account and Region.
default ListCustomPluginsIterable	listCustomPluginsPaginator(Consumer<ListCustomPluginsRequest.Builder> listCustomPluginsRequest)	This is a variant of listCustomPlugins(software.amazon.awssdk.services.kafkaconnect.model.ListCustomPluginsRequest) operation.
default ListCustomPluginsIterable	listCustomPluginsPaginator(ListCustomPluginsRequest listCustomPluginsRequest)	This is a variant of listCustomPlugins(software.amazon.awssdk.services.kafkaconnect.model.ListCustomPluginsRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Lists all the tags attached to the specified resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Lists all the tags attached to the specified resource.
default ListWorkerConfigurationsResponse	listWorkerConfigurations(Consumer<ListWorkerConfigurationsRequest.Builder> listWorkerConfigurationsRequest)	Returns a list of all of the worker configurations in this account and Region.
default ListWorkerConfigurationsResponse	listWorkerConfigurations(ListWorkerConfigurationsRequest listWorkerConfigurationsRequest)	Returns a list of all of the worker configurations in this account and Region.
default ListWorkerConfigurationsIterable	listWorkerConfigurationsPaginator(Consumer<ListWorkerConfigurationsRequest.Builder> listWorkerConfigurationsRequest)	This is a variant of listWorkerConfigurations(software.amazon.awssdk.services.kafkaconnect.model.ListWorkerConfigurationsRequest) operation.
default ListWorkerConfigurationsIterable	listWorkerConfigurationsPaginator(ListWorkerConfigurationsRequest listWorkerConfigurationsRequest)	This is a variant of listWorkerConfigurations(software.amazon.awssdk.services.kafkaconnect.model.ListWorkerConfigurationsRequest) operation.
default KafkaConnectServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Attaches tags to the specified resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Attaches tags to the specified resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes tags from the specified resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes tags from the specified resource.
default UpdateConnectorResponse	updateConnector(Consumer<UpdateConnectorRequest.Builder> updateConnectorRequest)	Updates the specified connector.
default UpdateConnectorResponse	updateConnector(UpdateConnectorRequest updateConnectorRequest)	Updates the specified connector.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

createConnector

default CreateConnectorResponse createConnector(CreateConnectorRequest createConnectorRequest)
                                         throws NotFoundException,
ConflictException,
BadRequestException,
ForbiddenException,
ServiceUnavailableException,
TooManyRequestsException,
UnauthorizedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
KafkaConnectException

Creates a connector using the specified properties.

Parameters:

createConnectorRequest -

Returns:

Result of the CreateConnector operation returned by the service.

See Also:

• AWS API Documentation

createConnector

default CreateConnectorResponse createConnector(Consumer<CreateConnectorRequest.Builder> createConnectorRequest)
                                         throws NotFoundException,
ConflictException,
BadRequestException,
ForbiddenException,
ServiceUnavailableException,
TooManyRequestsException,
UnauthorizedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
KafkaConnectException

Creates a connector using the specified properties.

This is a convenience which creates an instance of the CreateConnectorRequest.Builder avoiding the need to create one manually via CreateConnectorRequest.builder()

Parameters:

createConnectorRequest - A Consumer that will call methods on CreateConnectorRequest.Builder to create a request.

Returns:

Result of the CreateConnector operation returned by the service.

See Also:

• AWS API Documentation

createCustomPlugin

default CreateCustomPluginResponse createCustomPlugin(CreateCustomPluginRequest createCustomPluginRequest)
                                               throws NotFoundException,
ConflictException,
BadRequestException,
ForbiddenException,
ServiceUnavailableException,
TooManyRequestsException,
UnauthorizedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
KafkaConnectException

Creates a custom plugin using the specified properties.

Parameters:

createCustomPluginRequest -

Returns:

Result of the CreateCustomPlugin operation returned by the service.

See Also:

• AWS API Documentation

createCustomPlugin

default CreateCustomPluginResponse createCustomPlugin(Consumer<CreateCustomPluginRequest.Builder> createCustomPluginRequest)
                                               throws NotFoundException,
ConflictException,
BadRequestException,
ForbiddenException,
ServiceUnavailableException,
TooManyRequestsException,
UnauthorizedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
KafkaConnectException

Creates a custom plugin using the specified properties.

This is a convenience which creates an instance of the CreateCustomPluginRequest.Builder avoiding the need to create one manually via CreateCustomPluginRequest.builder()

Parameters:

createCustomPluginRequest - A Consumer that will call methods on CreateCustomPluginRequest.Builder to create a request.

Returns:

Result of the CreateCustomPlugin operation returned by the service.

See Also:

• AWS API Documentation

createWorkerConfiguration

default CreateWorkerConfigurationResponse createWorkerConfiguration(CreateWorkerConfigurationRequest createWorkerConfigurationRequest)
                                                             throws NotFoundException,
ConflictException,
BadRequestException,
ForbiddenException,
ServiceUnavailableException,
TooManyRequestsException,
UnauthorizedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
KafkaConnectException

Creates a worker configuration using the specified properties.

Parameters:

createWorkerConfigurationRequest -

Returns:

Result of the CreateWorkerConfiguration operation returned by the service.

See Also:

• AWS API Documentation

createWorkerConfiguration

default CreateWorkerConfigurationResponse createWorkerConfiguration(Consumer<CreateWorkerConfigurationRequest.Builder> createWorkerConfigurationRequest)
                                                             throws NotFoundException,
ConflictException,
BadRequestException,
ForbiddenException,
ServiceUnavailableException,
TooManyRequestsException,
UnauthorizedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
KafkaConnectException

Creates a worker configuration using the specified properties.

This is a convenience which creates an instance of the CreateWorkerConfigurationRequest.Builder avoiding the need to create one manually via CreateWorkerConfigurationRequest.builder()

Parameters:

createWorkerConfigurationRequest - A Consumer that will call methods on CreateWorkerConfigurationRequest.Builder to create a request.

Returns:

Result of the CreateWorkerConfiguration operation returned by the service.

See Also:

• AWS API Documentation

deleteConnector

default DeleteConnectorResponse deleteConnector(DeleteConnectorRequest deleteConnectorRequest)
                                         throws NotFoundException,
BadRequestException,
ForbiddenException,
ServiceUnavailableException,
TooManyRequestsException,
UnauthorizedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
KafkaConnectException

Deletes the specified connector.

Parameters:

deleteConnectorRequest -

Returns:

Result of the DeleteConnector operation returned by the service.

See Also:

• AWS API Documentation

deleteConnector

default DeleteConnectorResponse deleteConnector(Consumer<DeleteConnectorRequest.Builder> deleteConnectorRequest)
                                         throws NotFoundException,
BadRequestException,
ForbiddenException,
ServiceUnavailableException,
TooManyRequestsException,
UnauthorizedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
KafkaConnectException

Deletes the specified connector.

This is a convenience which creates an instance of the DeleteConnectorRequest.Builder avoiding the need to create one manually via DeleteConnectorRequest.builder()

Parameters:

deleteConnectorRequest - A Consumer that will call methods on DeleteConnectorRequest.Builder to create a request.

Returns:

Result of the DeleteConnector operation returned by the service.

See Also:

• AWS API Documentation

deleteCustomPlugin

default DeleteCustomPluginResponse deleteCustomPlugin(DeleteCustomPluginRequest deleteCustomPluginRequest)
                                               throws NotFoundException,
BadRequestException,
ForbiddenException,
ServiceUnavailableException,
TooManyRequestsException,
UnauthorizedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
KafkaConnectException

Deletes a custom plugin.

Parameters:

deleteCustomPluginRequest -

Returns:

Result of the DeleteCustomPlugin operation returned by the service.

See Also:

• AWS API Documentation

deleteCustomPlugin

default DeleteCustomPluginResponse deleteCustomPlugin(Consumer<DeleteCustomPluginRequest.Builder> deleteCustomPluginRequest)
                                               throws NotFoundException,
BadRequestException,
ForbiddenException,
ServiceUnavailableException,
TooManyRequestsException,
UnauthorizedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
KafkaConnectException

Deletes a custom plugin.

This is a convenience which creates an instance of the DeleteCustomPluginRequest.Builder avoiding the need to create one manually via DeleteCustomPluginRequest.builder()

Parameters:

deleteCustomPluginRequest - A Consumer that will call methods on DeleteCustomPluginRequest.Builder to create a request.

Returns:

Result of the DeleteCustomPlugin operation returned by the service.

See Also:

• AWS API Documentation

deleteWorkerConfiguration

default DeleteWorkerConfigurationResponse deleteWorkerConfiguration(DeleteWorkerConfigurationRequest deleteWorkerConfigurationRequest)
                                                             throws NotFoundException,
BadRequestException,
ForbiddenException,
ServiceUnavailableException,
TooManyRequestsException,
UnauthorizedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
KafkaConnectException

Deletes the specified worker configuration.

Parameters:

deleteWorkerConfigurationRequest -

Returns:

Result of the DeleteWorkerConfiguration operation returned by the service.

See Also:

• AWS API Documentation

deleteWorkerConfiguration

default DeleteWorkerConfigurationResponse deleteWorkerConfiguration(Consumer<DeleteWorkerConfigurationRequest.Builder> deleteWorkerConfigurationRequest)
                                                             throws NotFoundException,
BadRequestException,
ForbiddenException,
ServiceUnavailableException,
TooManyRequestsException,
UnauthorizedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
KafkaConnectException

Deletes the specified worker configuration.

This is a convenience which creates an instance of the DeleteWorkerConfigurationRequest.Builder avoiding the need to create one manually via DeleteWorkerConfigurationRequest.builder()

Parameters:

deleteWorkerConfigurationRequest - A Consumer that will call methods on DeleteWorkerConfigurationRequest.Builder to create a request.

Returns:

Result of the DeleteWorkerConfiguration operation returned by the service.

See Also:

• AWS API Documentation

describeConnector

default DescribeConnectorResponse describeConnector(DescribeConnectorRequest describeConnectorRequest)
                                             throws NotFoundException,
BadRequestException,
ForbiddenException,
ServiceUnavailableException,
TooManyRequestsException,
UnauthorizedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
KafkaConnectException

Returns summary information about the connector.

Parameters:

describeConnectorRequest -

Returns:

Result of the DescribeConnector operation returned by the service.

See Also:

• AWS API Documentation

describeConnector

default DescribeConnectorResponse describeConnector(Consumer<DescribeConnectorRequest.Builder> describeConnectorRequest)
                                             throws NotFoundException,
BadRequestException,
ForbiddenException,
ServiceUnavailableException,
TooManyRequestsException,
UnauthorizedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
KafkaConnectException

Returns summary information about the connector.

This is a convenience which creates an instance of the DescribeConnectorRequest.Builder avoiding the need to create one manually via DescribeConnectorRequest.builder()

Parameters:

describeConnectorRequest - A Consumer that will call methods on DescribeConnectorRequest.Builder to create a request.

Returns:

Result of the DescribeConnector operation returned by the service.

See Also:

• AWS API Documentation

describeCustomPlugin

default DescribeCustomPluginResponse describeCustomPlugin(DescribeCustomPluginRequest describeCustomPluginRequest)
                                                   throws NotFoundException,
BadRequestException,
ForbiddenException,
ServiceUnavailableException,
TooManyRequestsException,
UnauthorizedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
KafkaConnectException

A summary description of the custom plugin.

Parameters:

describeCustomPluginRequest -

Returns:

Result of the DescribeCustomPlugin operation returned by the service.

See Also:

• AWS API Documentation

describeCustomPlugin

default DescribeCustomPluginResponse describeCustomPlugin(Consumer<DescribeCustomPluginRequest.Builder> describeCustomPluginRequest)
                                                   throws NotFoundException,
BadRequestException,
ForbiddenException,
ServiceUnavailableException,
TooManyRequestsException,
UnauthorizedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
KafkaConnectException

A summary description of the custom plugin.

This is a convenience which creates an instance of the DescribeCustomPluginRequest.Builder avoiding the need to create one manually via DescribeCustomPluginRequest.builder()

Parameters:

describeCustomPluginRequest - A Consumer that will call methods on DescribeCustomPluginRequest.Builder to create a request.

Returns:

Result of the DescribeCustomPlugin operation returned by the service.

See Also:

• AWS API Documentation

describeWorkerConfiguration

default DescribeWorkerConfigurationResponse describeWorkerConfiguration(DescribeWorkerConfigurationRequest describeWorkerConfigurationRequest)
                                                                 throws NotFoundException,
BadRequestException,
ForbiddenException,
ServiceUnavailableException,
TooManyRequestsException,
UnauthorizedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
KafkaConnectException

Returns information about a worker configuration.

Parameters:

describeWorkerConfigurationRequest -

Returns:

Result of the DescribeWorkerConfiguration operation returned by the service.

See Also:

• AWS API Documentation

describeWorkerConfiguration

default DescribeWorkerConfigurationResponse describeWorkerConfiguration(Consumer<DescribeWorkerConfigurationRequest.Builder> describeWorkerConfigurationRequest)
                                                                 throws NotFoundException,
BadRequestException,
ForbiddenException,
ServiceUnavailableException,
TooManyRequestsException,
UnauthorizedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
KafkaConnectException

Returns information about a worker configuration.

This is a convenience which creates an instance of the DescribeWorkerConfigurationRequest.Builder avoiding the need to create one manually via DescribeWorkerConfigurationRequest.builder()

Parameters:

describeWorkerConfigurationRequest - A Consumer that will call methods on DescribeWorkerConfigurationRequest.Builder to create a request.

Returns:

Result of the DescribeWorkerConfiguration operation returned by the service.

See Also:

• AWS API Documentation

listConnectors

default ListConnectorsResponse listConnectors(ListConnectorsRequest listConnectorsRequest)
                                       throws NotFoundException,
BadRequestException,
ForbiddenException,
ServiceUnavailableException,
TooManyRequestsException,
UnauthorizedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
KafkaConnectException

Returns a list of all the connectors in this account and Region. The list is limited to connectors whose name starts with the specified prefix. The response also includes a description of each of the listed connectors.

Parameters:

listConnectorsRequest -

Returns:

Result of the ListConnectors operation returned by the service.

See Also:

• AWS API Documentation

listConnectors

default ListConnectorsResponse listConnectors(Consumer<ListConnectorsRequest.Builder> listConnectorsRequest)
                                       throws NotFoundException,
BadRequestException,
ForbiddenException,
ServiceUnavailableException,
TooManyRequestsException,
UnauthorizedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
KafkaConnectException

Returns a list of all the connectors in this account and Region. The list is limited to connectors whose name starts with the specified prefix. The response also includes a description of each of the listed connectors.

This is a convenience which creates an instance of the ListConnectorsRequest.Builder avoiding the need to create one manually via ListConnectorsRequest.builder()

Parameters:

listConnectorsRequest - A Consumer that will call methods on ListConnectorsRequest.Builder to create a request.

Returns:

Result of the ListConnectors operation returned by the service.

See Also:

• AWS API Documentation

listConnectorsPaginator

default ListConnectorsIterable listConnectorsPaginator(ListConnectorsRequest listConnectorsRequest)
                                                throws NotFoundException,
BadRequestException,
ForbiddenException,
ServiceUnavailableException,
TooManyRequestsException,
UnauthorizedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
KafkaConnectException

This is a variant of listConnectors(software.amazon.awssdk.services.kafkaconnect.model.ListConnectorsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.kafkaconnect.paginators.ListConnectorsIterable responses = client.listConnectorsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.kafkaconnect.paginators.ListConnectorsIterable responses = client
             .listConnectorsPaginator(request);
     for (software.amazon.awssdk.services.kafkaconnect.model.ListConnectorsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.kafkaconnect.paginators.ListConnectorsIterable responses = client.listConnectorsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listConnectors(software.amazon.awssdk.services.kafkaconnect.model.ListConnectorsRequest) operation.

Parameters:

listConnectorsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listConnectorsPaginator

default ListConnectorsIterable listConnectorsPaginator(Consumer<ListConnectorsRequest.Builder> listConnectorsRequest)
                                                throws NotFoundException,
BadRequestException,
ForbiddenException,
ServiceUnavailableException,
TooManyRequestsException,
UnauthorizedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
KafkaConnectException

This is a variant of listConnectors(software.amazon.awssdk.services.kafkaconnect.model.ListConnectorsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.kafkaconnect.paginators.ListConnectorsIterable responses = client.listConnectorsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.kafkaconnect.paginators.ListConnectorsIterable responses = client
             .listConnectorsPaginator(request);
     for (software.amazon.awssdk.services.kafkaconnect.model.ListConnectorsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.kafkaconnect.paginators.ListConnectorsIterable responses = client.listConnectorsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listConnectors(software.amazon.awssdk.services.kafkaconnect.model.ListConnectorsRequest) operation.

This is a convenience which creates an instance of the ListConnectorsRequest.Builder avoiding the need to create one manually via ListConnectorsRequest.builder()

Parameters:

listConnectorsRequest - A Consumer that will call methods on ListConnectorsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listCustomPlugins

default ListCustomPluginsResponse listCustomPlugins(ListCustomPluginsRequest listCustomPluginsRequest)
                                             throws NotFoundException,
BadRequestException,
ForbiddenException,
ServiceUnavailableException,
TooManyRequestsException,
UnauthorizedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
KafkaConnectException

Returns a list of all of the custom plugins in this account and Region.

Parameters:

listCustomPluginsRequest -

Returns:

Result of the ListCustomPlugins operation returned by the service.

See Also:

• AWS API Documentation

listCustomPlugins

default ListCustomPluginsResponse listCustomPlugins(Consumer<ListCustomPluginsRequest.Builder> listCustomPluginsRequest)
                                             throws NotFoundException,
BadRequestException,
ForbiddenException,
ServiceUnavailableException,
TooManyRequestsException,
UnauthorizedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
KafkaConnectException

Returns a list of all of the custom plugins in this account and Region.

This is a convenience which creates an instance of the ListCustomPluginsRequest.Builder avoiding the need to create one manually via ListCustomPluginsRequest.builder()

Parameters:

listCustomPluginsRequest - A Consumer that will call methods on ListCustomPluginsRequest.Builder to create a request.

Returns:

Result of the ListCustomPlugins operation returned by the service.

See Also:

• AWS API Documentation

listCustomPluginsPaginator

default ListCustomPluginsIterable listCustomPluginsPaginator(ListCustomPluginsRequest listCustomPluginsRequest)
                                                      throws NotFoundException,
BadRequestException,
ForbiddenException,
ServiceUnavailableException,
TooManyRequestsException,
UnauthorizedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
KafkaConnectException

This is a variant of listCustomPlugins(software.amazon.awssdk.services.kafkaconnect.model.ListCustomPluginsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.kafkaconnect.paginators.ListCustomPluginsIterable responses = client.listCustomPluginsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.kafkaconnect.paginators.ListCustomPluginsIterable responses = client
             .listCustomPluginsPaginator(request);
     for (software.amazon.awssdk.services.kafkaconnect.model.ListCustomPluginsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.kafkaconnect.paginators.ListCustomPluginsIterable responses = client.listCustomPluginsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listCustomPlugins(software.amazon.awssdk.services.kafkaconnect.model.ListCustomPluginsRequest) operation.

Parameters:

listCustomPluginsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listCustomPluginsPaginator

default ListCustomPluginsIterable listCustomPluginsPaginator(Consumer<ListCustomPluginsRequest.Builder> listCustomPluginsRequest)
                                                      throws NotFoundException,
BadRequestException,
ForbiddenException,
ServiceUnavailableException,
TooManyRequestsException,
UnauthorizedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
KafkaConnectException

This is a variant of listCustomPlugins(software.amazon.awssdk.services.kafkaconnect.model.ListCustomPluginsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.kafkaconnect.paginators.ListCustomPluginsIterable responses = client.listCustomPluginsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.kafkaconnect.paginators.ListCustomPluginsIterable responses = client
             .listCustomPluginsPaginator(request);
     for (software.amazon.awssdk.services.kafkaconnect.model.ListCustomPluginsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.kafkaconnect.paginators.ListCustomPluginsIterable responses = client.listCustomPluginsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listCustomPlugins(software.amazon.awssdk.services.kafkaconnect.model.ListCustomPluginsRequest) operation.

This is a convenience which creates an instance of the ListCustomPluginsRequest.Builder avoiding the need to create one manually via ListCustomPluginsRequest.builder()

Parameters:

listCustomPluginsRequest - A Consumer that will call methods on ListCustomPluginsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws NotFoundException,
BadRequestException,
ForbiddenException,
ServiceUnavailableException,
TooManyRequestsException,
UnauthorizedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
KafkaConnectException

Lists all the tags attached to the specified resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws NotFoundException,
BadRequestException,
ForbiddenException,
ServiceUnavailableException,
TooManyRequestsException,
UnauthorizedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
KafkaConnectException

Lists all the tags attached to the specified resource.

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listWorkerConfigurations

default ListWorkerConfigurationsResponse listWorkerConfigurations(ListWorkerConfigurationsRequest listWorkerConfigurationsRequest)
                                                           throws NotFoundException,
BadRequestException,
ForbiddenException,
ServiceUnavailableException,
TooManyRequestsException,
UnauthorizedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
KafkaConnectException

Returns a list of all of the worker configurations in this account and Region.

Parameters:

listWorkerConfigurationsRequest -

Returns:

Result of the ListWorkerConfigurations operation returned by the service.

See Also:

• AWS API Documentation

listWorkerConfigurations

default ListWorkerConfigurationsResponse listWorkerConfigurations(Consumer<ListWorkerConfigurationsRequest.Builder> listWorkerConfigurationsRequest)
                                                           throws NotFoundException,
BadRequestException,
ForbiddenException,
ServiceUnavailableException,
TooManyRequestsException,
UnauthorizedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
KafkaConnectException

Returns a list of all of the worker configurations in this account and Region.

This is a convenience which creates an instance of the ListWorkerConfigurationsRequest.Builder avoiding the need to create one manually via ListWorkerConfigurationsRequest.builder()

Parameters:

listWorkerConfigurationsRequest - A Consumer that will call methods on ListWorkerConfigurationsRequest.Builder to create a request.

Returns:

Result of the ListWorkerConfigurations operation returned by the service.

See Also:

• AWS API Documentation

listWorkerConfigurationsPaginator

default ListWorkerConfigurationsIterable listWorkerConfigurationsPaginator(ListWorkerConfigurationsRequest listWorkerConfigurationsRequest)
                                                                    throws NotFoundException,
BadRequestException,
ForbiddenException,
ServiceUnavailableException,
TooManyRequestsException,
UnauthorizedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
KafkaConnectException

This is a variant of listWorkerConfigurations(software.amazon.awssdk.services.kafkaconnect.model.ListWorkerConfigurationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.kafkaconnect.paginators.ListWorkerConfigurationsIterable responses = client.listWorkerConfigurationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.kafkaconnect.paginators.ListWorkerConfigurationsIterable responses = client
             .listWorkerConfigurationsPaginator(request);
     for (software.amazon.awssdk.services.kafkaconnect.model.ListWorkerConfigurationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.kafkaconnect.paginators.ListWorkerConfigurationsIterable responses = client.listWorkerConfigurationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listWorkerConfigurations(software.amazon.awssdk.services.kafkaconnect.model.ListWorkerConfigurationsRequest) operation.

Parameters:

listWorkerConfigurationsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listWorkerConfigurationsPaginator

default ListWorkerConfigurationsIterable listWorkerConfigurationsPaginator(Consumer<ListWorkerConfigurationsRequest.Builder> listWorkerConfigurationsRequest)
                                                                    throws NotFoundException,
BadRequestException,
ForbiddenException,
ServiceUnavailableException,
TooManyRequestsException,
UnauthorizedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
KafkaConnectException

This is a variant of listWorkerConfigurations(software.amazon.awssdk.services.kafkaconnect.model.ListWorkerConfigurationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.kafkaconnect.paginators.ListWorkerConfigurationsIterable responses = client.listWorkerConfigurationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.kafkaconnect.paginators.ListWorkerConfigurationsIterable responses = client
             .listWorkerConfigurationsPaginator(request);
     for (software.amazon.awssdk.services.kafkaconnect.model.ListWorkerConfigurationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.kafkaconnect.paginators.ListWorkerConfigurationsIterable responses = client.listWorkerConfigurationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listWorkerConfigurations(software.amazon.awssdk.services.kafkaconnect.model.ListWorkerConfigurationsRequest) operation.

This is a convenience which creates an instance of the ListWorkerConfigurationsRequest.Builder avoiding the need to create one manually via ListWorkerConfigurationsRequest.builder()

Parameters:

listWorkerConfigurationsRequest - A Consumer that will call methods on ListWorkerConfigurationsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws NotFoundException,
ConflictException,
BadRequestException,
ForbiddenException,
ServiceUnavailableException,
TooManyRequestsException,
UnauthorizedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
KafkaConnectException

Attaches tags to the specified resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws NotFoundException,
ConflictException,
BadRequestException,
ForbiddenException,
ServiceUnavailableException,
TooManyRequestsException,
UnauthorizedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
KafkaConnectException

Attaches tags to the specified resource.

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws NotFoundException,
BadRequestException,
ForbiddenException,
ServiceUnavailableException,
TooManyRequestsException,
UnauthorizedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
KafkaConnectException

Removes tags from the specified resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws NotFoundException,
BadRequestException,
ForbiddenException,
ServiceUnavailableException,
TooManyRequestsException,
UnauthorizedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
KafkaConnectException

Removes tags from the specified resource.

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateConnector

default UpdateConnectorResponse updateConnector(UpdateConnectorRequest updateConnectorRequest)
                                         throws NotFoundException,
BadRequestException,
ForbiddenException,
ServiceUnavailableException,
TooManyRequestsException,
UnauthorizedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
KafkaConnectException

Updates the specified connector.

Parameters:

updateConnectorRequest -

Returns:

Result of the UpdateConnector operation returned by the service.

See Also:

• AWS API Documentation

updateConnector

default UpdateConnectorResponse updateConnector(Consumer<UpdateConnectorRequest.Builder> updateConnectorRequest)
                                         throws NotFoundException,
BadRequestException,
ForbiddenException,
ServiceUnavailableException,
TooManyRequestsException,
UnauthorizedException,
InternalServerErrorException,
AwsServiceException,
SdkClientException,
KafkaConnectException

Updates the specified connector.

This is a convenience which creates an instance of the UpdateConnectorRequest.Builder avoiding the need to create one manually via UpdateConnectorRequest.builder()

Parameters:

updateConnectorRequest - A Consumer that will call methods on UpdateConnectorRequest.Builder to create a request.

Returns:

Result of the UpdateConnector operation returned by the service.

See Also:

• AWS API Documentation

create

static KafkaConnectClient create()

Create a KafkaConnectClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static KafkaConnectClientBuilder builder()

Create a builder that can be used to configure and create a KafkaConnectClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default KafkaConnectServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration