Package org.apache.pulsar.broker.admin.impl

Class SinksBase

java.lang.Object

org.apache.pulsar.broker.web.PulsarWebResource

org.apache.pulsar.broker.admin.AdminResource

org.apache.pulsar.broker.admin.impl.SinksBase

Direct Known Subclasses:

Sink, Sinks

public class SinksBase
extends AdminResource

Field Summary

Fields inherited from class org.apache.pulsar.broker.admin.AdminResource

namespaceName, topicName

Fields inherited from class org.apache.pulsar.broker.web.PulsarWebResource

httpRequest, servletContext, uri

Constructor Summary

Constructors

Constructor	Description
SinksBase()

Method Summary

Modifier and Type	Method	Description
void	deregisterSink(String tenant, String namespace, String sinkName)
List<org.apache.pulsar.common.io.ConfigFieldDefinition>	getSinkConfigDefinition(String name)
org.apache.pulsar.common.io.SinkConfig	getSinkInfo(String tenant, String namespace, String sinkName)
org.apache.pulsar.common.policies.data.SinkStatus.SinkInstanceStatus.SinkInstanceStatusData	getSinkInstanceStatus(String tenant, String namespace, String sinkName, String instanceId)
List<org.apache.pulsar.common.io.ConnectorDefinition>	getSinkList()
org.apache.pulsar.common.policies.data.SinkStatus	getSinkStatus(String tenant, String namespace, String sinkName)
List<String>	listSinks(String tenant, String namespace)
void	registerSink(String tenant, String namespace, String sinkName, InputStream uploadedInputStream, org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail, String sinkPkgUrl, org.apache.pulsar.common.io.SinkConfig sinkConfig)
void	reloadSinks()
void	restartSink(String tenant, String namespace, String sinkName)
void	restartSink(String tenant, String namespace, String sinkName, String instanceId)
void	startSink(String tenant, String namespace, String sinkName)
void	startSink(String tenant, String namespace, String sinkName, String instanceId)
void	stopSink(String tenant, String namespace, String sinkName)
void	stopSink(String tenant, String namespace, String sinkName, String instanceId)
void	updateSink(String tenant, String namespace, String sinkName, InputStream uploadedInputStream, org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail, String sinkPkgUrl, org.apache.pulsar.common.io.SinkConfig sinkConfig, org.apache.pulsar.common.functions.UpdateOptionsImpl updateOptions)

Methods inherited from class org.apache.pulsar.broker.admin.AdminResource

bookKeeper, checkArgument, checkBacklogQuota, checkNotNull, checkNotNull, checkTopicExistsAsync, checkTopicLevelPolicyEnable, clusters, clustersAsync, dispatchRate, domain, fetchPartitionedTopicMetadata, fetchPartitionedTopicMetadataCheckAllowAutoCreation, filterSystemTopic, getNamespacePolicies, getNamespacePolicies, getNamespacePoliciesAsync, getNamespaceReplicatedClusters, getNamespaceReplicatedClustersAsync, getPartitionedTopicList, getPartitionedTopicListAsync, getPartitionedTopicMetadata, getPartitionedTopicMetadataAsync, getPartitionedTopicNotFoundErrorMessage, getSchemaCompatibilityStrategyAsync, getSchemaCompatibilityStrategyAsyncWithoutAuth, getSubNotFoundErrorMessage, getTopicNotFoundErrorMessage, getTopicPartitionList, getTopicPoliciesAsyncWithRetry, getTopicPoliciesAsyncWithRetry, internalCreatePartitionedTopic, internalCreatePartitionedTopic, isLeaderBroker, isManagedLedgerNotFoundException, isNamespaceReplicated, isNotFoundException, isRedirectException, jsonMapper, namespaceBacklogQuota, replicatorDispatchRate, setServletContext, subscribeRate, subscriptionDispatchRate, tryCreateExtendedPartitionsAsync, tryCreatePartitionsAsync, validateAdminAccessForTenant, validateAndGetWorkerService, validateBundleOwnership, validateClusterExists, validateGlobalNamespaceOwnership, validateNamespaceName, validateNamespaceName, validatePartitionedTopicMetadataAsync, validatePartitionedTopicName, validatePersistencePolicies, validatePersistentTopicName, validatePersistentTopicName, validatePoliciesReadOnlyAccess, validatePoliciesReadOnlyAccessAsync, validateSuperUserAccess, validateTopicName, validateTopicName

Methods inherited from class org.apache.pulsar.broker.web.PulsarWebResource

bookieResources, canUpdateCluster, checkAuthorizationAsync, checkLocalOrGetPeerReplicationCluster, checkLocalOrGetPeerReplicationCluster, clientAppId, clientAuthData, clusterResources, config, dynamicConfigurationResources, getClusterDataIfDifferentCluster, getLocalPolicies, getPulsarResources, hasActiveNamespace, hasSuperUserAccess, isBundleOwnedByAnyBroker, isClientAuthenticated, isLeaderBroker, isRequestHttps, namespaceIsolationPolicies, namespaceResources, originalPrincipal, pulsar, resourceGroupResources, resumeAsyncResponseExceptionally, setPulsar, splitPath, sync, tenantResources, topicResources, validateAdminAccessForTenant, validateAdminAccessForTenantAsync, validateAdminAccessForTenantAsync, validateBrokerName, validateBundleOwnership, validateBundleOwnershipAsync, validateClusterForTenant, validateClusterForTenantAsync, validateClusterOwnership, validateClusterOwnershipAsync, validateGlobalNamespaceOwnership, validateGlobalNamespaceOwnershipAsync, validateNamespaceBundleOwnership, validateNamespaceBundleOwnershipAsync, validateNamespaceBundleRange, validateNamespaceOperation, validateNamespaceOperationAsync, validateNamespacePolicyOperation, validateNamespacePolicyOperationAsync, validatePeerClusterConflict, validatePeerClusterConflictAsync, validateSuperUserAccessAsync, validateTenantOperation, validateTenantOperationAsync, validateTopicOperation, validateTopicOperation, validateTopicOperationAsync, validateTopicOperationAsync, validateTopicOwnership, validateTopicOwnershipAsync, validateTopicPolicyOperation, validateTopicPolicyOperationAsync

