CheckResourceNotFoundError is used to check if an error is of type api.Error and whether the error is resource not found.

GetPaginated is a generic function used to handle pagination.

NewClient instantiates a new Client with the provided timeout.

ParseError is used to check if an error is of type api.Error error and return it as a string.

rate limits api requests to 60 req/min.

Access defines the level of access that the database credential will have across buckets and scopes.

AccessibleResources is the level at which the above privileges are defined.

Bucket contains the details of a single bucket with scope and collection level information.

Client is responsible for constructing and executing HTTP requests.

CouchbaseAuditData contains all audit-related fields.

CreateAllowListRequest is the payload sent to the Capella V4 Public API when asked to add an allowlist to gain access to a Capella cluster.

CreateAllowListResponse is the response received from the Capella V4 Public API when asked to add an allowlist to gain access to a Capella cluster.

CreateApiKeyRequest is the payload sent to the Capella V4 Public API when asked to create an API key in the organization.

CreateApiKeyResponse is the response received from the Capella V4 Public API when asked to create an API key in the organization.

CreateAzurePrivateEndpointCommandRequest is a request to get the CLI to create an Azure private endpoint.

CreateClusterAuditLogExportRequest is the payload sent to the Capella V4 Public API when creating export job request.

CreateClusterAuditLogExportResponse is the response received from the Capella V4 Public API after creating export job request.

CreateClusterOnOffScheduleRequest is the request payload sent to the Capella V4 Public API in order to create a new cluster on/off schedule.

CreateClusterOnRequest is the payload passed to V4 Capella Public API to turn on the cluster.

CreateCollectionRequest is the payload passed to V4 Capella Public API to create a collection in a scope.

CreateDatabaseCredentialRequest represents the schema for the POST Capella V4 API request that creates the database credential.

CreateDatabaseCredentialResponse represents the schema for the POST Capella V4 API response that creates the database credential.

CreateProjectRequest is the payload sent to the Capella V4 Public API when asked to create a project in the organization.

CreateProjectResponse is the response received from the Capella V4 Public API when asked to create a project in the organization.

CreateUserRequest is the request payload sent to the Capella V4 Public API when asked to invite a new user to an organization.

CreateUserResponse is the response received from the Capella V4 Public API when asked to invite a new user to an organization.

CreateVPCEndpointCommandRequest is a request to get the CLI to create an AWS VPC endpoint.

Cursor represents pagination metadata for navigating through large data sets.

DayItem is an array of Days.

EndpointCfg is used to encapsulate request details to endpoints.

Error tracks the error structure received from Capella V4 APIs.

GetAllowListResponse is the response received from the Capella V4 Public API when asked to fetch details of a particular allowlist.

GetApiKeyResponse is the response received from the Capella V4 Public API when asked to fetch an API key in an organization.

GetCertificateResponse is the response received from the Capella V4 Public API when asked to get the certificate details for a Capella cluster.

GetClusterAuditLogExportResponse is the response received from the Capella V4 Public API when asked to fetch details of an export job.

GetClusterAuditSettingsResponse is the response received from the Capella V4 Public API when retrieving cluster audit log settings.

GetClusterOnOffScheduleResponse is the API response received from the Capella V4 Public API while attempting to fetch the on/off schedule for a cluster.

GetCollectionResponse is the response received from Capella V4 Public API on requesting to information about an existing collection.

GetCollectionsResponse is the response received from the Capella V4 Public API when asked to list all collections.

GetDatabaseCredentialResponse represents the schema for the GET Capella V4 API request that fetches the database credential details.

GetEventResponse defines model for GetEventResponse.

GetEventsResponse defines model for GetEventsResponse.

GetPrivateEndpointResponse defines model for a CSP's private endpoint.

GetPrivateEndpointServiceStatusResponse is the response received from the Capella V4 Public API when getting private endpoint service status.

GetPrivateEndpointsResponse is a list of private endpoints.

GetProjectResponse is the response received from the Capella V4 Public API when asked to get project details in an organization.

GetUserResponse is the response received from the Capella V4 Public API when asked to get existing user's details.

Hrefs contains the hyperlinks for navigation through the paginated data set.

IndexBuildStatusResponse is the build status for an index.

IndexDDLRequest is a request to run an index DDL statement.

IndexDDLResponse has an array of errors returned by query service.

IndexDefinitionResponse represents a single index definition.

ListIndexDefinitionsResponse represents a list of index definitions.

OnTimeBoundary corresponds to "from" and "to" time boundaries for when the cluster needs to be in the turned on (healthy) state on a day with "custom" scheduling timings.

Pages represents the pagination details of the data set.

PutDatabaseCredentialRequest represents the schema for the PUT Capella V4 API request that updates an existing database credential.

PutProjectRequest is the payload sent to the Capella V4 Public API when asked to update a project in an organization.

QueryError is the error message returned by query service.

Resource defines either a project or cluster to which the newly invited user should have access.

ResourcesItems the individual item that is part of Resources.

Response struct is used to encapsulate the response details.

RotateApiKeyRequest is the payload sent to the Capella V4 Public API when asked to rotate an API key.

RotateApiKeyResponse is the response received from the Capella V4 Public API when asked to rotate an API key.

Scope is the details of a single scope inside the bucket, and it contains the collections details too.

UpdateClusterAuditSettingsRequest is the payload sent to the Capella V4 Public API when configuring audit log settings.

UpdateClusterOnOffScheduleRequest is the request payload sent to the Capella V4 Public API in order to create a update a cluster's on/off schedule.

UpdateCollectionRequest is the payload sent to the Capella V4 Public API when asked to update an existing collection.

AuditSettingsDisabledUsers List of users whose filterable events will not be logged.

Resources are the resource level permissions associated with the API key.