package
0.89.3
Repository: https://github.com/arangodb-managed/apis.git
Documentation: pkg.go.dev

# Functions

DataVolumeInfoEqual returns true when the fields of a & b are equal.
DeploymentServerStatusEqual returns true when the fields of a & b are equal.
DeploymentServerStatusListEqual returns true when the elements of a & b are equal.
DeploymentStatusEqual returns true when the fields of a & b are equal.
DeploymentURL creates a resource URL for the Deployment with given ID in given context.
ForEachDeployment iterates over all deployments in a project identified by given context ID, invoking the given callback for each deployment.
ForEachVersion iterates over all (ArangoDB) versions that match the given filter invoking the given callback for each version.
No description provided by the author
RegisterDataServiceHandler registers the http handlers for service DataService to "mux".
RegisterDataServiceHandlerClient registers the http handlers for service DataService to "mux".
RegisterDataServiceHandlerFromEndpoint is same as RegisterDataServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterDataServiceHandlerServer registers the http handlers for service DataService to "mux".
No description provided by the author

# Constants

AddonIDAuditLog is ID of the Audit Log addon.
AddonIDIAMProvider is ID of the IAM provider addon.
AddonIDPriviteEndpointService is ID of the Private endpoint service addon.
APIID contains identifier of this API.
APIMajorVersion contains major version of this API.
APIMinorVersion contains minor version of this API.
APIPatchVersion contains patch version of this API.
CPUSizeHigh is the CPU size that yields (on average) twice the CPU (per memory) compared to standard.
CPUSizeStandard is the CPU size that is used by default.
CreateTestDatabaseDatabaseNameField name of the field containing the name of the database.
CreateTestDatabaseUsernameField name of the field containing the username.
DeploymentEventReasonPauseDeployment contains the reason that should be set inside the event that is emitted when a deployment is paused.
DeploymentEventReasonRestoreBackup contains the reason taht should be set in the event that is emitted when a deployment backup is restored.
DeploymentEventReasonResumeDeployment contains the reason that should be set inside the event that is emitted when a deployment is resumed.
EventTypeDeploymentCreated is the type of event fired after a deployment has been created SubjectID contains the ID of the deployment.
EventTypeDeploymentCreatedTestDatabase is the type of event fired after a test database has been created SubjectID contains the ID of the deployment.
EventTypeDeploymentCredentialsRead is the type of event fired after the credentials of a deployment have been read.
EventTypeDeploymentDeleted is the type of event fired after a deployment has been (marked for) deleted SubjectID contains the ID of the deployment.
EventTypeDeploymentUpdated is the type of event fired after a deployment has been updated SubjectID contains the ID of the deployment.
No description provided by the author
KindDataloader is a constants for the kind of Dataloader resources.
KindDeployment is a constants for the kind of Deployment resources.
ModelDeveloper is the model that yields a deployment with: - a single instance of nodes (1).
ModelFlexible is the model that yields a deployment with: - completely flexible in number of coordinators (>= 2), dbservers (>= 3) - completely flexible in resources used by coordinators, dbservers - no limitation of shards per collection - a minimum replication factor of 1 (per collection).
ModelFree is the model that yields a deployment with: - a single A4 node - a maximum of 3 databases - not for production use - not highly available.
ModelOneShard is the model that yields a deployment with: - a fixed number of nodes (3).
ModelSharded is the model that yields a deployment with: - a variable number of nodes (>= 3).
Defines Critical level Notification Severity.
Defines Info level Notification Severity.
Defines Warning level Notification Severity.
PermissionCPUSizeList is needed for listing CPU sizes in a project.
PermissionDataLoaderImport is needed for importing data using dataloader for a specific deployment.
PermissionDeploymentCreate is needed for create a deployment.
PermissionDeploymentCreateTestDatabase is needed for creating a test database.
PermissionDeploymentCredentialsGet is needed for fetching credentials of an individual deployments in a project.
PermissionDeploymentDelete is needed for deleting a deployment.
PermissionDeploymentFeaturesGet is needed for fetching features that are available to deployments in a project.
PermissionDeploymentFullAccess is needed to give user full access for deployment.
PermissionDeploymentGet is needed for fetching an individual deployments in a project.
PermissionDeploymentList is needed for listing deployments in a project.
PermissionDeploymentModelList is needed for listing deployment models in a project.
PermissionDeploymentPause is needed for pausing a deployment.
PermissionDeploymentPriceCalculate is needed for calculating deployment prices.
PermissionDeploymentReadOnlyAccess is needed to give user read only permission for deployment.
PermissionDeploymentRebalanceShards is needed for rebalancing shards for a deployment.
PermissionDeploymentRestoreBackup is needed for restoring a backup of a deployment.
PermissionDeploymentResume is needed for resuming a paused deployment.
PermissionDeploymentRotateServer is needed to rotate a server belonging to a deployment.
PermissionDeploymentUpdate is needed for updating a deployment.
PermissionDeploymentUpdateScheduledRootPasswordRotation is needed to update scheduled root password rotation setting for a deployment.
PermissionDiskPerformanceList is needed for listing disk performances for a specific deployment.
PermissionLimitsGet is needed for fetching server spec limits in a project.
PermissionNodeSizeList is needed for listing server spec presets in a project.
PermissionPresetsList is needed for listing server spec presets in a project.
QuotaKindDeploymentCoordinatorMemory limits the amount of memory (in GB) used by a single coordinator in a deployment.
QuotaKindDeploymentCoordinators limits the number of coordinators per deployment.
QuotaKindDeploymentDBServerDisk limits the amount of disk (in GB) used by a single dbserver in a deployment.
QuotaKindDeploymentDBServerMemory limits the amount of memory (in GB) used by a single dbserver in a deployment.
QuotaKindDeploymentDBServers limits the number of dbservers per deployment.
QuotaKindDeploymentsPerProject limits the number of deployments in a single project.
QuotaKindFreeDeploymentsPerOrganization limits the number of free deployments in a single organization.
QuotaKindTotalBackupPoliciesPerDeployment limits the total number of back up policies for a given deployment This kind of quota must be requested on project level.
QuotaKindTotalDeploymentsDiskPerProject limits the total amount of disk used by all deployments in a project in GB.
QuotaKindTotalDeploymentsMemoryPerProject limits the total amount of memory used by all deployments in a project in GB.
UsageItemResourceKindDeployment is the kind used inside the UsageItem.Resource to refer to a deployment.

