Skip to content

fix: error with java docs validation #2336

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

import io.fabric8.kubernetes.api.model.HasMetadata;
import io.fabric8.kubernetes.client.CustomResource;
import io.javaoperatorsdk.operator.api.config.ConfigurationService;
import io.javaoperatorsdk.operator.api.reconciler.UpdateControl;

/**
Expand All @@ -11,10 +12,11 @@
* In order for this automatic handling to work the status object returned by
* {@link CustomResource#getStatus()} should not be null.
* <p>
* The observed generation is updated even when {@link UpdateControl#noUpdate()} or
* {@link UpdateControl#updateResource(HasMetadata)} is called. Although those results call normally
* does not result in a status update, there will be a subsequent status update Kubernetes API call
* in this case.
* The observed generation is updated with SSA mode only if
* {@link UpdateControl#patchStatus(HasMetadata)} or
* {@link UpdateControl#patchResourceAndStatus(HasMetadata)} is called. In non-SSA mode (see
* {@link ConfigurationService#useSSAToPatchPrimaryResource()}) observed generation is update even
* if patch is not called.
*
* @see ObservedGenerationAwareStatus
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -327,6 +327,8 @@ default ExecutorServiceManager getExecutorServiceManager() {
* method of Kubernetes Dependent Resource.
*
* @since 4.4.0
*
* @return if SSA should be used for dependent resources
*/
default boolean ssaBasedCreateUpdateMatchForDependentResources() {
return true;
Expand Down Expand Up @@ -355,6 +357,8 @@ default Set<Class<? extends HasMetadata>> defaultNonSSAResource() {
* Disable this if you want to react to your own dependent resource updates
*
* @since 4.5.0
*
* @return if special annotation should be used for dependent resource to filter events
*/
default boolean previousAnnotationForDependentResourcesEventFiltering() {
return true;
Expand All @@ -366,10 +370,12 @@ default boolean previousAnnotationForDependentResourcesEventFiltering() {
* <p>
* Disabled by default as Kubernetes does not support, and discourages, this interpretation of
* resourceVersions. Enable only if your api server event processing seems to lag the operator
* logic and you want to further minimize the the amount of work done / updates issued by the
* logic, and you want to further minimize the amount of work done / updates issued by the
* operator.
*
* @since 4.5.0
*
* @return if resource version should be parsed (as integer)
*/
default boolean parseResourceVersionsForEventFilteringAndCaching() {
return false;
Expand Down
Loading