| --- |
| title: "Reference" |
| weight: 4 |
| type: docs |
| aliases: |
| - /custom-resource/reference.html |
| --- |
| <!-- |
| 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. |
| --> |
| |
| # Custom Resource Defintion Reference |
| |
| This serves as a full reference for FlinkDeployment and FlinkSessionJob custom resource definitions, including all possible configuration parameters. |
| |
| ## FlinkDeployment |
| **Class**: org.apache.flink.kubernetes.operator.crd.FlinkDeployment |
| |
| **Description**: Custom resource that represents both Application and Session deployments. |
| |
| | Parameter | Type | Docs | |
| | ----------| ---- | ---- | |
| | spec | org.apache.flink.kubernetes.operator.crd.spec.FlinkDeploymentSpec | Spec that describes a Flink application or session cluster deployment. | |
| | status | org.apache.flink.kubernetes.operator.crd.status.FlinkDeploymentStatus | Last observed status of the Flink deployment. | |
| |
| ## FlinkSessionJob |
| **Class**: org.apache.flink.kubernetes.operator.crd.FlinkSessionJob |
| |
| **Description**: Custom resource that represents a session job deployment. |
| |
| | Parameter | Type | Docs | |
| | ----------| ---- | ---- | |
| | spec | org.apache.flink.kubernetes.operator.crd.spec.FlinkSessionJobSpec | Spec that describes a session job deployment. | |
| | status | org.apache.flink.kubernetes.operator.crd.status.FlinkSessionJobStatus | Last observed status of the session job deployment. | |
