Share via


Connectors Interface

public interface Connectors

Resource collection API of Connectors.

Method Summary

Modifier and Type Method and Description
abstract Blank define(String name)

Begins definition for a new ConnectorResource resource.

abstract void delete(String resourceGroupName, String organizationName, String environmentId, String clusterId, String connectorName)

Delete confluent connector by name.

abstract void delete(String resourceGroupName, String organizationName, String environmentId, String clusterId, String connectorName, Context context)

Delete confluent connector by name.

abstract void deleteById(String id)

Delete confluent connector by name.

abstract void deleteByIdWithResponse(String id, Context context)

Delete confluent connector by name.

abstract ConnectorResource get(String resourceGroupName, String organizationName, String environmentId, String clusterId, String connectorName)

Get confluent connector by Name.

abstract ConnectorResource getById(String id)

Get confluent connector by Name.

abstract Response<ConnectorResource> getByIdWithResponse(String id, Context context)

Get confluent connector by Name.

abstract Response<ConnectorResource> getWithResponse(String resourceGroupName, String organizationName, String environmentId, String clusterId, String connectorName, Context context)

Get confluent connector by Name.

abstract PagedIterable<ConnectorResource> list(String resourceGroupName, String organizationName, String environmentId, String clusterId)

Lists all the connectors in a cluster.

abstract PagedIterable<ConnectorResource> list(String resourceGroupName, String organizationName, String environmentId, String clusterId, Integer pageSize, String pageToken, Context context)

Lists all the connectors in a cluster.

Method Details

define

public abstract ConnectorResource.DefinitionStages.Blank define(String name)

Begins definition for a new ConnectorResource resource.

Parameters:

name - resource name.

Returns:

the first stage of the new ConnectorResource definition.

delete

public abstract void delete(String resourceGroupName, String organizationName, String environmentId, String clusterId, String connectorName)

Delete confluent connector by name.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
organizationName - Organization resource name.
environmentId - Confluent environment id.
clusterId - Confluent kafka or schema registry cluster id.
connectorName - Confluent connector name.

delete

public abstract void delete(String resourceGroupName, String organizationName, String environmentId, String clusterId, String connectorName, Context context)

Delete confluent connector by name.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
organizationName - Organization resource name.
environmentId - Confluent environment id.
clusterId - Confluent kafka or schema registry cluster id.
connectorName - Confluent connector name.
context - The context to associate with this operation.

deleteById

public abstract void deleteById(String id)

Delete confluent connector by name.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Context context)

Delete confluent connector by name.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

get

public abstract ConnectorResource get(String resourceGroupName, String organizationName, String environmentId, String clusterId, String connectorName)

Get confluent connector by Name.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
organizationName - Organization resource name.
environmentId - Confluent environment id.
clusterId - Confluent kafka or schema registry cluster id.
connectorName - Confluent connector name.

Returns:

confluent connector by Name.

getById

public abstract ConnectorResource getById(String id)

Get confluent connector by Name.

Parameters:

id - the resource ID.

Returns:

confluent connector by Name along with Response<T>.

getByIdWithResponse

public abstract Response<ConnectorResource> getByIdWithResponse(String id, Context context)

Get confluent connector by Name.

Parameters:

id - the resource ID.
context - The context to associate with this operation.

Returns:

confluent connector by Name along with Response<T>.

getWithResponse

public abstract Response<ConnectorResource> getWithResponse(String resourceGroupName, String organizationName, String environmentId, String clusterId, String connectorName, Context context)

Get confluent connector by Name.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
organizationName - Organization resource name.
environmentId - Confluent environment id.
clusterId - Confluent kafka or schema registry cluster id.
connectorName - Confluent connector name.
context - The context to associate with this operation.

Returns:

confluent connector by Name along with Response<T>.

list

public abstract PagedIterable<ConnectorResource> list(String resourceGroupName, String organizationName, String environmentId, String clusterId)

Lists all the connectors in a cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
organizationName - Organization resource name.
environmentId - Confluent environment id.
clusterId - Confluent kafka or schema registry cluster id.

Returns:

result of GET request to list connectors in the cluster of a confluent organization as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<ConnectorResource> list(String resourceGroupName, String organizationName, String environmentId, String clusterId, Integer pageSize, String pageToken, Context context)

Lists all the connectors in a cluster.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
organizationName - Organization resource name.
environmentId - Confluent environment id.
clusterId - Confluent kafka or schema registry cluster id.
pageSize - Pagination size.
pageToken - An opaque pagination token to fetch the next set of records.
context - The context to associate with this operation.

Returns:

result of GET request to list connectors in the cluster of a confluent organization as paginated response with PagedIterable<T>.

Applies to