# Variables

No description provided by the author
Enum value maps for NotificationSeverity.
Enum value maps for NotificationSeverity.

# Structs

Request arguments for CalculateDeploymentSize.
Instructions for connecting a driver to a deployment.
Instructions for a specific driver.
CPUSize specifies the a specific level of CPU for a node.
List of CPU sizes.
Request arguments for CreateTestDatabase.
CreateTestDatabaseResponse will contain the json formatted output of the create operation.
DataVolumeInfo provides information about a data volume.
A Deployment is represents one deployment of an ArangoDB cluster.
Information about a backup restore.
The status of backup restore All members of this message are read-only.
No description provided by the author
Deployment's disk autoscaling settings.
Expiration of the deployment.
No description provided by the author
Deployment's notification settings.
No description provided by the author
Status of a single server (of the ArangoDB cluster).
Status of the deployment All members of this field are read-only.
Result for GetDeploymentCredentials.
Request arguments for GetDeploymentCredentials.
Features that are available to new deployments in a given context.
Request arguments for GetDeploymentFeatures.
List of Deployments.
DeploymentModel specifies the a specific model of deploying arangodb clusters.
Features that are available to deployments of this model type.
List of deployment models.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Arguments for requesting a price a deployment of given properties.
Result of CalculateDeploymentSize.
Response of RecommendDeploymentSize.
Request arguments for RecommendDeploymentSize.
DiskPerformance provides information on a specific disk performance option.
List of DiskPerformances.
GetDiskPerformanceRequest is used as request in GetDiskPerformance.
Instructions for importing data into a deployment.
Request arguments for ListCPUSizes.
Request arguments for ListDeploymentModels.
Request arguments for ListDeploymentsByFilter.
ListDiskPerformancesRequest is used as request in ListAllDiskPerformances.
Request arguments for ListVersions.
NodeSize specifies the size constraints of different data nodes.
List of node sizes.
Request arguments for ListNodeSizes.
Define the Notification details.
RebalanceDeploymentShardsRequest request for rebalancing shards for a deployment.
ReplaceVersionBy holds replacement instructions.
RotateDeploymentServerRequest request for rotating out servers for a deployment.
Limits of allowed values for fields of Deployment.ServersSpec.
No description provided by the author
Request arguments for ListServersSpecLimits.
UnimplementedDataServiceServer can be embedded to have forward compatible implementations.
Request arguments for UpdateDeploymentScheduledRootPasswordRotation.
UpgradeVersionRecommendation holds a recommendation for updating this version.
Version of an ArangoDB release.
List of Versions.

# Interfaces

No description provided by the author
No description provided by the author
DataServiceClient is the client API for DataService service.
DataServiceServer is the server API for DataService service.

# Type aliases

No description provided by the author
NotificationSeverity keeps possible severities for notifications.
No description provided by the author