Methods inherited from class java.lang.Object

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

Constructor Details

SinksBase

public SinksBase()

Method Details

registerSink

@POST
@Path("/{tenant}/{namespace}/{sinkName}")
@Consumes("multipart/form-data")
public void registerSink(@PathParam("tenant")
 String tenant,
 @PathParam("namespace")
 String namespace,
 @PathParam("sinkName")
 String sinkName,
 InputStream uploadedInputStream,
 org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail,
 String sinkPkgUrl,
 org.apache.pulsar.common.io.SinkConfig sinkConfig)

updateSink

@PUT
@Path("/{tenant}/{namespace}/{sinkName}")
@Consumes("multipart/form-data")
public void updateSink(@PathParam("tenant")
 String tenant,
 @PathParam("namespace")
 String namespace,
 @PathParam("sinkName")
 String sinkName,
 InputStream uploadedInputStream,
 org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail,
 String sinkPkgUrl,
 org.apache.pulsar.common.io.SinkConfig sinkConfig,
 org.apache.pulsar.common.functions.UpdateOptionsImpl updateOptions)

deregisterSink

@DELETE
@Path("/{tenant}/{namespace}/{sinkName}")
public void deregisterSink(@PathParam("tenant")
 String tenant,
 @PathParam("namespace")
 String namespace,
 @PathParam("sinkName")
 String sinkName)

getSinkInfo

@GET
@Path("/{tenant}/{namespace}/{sinkName}")
public org.apache.pulsar.common.io.SinkConfig getSinkInfo(@PathParam("tenant")
 String tenant,
 @PathParam("namespace")
 String namespace,
 @PathParam("sinkName")
 String sinkName)
                                                   throws IOException

Throws:

IOException

getSinkInstanceStatus

@GET
@Produces("application/json")
@Path("/{tenant}/{namespace}/{sinkName}/{instanceId}/status")
public org.apache.pulsar.common.policies.data.SinkStatus.SinkInstanceStatus.SinkInstanceStatusData getSinkInstanceStatus(@PathParam("tenant")
 String tenant,
 @PathParam("namespace")
 String namespace,
 @PathParam("sinkName")
 String sinkName,
 @PathParam("instanceId")
 String instanceId)
                                                                                                                  throws IOException

Throws:

IOException

getSinkStatus

@GET
@Produces("application/json")
@Path("/{tenant}/{namespace}/{sinkName}/status")
public org.apache.pulsar.common.policies.data.SinkStatus getSinkStatus(@PathParam("tenant")
 String tenant,
 @PathParam("namespace")
 String namespace,
 @PathParam("sinkName")
 String sinkName)
                                                                throws IOException

Throws:

IOException

listSinks

@GET
@Path("/{tenant}/{namespace}")
public List<String> listSinks(@PathParam("tenant")
 String tenant,
 @PathParam("namespace")
 String namespace)

restartSink

@POST
@Path("/{tenant}/{namespace}/{sinkName}/{instanceId}/restart")
@Consumes("application/json")
public void restartSink(@PathParam("tenant")
 String tenant,
 @PathParam("namespace")
 String namespace,
 @PathParam("sinkName")
 String sinkName,
 @PathParam("instanceId")
 String instanceId)

restartSink

@POST
@Path("/{tenant}/{namespace}/{sinkName}/restart")
@Consumes("application/json")
public void restartSink(@PathParam("tenant")
 String tenant,
 @PathParam("namespace")
 String namespace,
 @PathParam("sinkName")
 String sinkName)

stopSink

@POST
@Path("/{tenant}/{namespace}/{sinkName}/{instanceId}/stop")
@Consumes("application/json")
public void stopSink(@PathParam("tenant")
 String tenant,
 @PathParam("namespace")
 String namespace,
 @PathParam("sinkName")
 String sinkName,
 @PathParam("instanceId")
 String instanceId)

stopSink

@POST
@Path("/{tenant}/{namespace}/{sinkName}/stop")
@Consumes("application/json")
public void stopSink(@PathParam("tenant")
 String tenant,
 @PathParam("namespace")
 String namespace,
 @PathParam("sinkName")
 String sinkName)

startSink

@POST
@Path("/{tenant}/{namespace}/{sinkName}/{instanceId}/start")
@Consumes("application/json")
public void startSink(@PathParam("tenant")
 String tenant,
 @PathParam("namespace")
 String namespace,
 @PathParam("sinkName")
 String sinkName,
 @PathParam("instanceId")
 String instanceId)

startSink

@POST
@Path("/{tenant}/{namespace}/{sinkName}/start")
@Consumes("application/json")
public void startSink(@PathParam("tenant")
 String tenant,
 @PathParam("namespace")
 String namespace,
 @PathParam("sinkName")
 String sinkName)

getSinkList

@GET
@Path("/builtinsinks")
public List<org.apache.pulsar.common.io.ConnectorDefinition> getSinkList()

getSinkConfigDefinition

@GET
@Produces("application/json")
@Path("/builtinsinks/{name}/configdefinition")
public List<org.apache.pulsar.common.io.ConfigFieldDefinition> getSinkConfigDefinition(@PathParam("name")
 String name)
                                                                                throws IOException

Throws:

IOException

reloadSinks

@POST
@Path("/reloadBuiltInSinks")
public void reloadSinks()