frankvicky commented on code in PR #17614: URL: https://github.com/apache/kafka/pull/17614#discussion_r2061153982
########## clients/src/main/java/org/apache/kafka/clients/consumer/CloseOptions.java: ########## @@ -0,0 +1,124 @@ +/* + * 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.kafka.clients.consumer; + +import org.apache.kafka.clients.consumer.internals.ConsumerUtils; + +import java.time.Duration; +import java.util.Objects; +import java.util.Optional; + +public class CloseOptions { + /** + * Enum to specify the group membership operation upon leaving group. + * + * <ul> + * <li><b>{@code LEAVE_GROUP}</b>: means the consumer will leave the group.</li> + * <li><b>{@code REMAIN_IN_GROUP}</b>: means the consumer will remain in the group.</li> + * <li><b>{@code DEFAULT}</b>: Applies the default behavior: + * <ul> + * <li>For <b>static members</b>: The consumer will remain in the group.</li> + * <li>For <b>dynamic members</b>: The consumer will leave the group.</li> + * </ul> + * </li> + * </ul> + */ + public enum GroupMembershipOperation { + LEAVE_GROUP, + REMAIN_IN_GROUP, + DEFAULT + } + + /** + * Specifies the group membership operation upon shutdown. + * By default, {@code GroupMembershipOperation.DEFAULT} will be applied, which follows the consumer's default behavior. + */ + protected GroupMembershipOperation operation = GroupMembershipOperation.DEFAULT; + + /** + * Specifies the maximum amount of time to wait for the close process to complete. + * This allows users to define a custom timeout for gracefully stopping the consumer. + * If no value is set, the default timeout {@link ConsumerUtils#DEFAULT_CLOSE_TIMEOUT_MS} will be applied. + */ + protected Optional<Duration> timeout = Optional.empty(); + + private CloseOptions() { + } + + protected CloseOptions(final CloseOptions option) { Review Comment: Previously, we had an internal class, but we deleted it in development. I will file a patch to remove this constructor. -- 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: jira-unsubscr...@kafka.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
