类的使用
org.apache.flink.kubernetes.operator.controller.FlinkResourceContext

使用FlinkResourceContext的程序包

程序包	说明
org.apache.flink.kubernetes.operator.controller
org.apache.flink.kubernetes.operator.observer
org.apache.flink.kubernetes.operator.observer.deployment
org.apache.flink.kubernetes.operator.observer.sessionjob
org.apache.flink.kubernetes.operator.reconciler
org.apache.flink.kubernetes.operator.reconciler.deployment
org.apache.flink.kubernetes.operator.reconciler.sessionjob
org.apache.flink.kubernetes.operator.service

org.apache.flink.kubernetes.operator.controller中FlinkResourceContext的使用

org.apache.flink.kubernetes.operator.controller中FlinkResourceContext的子类

修饰符和类型	类	说明
class	FlinkDeploymentContext	Context for reconciling a Flink resource.
class	FlinkSessionJobContext	Context for reconciling a Flink resource.

类型变量类型为FlinkResourceContext的org.apache.flink.kubernetes.operator.controller中的构造器参数

构造器	说明
FlinkDeploymentContext(org.apache.flink.kubernetes.operator.api.FlinkDeployment resource, io.javaoperatorsdk.operator.api.reconciler.Context<?> josdkContext, KubernetesResourceMetricGroup resourceMetricGroup, FlinkConfigManager configManager, java.util.function.Function<FlinkResourceContext<?>,FlinkService> flinkServiceFactory)
FlinkSessionJobContext(org.apache.flink.kubernetes.operator.api.FlinkSessionJob resource, io.javaoperatorsdk.operator.api.reconciler.Context<?> josdkContext, KubernetesResourceMetricGroup resourceMetricGroup, FlinkConfigManager configManager, java.util.function.Function<FlinkResourceContext<?>,FlinkService> flinkServiceFactory)

org.apache.flink.kubernetes.operator.observer中FlinkResourceContext的使用

参数类型为FlinkResourceContext的org.apache.flink.kubernetes.operator.observer中的方法

修饰符和类型	方法	说明
protected abstract boolean	AbstractFlinkResourceObserver.checkIfAlreadyUpgraded(FlinkResourceContext<CR> ctx)	Checks a resource that is currently in the UPGRADING state whether it was already deployed but we simply miss the status information.
protected boolean	AbstractFlinkResourceObserver.isResourceReadyToBeObserved(FlinkResourceContext<CR> ctx)	Check whether the resource should be observed.
void	AbstractFlinkResourceObserver.observe(FlinkResourceContext<CR> ctx)
void	ClusterHealthObserver.observe(FlinkResourceContext<org.apache.flink.kubernetes.operator.api.FlinkDeployment> ctx)	Observe the health of the flink cluster.
boolean	JobStatusObserver.observe(FlinkResourceContext<R> ctx)	Observe the status of the flink job.
void	Observer.observe(FlinkResourceContext<CR> ctx)	Observe the flinkApp status, It will reflect the changed status on the flinkApp resource.
protected abstract void	AbstractFlinkResourceObserver.observeInternal(FlinkResourceContext<CR> ctx)	Internal observer logic specific to each resource type.
void	SavepointObserver.observeSavepointStatus(FlinkResourceContext<CR> ctx)
protected void	JobStatusObserver.onNoJobsFound(FlinkResourceContext<R> ctx)	Callback when no jobs were found on the cluster.
protected abstract void	JobStatusObserver.onTargetJobNotFound(FlinkResourceContext<R> ctx)	Callback when no matching target job was found on a cluster where jobs were found.
protected abstract void	JobStatusObserver.onTimeout(FlinkResourceContext<R> ctx)	Callback when list jobs timeout.

org.apache.flink.kubernetes.operator.observer.deployment中FlinkResourceContext的使用

参数类型为FlinkResourceContext的org.apache.flink.kubernetes.operator.observer.deployment中的方法

