Documentation ¶
Index ¶
- Variables
- func CacheExpires(r *http.Response) time.Time
- type APIClient
- type APIKey
- type APIResponse
- type BasicAuth
- type Channel
- type Configuration
- type ConnectorAdminRequest
- type ConnectorAdminView
- type ConnectorAdminViewList
- type ConnectorClusterAdminList
- type ConnectorClusterAdminStatus
- type ConnectorClusterAdminStatusOperators
- type ConnectorClusterAdminView
- type ConnectorClusterMeta
- type ConnectorClusterPlatform
- type ConnectorClusterRequestMeta
- type ConnectorClusterState
- type ConnectorClustersAdminApiService
- func (a *ConnectorClustersAdminApiService) DeleteConnector(ctx _context.Context, connectorId string, ...) (Error, *_nethttp.Response, error)
- func (a *ConnectorClustersAdminApiService) DeleteConnectorNamespace(ctx _context.Context, namespaceId string, ...) (Error, *_nethttp.Response, error)
- func (a *ConnectorClustersAdminApiService) GetClusterConnectors(ctx _context.Context, connectorClusterId string, ...) (ConnectorAdminViewList, *_nethttp.Response, error)
- func (a *ConnectorClustersAdminApiService) GetClusterDeployments(ctx _context.Context, connectorClusterId string, ...) (ConnectorDeploymentAdminViewList, *_nethttp.Response, error)
- func (a *ConnectorClustersAdminApiService) GetClusterNamespaces(ctx _context.Context, connectorClusterId string, ...) (ConnectorNamespaceList, *_nethttp.Response, error)
- func (a *ConnectorClustersAdminApiService) GetConnector(ctx _context.Context, connectorId string) (ConnectorAdminView, *_nethttp.Response, error)
- func (a *ConnectorClustersAdminApiService) GetConnectorCluster(ctx _context.Context, connectorClusterId string) (ConnectorClusterAdminView, *_nethttp.Response, error)
- func (a *ConnectorClustersAdminApiService) GetConnectorDeployment(ctx _context.Context, connectorClusterId string, deploymentId string) (ConnectorDeploymentAdminView, *_nethttp.Response, error)
- func (a *ConnectorClustersAdminApiService) GetConnectorNamespace(ctx _context.Context, namespaceId string) (ConnectorNamespace, *_nethttp.Response, error)
- func (a *ConnectorClustersAdminApiService) GetNamespaceConnectors(ctx _context.Context, namespaceId string, ...) (ConnectorAdminViewList, *_nethttp.Response, error)
- func (a *ConnectorClustersAdminApiService) GetNamespaceDeployments(ctx _context.Context, namespaceId string, ...) (ConnectorDeploymentAdminViewList, *_nethttp.Response, error)
- func (a *ConnectorClustersAdminApiService) ListConnectorClusters(ctx _context.Context, localVarOptionals *ListConnectorClustersOpts) (ConnectorClusterAdminList, *_nethttp.Response, error)
- func (a *ConnectorClustersAdminApiService) PatchConnector(ctx _context.Context, connectorId string, body map[string]interface{}) (ConnectorAdminView, *_nethttp.Response, error)
- func (a *ConnectorClustersAdminApiService) PatchConnectorClusterDeploymentAdmin(ctx _context.Context, connectorClusterId string, deploymentId string, ...) (ConnectorDeploymentAdminView, *_nethttp.Response, error)
- type ConnectorDeploymentAdminSpec
- type ConnectorDeploymentAdminStatus
- type ConnectorDeploymentAdminStatusOperators
- type ConnectorDeploymentAdminStatusShardMetadata
- type ConnectorDeploymentAdminView
- type ConnectorDeploymentAdminViewAllOfMetadata
- type ConnectorDeploymentAdminViewList
- type ConnectorDesiredState
- type ConnectorMeta
- type ConnectorNamespace
- type ConnectorNamespaceEvalRequest
- type ConnectorNamespaceList
- type ConnectorNamespaceMeta
- type ConnectorNamespaceQuota
- type ConnectorNamespaceRequestMeta
- type ConnectorNamespaceState
- type ConnectorNamespaceStatus
- type ConnectorNamespaceTenant
- type ConnectorNamespaceTenantKind
- type ConnectorNamespaceWithTenantRequest
- type ConnectorNamespacesAdminApiService
- func (a *ConnectorNamespacesAdminApiService) CreateConnectorNamespace(ctx _context.Context, ...) (ConnectorNamespace, *_nethttp.Response, error)
- func (a *ConnectorNamespacesAdminApiService) GetConnectorNamespaces(ctx _context.Context, localVarOptionals *GetConnectorNamespacesOpts) (ConnectorNamespaceList, *_nethttp.Response, error)
- type ConnectorOperator
- type ConnectorRequestMeta
- type ConnectorShardMetadata
- type ConnectorState
- type ConnectorStatus
- type ConnectorStatusStatus
- type ConnectorType
- type ConnectorTypeAdminView
- type ConnectorTypeAdminViewList
- type ConnectorTypeChannel
- type ConnectorTypesApiService
- func (a *ConnectorTypesApiService) GetConnectorTypeByID(ctx _context.Context, connectorTypeId string) (ConnectorTypeAdminView, *_nethttp.Response, error)
- func (a *ConnectorTypesApiService) GetConnectorTypes(ctx _context.Context, localVarOptionals *GetConnectorTypesOpts) (ConnectorTypeAdminViewList, *_nethttp.Response, error)
- type DeleteConnectorNamespaceOpts
- type DeleteConnectorOpts
- type Error
- type GenericOpenAPIError
- type GetClusterConnectorsOpts
- type GetClusterDeploymentsOpts
- type GetClusterNamespacesOpts
- type GetConnectorNamespacesOpts
- type GetConnectorTypesOpts
- type GetNamespaceConnectorsOpts
- type GetNamespaceDeploymentsOpts
- type List
- type ListConnectorClustersOpts
- type MetaV1Condition
- type ObjectMeta
- type ObjectReference
- type ServerConfiguration
- type ServerVariable
Constants ¶
This section is empty.
Variables ¶
var ( // ContextOAuth2 takes an oauth2.TokenSource as authentication for the request. ContextOAuth2 = contextKey("token") // ContextBasicAuth takes BasicAuth as authentication for the request. ContextBasicAuth = contextKey("basic") // ContextAccessToken takes a string oauth2 access token as authentication for the request. ContextAccessToken = contextKey("accesstoken") // ContextAPIKey takes an APIKey as authentication for the request ContextAPIKey = contextKey("apikey") )
Functions ¶
Types ¶
type APIClient ¶
type APIClient struct { ConnectorClustersAdminApi *ConnectorClustersAdminApiService ConnectorNamespacesAdminApi *ConnectorNamespacesAdminApiService ConnectorTypesApi *ConnectorTypesApiService // contains filtered or unexported fields }
APIClient manages communication with the Connector Service Fleet Manager Admin APIs API v0.0.3 In most cases there should be only one, shared, APIClient.
func NewAPIClient ¶
func NewAPIClient(cfg *Configuration) *APIClient
NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.
func (*APIClient) ChangeBasePath ¶
ChangeBasePath changes base path to allow switching to mocks
func (*APIClient) GetConfig ¶
func (c *APIClient) GetConfig() *Configuration
Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior
type APIKey ¶
APIKey provides API key based authentication to a request passed via context using ContextAPIKey
type APIResponse ¶
type APIResponse struct { *http.Response `json:"-"` Message string `json:"message,omitempty"` // Operation is the name of the OpenAPI operation. Operation string `json:"operation,omitempty"` // RequestURL is the request URL. This value is always available, even if the // embedded *http.Response is nil. RequestURL string `json:"url,omitempty"` // Method is the HTTP method used for the request. This value is always // available, even if the embedded *http.Response is nil. Method string `json:"method,omitempty"` // Payload holds the contents of the response body (which may be nil or empty). // This is provided here as the raw response.Body() reader will have already // been drained. Payload []byte `json:"-"` }
APIResponse stores the API response returned by the server.
func NewAPIResponse ¶
func NewAPIResponse(r *http.Response) *APIResponse
NewAPIResponse returns a new APIResonse object.
func NewAPIResponseWithError ¶
func NewAPIResponseWithError(errorMessage string) *APIResponse
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
type BasicAuth ¶
type BasicAuth struct { UserName string `json:"userName,omitempty"` Password string `json:"password,omitempty"` }
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth
type Channel ¶
type Channel string
Channel the model 'Channel'
const (
CHANNEL_STABLE Channel = "stable"
)
List of Channel
type Configuration ¶
type Configuration struct { BasePath string `json:"basePath,omitempty"` Host string `json:"host,omitempty"` Scheme string `json:"scheme,omitempty"` DefaultHeader map[string]string `json:"defaultHeader,omitempty"` UserAgent string `json:"userAgent,omitempty"` Debug bool `json:"debug,omitempty"` Servers []ServerConfiguration HTTPClient *http.Client }
Configuration stores the configuration of the API client
func NewConfiguration ¶
func NewConfiguration() *Configuration
NewConfiguration returns a new Configuration object
func (*Configuration) AddDefaultHeader ¶
func (c *Configuration) AddDefaultHeader(key string, value string)
AddDefaultHeader adds a new HTTP header to the default header in the request
type ConnectorAdminRequest ¶
type ConnectorAdminRequest struct {
DesiredState ConnectorDesiredState `json:"desired_state"`
}
ConnectorAdminRequest struct for ConnectorAdminRequest
type ConnectorAdminView ¶
type ConnectorAdminView struct { Id string `json:"id,omitempty"` Kind string `json:"kind,omitempty"` Href string `json:"href,omitempty"` Owner string `json:"owner,omitempty"` CreatedAt time.Time `json:"created_at,omitempty"` ModifiedAt time.Time `json:"modified_at,omitempty"` Name string `json:"name"` ConnectorTypeId string `json:"connector_type_id"` NamespaceId string `json:"namespace_id"` Channel Channel `json:"channel,omitempty"` DesiredState ConnectorDesiredState `json:"desired_state"` // Name-value string annotations for resource Annotations map[string]string `json:"annotations,omitempty"` ResourceVersion int64 `json:"resource_version,omitempty"` Status ConnectorStatusStatus `json:"status,omitempty"` }
ConnectorAdminView struct for ConnectorAdminView
type ConnectorAdminViewList ¶
type ConnectorAdminViewList struct { Kind string `json:"kind"` Page int32 `json:"page"` Size int32 `json:"size"` Total int32 `json:"total"` Items []ConnectorAdminView `json:"items"` }
ConnectorAdminViewList struct for ConnectorAdminViewList
type ConnectorClusterAdminList ¶
type ConnectorClusterAdminList struct { Kind string `json:"kind"` Page int32 `json:"page"` Size int32 `json:"size"` Total int32 `json:"total"` Items []ConnectorClusterAdminView `json:"items"` }
ConnectorClusterAdminList struct for ConnectorClusterAdminList
type ConnectorClusterAdminStatus ¶
type ConnectorClusterAdminStatus struct { State ConnectorClusterState `json:"state,omitempty"` Version string `json:"version,omitempty"` Conditions []MetaV1Condition `json:"conditions,omitempty"` Platform ConnectorClusterPlatform `json:"platform,omitempty"` // the list of installed operators Operators []ConnectorClusterAdminStatusOperators `json:"operators,omitempty"` }
ConnectorClusterAdminStatus struct for ConnectorClusterAdminStatus
type ConnectorClusterAdminStatusOperators ¶
type ConnectorClusterAdminStatusOperators struct { Operator ConnectorOperator `json:"operator,omitempty"` // the namespace to which the operator has been installed Namespace string `json:"namespace,omitempty"` // the status of the operator Status string `json:"status,omitempty"` }
ConnectorClusterAdminStatusOperators struct for ConnectorClusterAdminStatusOperators
type ConnectorClusterAdminView ¶
type ConnectorClusterAdminView struct { Id string `json:"id,omitempty"` Kind string `json:"kind,omitempty"` Href string `json:"href,omitempty"` Owner string `json:"owner,omitempty"` CreatedAt time.Time `json:"created_at,omitempty"` ModifiedAt time.Time `json:"modified_at,omitempty"` Name string `json:"name,omitempty"` // Name-value string annotations for resource Annotations map[string]string `json:"annotations,omitempty"` Status ConnectorClusterAdminStatus `json:"status,omitempty"` }
ConnectorClusterAdminView struct for ConnectorClusterAdminView
type ConnectorClusterMeta ¶
type ConnectorClusterMeta struct { Owner string `json:"owner,omitempty"` CreatedAt time.Time `json:"created_at,omitempty"` ModifiedAt time.Time `json:"modified_at,omitempty"` Name string `json:"name,omitempty"` // Name-value string annotations for resource Annotations map[string]string `json:"annotations,omitempty"` }
ConnectorClusterMeta struct for ConnectorClusterMeta
type ConnectorClusterPlatform ¶
type ConnectorClusterPlatform struct { // the kubernetes cluster type Type string `json:"type,omitempty"` // uniquely identifies the kubernetes cluster Id string `json:"id,omitempty"` // optional version of the kubernetes cluster Version string `json:"version,omitempty"` }
ConnectorClusterPlatform information about the kubernetes platform
type ConnectorClusterRequestMeta ¶
type ConnectorClusterRequestMeta struct { Name string `json:"name,omitempty"` // Name-value string annotations for resource Annotations map[string]string `json:"annotations,omitempty"` }
ConnectorClusterRequestMeta struct for ConnectorClusterRequestMeta
type ConnectorClusterState ¶
type ConnectorClusterState string
ConnectorClusterState the model 'ConnectorClusterState'
const ( CONNECTORCLUSTERSTATE_DISCONNECTED ConnectorClusterState = "disconnected" CONNECTORCLUSTERSTATE_READY ConnectorClusterState = "ready" CONNECTORCLUSTERSTATE_DELETING ConnectorClusterState = "deleting" )
List of ConnectorClusterState
type ConnectorClustersAdminApiService ¶
type ConnectorClustersAdminApiService service
ConnectorClustersAdminApiService ConnectorClustersAdminApi service
func (*ConnectorClustersAdminApiService) DeleteConnector ¶
func (a *ConnectorClustersAdminApiService) DeleteConnector(ctx _context.Context, connectorId string, localVarOptionals *DeleteConnectorOpts) (Error, *_nethttp.Response, error)
DeleteConnector Delete a connector
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param connectorId The id of the connector to delete
- @param optional nil or *DeleteConnectorOpts - Optional Parameters:
- @param "Force" (optional.Bool) - Flag to force deletion of connector in Fleet manager if true
@return Error
func (*ConnectorClustersAdminApiService) DeleteConnectorNamespace ¶
func (a *ConnectorClustersAdminApiService) DeleteConnectorNamespace(ctx _context.Context, namespaceId string, localVarOptionals *DeleteConnectorNamespaceOpts) (Error, *_nethttp.Response, error)
DeleteConnectorNamespace Delete a connector namespace
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param namespaceId The id of the namespace to delete
- @param optional nil or *DeleteConnectorNamespaceOpts - Optional Parameters:
- @param "Force" (optional.Bool) - Flag to force deletion of namespace in Fleet manager if true
@return Error
func (*ConnectorClustersAdminApiService) GetClusterConnectors ¶
func (a *ConnectorClustersAdminApiService) GetClusterConnectors(ctx _context.Context, connectorClusterId string, localVarOptionals *GetClusterConnectorsOpts) (ConnectorAdminViewList, *_nethttp.Response, error)
GetClusterConnectors Get a list of available connectors in a cluster
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param connectorClusterId The id of the connector cluster
- @param optional nil or *GetClusterConnectorsOpts - Optional Parameters:
- @param "Page" (optional.String) - Page index
- @param "Size" (optional.String) - Number of items in each page
- @param "OrderBy" (optional.String) - Specifies the order by criteria. The syntax of this parameter is similar to the syntax of the `order by` clause of an SQL statement. Each query can be ordered by any of the underlying resource fields supported in the search parameter. For example, to return all Connector types ordered by their name, use the following syntax: ```sql name asc ``` To return all Connector types ordered by their name _and_ version, use the following syntax: ```sql name asc, version asc ``` To return connector types with labels `category-featured` AND `source`, use the following syntax: ``` label like %25category-featured%25source% ``` NOTE: The AND operator does not work for multiple labels. Instead use an alphabetically ascending order pattern with the LIKE operator to match an aggregated list of ',' separated label names. If the parameter isn't provided, or if the value is empty, then the results are ordered by name.
- @param "Search" (optional.String) - Search criteria. The syntax of this parameter is similar to the syntax of the `where` clause of a SQL statement. Allowed fields in the search depend on the resource type: * Cluster: id, created_at, updated_at, owner, organisation_id, name, state, client_id * Namespace: id, created_at, updated_at, name, cluster_id, owner, expiration, tenant_user_id, tenant_organisation_id, state * Connector Types: id, created_at, updated_at, version, name, description, label, channel, featured_rank, pricing_tier * Connectors: id, created_at, updated_at, name, owner, organisation_id, connector_type_id, desired_state, state, channel, namespace_id, kafka_id, kafka_bootstrap_server, service_account_client_id, schema_registry_id, schema_registry_url Allowed operators are `<>`, `=`, `IN`, `NOT IN`, `LIKE`, or `ILIKE`. Allowed conjunctive operators are `AND` and `OR`. However, you can use a maximum of 10 conjunctions in a search query. Examples: To return a Connector Type with the name `aws-sqs-source` and the channel `stable`, use the following syntax: ``` name = aws-sqs-source and channel = stable ``` To return a connector instance with a name that starts with `aws`, use the following syntax: ``` name like aws%25 ``` To return a connector type with a name containing `aws` matching any character case combination, use the following syntax: ``` name ilike %25aws%25 ``` To return connector types with labels `category-featured` AND `source`, use the following syntax: ``` label like %25category-featured%25source% ``` NOTE: The AND operator does not work for multiple labels. Instead use an alphabetically ascending order pattern with the LIKE operator to match an aggregated list of ',' separated label names. If the parameter isn't provided, or if the value is empty, then all the resources that the user has permission to see are returned. Note. If the query is invalid, an error is returned.
@return ConnectorAdminViewList
func (*ConnectorClustersAdminApiService) GetClusterDeployments ¶
func (a *ConnectorClustersAdminApiService) GetClusterDeployments(ctx _context.Context, connectorClusterId string, localVarOptionals *GetClusterDeploymentsOpts) (ConnectorDeploymentAdminViewList, *_nethttp.Response, error)
GetClusterDeployments Get a list of available deployments in a cluster
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param connectorClusterId The id of the cluster
- @param optional nil or *GetClusterDeploymentsOpts - Optional Parameters:
- @param "ChannelUpdates" (optional.Bool) - include only deployments that have channel updates
- @param "OperatorUpdates" (optional.Bool) - include only deployments that have operator updates
- @param "DanglingDeployments" (optional.Bool) - include only not deleted deployments belonging to a deleted connector
- @param "Page" (optional.String) - Page index
- @param "Size" (optional.String) - Number of items in each page
- @param "OrderBy" (optional.String) - Specifies the order by criteria. The syntax of this parameter is similar to the syntax of the `order by` clause of an SQL statement. Each query can be ordered by any of the underlying resource fields supported in the search parameter. For example, to return all Connector types ordered by their name, use the following syntax: ```sql name asc ``` To return all Connector types ordered by their name _and_ version, use the following syntax: ```sql name asc, version asc ``` To return connector types with labels `category-featured` AND `source`, use the following syntax: ``` label like %25category-featured%25source% ``` NOTE: The AND operator does not work for multiple labels. Instead use an alphabetically ascending order pattern with the LIKE operator to match an aggregated list of ',' separated label names. If the parameter isn't provided, or if the value is empty, then the results are ordered by name.
@return ConnectorDeploymentAdminViewList
func (*ConnectorClustersAdminApiService) GetClusterNamespaces ¶
func (a *ConnectorClustersAdminApiService) GetClusterNamespaces(ctx _context.Context, connectorClusterId string, localVarOptionals *GetClusterNamespacesOpts) (ConnectorNamespaceList, *_nethttp.Response, error)
GetClusterNamespaces Get a list of available connector namespaces in cluster
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param connectorClusterId The id of the connector cluster
- @param optional nil or *GetClusterNamespacesOpts - Optional Parameters:
- @param "Page" (optional.String) - Page index
- @param "Size" (optional.String) - Number of items in each page
- @param "OrderBy" (optional.String) - Specifies the order by criteria. The syntax of this parameter is similar to the syntax of the `order by` clause of an SQL statement. Each query can be ordered by any of the underlying resource fields supported in the search parameter. For example, to return all Connector types ordered by their name, use the following syntax: ```sql name asc ``` To return all Connector types ordered by their name _and_ version, use the following syntax: ```sql name asc, version asc ``` To return connector types with labels `category-featured` AND `source`, use the following syntax: ``` label like %25category-featured%25source% ``` NOTE: The AND operator does not work for multiple labels. Instead use an alphabetically ascending order pattern with the LIKE operator to match an aggregated list of ',' separated label names. If the parameter isn't provided, or if the value is empty, then the results are ordered by name.
- @param "Search" (optional.String) - Search criteria. The syntax of this parameter is similar to the syntax of the `where` clause of a SQL statement. Allowed fields in the search depend on the resource type: * Cluster: id, created_at, updated_at, owner, organisation_id, name, state, client_id * Namespace: id, created_at, updated_at, name, cluster_id, owner, expiration, tenant_user_id, tenant_organisation_id, state * Connector Types: id, created_at, updated_at, version, name, description, label, channel, featured_rank, pricing_tier * Connectors: id, created_at, updated_at, name, owner, organisation_id, connector_type_id, desired_state, state, channel, namespace_id, kafka_id, kafka_bootstrap_server, service_account_client_id, schema_registry_id, schema_registry_url Allowed operators are `<>`, `=`, `IN`, `NOT IN`, `LIKE`, or `ILIKE`. Allowed conjunctive operators are `AND` and `OR`. However, you can use a maximum of 10 conjunctions in a search query. Examples: To return a Connector Type with the name `aws-sqs-source` and the channel `stable`, use the following syntax: ``` name = aws-sqs-source and channel = stable ``` To return a connector instance with a name that starts with `aws`, use the following syntax: ``` name like aws%25 ``` To return a connector type with a name containing `aws` matching any character case combination, use the following syntax: ``` name ilike %25aws%25 ``` To return connector types with labels `category-featured` AND `source`, use the following syntax: ``` label like %25category-featured%25source% ``` NOTE: The AND operator does not work for multiple labels. Instead use an alphabetically ascending order pattern with the LIKE operator to match an aggregated list of ',' separated label names. If the parameter isn't provided, or if the value is empty, then all the resources that the user has permission to see are returned. Note. If the query is invalid, an error is returned.
@return ConnectorNamespaceList
func (*ConnectorClustersAdminApiService) GetConnector ¶
func (a *ConnectorClustersAdminApiService) GetConnector(ctx _context.Context, connectorId string) (ConnectorAdminView, *_nethttp.Response, error)
GetConnector Get a connector Get a connector
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param connectorId The id of the connector to delete
@return ConnectorAdminView
func (*ConnectorClustersAdminApiService) GetConnectorCluster ¶
func (a *ConnectorClustersAdminApiService) GetConnectorCluster(ctx _context.Context, connectorClusterId string) (ConnectorClusterAdminView, *_nethttp.Response, error)
GetConnectorCluster Get a connector cluster
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param connectorClusterId The id of the connector cluster
@return ConnectorClusterAdminView
func (*ConnectorClustersAdminApiService) GetConnectorDeployment ¶
func (a *ConnectorClustersAdminApiService) GetConnectorDeployment(ctx _context.Context, connectorClusterId string, deploymentId string) (ConnectorDeploymentAdminView, *_nethttp.Response, error)
GetConnectorDeployment Get a connector deployment Get a connector deployment
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param connectorClusterId The id of the connector cluster
- @param deploymentId The id of the connector deployment
@return ConnectorDeploymentAdminView
func (*ConnectorClustersAdminApiService) GetConnectorNamespace ¶
func (a *ConnectorClustersAdminApiService) GetConnectorNamespace(ctx _context.Context, namespaceId string) (ConnectorNamespace, *_nethttp.Response, error)
GetConnectorNamespace Get a connector namespace Get a connector namespace
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param namespaceId The id of the namespace
@return ConnectorNamespace
func (*ConnectorClustersAdminApiService) GetNamespaceConnectors ¶
func (a *ConnectorClustersAdminApiService) GetNamespaceConnectors(ctx _context.Context, namespaceId string, localVarOptionals *GetNamespaceConnectorsOpts) (ConnectorAdminViewList, *_nethttp.Response, error)
GetNamespaceConnectors Get a list of available connectors in a namespace
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param namespaceId The id of the namespace
- @param optional nil or *GetNamespaceConnectorsOpts - Optional Parameters:
- @param "Page" (optional.String) - Page index
- @param "Size" (optional.String) - Number of items in each page
- @param "OrderBy" (optional.String) - Specifies the order by criteria. The syntax of this parameter is similar to the syntax of the `order by` clause of an SQL statement. Each query can be ordered by any of the underlying resource fields supported in the search parameter. For example, to return all Connector types ordered by their name, use the following syntax: ```sql name asc ``` To return all Connector types ordered by their name _and_ version, use the following syntax: ```sql name asc, version asc ``` To return connector types with labels `category-featured` AND `source`, use the following syntax: ``` label like %25category-featured%25source% ``` NOTE: The AND operator does not work for multiple labels. Instead use an alphabetically ascending order pattern with the LIKE operator to match an aggregated list of ',' separated label names. If the parameter isn't provided, or if the value is empty, then the results are ordered by name.
- @param "Search" (optional.String) - Search criteria. The syntax of this parameter is similar to the syntax of the `where` clause of a SQL statement. Allowed fields in the search depend on the resource type: * Cluster: id, created_at, updated_at, owner, organisation_id, name, state, client_id * Namespace: id, created_at, updated_at, name, cluster_id, owner, expiration, tenant_user_id, tenant_organisation_id, state * Connector Types: id, created_at, updated_at, version, name, description, label, channel, featured_rank, pricing_tier * Connectors: id, created_at, updated_at, name, owner, organisation_id, connector_type_id, desired_state, state, channel, namespace_id, kafka_id, kafka_bootstrap_server, service_account_client_id, schema_registry_id, schema_registry_url Allowed operators are `<>`, `=`, `IN`, `NOT IN`, `LIKE`, or `ILIKE`. Allowed conjunctive operators are `AND` and `OR`. However, you can use a maximum of 10 conjunctions in a search query. Examples: To return a Connector Type with the name `aws-sqs-source` and the channel `stable`, use the following syntax: ``` name = aws-sqs-source and channel = stable ``` To return a connector instance with a name that starts with `aws`, use the following syntax: ``` name like aws%25 ``` To return a connector type with a name containing `aws` matching any character case combination, use the following syntax: ``` name ilike %25aws%25 ``` To return connector types with labels `category-featured` AND `source`, use the following syntax: ``` label like %25category-featured%25source% ``` NOTE: The AND operator does not work for multiple labels. Instead use an alphabetically ascending order pattern with the LIKE operator to match an aggregated list of ',' separated label names. If the parameter isn't provided, or if the value is empty, then all the resources that the user has permission to see are returned. Note. If the query is invalid, an error is returned.
@return ConnectorAdminViewList
func (*ConnectorClustersAdminApiService) GetNamespaceDeployments ¶
func (a *ConnectorClustersAdminApiService) GetNamespaceDeployments(ctx _context.Context, namespaceId string, localVarOptionals *GetNamespaceDeploymentsOpts) (ConnectorDeploymentAdminViewList, *_nethttp.Response, error)
GetNamespaceDeployments Get a list of available deployments in a namespace
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param namespaceId The id of the namespace
- @param optional nil or *GetNamespaceDeploymentsOpts - Optional Parameters:
- @param "ChannelUpdates" (optional.Bool) - include only deployments that have channel updates
- @param "OperatorUpdates" (optional.Bool) - include only deployments that have operator updates
- @param "DanglingDeployments" (optional.Bool) - include only not deleted deployments belonging to a deleted connector
- @param "Page" (optional.String) - Page index
- @param "Size" (optional.String) - Number of items in each page
- @param "OrderBy" (optional.String) - Specifies the order by criteria. The syntax of this parameter is similar to the syntax of the `order by` clause of an SQL statement. Each query can be ordered by any of the underlying resource fields supported in the search parameter. For example, to return all Connector types ordered by their name, use the following syntax: ```sql name asc ``` To return all Connector types ordered by their name _and_ version, use the following syntax: ```sql name asc, version asc ``` To return connector types with labels `category-featured` AND `source`, use the following syntax: ``` label like %25category-featured%25source% ``` NOTE: The AND operator does not work for multiple labels. Instead use an alphabetically ascending order pattern with the LIKE operator to match an aggregated list of ',' separated label names. If the parameter isn't provided, or if the value is empty, then the results are ordered by name.
@return ConnectorDeploymentAdminViewList
func (*ConnectorClustersAdminApiService) ListConnectorClusters ¶
func (a *ConnectorClustersAdminApiService) ListConnectorClusters(ctx _context.Context, localVarOptionals *ListConnectorClustersOpts) (ConnectorClusterAdminList, *_nethttp.Response, error)
ListConnectorClusters Returns a list of connector clusters
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param optional nil or *ListConnectorClustersOpts - Optional Parameters:
- @param "Page" (optional.String) - Page index
- @param "Size" (optional.String) - Number of items in each page
- @param "OrderBy" (optional.String) - Specifies the order by criteria. The syntax of this parameter is similar to the syntax of the `order by` clause of an SQL statement. Each query can be ordered by any of the underlying resource fields supported in the search parameter. For example, to return all Connector types ordered by their name, use the following syntax: ```sql name asc ``` To return all Connector types ordered by their name _and_ version, use the following syntax: ```sql name asc, version asc ``` To return connector types with labels `category-featured` AND `source`, use the following syntax: ``` label like %25category-featured%25source% ``` NOTE: The AND operator does not work for multiple labels. Instead use an alphabetically ascending order pattern with the LIKE operator to match an aggregated list of ',' separated label names. If the parameter isn't provided, or if the value is empty, then the results are ordered by name.
- @param "Search" (optional.String) - Search criteria. The syntax of this parameter is similar to the syntax of the `where` clause of a SQL statement. Allowed fields in the search depend on the resource type: * Cluster: id, created_at, updated_at, owner, organisation_id, name, state, client_id * Namespace: id, created_at, updated_at, name, cluster_id, owner, expiration, tenant_user_id, tenant_organisation_id, state * Connector Types: id, created_at, updated_at, version, name, description, label, channel, featured_rank, pricing_tier * Connectors: id, created_at, updated_at, name, owner, organisation_id, connector_type_id, desired_state, state, channel, namespace_id, kafka_id, kafka_bootstrap_server, service_account_client_id, schema_registry_id, schema_registry_url Allowed operators are `<>`, `=`, `IN`, `NOT IN`, `LIKE`, or `ILIKE`. Allowed conjunctive operators are `AND` and `OR`. However, you can use a maximum of 10 conjunctions in a search query. Examples: To return a Connector Type with the name `aws-sqs-source` and the channel `stable`, use the following syntax: ``` name = aws-sqs-source and channel = stable ``` To return a connector instance with a name that starts with `aws`, use the following syntax: ``` name like aws%25 ``` To return a connector type with a name containing `aws` matching any character case combination, use the following syntax: ``` name ilike %25aws%25 ``` To return connector types with labels `category-featured` AND `source`, use the following syntax: ``` label like %25category-featured%25source% ``` NOTE: The AND operator does not work for multiple labels. Instead use an alphabetically ascending order pattern with the LIKE operator to match an aggregated list of ',' separated label names. If the parameter isn't provided, or if the value is empty, then all the resources that the user has permission to see are returned. Note. If the query is invalid, an error is returned.
@return ConnectorClusterAdminList
func (*ConnectorClustersAdminApiService) PatchConnector ¶
func (a *ConnectorClustersAdminApiService) PatchConnector(ctx _context.Context, connectorId string, body map[string]interface{}) (ConnectorAdminView, *_nethttp.Response, error)
PatchConnector Patch a connector Patch a connector
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param connectorId The id of the connector to delete
- @param body Data to patch the connector with
@return ConnectorAdminView
func (*ConnectorClustersAdminApiService) PatchConnectorClusterDeploymentAdmin ¶
func (a *ConnectorClustersAdminApiService) PatchConnectorClusterDeploymentAdmin(ctx _context.Context, connectorClusterId string, deploymentId string, body map[string]interface{}) (ConnectorDeploymentAdminView, *_nethttp.Response, error)
PatchConnectorClusterDeploymentAdmin Patch a deployment Patch a deployment
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param connectorClusterId The id of the connector cluster
- @param deploymentId The id of the connector deployment
- @param body Data to patch the deployment with
@return ConnectorDeploymentAdminView
type ConnectorDeploymentAdminSpec ¶
type ConnectorDeploymentAdminSpec struct { ConnectorId string `json:"connector_id,omitempty"` ConnectorResourceVersion int64 `json:"connector_resource_version,omitempty"` ConnectorTypeId string `json:"connector_type_id,omitempty"` ClusterId string `json:"cluster_id,omitempty"` NamespaceId string `json:"namespace_id,omitempty"` // allow the connector to upgrade to a new operator // Deprecated DeprecatedAllowUpgrade bool `json:"allow_upgrade,omitempty"` // an optional operator id that the connector should be run under. OperatorId string `json:"operator_id,omitempty"` DesiredState ConnectorDesiredState `json:"desired_state,omitempty"` ShardMetadata map[string]interface{} `json:"shard_metadata,omitempty"` }
ConnectorDeploymentAdminSpec Holds the deployment specification of a connector
type ConnectorDeploymentAdminStatus ¶
type ConnectorDeploymentAdminStatus struct { Phase ConnectorState `json:"phase,omitempty"` ResourceVersion int64 `json:"resource_version,omitempty"` ShardMetadata ConnectorDeploymentAdminStatusShardMetadata `json:"shard_metadata,omitempty"` Operators ConnectorDeploymentAdminStatusOperators `json:"operators,omitempty"` Conditions []MetaV1Condition `json:"conditions,omitempty"` }
ConnectorDeploymentAdminStatus The status of connector deployment
type ConnectorDeploymentAdminStatusOperators ¶
type ConnectorDeploymentAdminStatusOperators struct { Assigned ConnectorOperator `json:"assigned,omitempty"` Available ConnectorOperator `json:"available,omitempty"` }
ConnectorDeploymentAdminStatusOperators struct for ConnectorDeploymentAdminStatusOperators
type ConnectorDeploymentAdminStatusShardMetadata ¶
type ConnectorDeploymentAdminStatusShardMetadata struct { Assigned ConnectorShardMetadata `json:"assigned,omitempty"` Available ConnectorShardMetadata `json:"available,omitempty"` }
ConnectorDeploymentAdminStatusShardMetadata latest available revision of deployment shared metadata
type ConnectorDeploymentAdminView ¶
type ConnectorDeploymentAdminView struct { Id string `json:"id,omitempty"` Kind string `json:"kind,omitempty"` Href string `json:"href,omitempty"` Metadata ConnectorDeploymentAdminViewAllOfMetadata `json:"metadata,omitempty"` Spec ConnectorDeploymentAdminSpec `json:"spec,omitempty"` Status ConnectorDeploymentAdminStatus `json:"status,omitempty"` }
ConnectorDeploymentAdminView Holds the deployment configuration of a connector
type ConnectorDeploymentAdminViewAllOfMetadata ¶
type ConnectorDeploymentAdminViewAllOfMetadata struct { CreatedAt time.Time `json:"created_at"` UpdatedAt time.Time `json:"updated_at"` ResourceVersion int64 `json:"resource_version"` ResolvedSecrets bool `json:"resolved_secrets"` // Name-value string annotations for resource Annotations map[string]string `json:"annotations,omitempty"` }
ConnectorDeploymentAdminViewAllOfMetadata struct for ConnectorDeploymentAdminViewAllOfMetadata
type ConnectorDeploymentAdminViewList ¶
type ConnectorDeploymentAdminViewList struct { Kind string `json:"kind"` Page int32 `json:"page"` Size int32 `json:"size"` Total int32 `json:"total"` Items []ConnectorDeploymentAdminView `json:"items"` }
ConnectorDeploymentAdminViewList struct for ConnectorDeploymentAdminViewList
type ConnectorDesiredState ¶
type ConnectorDesiredState string
ConnectorDesiredState the model 'ConnectorDesiredState'
const ( CONNECTORDESIREDSTATE_UNASSIGNED ConnectorDesiredState = "unassigned" CONNECTORDESIREDSTATE_READY ConnectorDesiredState = "ready" CONNECTORDESIREDSTATE_STOPPED ConnectorDesiredState = "stopped" CONNECTORDESIREDSTATE_DELETED ConnectorDesiredState = "deleted" )
List of ConnectorDesiredState
type ConnectorMeta ¶
type ConnectorMeta struct { Owner string `json:"owner,omitempty"` CreatedAt time.Time `json:"created_at,omitempty"` ModifiedAt time.Time `json:"modified_at,omitempty"` Name string `json:"name"` ConnectorTypeId string `json:"connector_type_id"` NamespaceId string `json:"namespace_id"` Channel Channel `json:"channel,omitempty"` DesiredState ConnectorDesiredState `json:"desired_state"` // Name-value string annotations for resource Annotations map[string]string `json:"annotations,omitempty"` ResourceVersion int64 `json:"resource_version,omitempty"` }
ConnectorMeta struct for ConnectorMeta
type ConnectorNamespace ¶
type ConnectorNamespace struct { Id string `json:"id"` Kind string `json:"kind,omitempty"` Href string `json:"href,omitempty"` Owner string `json:"owner,omitempty"` CreatedAt time.Time `json:"created_at,omitempty"` ModifiedAt time.Time `json:"modified_at,omitempty"` Name string `json:"name"` // Name-value string annotations for resource Annotations map[string]string `json:"annotations,omitempty"` ResourceVersion int64 `json:"resource_version"` Quota ConnectorNamespaceQuota `json:"quota,omitempty"` ClusterId string `json:"cluster_id"` // Namespace expiration timestamp in RFC 3339 format Expiration string `json:"expiration,omitempty"` Tenant ConnectorNamespaceTenant `json:"tenant"` Status ConnectorNamespaceStatus `json:"status"` }
ConnectorNamespace A connector namespace
type ConnectorNamespaceEvalRequest ¶
type ConnectorNamespaceEvalRequest struct { // Namespace name must match pattern `^(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$`, or it may be empty to be auto-generated. Name string `json:"name,omitempty"` // Name-value string annotations for resource Annotations map[string]string `json:"annotations,omitempty"` }
ConnectorNamespaceEvalRequest An evaluation connector namespace create request
type ConnectorNamespaceList ¶
type ConnectorNamespaceList struct { Kind string `json:"kind"` Page int32 `json:"page"` Size int32 `json:"size"` Total int32 `json:"total"` Items []ConnectorNamespace `json:"items"` }
ConnectorNamespaceList struct for ConnectorNamespaceList
type ConnectorNamespaceMeta ¶
type ConnectorNamespaceMeta struct { Owner string `json:"owner,omitempty"` CreatedAt time.Time `json:"created_at,omitempty"` ModifiedAt time.Time `json:"modified_at,omitempty"` // Namespace name must match pattern `^(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$`, or it may be empty to be auto-generated. Name string `json:"name,omitempty"` // Name-value string annotations for resource Annotations map[string]string `json:"annotations,omitempty"` ResourceVersion int64 `json:"resource_version,omitempty"` Quota ConnectorNamespaceQuota `json:"quota,omitempty"` }
ConnectorNamespaceMeta struct for ConnectorNamespaceMeta
type ConnectorNamespaceQuota ¶
type ConnectorNamespaceQuota struct { Connectors int32 `json:"connectors,omitempty"` // Memory quota for limits or requests MemoryRequests string `json:"memory_requests,omitempty"` // Memory quota for limits or requests MemoryLimits string `json:"memory_limits,omitempty"` // CPU quota for limits or requests CpuRequests string `json:"cpu_requests,omitempty"` // CPU quota for limits or requests CpuLimits string `json:"cpu_limits,omitempty"` }
ConnectorNamespaceQuota struct for ConnectorNamespaceQuota
type ConnectorNamespaceRequestMeta ¶
type ConnectorNamespaceRequestMeta struct { // Namespace name must match pattern `^(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$`, or it may be empty to be auto-generated. Name string `json:"name,omitempty"` // Name-value string annotations for resource Annotations map[string]string `json:"annotations,omitempty"` }
ConnectorNamespaceRequestMeta struct for ConnectorNamespaceRequestMeta
type ConnectorNamespaceState ¶
type ConnectorNamespaceState string
ConnectorNamespaceState the model 'ConnectorNamespaceState'
const ( CONNECTORNAMESPACESTATE_DISCONNECTED ConnectorNamespaceState = "disconnected" CONNECTORNAMESPACESTATE_READY ConnectorNamespaceState = "ready" CONNECTORNAMESPACESTATE_DELETING ConnectorNamespaceState = "deleting" CONNECTORNAMESPACESTATE_DELETED ConnectorNamespaceState = "deleted" )
List of ConnectorNamespaceState
type ConnectorNamespaceStatus ¶
type ConnectorNamespaceStatus struct { State ConnectorNamespaceState `json:"state"` Version string `json:"version,omitempty"` ConnectorsDeployed int32 `json:"connectors_deployed"` Error string `json:"error,omitempty"` }
ConnectorNamespaceStatus struct for ConnectorNamespaceStatus
type ConnectorNamespaceTenant ¶
type ConnectorNamespaceTenant struct { Kind ConnectorNamespaceTenantKind `json:"kind"` // Either user or organisation id depending on the value of kind Id string `json:"id"` }
ConnectorNamespaceTenant struct for ConnectorNamespaceTenant
type ConnectorNamespaceTenantKind ¶
type ConnectorNamespaceTenantKind string
ConnectorNamespaceTenantKind the model 'ConnectorNamespaceTenantKind'
const ( CONNECTORNAMESPACETENANTKIND_USER ConnectorNamespaceTenantKind = "user" CONNECTORNAMESPACETENANTKIND_ORGANISATION ConnectorNamespaceTenantKind = "organisation" )
List of ConnectorNamespaceTenantKind
type ConnectorNamespaceWithTenantRequest ¶
type ConnectorNamespaceWithTenantRequest struct { // Namespace name must match pattern `^(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])?$`, or it may be empty to be auto-generated. Name string `json:"name"` // Name-value string annotations for resource Annotations map[string]string `json:"annotations,omitempty"` ClusterId string `json:"cluster_id"` Tenant ConnectorNamespaceTenant `json:"tenant"` // Namespace expiration timestamp in RFC 3339 format Expiration string `json:"expiration,omitempty"` }
ConnectorNamespaceWithTenantRequest struct for ConnectorNamespaceWithTenantRequest
type ConnectorNamespacesAdminApiService ¶
type ConnectorNamespacesAdminApiService service
ConnectorNamespacesAdminApiService ConnectorNamespacesAdminApi service
func (*ConnectorNamespacesAdminApiService) CreateConnectorNamespace ¶
func (a *ConnectorNamespacesAdminApiService) CreateConnectorNamespace(ctx _context.Context, connectorNamespaceWithTenantRequest ConnectorNamespaceWithTenantRequest) (ConnectorNamespace, *_nethttp.Response, error)
CreateConnectorNamespace Create a connector namespace
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param connectorNamespaceWithTenantRequest Namespace to create
@return ConnectorNamespace
func (*ConnectorNamespacesAdminApiService) GetConnectorNamespaces ¶
func (a *ConnectorNamespacesAdminApiService) GetConnectorNamespaces(ctx _context.Context, localVarOptionals *GetConnectorNamespacesOpts) (ConnectorNamespaceList, *_nethttp.Response, error)
GetConnectorNamespaces Get a list of available connector namespaces
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param optional nil or *GetConnectorNamespacesOpts - Optional Parameters:
- @param "Page" (optional.String) - Page index
- @param "Size" (optional.String) - Number of items in each page
- @param "OrderBy" (optional.String) - Specifies the order by criteria. The syntax of this parameter is similar to the syntax of the `order by` clause of an SQL statement. Each query can be ordered by any of the underlying resource fields supported in the search parameter. For example, to return all Connector types ordered by their name, use the following syntax: ```sql name asc ``` To return all Connector types ordered by their name _and_ version, use the following syntax: ```sql name asc, version asc ``` To return connector types with labels `category-featured` AND `source`, use the following syntax: ``` label like %25category-featured%25source% ``` NOTE: The AND operator does not work for multiple labels. Instead use an alphabetically ascending order pattern with the LIKE operator to match an aggregated list of ',' separated label names. If the parameter isn't provided, or if the value is empty, then the results are ordered by name.
- @param "Search" (optional.String) - Search criteria. The syntax of this parameter is similar to the syntax of the `where` clause of a SQL statement. Allowed fields in the search depend on the resource type: * Cluster: id, created_at, updated_at, owner, organisation_id, name, state, client_id * Namespace: id, created_at, updated_at, name, cluster_id, owner, expiration, tenant_user_id, tenant_organisation_id, state * Connector Types: id, created_at, updated_at, version, name, description, label, channel, featured_rank, pricing_tier * Connectors: id, created_at, updated_at, name, owner, organisation_id, connector_type_id, desired_state, state, channel, namespace_id, kafka_id, kafka_bootstrap_server, service_account_client_id, schema_registry_id, schema_registry_url Allowed operators are `<>`, `=`, `IN`, `NOT IN`, `LIKE`, or `ILIKE`. Allowed conjunctive operators are `AND` and `OR`. However, you can use a maximum of 10 conjunctions in a search query. Examples: To return a Connector Type with the name `aws-sqs-source` and the channel `stable`, use the following syntax: ``` name = aws-sqs-source and channel = stable ``` To return a connector instance with a name that starts with `aws`, use the following syntax: ``` name like aws%25 ``` To return a connector type with a name containing `aws` matching any character case combination, use the following syntax: ``` name ilike %25aws%25 ``` To return connector types with labels `category-featured` AND `source`, use the following syntax: ``` label like %25category-featured%25source% ``` NOTE: The AND operator does not work for multiple labels. Instead use an alphabetically ascending order pattern with the LIKE operator to match an aggregated list of ',' separated label names. If the parameter isn't provided, or if the value is empty, then all the resources that the user has permission to see are returned. Note. If the query is invalid, an error is returned.
@return ConnectorNamespaceList
type ConnectorOperator ¶
type ConnectorOperator struct { // the id of the operator Id string `json:"id,omitempty"` // the type of the operator Type string `json:"type,omitempty"` // the version of the operator Version string `json:"version,omitempty"` }
ConnectorOperator identifies an operator that runs on the fleet shards used to manage connectors.
type ConnectorRequestMeta ¶
type ConnectorRequestMeta struct { Name string `json:"name"` ConnectorTypeId string `json:"connector_type_id"` NamespaceId string `json:"namespace_id"` Channel Channel `json:"channel,omitempty"` DesiredState ConnectorDesiredState `json:"desired_state"` // Name-value string annotations for resource Annotations map[string]string `json:"annotations,omitempty"` }
ConnectorRequestMeta struct for ConnectorRequestMeta
type ConnectorShardMetadata ¶
type ConnectorShardMetadata struct { // the channel of the shard metadata Channel string `json:"channel,omitempty"` // the connector type id this shard metadata refers to ConnectorTypeId string `json:"connector_type_id,omitempty"` // the revision of the shard metadate Revision int64 `json:"revision,omitempty"` }
ConnectorShardMetadata identifies a shard metadata of a connector type.
type ConnectorState ¶
type ConnectorState string
ConnectorState the model 'ConnectorState'
const ( CONNECTORSTATE_ASSIGNING ConnectorState = "assigning" CONNECTORSTATE_ASSIGNED ConnectorState = "assigned" CONNECTORSTATE_UPDATING ConnectorState = "updating" CONNECTORSTATE_READY ConnectorState = "ready" CONNECTORSTATE_STOPPED ConnectorState = "stopped" CONNECTORSTATE_FAILED ConnectorState = "failed" CONNECTORSTATE_DELETING ConnectorState = "deleting" CONNECTORSTATE_DELETED ConnectorState = "deleted" CONNECTORSTATE_PROVISIONING ConnectorState = "provisioning" CONNECTORSTATE_DEPROVISIONING ConnectorState = "deprovisioning" )
List of ConnectorState
type ConnectorStatus ¶
type ConnectorStatus struct {
Status ConnectorStatusStatus `json:"status,omitempty"`
}
ConnectorStatus struct for ConnectorStatus
type ConnectorStatusStatus ¶
type ConnectorStatusStatus struct { State ConnectorState `json:"state,omitempty"` Error string `json:"error,omitempty"` }
ConnectorStatusStatus struct for ConnectorStatusStatus
type ConnectorType ¶
type ConnectorType struct { Id string `json:"id,omitempty"` Kind string `json:"kind,omitempty"` Href string `json:"href,omitempty"` // Name of the connector type. Name string `json:"name"` // Version of the connector type. Version string `json:"version"` // Channels of the connector type. Channels []Channel `json:"channels,omitempty"` // A description of the connector. Description string `json:"description,omitempty"` // Connector type is deprecated and removed from the catalog. Deprecated bool `json:"deprecated,omitempty"` // URL to an icon of the connector. IconHref string `json:"icon_href,omitempty"` // Labels used to categorize the connector Labels []string `json:"labels,omitempty"` // Name-value string annotations for resource Annotations map[string]string `json:"annotations,omitempty"` // Ranking for featured connectors FeaturedRank int32 `json:"featured_rank,omitempty"` // The capabilities supported by the connector Capabilities []string `json:"capabilities,omitempty"` // A json schema that can be used to validate a ConnectorRequest connector field. Schema map[string]interface{} `json:"schema"` }
ConnectorType Represents a connector type supported by the API
type ConnectorTypeAdminView ¶
type ConnectorTypeAdminView struct { Id string `json:"id,omitempty"` Kind string `json:"kind,omitempty"` Href string `json:"href,omitempty"` // Name of the connector type. Name string `json:"name"` // Version of the connector type. Version string `json:"version"` Channels map[string]ConnectorTypeChannel `json:"channels,omitempty"` // A description of the connector. Description string `json:"description,omitempty"` // Connector type is deprecated and removed from the catalog. Deprecated bool `json:"deprecated,omitempty"` // URL to an icon of the connector. IconHref string `json:"icon_href,omitempty"` // Labels used to categorize the connector Labels []string `json:"labels,omitempty"` // Name-value string annotations for resource Annotations map[string]string `json:"annotations,omitempty"` // Ranking for featured connectors FeaturedRank int32 `json:"featured_rank,omitempty"` // The capabilities supported by the connector Capabilities []string `json:"capabilities,omitempty"` // A json schema that can be used to validate a ConnectorRequest connector field. Schema map[string]interface{} `json:"schema"` }
ConnectorTypeAdminView Holds the connector type
type ConnectorTypeAdminViewList ¶
type ConnectorTypeAdminViewList struct { Kind string `json:"kind"` Page int32 `json:"page"` Size int32 `json:"size"` Total int32 `json:"total"` Items []ConnectorTypeAdminView `json:"items"` }
ConnectorTypeAdminViewList struct for ConnectorTypeAdminViewList
type ConnectorTypeChannel ¶
type ConnectorTypeChannel struct {
ShardMetadata map[string]interface{} `json:"shard_metadata,omitempty"`
}
ConnectorTypeChannel Holds the connector type channel
type ConnectorTypesApiService ¶
type ConnectorTypesApiService service
ConnectorTypesApiService ConnectorTypesApi service
func (*ConnectorTypesApiService) GetConnectorTypeByID ¶
func (a *ConnectorTypesApiService) GetConnectorTypeByID(ctx _context.Context, connectorTypeId string) (ConnectorTypeAdminView, *_nethttp.Response, error)
GetConnectorTypeByID Get a connector type by id Get a connector type by id
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param connectorTypeId The id of the connector type
@return ConnectorTypeAdminView
func (*ConnectorTypesApiService) GetConnectorTypes ¶
func (a *ConnectorTypesApiService) GetConnectorTypes(ctx _context.Context, localVarOptionals *GetConnectorTypesOpts) (ConnectorTypeAdminViewList, *_nethttp.Response, error)
GetConnectorTypes Returns a list of connector types Returns a list of connector types
- @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
- @param optional nil or *GetConnectorTypesOpts - Optional Parameters:
- @param "Page" (optional.String) - Page index
- @param "Size" (optional.String) - Number of items in each page
- @param "OrderBy" (optional.String) - Specifies the order by criteria. The syntax of this parameter is similar to the syntax of the `order by` clause of an SQL statement. Each query can be ordered by any of the underlying resource fields supported in the search parameter. For example, to return all Connector types ordered by their name, use the following syntax: ```sql name asc ``` To return all Connector types ordered by their name _and_ version, use the following syntax: ```sql name asc, version asc ``` To return connector types with labels `category-featured` AND `source`, use the following syntax: ``` label like %25category-featured%25source% ``` NOTE: The AND operator does not work for multiple labels. Instead use an alphabetically ascending order pattern with the LIKE operator to match an aggregated list of ',' separated label names. If the parameter isn't provided, or if the value is empty, then the results are ordered by name.
- @param "Search" (optional.String) - Search criteria. The syntax of this parameter is similar to the syntax of the `where` clause of a SQL statement. Allowed fields in the search depend on the resource type: * Cluster: id, created_at, updated_at, owner, organisation_id, name, state, client_id * Namespace: id, created_at, updated_at, name, cluster_id, owner, expiration, tenant_user_id, tenant_organisation_id, state * Connector Types: id, created_at, updated_at, version, name, description, label, channel, featured_rank, pricing_tier * Connectors: id, created_at, updated_at, name, owner, organisation_id, connector_type_id, desired_state, state, channel, namespace_id, kafka_id, kafka_bootstrap_server, service_account_client_id, schema_registry_id, schema_registry_url Allowed operators are `<>`, `=`, `IN`, `NOT IN`, `LIKE`, or `ILIKE`. Allowed conjunctive operators are `AND` and `OR`. However, you can use a maximum of 10 conjunctions in a search query. Examples: To return a Connector Type with the name `aws-sqs-source` and the channel `stable`, use the following syntax: ``` name = aws-sqs-source and channel = stable ``` To return a connector instance with a name that starts with `aws`, use the following syntax: ``` name like aws%25 ``` To return a connector type with a name containing `aws` matching any character case combination, use the following syntax: ``` name ilike %25aws%25 ``` To return connector types with labels `category-featured` AND `source`, use the following syntax: ``` label like %25category-featured%25source% ``` NOTE: The AND operator does not work for multiple labels. Instead use an alphabetically ascending order pattern with the LIKE operator to match an aggregated list of ',' separated label names. If the parameter isn't provided, or if the value is empty, then all the resources that the user has permission to see are returned. Note. If the query is invalid, an error is returned.
@return ConnectorTypeAdminViewList
type DeleteConnectorNamespaceOpts ¶
DeleteConnectorNamespaceOpts Optional parameters for the method 'DeleteConnectorNamespace'
type DeleteConnectorOpts ¶
DeleteConnectorOpts Optional parameters for the method 'DeleteConnector'
type Error ¶
type Error struct { Reason string `json:"reason"` OperationId string `json:"operation_id,omitempty"` Id string `json:"id"` Kind string `json:"kind"` Href string `json:"href"` Code string `json:"code"` }
Error struct for Error
type GenericOpenAPIError ¶
type GenericOpenAPIError struct {
// contains filtered or unexported fields
}
GenericOpenAPIError Provides access to the body, error and model on returned errors.
func (GenericOpenAPIError) Body ¶
func (e GenericOpenAPIError) Body() []byte
Body returns the raw bytes of the response
func (GenericOpenAPIError) Error ¶
func (e GenericOpenAPIError) Error() string
Error returns non-empty string if there was an error.
func (GenericOpenAPIError) Model ¶
func (e GenericOpenAPIError) Model() interface{}
Model returns the unpacked model of the error
type GetClusterConnectorsOpts ¶
type GetClusterConnectorsOpts struct { Page optional.String Size optional.String OrderBy optional.String Search optional.String }
GetClusterConnectorsOpts Optional parameters for the method 'GetClusterConnectors'
type GetClusterDeploymentsOpts ¶
type GetClusterDeploymentsOpts struct { ChannelUpdates optional.Bool OperatorUpdates optional.Bool DanglingDeployments optional.Bool Page optional.String Size optional.String OrderBy optional.String }
GetClusterDeploymentsOpts Optional parameters for the method 'GetClusterDeployments'
type GetClusterNamespacesOpts ¶
type GetClusterNamespacesOpts struct { Page optional.String Size optional.String OrderBy optional.String Search optional.String }
GetClusterNamespacesOpts Optional parameters for the method 'GetClusterNamespaces'
type GetConnectorNamespacesOpts ¶
type GetConnectorNamespacesOpts struct { Page optional.String Size optional.String OrderBy optional.String Search optional.String }
GetConnectorNamespacesOpts Optional parameters for the method 'GetConnectorNamespaces'
type GetConnectorTypesOpts ¶
type GetConnectorTypesOpts struct { Page optional.String Size optional.String OrderBy optional.String Search optional.String }
GetConnectorTypesOpts Optional parameters for the method 'GetConnectorTypes'
type GetNamespaceConnectorsOpts ¶
type GetNamespaceConnectorsOpts struct { Page optional.String Size optional.String OrderBy optional.String Search optional.String }
GetNamespaceConnectorsOpts Optional parameters for the method 'GetNamespaceConnectors'
type GetNamespaceDeploymentsOpts ¶
type GetNamespaceDeploymentsOpts struct { ChannelUpdates optional.Bool OperatorUpdates optional.Bool DanglingDeployments optional.Bool Page optional.String Size optional.String OrderBy optional.String }
GetNamespaceDeploymentsOpts Optional parameters for the method 'GetNamespaceDeployments'
type List ¶
type List struct { Kind string `json:"kind"` Page int32 `json:"page"` Size int32 `json:"size"` Total int32 `json:"total"` }
List struct for List
type ListConnectorClustersOpts ¶
type ListConnectorClustersOpts struct { Page optional.String Size optional.String OrderBy optional.String Search optional.String }
ListConnectorClustersOpts Optional parameters for the method 'ListConnectorClusters'
type MetaV1Condition ¶
type MetaV1Condition struct { Type string `json:"type,omitempty"` Reason string `json:"reason,omitempty"` Message string `json:"message,omitempty"` Status string `json:"status,omitempty"` LastTransitionTime string `json:"last_transition_time,omitempty"` }
MetaV1Condition struct for MetaV1Condition
type ObjectMeta ¶
type ObjectMeta struct { Owner string `json:"owner,omitempty"` CreatedAt time.Time `json:"created_at,omitempty"` ModifiedAt time.Time `json:"modified_at,omitempty"` }
ObjectMeta struct for ObjectMeta
type ObjectReference ¶
type ObjectReference struct { Id string `json:"id,omitempty"` Kind string `json:"kind,omitempty"` Href string `json:"href,omitempty"` }
ObjectReference struct for ObjectReference
type ServerConfiguration ¶
type ServerConfiguration struct { Url string Description string Variables map[string]ServerVariable }
ServerConfiguration stores the information about a server
type ServerVariable ¶
ServerVariable stores the information about a server variable
Source Files ¶
- api_connector_clusters_admin.go
- api_connector_namespaces_admin.go
- api_connector_types.go
- client.go
- configuration.go
- model_channel.go
- model_connector_admin_request.go
- model_connector_admin_view.go
- model_connector_admin_view_list.go
- model_connector_cluster_admin_list.go
- model_connector_cluster_admin_status.go
- model_connector_cluster_admin_status_operators.go
- model_connector_cluster_admin_view.go
- model_connector_cluster_meta.go
- model_connector_cluster_platform.go
- model_connector_cluster_request_meta.go
- model_connector_cluster_state.go
- model_connector_deployment_admin_spec.go
- model_connector_deployment_admin_status.go
- model_connector_deployment_admin_status_operators.go
- model_connector_deployment_admin_status_shard_metadata.go
- model_connector_deployment_admin_view.go
- model_connector_deployment_admin_view_all_of_metadata.go
- model_connector_deployment_admin_view_list.go
- model_connector_desired_state.go
- model_connector_meta.go
- model_connector_namespace.go
- model_connector_namespace_eval_request.go
- model_connector_namespace_list.go
- model_connector_namespace_meta.go
- model_connector_namespace_quota.go
- model_connector_namespace_request_meta.go
- model_connector_namespace_state.go
- model_connector_namespace_status.go
- model_connector_namespace_tenant.go
- model_connector_namespace_tenant_kind.go
- model_connector_namespace_with_tenant_request.go
- model_connector_operator.go
- model_connector_request_meta.go
- model_connector_shard_metadata.go
- model_connector_state.go
- model_connector_status.go
- model_connector_status_status.go
- model_connector_type.go
- model_connector_type_admin_view.go
- model_connector_type_admin_view_list.go
- model_connector_type_channel.go
- model_error.go
- model_list.go
- model_meta_v1_condition.go
- model_object_meta.go
- model_object_reference.go
- response.go