Go API client for v1

Network API

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: 0.0.1-alpha1
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://confluent.slack.com/app_redirect?channel=cire-traffic-eng

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

Put the package under your project folder and add the following in import:

import sw "./v1"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), sw.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), sw.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), sw.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sw.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api.confluent.cloud

Class	Method	HTTP request	Description
GatewaysNetworkingV1Api	GetNetworkingV1Gateway	Get /networking/v1/gateways/{id}	Read a Gateway
GatewaysNetworkingV1Api	ListNetworkingV1Gateways	Get /networking/v1/gateways	List of Gateways
NetworkLinkEndpointsNetworkingV1Api	CreateNetworkingV1NetworkLinkEndpoint	Post /networking/v1/network-link-endpoints	Create a Network Link Endpoint
NetworkLinkEndpointsNetworkingV1Api	DeleteNetworkingV1NetworkLinkEndpoint	Delete /networking/v1/network-link-endpoints/{id}	Delete a Network Link Endpoint
NetworkLinkEndpointsNetworkingV1Api	GetNetworkingV1NetworkLinkEndpoint	Get /networking/v1/network-link-endpoints/{id}	Read a Network Link Endpoint
NetworkLinkEndpointsNetworkingV1Api	ListNetworkingV1NetworkLinkEndpoints	Get /networking/v1/network-link-endpoints	List of Network Link Endpoints
NetworkLinkEndpointsNetworkingV1Api	UpdateNetworkingV1NetworkLinkEndpoint	Patch /networking/v1/network-link-endpoints/{id}	Update a Network Link Endpoint
NetworkLinkServiceAssociationsNetworkingV1Api	GetNetworkingV1NetworkLinkServiceAssociation	Get /networking/v1/network-link-service-associations/{id}	Read a Network Link Service Association
NetworkLinkServiceAssociationsNetworkingV1Api	ListNetworkingV1NetworkLinkServiceAssociations	Get /networking/v1/network-link-service-associations	List of Network Link Service Associations
NetworkLinkServicesNetworkingV1Api	CreateNetworkingV1NetworkLinkService	Post /networking/v1/network-link-services	Create a Network Link Service
NetworkLinkServicesNetworkingV1Api	DeleteNetworkingV1NetworkLinkService	Delete /networking/v1/network-link-services/{id}	Delete a Network Link Service
NetworkLinkServicesNetworkingV1Api	GetNetworkingV1NetworkLinkService	Get /networking/v1/network-link-services/{id}	Read a Network Link Service
NetworkLinkServicesNetworkingV1Api	ListNetworkingV1NetworkLinkServices	Get /networking/v1/network-link-services	List of Network Link Services
NetworkLinkServicesNetworkingV1Api	UpdateNetworkingV1NetworkLinkService	Patch /networking/v1/network-link-services/{id}	Update a Network Link Service
NetworksNetworkingV1Api	CreateNetworkingV1Network	Post /networking/v1/networks	Create a Network
NetworksNetworkingV1Api	DeleteNetworkingV1Network	Delete /networking/v1/networks/{id}	Delete a Network
NetworksNetworkingV1Api	GetNetworkingV1Network	Get /networking/v1/networks/{id}	Read a Network
NetworksNetworkingV1Api	ListNetworkingV1Networks	Get /networking/v1/networks	List of Networks
NetworksNetworkingV1Api	UpdateNetworkingV1Network	Patch /networking/v1/networks/{id}	Update a Network
PeeringsNetworkingV1Api	CreateNetworkingV1Peering	Post /networking/v1/peerings	Create a Peering
PeeringsNetworkingV1Api	DeleteNetworkingV1Peering	Delete /networking/v1/peerings/{id}	Delete a Peering
PeeringsNetworkingV1Api	GetNetworkingV1Peering	Get /networking/v1/peerings/{id}	Read a Peering
PeeringsNetworkingV1Api	ListNetworkingV1Peerings	Get /networking/v1/peerings	List of Peerings
PeeringsNetworkingV1Api	UpdateNetworkingV1Peering	Patch /networking/v1/peerings/{id}	Update a Peering
PrivateLinkAccessesNetworkingV1Api	CreateNetworkingV1PrivateLinkAccess	Post /networking/v1/private-link-accesses	Create a Private Link Access
PrivateLinkAccessesNetworkingV1Api	DeleteNetworkingV1PrivateLinkAccess	Delete /networking/v1/private-link-accesses/{id}	Delete a Private Link Access
PrivateLinkAccessesNetworkingV1Api	GetNetworkingV1PrivateLinkAccess	Get /networking/v1/private-link-accesses/{id}	Read a Private Link Access
PrivateLinkAccessesNetworkingV1Api	ListNetworkingV1PrivateLinkAccesses	Get /networking/v1/private-link-accesses	List of Private Link Accesses
PrivateLinkAccessesNetworkingV1Api	UpdateNetworkingV1PrivateLinkAccess	Patch /networking/v1/private-link-accesses/{id}	Update a Private Link Access
TransitGatewayAttachmentsNetworkingV1Api	CreateNetworkingV1TransitGatewayAttachment	Post /networking/v1/transit-gateway-attachments	Create a Transit Gateway Attachment
TransitGatewayAttachmentsNetworkingV1Api	DeleteNetworkingV1TransitGatewayAttachment	Delete /networking/v1/transit-gateway-attachments/{id}	Delete a Transit Gateway Attachment
TransitGatewayAttachmentsNetworkingV1Api	GetNetworkingV1TransitGatewayAttachment	Get /networking/v1/transit-gateway-attachments/{id}	Read a Transit Gateway Attachment
TransitGatewayAttachmentsNetworkingV1Api	ListNetworkingV1TransitGatewayAttachments	Get /networking/v1/transit-gateway-attachments	List of Transit Gateway Attachments
TransitGatewayAttachmentsNetworkingV1Api	UpdateNetworkingV1TransitGatewayAttachment	Patch /networking/v1/transit-gateway-attachments/{id}	Update a Transit Gateway Attachment