修饰符和类型	方法	说明
protected boolean	AbstractFlinkDeploymentObserver.checkIfAlreadyUpgraded(FlinkResourceContext<org.apache.flink.kubernetes.operator.api.FlinkDeployment> ctx)
protected abstract void	AbstractFlinkDeploymentObserver.observeFlinkCluster(FlinkResourceContext<org.apache.flink.kubernetes.operator.api.FlinkDeployment> ctx)	Observe the flinkApp status when the cluster is ready.
protected void	ApplicationObserver.observeFlinkCluster(FlinkResourceContext<org.apache.flink.kubernetes.operator.api.FlinkDeployment> ctx)
void	SessionObserver.observeFlinkCluster(FlinkResourceContext<org.apache.flink.kubernetes.operator.api.FlinkDeployment> ctx)
void	AbstractFlinkDeploymentObserver.observeInternal(FlinkResourceContext<org.apache.flink.kubernetes.operator.api.FlinkDeployment> ctx)
protected void	AbstractFlinkDeploymentObserver.observeJmDeployment(FlinkResourceContext<org.apache.flink.kubernetes.operator.api.FlinkDeployment> ctx)

org.apache.flink.kubernetes.operator.observer.sessionjob中FlinkResourceContext的使用

参数类型为FlinkResourceContext的org.apache.flink.kubernetes.operator.observer.sessionjob中的方法

修饰符和类型	方法	说明
protected boolean	FlinkSessionJobObserver.checkIfAlreadyUpgraded(FlinkResourceContext<org.apache.flink.kubernetes.operator.api.FlinkSessionJob> ctx)
protected boolean	FlinkSessionJobObserver.isResourceReadyToBeObserved(FlinkResourceContext<org.apache.flink.kubernetes.operator.api.FlinkSessionJob> ctx)
protected void	FlinkSessionJobObserver.observeInternal(FlinkResourceContext<org.apache.flink.kubernetes.operator.api.FlinkSessionJob> ctx)

org.apache.flink.kubernetes.operator.reconciler中FlinkResourceContext的使用

参数类型为FlinkResourceContext的org.apache.flink.kubernetes.operator.reconciler中的方法

修饰符和类型	方法	说明
static <SPEC extends org.apache.flink.kubernetes.operator.api.spec.AbstractFlinkSpec> boolean	ReconciliationUtils.applyValidationErrorAndResetSpec(FlinkResourceContext<? extends org.apache.flink.kubernetes.operator.api.AbstractFlinkResource<SPEC,?>> ctx, java.lang.String validationError)	In case of validation errors we need to (temporarily) reset the old spec so that we can reconcile other outstanding changes, instead of simply blocking.
io.javaoperatorsdk.operator.api.reconciler.DeleteControl	Reconciler.cleanup(FlinkResourceContext<CR> context)	This is called when receiving the delete event of custom resource.
void	Reconciler.reconcile(FlinkResourceContext<CR> context)	This is called when receiving the create or update event of the custom resource.
static <STATUS extends org.apache.flink.kubernetes.operator.api.status.CommonStatus<?>,R extends org.apache.flink.kubernetes.operator.api.AbstractFlinkResource<?,STATUS>> io.javaoperatorsdk.operator.api.reconciler.ErrorStatusUpdateControl<R>	ReconciliationUtils.toErrorStatusUpdateControl(FlinkResourceContext<R> ctx, java.lang.Exception e, StatusRecorder<R,STATUS> statusRecorder)	Update the resource error status and metrics when the operator encountered an exception during reconciliation.
static void	ReconciliationUtils.updateForReconciliationError(FlinkResourceContext ctx, java.lang.Throwable error)

org.apache.flink.kubernetes.operator.reconciler.deployment中FlinkResourceContext的使用

参数类型为FlinkResourceContext的org.apache.flink.kubernetes.operator.reconciler.deployment中的方法

