You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2021/09/14 06:21:55 UTC
[GitHub] [pulsar] 315157973 opened a new pull request #12034: [PIP-92] Part-1: Separate Topic Policies into a separate class
315157973 opened a new pull request #12034:
URL: https://github.com/apache/pulsar/pull/12034
### Motivation
When setting the topic policy for a geo-replicated cluster, some policies want to affect the whole geo-replicated cluster but some only want to affect the local cluster.
https://github.com/apache/pulsar/wiki/PIP-92%3A-Topic-policy-across-multiple-clusters
And I address penghui‘s comment
https://lists.apache.org/thread.html/r1c4be3c3b97618625cc7b3410634b43704e0a290df21b7356a491152%40%3Cdev.pulsar.apache.org%3E
### Modifications
Separate Topic Policies into a separate class
### Verifying this change
### Documentation
doc-required
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] codelipenghui merged pull request #12034: [PIP-92] Part-1: Separate Topic Policies into a separate class
Posted by GitBox <gi...@apache.org>.
codelipenghui merged pull request #12034:
URL: https://github.com/apache/pulsar/pull/12034
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] codelipenghui commented on pull request #12034: [PIP-92] Part-1: Separate Topic Policies into a separate class
Posted by GitBox <gi...@apache.org>.
codelipenghui commented on pull request #12034:
URL: https://github.com/apache/pulsar/pull/12034#issuecomment-938402375
@eolivelli PIP-92 happens earlier than the new PIP process, I think the new PIP process should only affect the new proposals, not the old proposals, so I think we can ship this PR in 2.9.0 since the proposal already send in the dev email channel and after this PR we can continue to improve the topic policy in 2.9.x, otherwise, we need to wait for 2.10
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Anonymitaet commented on a change in pull request #12034: [PIP-92] Part-1: Separate Topic Policies into a separate class
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on a change in pull request #12034:
URL: https://github.com/apache/pulsar/pull/12034#discussion_r708801960
##########
File path: pulsar-client-admin-api/src/main/java/org/apache/pulsar/client/admin/TopicPolicies.java
##########
@@ -0,0 +1,1661 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.pulsar.client.admin;
+
+import java.util.Map;
+import java.util.Set;
+import java.util.concurrent.CompletableFuture;
+import org.apache.pulsar.client.api.SubscriptionType;
+import org.apache.pulsar.common.policies.data.BacklogQuota;
+import org.apache.pulsar.common.policies.data.DelayedDeliveryPolicies;
+import org.apache.pulsar.common.policies.data.DispatchRate;
+import org.apache.pulsar.common.policies.data.InactiveTopicPolicies;
+import org.apache.pulsar.common.policies.data.OffloadPolicies;
+import org.apache.pulsar.common.policies.data.PersistencePolicies;
+import org.apache.pulsar.common.policies.data.PublishRate;
+import org.apache.pulsar.common.policies.data.RetentionPolicies;
+import org.apache.pulsar.common.policies.data.SubscribeRate;
+
+/**
+ * Admin interface for topic policies management.
+ */
+public interface TopicPolicies {
+
+ /**
+ * Get backlog quota map for a topic.
+ * @param topic Topic name
+ * @throws PulsarAdminException.NotFoundException Topic does not exist
+ * @throws PulsarAdminException Unexpected error
+ */
+ Map<BacklogQuota.BacklogQuotaType, BacklogQuota> getBacklogQuotaMap(String topic)
+ throws PulsarAdminException;
+
+ /**
+ * Get applied backlog quota map for a topic.
+ * @param topic
+ * @param applied
+ * @return
+ * @throws PulsarAdminException
+ */
+ Map<BacklogQuota.BacklogQuotaType, BacklogQuota> getBacklogQuotaMap(String topic, boolean applied)
+ throws PulsarAdminException;
+
+ /**
+ * Set a backlog quota for a topic.
+ * @param topic
+ * Topic name
+ * @param backlogQuota
+ * the new BacklogQuota
+ * @param backlogQuotaType
+ *
+ * @throws PulsarAdminException.NotFoundException
+ * Topic does not exist
+ * @throws PulsarAdminException
+ * Unexpected error
+ */
+ void setBacklogQuota(String topic, BacklogQuota backlogQuota,
+ BacklogQuota.BacklogQuotaType backlogQuotaType) throws PulsarAdminException;
+
+ default void setBacklogQuota(String topic, BacklogQuota backlogQuota) throws PulsarAdminException {
+ setBacklogQuota(topic, backlogQuota, BacklogQuota.BacklogQuotaType.destination_storage);
+ }
+
+ /**
+ * Remove a backlog quota policy from a topic.
+ * The namespace backlog policy will fall back to the default.
Review comment:
```suggestion
* The namespace backlog policy falls back to the default.
```
Use present tense in technical writing.
##########
File path: pulsar-client-admin-api/src/main/java/org/apache/pulsar/client/admin/TopicPolicies.java
##########
@@ -0,0 +1,1661 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.pulsar.client.admin;
+
+import java.util.Map;
+import java.util.Set;
+import java.util.concurrent.CompletableFuture;
+import org.apache.pulsar.client.api.SubscriptionType;
+import org.apache.pulsar.common.policies.data.BacklogQuota;
+import org.apache.pulsar.common.policies.data.DelayedDeliveryPolicies;
+import org.apache.pulsar.common.policies.data.DispatchRate;
+import org.apache.pulsar.common.policies.data.InactiveTopicPolicies;
+import org.apache.pulsar.common.policies.data.OffloadPolicies;
+import org.apache.pulsar.common.policies.data.PersistencePolicies;
+import org.apache.pulsar.common.policies.data.PublishRate;
+import org.apache.pulsar.common.policies.data.RetentionPolicies;
+import org.apache.pulsar.common.policies.data.SubscribeRate;
+
+/**
+ * Admin interface for topic policies management.
+ */
+public interface TopicPolicies {
+
+ /**
+ * Get backlog quota map for a topic.
+ * @param topic Topic name
+ * @throws PulsarAdminException.NotFoundException Topic does not exist
+ * @throws PulsarAdminException Unexpected error
+ */
+ Map<BacklogQuota.BacklogQuotaType, BacklogQuota> getBacklogQuotaMap(String topic)
+ throws PulsarAdminException;
+
+ /**
+ * Get applied backlog quota map for a topic.
+ * @param topic
+ * @param applied
+ * @return
+ * @throws PulsarAdminException
+ */
+ Map<BacklogQuota.BacklogQuotaType, BacklogQuota> getBacklogQuotaMap(String topic, boolean applied)
+ throws PulsarAdminException;
+
+ /**
+ * Set a backlog quota for a topic.
+ * @param topic
+ * Topic name
+ * @param backlogQuota
+ * the new BacklogQuota
+ * @param backlogQuotaType
+ *
+ * @throws PulsarAdminException.NotFoundException
+ * Topic does not exist
+ * @throws PulsarAdminException
+ * Unexpected error
+ */
+ void setBacklogQuota(String topic, BacklogQuota backlogQuota,
+ BacklogQuota.BacklogQuotaType backlogQuotaType) throws PulsarAdminException;
+
+ default void setBacklogQuota(String topic, BacklogQuota backlogQuota) throws PulsarAdminException {
+ setBacklogQuota(topic, backlogQuota, BacklogQuota.BacklogQuotaType.destination_storage);
+ }
+
+ /**
+ * Remove a backlog quota policy from a topic.
+ * The namespace backlog policy will fall back to the default.
+ *
+ * @param topic
+ * Topic name
+ * @param backlogQuotaType
+ *
+ * @throws PulsarAdminException.NotFoundException
+ * Topic does not exist
+ * @throws PulsarAdminException
+ * Unexpected error
+ */
+ void removeBacklogQuota(String topic, BacklogQuota.BacklogQuotaType backlogQuotaType) throws PulsarAdminException;
+
+ default void removeBacklogQuota(String topic)
+ throws PulsarAdminException {
+ removeBacklogQuota(topic, BacklogQuota.BacklogQuotaType.destination_storage);
+ }
+
+ /**
+ * Get the delayed delivery policy applied for a specified topic.
+ * @param topic
+ * @param applied
+ * @return
+ * @throws PulsarAdminException
+ */
+ DelayedDeliveryPolicies getDelayedDeliveryPolicy(String topic
+ , boolean applied) throws PulsarAdminException;
+
+ /**
+ * Get the delayed delivery policy applied for a specified topic asynchronously.
+ * @param topic
+ * @param applied
+ * @return
+ */
+ CompletableFuture<DelayedDeliveryPolicies> getDelayedDeliveryPolicyAsync(String topic
+ , boolean applied);
+ /**
+ * Get the delayed delivery policy for a specified topic.
+ * @param topic
+ * @return
+ * @throws PulsarAdminException
+ */
+ DelayedDeliveryPolicies getDelayedDeliveryPolicy(String topic) throws PulsarAdminException;
+
+ /**
+ * Get the delayed delivery policy for a specified topic asynchronously.
+ * @param topic
+ * @return
+ */
+ CompletableFuture<DelayedDeliveryPolicies> getDelayedDeliveryPolicyAsync(String topic);
+
+ /**
+ * Set the delayed delivery policy for a specified topic.
+ * @param topic
+ * @param delayedDeliveryPolicies
+ * @throws PulsarAdminException
+ */
+ void setDelayedDeliveryPolicy(String topic
+ , DelayedDeliveryPolicies delayedDeliveryPolicies) throws PulsarAdminException;
+
+ /**
+ * Set the delayed delivery policy for a specified topic asynchronously.
+ * @param topic
+ * @param delayedDeliveryPolicies
+ * @return
+ */
+ CompletableFuture<Void> setDelayedDeliveryPolicyAsync(String topic
+ , DelayedDeliveryPolicies delayedDeliveryPolicies);
+
+ /**
+ * Remove the delayed delivery policy for a specified topic asynchronously.
+ * @param topic
+ * @return
+ */
+ CompletableFuture<Void> removeDelayedDeliveryPolicyAsync(String topic);
+
+ /**
+ * Remove the delayed delivery policy for a specified topic.
+ * @param topic
+ * @throws PulsarAdminException
+ */
+ void removeDelayedDeliveryPolicy(String topic) throws PulsarAdminException;
+
+ /**
+ * Set message TTL for a topic.
+ *
+ * @param topic
+ * Topic name
+ * @param messageTTLInSecond
+ * Message TTL in second.
+ * @throws NotAuthorizedException
+ * Don't have admin permission
+ * @throws PulsarAdminException.NotFoundException
+ * Topic does not exist
+ * @throws PulsarAdminException
+ * Unexpected error
+ */
+ void setMessageTTL(String topic, int messageTTLInSecond) throws PulsarAdminException;
+
+ /**
+ * Get message TTL for a topic.
+ *
+ * @param topic
+ * @return Message TTL in second.
+ * @throws NotAuthorizedException
+ * Don't have admin permission
+ * @throws PulsarAdminException.NotFoundException
+ * Topic does not exist
+ * @throws PulsarAdminException
+ * Unexpected error
+ */
+ Integer getMessageTTL(String topic) throws PulsarAdminException;
+
+ /**
+ * Get message TTL applied for a topic.
+ * @param topic
+ * @return
+ * @throws PulsarAdminException
+ */
+ Integer getMessageTTL(String topic, boolean applied) throws PulsarAdminException;
+
+ /**
+ * Remove message TTL for a topic.
+ *
+ * @param topic
+ * @throws NotAuthorizedException
+ * Don't have admin permission
+ * @throws PulsarAdminException.NotFoundException
+ * Topic does not exist
+ * @throws PulsarAdminException
+ * Unexpected error
+ */
+ void removeMessageTTL(String topic) throws PulsarAdminException;
+
+ /**
+ * Set the retention configuration on a topic.
+ * <p/>
+ * Set the retention configuration on a topic. This operation requires Pulsar super-user access.
+ * <p/>
+ * Request parameter example:
+ * <p/>
+ *
+ * <pre>
+ * <code>
+ * {
+ * "retentionTimeInMinutes" : 60, // how long to retain messages
+ * "retentionSizeInMB" : 1024, // retention backlog limit
+ * }
+ * </code>
+ * </pre>
+ *
+ * @param topic
+ * Topic name
+ *
+ * @throws NotAuthorizedException
+ * Don't have admin permission
+ * @throws PulsarAdminException.NotFoundException
+ * Topic does not exist
+ * @throws ConflictException
+ * Concurrent modification
+ * @throws PulsarAdminException
+ * Unexpected error
+ */
+ void setRetention(String topic, RetentionPolicies retention) throws PulsarAdminException;
+
+ /**
+ * Set the retention configuration for all the topics on a topic asynchronously.
+ * <p/>
+ * Set the retention configuration on a topic. This operation requires Pulsar super-user access.
+ * <p/>
+ * Request parameter example:
+ * <p/>
+ *
+ * <pre>
+ * <code>
+ * {
+ * "retentionTimeInMinutes" : 60, // how long to retain messages
+ * "retentionSizeInMB" : 1024, // retention backlog limit
+ * }
+ * </code>
+ * </pre>
+ *
+ * @param topic
+ * Topic name
+ */
+ CompletableFuture<Void> setRetentionAsync(String topic, RetentionPolicies retention);
+
+ /**
+ * Get the retention configuration for a topic.
+ * <p/>
+ * Get the retention configuration for a topic.
+ * <p/>
+ * Response example:
+ * <p/>
+ *
+ * <pre>
+ * <code>
+ * {
+ * "retentionTimeInMinutes" : 60, // how long to retain messages
+ * "retentionSizeInMB" : 1024, // retention backlog limit
+ * }
+ * </code>
+ * </pre>
+ *
+ * @param topic
+ * Topic name
+ * @throws NotAuthorizedException
+ * Don't have admin permission
+ * @throws PulsarAdminException.NotFoundException
+ * Topic does not exist
+ * @throws ConflictException
+ * Concurrent modification
+ * @throws PulsarAdminException
+ * Unexpected error
+ */
+ RetentionPolicies getRetention(String topic) throws PulsarAdminException;
+
+ /**
+ * Get the retention configuration for a topic asynchronously.
+ * <p/>
+ * Get the retention configuration for a topic.
+ * <p/>
+ *
+ * @param topic
+ * Topic name
+ */
+ CompletableFuture<RetentionPolicies> getRetentionAsync(String topic);
+
+ /**
+ * Get the applied retention configuration for a topic.
+ * @param topic
+ * @param applied
+ * @return
+ * @throws PulsarAdminException
+ */
+ RetentionPolicies getRetention(String topic, boolean applied) throws PulsarAdminException;
+
+ /**
+ * Get the applied retention configuration for a topic asynchronously.
+ * @param topic
+ * @param applied
+ * @return
+ */
+ CompletableFuture<RetentionPolicies> getRetentionAsync(String topic, boolean applied);
+
+ /**
+ * Remove the retention configuration for all the topics on a topic.
+ * <p/>
+ * Remove the retention configuration on a topic. This operation requires Pulsar super-user access.
+ * <p/>
+ * Request parameter example:
+ * <p/>
+ *
+ * @param topic
+ * Topic name
+ *
+ * @throws NotAuthorizedException
+ * Don't have admin permission
+ * @throws PulsarAdminException.NotFoundException
+ * Topic does not exist
+ * @throws ConflictException
+ * Concurrent modification
+ * @throws PulsarAdminException
+ * Unexpected error
+ */
+ void removeRetention(String topic) throws PulsarAdminException;
+
+ /**
+ * Remove the retention configuration for all the topics on a topic asynchronously.
+ * <p/>
+ * Remove the retention configuration on a topic. This operation requires Pulsar super-user access.
+ * <p/>
+ * Request parameter example:
+ * <p/>
+ *
+ * <pre>
+ * <code>
+ * {
+ * "retentionTimeInMinutes" : 60, // how long to retain messages
+ * "retentionSizeInMB" : 1024, // retention backlog limit
+ * }
+ * </code>
+ * </pre>
+ *
+ * @param topic
+ * Topic name
+ */
+ CompletableFuture<Void> removeRetentionAsync(String topic);
+
+ /**
+ * get max unacked messages on consumer of a topic.
Review comment:
"a consumer" or "consumers"? Please update and check all occurrences.
##########
File path: pulsar-client-admin-api/src/main/java/org/apache/pulsar/client/admin/TopicPolicies.java
##########
@@ -0,0 +1,1661 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.pulsar.client.admin;
+
+import java.util.Map;
+import java.util.Set;
+import java.util.concurrent.CompletableFuture;
+import org.apache.pulsar.client.api.SubscriptionType;
+import org.apache.pulsar.common.policies.data.BacklogQuota;
+import org.apache.pulsar.common.policies.data.DelayedDeliveryPolicies;
+import org.apache.pulsar.common.policies.data.DispatchRate;
+import org.apache.pulsar.common.policies.data.InactiveTopicPolicies;
+import org.apache.pulsar.common.policies.data.OffloadPolicies;
+import org.apache.pulsar.common.policies.data.PersistencePolicies;
+import org.apache.pulsar.common.policies.data.PublishRate;
+import org.apache.pulsar.common.policies.data.RetentionPolicies;
+import org.apache.pulsar.common.policies.data.SubscribeRate;
+
+/**
+ * Admin interface for topic policies management.
+ */
+public interface TopicPolicies {
+
+ /**
+ * Get backlog quota map for a topic.
+ * @param topic Topic name
+ * @throws PulsarAdminException.NotFoundException Topic does not exist
+ * @throws PulsarAdminException Unexpected error
+ */
+ Map<BacklogQuota.BacklogQuotaType, BacklogQuota> getBacklogQuotaMap(String topic)
+ throws PulsarAdminException;
+
+ /**
+ * Get applied backlog quota map for a topic.
+ * @param topic
+ * @param applied
+ * @return
+ * @throws PulsarAdminException
+ */
+ Map<BacklogQuota.BacklogQuotaType, BacklogQuota> getBacklogQuotaMap(String topic, boolean applied)
+ throws PulsarAdminException;
+
+ /**
+ * Set a backlog quota for a topic.
+ * @param topic
+ * Topic name
+ * @param backlogQuota
+ * the new BacklogQuota
+ * @param backlogQuotaType
+ *
+ * @throws PulsarAdminException.NotFoundException
+ * Topic does not exist
+ * @throws PulsarAdminException
+ * Unexpected error
+ */
+ void setBacklogQuota(String topic, BacklogQuota backlogQuota,
+ BacklogQuota.BacklogQuotaType backlogQuotaType) throws PulsarAdminException;
+
+ default void setBacklogQuota(String topic, BacklogQuota backlogQuota) throws PulsarAdminException {
+ setBacklogQuota(topic, backlogQuota, BacklogQuota.BacklogQuotaType.destination_storage);
+ }
+
+ /**
+ * Remove a backlog quota policy from a topic.
+ * The namespace backlog policy will fall back to the default.
+ *
+ * @param topic
+ * Topic name
+ * @param backlogQuotaType
+ *
+ * @throws PulsarAdminException.NotFoundException
+ * Topic does not exist
+ * @throws PulsarAdminException
+ * Unexpected error
+ */
+ void removeBacklogQuota(String topic, BacklogQuota.BacklogQuotaType backlogQuotaType) throws PulsarAdminException;
+
+ default void removeBacklogQuota(String topic)
+ throws PulsarAdminException {
+ removeBacklogQuota(topic, BacklogQuota.BacklogQuotaType.destination_storage);
+ }
+
+ /**
+ * Get the delayed delivery policy applied for a specified topic.
+ * @param topic
+ * @param applied
+ * @return
+ * @throws PulsarAdminException
+ */
+ DelayedDeliveryPolicies getDelayedDeliveryPolicy(String topic
+ , boolean applied) throws PulsarAdminException;
+
+ /**
+ * Get the delayed delivery policy applied for a specified topic asynchronously.
+ * @param topic
+ * @param applied
+ * @return
+ */
+ CompletableFuture<DelayedDeliveryPolicies> getDelayedDeliveryPolicyAsync(String topic
+ , boolean applied);
+ /**
+ * Get the delayed delivery policy for a specified topic.
+ * @param topic
+ * @return
+ * @throws PulsarAdminException
+ */
+ DelayedDeliveryPolicies getDelayedDeliveryPolicy(String topic) throws PulsarAdminException;
+
+ /**
+ * Get the delayed delivery policy for a specified topic asynchronously.
+ * @param topic
+ * @return
+ */
+ CompletableFuture<DelayedDeliveryPolicies> getDelayedDeliveryPolicyAsync(String topic);
+
+ /**
+ * Set the delayed delivery policy for a specified topic.
+ * @param topic
+ * @param delayedDeliveryPolicies
+ * @throws PulsarAdminException
+ */
+ void setDelayedDeliveryPolicy(String topic
+ , DelayedDeliveryPolicies delayedDeliveryPolicies) throws PulsarAdminException;
+
+ /**
+ * Set the delayed delivery policy for a specified topic asynchronously.
+ * @param topic
+ * @param delayedDeliveryPolicies
+ * @return
+ */
+ CompletableFuture<Void> setDelayedDeliveryPolicyAsync(String topic
+ , DelayedDeliveryPolicies delayedDeliveryPolicies);
+
+ /**
+ * Remove the delayed delivery policy for a specified topic asynchronously.
+ * @param topic
+ * @return
+ */
+ CompletableFuture<Void> removeDelayedDeliveryPolicyAsync(String topic);
+
+ /**
+ * Remove the delayed delivery policy for a specified topic.
+ * @param topic
+ * @throws PulsarAdminException
+ */
+ void removeDelayedDeliveryPolicy(String topic) throws PulsarAdminException;
+
+ /**
+ * Set message TTL for a topic.
+ *
+ * @param topic
+ * Topic name
+ * @param messageTTLInSecond
+ * Message TTL in second.
+ * @throws NotAuthorizedException
+ * Don't have admin permission
+ * @throws PulsarAdminException.NotFoundException
+ * Topic does not exist
+ * @throws PulsarAdminException
+ * Unexpected error
+ */
+ void setMessageTTL(String topic, int messageTTLInSecond) throws PulsarAdminException;
+
+ /**
+ * Get message TTL for a topic.
+ *
+ * @param topic
+ * @return Message TTL in second.
+ * @throws NotAuthorizedException
+ * Don't have admin permission
+ * @throws PulsarAdminException.NotFoundException
+ * Topic does not exist
+ * @throws PulsarAdminException
+ * Unexpected error
+ */
+ Integer getMessageTTL(String topic) throws PulsarAdminException;
+
+ /**
+ * Get message TTL applied for a topic.
+ * @param topic
+ * @return
+ * @throws PulsarAdminException
+ */
+ Integer getMessageTTL(String topic, boolean applied) throws PulsarAdminException;
+
+ /**
+ * Remove message TTL for a topic.
+ *
+ * @param topic
+ * @throws NotAuthorizedException
+ * Don't have admin permission
+ * @throws PulsarAdminException.NotFoundException
+ * Topic does not exist
+ * @throws PulsarAdminException
+ * Unexpected error
+ */
+ void removeMessageTTL(String topic) throws PulsarAdminException;
+
+ /**
+ * Set the retention configuration on a topic.
+ * <p/>
+ * Set the retention configuration on a topic. This operation requires Pulsar super-user access.
+ * <p/>
+ * Request parameter example:
+ * <p/>
+ *
+ * <pre>
+ * <code>
+ * {
+ * "retentionTimeInMinutes" : 60, // how long to retain messages
+ * "retentionSizeInMB" : 1024, // retention backlog limit
+ * }
+ * </code>
+ * </pre>
+ *
+ * @param topic
+ * Topic name
+ *
+ * @throws NotAuthorizedException
+ * Don't have admin permission
+ * @throws PulsarAdminException.NotFoundException
+ * Topic does not exist
+ * @throws ConflictException
+ * Concurrent modification
+ * @throws PulsarAdminException
+ * Unexpected error
+ */
+ void setRetention(String topic, RetentionPolicies retention) throws PulsarAdminException;
+
+ /**
+ * Set the retention configuration for all the topics on a topic asynchronously.
+ * <p/>
+ * Set the retention configuration on a topic. This operation requires Pulsar super-user access.
+ * <p/>
+ * Request parameter example:
+ * <p/>
+ *
+ * <pre>
+ * <code>
+ * {
+ * "retentionTimeInMinutes" : 60, // how long to retain messages
+ * "retentionSizeInMB" : 1024, // retention backlog limit
+ * }
+ * </code>
+ * </pre>
+ *
+ * @param topic
+ * Topic name
+ */
+ CompletableFuture<Void> setRetentionAsync(String topic, RetentionPolicies retention);
+
+ /**
+ * Get the retention configuration for a topic.
+ * <p/>
+ * Get the retention configuration for a topic.
+ * <p/>
+ * Response example:
+ * <p/>
+ *
+ * <pre>
+ * <code>
+ * {
+ * "retentionTimeInMinutes" : 60, // how long to retain messages
+ * "retentionSizeInMB" : 1024, // retention backlog limit
+ * }
+ * </code>
+ * </pre>
+ *
+ * @param topic
+ * Topic name
+ * @throws NotAuthorizedException
+ * Don't have admin permission
+ * @throws PulsarAdminException.NotFoundException
+ * Topic does not exist
+ * @throws ConflictException
+ * Concurrent modification
+ * @throws PulsarAdminException
+ * Unexpected error
+ */
+ RetentionPolicies getRetention(String topic) throws PulsarAdminException;
+
+ /**
+ * Get the retention configuration for a topic asynchronously.
+ * <p/>
+ * Get the retention configuration for a topic.
+ * <p/>
+ *
+ * @param topic
+ * Topic name
+ */
+ CompletableFuture<RetentionPolicies> getRetentionAsync(String topic);
+
+ /**
+ * Get the applied retention configuration for a topic.
+ * @param topic
+ * @param applied
+ * @return
+ * @throws PulsarAdminException
+ */
+ RetentionPolicies getRetention(String topic, boolean applied) throws PulsarAdminException;
+
+ /**
+ * Get the applied retention configuration for a topic asynchronously.
+ * @param topic
+ * @param applied
+ * @return
+ */
+ CompletableFuture<RetentionPolicies> getRetentionAsync(String topic, boolean applied);
+
+ /**
+ * Remove the retention configuration for all the topics on a topic.
+ * <p/>
+ * Remove the retention configuration on a topic. This operation requires Pulsar super-user access.
+ * <p/>
+ * Request parameter example:
+ * <p/>
+ *
+ * @param topic
+ * Topic name
+ *
+ * @throws NotAuthorizedException
+ * Don't have admin permission
+ * @throws PulsarAdminException.NotFoundException
+ * Topic does not exist
+ * @throws ConflictException
+ * Concurrent modification
+ * @throws PulsarAdminException
+ * Unexpected error
+ */
+ void removeRetention(String topic) throws PulsarAdminException;
+
+ /**
+ * Remove the retention configuration for all the topics on a topic asynchronously.
+ * <p/>
+ * Remove the retention configuration on a topic. This operation requires Pulsar super-user access.
+ * <p/>
+ * Request parameter example:
+ * <p/>
+ *
+ * <pre>
+ * <code>
+ * {
+ * "retentionTimeInMinutes" : 60, // how long to retain messages
+ * "retentionSizeInMB" : 1024, // retention backlog limit
+ * }
+ * </code>
+ * </pre>
+ *
+ * @param topic
+ * Topic name
+ */
+ CompletableFuture<Void> removeRetentionAsync(String topic);
+
+ /**
+ * get max unacked messages on consumer of a topic.
Review comment:
Capitalize the 1st letter of the 1st word in a sentence. Please update all occurrences.
##########
File path: pulsar-client-admin-api/src/main/java/org/apache/pulsar/client/admin/TopicPolicies.java
##########
@@ -0,0 +1,1661 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.pulsar.client.admin;
+
+import java.util.Map;
+import java.util.Set;
+import java.util.concurrent.CompletableFuture;
+import org.apache.pulsar.client.api.SubscriptionType;
+import org.apache.pulsar.common.policies.data.BacklogQuota;
+import org.apache.pulsar.common.policies.data.DelayedDeliveryPolicies;
+import org.apache.pulsar.common.policies.data.DispatchRate;
+import org.apache.pulsar.common.policies.data.InactiveTopicPolicies;
+import org.apache.pulsar.common.policies.data.OffloadPolicies;
+import org.apache.pulsar.common.policies.data.PersistencePolicies;
+import org.apache.pulsar.common.policies.data.PublishRate;
+import org.apache.pulsar.common.policies.data.RetentionPolicies;
+import org.apache.pulsar.common.policies.data.SubscribeRate;
+
+/**
+ * Admin interface for topic policies management.
+ */
+public interface TopicPolicies {
+
+ /**
+ * Get backlog quota map for a topic.
+ * @param topic Topic name
+ * @throws PulsarAdminException.NotFoundException Topic does not exist
+ * @throws PulsarAdminException Unexpected error
+ */
+ Map<BacklogQuota.BacklogQuotaType, BacklogQuota> getBacklogQuotaMap(String topic)
+ throws PulsarAdminException;
+
+ /**
+ * Get applied backlog quota map for a topic.
+ * @param topic
+ * @param applied
+ * @return
+ * @throws PulsarAdminException
+ */
+ Map<BacklogQuota.BacklogQuotaType, BacklogQuota> getBacklogQuotaMap(String topic, boolean applied)
+ throws PulsarAdminException;
+
+ /**
+ * Set a backlog quota for a topic.
+ * @param topic
+ * Topic name
+ * @param backlogQuota
+ * the new BacklogQuota
+ * @param backlogQuotaType
+ *
+ * @throws PulsarAdminException.NotFoundException
+ * Topic does not exist
+ * @throws PulsarAdminException
+ * Unexpected error
+ */
+ void setBacklogQuota(String topic, BacklogQuota backlogQuota,
+ BacklogQuota.BacklogQuotaType backlogQuotaType) throws PulsarAdminException;
+
+ default void setBacklogQuota(String topic, BacklogQuota backlogQuota) throws PulsarAdminException {
+ setBacklogQuota(topic, backlogQuota, BacklogQuota.BacklogQuotaType.destination_storage);
+ }
+
+ /**
+ * Remove a backlog quota policy from a topic.
+ * The namespace backlog policy will fall back to the default.
+ *
+ * @param topic
+ * Topic name
+ * @param backlogQuotaType
+ *
+ * @throws PulsarAdminException.NotFoundException
+ * Topic does not exist
+ * @throws PulsarAdminException
+ * Unexpected error
+ */
+ void removeBacklogQuota(String topic, BacklogQuota.BacklogQuotaType backlogQuotaType) throws PulsarAdminException;
+
+ default void removeBacklogQuota(String topic)
+ throws PulsarAdminException {
+ removeBacklogQuota(topic, BacklogQuota.BacklogQuotaType.destination_storage);
+ }
+
+ /**
+ * Get the delayed delivery policy applied for a specified topic.
+ * @param topic
+ * @param applied
+ * @return
+ * @throws PulsarAdminException
+ */
+ DelayedDeliveryPolicies getDelayedDeliveryPolicy(String topic
+ , boolean applied) throws PulsarAdminException;
+
+ /**
+ * Get the delayed delivery policy applied for a specified topic asynchronously.
+ * @param topic
+ * @param applied
+ * @return
+ */
+ CompletableFuture<DelayedDeliveryPolicies> getDelayedDeliveryPolicyAsync(String topic
+ , boolean applied);
+ /**
+ * Get the delayed delivery policy for a specified topic.
+ * @param topic
+ * @return
+ * @throws PulsarAdminException
+ */
+ DelayedDeliveryPolicies getDelayedDeliveryPolicy(String topic) throws PulsarAdminException;
+
+ /**
+ * Get the delayed delivery policy for a specified topic asynchronously.
+ * @param topic
+ * @return
+ */
+ CompletableFuture<DelayedDeliveryPolicies> getDelayedDeliveryPolicyAsync(String topic);
+
+ /**
+ * Set the delayed delivery policy for a specified topic.
+ * @param topic
+ * @param delayedDeliveryPolicies
+ * @throws PulsarAdminException
+ */
+ void setDelayedDeliveryPolicy(String topic
+ , DelayedDeliveryPolicies delayedDeliveryPolicies) throws PulsarAdminException;
+
+ /**
+ * Set the delayed delivery policy for a specified topic asynchronously.
+ * @param topic
+ * @param delayedDeliveryPolicies
+ * @return
+ */
+ CompletableFuture<Void> setDelayedDeliveryPolicyAsync(String topic
+ , DelayedDeliveryPolicies delayedDeliveryPolicies);
+
+ /**
+ * Remove the delayed delivery policy for a specified topic asynchronously.
+ * @param topic
+ * @return
+ */
+ CompletableFuture<Void> removeDelayedDeliveryPolicyAsync(String topic);
+
+ /**
+ * Remove the delayed delivery policy for a specified topic.
+ * @param topic
+ * @throws PulsarAdminException
+ */
+ void removeDelayedDeliveryPolicy(String topic) throws PulsarAdminException;
+
+ /**
+ * Set message TTL for a topic.
+ *
+ * @param topic
+ * Topic name
+ * @param messageTTLInSecond
+ * Message TTL in second.
+ * @throws NotAuthorizedException
+ * Don't have admin permission
+ * @throws PulsarAdminException.NotFoundException
+ * Topic does not exist
+ * @throws PulsarAdminException
+ * Unexpected error
+ */
+ void setMessageTTL(String topic, int messageTTLInSecond) throws PulsarAdminException;
+
+ /**
+ * Get message TTL for a topic.
+ *
+ * @param topic
+ * @return Message TTL in second.
+ * @throws NotAuthorizedException
+ * Don't have admin permission
+ * @throws PulsarAdminException.NotFoundException
+ * Topic does not exist
+ * @throws PulsarAdminException
+ * Unexpected error
+ */
+ Integer getMessageTTL(String topic) throws PulsarAdminException;
+
+ /**
+ * Get message TTL applied for a topic.
+ * @param topic
+ * @return
+ * @throws PulsarAdminException
+ */
+ Integer getMessageTTL(String topic, boolean applied) throws PulsarAdminException;
+
+ /**
+ * Remove message TTL for a topic.
+ *
+ * @param topic
+ * @throws NotAuthorizedException
+ * Don't have admin permission
+ * @throws PulsarAdminException.NotFoundException
+ * Topic does not exist
+ * @throws PulsarAdminException
+ * Unexpected error
+ */
+ void removeMessageTTL(String topic) throws PulsarAdminException;
+
+ /**
+ * Set the retention configuration on a topic.
+ * <p/>
+ * Set the retention configuration on a topic. This operation requires Pulsar super-user access.
+ * <p/>
+ * Request parameter example:
+ * <p/>
+ *
+ * <pre>
+ * <code>
+ * {
+ * "retentionTimeInMinutes" : 60, // how long to retain messages
+ * "retentionSizeInMB" : 1024, // retention backlog limit
+ * }
+ * </code>
+ * </pre>
+ *
+ * @param topic
+ * Topic name
+ *
+ * @throws NotAuthorizedException
+ * Don't have admin permission
+ * @throws PulsarAdminException.NotFoundException
+ * Topic does not exist
+ * @throws ConflictException
+ * Concurrent modification
+ * @throws PulsarAdminException
+ * Unexpected error
+ */
+ void setRetention(String topic, RetentionPolicies retention) throws PulsarAdminException;
+
+ /**
+ * Set the retention configuration for all the topics on a topic asynchronously.
+ * <p/>
+ * Set the retention configuration on a topic. This operation requires Pulsar super-user access.
+ * <p/>
+ * Request parameter example:
+ * <p/>
+ *
+ * <pre>
+ * <code>
+ * {
+ * "retentionTimeInMinutes" : 60, // how long to retain messages
+ * "retentionSizeInMB" : 1024, // retention backlog limit
+ * }
+ * </code>
+ * </pre>
+ *
+ * @param topic
+ * Topic name
+ */
+ CompletableFuture<Void> setRetentionAsync(String topic, RetentionPolicies retention);
+
+ /**
+ * Get the retention configuration for a topic.
+ * <p/>
+ * Get the retention configuration for a topic.
+ * <p/>
+ * Response example:
+ * <p/>
+ *
+ * <pre>
+ * <code>
+ * {
+ * "retentionTimeInMinutes" : 60, // how long to retain messages
+ * "retentionSizeInMB" : 1024, // retention backlog limit
+ * }
+ * </code>
+ * </pre>
+ *
+ * @param topic
+ * Topic name
+ * @throws NotAuthorizedException
+ * Don't have admin permission
+ * @throws PulsarAdminException.NotFoundException
+ * Topic does not exist
+ * @throws ConflictException
+ * Concurrent modification
+ * @throws PulsarAdminException
+ * Unexpected error
+ */
+ RetentionPolicies getRetention(String topic) throws PulsarAdminException;
+
+ /**
+ * Get the retention configuration for a topic asynchronously.
+ * <p/>
+ * Get the retention configuration for a topic.
+ * <p/>
+ *
+ * @param topic
+ * Topic name
+ */
+ CompletableFuture<RetentionPolicies> getRetentionAsync(String topic);
+
+ /**
+ * Get the applied retention configuration for a topic.
+ * @param topic
+ * @param applied
+ * @return
+ * @throws PulsarAdminException
+ */
+ RetentionPolicies getRetention(String topic, boolean applied) throws PulsarAdminException;
+
+ /**
+ * Get the applied retention configuration for a topic asynchronously.
+ * @param topic
+ * @param applied
+ * @return
+ */
+ CompletableFuture<RetentionPolicies> getRetentionAsync(String topic, boolean applied);
+
+ /**
+ * Remove the retention configuration for all the topics on a topic.
+ * <p/>
+ * Remove the retention configuration on a topic. This operation requires Pulsar super-user access.
+ * <p/>
+ * Request parameter example:
+ * <p/>
+ *
+ * @param topic
+ * Topic name
+ *
+ * @throws NotAuthorizedException
+ * Don't have admin permission
+ * @throws PulsarAdminException.NotFoundException
+ * Topic does not exist
+ * @throws ConflictException
+ * Concurrent modification
+ * @throws PulsarAdminException
+ * Unexpected error
+ */
+ void removeRetention(String topic) throws PulsarAdminException;
+
+ /**
+ * Remove the retention configuration for all the topics on a topic asynchronously.
+ * <p/>
+ * Remove the retention configuration on a topic. This operation requires Pulsar super-user access.
+ * <p/>
+ * Request parameter example:
+ * <p/>
+ *
+ * <pre>
+ * <code>
+ * {
+ * "retentionTimeInMinutes" : 60, // how long to retain messages
+ * "retentionSizeInMB" : 1024, // retention backlog limit
+ * }
+ * </code>
+ * </pre>
+ *
+ * @param topic
+ * Topic name
+ */
+ CompletableFuture<Void> removeRetentionAsync(String topic);
+
+ /**
+ * get max unacked messages on consumer of a topic.
Review comment:
```suggestion
* Get max unacked messages on a consumer of a topic.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] codelipenghui commented on pull request #12034: [PIP-92] Part-1: Separate Topic Policies into a separate class
Posted by GitBox <gi...@apache.org>.
codelipenghui commented on pull request #12034:
URL: https://github.com/apache/pulsar/pull/12034#issuecomment-938406520
Have a conversation with @eolivelli in the Slack channel, we agree to contain this PR in 2.9.0 so I have moved the milestone to 2.9 and merged it for now.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org