# README
Go API client for vapi
Application Manager APIs to control Apache Flink jobs
Overview
This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.
- API version: 2.0.1
- Package version: 1.0.0
- Build package: io.swagger.codegen.languages.GoClientCodegen For more information, please visit https://www.ververica.com
Installation
Put the package under your project folder and add the following in import:
import "./vapi"
Documentation for API Endpoints
All URIs are relative to https://ververica.prod.bird.co
Class | Method | HTTP request | Description |
---|---|---|---|
DeploymentResourceApi | CreateDeploymentUsingPOST | Post /api/v1/namespaces/{namespace}/deployments | Create a deployment |
DeploymentResourceApi | DeleteDeploymentUsingDELETE | Delete /api/v1/namespaces/{namespace}/deployments/{deploymentId} | Delete deployment |
DeploymentResourceApi | GetDeploymentUsingGET | Get /api/v1/namespaces/{namespace}/deployments/{deploymentId} | Get a deployment by id |
DeploymentResourceApi | GetDeploymentsUsingGET | Get /api/v1/namespaces/{namespace}/deployments | List all deployments |
DeploymentResourceApi | UpdateDeploymentUsingPATCH | Patch /api/v1/namespaces/{namespace}/deployments/{deploymentId} | Update a deployment |
DeploymentTargetResourceApi | CreateDeploymentTargetUsingPOST | Post /api/v1/namespaces/{namespace}/deployment-targets | Create a deployment target |
DeploymentTargetResourceApi | DeleteDeploymentTargetUsingDELETE | Delete /api/v1/namespaces/{namespace}/deployment-targets/{name} | Delete a deployment target |
DeploymentTargetResourceApi | GetDeploymentTargetUsingGET | Get /api/v1/namespaces/{namespace}/deployment-targets/{name} | Get a deployment target by name |
DeploymentTargetResourceApi | GetDeploymentTargetsUsingGET | Get /api/v1/namespaces/{namespace}/deployment-targets | List all deployment targets |
EventResourceApi | GetEventsUsingGET | Get /api/v1/namespaces/{namespace}/events | Filter all events for a deployment or job |
JobResourceApi | GetJobUsingGET | Get /api/v1/namespaces/{namespace}/jobs/{jobId} | Get a job by id |
JobResourceApi | GetJobsUsingGET | Get /api/v1/namespaces/{namespace}/jobs | List all jobs. Can be filtered by DeploymentId |
SavepointResourceApi | CreateSavepointUsingPOST | Post /api/v1/namespaces/{namespace}/savepoints | Create a new savepoint |
SavepointResourceApi | GetSavepointUsingGET | Get /api/v1/namespaces/{namespace}/savepoints/{savepointId} | Get a savepoint by id |
SavepointResourceApi | GetSavepointsUsingGET | Get /api/v1/namespaces/{namespace}/savepoints | List all savepoints. Can be filtered by DeploymentId |
SecretValueResourceApi | CreateSecretValueUsingPOST | Post /api/v1/namespaces/{namespace}/secret-values | Create a secret value |
SecretValueResourceApi | DeleteSecretValueUsingDELETE | Delete /api/v1/namespaces/{namespace}/secret-values/{name} | Delete a secret value |
SecretValueResourceApi | GetSecretValueUsingGET | Get /api/v1/namespaces/{namespace}/secret-values/{name} | Get a secret value by name |
SecretValueResourceApi | GetSecretValuesUsingGET | Get /api/v1/namespaces/{namespace}/secret-values | List all secrets values |
SecretValueResourceApi | UpdateSecretValueUsingPATCH | Patch /api/v1/namespaces/{namespace}/secret-values/{name} | Update a secret value |
StatusResourceApi | GetStatusUsingGET | Get /api/v1/status | Check that the server is running |
StatusResourceApi | GetSystemInfoUsingGET | Get /api/v1/status/system-info | Get system's information |
Documentation For Models
- Artifact
- Deployment
- DeploymentMetadata
- DeploymentRestoreStrategy
- DeploymentSpec
- DeploymentStatus
- DeploymentTarget
- DeploymentTargetMetadata
- DeploymentTargetSpec
- DeploymentTemplate
- DeploymentTemplateMetadata
- DeploymentTemplateSpec
- DeploymentUpgradeStrategy
- EnvVar
- Event
- EventMetadata
- EventSpec
- Failure
- FlinkSavepointId
- Job
- JobDeploymentTarget
- JobMetadata
- JobSpec
- JobStatus
- JsonNode
- KubernetesOptions
- KubernetesTarget
- License
- LicenseId
- LicenseMetadata
- LicenseSpec
- LocalObjectReference
- Logging
- ObjectNode
- Pods
- ResourceListDeployment
- ResourceListDeploymentTarget
- ResourceListEvent
- ResourceListJob
- ResourceListMetadata
- ResourceListSavepoint
- ResourceListSecretValue
- ResourceQuota
- ResourceQuotaQuantity
- ResourceQuotaSpec
- ResourceQuotaStatus
- ResourceSpec
- RevisionInformation
- Savepoint
- SavepointMetadata
- SavepointSpec
- SavepointStatus
- SecretValue
- SecretValueMetadata
- SecretValueSpec
- SystemInformation
- SystemInformationStatus
- Uri
- VolumeAndMount
Documentation For Authorization
Endpoints do not require authorization.