修饰符和类型	方法	说明
protected abstract void	AbstractJobReconciler.cancelJob(FlinkResourceContext<CR> ctx, org.apache.flink.kubernetes.operator.api.spec.UpgradeMode upgradeMode)	Cancel the job for the given resource using the specified upgrade mode.
protected void	ApplicationReconciler.cancelJob(FlinkResourceContext<org.apache.flink.kubernetes.operator.api.FlinkDeployment> ctx, org.apache.flink.kubernetes.operator.api.spec.UpgradeMode upgradeMode)
protected AbstractJobReconciler.AvailableUpgradeMode	AbstractJobReconciler.changeLastStateIfCheckpointTooOld(FlinkResourceContext<CR> ctx, org.apache.flink.configuration.Configuration deployConfig)
io.javaoperatorsdk.operator.api.reconciler.DeleteControl	AbstractFlinkResourceReconciler.cleanup(FlinkResourceContext<CR> ctx)
void	JobAutoScaler.cleanup(FlinkResourceContext<?> ctx)	Called when the custom resource is deleted.
void	NoopJobAutoscalerFactory.cleanup(FlinkResourceContext<?> ctx)
protected abstract void	AbstractJobReconciler.cleanupAfterFailedJob(FlinkResourceContext<CR> ctx)	Removes a failed job.
protected void	ApplicationReconciler.cleanupAfterFailedJob(FlinkResourceContext<org.apache.flink.kubernetes.operator.api.FlinkDeployment> ctx)
protected abstract io.javaoperatorsdk.operator.api.reconciler.DeleteControl	AbstractFlinkResourceReconciler.cleanupInternal(FlinkResourceContext<CR> ctx)	Shut down and clean up all Flink job/cluster resources.
protected io.javaoperatorsdk.operator.api.reconciler.DeleteControl	ApplicationReconciler.cleanupInternal(FlinkResourceContext<org.apache.flink.kubernetes.operator.api.FlinkDeployment> ctx)
io.javaoperatorsdk.operator.api.reconciler.DeleteControl	SessionReconciler.cleanupInternal(FlinkResourceContext<org.apache.flink.kubernetes.operator.api.FlinkDeployment> ctx)
abstract void	AbstractFlinkResourceReconciler.deploy(FlinkResourceContext<CR> ctx, SPEC spec, org.apache.flink.configuration.Configuration deployConfig, java.util.Optional<java.lang.String> savepoint, boolean requireHaMetadata)	Deploys the target resource spec to Kubernetes.
void	ApplicationReconciler.deploy(FlinkResourceContext<org.apache.flink.kubernetes.operator.api.FlinkDeployment> ctx, org.apache.flink.kubernetes.operator.api.spec.FlinkDeploymentSpec spec, org.apache.flink.configuration.Configuration deployConfig, java.util.Optional<java.lang.String> savepoint, boolean requireHaMetadata)
void	SessionReconciler.deploy(FlinkResourceContext<org.apache.flink.kubernetes.operator.api.FlinkDeployment> ctx, org.apache.flink.kubernetes.operator.api.spec.FlinkDeploymentSpec spec, org.apache.flink.configuration.Configuration deployConfig, java.util.Optional<java.lang.String> savepoint, boolean requireHaMetadata)
protected AbstractJobReconciler.AvailableUpgradeMode	AbstractJobReconciler.getAvailableUpgradeMode(FlinkResourceContext<CR> ctx, org.apache.flink.configuration.Configuration deployConfig)
protected AbstractJobReconciler.AvailableUpgradeMode	ApplicationReconciler.getAvailableUpgradeMode(FlinkResourceContext<org.apache.flink.kubernetes.operator.api.FlinkDeployment> ctx, org.apache.flink.configuration.Configuration deployConfig)
java.util.Map<java.lang.String,java.lang.String>	JobAutoScaler.getParallelismOverrides(FlinkResourceContext<?> ctx)	Get the current parallelism overrides for the job.
java.util.Map<java.lang.String,java.lang.String>	NoopJobAutoscalerFactory.getParallelismOverrides(FlinkResourceContext<?> ctx)
protected abstract boolean	AbstractFlinkResourceReconciler.readyToReconcile(FlinkResourceContext<CR> ctx)	Check whether the given Flink resource is ready to be reconciled or we are still waiting for any pending operation or condition first.
boolean	AbstractJobReconciler.readyToReconcile(FlinkResourceContext<CR> ctx)
protected boolean	SessionReconciler.readyToReconcile(FlinkResourceContext<org.apache.flink.kubernetes.operator.api.FlinkDeployment> ctx)
void	AbstractFlinkResourceReconciler.reconcile(FlinkResourceContext<CR> ctx)
protected abstract boolean	AbstractFlinkResourceReconciler.reconcileOtherChanges(FlinkResourceContext<CR> ctx)	Reconcile any other changes required for this resource that are specific to the reconciler implementation.
boolean	AbstractJobReconciler.reconcileOtherChanges(FlinkResourceContext<CR> ctx)
boolean	ApplicationReconciler.reconcileOtherChanges(FlinkResourceContext<org.apache.flink.kubernetes.operator.api.FlinkDeployment> ctx)
boolean	SessionReconciler.reconcileOtherChanges(FlinkResourceContext<org.apache.flink.kubernetes.operator.api.FlinkDeployment> ctx)
protected abstract boolean	AbstractFlinkResourceReconciler.reconcileSpecChange(FlinkResourceContext<CR> ctx, org.apache.flink.configuration.Configuration deployConfig)	Reconcile spec upgrade on the currently deployed/suspended Flink resource and update the status accordingly.
protected boolean	AbstractJobReconciler.reconcileSpecChange(FlinkResourceContext<CR> ctx, org.apache.flink.configuration.Configuration deployConfig)
protected boolean	SessionReconciler.reconcileSpecChange(FlinkResourceContext<org.apache.flink.kubernetes.operator.api.FlinkDeployment> ctx, org.apache.flink.configuration.Configuration deployConfig)
protected void	AbstractJobReconciler.restoreJob(FlinkResourceContext<CR> ctx, SPEC spec, org.apache.flink.configuration.Configuration deployConfig, boolean requireHaMetadata)
protected void	AbstractJobReconciler.resubmitJob(FlinkResourceContext<CR> ctx, boolean requireHaMetadata)
boolean	JobAutoScaler.scale(FlinkResourceContext<?> ctx)	Called as part of the reconciliation loop.
boolean	NoopJobAutoscalerFactory.scale(FlinkResourceContext<?> ctx)

