[
https://issues.apache.org/jira/browse/KAFKA-20126?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=18056906#comment-18056906
]
黃竣陽 commented on KAFKA-20126:
-----------------------------
I have organized the missing public classes and will break the work down into
module-based subtasks.
|module|sub module|class|
|org.apache.kafka.clients.admin| |AbortTransactionOptions|
| | |AbortTransactionSpec|
| | |AbstractOptions|
| | |AbstractOptions<T extends AbstractOptions>|
| | |AddRaftVoterOptions|
| | |Admin|
| | |AdminClientConfig|
| | |AlterConfigOp|
| | |AlterConfigOp.OpType|
| | |ClassicGroupDescription|
| | |ClientMetricsResourceListing|
| | |Config|
| | |ConsumerGroupDescription|
| | |CreateDelegationTokenOptions|
| | |CreateTopicsResult.TopicMetadataAndConfig|
| | |DeleteRecordsResult|
| | |DeleteTopicsResult|
| | |DescribeClassicGroupsOptions|
| | |DescribeClassicGroupsResult|
| | |DescribeClusterOptions|
| | |DescribeConsumerGroupsResult|
| | |DescribeDelegationTokenOptions|
| | |DescribeFeaturesResult|
| | |DescribeProducersOptions|
| | |DescribeProducersResult|
| | |DescribeProducersResult.PartitionProducerState|
| | |DescribeReplicaLogDirsResult.ReplicaLogDirInfo|
| | |DescribeShareGroupsOptions|
| | |DescribeShareGroupsResult|
| | |DescribeStreamsGroupsOptions|
| | |DescribeStreamsGroupsResult|
| | |DescribeTopicsOptions|
| | |DescribeTopicsResult|
| | |DescribeTransactionsResult|
| | |DescribeUserScramCredentialsResult|
| | |EndpointType|
| | |ExpireDelegationTokenOptions|
| | |FeatureUpdate|
| | |FeatureUpdate.UpgradeType|
| | |FinalizedVersionRange|
| | |ForwardingAdmin|
| | |KafkaAdminClient|
| | |ListConsumerGroupOffsetsOptions|
| | |ListConsumerGroupsOptions|
| | |ListOffsetsOptions|
| | |ListOffsetsResult|
| | |ListOffsetsResultInfo|
| | |ListStreamsGroupOffsetsOptions|
| | |MemberDescription|
| | |MemberToRemove|
| | |NewPartitionReassignment|
| | |OffsetSpec.EarliestLocalSpec|
| | |OffsetSpec.EarliestSpec|
| | |OffsetSpec.LatestSpec|
| | |OffsetSpec.LatestTieredSpec|
| | |OffsetSpec.MaxTimestampSpec|
| | |OffsetSpec.TimestampSpec|
| | |PartitionReassignment|
| | |ProducerState|
| | |QuorumInfo|
| | |QuorumInfo.Node|
| | |QuorumInfo.ReplicaState|
| | |RaftVoterEndpoint|
| | |RemoveMembersFromConsumerGroupOptions|
| | |RemoveRaftVoterOptions|
| | |RenewDelegationTokenOptions|
| | |ReplicaInfo|
| | |ScramCredentialInfo|
| | |ScramMechanism|
| | |ShareGroupDescription|
| | |ShareMemberDescription|
| | |StreamsGroupDescription|
| | |StreamsGroupMemberAssignment|
| | |StreamsGroupMemberAssignment.TaskIds|
| | |StreamsGroupMemberDescription|
| | |StreamsGroupMemberDescription.Endpoint|
| | |StreamsGroupMemberDescription.TaskOffset|
| | |StreamsGroupSubtopologyDescription|
| | |StreamsGroupSubtopologyDescription|
| | |SupportedVersionRange|
| | |TopicDescription|
| | |TransactionDescription|
| | |TransactionListing|
| | |TransactionState|
| | |UpdateFeaturesOptions|
| | |UpdateFeaturesResult|
| | |UserScramCredentialAlteration|
| | |UserScramCredentialDeletion|
| | |UserScramCredentialsDescription|
| | |UserScramCredentialsDescription|
| | | |
|org.apache.kafka.clients.consumer| |AcknowledgeType|
| | |CloseOptions|
| | |CommitFailedException|
| | |Consumer<K,V>|
| | |ConsumerConfig|
| | |ConsumerGroupMetadata|
| | |ConsumerPartitionAssignor.Assignment|
| | |ConsumerPartitionAssignor.GroupAssignment|
| | |ConsumerPartitionAssignor.GroupSubscription|
| | |ConsumerPartitionAssignor.RebalanceProtocol|
| | |ConsumerPartitionAssignor.Subscription|
| | |ConsumerRecords<K,V>|
| | |CooperativeStickyAssignor|
| | |GroupProtocol|
| | |InvalidOffsetException|
| | |KafkaConsumer<K,V>|
| | |LogTruncationException|
| | |MockConsumer<K,V>|
| | |MockShareConsumer<K,V>|
| | |NoOffsetForPartitionException|
| | |OffsetAndMetadata|
| | |OffsetAndTimestamp|
| | |OffsetOutOfRangeException|
| | |OffsetResetStrategy|
| | |RangeAssignor|
| | |RetriableCommitFailedException|
| | |RoundRobinAssignor|
| | |ShareConsumer<K,V>|
| | |SubscriptionPattern|
| | | |
|org.apache.kafka.clients.producer| |BufferExhaustedException|
| | |MockProducer<K,V>|
| | |PreparedTxnState|
| | |Producer<K,V>|
| | |ProducerConfig|
| | | |
|org.apache.kafka.common| |Cluster|
| | |Endpoint|
| | |GroupState|
| | |GroupType|
| | |InvalidRecordException|
| | |IsolationLevel|
| | |KafkaException|
| | |KafkaFuture.BaseFunction<A,B>|
| | |KafkaFuture.BiConsumer<A,B>|
| | |MetricName|
| | |Node|
| | |PartitionInfo|
| | |TopicCollection|
| | |TopicCollection.TopicIdCollection|
| | |TopicCollection.TopicNameCollection|
| | |TopicIdPartition|
| | |TopicPartition|
| | |TopicPartitionInfo|
| | |TopicPartitionReplica|
| | |Uuid|
| |acl|AclBinding|
| | |AclBindingFilter|
| |config|AbstractConfig|
| | |Config|
| | |ConfigDef|
| | |ConfigDef.CaseInsensitiveValidString|
| | |ConfigDef.CompositeValidator|
| | |ConfigDef.ConfigKey|
| | |ConfigDef.LambdaValidator|
| | |ConfigDef.ListSize|
| | |ConfigDef.NonEmptyString|
| | |ConfigDef.NonEmptyStringWithoutControlChars|
| | |ConfigDef.NonNullValidator|
| | |ConfigDef.ValidList|
| | |ConfigDef.ValidString|
| | |ConfigException|
| | |ConfigResource.Type|
| | |ConfigValue|
| | |LogLevelConfig|
| | |SaslConfigs|
| | |SslClientAuth|
| | |SslConfigs|
| |config.provider|DirectoryConfigProvider|
| | |EnvVarConfigProvider|
| | |FileConfigProvider|
| |errors|All construtor needs|
| |header|Header|
| | |Headers|
| |metrics|CompoundStat|
| | |CompoundStat.NamedMeasurable|
| | |JmxReporter|
| | |KafkaMetric|
| | |MetricConfig|
| | |Metrics|
| | |Quota|
| | |QuotaViolationException|
| | |Sensor|
| | |Sensor.RecordingLevel|
| |metrics.stats|Avg|
| | |CumulativeSum|
| | |Frequencies|
| | |Histogram|
| | |Max|
| | |Meter|
| | |Min|
| | |Percentile|
| | |Percentiles|
| | |Rate|
| | |SampledStat|
| | |SimpleRate|
| | |TokenBucket|
| | |WindowedSum|
| |quota|ClientQuotaAlteration|
| | |ClientQuotaAlteration.Op|
| | |ClientQuotaEntity|
| | |ClientQuotaFilter|
| | |ClientQuotaFilterComponent|
| |resource|PatternType|
| | |ResourcePattern|
| | |ResourcePatternFilter|
| |serialization|BooleanDeserializer|
| | |BooleanSerializer|
| | |ByteArrayDeserializer|
| | |ByteArraySerializer|
| | |ByteBufferDeserializer|
| | |BytesDeserializer|
| | |BytesSerializer|
| | |DoubleDeserializer|
| | |DoubleSerializer|
| | |FloatDeserializer|
| | |FloatSerializer|
| | |IntegerDeserializer|
| | |IntegerSerializer|
| | |ListDeserializer<Inner>|
| | |ListSerializer<Inner>|
| | |LongDeserializer|
| | |LongSerializer|
| | |Serde<T>|
| | |Serdes|
| | |Serdes.BooleanSerde|
| | |Serdes.ByteArraySerde|
| | |Serdes.ByteBufferSerde|
| | |Serdes.BytesSerde|
| | |Serdes.DoubleSerde|
| | |Serdes.FloatSerde|
| | |Serdes.IntegerSerde|
| | |Serdes.ListSerde<Inner>|
| | |Serdes.LongSerde|
| | |Serdes.ShortSerde|
| | |Serdes.StringSerde|
| | |Serdes.UUIDSerde|
| | |Serdes.VoidSerde|
| | |Serdes.WrapperSerde<T>|
| | |ShortDeserializer|
| | |ShortSerializer|
| | |VoidDeserializer|
| | |VoidSerializer|
| |security.auth|AuthenticationContext|
| | |KafkaPrincipal|
| | |PlaintextAuthenticationContext|
| | |SaslAuthenticationContext|
| | |SaslExtensions|
| | |SecurityProtocol|
| | |SslAuthenticationContext|
| |security.oauthbearer|BrokerJwtValidator|
| | |BrokerJwtValidator.ClaimSupplier<T>|
| | |ClientCredentialsJwtRetriever|
| | |ClientJwtValidator|
| | |DefaultJwtRetriever|
| | |DefaultJwtValidator|
| | |FileJwtRetriever|
| | |JwtBearerJwtRetriever|
| | |JwtRetrieverException|
| | |JwtValidatorException|
| | |OAuthBearerExtensionsValidatorCallback|
| | |OAuthBearerLoginCallbackHandler|
| | |OAuthBearerLoginModule|
| | |OAuthBearerValidatorCallback|
| | |OAuthBearerValidatorCallbackHandler|
| |security.plain|PlainAuthenticateCallback|
| | |PlainLoginModule|
| |security.scram|ScramCredential|
| | |ScramLoginModule|
| |security.token.delegation|DelegationToken|
| | |TokenInformation|
|org.apache.kafka.connect|connector|ConnectRecord<R extends ConnectRecord<R>>|
| |connector.policy|ConnectorClientConfigRequest|
| | |ConnectorClientConfigRequest.ClientType|
| |data|ConnectSchema|
| | |Decimal|
| | |Field|
| | |Schema|
| | |Schema.Type|
| | |SchemaAndValue|
| | |SchemaBuilder|
| | |Values|
| |errors|all|
| |header|ConnectHeaders|
| |mirror|Checkpoint|
| | |Heartbeat|
| | |MirrorClient|
| | |MirrorClientConfig|
| | |SourceAndTarget|
| |sink|SinkConnector|
| | |SinkRecord|
| |source|SourceRecord|
| |storage|ConverterType|
| | |StringConverterConfig|
| |transforms|ConnectRecord<R extends ConnectRecord<R>>|
| |transforms.predicates|ConnectRecord<R extends ConnectRecord<R>>|
| | | |
|org.apache.kafka.coordinator.group.api.assignor| |GroupAssignment|
| | |GroupSpec|
| | |MemberAssignment|
| | |PartitionAssignorException|
| | | |
|Package org.apache.kafka.server|authorizer|AclCreateResult|
| | |AclDeleteResult|
| | |AclDeleteResult.AclBindingDeleteResult|
| | |Action|
| | |AuthorizationResult|
| |log.remote.storage|LogSegmentData|
| | |RemoteLogMetadata|
| | |RemoteLogSegmentId|
| | |RemoteLogSegmentMetadata.CustomMetadata|
| | |RemoteLogSegmentMetadataUpdate|
| | |RemoteLogSegmentState|
| | |RemotePartitionDeleteMetadata|
| | |RemotePartitionDeleteState|
| | |RemoteResourceNotFoundException|
| | |RemoteStorageException|
| | |RemoteStorageMetrics|
| |policy|RequestMetadata|
| | | |
|org.apache.kafka.streams| |GroupProtocol|
| | |KafkaStreams.CloseOptions|
| | |KafkaStreams.State|
| | |KeyQueryMetadata|
| | |StoreQueryParameters<T>|
| | |StreamsConfig|
| | |StreamsConfig.InternalConfig|
| | |Topology|
| | |TopologyConfig|
| | |TopologyConfig.InternalConfig|
| | |TopologyDescription.GlobalStore|
| | |TopologyConfig.TaskConfig|
| |errors|BrokerNotFoundException|
| | |InvalidStateStoreException|
| | |LockException|
| | |MissingSourceTopicException|
| | |ProcessingExceptionHandler.ProcessingHandlerResponse|
| | |ProcessorStateException|
| | |StateStoreMigratedException|
| | |StreamsException|
| | |StreamsNotStartedException|
| | |StreamsRebalancingException|
| | |StreamsStoppedException|
| | |TaskAssignmentException|
| | |TaskCorruptedException|
| | |TaskIdFormatException|
| | |TaskMigratedException|
| | |TopologyException|
| | |UnknownStateStoreException|
| | |UnknownTopologyException|
| |kstream|EmitStrategy.StrategyType|
| | |Materialized.StoreType|
| | |Named|
| | |SessionWindowedDeserializer|
| | |SessionWindowedSerializer|
| | |SessionWindows|
| | |SlidingWindows|
| | |Suppressed|
| | |Suppressed.BufferConfig|
| | |TimeWindowedDeserializer|
| | |TimeWindowedSerializer|
| | |SessionWindowedSerde|
| | |TimeWindowedSerde|
| |processor|CommitCallback|
| | |ConnectedStoreProvider|
| | |MockProcessorContext.CapturedForward|
| | |MockProcessorContext.CapturedPunctuator|
| | |StandbyUpdateListener|
| | |StandbyUpdateListener.SuspendReason|
| | |StateRestoreCallback|
| | |TaskId|
| |processor.api|nternalFixedKeyRecordFactory|
| | |MockProcessorContext|
| | |MockProcessorContext.CapturedForward|
| | |MockProcessorContext.CapturedPunctuator|
| |processor.assignment|ApplicationState|
| | |AssignmentConfigs|
| | |KafkaStreamsAssignment|
| | |KafkaStreamsAssignment.AssignedTask|
| | |KafkaStreamsState|
| | |ProcessId|
| | |TaskAssignmentUtils.MoveStandbyTaskPredicate|
| | |TaskAssignor.TaskAssignment|
| | |TaskInfo|
| | |TaskTopicPartition|
| |processor.assignment.assignors|StickyTaskAssignor|
| |query|Position|
| | |QueryConfig|
| | |ResultOrder|
| | |WindowKeyQuery|
| | |WindowRangeQuery|
| |state|BuiltInDslStoreSuppliers.InMemoryDslStoreSuppliers|
| | |BuiltInDslStoreSuppliers.RocksDBDslStoreSuppliers|
| | |DslKeyValueParams|
| | |DslSessionParams|
| | |DslStoreSuppliers|
| | |DslWindowParams|
| | |HostInfo|
| | |KeyValueIterator|
| | |QueryableStoreTypes.KeyValueStoreType|
| | |QueryableStoreTypes.SessionStoreType|
| | |QueryableStoreTypes.WindowStoreType|
| | |TimestampedBytesStore|
| | |ValueAndTimestamp|
| | |VersionedRecord|
| | |VersionedRecordIterator|
| | |WindowStore|
| | |WindowStoreIterator|
| |test|TestRecord|
| | | |
|org.apache.kafka.tools.api| |Decoder|
| | |DefaultDecoder|
| | |IntegerDecoder|
| | |LongDecoder|
> Add javadoc to public APIs
> --------------------------
>
> Key: KAFKA-20126
> URL: https://issues.apache.org/jira/browse/KAFKA-20126
> Project: Kafka
> Issue Type: Improvement
> Reporter: Mickael Maison
> Priority: Major
>
> Many public classes/methods from the public APIs don't have javadoc.
> I suggest creating subtasks to address this bits by bits.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