Documentation For Models

• EnvScopedObjectReference
• Error
• ErrorSource
• Failure
• GlobalObjectReference
• ListMeta
• NetworkingV1AwsEgressPrivateLinkGatewaySpec
• NetworkingV1AwsEgressPrivateLinkGatewayStatus
• NetworkingV1AwsNetwork
• NetworkingV1AwsPeering
• NetworkingV1AwsPeeringGatewaySpec
• NetworkingV1AwsPrivateLinkAccess
• NetworkingV1AwsTransitGatewayAttachment
• NetworkingV1AwsTransitGatewayAttachmentStatus
• NetworkingV1AzureEgressPrivateLinkGatewaySpec
• NetworkingV1AzureEgressPrivateLinkGatewayStatus
• NetworkingV1AzureNetwork
• NetworkingV1AzurePeering
• NetworkingV1AzurePeeringGatewaySpec
• NetworkingV1AzurePrivateLinkAccess
• NetworkingV1DnsConfig
• NetworkingV1Gateway
• NetworkingV1GatewayList
• NetworkingV1GatewaySpec
• NetworkingV1GatewaySpecConfigOneOf
• NetworkingV1GatewayStatus
• NetworkingV1GatewayStatusCloudGatewayOneOf
• NetworkingV1GcpNetwork
• NetworkingV1GcpPeering
• NetworkingV1GcpPrivateServiceConnectAccess
• NetworkingV1Network
• NetworkingV1NetworkLinkEndpoint
• NetworkingV1NetworkLinkEndpointList
• NetworkingV1NetworkLinkEndpointSpec
• NetworkingV1NetworkLinkEndpointSpecUpdate
• NetworkingV1NetworkLinkEndpointStatus
• NetworkingV1NetworkLinkEndpointUpdate
• NetworkingV1NetworkLinkService
• NetworkingV1NetworkLinkServiceAcceptPolicy
• NetworkingV1NetworkLinkServiceAssociation
• NetworkingV1NetworkLinkServiceAssociationList
• NetworkingV1NetworkLinkServiceAssociationSpec
• NetworkingV1NetworkLinkServiceAssociationStatus
• NetworkingV1NetworkLinkServiceList
• NetworkingV1NetworkLinkServiceSpec
• NetworkingV1NetworkLinkServiceSpecUpdate
• NetworkingV1NetworkLinkServiceStatus
• NetworkingV1NetworkLinkServiceUpdate
• NetworkingV1NetworkList
• NetworkingV1NetworkSpec
• NetworkingV1NetworkSpecUpdate
• NetworkingV1NetworkStatus
• NetworkingV1NetworkStatusCloudOneOf
• NetworkingV1NetworkUpdate
• NetworkingV1Peering
• NetworkingV1PeeringList
• NetworkingV1PeeringSpec
• NetworkingV1PeeringSpecCloudOneOf
• NetworkingV1PeeringSpecUpdate
• NetworkingV1PeeringStatus
• NetworkingV1PeeringUpdate
• NetworkingV1PrivateLinkAccess
• NetworkingV1PrivateLinkAccessList
• NetworkingV1PrivateLinkAccessSpec
• NetworkingV1PrivateLinkAccessSpecCloudOneOf
• NetworkingV1PrivateLinkAccessSpecUpdate
• NetworkingV1PrivateLinkAccessStatus
• NetworkingV1PrivateLinkAccessUpdate
• NetworkingV1TransitGatewayAttachment
• NetworkingV1TransitGatewayAttachmentList
• NetworkingV1TransitGatewayAttachmentSpec
• NetworkingV1TransitGatewayAttachmentSpecCloudOneOf
• NetworkingV1TransitGatewayAttachmentSpecUpdate
• NetworkingV1TransitGatewayAttachmentStatus
• NetworkingV1TransitGatewayAttachmentStatusCloudOneOf
• NetworkingV1TransitGatewayAttachmentUpdate
• NetworkingV1ZoneInfo
• ObjectMeta
• ObjectReference
• TypedEnvScopedObjectReference

Documentation For Authorization

cloud-api-key

• Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

confluent-sts-access-token

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes: N/A

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Author

[email protected]