# README

Go API client for v1

Introduction

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.

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

ClassMethodHTTP requestDescription
ConsumerSharedResourcesCdxV1ApiGetCdxV1ConsumerSharedResourceGet /cdx/v1/consumer-shared-resources/{id}Read a Consumer Shared Resource
ConsumerSharedResourcesCdxV1ApiImageCdxV1ConsumerSharedResourceGet /cdx/v1/consumer-shared-resources/{id}/images/{file_name}Get image for shared resource
ConsumerSharedResourcesCdxV1ApiListCdxV1ConsumerSharedResourcesGet /cdx/v1/consumer-shared-resourcesList of Consumer Shared Resources
ConsumerSharedResourcesCdxV1ApiNetworkCdxV1ConsumerSharedResourceGet /cdx/v1/consumer-shared-resources/{id}:networkGet shared resource's network configuration
ConsumerSharesCdxV1ApiDeleteCdxV1ConsumerShareDelete /cdx/v1/consumer-shares/{id}Delete a Consumer Share
ConsumerSharesCdxV1ApiGetCdxV1ConsumerShareGet /cdx/v1/consumer-shares/{id}Read a Consumer Share
ConsumerSharesCdxV1ApiListCdxV1ConsumerSharesGet /cdx/v1/consumer-sharesList of Consumer Shares
OptInsCdxV1ApiGetCdxV1OptInGet /cdx/v1/opt-inRead the organization's stream sharing opt-in settings
OptInsCdxV1ApiUpdateCdxV1OptInPatch /cdx/v1/opt-inSet the organization's stream sharing opt-in settings
ProviderSharedResourcesCdxV1ApiDeleteImageCdxV1ProviderSharedResourceDelete /cdx/v1/provider-shared-resources/{id}/images/{file_name}Delete_Image a Provider Shared Resource
ProviderSharedResourcesCdxV1ApiGetCdxV1ProviderSharedResourceGet /cdx/v1/provider-shared-resources/{id}Read a Provider Shared Resource
ProviderSharedResourcesCdxV1ApiListCdxV1ProviderSharedResourcesGet /cdx/v1/provider-shared-resourcesList of Provider Shared Resources
ProviderSharedResourcesCdxV1ApiUpdateCdxV1ProviderSharedResourcePatch /cdx/v1/provider-shared-resources/{id}Update a Provider Shared Resource
ProviderSharedResourcesCdxV1ApiUploadImageCdxV1ProviderSharedResourcePost /cdx/v1/provider-shared-resources/{id}/images/{file_name}Upload image for shared resource
ProviderSharedResourcesCdxV1ApiViewImageCdxV1ProviderSharedResourceGet /cdx/v1/provider-shared-resources/{id}/images/{file_name}View_Image a Provider Shared Resource
ProviderSharesCdxV1ApiCreateCdxV1ProviderSharePost /cdx/v1/provider-sharesCreate a provider share
ProviderSharesCdxV1ApiDeleteCdxV1ProviderShareDelete /cdx/v1/provider-shares/{id}Delete a Provider Share
ProviderSharesCdxV1ApiGetCdxV1ProviderShareGet /cdx/v1/provider-shares/{id}Read a Provider Share
ProviderSharesCdxV1ApiListCdxV1ProviderSharesGet /cdx/v1/provider-sharesList of Provider Shares
ProviderSharesCdxV1ApiResendCdxV1ProviderSharePost /cdx/v1/provider-shares/{id}:resendResend
SharedTokensCdxV1ApiRedeemCdxV1SharedTokenPost /cdx/v1/shared-tokens:redeemRedeem token
SharedTokensCdxV1ApiResourcesCdxV1SharedTokenPost /cdx/v1/shared-tokens:resourcesValidate token to view shared resources

Documentation For Models