org.apache.flink.kubernetes.operator.reconciler.sessionjob中FlinkResourceContext的使用

参数类型为FlinkResourceContext的org.apache.flink.kubernetes.operator.reconciler.sessionjob中的方法

修饰符和类型	方法	说明
protected void	SessionJobReconciler.cancelJob(FlinkResourceContext<org.apache.flink.kubernetes.operator.api.FlinkSessionJob> ctx, org.apache.flink.kubernetes.operator.api.spec.UpgradeMode upgradeMode)
protected void	SessionJobReconciler.cleanupAfterFailedJob(FlinkResourceContext<org.apache.flink.kubernetes.operator.api.FlinkSessionJob> ctx)
io.javaoperatorsdk.operator.api.reconciler.DeleteControl	SessionJobReconciler.cleanupInternal(FlinkResourceContext<org.apache.flink.kubernetes.operator.api.FlinkSessionJob> ctx)
void	SessionJobReconciler.deploy(FlinkResourceContext<org.apache.flink.kubernetes.operator.api.FlinkSessionJob> ctx, org.apache.flink.kubernetes.operator.api.spec.FlinkSessionJobSpec sessionJobSpec, org.apache.flink.configuration.Configuration deployConfig, java.util.Optional<java.lang.String> savepoint, boolean requireHaMetadata)
boolean	SessionJobReconciler.readyToReconcile(FlinkResourceContext<org.apache.flink.kubernetes.operator.api.FlinkSessionJob> ctx)

org.apache.flink.kubernetes.operator.service中FlinkResourceContext的使用

返回FlinkResourceContext的org.apache.flink.kubernetes.operator.service中的方法

修饰符和类型	方法	说明
<CR extends org.apache.flink.kubernetes.operator.api.AbstractFlinkResource<?,?>> FlinkResourceContext<CR>	FlinkResourceContextFactory.getResourceContext(CR resource, io.javaoperatorsdk.operator.api.reconciler.Context josdkContext)

参数类型为FlinkResourceContext的org.apache.flink.kubernetes.operator.service中的方法

修饰符和类型	方法	说明
protected FlinkService	FlinkResourceContextFactory.getFlinkService(FlinkResourceContext<?> ctx)
FlinkService.ScalingResult	FlinkService.scale(FlinkResourceContext<?> resourceContext, org.apache.flink.configuration.Configuration deployConfig)
FlinkService.ScalingResult	NativeFlinkService.scale(FlinkResourceContext<?> ctx, org.apache.flink.configuration.Configuration deployConfig)
FlinkService.ScalingResult	StandaloneFlinkService.scale(FlinkResourceContext<?> ctx, org.apache.flink.configuration.Configuration deployConfig)
boolean	FlinkService.scalingCompleted(FlinkResourceContext<?> resourceContext)
boolean	NativeFlinkService.scalingCompleted(FlinkResourceContext<?> ctx)
boolean	StandaloneFlinkService.scalingCompleted(FlinkResourceContext<?> resourceContext)