# README
Go API client for v1
Apache Flink job lifecycle management component for Confluent Platform.
Overview
This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.
- API version: 1.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.GoDeprecatedClientCodegen
Installation
Install the following dependencies:
go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional
Put the package under your project folder and add the following in import:
import "./v1"
Documentation for API Endpoints
All URIs are relative to http://localhost:8080/cmf/api/v1
| Class | Method | HTTP request | Description |
|---|---|---|---|
| DefaultApi | CreateOrUpdateApplication | Post /environments/{envName}/applications | Creates a new Flink Application or updates an existing one in the given Environment. |
| DefaultApi | CreateOrUpdateEnvironment | Post /environments | Create or update an Environment |
| DefaultApi | DeleteApplication | Delete /environments/{envName}/applications/{appName} | Deletes an Application of the given name in the given Environment. |
| DefaultApi | DeleteEnvironment | Delete /environments/{envName} | |
| DefaultApi | GetApplication | Get /environments/{envName}/applications/{appName} | Retrieve an Application of the given name in the given Environment. |
| DefaultApi | GetApplications | Get /environments/{envName}/applications | Retrieve a paginated list of all applications in the given Environment. |
| DefaultApi | GetEnvironment | Get /environments/{envName} | Get/Describe an environment with the given name. |
| DefaultApi | GetEnvironments | Get /environments | Retrieve a paginated list of all environments. |
| DefaultApi | StartApplication | Post /environments/{envName}/applications/{appName}/start | Starts an earlier submitted Flink Application |
| DefaultApi | SuspendApplication | Post /environments/{envName}/applications/{appName}/suspend | Suspends an earlier started Flink Application |
Documentation For Models
- Application
- ApplicationPageMetadata
- ApplicationsPage
- ApplicationsPageAllOf
- Environment
- EnvironmentsPage
- EnvironmentsPageAllOf
- EnvironmentsPageMetadata
- GetResourceBase
- KubernetesNamespace
- ModelError
- Pageable
- PaginationResponse
- PostEnvironment
- PostResourceBase
- ResourceWithFlinkApplicationDefaults
- RestError
- Sort
Documentation For Authorization
Endpoints do not require authorization.
Author
# Packages
No description provided by the author
# Functions
CacheExpires helper function to determine remaining time before repeating a request.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResonse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewConfiguration returns a new Configuration object.
# Variables
ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKey takes an APIKey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
# Structs
APIClient manages communication with the Confluent Manager for Apache Flink / CMF API v1.0 In most cases there should be only one, shared, APIClient.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
APIResponse stores the API response returned by the server.
Application Represents a Flink Application submitted by the user.
ApplicationPageMetadata struct for ApplicationPageMetadata.
ApplicationsPage struct for ApplicationsPage.
ApplicationsPageAllOf struct for ApplicationsPageAllOf.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
Configuration stores the configuration of the API client.
Environment Environment.
EnvironmentsPage struct for EnvironmentsPage.
EnvironmentsPageAllOf struct for EnvironmentsPageAllOf.
EnvironmentsPageMetadata struct for EnvironmentsPageMetadata.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
GetApplicationsOpts Optional parameters for the method 'GetApplications'.
GetEnvironmentsOpts Optional parameters for the method 'GetEnvironments'.
GetResourceBase struct for GetResourceBase.
KubernetesNamespace struct for KubernetesNamespace.
ModelError An error.
Pageable struct for Pageable.
PaginationResponse struct for PaginationResponse.
PostEnvironment Environment.
PostResourceBase struct for PostResourceBase.
ResourceWithFlinkApplicationDefaults struct for ResourceWithFlinkApplicationDefaults.
RestError The schema for all error responses.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
Sort struct for Sort.
# Interfaces
No description provided by the author
# Type aliases
DefaultApiService DefaultApi service.