Documentation For Authorization

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)

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]

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
CdxV1AwsNetworkAsCdxV1NetworkCloudOneOf is a convenience function that returns CdxV1AwsNetwork wrapped in CdxV1NetworkCloudOneOf.
CdxV1AzureNetworkAsCdxV1NetworkCloudOneOf is a convenience function that returns CdxV1AzureNetwork wrapped in CdxV1NetworkCloudOneOf.
CdxV1EmailConsumerRestrictionAsCdxV1CreateProviderShareRequestConsumerRestrictionOneOf is a convenience function that returns CdxV1EmailConsumerRestriction wrapped in CdxV1CreateProviderShareRequestConsumerRestrictionOneOf.
CdxV1EmailConsumerRestrictionAsCdxV1ProviderShareConsumerRestrictionOneOf is a convenience function that returns CdxV1EmailConsumerRestriction wrapped in CdxV1ProviderShareConsumerRestrictionOneOf.
CdxV1GcpNetworkAsCdxV1NetworkCloudOneOf is a convenience function that returns CdxV1GcpNetwork wrapped in CdxV1NetworkCloudOneOf.
CdxV1SharedGroupAsCdxV1RedeemTokenResponseResourcesOneOf is a convenience function that returns CdxV1SharedGroup wrapped in CdxV1RedeemTokenResponseResourcesOneOf.
CdxV1SharedSubjectAsCdxV1RedeemTokenResponseResourcesOneOf is a convenience function that returns CdxV1SharedSubject wrapped in CdxV1RedeemTokenResponseResourcesOneOf.
CdxV1SharedTopicAsCdxV1RedeemTokenResponseResourcesOneOf is a convenience function that returns CdxV1SharedTopic wrapped in CdxV1RedeemTokenResponseResourcesOneOf.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResponse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewCdxV1AwsNetwork instantiates a new CdxV1AwsNetwork object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCdxV1AwsNetworkWithDefaults instantiates a new CdxV1AwsNetwork object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCdxV1AzureNetwork instantiates a new CdxV1AzureNetwork object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCdxV1AzureNetworkWithDefaults instantiates a new CdxV1AzureNetwork object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCdxV1ConnectionTypes instantiates a new CdxV1ConnectionTypes object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCdxV1ConnectionTypesWithDefaults instantiates a new CdxV1ConnectionTypes object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCdxV1ConsumerShare instantiates a new CdxV1ConsumerShare object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCdxV1ConsumerSharedResource instantiates a new CdxV1ConsumerSharedResource object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCdxV1ConsumerSharedResourceList instantiates a new CdxV1ConsumerSharedResourceList object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCdxV1ConsumerSharedResourceListWithDefaults instantiates a new CdxV1ConsumerSharedResourceList object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCdxV1ConsumerSharedResourceWithDefaults instantiates a new CdxV1ConsumerSharedResource object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCdxV1ConsumerShareList instantiates a new CdxV1ConsumerShareList object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCdxV1ConsumerShareListWithDefaults instantiates a new CdxV1ConsumerShareList object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCdxV1ConsumerShareStatus instantiates a new CdxV1ConsumerShareStatus object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCdxV1ConsumerShareStatusWithDefaults instantiates a new CdxV1ConsumerShareStatus object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCdxV1ConsumerShareWithDefaults instantiates a new CdxV1ConsumerShare object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCdxV1CreateProviderShareRequest instantiates a new CdxV1CreateProviderShareRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCdxV1CreateProviderShareRequestWithDefaults instantiates a new CdxV1CreateProviderShareRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCdxV1EmailConsumerRestriction instantiates a new CdxV1EmailConsumerRestriction object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCdxV1EmailConsumerRestrictionWithDefaults instantiates a new CdxV1EmailConsumerRestriction object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCdxV1GcpNetwork instantiates a new CdxV1GcpNetwork object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCdxV1GcpNetworkWithDefaults instantiates a new CdxV1GcpNetwork object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCdxV1Network instantiates a new CdxV1Network object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCdxV1NetworkWithDefaults instantiates a new CdxV1Network object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCdxV1OptIn instantiates a new CdxV1OptIn object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCdxV1OptInWithDefaults instantiates a new CdxV1OptIn object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCdxV1ProviderShare instantiates a new CdxV1ProviderShare object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCdxV1ProviderSharedResource instantiates a new CdxV1ProviderSharedResource object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCdxV1ProviderSharedResourceList instantiates a new CdxV1ProviderSharedResourceList object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCdxV1ProviderSharedResourceListWithDefaults instantiates a new CdxV1ProviderSharedResourceList object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCdxV1ProviderSharedResourceUpdate instantiates a new CdxV1ProviderSharedResourceUpdate object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCdxV1ProviderSharedResourceUpdateWithDefaults instantiates a new CdxV1ProviderSharedResourceUpdate object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCdxV1ProviderSharedResourceWithDefaults instantiates a new CdxV1ProviderSharedResource object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCdxV1ProviderShareList instantiates a new CdxV1ProviderShareList object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCdxV1ProviderShareListWithDefaults instantiates a new CdxV1ProviderShareList object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCdxV1ProviderShareStatus instantiates a new CdxV1ProviderShareStatus object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCdxV1ProviderShareStatusWithDefaults instantiates a new CdxV1ProviderShareStatus object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCdxV1ProviderShareWithDefaults instantiates a new CdxV1ProviderShare object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCdxV1RedeemTokenRequest instantiates a new CdxV1RedeemTokenRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCdxV1RedeemTokenRequestWithDefaults instantiates a new CdxV1RedeemTokenRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCdxV1RedeemTokenResponse instantiates a new CdxV1RedeemTokenResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCdxV1RedeemTokenResponseWithDefaults instantiates a new CdxV1RedeemTokenResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCdxV1Schema instantiates a new CdxV1Schema object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCdxV1SchemaWithDefaults instantiates a new CdxV1Schema object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCdxV1SharedGroup instantiates a new CdxV1SharedGroup object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCdxV1SharedGroupWithDefaults instantiates a new CdxV1SharedGroup object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCdxV1SharedSubject instantiates a new CdxV1SharedSubject object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCdxV1SharedSubjectWithDefaults instantiates a new CdxV1SharedSubject object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCdxV1SharedToken instantiates a new CdxV1SharedToken object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCdxV1SharedTokenWithDefaults instantiates a new CdxV1SharedToken object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCdxV1SharedTopic instantiates a new CdxV1SharedTopic object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCdxV1SharedTopicWithDefaults instantiates a new CdxV1SharedTopic object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewConfiguration returns a new Configuration object.
NewEnvScopedObjectReference instantiates a new EnvScopedObjectReference object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewEnvScopedObjectReferenceWithDefaults instantiates a new EnvScopedObjectReference object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewError instantiates a new Error object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewErrorSource instantiates a new ErrorSource object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewErrorSourceWithDefaults instantiates a new ErrorSource object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewErrorWithDefaults instantiates a new Error object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewFailure instantiates a new Failure object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewFailureWithDefaults instantiates a new Failure object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewGlobalObjectReference instantiates a new GlobalObjectReference object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewGlobalObjectReferenceWithDefaults instantiates a new GlobalObjectReference object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewInlineResponse200 instantiates a new InlineResponse200 object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewInlineResponse200WithDefaults instantiates a new InlineResponse200 object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewListMeta instantiates a new ListMeta object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewListMetaWithDefaults instantiates a new ListMeta object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewObjectMeta instantiates a new ObjectMeta object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewObjectMetaWithDefaults instantiates a new ObjectMeta object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewObjectReference instantiates a new ObjectReference object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewObjectReferenceWithDefaults instantiates a new ObjectReference object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTypedEnvScopedObjectReference instantiates a new TypedEnvScopedObjectReference object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTypedEnvScopedObjectReferenceWithDefaults instantiates a new TypedEnvScopedObjectReference object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTypedGlobalObjectReference instantiates a new TypedGlobalObjectReference object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTypedGlobalObjectReferenceWithDefaults instantiates a new TypedGlobalObjectReference object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
PtrBool is a helper routine that returns a pointer to given boolean value.
PtrFloat32 is a helper routine that returns a pointer to given float value.
PtrFloat64 is a helper routine that returns a pointer to given float value.
PtrInt is a helper routine that returns a pointer to given integer value.
PtrInt32 is a helper routine that returns a pointer to given integer value.
PtrInt64 is a helper routine that returns a pointer to given integer value.
PtrString is a helper routine that returns a pointer to given string value.
PtrTime is helper routine that returns a pointer to given Time value.

