# README
Go API client for couchbasecapella
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
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: 2.0.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen
Configuring environment variables
In order to set up authentication a programmatic API key must be generated. Instructions to generate your API key can be found in the Couchbase Capella Public API documentation.
You will need to provide your credentials for authentication via the environment variables,
CBC_ACCESS_KEY and CBC_SECRET_KEY,
for your access and secret API Key Pair respectively.
$ export CBC_ACCESS_KEY="xxxx"
$ export CBC_SECRET_KEY="xxxx"
Installation
Install the following dependency:
go get github.com/couchbasecloud/couchbase-capella-api-go-client
Add the following in import:
import "github.com/couchbasecloud/couchbase-capella-api-go-client"
Creating an API client
ctx := context.WithValue(
context.Background(),
couchbasecloud.ContextAPIKeys,
map[string]couchbasecloud.APIKey{
"accessKey": {
Key: os.Getenv("CBC_ACCESS_KEY"),
},
"secretKey": {
Key: os.Getenv("CBC_SECRET_KEY"),
},
},
)
configuration := couchbasecloud.NewConfiguration()
apiClient := couchbasecloud.NewAPIClient(configuration)
API usage - Retrieving a project
projectId := "39eidkdhe-48389-dk38-8e84-34038djsjks"
project, _, err := apiClient.ProjectsApi.ProjectsShow(ctx, projectId).Execute()
if err != nil {
t.Fatalf("Error when calling `ProjectsApi.ProjectsShow(ctx)`: %v\n", err)
}
fmt.Fprintf(os.Stdout, "Response from `ProjectsApi.ProjectsShow(ctx)`: %v\n", project)
To use a proxy server, 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://cloudapi.cloud.couchbase.com
| Class | Method | HTTP request | Description |
|---|---|---|---|
| CloudsApi | CloudsList | Get /v2/clouds | List Clouds |
| CloudsApi | CloudsShow | Get /v2/clouds/{id} | Get Cloud |
| ClustersApi | ClustersCreate | Post /v2/clusters | Create cluster |
| ClustersApi | ClustersCreateAllowlistEntry | Post /v2/clusters/{id}/allowlist | Adds entry to allowlist |
| ClustersApi | ClustersCreateBucket | Post /v2/clusters/{id}/buckets | Create bucket in cluster |
| ClustersApi | ClustersCreateUser | Post /v2/clusters/{id}/users | Create Database User |
| ClustersApi | ClustersDelete | Delete /v2/clusters/{id} | Delete cluster |
| ClustersApi | ClustersDeleteAllowlistEntry | Delete /v2/clusters/{id}/allowlist | Delete entry from allowlist |
| ClustersApi | ClustersDeleteBucket | Delete /v2/clusters/{id}/buckets | Delete bucket in cluster |
| ClustersApi | ClustersDeleteSingleBucket | Delete /v2/clusters/{id}/buckets/{bucketId} | Delete an existing bucket |
| ClustersApi | ClustersDeleteUser | Delete /v2/clusters/{id}/users/{username} | Delete Database User |
| ClustersApi | ClustersGetAllowlist | Get /v2/clusters/{id}/allowlist | Get current allowlist |
| ClustersApi | ClustersGetCertificate | Get /v2/clusters/{id}/certificate | Get Cluster Certificate |
| ClustersApi | ClustersHealth | Get /v2/clusters/{id}/health | Get Cluster Health |
| ClustersApi | ClustersList | Get /v2/clusters | List Clusters |
| ClustersApi | ClustersListBuckets | Get /v2/clusters/{id}/buckets | List cluster buckets |
| ClustersApi | ClustersListUsers | Get /v2/clusters/{id}/users | List Database Users |
| ClustersApi | ClustersShow | Get /v2/clusters/{id} | Get Cluster |
| ClustersApi | ClustersStatus | Get /v2/clusters/{id}/status | Get Cluster Status |
| ClustersApi | ClustersUpdateAllowlist | Put /v2/clusters/{id}/allowlist | Update the allowlist for a cluster |
| ClustersApi | ClustersUpdateBucket | Put /v2/clusters/{id}/buckets | Update bucket in cluster |
| ClustersApi | ClustersUpdateSingleBucket | Put /v2/clusters/{id}/buckets/{bucketId} | Update an existing bucket |
| ClustersApi | ClustersUpdateUser | Put /v2/clusters/{id}/users/{username} | Update Database User |
| ClustersV3Api | ClustersV3create | Post /v3/clusters | Create Cluster V3 |
| ClustersV3Api | ClustersV3createUser | Post /v3/clusters/{id}/users | Create cluster user |
| ClustersV3Api | ClustersV3delete | Delete /v3/clusters/{id} | Delete Cluster V3 |
| ClustersV3Api | ClustersV3list | Get /v3/clusters | List all clusters v3 |
| ClustersV3Api | ClustersV3show | Get /v3/clusters/{id} | Get Cluster Info V3 |
| ClustersV3Api | ClustersV3status | Get /v3/clusters/{id}/status | Get Cluster Status V3 |
| ClustersV3Api | ClustersV3updateMeta | Put /v3/clusters/{id}/meta | Update Cluster Metadata V3 |
| ClustersV3Api | ClustersV3updateServers | Put /v3/clusters/{id}/servers | Update Cluster Servers V3 |
| ClustersV3Api | ClustersV3updateSupport | Put /v3/clusters/{id}/support | Update Cluster Support Package V3 |
| ProjectsApi | ProjectsCreate | Post /v2/projects | Create project |
| ProjectsApi | ProjectsDelete | Delete /v2/projects/{id} | Delete project |
| ProjectsApi | ProjectsList | Get /v2/projects | List Projects |
| ProjectsApi | ProjectsShow | Get /v2/projects/{id} | Get project by ID |
| StatusApi | StatusShow | Get /v2/status | API status |
| UsersApi | UsersList | Get /v2/users | List Users |
Documentation For Models
- AWSProviderSettings
- AllowListEntry
- AllowListRules
- AllowListStates
- AppendAllowListRequest
- AwsInstances
- AwsRegions
- AzureInstances
- AzureProviderSettings
- AzureRegions
- AzureVolumeTypes
- BucketRole
- BucketRoleTypes
- BucketStats
- Cloud
- CloudProviderSettings
- CloudStatus
- CloudSummary
- CloudVersion
- Cluster
- ClusterHealth
- ClusterHealthResponse
- ClusterStatus
- ClusterStatusResponse
- ClusterSummary
- ClusterVersion
- ClusterVersions
- ConflictResolution
- CouchbaseBucketSpec
- CouchbaseServices
- CreateClusterRequest
- CreateClusterRequestSupportPackage
- CreateDatabaseUserRequest
- CreateProjectRequest
- Cursor
- CursorHrefs
- CursorPages
- DeleteAllowListEntryRequest
- DeleteBucketRequest
- GetCertificateResponse
- Goof
- ListBucketItem
- ListCloudsResponse
- ListClustersResponse
- ListDatabaseUsersResponseItem
- ListProjectsResponse
- ListUsersResponse
- ListUsersResponseItem
- NodeStats
- Project
- Provider
- Regions
- Server
- ServerAws
- ServerAzure
- ServiceStats
- StatusOK
- SupportPackageType
- SupportTimezones
- UpdateBucketRequest
- UpdateDatabaseUserRequest
- V3BucketRoles
- V3Cluster
- V3ClusterList
- V3ClusterListData
- V3ClusterListDataItems
- V3ClusterPlace
- V3ClusterServers
- V3ClusterStatus
- V3ClusterStatusResponse
- V3ClusterStorage
- V3ClusterVersion
- V3ClusterVersionComponents
- V3CouchbaseServices
- V3CreateClusterRequest
- V3CreateClusterUserRequest
- V3CreateClusterUserRequestBuckets
- V3Environment
- V3Place
- V3PlaceHosted
- V3Provider
- V3Servers
- V3ServersStorage
- V3StorageType
- V3SupportPackage
- V3SupportPackageTimezones
- V3SupportPackageType
- V3UpdateClusterMetaRequest
- V3UpdateClusterServersRequest
- V3UpdateClusterSupportRequest
- V3UpdateClusterSupportRequestSupportPackage
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:
PtrBoolPtrIntPtrInt32PtrInt64PtrFloatPtrFloat32PtrFloat64PtrStringPtrTime
Author
# Functions
AWSProviderSettingsAsCloudProviderSettings is a convenience function that returns AWSProviderSettings wrapped in CloudProviderSettings.
AwsRegionsAsRegions is a convenience function that returns AwsRegions wrapped in Regions.
AzureProviderSettingsAsCloudProviderSettings is a convenience function that returns AzureProviderSettings wrapped in CloudProviderSettings.
AzureRegionsAsRegions is a convenience function that returns AzureRegions wrapped in Regions.
CacheExpires helper function to determine remaining time before repeating a request.
NewAllowListEntry instantiates a new AllowListEntry 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.
NewAllowListEntryWithDefaults instantiates a new AllowListEntry 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.
NewAllowListRulesFromValue returns a pointer to a valid AllowListRules for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewAllowListStatesFromValue returns a pointer to a valid AllowListStates for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResponse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewAppendAllowListRequest instantiates a new AppendAllowListRequest 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.
NewAppendAllowListRequestWithDefaults instantiates a new AppendAllowListRequest 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.
NewAwsInstancesFromValue returns a pointer to a valid AwsInstances for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewAWSProviderSettings instantiates a new AWSProviderSettings 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.
NewAWSProviderSettingsWithDefaults instantiates a new AWSProviderSettings 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.
NewAwsRegionsFromValue returns a pointer to a valid AwsRegions for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewAzureInstancesFromValue returns a pointer to a valid AzureInstances for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewAzureProviderSettings instantiates a new AzureProviderSettings 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.
NewAzureProviderSettingsWithDefaults instantiates a new AzureProviderSettings 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.
NewAzureRegionsFromValue returns a pointer to a valid AzureRegions for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewAzureVolumeTypesFromValue returns a pointer to a valid AzureVolumeTypes for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewBucketRole instantiates a new BucketRole 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.
NewBucketRoleTypesFromValue returns a pointer to a valid BucketRoleTypes for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewBucketRoleWithDefaults instantiates a new BucketRole 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.
NewBucketStats instantiates a new BucketStats 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.
NewBucketStatsWithDefaults instantiates a new BucketStats 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.
NewCloud instantiates a new Cloud 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.
NewCloudStatusFromValue returns a pointer to a valid CloudStatus for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewCloudSummary instantiates a new CloudSummary 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.
NewCloudSummaryWithDefaults instantiates a new CloudSummary 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.
NewCloudVersion instantiates a new CloudVersion 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.
NewCloudVersionWithDefaults instantiates a new CloudVersion 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.
NewCloudWithDefaults instantiates a new Cloud 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.
NewCluster instantiates a new Cluster 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.
NewClusterHealthFromValue returns a pointer to a valid ClusterHealth for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewClusterHealthResponse instantiates a new ClusterHealthResponse 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.
NewClusterHealthResponseWithDefaults instantiates a new ClusterHealthResponse 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.
NewClusterStatusFromValue returns a pointer to a valid ClusterStatus for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewClusterStatusResponse instantiates a new ClusterStatusResponse 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.
NewClusterStatusResponseWithDefaults instantiates a new ClusterStatusResponse 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.
NewClusterSummary instantiates a new ClusterSummary 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.
NewClusterSummaryWithDefaults instantiates a new ClusterSummary 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.
NewClusterVersion instantiates a new ClusterVersion 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.
NewClusterVersionsFromValue returns a pointer to a valid ClusterVersions for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewClusterVersionWithDefaults instantiates a new ClusterVersion 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.
NewClusterWithDefaults instantiates a new Cluster 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.
NewConflictResolutionFromValue returns a pointer to a valid ConflictResolution for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewCouchbaseBucketSpec instantiates a new CouchbaseBucketSpec 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.
NewCouchbaseBucketSpecWithDefaults instantiates a new CouchbaseBucketSpec 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.
NewCouchbaseServicesFromValue returns a pointer to a valid CouchbaseServices for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewCreateClusterRequest instantiates a new CreateClusterRequest 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.
NewCreateClusterRequestSupportPackage instantiates a new CreateClusterRequestSupportPackage 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.
NewCreateClusterRequestSupportPackageWithDefaults instantiates a new CreateClusterRequestSupportPackage 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.
NewCreateClusterRequestWithDefaults instantiates a new CreateClusterRequest 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.
NewCreateDatabaseUserRequest instantiates a new CreateDatabaseUserRequest 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.
NewCreateDatabaseUserRequestWithDefaults instantiates a new CreateDatabaseUserRequest 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.
NewCreateProjectRequest instantiates a new CreateProjectRequest 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.
NewCreateProjectRequestWithDefaults instantiates a new CreateProjectRequest 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.
NewCursor instantiates a new Cursor 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.
NewCursorHrefs instantiates a new CursorHrefs 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.
NewCursorHrefsWithDefaults instantiates a new CursorHrefs 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.
NewCursorPages instantiates a new CursorPages 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.
NewCursorPagesWithDefaults instantiates a new CursorPages 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.
NewCursorWithDefaults instantiates a new Cursor 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.
NewDeleteAllowListEntryRequest instantiates a new DeleteAllowListEntryRequest 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.
NewDeleteAllowListEntryRequestWithDefaults instantiates a new DeleteAllowListEntryRequest 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.
NewDeleteBucketRequest instantiates a new DeleteBucketRequest 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.
NewDeleteBucketRequestWithDefaults instantiates a new DeleteBucketRequest 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.
NewGetCertificateResponse instantiates a new GetCertificateResponse 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.
NewGetCertificateResponseWithDefaults instantiates a new GetCertificateResponse 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.
NewGoof instantiates a new Goof 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.
NewGoofWithDefaults instantiates a new Goof 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.
NewListBucketItem instantiates a new ListBucketItem 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.
NewListBucketItemWithDefaults instantiates a new ListBucketItem 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.
NewListCloudsResponse instantiates a new ListCloudsResponse 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.
NewListCloudsResponseWithDefaults instantiates a new ListCloudsResponse 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.
NewListClustersResponse instantiates a new ListClustersResponse 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.
NewListClustersResponseWithDefaults instantiates a new ListClustersResponse 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.
NewListDatabaseUsersResponseItem instantiates a new ListDatabaseUsersResponseItem 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.
NewListDatabaseUsersResponseItemWithDefaults instantiates a new ListDatabaseUsersResponseItem 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.
NewListProjectsResponse instantiates a new ListProjectsResponse 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.
NewListProjectsResponseWithDefaults instantiates a new ListProjectsResponse 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.
NewListUsersResponse instantiates a new ListUsersResponse 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.
NewListUsersResponseItem instantiates a new ListUsersResponseItem 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.
NewListUsersResponseItemWithDefaults instantiates a new ListUsersResponseItem 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.
NewListUsersResponseWithDefaults instantiates a new ListUsersResponse 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.
NewNodeStats instantiates a new NodeStats 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.
NewNodeStatsWithDefaults instantiates a new NodeStats 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
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
No description provided by the author
NewProject instantiates a new Project 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.
NewProjectWithDefaults instantiates a new Project 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.
NewProviderFromValue returns a pointer to a valid Provider for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewServer instantiates a new Server 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.
NewServerAws instantiates a new ServerAws 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.
NewServerAwsWithDefaults instantiates a new ServerAws 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.
NewServerAzure instantiates a new ServerAzure 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.
NewServerAzureWithDefaults instantiates a new ServerAzure 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.
NewServerWithDefaults instantiates a new Server 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.
NewServiceStats instantiates a new ServiceStats 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.
NewServiceStatsWithDefaults instantiates a new ServiceStats 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.
NewStatusOK instantiates a new StatusOK 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.
NewStatusOKWithDefaults instantiates a new StatusOK 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.
NewSupportPackageTypeFromValue returns a pointer to a valid SupportPackageType for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewSupportTimezonesFromValue returns a pointer to a valid SupportTimezones for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewUpdateBucketRequest instantiates a new UpdateBucketRequest 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.
NewUpdateBucketRequestWithDefaults instantiates a new UpdateBucketRequest 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.
NewUpdateDatabaseUserRequest instantiates a new UpdateDatabaseUserRequest 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.
NewUpdateDatabaseUserRequestWithDefaults instantiates a new UpdateDatabaseUserRequest 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.
NewV3BucketRolesFromValue returns a pointer to a valid V3BucketRoles for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewV3Cluster instantiates a new V3Cluster 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.
NewV3ClusterList instantiates a new V3ClusterList 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.
NewV3ClusterListData instantiates a new V3ClusterListData 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.
NewV3ClusterListDataItems instantiates a new V3ClusterListDataItems 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.
NewV3ClusterListDataItemsWithDefaults instantiates a new V3ClusterListDataItems 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.
NewV3ClusterListDataWithDefaults instantiates a new V3ClusterListData 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.
NewV3ClusterListWithDefaults instantiates a new V3ClusterList 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.
NewV3ClusterPlace instantiates a new V3ClusterPlace 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.
NewV3ClusterPlaceWithDefaults instantiates a new V3ClusterPlace 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.
NewV3ClusterServers instantiates a new V3ClusterServers 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.
NewV3ClusterServersWithDefaults instantiates a new V3ClusterServers 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.
NewV3ClusterStatusFromValue returns a pointer to a valid V3ClusterStatus for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewV3ClusterStatusResponse instantiates a new V3ClusterStatusResponse 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.
NewV3ClusterStatusResponseWithDefaults instantiates a new V3ClusterStatusResponse 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.
NewV3ClusterStorage instantiates a new V3ClusterStorage 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.
NewV3ClusterStorageWithDefaults instantiates a new V3ClusterStorage 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.
NewV3ClusterVersion instantiates a new V3ClusterVersion 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.
NewV3ClusterVersionComponents instantiates a new V3ClusterVersionComponents 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.
NewV3ClusterVersionComponentsWithDefaults instantiates a new V3ClusterVersionComponents 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.
NewV3ClusterVersionWithDefaults instantiates a new V3ClusterVersion 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.
NewV3ClusterWithDefaults instantiates a new V3Cluster 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.
NewV3CouchbaseServicesFromValue returns a pointer to a valid V3CouchbaseServices for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewV3CreateClusterRequest instantiates a new V3CreateClusterRequest 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.
NewV3CreateClusterRequestWithDefaults instantiates a new V3CreateClusterRequest 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.
NewV3CreateClusterUserRequest instantiates a new V3CreateClusterUserRequest 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.
NewV3CreateClusterUserRequestBuckets instantiates a new V3CreateClusterUserRequestBuckets 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.
NewV3CreateClusterUserRequestBucketsWithDefaults instantiates a new V3CreateClusterUserRequestBuckets 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.
NewV3CreateClusterUserRequestWithDefaults instantiates a new V3CreateClusterUserRequest 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.
NewV3EnvironmentFromValue returns a pointer to a valid V3Environment for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewV3Place instantiates a new V3Place 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.
NewV3PlaceHosted instantiates a new V3PlaceHosted 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.
NewV3PlaceHostedWithDefaults instantiates a new V3PlaceHosted 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.
NewV3PlaceWithDefaults instantiates a new V3Place 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.
NewV3ProviderFromValue returns a pointer to a valid V3Provider for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewV3Servers instantiates a new V3Servers 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.
NewV3ServersStorage instantiates a new V3ServersStorage 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.
NewV3ServersStorageWithDefaults instantiates a new V3ServersStorage 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.
NewV3ServersWithDefaults instantiates a new V3Servers 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.
NewV3StorageTypeFromValue returns a pointer to a valid V3StorageType for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewV3SupportPackage instantiates a new V3SupportPackage 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.
NewV3SupportPackageTimezonesFromValue returns a pointer to a valid V3SupportPackageTimezones for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewV3SupportPackageTypeFromValue returns a pointer to a valid V3SupportPackageType for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewV3SupportPackageWithDefaults instantiates a new V3SupportPackage 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.
NewV3UpdateClusterMetaRequest instantiates a new V3UpdateClusterMetaRequest 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.
NewV3UpdateClusterMetaRequestWithDefaults instantiates a new V3UpdateClusterMetaRequest 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.
NewV3UpdateClusterServersRequest instantiates a new V3UpdateClusterServersRequest 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.
NewV3UpdateClusterServersRequestWithDefaults instantiates a new V3UpdateClusterServersRequest 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.
NewV3UpdateClusterSupportRequest instantiates a new V3UpdateClusterSupportRequest 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.
NewV3UpdateClusterSupportRequestSupportPackage instantiates a new V3UpdateClusterSupportRequestSupportPackage 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.
NewV3UpdateClusterSupportRequestSupportPackageWithDefaults instantiates a new V3UpdateClusterSupportRequestSupportPackage 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.
NewV3UpdateClusterSupportRequestWithDefaults instantiates a new V3UpdateClusterSupportRequest 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.
# Constants
List of allowListRules.
List of allowListRules.
List of allowListStates.
List of allowListStates.
List of allowListStates.
List of allowListStates.
List of awsInstances.
List of awsInstances.
List of awsInstances.
List of awsInstances.
List of awsInstances.
List of awsInstances.
List of awsInstances.
List of awsInstances.
List of awsInstances.
List of awsInstances.
List of awsInstances.
List of awsInstances.
List of awsInstances.
List of awsInstances.
List of awsInstances.
List of awsInstances.
List of awsInstances.
List of awsInstances.
List of awsInstances.
List of awsInstances.
List of awsInstances.
List of awsInstances.
List of awsInstances.
List of awsInstances.
List of awsRegions.
List of awsRegions.
List of awsRegions.
List of awsRegions.
List of awsRegions.
List of awsRegions.
List of awsRegions.
List of awsRegions.
List of awsRegions.
List of awsRegions.
List of awsRegions.
List of awsRegions.
List of awsRegions.
List of awsRegions.
List of azureInstances.
List of azureInstances.
List of azureInstances.
List of azureInstances.
List of azureInstances.
List of azureInstances.
List of azureInstances.
List of azureInstances.
List of azureInstances.
List of azureInstances.
List of azureInstances.
List of azureInstances.
List of azureInstances.
List of azureInstances.
List of azureInstances.
List of azureInstances.
List of azureInstances.
List of azureInstances.
List of azureInstances.
List of azureInstances.
List of azureInstances.
List of azureInstances.
List of azureInstances.
List of azureInstances.
List of azureRegions.
List of azureRegions.
List of azureRegions.
List of azureRegions.
List of azureRegions.
List of azureRegions.
List of azureRegions.
List of azureRegions.
List of azureRegions.
List of azureRegions.
List of azureVolumeTypes.
List of azureVolumeTypes.
List of azureVolumeTypes.
List of azureVolumeTypes.
List of azureVolumeTypes.
List of azureVolumeTypes.
List of azureVolumeTypes.
List of azureVolumeTypes.
List of azureVolumeTypes.
List of azureVolumeTypes.
List of bucketRoleTypes.
List of bucketRoleTypes.
List of cloudStatus.
List of cloudStatus.
List of cloudStatus.
List of cloudStatus.
List of cloudStatus.
List of cloudStatus.
List of cloudStatus.
List of cloudStatus.
List of cloudStatus.
List of cloudStatus.
List of cloudStatus.
List of cloudStatus.
List of cloudStatus.
List of cloudStatus.
List of cloudStatus.
List of clusterHealth.
List of clusterHealth.
List of clusterHealth.
List of clusterHealth.
List of clusterHealth.
List of clusterHealth.
List of clusterStatus.
List of clusterStatus.
List of clusterStatus.
List of clusterStatus.
List of clusterStatus.
List of clusterStatus.
List of clusterStatus.
List of clusterStatus.
List of clusterStatus.
List of clusterStatus.
List of clusterStatus.
List of clusterStatus.
List of clusterStatus.
List of clusterStatus.
List of clusterStatus.
List of clusterStatus.
List of clusterVersions.
List of clusterVersions.
List of clusterVersions.
List of clusterVersions.
List of conflictResolution.
List of conflictResolution.
List of couchbaseServices.
List of couchbaseServices.
List of couchbaseServices.
List of couchbaseServices.
List of couchbaseServices.
List of couchbaseServices.
List of provider.
List of provider.
List of provider.
List of supportPackageType.
List of supportPackageType.
List of supportPackageType.
List of supportTimezones.
List of supportTimezones.
List of supportTimezones.
List of supportTimezones.
List of v3BucketRoles.
List of v3BucketRoles.
List of v3ClusterStatus.
List of v3ClusterStatus.
List of v3ClusterStatus.
List of v3ClusterStatus.
List of v3ClusterStatus.
List of v3ClusterStatus.
List of v3ClusterStatus.
List of v3ClusterStatus.
List of v3ClusterStatus.
List of v3ClusterStatus.
List of v3ClusterStatus.
List of v3ClusterStatus.
List of v3ClusterStatus.
List of v3ClusterStatus.
List of v3ClusterStatus.
List of v3CouchbaseServices.
List of v3CouchbaseServices.
List of v3CouchbaseServices.
List of v3CouchbaseServices.
List of v3CouchbaseServices.
List of v3CouchbaseServices.
List of v3Environment.
List of v3Environment.
List of v3Provider.
List of v3Provider.
List of v3Provider.
List of v3StorageType.
List of v3StorageType.
List of v3StorageType.
List of v3SupportPackageTimezones.
List of v3SupportPackageTimezones.
List of v3SupportPackageTimezones.
List of v3SupportPackageTimezones.
List of v3SupportPackageType.
List of v3SupportPackageType.
List of v3SupportPackageType.
# 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
AllowListEntry struct for AllowListEntry.
APIClient manages communication with the Couchbase Public API API v2.0.0 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
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
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
APIResponse stores the API response returned by the server.
No description provided by the author
No description provided by the author
AppendAllowListRequest struct for AppendAllowListRequest.
AWSProviderSettings struct for AWSProviderSettings.
AzureProviderSettings struct for AzureProviderSettings.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
BucketRole Specifies the roles of the user for the given bucket .
BucketStats struct for BucketStats.
Cloud struct for Cloud.
CloudProviderSettings - struct for CloudProviderSettings.
CloudSummary struct for CloudSummary.
CloudVersion struct for CloudVersion.
Cluster struct for Cluster.
ClusterHealthResponse struct for ClusterHealthResponse.
ClusterStatusResponse struct for ClusterStatusResponse.
ClusterSummary struct for ClusterSummary.
ClusterVersion struct for ClusterVersion.
Configuration stores the configuration of the API client.
CouchbaseBucketSpec struct for CouchbaseBucketSpec.
CreateClusterRequest struct for CreateClusterRequest.
CreateClusterRequestSupportPackage if support package is not set then default support package is used.
CreateDatabaseUserRequest struct for CreateDatabaseUserRequest.
CreateProjectRequest struct for CreateProjectRequest.
Cursor struct for Cursor.
CursorHrefs struct for CursorHrefs.
CursorPages struct for CursorPages.
DeleteAllowListEntryRequest struct for DeleteAllowListEntryRequest.
DeleteBucketRequest struct for DeleteBucketRequest.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
GetCertificateResponse struct for GetCertificateResponse.
Goof struct for Goof.
ListBucketItem struct for ListBucketItem.
ListCloudsResponse struct for ListCloudsResponse.
ListClustersResponse struct for ListClustersResponse.
ListDatabaseUsersResponseItem struct for ListDatabaseUsersResponseItem.
ListProjectsResponse struct for ListProjectsResponse.
ListUsersResponse struct for ListUsersResponse.
ListUsersResponseItem struct for ListUsersResponseItem.
NodeStats struct for NodeStats.
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
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
No description provided by the author
Project struct for Project.
Regions - struct for Regions.
Server struct for Server.
ServerAws struct for ServerAws.
ServerAzure struct for ServerAzure.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
ServiceStats struct for ServiceStats.
StatusOK struct for StatusOK.
UpdateBucketRequest struct for UpdateBucketRequest.
UpdateDatabaseUserRequest struct for UpdateDatabaseUserRequest.
V3Cluster struct for V3Cluster.
V3ClusterList struct for V3ClusterList.
V3ClusterListData struct for V3ClusterListData.
V3ClusterListDataItems struct for V3ClusterListDataItems.
V3ClusterPlace struct for V3ClusterPlace.
V3ClusterServers struct for V3ClusterServers.
V3ClusterStatusResponse struct for V3ClusterStatusResponse.
V3ClusterStorage struct for V3ClusterStorage.
V3ClusterVersion struct for V3ClusterVersion.
V3ClusterVersionComponents struct for V3ClusterVersionComponents.
V3CreateClusterRequest struct for V3CreateClusterRequest.
V3CreateClusterUserRequest struct for V3CreateClusterUserRequest.
V3CreateClusterUserRequestBuckets struct for V3CreateClusterUserRequestBuckets.
V3Place Cluster deployment location based on the value provided in environment.
V3PlaceHosted cluster will be deployed in the managed couchbase capella.
V3Servers struct for V3Servers.
V3ServersStorage struct for V3ServersStorage.
V3SupportPackage One from \"Basic\", \"DeveloperPro\" or \"Enterprise\" .
V3UpdateClusterMetaRequest struct for V3UpdateClusterMetaRequest.
V3UpdateClusterServersRequest struct for V3UpdateClusterServersRequest.
V3UpdateClusterSupportRequest struct for V3UpdateClusterSupportRequest.
V3UpdateClusterSupportRequestSupportPackage One from \"Basic\", \"DeveloperPro\" or \"Enterprise\" .
# Type aliases
AllowListRules the model 'AllowListRules'.
AllowListStates the model 'AllowListStates'.
AwsInstances the model 'AwsInstances'.
AwsRegions the model 'AwsRegions'.
AzureInstances the model 'AzureInstances'.
AzureRegions the model 'AzureRegions'.
AzureVolumeTypes the model 'AzureVolumeTypes'.
BucketRoleTypes * `data_writer` - Gives the user permission to read and write data for the bucket.
CloudsApiService CloudsApi service.
CloudStatus the model 'CloudStatus'.
ClusterHealth * `healthy` - denotes that the resource is in a healthy state.
ClustersApiService ClustersApi service.
ClusterStatus * `draft` - indicates that all fields under database model are mutable.
ClustersV3ApiService ClustersV3Api service.
ClusterVersions If not defined the latest version of Couchbase Server is deployed.
ConflictResolution the model 'ConflictResolution'.
CouchbaseServices the model 'CouchbaseServices'.
ProjectsApiService ProjectsApi service.
Provider the model 'Provider'.
ServerConfigurations stores multiple ServerConfiguration items.
StatusApiService StatusApi service.
SupportPackageType the model 'SupportPackageType'.
SupportTimezones * `ET` - Eastern Time * `GMT` - Greenwich Mean Time * `IST` - India Standard Time * `PT` - Pacific Time .
UsersApiService UsersApi service.
V3BucketRoles * `data_writer` - Gives the user permission to read and write data for the bucket.
V3ClusterStatus the model 'V3ClusterStatus'.
V3CouchbaseServices the model 'V3CouchbaseServices'.
V3Environment the model 'V3Environment'.
V3Provider the model 'V3Provider'.
V3StorageType the model 'V3StorageType'.
V3SupportPackageTimezones * `ET` - Eastern Time * `GMT` - Greenwich Mean Time * `IST` - India Standard Time * `PT` - Pacific Time .
V3SupportPackageType the model 'V3SupportPackageType'.