# Variables

ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKeys takes a string apikey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
ContextOperationServerIndices uses a server configuration from the index mapping.
ContextOperationServerVariables overrides a server configuration variables using operation specific values.
ContextServerIndex uses a server configuration from the index.
ContextServerVariables overrides a server configuration variables.

# Structs

APIClient manages communication with the Stream Share APIs API v0.1.0-alpha0 In most cases there should be only one, shared, APIClient.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
APIResponse stores the API response returned by the server.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
CdxV1AwsNetwork The AWS network details.
CdxV1AzureNetwork The Azure network details.
CdxV1ConnectionTypes The network connection types of the provider shared cluster.
CdxV1ConsumerShare Resources accessible by the consumer ## The Consumer Shared Resources Model <SchemaDefinition schemaRef=\"#/components/schemas/cdx.v1.ConsumerSharedResource\" />.
CdxV1ConsumerSharedResource Resources accessible by the consumer ## The Consumer Shared Resources Model <SchemaDefinition schemaRef=\"#/components/schemas/cdx.v1.ConsumerSharedResource\" />.
CdxV1ConsumerSharedResourceList Resources accessible by the consumer ## The Consumer Shared Resources Model <SchemaDefinition schemaRef=\"#/components/schemas/cdx.v1.ConsumerSharedResource\" />.
CdxV1ConsumerShareList Resources accessible by the consumer ## The Consumer Shared Resources Model <SchemaDefinition schemaRef=\"#/components/schemas/cdx.v1.ConsumerSharedResource\" />.
CdxV1ConsumerShareStatus The status of the Consumer Share.
CdxV1CreateProviderShareRequest Create share request.
CdxV1CreateProviderShareRequestConsumerRestrictionOneOf - struct for CdxV1CreateProviderShareRequestConsumerRestrictionOneOf.
CdxV1EmailConsumerRestriction Consumer restrictions limits by authenticated user's email.
CdxV1GcpNetwork The GCP network details.
CdxV1Network The shared cluster's network configurations for consumer to setup private link.
CdxV1NetworkCloudOneOf - struct for CdxV1NetworkCloudOneOf.
CdxV1OptIn Stream sharing opt in options ## The Opt Ins Model <SchemaDefinition schemaRef=\"#/components/schemas/cdx.v1.OptIn\" />.
CdxV1ProviderShare Resources shared by the provider ## The Provider Shared Resources Model <SchemaDefinition schemaRef=\"#/components/schemas/cdx.v1.ProviderSharedResource\" />.
CdxV1ProviderShareConsumerRestrictionOneOf - struct for CdxV1ProviderShareConsumerRestrictionOneOf.
CdxV1ProviderSharedResource Resources shared by the provider ## The Provider Shared Resources Model <SchemaDefinition schemaRef=\"#/components/schemas/cdx.v1.ProviderSharedResource\" />.
CdxV1ProviderSharedResourceList Resources shared by the provider ## The Provider Shared Resources Model <SchemaDefinition schemaRef=\"#/components/schemas/cdx.v1.ProviderSharedResource\" />.
CdxV1ProviderSharedResourceUpdate Resources shared by the provider ## The Provider Shared Resources Model <SchemaDefinition schemaRef=\"#/components/schemas/cdx.v1.ProviderSharedResource\" />.
CdxV1ProviderShareList Resources shared by the provider ## The Provider Shared Resources Model <SchemaDefinition schemaRef=\"#/components/schemas/cdx.v1.ProviderSharedResource\" />.
CdxV1ProviderShareStatus The status of the Provider Share.
CdxV1RedeemTokenRequest Redeem share with token request parameters.
CdxV1RedeemTokenResponse Share details for the consumer org or user.
CdxV1RedeemTokenResponseResourcesOneOf - struct for CdxV1RedeemTokenResponseResourcesOneOf.
CdxV1Schema Schema.
CdxV1SharedGroup The shared consumer group.
CdxV1SharedSubject The shared resource details.
CdxV1SharedToken Encrypted Token shared with consumer ## The Shared Tokens Model <SchemaDefinition schemaRef=\"#/components/schemas/cdx.v1.SharedToken\" />.
CdxV1SharedTopic The shared resource details.
Configuration stores the configuration of the API client.
EnvScopedObjectReference ObjectReference provides information for you to locate the referred object.
Error Describes a particular error encountered while performing an operation.
ErrorSource If this error was caused by a particular part of the API request, the source will point to the query string parameter or request body property that caused it.
Failure Provides information about problems encountered while performing an operation.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
GlobalObjectReference ObjectReference provides information for you to locate the referred object.
InlineResponse200 struct for InlineResponse200.
ListMeta ListMeta describes metadata that resource collections may have.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ObjectMeta ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
ObjectReference ObjectReference provides information for you to locate the referred object.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
TypedEnvScopedObjectReference ObjectReference provides information for you to locate the referred object.
TypedGlobalObjectReference ObjectReference provides information for you to locate the referred object.

# Interfaces

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

ConsumerSharedResourcesCdxV1ApiService ConsumerSharedResourcesCdxV1Api service.
ConsumerSharesCdxV1ApiService ConsumerSharesCdxV1Api service.
OptInsCdxV1ApiService OptInsCdxV1Api service.
ProviderSharedResourcesCdxV1ApiService ProviderSharedResourcesCdxV1Api service.
ProviderSharesCdxV1ApiService ProviderSharesCdxV1Api service.
ServerConfigurations stores multiple ServerConfiguration items.
SharedTokensCdxV1ApiService SharedTokensCdxV1Api service.