v1

package
v0.89.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 8, 2024 License: Apache-2.0 Imports: 25 Imported by: 11

Documentation

Overview

Package v1 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Package v1 contains the API of DataManager services.

Index

Constants

View Source 
const (

	// AddonIDIAMProvider is ID of the IAM provider addon.
	// That addon is used when a deployment is using a custom IAM provider.
	AddonIDIAMProvider = "iamprovider"

	// AddonIDAuditLog is ID of the Audit Log addon.
	// That addon is used when a deployment has an attached audit log.
	AddonIDAuditLog = "auditlog"

	// AddonIDPriviteEndpointService is ID of the Private endpoint service addon.
	// That addon is used when a deployment is using a private endpoint service.
	AddonIDPrivateEndpointService = "privateendpointservice"
)
View Source 
const (

	// CreateTestDatabaseUsernameField name of the field containing the username.
	CreateTestDatabaseUsernameField = "username"
	// CreateTestDatabaseDatabaseNameField name of the field containing the name of the database.
	CreateTestDatabaseDatabaseNameField = "database"
)
View Source 
const (

	// CPUSizeStandard is the CPU size that is used by default.
	CPUSizeStandard = "standard"
	// CPUSizeHigh is the CPU size that yields (on average) twice the CPU (per memory)
	// compared to standard.
	CPUSizeHigh = "high"
)
View Source 
const (

	// EventTypeDeploymentCreated is the type of event fired after a deployment has been created
	// SubjectID contains the ID of the deployment.
	EventTypeDeploymentCreated = "data.deployment.created"
	// EventTypeDeploymentUpdated is the type of event fired after a deployment has been updated
	// SubjectID contains the ID of the deployment.
	// Note that this type of event is also fired when the status of the deployment has changed.
	EventTypeDeploymentUpdated = "data.deployment.updated"
	// EventTypeDeploymentDeleted is the type of event fired after a deployment has been (marked for) deleted
	// SubjectID contains the ID of the deployment.
	EventTypeDeploymentDeleted = "data.deployment.deleted"
)
View Source 
const (

	// DeploymentEventReasonPauseDeployment contains the reason that should be set
	// inside the event that is emitted when a deployment is paused.
	DeploymentEventReasonPauseDeployment = "pause_deployment"
	// DeploymentEventReasonResumeDeployment contains the reason that should be set
	// inside the event that is emitted when a deployment is resumed.
	DeploymentEventReasonResumeDeployment = "resume_deployment"
	// DeploymentEventReasonRestoreBackup contains the reason taht should be set
	// in the event that is emitted when a deployment backup is restored.
	DeploymentEventReasonRestoreBackup = "restore_backup"
)
View Source 
const (

	// ModelDeveloper is the model that yields a deployment with:
	// - a single instance of nodes (1).
	// - a variable node size.
	// - not for production use
	// - not highly available
	ModelDeveloper = "developer"

	// ModelOneShard is the model that yields a deployment with:
	// - a fixed number of nodes (3).
	// - a variable node size.
	// - a limitation of 1 shard per collection.
	// - a fixed replication factor of 3 (per collection)
	// - optimized for graph use cases
	ModelOneShard = "oneshard"

	// ModelSharded is the model that yields a deployment with:
	// - a variable number of nodes (>= 3).
	// - a variable node size.
	// - a minimum replication factor of 2 (per shard)
	// - a default replication factor of 3 (per shard)
	// - no limitation of shards per collection
	ModelSharded = "sharded"

	// 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)
	ModelFlexible = "flexible"

	// 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
	ModelFree = "free"
)
View Source 
const (

	// PermissionDeploymentList is needed for listing deployments in a project
	PermissionDeploymentList = "data.deployment.list"
	// PermissionDeploymentGet is needed for fetching an individual deployments in a project
	PermissionDeploymentGet = "data.deployment.get"
	// PermissionDeploymentCreate is needed for create a deployment
	PermissionDeploymentCreate = "data.deployment.create"
	// PermissionDeploymentUpdate is needed for updating a deployment
	PermissionDeploymentUpdate = "data.deployment.update"
	// PermissionDeploymentDelete is needed for deleting a deployment
	PermissionDeploymentDelete = "data.deployment.delete"
	// PermissionDeploymentRestoreBackup is needed for restoring a backup of a deployment
	PermissionDeploymentRestoreBackup = "data.deployment.restore-backup"
	// PermissionDeploymentPause is needed for pausing a deployment
	PermissionDeploymentPause = "data.deployment.pause"
	// PermissionDeploymentResume is needed for resuming a paused deployment
	PermissionDeploymentResume = "data.deployment.resume"
	// PermissionDeploymentRotateServer is needed to rotate a server belonging to a deployment
	PermissionDeploymentRotateServer = "data.deployment.rotate-server"
	// PermissionDeploymentCreateTestDatabase is needed for creating a test database
	PermissionDeploymentCreateTestDatabase = "data.deployment.create-test-database"
	// PermissionDeploymentRebalanceShards is needed for rebalancing shards for a deployment
	PermissionDeploymentRebalanceShards = "data.deployment.rebalance-shards"
	// PermissionDeploymentUpdateScheduledRootPasswordRotation is needed to update scheduled root password rotation setting for a deployment
	PermissionDeploymentUpdateScheduledRootPasswordRotation = "data.deployment.update-scheduled-root-password-rotation"
	// PermissionDeploymentReadOnlyAccess is needed to give user read only permission for deployment
	PermissionDeploymentReadOnlyAccess = "data.deployment.read-only-access"
	// PermissionDeploymentFullAccess is needed to give user full access for deployment
	PermissionDeploymentFullAccess = "data.deployment.full-access"
)
View Source 
const (

	// QuotaKindDeploymentsPerProject limits the number of deployments in a single project.
	// This kinds of quota must be requested on project level.
	QuotaKindDeploymentsPerProject = "data.deployments-per-project"
	// QuotaKindDeploymentCoordinatorMemory limits the amount of memory (in GB) used
	// by a single coordinator in a deployment.
	// This kinds of quota must be requested on project level.
	QuotaKindDeploymentCoordinatorMemory = "data.deployment-coordinator-memory"
	// QuotaKindDeploymentCoordinators limits the number of coordinators per deployment.
	// This kinds of quota must be requested on project level.
	QuotaKindDeploymentCoordinators = "data.deployment-coordinators"
	// QuotaKindDeploymentDBServerMemory limits the amount of memory (in GB) used
	// by a single dbserver in a deployment.
	// This kinds of quota must be requested on project level.
	QuotaKindDeploymentDBServerMemory = "data.deployment-dbserver-memory"
	// QuotaKindDeploymentDBServerDisk limits the amount of disk (in GB) used
	// by a single dbserver in a deployment.
	// This kinds of quota must be requested on project level.
	QuotaKindDeploymentDBServerDisk = "data.deployment-dbserver-disk"
	// QuotaKindDeploymentDBServers limits the number of dbservers per deployment.
	// This kinds of quota must be requested on project level.
	QuotaKindDeploymentDBServers = "data.deployment-dbservers"
	// QuotaKindTotalDeploymentsMemoryPerProject limits the total amount of memory used
	// by all deployments in a project in GB.
	// This kinds of quota must be requested on project level.
	QuotaKindTotalDeploymentsMemoryPerProject = "data.total-deployments-memory-per-project"
	// QuotaKindTotalDeploymentsDiskPerProject limits the total amount of disk used
	// by all deployments in a project in GB.
	// This kinds of quota must be requested on project level.
	QuotaKindTotalDeploymentsDiskPerProject = "data.total-deployments-disk-per-project"
	// QuotaKindTotalBackupPoliciesPerDeployment limits the total number of back up policies
	// for a given deployment
	// This kind of quota must be requested on project level.
	QuotaKindTotalBackupPoliciesPerDeployment = "backup.total-backup-policy-per-deployment"
	// QuotaKindFreeDeploymentsPerOrganization limits the number of free deployments in a single organization.
	// This kinds of quota must be requested on organization level.
	QuotaKindFreeDeploymentsPerOrganization = "data.free-deployments-per-organization"
)
View Source 
const (
	// KindDeployment is a constants for the kind of Deployment resources.
	KindDeployment = "Deployment"
	// KindDataloader is a constants for the kind of Dataloader resources.
	KindDataloader = "Dataloader"
)
View Source 
const (
	// APIID contains identifier of this API
	APIID = "data/v1"
	// APIMajorVersion contains major version of this API
	APIMajorVersion = 2
	// APIMinorVersion contains minor version of this API
	APIMinorVersion = 10
	// APIPatchVersion contains patch version of this API
	APIPatchVersion = 0
)
View Source 
const (

	// EventTypeDeploymentCreatedTestDatabase is the type of event fired after a test database has been created
	// SubjectID contains the ID of the deployment.
	// Contains the following custom fields:
	// username - the username of the created user
	// database - the name of the created database
	EventTypeDeploymentCreatedTestDatabase = "data.deployment.created-test-database"
)
View Source 
const (

	// EventTypeDeploymentCredentialsRead is the type of event fired after the credentials
	// of a deployment have been read.
	// SubjectID contains the ID of the deployment.
	EventTypeDeploymentCredentialsRead = "data.deploymentcredentials.read"
)
View Source 
const (
	ExpirationReasonNoExpire = "doesn't expire"
)
View Source 
const (

	// PermissionCPUSizeList is needed for listing CPU sizes in a project.
	PermissionCPUSizeList = "data.cpusize.list"
)
View Source 
const (

	// PermissionDataLoaderImport is needed for importing data using dataloader for a specific deployment
	PermissionDataLoaderImport = "dataloader.deployment.import"
)
View Source 
const (

	// PermissionDeploymentCredentialsGet is needed for fetching credentials of an individual deployments in a project
	PermissionDeploymentCredentialsGet = "data.deploymentcredentials.get"
)
View Source 
const (

	// PermissionDeploymentFeaturesGet is needed for fetching features that are available to deployments in a project
	PermissionDeploymentFeaturesGet = "data.deploymentfeatures.get"
)
View Source 
const (

	// PermissionDeploymentModelList is needed for listing deployment models in a project.
	PermissionDeploymentModelList = "data.deploymentmodel.list"
)
View Source 
const (

	// PermissionDeploymentPriceCalculate is needed for calculating deployment prices
	PermissionDeploymentPriceCalculate = "data.deploymentprice.calculate"
)
View Source 
const (

	// PermissionDiskPerformanceList is needed for listing disk performances for a specific deployment
	PermissionDiskPerformanceList = "data.diskperformance.list"
)
View Source 
const (

	// PermissionLimitsGet is needed for fetching server spec limits in a project
	PermissionLimitsGet = "data.limits.get"
)
View Source 
const (

	// PermissionNodeSizeList is needed for listing server spec presets in a project
	PermissionNodeSizeList = "data.nodesize.list"
)
View Source 
const (

	// PermissionPresetsList is needed for listing server spec presets in a project
	PermissionPresetsList = "data.presets.list"
)
View Source 
const (

	// UsageItemResourceKindDeployment is the kind used inside the UsageItem.Resource to refer to a deployment.
	UsageItemResourceKindDeployment = "Deployment"
)

Variables

View Source 
var (
	NotificationSeverity_name = map[int32]string{
		0: "NOTIFICATION_SEVERITY_INFO",
		1: "NOTIFICATION_SEVERITY_WARNING",
		2: "NOTIFICATION_SEVERITY_CRITICAL",
	}
	NotificationSeverity_value = map[string]int32{
		"NOTIFICATION_SEVERITY_INFO":     0,
		"NOTIFICATION_SEVERITY_WARNING":  1,
		"NOTIFICATION_SEVERITY_CRITICAL": 2,
	}
)

Enum value maps for NotificationSeverity.

View Source 
var File_data_proto protoreflect.FileDescriptor

Functions

func DataVolumeInfoEqual 

func DataVolumeInfoEqual(a, b *DataVolumeInfo, ignoreTimestamps bool) bool

DataVolumeInfoEqual returns true when the fields of a & b are equal.

func DeploymentServerStatusEqual 

func DeploymentServerStatusEqual(a, b *Deployment_ServerStatus, ignoreTimestamps, ignoreVolatile bool) bool

DeploymentServerStatusEqual returns true when the fields of a & b are equal.

func DeploymentServerStatusListEqual 

func DeploymentServerStatusListEqual(a, b []*Deployment_ServerStatus, ignoreTimestamps, ignoreVolatile bool) bool

DeploymentServerStatusListEqual returns true when the elements of a & b are equal.

func DeploymentStatusEqual 

func DeploymentStatusEqual(a, b *Deployment_Status, ignoreTimestamps, ignoreVolatile bool) bool

DeploymentStatusEqual returns true when the fields of a & b are equal.

func DeploymentURL 

func DeploymentURL(organizationID, projectID, deploymentID string) string

DeploymentURL creates a resource URL for the Deployment with given ID in given context.

func ForEachDeployment 

func ForEachDeployment(ctx context.Context, listFunc func(ctx context.Context, req *common.ListOptions) (*DeploymentList, error),
	opts *common.ListOptions, cb DeploymentCallback) error

ForEachDeployment iterates over all deployments in a project identified by given context ID, invoking the given callback for each deployment.

func ForEachVersion 

func ForEachVersion(ctx context.Context,
	listFunc func(ctx context.Context, req *ListVersionsRequest) (*VersionList, error),
	req *ListVersionsRequest, cb VersionCallback) error

ForEachVersion iterates over all (ArangoDB) versions that match the given filter invoking the given callback for each version.

func RegisterDataServiceHandler 

func RegisterDataServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterDataServiceHandler registers the http handlers for service DataService to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterDataServiceHandlerClient 

func RegisterDataServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client DataServiceClient) error

RegisterDataServiceHandlerClient registers the http handlers for service DataService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "DataServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "DataServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "DataServiceClient" to call the correct interceptors.

func RegisterDataServiceHandlerFromEndpoint 

func RegisterDataServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterDataServiceHandlerFromEndpoint is same as RegisterDataServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterDataServiceHandlerServer 

func RegisterDataServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server DataServiceServer) error

RegisterDataServiceHandlerServer registers the http handlers for service DataService to "mux". UnaryRPC :call DataServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterDataServiceHandlerFromEndpoint instead.

func RegisterDataServiceServer 

func RegisterDataServiceServer(s *grpc.Server, srv DataServiceServer)

Types

type CPUSize 

type CPUSize struct {

	// System identifier of the size (e.g. standard)
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Human readable name of the size (e.g. Standard)
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

CPUSize specifies the a specific level of CPU for a node.

func (*CPUSize) Descriptor deprecated 

func (*CPUSize) Descriptor() ([]byte, []int)

Deprecated: Use CPUSize.ProtoReflect.Descriptor instead.

func (*CPUSize) GetId 

func (x *CPUSize) GetId() string

func (*CPUSize) GetName 

func (x *CPUSize) GetName() string

func (*CPUSize) ProtoMessage 

func (*CPUSize) ProtoMessage()

func (*CPUSize) ProtoReflect added in v0.89.0 

func (x *CPUSize) ProtoReflect() protoreflect.Message

func (*CPUSize) Reset 

func (x *CPUSize) Reset()

func (*CPUSize) String 

func (x *CPUSize) String() string

type CPUSizeList 

type CPUSizeList struct {
	Items []*CPUSize `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	// contains filtered or unexported fields
}

List of CPU sizes.

func (*CPUSizeList) Descriptor deprecated 

func (*CPUSizeList) Descriptor() ([]byte, []int)

Deprecated: Use CPUSizeList.ProtoReflect.Descriptor instead.

func (*CPUSizeList) GetItems 

func (x *CPUSizeList) GetItems() []*CPUSize

func (*CPUSizeList) ProtoMessage 

func (*CPUSizeList) ProtoMessage()

func (*CPUSizeList) ProtoReflect added in v0.89.0 

func (x *CPUSizeList) ProtoReflect() protoreflect.Message

func (*CPUSizeList) Reset 

func (x *CPUSizeList) Reset()

func (*CPUSizeList) String 

func (x *CPUSizeList) String() string

type CalculateDeploymentSizeRequest 

type CalculateDeploymentSizeRequest struct {

	// Number of coordinators of the deployment
	// This field is ignored unless model is "flexible".
	Coordinators int32 `protobuf:"varint,1,opt,name=coordinators,proto3" json:"coordinators,omitempty"`
	// Amount of memory (in GB) to allocate for each coordinator.
	// This field is ignored unless model is "flexible".
	CoordinatorMemorySize int32 `` /* 127-byte string literal not displayed */
	// Number of dbservers of the deployment
	// This field is ignored unless model is "flexible".
	Dbservers int32 `protobuf:"varint,11,opt,name=dbservers,proto3" json:"dbservers,omitempty"`
	// Amount of memory (in GB) to allocate for each dbserver.
	// This field is ignored unless model is "flexible".
	DbserverMemorySize int32 `protobuf:"varint,12,opt,name=dbserver_memory_size,json=dbserverMemorySize,proto3" json:"dbserver_memory_size,omitempty"`
	// Amount of disk space (in GB) to allocate for each dbserver.
	// This field is ignored unless model is "flexible".
	DbserverDiskSize int32 `protobuf:"varint,13,opt,name=dbserver_disk_size,json=dbserverDiskSize,proto3" json:"dbserver_disk_size,omitempty"`
	// Type of model being used
	Model string `protobuf:"bytes,21,opt,name=model,proto3" json:"model,omitempty"`
	// Size of nodes being used
	NodeSizeId string `protobuf:"bytes,22,opt,name=node_size_id,json=nodeSizeId,proto3" json:"node_size_id,omitempty"`
	// Number of nodes being used
	NodeCount int32 `protobuf:"varint,23,opt,name=node_count,json=nodeCount,proto3" json:"node_count,omitempty"`
	// Amount of disk space per node (in GB)
	NodeDiskSize int32 `protobuf:"varint,34,opt,name=node_disk_size,json=nodeDiskSize,proto3" json:"node_disk_size,omitempty"`
	// ID of region in which the deployment will be created.
	RegionId string `protobuf:"bytes,50,opt,name=region_id,json=regionId,proto3" json:"region_id,omitempty"`
	// contains filtered or unexported fields
}

Request arguments for CalculateDeploymentSize

func (*CalculateDeploymentSizeRequest) Descriptor deprecated 

func (*CalculateDeploymentSizeRequest) Descriptor() ([]byte, []int)

Deprecated: Use CalculateDeploymentSizeRequest.ProtoReflect.Descriptor instead.

func (*CalculateDeploymentSizeRequest) GetCoordinatorMemorySize 

func (x *CalculateDeploymentSizeRequest) GetCoordinatorMemorySize() int32

func (*CalculateDeploymentSizeRequest) GetCoordinators 

func (x *CalculateDeploymentSizeRequest) GetCoordinators() int32

func (*CalculateDeploymentSizeRequest) GetDbserverDiskSize 

func (x *CalculateDeploymentSizeRequest) GetDbserverDiskSize() int32

func (*CalculateDeploymentSizeRequest) GetDbserverMemorySize 

func (x *CalculateDeploymentSizeRequest) GetDbserverMemorySize() int32

func (*CalculateDeploymentSizeRequest) GetDbservers 

func (x *CalculateDeploymentSizeRequest) GetDbservers() int32

func (*CalculateDeploymentSizeRequest) GetModel 

func (x *CalculateDeploymentSizeRequest) GetModel() string

func (*CalculateDeploymentSizeRequest) GetNodeCount 

func (x *CalculateDeploymentSizeRequest) GetNodeCount() int32

func (*CalculateDeploymentSizeRequest) GetNodeDiskSize 

func (x *CalculateDeploymentSizeRequest) GetNodeDiskSize() int32

func (*CalculateDeploymentSizeRequest) GetNodeSizeId 

func (x *CalculateDeploymentSizeRequest) GetNodeSizeId() string

func (*CalculateDeploymentSizeRequest) GetRegionId 

func (x *CalculateDeploymentSizeRequest) GetRegionId() string

func (*CalculateDeploymentSizeRequest) ProtoMessage 

func (*CalculateDeploymentSizeRequest) ProtoMessage()

func (*CalculateDeploymentSizeRequest) ProtoReflect added in v0.89.0 

func (x *CalculateDeploymentSizeRequest) ProtoReflect() protoreflect.Message

func (*CalculateDeploymentSizeRequest) Reset 

func (x *CalculateDeploymentSizeRequest) Reset()

func (*CalculateDeploymentSizeRequest) String 

func (x *CalculateDeploymentSizeRequest) String() string

type ConnectDriverInstructions 

type ConnectDriverInstructions struct {

	// Per driver instructions for connecting to a deployment
	Drivers []*ConnectDriverInstructions_DriverInstructions `protobuf:"bytes,1,rep,name=drivers,proto3" json:"drivers,omitempty"`
	// contains filtered or unexported fields
}

Instructions for connecting a driver to a deployment

func (*ConnectDriverInstructions) Descriptor deprecated 

func (*ConnectDriverInstructions) Descriptor() ([]byte, []int)

Deprecated: Use ConnectDriverInstructions.ProtoReflect.Descriptor instead.

func (*ConnectDriverInstructions) GetDrivers 

func (x *ConnectDriverInstructions) GetDrivers() []*ConnectDriverInstructions_DriverInstructions

func (*ConnectDriverInstructions) ProtoMessage 

func (*ConnectDriverInstructions) ProtoMessage()

func (*ConnectDriverInstructions) ProtoReflect added in v0.89.0 

func (x *ConnectDriverInstructions) ProtoReflect() protoreflect.Message

func (*ConnectDriverInstructions) Reset 

func (x *ConnectDriverInstructions) Reset()

func (*ConnectDriverInstructions) String 

func (x *ConnectDriverInstructions) String() string

type ConnectDriverInstructions_DriverInstructions 

type ConnectDriverInstructions_DriverInstructions struct {

	// Human readable name of the driver.
	// E.g. "ArangoDB Go driver"
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Lines of code
	Code []string `protobuf:"bytes,2,rep,name=code,proto3" json:"code,omitempty"`
	// Human readable remarks
	Remarks []string `protobuf:"bytes,3,rep,name=remarks,proto3" json:"remarks,omitempty"`
	// URL for getting more information on the driver.
	DriverUrl string `protobuf:"bytes,4,opt,name=driver_url,json=driverUrl,proto3" json:"driver_url,omitempty"`
	// contains filtered or unexported fields
}

Instructions for a specific driver

func (*ConnectDriverInstructions_DriverInstructions) Descriptor deprecated 

func (*ConnectDriverInstructions_DriverInstructions) Descriptor() ([]byte, []int)

Deprecated: Use ConnectDriverInstructions_DriverInstructions.ProtoReflect.Descriptor instead.

func (*ConnectDriverInstructions_DriverInstructions) GetCode 

func (x *ConnectDriverInstructions_DriverInstructions) GetCode() []string

func (*ConnectDriverInstructions_DriverInstructions) GetDriverUrl 

func (x *ConnectDriverInstructions_DriverInstructions) GetDriverUrl() string

func (*ConnectDriverInstructions_DriverInstructions) GetName 

func (x *ConnectDriverInstructions_DriverInstructions) GetName() string

func (*ConnectDriverInstructions_DriverInstructions) GetRemarks 

func (x *ConnectDriverInstructions_DriverInstructions) GetRemarks() []string

func (*ConnectDriverInstructions_DriverInstructions) ProtoMessage 

func (*ConnectDriverInstructions_DriverInstructions) ProtoMessage()

func (*ConnectDriverInstructions_DriverInstructions) ProtoReflect added in v0.89.0 

func (x *ConnectDriverInstructions_DriverInstructions) ProtoReflect() protoreflect.Message

func (*ConnectDriverInstructions_DriverInstructions) Reset 

func (x *ConnectDriverInstructions_DriverInstructions) Reset()

func (*ConnectDriverInstructions_DriverInstructions) String 

func (x *ConnectDriverInstructions_DriverInstructions) String() string

type CreateTestDatabaseRequest added in v0.43.7 

type CreateTestDatabaseRequest struct {

	// The id of the deployment
	DeploymentId string `protobuf:"bytes,1,opt,name=deployment_id,json=deploymentId,proto3" json:"deployment_id,omitempty"`
	// contains filtered or unexported fields
}

Request arguments for CreateTestDatabase

func (*CreateTestDatabaseRequest) Descriptor deprecated added in v0.43.7 

func (*CreateTestDatabaseRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateTestDatabaseRequest.ProtoReflect.Descriptor instead.

func (*CreateTestDatabaseRequest) GetDeploymentId added in v0.43.7 

func (x *CreateTestDatabaseRequest) GetDeploymentId() string

func (*CreateTestDatabaseRequest) ProtoMessage added in v0.43.7 

func (*CreateTestDatabaseRequest) ProtoMessage()

func (*CreateTestDatabaseRequest) ProtoReflect added in v0.89.0 

func (x *CreateTestDatabaseRequest) ProtoReflect() protoreflect.Message

func (*CreateTestDatabaseRequest) Reset added in v0.43.7 

func (x *CreateTestDatabaseRequest) Reset()

func (*CreateTestDatabaseRequest) String added in v0.43.7 

func (x *CreateTestDatabaseRequest) String() string

type CreateTestDatabaseResponse added in v0.43.7 

type CreateTestDatabaseResponse struct {

	// Name of the created database
	DbName string `protobuf:"bytes,1,opt,name=db_name,json=dbName,proto3" json:"db_name,omitempty"`
	// Username of the created user
	Username string `protobuf:"bytes,2,opt,name=username,proto3" json:"username,omitempty"`
	// Password of the created user
	Password string `protobuf:"bytes,3,opt,name=password,proto3" json:"password,omitempty"`
	// Hostname of the database
	Hostname string `protobuf:"bytes,4,opt,name=hostname,proto3" json:"hostname,omitempty"`
	// Port of the database
	Port string `protobuf:"bytes,5,opt,name=port,proto3" json:"port,omitempty"`
	// contains filtered or unexported fields
}

CreateTestDatabaseResponse will contain the json formatted output of the create operation

func (*CreateTestDatabaseResponse) Descriptor deprecated added in v0.43.7 

func (*CreateTestDatabaseResponse) Descriptor() ([]byte, []int)

Deprecated: Use CreateTestDatabaseResponse.ProtoReflect.Descriptor instead.

func (*CreateTestDatabaseResponse) GetDbName added in v0.43.7 

func (x *CreateTestDatabaseResponse) GetDbName() string

func (*CreateTestDatabaseResponse) GetHostname added in v0.43.7 

func (x *CreateTestDatabaseResponse) GetHostname() string

func (*CreateTestDatabaseResponse) GetPassword added in v0.43.7 

func (x *CreateTestDatabaseResponse) GetPassword() string

func (*CreateTestDatabaseResponse) GetPort added in v0.43.7 

func (x *CreateTestDatabaseResponse) GetPort() string

func (*CreateTestDatabaseResponse) GetUsername added in v0.43.7 

func (x *CreateTestDatabaseResponse) GetUsername() string

func (*CreateTestDatabaseResponse) ProtoMessage added in v0.43.7 

func (*CreateTestDatabaseResponse) ProtoMessage()

func (*CreateTestDatabaseResponse) ProtoReflect added in v0.89.0 

func (x *CreateTestDatabaseResponse) ProtoReflect() protoreflect.Message

func (*CreateTestDatabaseResponse) Reset added in v0.43.7 

func (x *CreateTestDatabaseResponse) Reset()

func (*CreateTestDatabaseResponse) String added in v0.43.7 

func (x *CreateTestDatabaseResponse) String() string

type DataServiceClient 

type DataServiceClient interface {
	// Get the current API version of this service.
	// Required permissions:
	// - None
	GetAPIVersion(ctx context.Context, in *v1.Empty, opts ...grpc.CallOption) (*v1.Version, error)
	// Fetch all deployments in the project identified by the given context ID.
	// Required permissions:
	// - data.deployment.list on the project identified by the given context ID
	ListDeployments(ctx context.Context, in *v1.ListOptions, opts ...grpc.CallOption) (*DeploymentList, error)
	// Fetch all deployments in the organization identified by the given filter.
	// Only the deployments with sufficient permissions are returned.
	// If the caller has no such permission on any of the deployments (in the organization) an empty list is returned, not an error.
	// Required permissions:
	// - None (authenticated only)
	// - data.deployment.list on the filtered deployment(s)
	ListDeploymentsByFilter(ctx context.Context, in *ListDeploymentsByFilterRequest, opts ...grpc.CallOption) (*DeploymentList, error)
	// Fetch a deployment by its id.
	// Required permissions:
	// - data.deployment.get on the deployment identified by the given ID
	GetDeployment(ctx context.Context, in *v1.IDOptions, opts ...grpc.CallOption) (*Deployment, error)
	// Fetch all updates (spec and/or status) of the deployment that matches the given request.
	// Required permissions:
	// - data.deployment.get on the deployment identified by the given ID
	GetDeploymentUpdates(ctx context.Context, in *v1.IDOptions, opts ...grpc.CallOption) (DataService_GetDeploymentUpdatesClient, error)
	// Create a new deployment
	// Required permissions:
	// - data.deployment.create on the project that owns the deployment
	// - network.privateendpointservice.create on the project that owns the deployment (if private_endpoint field is set)
	// Note that deployment.status & deployment.expiration are ignored
	// in this request.
	CreateDeployment(ctx context.Context, in *Deployment, opts ...grpc.CallOption) (*Deployment, error)
	// Update a deployment
	// Required permissions:
	// - data.deployment.update on the deployment
	// Note that deployment.status & deployment.expiration are ignored
	// in this request.
	UpdateDeployment(ctx context.Context, in *Deployment, opts ...grpc.CallOption) (*Deployment, error)
	// Update the setting for scheduled root password rotation
	// Required permissions:
	// - data.deployment.update-scheduled-root-password-rotation
	UpdateDeploymentScheduledRootPasswordRotation(ctx context.Context, in *UpdateDeploymentScheduledRootPasswordRotationRequest, opts ...grpc.CallOption) (*v1.Empty, error)
	// Delete a deployment
	// Note that deployments are initially only marked for deletion.
	// Once all their resources are removed the deployment itself is removed.
	// Required permissions:
	// - data.deployment.delete on the deployment
	DeleteDeployment(ctx context.Context, in *v1.IDOptions, opts ...grpc.CallOption) (*v1.Empty, error)
	// Fetch credentials for accessing deployment by its id.
	// Required permissions:
	// - data.deployment.get on the deployment identified by the given ID
	// - data.deploymentcredentials.get on the deployment identified by the given ID
	GetDeploymentCredentials(ctx context.Context, in *DeploymentCredentialsRequest, opts ...grpc.CallOption) (*DeploymentCredentials, error)
	// Fetch all ArangoDB versions that are available for deployments.
	// Required permissions:
	// - None
	ListVersions(ctx context.Context, in *ListVersionsRequest, opts ...grpc.CallOption) (*VersionList, error)
	// Fetch the default ArangoDB version for new deployment.
	// Required permissions:
	// - None
	GetDefaultVersion(ctx context.Context, in *v1.Empty, opts ...grpc.CallOption) (*Version, error)
	// Fetch the ArangoDB version by its id (semver).
	// Required permissions:
	// - None
	GetVersion(ctx context.Context, in *v1.IDOptions, opts ...grpc.CallOption) (*Version, error)
	// Fetch the limits for server specifications for deployments
	// owned by the given projected, created in the given region.
	// Required permissions:
	// - data.limits.get on the requested project
	// - data.deployment.get on the specified deployment (if deployment_id is set)
	// This method is deprecated and will be remove in the very near future, do not use this method anymore
	GetServersSpecLimits(ctx context.Context, in *ServersSpecLimitsRequest, opts ...grpc.CallOption) (*ServersSpecLimits, error)
	// Fetch the node sizes available for deployments
	// owned by the project with given ID, created in the given region with given ID.
	// If project ID "all" is used, then all node sizes for the region with given
	// ID are returned.
	// Required permissions:
	// - data.nodesize.list on the requested deployment (if deployment ID is set)
	// - data.nodesize.list on the requested project (if project ID does not equal "all")
	// - data.nodesize.list on the requested organization (if organization ID is set)
	// - None if project ID does equals "all"
	ListNodeSizes(ctx context.Context, in *NodeSizesRequest, opts ...grpc.CallOption) (*NodeSizeList, error)
	// Fetch the models available for deployments owned by the project with given ID.
	// Required permissions:
	// - data.deploymentmodel.list on the requested project
	ListDeploymentModels(ctx context.Context, in *ListDeploymentModelsRequest, opts ...grpc.CallOption) (*DeploymentModelList, error)
	// Fetch the CPU sizes available for deployments owned by the project with given ID.
	// Required permissions:
	// - data.cpusize.list on the requested project
	ListCPUSizes(ctx context.Context, in *ListCPUSizesRequest, opts ...grpc.CallOption) (*CPUSizeList, error)
	// Get the deployment model identified by the provided ID.
	// Required permissions:
	// - None (authenticated only)
	GetDeploymentModel(ctx context.Context, in *v1.IDOptions, opts ...grpc.CallOption) (*DeploymentModel, error)
	// Calculate the total size of a deployment with given arguments.
	// Required permissions:
	// - none
	CalculateDeploymentSize(ctx context.Context, in *CalculateDeploymentSizeRequest, opts ...grpc.CallOption) (*DeploymentSize, error)
	// Recommend a deployment size, for a oneshard or sharded deployments, using the
	// given input values.
	// Required permissions:
	// - none
	RecommendDeploymentSize(ctx context.Context, in *DeploymentSizeRequest, opts ...grpc.CallOption) (*DeploymentSizeRecommendation, error)
	// Fetch instructions for connecting drivers to the deployment identified by the given id.
	// Required permissions:
	// - data.deployment.get on the deployment identified by the given ID
	GetConnectDriverInstructions(ctx context.Context, in *v1.IDOptions, opts ...grpc.CallOption) (*ConnectDriverInstructions, error)
	// Fetch instructions for importing data into the deployment identified by the given id.
	// Required permissions:
	// - data.deployment.get on the deployment identified by the given ID
	GetImportDataInstructions(ctx context.Context, in *v1.IDOptions, opts ...grpc.CallOption) (*ImportDataInstructions, error)
	// Calculate the price of a deployment of given settings.
	// Required permissions:
	// - data.deploymentprice.calculate
	CalculateDeploymentPrice(ctx context.Context, in *DeploymentPriceRequest, opts ...grpc.CallOption) (*DeploymentPrice, error)
	// Get the features that will be available to a deployment in the given context.
	// Required permissions:
	// - data.deploymentfeatures.get on the project that is given in the request.
	GetDeploymentFeatures(ctx context.Context, in *DeploymentFeaturesRequest, opts ...grpc.CallOption) (*DeploymentFeatures, error)
	// Pauses a deployment indentified by the given ID.
	// When PauseDeployment is invoked on a deployment that is not allowed to pause or has is_paused set, an PreconditionFailed error is returned.
	// Required permissions:
	// - data.deployment.pause on the deployment
	PauseDeployment(ctx context.Context, in *v1.IDOptions, opts ...grpc.CallOption) (*v1.Empty, error)
	// Resumes a paused deployment identified by the given id.
	// When ResumeDeployment is invoked on a deployment that has is_paused not set, an PreconditionFailed error is returned.
	// Required permissions:
	// - data.deployment.resume on the deployment
	ResumeDeployment(ctx context.Context, in *v1.IDOptions, opts ...grpc.CallOption) (*v1.Empty, error)
	// Rotate a server for a deployment.
	// This causes the server to restart after condition are deemed safe for a restart.
	// Required permissions:
	// - data.deployment.rotate-server on the deployment
	RotateDeploymentServer(ctx context.Context, in *RotateDeploymentServerRequest, opts ...grpc.CallOption) (*v1.Empty, error)
	// Create a test database and user for a deployment. Returns the output containing the created
	// database name, password, username, host and port.
	// Required permissions:
	// - data.deployment.create-test-database on the deployment
	CreateTestDatabase(ctx context.Context, in *CreateTestDatabaseRequest, opts ...grpc.CallOption) (*CreateTestDatabaseResponse, error)
	// RebalanceDeploymentShards rebalances shards for deployment across the DB servers.
	// Prerelease: This function is not yet available in production.
	// Required permissions:
	// - data.deployment.rebalance-shards on the deployment
	RebalanceDeploymentShards(ctx context.Context, in *RebalanceDeploymentShardsRequest, opts ...grpc.CallOption) (*v1.Empty, error)
	// Lists disk performances that match all of the given filters.
	// Required permissions:
	// - data.diskperformance.list on the deployment (if deployment ID is provided)
	// - data.diskperformance.list on the organization (if organization ID is provided, but deployment ID is not)
	// - None, authenticated only (if no deployment ID is provided)
	ListDiskPerformances(ctx context.Context, in *ListDiskPerformancesRequest, opts ...grpc.CallOption) (*DiskPerformanceList, error)
	// Get the disk performance for the requested disk performance ID.
	// Required permissions:
	// - None, authenticated only
	GetDiskPerformance(ctx context.Context, in *GetDiskPerformanceRequest, opts ...grpc.CallOption) (*DiskPerformance, error)
}

DataServiceClient is the client API for DataService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewDataServiceClient 

func NewDataServiceClient(cc grpc.ClientConnInterface) DataServiceClient

type DataServiceServer 

type DataServiceServer interface {
	// Get the current API version of this service.
	// Required permissions:
	// - None
	GetAPIVersion(context.Context, *v1.Empty) (*v1.Version, error)
	// Fetch all deployments in the project identified by the given context ID.
	// Required permissions:
	// - data.deployment.list on the project identified by the given context ID
	ListDeployments(context.Context, *v1.ListOptions) (*DeploymentList, error)
	// Fetch all deployments in the organization identified by the given filter.
	// Only the deployments with sufficient permissions are returned.
	// If the caller has no such permission on any of the deployments (in the organization) an empty list is returned, not an error.
	// Required permissions:
	// - None (authenticated only)
	// - data.deployment.list on the filtered deployment(s)
	ListDeploymentsByFilter(context.Context, *ListDeploymentsByFilterRequest) (*DeploymentList, error)
	// Fetch a deployment by its id.
	// Required permissions:
	// - data.deployment.get on the deployment identified by the given ID
	GetDeployment(context.Context, *v1.IDOptions) (*Deployment, error)
	// Fetch all updates (spec and/or status) of the deployment that matches the given request.
	// Required permissions:
	// - data.deployment.get on the deployment identified by the given ID
	GetDeploymentUpdates(*v1.IDOptions, DataService_GetDeploymentUpdatesServer) error
	// Create a new deployment
	// Required permissions:
	// - data.deployment.create on the project that owns the deployment
	// - network.privateendpointservice.create on the project that owns the deployment (if private_endpoint field is set)
	// Note that deployment.status & deployment.expiration are ignored
	// in this request.
	CreateDeployment(context.Context, *Deployment) (*Deployment, error)
	// Update a deployment
	// Required permissions:
	// - data.deployment.update on the deployment
	// Note that deployment.status & deployment.expiration are ignored
	// in this request.
	UpdateDeployment(context.Context, *Deployment) (*Deployment, error)
	// Update the setting for scheduled root password rotation
	// Required permissions:
	// - data.deployment.update-scheduled-root-password-rotation
	UpdateDeploymentScheduledRootPasswordRotation(context.Context, *UpdateDeploymentScheduledRootPasswordRotationRequest) (*v1.Empty, error)
	// Delete a deployment
	// Note that deployments are initially only marked for deletion.
	// Once all their resources are removed the deployment itself is removed.
	// Required permissions:
	// - data.deployment.delete on the deployment
	DeleteDeployment(context.Context, *v1.IDOptions) (*v1.Empty, error)
	// Fetch credentials for accessing deployment by its id.
	// Required permissions:
	// - data.deployment.get on the deployment identified by the given ID
	// - data.deploymentcredentials.get on the deployment identified by the given ID
	GetDeploymentCredentials(context.Context, *DeploymentCredentialsRequest) (*DeploymentCredentials, error)
	// Fetch all ArangoDB versions that are available for deployments.
	// Required permissions:
	// - None
	ListVersions(context.Context, *ListVersionsRequest) (*VersionList, error)
	// Fetch the default ArangoDB version for new deployment.
	// Required permissions:
	// - None
	GetDefaultVersion(context.Context, *v1.Empty) (*Version, error)
	// Fetch the ArangoDB version by its id (semver).
	// Required permissions:
	// - None
	GetVersion(context.Context, *v1.IDOptions) (*Version, error)
	// Fetch the limits for server specifications for deployments
	// owned by the given projected, created in the given region.
	// Required permissions:
	// - data.limits.get on the requested project
	// - data.deployment.get on the specified deployment (if deployment_id is set)
	// This method is deprecated and will be remove in the very near future, do not use this method anymore
	GetServersSpecLimits(context.Context, *ServersSpecLimitsRequest) (*ServersSpecLimits, error)
	// Fetch the node sizes available for deployments
	// owned by the project with given ID, created in the given region with given ID.
	// If project ID "all" is used, then all node sizes for the region with given
	// ID are returned.
	// Required permissions:
	// - data.nodesize.list on the requested deployment (if deployment ID is set)
	// - data.nodesize.list on the requested project (if project ID does not equal "all")
	// - data.nodesize.list on the requested organization (if organization ID is set)
	// - None if project ID does equals "all"
	ListNodeSizes(context.Context, *NodeSizesRequest) (*NodeSizeList, error)
	// Fetch the models available for deployments owned by the project with given ID.
	// Required permissions:
	// - data.deploymentmodel.list on the requested project
	ListDeploymentModels(context.Context, *ListDeploymentModelsRequest) (*DeploymentModelList, error)
	// Fetch the CPU sizes available for deployments owned by the project with given ID.
	// Required permissions:
	// - data.cpusize.list on the requested project
	ListCPUSizes(context.Context, *ListCPUSizesRequest) (*CPUSizeList, error)
	// Get the deployment model identified by the provided ID.
	// Required permissions:
	// - None (authenticated only)
	GetDeploymentModel(context.Context, *v1.IDOptions) (*DeploymentModel, error)
	// Calculate the total size of a deployment with given arguments.
	// Required permissions:
	// - none
	CalculateDeploymentSize(context.Context, *CalculateDeploymentSizeRequest) (*DeploymentSize, error)
	// Recommend a deployment size, for a oneshard or sharded deployments, using the
	// given input values.
	// Required permissions:
	// - none
	RecommendDeploymentSize(context.Context, *DeploymentSizeRequest) (*DeploymentSizeRecommendation, error)
	// Fetch instructions for connecting drivers to the deployment identified by the given id.
	// Required permissions:
	// - data.deployment.get on the deployment identified by the given ID
	GetConnectDriverInstructions(context.Context, *v1.IDOptions) (*ConnectDriverInstructions, error)
	// Fetch instructions for importing data into the deployment identified by the given id.
	// Required permissions:
	// - data.deployment.get on the deployment identified by the given ID
	GetImportDataInstructions(context.Context, *v1.IDOptions) (*ImportDataInstructions, error)
	// Calculate the price of a deployment of given settings.
	// Required permissions:
	// - data.deploymentprice.calculate
	CalculateDeploymentPrice(context.Context, *DeploymentPriceRequest) (*DeploymentPrice, error)
	// Get the features that will be available to a deployment in the given context.
	// Required permissions:
	// - data.deploymentfeatures.get on the project that is given in the request.
	GetDeploymentFeatures(context.Context, *DeploymentFeaturesRequest) (*DeploymentFeatures, error)
	// Pauses a deployment indentified by the given ID.
	// When PauseDeployment is invoked on a deployment that is not allowed to pause or has is_paused set, an PreconditionFailed error is returned.
	// Required permissions:
	// - data.deployment.pause on the deployment
	PauseDeployment(context.Context, *v1.IDOptions) (*v1.Empty, error)
	// Resumes a paused deployment identified by the given id.
	// When ResumeDeployment is invoked on a deployment that has is_paused not set, an PreconditionFailed error is returned.
	// Required permissions:
	// - data.deployment.resume on the deployment
	ResumeDeployment(context.Context, *v1.IDOptions) (*v1.Empty, error)
	// Rotate a server for a deployment.
	// This causes the server to restart after condition are deemed safe for a restart.
	// Required permissions:
	// - data.deployment.rotate-server on the deployment
	RotateDeploymentServer(context.Context, *RotateDeploymentServerRequest) (*v1.Empty, error)
	// Create a test database and user for a deployment. Returns the output containing the created
	// database name, password, username, host and port.
	// Required permissions:
	// - data.deployment.create-test-database on the deployment
	CreateTestDatabase(context.Context, *CreateTestDatabaseRequest) (*CreateTestDatabaseResponse, error)
	// RebalanceDeploymentShards rebalances shards for deployment across the DB servers.
	// Prerelease: This function is not yet available in production.
	// Required permissions:
	// - data.deployment.rebalance-shards on the deployment
	RebalanceDeploymentShards(context.Context, *RebalanceDeploymentShardsRequest) (*v1.Empty, error)
	// Lists disk performances that match all of the given filters.
	// Required permissions:
	// - data.diskperformance.list on the deployment (if deployment ID is provided)
	// - data.diskperformance.list on the organization (if organization ID is provided, but deployment ID is not)
	// - None, authenticated only (if no deployment ID is provided)
	ListDiskPerformances(context.Context, *ListDiskPerformancesRequest) (*DiskPerformanceList, error)
	// Get the disk performance for the requested disk performance ID.
	// Required permissions:
	// - None, authenticated only
	GetDiskPerformance(context.Context, *GetDiskPerformanceRequest) (*DiskPerformance, error)
}

DataServiceServer is the server API for DataService service.

type DataService_GetDeploymentUpdatesClient added in v0.48.0 

type DataService_GetDeploymentUpdatesClient interface {
	Recv() (*Deployment, error)
	grpc.ClientStream
}

type DataService_GetDeploymentUpdatesServer added in v0.48.0 

type DataService_GetDeploymentUpdatesServer interface {
	Send(*Deployment) error
	grpc.ServerStream
}

type DataVolumeInfo 

type DataVolumeInfo struct {

	// The total number of bytes of the data volume.
	TotalBytes int64 `protobuf:"varint,1,opt,name=total_bytes,json=totalBytes,proto3" json:"total_bytes,omitempty"`
	// The number of bytes used on the data volume.
	UsedBytes int64 `protobuf:"varint,2,opt,name=used_bytes,json=usedBytes,proto3" json:"used_bytes,omitempty"`
	// The number of bytes available on the data volume.
	AvailableBytes int64 `protobuf:"varint,3,opt,name=available_bytes,json=availableBytes,proto3" json:"available_bytes,omitempty"`
	// The total number of inodes of the data volume.
	TotalInodes int64 `protobuf:"varint,4,opt,name=total_inodes,json=totalInodes,proto3" json:"total_inodes,omitempty"`
	// The number of inodes used on the data volume.
	UsedInodes int64 `protobuf:"varint,5,opt,name=used_inodes,json=usedInodes,proto3" json:"used_inodes,omitempty"`
	// The number of inodes available on the data volume.
	AvailableInodes int64 `protobuf:"varint,6,opt,name=available_inodes,json=availableInodes,proto3" json:"available_inodes,omitempty"`
	// When this info has been measused
	MeasuredAt *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=measured_at,json=measuredAt,proto3" json:"measured_at,omitempty"`
	// contains filtered or unexported fields
}

DataVolumeInfo provides information about a data volume

func (*DataVolumeInfo) Clone 

func (s *DataVolumeInfo) Clone() *DataVolumeInfo

Clone creates a deep clone of the given source

func (*DataVolumeInfo) Descriptor deprecated 

func (*DataVolumeInfo) Descriptor() ([]byte, []int)

Deprecated: Use DataVolumeInfo.ProtoReflect.Descriptor instead.

func (*DataVolumeInfo) GetAvailableBytes 

func (x *DataVolumeInfo) GetAvailableBytes() int64

func (*DataVolumeInfo) GetAvailableInodes added in v0.43.10 

func (x *DataVolumeInfo) GetAvailableInodes() int64

func (*DataVolumeInfo) GetMeasuredAt 

func (x *DataVolumeInfo) GetMeasuredAt() *timestamppb.Timestamp

func (*DataVolumeInfo) GetTotalBytes 

func (x *DataVolumeInfo) GetTotalBytes() int64

func (*DataVolumeInfo) GetTotalInodes added in v0.43.10 

func (x *DataVolumeInfo) GetTotalInodes() int64

func (*DataVolumeInfo) GetUsedBytes 

func (x *DataVolumeInfo) GetUsedBytes() int64

func (*DataVolumeInfo) GetUsedInodes added in v0.43.10 

func (x *DataVolumeInfo) GetUsedInodes() int64

func (*DataVolumeInfo) ProtoMessage 

func (*DataVolumeInfo) ProtoMessage()

func (*DataVolumeInfo) ProtoReflect added in v0.89.0 

func (x *DataVolumeInfo) ProtoReflect() protoreflect.Message

func (*DataVolumeInfo) Reset 

func (x *DataVolumeInfo) Reset()

func (*DataVolumeInfo) String 

func (x *DataVolumeInfo) String() string

type Deployment 

type Deployment struct {

	// System identifier of the deployment.
	// This is a read-only value.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// URL of this resource
	// This is a read-only value.
	Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`
	// Name of the deployment
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// Description of the deployment
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// Identifier of the project that owns this deployment.
	// After creation, this value cannot be changed.
	ProjectId string `protobuf:"bytes,5,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Identifier of the region in which the deployment is created.
	// After creation, this value cannot be changed.
	RegionId string `protobuf:"bytes,6,opt,name=region_id,json=regionId,proto3" json:"region_id,omitempty"`
	// The creation timestamp of the deployment
	// This is a read-only value.
	CreatedAt *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// The deletion timestamp of the deployment
	// This is a read-only value.
	DeletedAt *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=deleted_at,json=deletedAt,proto3" json:"deleted_at,omitempty"`
	// Set when this deployment is deleted.
	// This is a read-only value.
	IsDeleted bool `protobuf:"varint,9,opt,name=is_deleted,json=isDeleted,proto3" json:"is_deleted,omitempty"`
	// Optional identifier of the support plan selected for this deployment.
	// After creation, this value cannot be changed.
	// If no support plan identifier is set, the default support plan is used.
	SupportPlanId string `protobuf:"bytes,10,opt,name=support_plan_id,json=supportPlanId,proto3" json:"support_plan_id,omitempty"`
	// Identifier of the user who created this deployment.
	// This is a read-only value.
	CreatedById string `protobuf:"bytes,11,opt,name=created_by_id,json=createdById,proto3" json:"created_by_id,omitempty"`
	// This field must be set to the identifier of the current Terms&Conditions
	// when creating a deployment.
	// If the tier of the organization does not require a non-empty Terms&Condition
	// identifier, this field may be left empty.
	// This is a read-only value after creation.
	AcceptedTermsAndConditionsId string `` /* 152-byte string literal not displayed */
	// If set, this deployment cannot be deleted.
	// To delete, first update the with locked set to false.
	Locked bool `protobuf:"varint,13,opt,name=locked,proto3" json:"locked,omitempty"`
	// Indicates that this deployment is paused.
	// Use the data.ResumeDeployment method to resume (aka unpause) the deployment.
	// This is a read-only value.
	IsPaused bool `protobuf:"varint,20,opt,name=is_paused,json=isPaused,proto3" json:"is_paused,omitempty"`
	// The last paused timestamp of the deployment.
	// This is the timestamp that is_paused is transitioned from unset to set.
	// This is a read-only value.
	LastPausedAt *timestamppb.Timestamp `protobuf:"bytes,21,opt,name=last_paused_at,json=lastPausedAt,proto3" json:"last_paused_at,omitempty"`
	// The last resumed  timestamp of the deployment.
	// This is the timestamp that is_paused is transitioned from set to unset.
	// This is a read-only value.
	LastResumedAt *timestamppb.Timestamp `protobuf:"bytes,22,opt,name=last_resumed_at,json=lastResumedAt,proto3" json:"last_resumed_at,omitempty"`
	// Identifier of the prepaid deployment that this deployment is attached to (if any).
	// This is a read-only value.
	PrepaidDeploymentId string `protobuf:"bytes,23,opt,name=prepaid_deployment_id,json=prepaidDeploymentId,proto3" json:"prepaid_deployment_id,omitempty"`
	// If set, authentication for Foxx requests is disabled.
	// Be default this field is not set for new deployments.
	DisableFoxxAuthentication bool `` /* 140-byte string literal not displayed */
	// When the prepaid deployments starts (relevant when prepaid_deployment_id is set only)
	// This is a read-only value
	PrepaidDeploymentStartsAt *timestamppb.Timestamp `` /* 141-byte string literal not displayed */
	// When the prepaid deployments ends (relevant when prepaid_deployment_id is set only)
	// This is a read-only value
	PrepaidDeploymentEndsAt *timestamppb.Timestamp `` /* 135-byte string literal not displayed */
	// Whenever deployment can be updated to new values from prepaid deployment
	// This is a read-only value
	IsPrepaidDeploymentUpdateAvailable bool `` /* 171-byte string literal not displayed */
	// Set if the deployment use a private endpoint.
	// This is a read-only value after creation.
	// If set during creation a private endpoint service will be created.
	PrivateEndpoint bool `protobuf:"varint,30,opt,name=private_endpoint,json=privateEndpoint,proto3" json:"private_endpoint,omitempty"`
	// ArangoDB version to use for this deployment.
	// See Version.version.
	// If you change this value to a higher version,
	// the deployment will be upgraded.
	// If you change this value to a lower patch value,
	// the deployment will be downgraded.
	// Any attempt to change to a lower minor or major version
	// is considered an invalid request.
	// Any attempt to change to a version that is not in the
	// list of available versions is considered an invalid request.
	Version string `protobuf:"bytes,101,opt,name=version,proto3" json:"version,omitempty"`
	// If set, this deployment will be upgraded to the ArangoDB release with the
	// version as listed in this field.
	ReplaceVersionBy *ReplaceVersionBy `protobuf:"bytes,104,opt,name=replace_version_by,json=replaceVersionBy,proto3" json:"replace_version_by,omitempty"`
	// If set, it is recommended to upgrade to the ArangoDB release with the
	// version as listed in this field.
	UpgradeRecommendation *UpgradeVersionRecommendation `` /* 126-byte string literal not displayed */
	// If set, the version used by this deployment is no longer actively supported.
	// This is a readonly field.
	VersionIsEndOfLife bool                        `protobuf:"varint,701,opt,name=version_is_end_of_life,json=versionIsEndOfLife,proto3" json:"version_is_end_of_life,omitempty"`
	Certificates       *Deployment_CertificateSpec `protobuf:"bytes,102,opt,name=certificates,proto3" json:"certificates,omitempty"`
	Servers            *Deployment_ServersSpec     `protobuf:"bytes,103,opt,name=servers,proto3" json:"servers,omitempty"`
	// Optional identifier of IP allowlist to use for this deployment.
	IpallowlistId string                `protobuf:"bytes,109,opt,name=ipallowlist_id,json=ipallowlistId,proto3" json:"ipallowlist_id,omitempty"`
	Model         *Deployment_ModelSpec `protobuf:"bytes,106,opt,name=model,proto3" json:"model,omitempty"`
	// If provided, dataclusterd will use this custom image tag instead of the configured one for a given version.
	// Further, ImagePullPolicy will be set to Always.
	// This field can only be set by selected organizations.
	CustomImage string `protobuf:"bytes,107,opt,name=custom_image,json=customImage,proto3" json:"custom_image,omitempty"`
	// Optional identifier of IAM provider to use for this deployment.
	IamproviderId string `protobuf:"bytes,108,opt,name=iamprovider_id,json=iamproviderId,proto3" json:"iamprovider_id,omitempty"`
	// Optional identifier of disk performance to use for this deployment.
	DiskPerformanceId string `protobuf:"bytes,120,opt,name=disk_performance_id,json=diskPerformanceId,proto3" json:"disk_performance_id,omitempty"`
	// If set, the disk performance cannot be updated, due to other reasons than the disk rate limit.
	// This is a read-only value
	DiskPerformanceLocked bool `` /* 129-byte string literal not displayed */
	// Disk rate limit is the (fixed) period required to wait before a next disk action can be executed.
	// A value of 0 means that there is no rate limit.
	// If now - (last_disk_performance_updated_at or last_disk_size_updated_at) > disk_rate_limit_period it is not allowed to update
	// dbserver_disk_size or disk_performance_id.
	DiskRateLimitPeriod *durationpb.Duration `protobuf:"bytes,122,opt,name=disk_rate_limit_period,json=diskRateLimitPeriod,proto3" json:"disk_rate_limit_period,omitempty"`
	// Timestamp when the last time the disk performance has been updated.
	// This is a read-only value
	LastDiskPerformanceUpdatedAt *timestamppb.Timestamp `` /* 153-byte string literal not displayed */
	// Timestamp when the last time the disk size has been updated.
	// This is a read-only value
	LastDiskSizeUpdatedAt *timestamppb.Timestamp `` /* 132-byte string literal not displayed */
	// Disk rate limit active is the active period required to wait before a next disk action can be executed.
	// The difference between disk_rate_limit_period and this field is that disk_rate_limit_period is a constant value
	// (independent) if the rate limit is active, this field will count down, if the field is 0 you can modify.
	// If this field is set it is not allowed to update dbserver_disk_size or disk_performance_id.
	// This is a read-only value
	DiskRateLimitActive *durationpb.Duration `protobuf:"bytes,125,opt,name=disk_rate_limit_active,json=diskRateLimitActive,proto3" json:"disk_rate_limit_active,omitempty"`
	Status              *Deployment_Status   `protobuf:"bytes,201,opt,name=status,proto3" json:"status,omitempty"`
	// Detailed size of the deployment
	// This is a read-only field.
	Size       *DeploymentSize        `protobuf:"bytes,202,opt,name=size,proto3" json:"size,omitempty"`
	Expiration *Deployment_Expiration `protobuf:"bytes,301,opt,name=expiration,proto3" json:"expiration,omitempty"`
	// Information about a backup restore.
	// If this field is set the deployment will be restored to that backup.
	// This is a read-only field. To set this field please use the backup service RestoreBackup method.
	BackupRestore *Deployment_BackupRestoreSpec `protobuf:"bytes,401,opt,name=backup_restore,json=backupRestore,proto3" json:"backup_restore,omitempty"`
	// Recommendations made for deployments using the "oneshard" or "sharded" model.
	DeploymentRecommendations []*DeploymentSizeRecommendation `` /* 138-byte string literal not displayed */
	// Set if this deployment is a clone and should be handled differently. After bootstrapping a clone
	// needs a restore operation.
	// This is a read-only property
	IsClone bool `protobuf:"varint,600,opt,name=is_clone,json=isClone,proto3" json:"is_clone,omitempty"`
	// The ID of the backup to restore this clone deployment from.
	// This is a read-only property
	CloneBackupId string `protobuf:"bytes,601,opt,name=clone_backup_id,json=cloneBackupId,proto3" json:"clone_backup_id,omitempty"`
	// Deployment's notification settings
	NotificationSettings *Deployment_NotificationSettings `protobuf:"bytes,610,opt,name=notification_settings,json=notificationSettings,proto3" json:"notification_settings,omitempty"`
	// Deployment's disk autoscaling settings
	// [Deprecated] This setting isn't supported anymore.
	//
	//	To increase disk space you need to switch to a larger node-size [e.g. A8 (with 80Gib)--> A16 (with 160 Gib)]
	DiskAutoSizeSettings *Deployment_DiskAutoSizeSettings `` /* 127-byte string literal not displayed */
	// Determines if root's password scheduled rotation is enabled for the deployment.
	// This is a readonly field.
	IsScheduledRootPasswordRotationEnabled bool `` /* 186-byte string literal not displayed */
	// Time when the last time root password rotated for the deployment.
	// For the existing deployments, this field is not set until they enable scheduled root password rotation.
	// For the new deployments, this field will have the same value with deployment's `created_at`.
	// This is a readonly field.
	LastRootPasswordRotatedAt *timestamppb.Timestamp `` /* 144-byte string literal not displayed */
	// Optional identifier of the deployment profile for this deployment.
	// After creation, this value cannot be changed.
	DeploymentProfileId string `protobuf:"bytes,614,opt,name=deployment_profile_id,json=deploymentProfileId,proto3" json:"deployment_profile_id,omitempty"`
	// Determines if deployment is using platform authentication
	IsPlatformAuthenticationEnabled bool `` /* 161-byte string literal not displayed */
	// The (optional) intended use-case for this deployment
	IntendedUseCase string `protobuf:"bytes,616,opt,name=intended_use_case,json=intendedUseCase,proto3" json:"intended_use_case,omitempty"`
	// If set to true, drop support for deprecated VST protocol and improve resilience.
	// Defaults to false.
	DropVstSupport bool `protobuf:"varint,617,opt,name=drop_vst_support,json=dropVstSupport,proto3" json:"drop_vst_support,omitempty"`
	// Defines notifications attached to the Deployment
	Notifications map[string]*Notification `` /* 169-byte string literal not displayed */
	// contains filtered or unexported fields
}

A Deployment is represents one deployment of an ArangoDB cluster.

func (*Deployment) Descriptor deprecated 

func (*Deployment) Descriptor() ([]byte, []int)

Deprecated: Use Deployment.ProtoReflect.Descriptor instead.

func (*Deployment) GetAcceptedTermsAndConditionsId 

func (x *Deployment) GetAcceptedTermsAndConditionsId() string

func (*Deployment) GetBackupRestore 

func (x *Deployment) GetBackupRestore() *Deployment_BackupRestoreSpec

func (*Deployment) GetCertificates 

func (x *Deployment) GetCertificates() *Deployment_CertificateSpec

func (*Deployment) GetCloneBackupId added in v0.43.5 

func (x *Deployment) GetCloneBackupId() string

func (*Deployment) GetCreatedAt 

func (x *Deployment) GetCreatedAt() *timestamppb.Timestamp

func (*Deployment) GetCreatedById 

func (x *Deployment) GetCreatedById() string

func (*Deployment) GetCustomImage 

func (x *Deployment) GetCustomImage() string

func (*Deployment) GetDeletedAt 

func (x *Deployment) GetDeletedAt() *timestamppb.Timestamp

func (*Deployment) GetDeploymentProfileId added in v0.76.7 

func (x *Deployment) GetDeploymentProfileId() string

func (*Deployment) GetDeploymentRecommendations 

func (x *Deployment) GetDeploymentRecommendations() []*DeploymentSizeRecommendation

func (*Deployment) GetDescription 

func (x *Deployment) GetDescription() string

func (*Deployment) GetDisableFoxxAuthentication added in v0.69.3 

func (x *Deployment) GetDisableFoxxAuthentication() bool

func (*Deployment) GetDiskAutoSizeSettings added in v0.72.4 

func (x *Deployment) GetDiskAutoSizeSettings() *Deployment_DiskAutoSizeSettings

func (*Deployment) GetDiskPerformanceId added in v0.73.0 

func (x *Deployment) GetDiskPerformanceId() string

func (*Deployment) GetDiskPerformanceLocked added in v0.73.0 

func (x *Deployment) GetDiskPerformanceLocked() bool

func (*Deployment) GetDiskRateLimitActive added in v0.73.2 

func (x *Deployment) GetDiskRateLimitActive() *durationpb.Duration

func (*Deployment) GetDiskRateLimitPeriod added in v0.73.0 

func (x *Deployment) GetDiskRateLimitPeriod() *durationpb.Duration

func (*Deployment) GetDropVstSupport added in v0.83.1 

func (x *Deployment) GetDropVstSupport() bool

func (*Deployment) GetExpiration 

func (x *Deployment) GetExpiration() *Deployment_Expiration

func (*Deployment) GetIamproviderId 

func (x *Deployment) GetIamproviderId() string

func (*Deployment) GetId 

func (x *Deployment) GetId() string

func (*Deployment) GetIntendedUseCase added in v0.79.19 

func (x *Deployment) GetIntendedUseCase() string

func (*Deployment) GetIpallowlistId added in v0.45.0 

func (x *Deployment) GetIpallowlistId() string

func (*Deployment) GetIsClone added in v0.43.5 

func (x *Deployment) GetIsClone() bool

func (*Deployment) GetIsDeleted 

func (x *Deployment) GetIsDeleted() bool

func (*Deployment) GetIsPaused added in v0.43.4 

func (x *Deployment) GetIsPaused() bool

func (*Deployment) GetIsPlatformAuthenticationEnabled added in v0.79.3 

func (x *Deployment) GetIsPlatformAuthenticationEnabled() bool

func (*Deployment) GetIsPrepaidDeploymentUpdateAvailable added in v0.70.3 

func (x *Deployment) GetIsPrepaidDeploymentUpdateAvailable() bool

func (*Deployment) GetIsScheduledRootPasswordRotationEnabled added in v0.73.8 

func (x *Deployment) GetIsScheduledRootPasswordRotationEnabled() bool

func (*Deployment) GetLastDiskPerformanceUpdatedAt added in v0.73.0 

func (x *Deployment) GetLastDiskPerformanceUpdatedAt() *timestamppb.Timestamp

func (*Deployment) GetLastDiskSizeUpdatedAt added in v0.73.0 

func (x *Deployment) GetLastDiskSizeUpdatedAt() *timestamppb.Timestamp

func (*Deployment) GetLastPausedAt added in v0.43.4 

func (x *Deployment) GetLastPausedAt() *timestamppb.Timestamp

func (*Deployment) GetLastResumedAt added in v0.43.4 

func (x *Deployment) GetLastResumedAt() *timestamppb.Timestamp

func (*Deployment) GetLastRootPasswordRotatedAt added in v0.73.8 

func (x *Deployment) GetLastRootPasswordRotatedAt() *timestamppb.Timestamp

func (*Deployment) GetLocked added in v0.47.0 

func (x *Deployment) GetLocked() bool

func (*Deployment) GetModel 

func (x *Deployment) GetModel() *Deployment_ModelSpec

func (*Deployment) GetName 

func (x *Deployment) GetName() string

func (*Deployment) GetNotificationSettings added in v0.71.2 

func (x *Deployment) GetNotificationSettings() *Deployment_NotificationSettings

func (*Deployment) GetNotifications added in v0.88.10 

func (x *Deployment) GetNotifications() map[string]*Notification

func (*Deployment) GetOrCreateCertificates 

func (d *Deployment) GetOrCreateCertificates() *Deployment_CertificateSpec

GetOrCreateCertificates returns the Certificates field, creating it if needed.

func (*Deployment) GetOrCreateExpiration 

func (d *Deployment) GetOrCreateExpiration() *Deployment_Expiration

GetOrCreateExpiration returns the Expiration field, creating it if needed.

func (*Deployment) GetOrCreateServers 

func (d *Deployment) GetOrCreateServers() *Deployment_ServersSpec

GetOrCreateServers returns the Servers field, creating it if needed.

func (*Deployment) GetOrCreateStatus 

func (d *Deployment) GetOrCreateStatus() *Deployment_Status

GetOrCreateStatus returns the Status field, creating it if needed.

func (*Deployment) GetOrganizationID added in v0.63.3 

func (depl *Deployment) GetOrganizationID() (string, error)

GetOrganizationID returns the organization ID of a deployment based on the URL.

func (*Deployment) GetPrepaidDeploymentEndsAt added in v0.70.0 

func (x *Deployment) GetPrepaidDeploymentEndsAt() *timestamppb.Timestamp

func (*Deployment) GetPrepaidDeploymentId added in v0.68.0 

func (x *Deployment) GetPrepaidDeploymentId() string

func (*Deployment) GetPrepaidDeploymentStartsAt added in v0.70.0 

func (x *Deployment) GetPrepaidDeploymentStartsAt() *timestamppb.Timestamp

func (*Deployment) GetPrivateEndpoint added in v0.71.0 

func (x *Deployment) GetPrivateEndpoint() bool

func (*Deployment) GetProjectId 

func (x *Deployment) GetProjectId() string

func (*Deployment) GetRegionId 

func (x *Deployment) GetRegionId() string

func (*Deployment) GetReplaceVersionBy added in v0.40.10 

func (x *Deployment) GetReplaceVersionBy() *ReplaceVersionBy

func (*Deployment) GetServers 

func (x *Deployment) GetServers() *Deployment_ServersSpec

func (*Deployment) GetSize added in v0.89.0 

func (x *Deployment) GetSize() *DeploymentSize

func (*Deployment) GetStatus 

func (x *Deployment) GetStatus() *Deployment_Status

func (*Deployment) GetSupportPlanId 

func (x *Deployment) GetSupportPlanId() string

func (*Deployment) GetUpgradeRecommendation added in v0.60.0 

func (x *Deployment) GetUpgradeRecommendation() *UpgradeVersionRecommendation

func (*Deployment) GetUrl 

func (x *Deployment) GetUrl() string

func (*Deployment) GetVersion 

func (x *Deployment) GetVersion() string

func (*Deployment) GetVersionIsEndOfLife added in v0.72.8 

func (x *Deployment) GetVersionIsEndOfLife() bool

func (*Deployment) Notification added in v0.88.10 

func (d *Deployment) Notification(id string) (*Notification, bool)

func (*Deployment) NotificationEquals added in v0.88.10 

func (d *Deployment) NotificationEquals(id string, notification string, severity NotificationSeverity) bool

func (*Deployment) ProtoMessage 

func (*Deployment) ProtoMessage()

func (*Deployment) ProtoReflect added in v0.89.0 

func (x *Deployment) ProtoReflect() protoreflect.Message

func (*Deployment) Reset 

func (x *Deployment) Reset()

func (*Deployment) SpecEquals 

func (source *Deployment) SpecEquals(other *Deployment) bool

SpecEquals returns true when source & other have the same specification values

func (*Deployment) String 

func (x *Deployment) String() string

type DeploymentCallback 

type DeploymentCallback func(context.Context, *Deployment) error

DeploymentCallback is a callback for individual deployments.

type DeploymentCredentials 

type DeploymentCredentials struct {

	// Name of the user for which credentials were asked.
	// Default to username of root user.
	Username string `protobuf:"bytes,1,opt,name=username,proto3" json:"username,omitempty"`
	// Password of the user for which credentials were asked.
	Password string `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty"`
	// contains filtered or unexported fields
}

Result for GetDeploymentCredentials

func (*DeploymentCredentials) Descriptor deprecated 

func (*DeploymentCredentials) Descriptor() ([]byte, []int)

Deprecated: Use DeploymentCredentials.ProtoReflect.Descriptor instead.

func (*DeploymentCredentials) GetPassword 

func (x *DeploymentCredentials) GetPassword() string

func (*DeploymentCredentials) GetUsername 

func (x *DeploymentCredentials) GetUsername() string

func (*DeploymentCredentials) ProtoMessage 

func (*DeploymentCredentials) ProtoMessage()

func (*DeploymentCredentials) ProtoReflect added in v0.89.0 

func (x *DeploymentCredentials) ProtoReflect() protoreflect.Message

func (*DeploymentCredentials) Reset 

func (x *DeploymentCredentials) Reset()

func (*DeploymentCredentials) String 

func (x *DeploymentCredentials) String() string

type DeploymentCredentialsRequest 

type DeploymentCredentialsRequest struct {

	// Identifier of deployment to request credentials for.
	DeploymentId string `protobuf:"bytes,1,opt,name=deployment_id,json=deploymentId,proto3" json:"deployment_id,omitempty"`
	// Reason for requesting the credentials
	Reason string `protobuf:"bytes,2,opt,name=reason,proto3" json:"reason,omitempty"`
	// contains filtered or unexported fields
}

Request arguments for GetDeploymentCredentials

func (*DeploymentCredentialsRequest) Descriptor deprecated 

func (*DeploymentCredentialsRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeploymentCredentialsRequest.ProtoReflect.Descriptor instead.

func (*DeploymentCredentialsRequest) GetDeploymentId 

func (x *DeploymentCredentialsRequest) GetDeploymentId() string

func (*DeploymentCredentialsRequest) GetReason 

func (x *DeploymentCredentialsRequest) GetReason() string

func (*DeploymentCredentialsRequest) ProtoMessage 

func (*DeploymentCredentialsRequest) ProtoMessage()

func (*DeploymentCredentialsRequest) ProtoReflect added in v0.89.0 

func (x *DeploymentCredentialsRequest) ProtoReflect() protoreflect.Message

func (*DeploymentCredentialsRequest) Reset 

func (x *DeploymentCredentialsRequest) Reset()

func (*DeploymentCredentialsRequest) String 

func (x *DeploymentCredentialsRequest) String() string

type DeploymentFeatures 

type DeploymentFeatures struct {

	// Is the use of an IAM provider available?
	Iamprovider bool `protobuf:"varint,1,opt,name=iamprovider,proto3" json:"iamprovider,omitempty"`
	// Is the use of the pause feature available?
	Pause bool `protobuf:"varint,2,opt,name=pause,proto3" json:"pause,omitempty"`
	// Is the use of the ML features available?
	Ml bool `protobuf:"varint,3,opt,name=ml,proto3" json:"ml,omitempty"`
	// Is the use of monitoring feature available?
	Monitoring bool `protobuf:"varint,4,opt,name=monitoring,proto3" json:"monitoring,omitempty"`
	// contains filtered or unexported fields
}

Features that are available to new deployments in a given context.

func (*DeploymentFeatures) Descriptor deprecated 

func (*DeploymentFeatures) Descriptor() ([]byte, []int)

Deprecated: Use DeploymentFeatures.ProtoReflect.Descriptor instead.

func (*DeploymentFeatures) GetIamprovider 

func (x *DeploymentFeatures) GetIamprovider() bool

func (*DeploymentFeatures) GetMl added in v0.79.8 

func (x *DeploymentFeatures) GetMl() bool

func (*DeploymentFeatures) GetMonitoring added in v0.81.7 

func (x *DeploymentFeatures) GetMonitoring() bool

func (*DeploymentFeatures) GetPause added in v0.78.6 

func (x *DeploymentFeatures) GetPause() bool

func (*DeploymentFeatures) ProtoMessage 

func (*DeploymentFeatures) ProtoMessage()

func (*DeploymentFeatures) ProtoReflect added in v0.89.0 

func (x *DeploymentFeatures) ProtoReflect() protoreflect.Message

func (*DeploymentFeatures) Reset 

func (x *DeploymentFeatures) Reset()

func (*DeploymentFeatures) String 

func (x *DeploymentFeatures) String() string

type DeploymentFeaturesRequest 

type DeploymentFeaturesRequest struct {

	// Identifier of project that will own a deployment.
	ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Identifier of a region in which a deployment will be created.
	RegionId string `protobuf:"bytes,2,opt,name=region_id,json=regionId,proto3" json:"region_id,omitempty"`
	// Model of the intended deployment.
	Model string `protobuf:"bytes,3,opt,name=model,proto3" json:"model,omitempty"`
	// Node size use for the intended deployments
	NodeSizeId string `protobuf:"bytes,4,opt,name=node_size_id,json=nodeSizeId,proto3" json:"node_size_id,omitempty"`
	// contains filtered or unexported fields
}

Request arguments for GetDeploymentFeatures

func (*DeploymentFeaturesRequest) Descriptor deprecated 

func (*DeploymentFeaturesRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeploymentFeaturesRequest.ProtoReflect.Descriptor instead.

func (*DeploymentFeaturesRequest) GetModel 

func (x *DeploymentFeaturesRequest) GetModel() string

func (*DeploymentFeaturesRequest) GetNodeSizeId 

func (x *DeploymentFeaturesRequest) GetNodeSizeId() string

func (*DeploymentFeaturesRequest) GetProjectId 

func (x *DeploymentFeaturesRequest) GetProjectId() string

func (*DeploymentFeaturesRequest) GetRegionId 

func (x *DeploymentFeaturesRequest) GetRegionId() string

func (*DeploymentFeaturesRequest) ProtoMessage 

func (*DeploymentFeaturesRequest) ProtoMessage()

func (*DeploymentFeaturesRequest) ProtoReflect added in v0.89.0 

func (x *DeploymentFeaturesRequest) ProtoReflect() protoreflect.Message

func (*DeploymentFeaturesRequest) Reset 

func (x *DeploymentFeaturesRequest) Reset()

func (*DeploymentFeaturesRequest) String 

func (x *DeploymentFeaturesRequest) String() string

type DeploymentList 

type DeploymentList struct {

	// Actual deployments
	Items []*Deployment `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	// Budget for deployments
	Budget *v1.Budget `protobuf:"bytes,2,opt,name=budget,proto3" json:"budget,omitempty"`
	// contains filtered or unexported fields
}

List of Deployments.

func (*DeploymentList) Descriptor deprecated 

func (*DeploymentList) Descriptor() ([]byte, []int)

Deprecated: Use DeploymentList.ProtoReflect.Descriptor instead.

func (*DeploymentList) GetBudget 

func (x *DeploymentList) GetBudget() *v1.Budget

func (*DeploymentList) GetItems 

func (x *DeploymentList) GetItems() []*Deployment

func (*DeploymentList) ProtoMessage 

func (*DeploymentList) ProtoMessage()

func (*DeploymentList) ProtoReflect added in v0.89.0 

func (x *DeploymentList) ProtoReflect() protoreflect.Message

func (*DeploymentList) Reset 

func (x *DeploymentList) Reset()

func (*DeploymentList) String 

func (x *DeploymentList) String() string

type DeploymentModel 

type DeploymentModel struct {

	// System identifier of the model (e.g. oneshard)
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Human readable name of the model (e.g. One shard)
	Name     string                    `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	Features *DeploymentModel_Features `protobuf:"bytes,3,opt,name=features,proto3" json:"features,omitempty"`
	// Limit the time-to-live of deployments created with this model.
	// Time-to-live (till expiration) is expressed in seconds.
	// A value of '0' means no expiration.
	DeploymentTtl int64 `protobuf:"varint,4,opt,name=deployment_ttl,json=deploymentTtl,proto3" json:"deployment_ttl,omitempty"`
	// contains filtered or unexported fields
}

DeploymentModel specifies the a specific model of deploying arangodb clusters.

func (*DeploymentModel) Descriptor deprecated 

func (*DeploymentModel) Descriptor() ([]byte, []int)

Deprecated: Use DeploymentModel.ProtoReflect.Descriptor instead.

func (*DeploymentModel) GetDeploymentTtl added in v0.88.7 

func (x *DeploymentModel) GetDeploymentTtl() int64

func (*DeploymentModel) GetFeatures added in v0.88.1 

func (x *DeploymentModel) GetFeatures() *DeploymentModel_Features

func (*DeploymentModel) GetId 

func (x *DeploymentModel) GetId() string

func (*DeploymentModel) GetName 

func (x *DeploymentModel) GetName() string

func (*DeploymentModel) ProtoMessage 

func (*DeploymentModel) ProtoMessage()

func (*DeploymentModel) ProtoReflect added in v0.89.0 

func (x *DeploymentModel) ProtoReflect() protoreflect.Message

func (*DeploymentModel) Reset 

func (x *DeploymentModel) Reset()

func (*DeploymentModel) String 

func (x *DeploymentModel) String() string

type DeploymentModelList 

type DeploymentModelList struct {
	Items []*DeploymentModel `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	// contains filtered or unexported fields
}

List of deployment models.

func (*DeploymentModelList) Descriptor deprecated 

func (*DeploymentModelList) Descriptor() ([]byte, []int)

Deprecated: Use DeploymentModelList.ProtoReflect.Descriptor instead.

func (*DeploymentModelList) GetItems 

func (x *DeploymentModelList) GetItems() []*DeploymentModel

func (*DeploymentModelList) ProtoMessage 

func (*DeploymentModelList) ProtoMessage()

func (*DeploymentModelList) ProtoReflect added in v0.89.0 

func (x *DeploymentModelList) ProtoReflect() protoreflect.Message

func (*DeploymentModelList) Reset 

func (x *DeploymentModelList) Reset()

func (*DeploymentModelList) String 

func (x *DeploymentModelList) String() string

type DeploymentModel_Features added in v0.88.1 

type DeploymentModel_Features struct {

	// If set, ML is available as a trial only.
	MlFreeTrial bool `protobuf:"varint,1,opt,name=ml_free_trial,json=mlFreeTrial,proto3" json:"ml_free_trial,omitempty"`
	// If set, private endpoints are allowed for this deployment model.
	PrivateEndpoints bool `protobuf:"varint,2,opt,name=private_endpoints,json=privateEndpoints,proto3" json:"private_endpoints,omitempty"`
	// If set, metrics endpoint integration is allowed for this deployment model.
	MetricsEndpoint bool `protobuf:"varint,3,opt,name=metrics_endpoint,json=metricsEndpoint,proto3" json:"metrics_endpoint,omitempty"`
	// If set, backups for this deployment model are allowed to be uploaded to the cloud.
	BackupUploads bool `protobuf:"varint,4,opt,name=backup_uploads,json=backupUploads,proto3" json:"backup_uploads,omitempty"`
	// contains filtered or unexported fields
}

Features that are available to deployments of this model type.

func (*DeploymentModel_Features) Descriptor deprecated added in v0.88.1 

func (*DeploymentModel_Features) Descriptor() ([]byte, []int)

Deprecated: Use DeploymentModel_Features.ProtoReflect.Descriptor instead.

func (*DeploymentModel_Features) GetBackupUploads added in v0.88.4 

func (x *DeploymentModel_Features) GetBackupUploads() bool

func (*DeploymentModel_Features) GetMetricsEndpoint added in v0.88.4 

func (x *DeploymentModel_Features) GetMetricsEndpoint() bool

func (*DeploymentModel_Features) GetMlFreeTrial added in v0.88.1 

func (x *DeploymentModel_Features) GetMlFreeTrial() bool

func (*DeploymentModel_Features) GetPrivateEndpoints added in v0.88.4 

func (x *DeploymentModel_Features) GetPrivateEndpoints() bool

func (*DeploymentModel_Features) ProtoMessage added in v0.88.1 

func (*DeploymentModel_Features) ProtoMessage()

func (*DeploymentModel_Features) ProtoReflect added in v0.89.0 

func (x *DeploymentModel_Features) ProtoReflect() protoreflect.Message

func (*DeploymentModel_Features) Reset added in v0.88.1 

func (x *DeploymentModel_Features) Reset()

func (*DeploymentModel_Features) String added in v0.88.1 

func (x *DeploymentModel_Features) String() string

type DeploymentPrice 

type DeploymentPrice struct {

	// Price per hour in given currency for the deployment.
	PricePerHour float32 `protobuf:"fixed32,1,opt,name=price_per_hour,json=pricePerHour,proto3" json:"price_per_hour,omitempty"`
	// Network transfer prices (variable depending on usage)
	NetworkTransferPrices []*DeploymentPrice_NetworkTransferPrice `` /* 126-byte string literal not displayed */
	// Backup prices (variable depending on usage)
	BackupPrice *DeploymentPrice_BackupPrice `protobuf:"bytes,3,opt,name=backup_price,json=backupPrice,proto3" json:"backup_price,omitempty"`
	// Identifier of the currency in which the price is specified.
	CurrencyId string `protobuf:"bytes,4,opt,name=currency_id,json=currencyId,proto3" json:"currency_id,omitempty"`
	// AuditLog prices (variable depending on usage)
	AuditlogPrice *DeploymentPrice_AuditLogPrice `protobuf:"bytes,5,opt,name=auditlog_price,json=auditlogPrice,proto3" json:"auditlog_price,omitempty"`
	// contains filtered or unexported fields
}

func (*DeploymentPrice) Descriptor deprecated 

func (*DeploymentPrice) Descriptor() ([]byte, []int)

Deprecated: Use DeploymentPrice.ProtoReflect.Descriptor instead.

func (*DeploymentPrice) GetAuditlogPrice added in v0.61.1 

func (x *DeploymentPrice) GetAuditlogPrice() *DeploymentPrice_AuditLogPrice

func (*DeploymentPrice) GetBackupPrice 

func (x *DeploymentPrice) GetBackupPrice() *DeploymentPrice_BackupPrice

func (*DeploymentPrice) GetCurrencyId 

func (x *DeploymentPrice) GetCurrencyId() string

func (*DeploymentPrice) GetNetworkTransferPrices 

func (x *DeploymentPrice) GetNetworkTransferPrices() []*DeploymentPrice_NetworkTransferPrice

func (*DeploymentPrice) GetPricePerHour 

func (x *DeploymentPrice) GetPricePerHour() float32

func (*DeploymentPrice) ProtoMessage 

func (*DeploymentPrice) ProtoMessage()

func (*DeploymentPrice) ProtoReflect added in v0.89.0 

func (x *DeploymentPrice) ProtoReflect() protoreflect.Message

func (*DeploymentPrice) Reset 

func (x *DeploymentPrice) Reset()

func (*DeploymentPrice) String 

func (x *DeploymentPrice) String() string

type DeploymentPriceRequest 

type DeploymentPriceRequest struct {

	// Identifier of organization containing the deployment.
	OrganizationId string `protobuf:"bytes,1,opt,name=organization_id,json=organizationId,proto3" json:"organization_id,omitempty"`
	// Identifier of project containing the deployment.
	ProjectId string `protobuf:"bytes,2,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Identifier of the support plan of the deployment.
	SupportPlanId string `protobuf:"bytes,3,opt,name=support_plan_id,json=supportPlanId,proto3" json:"support_plan_id,omitempty"`
	// Identifier of the cloud provider of the deployment.
	CloudProviderId string `protobuf:"bytes,4,opt,name=cloud_provider_id,json=cloudProviderId,proto3" json:"cloud_provider_id,omitempty"`
	// Identifier of the cloud region of the deployment.
	CloudRegionId string `protobuf:"bytes,5,opt,name=cloud_region_id,json=cloudRegionId,proto3" json:"cloud_region_id,omitempty"`
	// Model of the deployment.
	Model string `protobuf:"bytes,6,opt,name=model,proto3" json:"model,omitempty"`
	// Node size use for deployments
	NodeSizeId string `protobuf:"bytes,7,opt,name=node_size_id,json=nodeSizeId,proto3" json:"node_size_id,omitempty"`
	// Number of nodes being used
	// This field is ignored if model is "flexible".
	NodeCount int32 `protobuf:"varint,8,opt,name=node_count,json=nodeCount,proto3" json:"node_count,omitempty"`
	// Amount of disk space per node (in GB)
	// This field is ignored if model is "flexible".
	NodeDiskSize int32 `protobuf:"varint,9,opt,name=node_disk_size,json=nodeDiskSize,proto3" json:"node_disk_size,omitempty"`
	// Number of coordinators of the deployment
	// This field is ignored unless model is "flexible".
	Coordinators int32 `protobuf:"varint,10,opt,name=coordinators,proto3" json:"coordinators,omitempty"`
	// Amount of memory (in GB) to allocate for each coordinator.
	// This field is ignored unless model is "flexible".
	CoordinatorMemorySize int32 `` /* 128-byte string literal not displayed */
	// Number of dbservers of the deployment
	// This field is ignored unless model is "flexible".
	Dbservers int32 `protobuf:"varint,12,opt,name=dbservers,proto3" json:"dbservers,omitempty"`
	// Amount of memory (in GB) to allocate for each dbserver.
	// This field is ignored unless model is "flexible".
	DbserverMemorySize int32 `protobuf:"varint,13,opt,name=dbserver_memory_size,json=dbserverMemorySize,proto3" json:"dbserver_memory_size,omitempty"`
	// Amount of disk space (in GB) to allocate for each dbserver.
	// This field is ignored unless model is "flexible".
	DbserverDiskSize int32 `protobuf:"varint,14,opt,name=dbserver_disk_size,json=dbserverDiskSize,proto3" json:"dbserver_disk_size,omitempty"`
	// Identifier of disk performance used for this deployment (if any).
	DiskPerformanceId string `protobuf:"bytes,15,opt,name=disk_performance_id,json=diskPerformanceId,proto3" json:"disk_performance_id,omitempty"`
	// If set, request for prices based on ArangoGraph credits.
	UseCreditPricing bool `protobuf:"varint,16,opt,name=use_credit_pricing,json=useCreditPricing,proto3" json:"use_credit_pricing,omitempty"`
	// contains filtered or unexported fields
}

Arguments for requesting a price a deployment of given properties.

func (*DeploymentPriceRequest) Descriptor deprecated 

func (*DeploymentPriceRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeploymentPriceRequest.ProtoReflect.Descriptor instead.

func (*DeploymentPriceRequest) GetCloudProviderId 

func (x *DeploymentPriceRequest) GetCloudProviderId() string

func (*DeploymentPriceRequest) GetCloudRegionId 

func (x *DeploymentPriceRequest) GetCloudRegionId() string

func (*DeploymentPriceRequest) GetCoordinatorMemorySize 

func (x *DeploymentPriceRequest) GetCoordinatorMemorySize() int32

func (*DeploymentPriceRequest) GetCoordinators 

func (x *DeploymentPriceRequest) GetCoordinators() int32

func (*DeploymentPriceRequest) GetDbserverDiskSize 

func (x *DeploymentPriceRequest) GetDbserverDiskSize() int32

func (*DeploymentPriceRequest) GetDbserverMemorySize 

func (x *DeploymentPriceRequest) GetDbserverMemorySize() int32

func (*DeploymentPriceRequest) GetDbservers 

func (x *DeploymentPriceRequest) GetDbservers() int32

func (*DeploymentPriceRequest) GetDiskPerformanceId added in v0.73.5 

func (x *DeploymentPriceRequest) GetDiskPerformanceId() string

func (*DeploymentPriceRequest) GetModel 

func (x *DeploymentPriceRequest) GetModel() string

func (*DeploymentPriceRequest) GetNodeCount 

func (x *DeploymentPriceRequest) GetNodeCount() int32

func (*DeploymentPriceRequest) GetNodeDiskSize 

func (x *DeploymentPriceRequest) GetNodeDiskSize() int32

func (*DeploymentPriceRequest) GetNodeSizeId 

func (x *DeploymentPriceRequest) GetNodeSizeId() string

func (*DeploymentPriceRequest) GetOrganizationId 

func (x *DeploymentPriceRequest) GetOrganizationId() string

func (*DeploymentPriceRequest) GetProjectId 

func (x *DeploymentPriceRequest) GetProjectId() string

func (*DeploymentPriceRequest) GetSupportPlanId 

func (x *DeploymentPriceRequest) GetSupportPlanId() string

func (*DeploymentPriceRequest) GetUseCreditPricing added in v0.83.2 

func (x *DeploymentPriceRequest) GetUseCreditPricing() bool

func (*DeploymentPriceRequest) ProtoMessage 

func (*DeploymentPriceRequest) ProtoMessage()

func (*DeploymentPriceRequest) ProtoReflect added in v0.89.0 

func (x *DeploymentPriceRequest) ProtoReflect() protoreflect.Message

func (*DeploymentPriceRequest) Reset 

func (x *DeploymentPriceRequest) Reset()

func (*DeploymentPriceRequest) String 

func (x *DeploymentPriceRequest) String() string

type DeploymentPrice_AuditLogPrice added in v0.61.1 

type DeploymentPrice_AuditLogPrice struct {

	// Price per GB/hour of audit logs in cloud storage (destination=cloud)
	PricePerGbPerHour float32 `protobuf:"fixed32,1,opt,name=price_per_gb_per_hour,json=pricePerGbPerHour,proto3" json:"price_per_gb_per_hour,omitempty"`
	// Price per 1.000 HTTPS Post invocations (destination=https-post)
	HttpsPostInvocationPricePer_1000 float32 `` /* 164-byte string literal not displayed */
	// Price per GB HTTPS Post body size (destination=https-post)
	HttpsPostBodySizePricePerGb float32 `` /* 154-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*DeploymentPrice_AuditLogPrice) Descriptor deprecated added in v0.61.1 

func (*DeploymentPrice_AuditLogPrice) Descriptor() ([]byte, []int)

Deprecated: Use DeploymentPrice_AuditLogPrice.ProtoReflect.Descriptor instead.

func (*DeploymentPrice_AuditLogPrice) GetHttpsPostBodySizePricePerGb added in v0.61.1 

func (x *DeploymentPrice_AuditLogPrice) GetHttpsPostBodySizePricePerGb() float32

func (*DeploymentPrice_AuditLogPrice) GetHttpsPostInvocationPricePer_1000 added in v0.61.1 

func (x *DeploymentPrice_AuditLogPrice) GetHttpsPostInvocationPricePer_1000() float32

func (*DeploymentPrice_AuditLogPrice) GetPricePerGbPerHour added in v0.61.1 

func (x *DeploymentPrice_AuditLogPrice) GetPricePerGbPerHour() float32

func (*DeploymentPrice_AuditLogPrice) ProtoMessage added in v0.61.1 

func (*DeploymentPrice_AuditLogPrice) ProtoMessage()

func (*DeploymentPrice_AuditLogPrice) ProtoReflect added in v0.89.0 

func (x *DeploymentPrice_AuditLogPrice) ProtoReflect() protoreflect.Message

func (*DeploymentPrice_AuditLogPrice) Reset added in v0.61.1 

func (x *DeploymentPrice_AuditLogPrice) Reset()

func (*DeploymentPrice_AuditLogPrice) String added in v0.61.1 

func (x *DeploymentPrice_AuditLogPrice) String() string

type DeploymentPrice_BackupPrice 

type DeploymentPrice_BackupPrice struct {

	// Price per GB/hour of uploaded backup storage
	PricePerGbPerHour float32 `protobuf:"fixed32,1,opt,name=price_per_gb_per_hour,json=pricePerGbPerHour,proto3" json:"price_per_gb_per_hour,omitempty"`
	// contains filtered or unexported fields
}

func (*DeploymentPrice_BackupPrice) Descriptor deprecated 

func (*DeploymentPrice_BackupPrice) Descriptor() ([]byte, []int)

Deprecated: Use DeploymentPrice_BackupPrice.ProtoReflect.Descriptor instead.

func (*DeploymentPrice_BackupPrice) GetPricePerGbPerHour 

func (x *DeploymentPrice_BackupPrice) GetPricePerGbPerHour() float32

func (*DeploymentPrice_BackupPrice) ProtoMessage 

func (*DeploymentPrice_BackupPrice) ProtoMessage()

func (*DeploymentPrice_BackupPrice) ProtoReflect added in v0.89.0 

func (x *DeploymentPrice_BackupPrice) ProtoReflect() protoreflect.Message

func (*DeploymentPrice_BackupPrice) Reset 

func (x *DeploymentPrice_BackupPrice) Reset()

func (*DeploymentPrice_BackupPrice) String 

func (x *DeploymentPrice_BackupPrice) String() string

type DeploymentPrice_NetworkTransferPrice 

type DeploymentPrice_NetworkTransferPrice struct {

	// Price per GB of network transfer into the database
	IngressPricePerGb float32 `protobuf:"fixed32,1,opt,name=ingress_price_per_gb,json=ingressPricePerGb,proto3" json:"ingress_price_per_gb,omitempty"`
	// Price per GB of network transfer out of the database
	EgressPricePerGb float32 `protobuf:"fixed32,2,opt,name=egress_price_per_gb,json=egressPricePerGb,proto3" json:"egress_price_per_gb,omitempty"`
	// Description of this price
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

func (*DeploymentPrice_NetworkTransferPrice) Descriptor deprecated 

func (*DeploymentPrice_NetworkTransferPrice) Descriptor() ([]byte, []int)

Deprecated: Use DeploymentPrice_NetworkTransferPrice.ProtoReflect.Descriptor instead.

func (*DeploymentPrice_NetworkTransferPrice) GetDescription 

func (x *DeploymentPrice_NetworkTransferPrice) GetDescription() string

func (*DeploymentPrice_NetworkTransferPrice) GetEgressPricePerGb 

func (x *DeploymentPrice_NetworkTransferPrice) GetEgressPricePerGb() float32

func (*DeploymentPrice_NetworkTransferPrice) GetIngressPricePerGb 

func (x *DeploymentPrice_NetworkTransferPrice) GetIngressPricePerGb() float32

func (*DeploymentPrice_NetworkTransferPrice) ProtoMessage 

func (*DeploymentPrice_NetworkTransferPrice) ProtoMessage()

func (*DeploymentPrice_NetworkTransferPrice) ProtoReflect added in v0.89.0 

func (x *DeploymentPrice_NetworkTransferPrice) ProtoReflect() protoreflect.Message

func (*DeploymentPrice_NetworkTransferPrice) Reset 

func (x *DeploymentPrice_NetworkTransferPrice) Reset()

func (*DeploymentPrice_NetworkTransferPrice) String 

func (x *DeploymentPrice_NetworkTransferPrice) String() string

type DeploymentSize 

type DeploymentSize struct {

	// Number of agents
	Agents int32 `protobuf:"varint,1,opt,name=agents,proto3" json:"agents,omitempty"`
	// Amount of memory (in GB) to allocate for each agent.
	AgentMemorySize int32 `protobuf:"varint,2,opt,name=agent_memory_size,json=agentMemorySize,proto3" json:"agent_memory_size,omitempty"`
	// Amount of disk space (in GB) to allocate for each agent.
	AgentDiskSize int32 `protobuf:"varint,3,opt,name=agent_disk_size,json=agentDiskSize,proto3" json:"agent_disk_size,omitempty"`
	// Total (combined) amount of memory (in GB) used by all servers (agents, coordinators & dbservers)
	TotalMemorySize int32 `protobuf:"varint,11,opt,name=total_memory_size,json=totalMemorySize,proto3" json:"total_memory_size,omitempty"`
	// Total (combined) amount of disk space (in GB) used by all servers (agents & dbservers)
	TotalDiskSize int32 `protobuf:"varint,12,opt,name=total_disk_size,json=totalDiskSize,proto3" json:"total_disk_size,omitempty"`
	// Number of coordinators
	Coordinators int32 `protobuf:"varint,21,opt,name=coordinators,proto3" json:"coordinators,omitempty"`
	// Amount of memory (in GB) to allocate for each coordinator.
	CoordinatorMemorySize int32 `` /* 128-byte string literal not displayed */
	// Number of dbservers
	Dbservers int32 `protobuf:"varint,31,opt,name=dbservers,proto3" json:"dbservers,omitempty"`
	// Amount of memory (in GB) to allocate for each dbserver.
	DbserverMemorySize int32 `protobuf:"varint,32,opt,name=dbserver_memory_size,json=dbserverMemorySize,proto3" json:"dbserver_memory_size,omitempty"`
	// Amount of disk space (in GB) to allocate for each dbserver.
	DbserverDiskSize int32 `protobuf:"varint,33,opt,name=dbserver_disk_size,json=dbserverDiskSize,proto3" json:"dbserver_disk_size,omitempty"`
	// contains filtered or unexported fields
}

Result of CalculateDeploymentSize

func (*DeploymentSize) Descriptor deprecated 

func (*DeploymentSize) Descriptor() ([]byte, []int)

Deprecated: Use DeploymentSize.ProtoReflect.Descriptor instead.

func (*DeploymentSize) GetAgentDiskSize 

func (x *DeploymentSize) GetAgentDiskSize() int32

func (*DeploymentSize) GetAgentMemorySize 

func (x *DeploymentSize) GetAgentMemorySize() int32

func (*DeploymentSize) GetAgents 

func (x *DeploymentSize) GetAgents() int32

func (*DeploymentSize) GetCoordinatorMemorySize added in v0.44.0 

func (x *DeploymentSize) GetCoordinatorMemorySize() int32

func (*DeploymentSize) GetCoordinators added in v0.44.0 

func (x *DeploymentSize) GetCoordinators() int32

func (*DeploymentSize) GetDbserverDiskSize added in v0.44.0 

func (x *DeploymentSize) GetDbserverDiskSize() int32

func (*DeploymentSize) GetDbserverMemorySize added in v0.44.0 

func (x *DeploymentSize) GetDbserverMemorySize() int32

func (*DeploymentSize) GetDbservers added in v0.44.0 

func (x *DeploymentSize) GetDbservers() int32

func (*DeploymentSize) GetTotalDiskSize 

func (x *DeploymentSize) GetTotalDiskSize() int32

func (*DeploymentSize) GetTotalMemorySize 

func (x *DeploymentSize) GetTotalMemorySize() int32

func (*DeploymentSize) ProtoMessage 

func (*DeploymentSize) ProtoMessage()

func (*DeploymentSize) ProtoReflect added in v0.89.0 

func (x *DeploymentSize) ProtoReflect() protoreflect.Message

func (*DeploymentSize) Reset 

func (x *DeploymentSize) Reset()

func (*DeploymentSize) String 

func (x *DeploymentSize) String() string

type DeploymentSizeRecommendation 

type DeploymentSizeRecommendation struct {

	// Request that resulted in this recommendation.
	Request *DeploymentSizeRequest `protobuf:"bytes,1,opt,name=request,proto3" json:"request,omitempty"`
	// Time when the recommendation was made.
	CreatedAt *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// Amount of memory space per node (in GB) being recommended
	NodeMemorySize int32 `protobuf:"varint,11,opt,name=node_memory_size,json=nodeMemorySize,proto3" json:"node_memory_size,omitempty"`
	// Amount of disk space per node (in GB) being recommended
	NodeDiskSize int32 `protobuf:"varint,12,opt,name=node_disk_size,json=nodeDiskSize,proto3" json:"node_disk_size,omitempty"`
	// Number of nodes being recommended
	NodeCount int32 `protobuf:"varint,13,opt,name=node_count,json=nodeCount,proto3" json:"node_count,omitempty"`
	// If set, this recommendation does not fit in
	// the callers quota.
	ExceedsQuota bool `protobuf:"varint,21,opt,name=exceeds_quota,json=exceedsQuota,proto3" json:"exceeds_quota,omitempty"`
	// If set, this recommendation does not fit in
	// the ArangoGraph Insights Platform.
	ExceedsPlatform bool `protobuf:"varint,22,opt,name=exceeds_platform,json=exceedsPlatform,proto3" json:"exceeds_platform,omitempty"`
	// contains filtered or unexported fields
}

Response of RecommendDeploymentSize.

func (*DeploymentSizeRecommendation) Descriptor deprecated 

func (*DeploymentSizeRecommendation) Descriptor() ([]byte, []int)

Deprecated: Use DeploymentSizeRecommendation.ProtoReflect.Descriptor instead.

func (*DeploymentSizeRecommendation) GetCreatedAt 

func (x *DeploymentSizeRecommendation) GetCreatedAt() *timestamppb.Timestamp

func (*DeploymentSizeRecommendation) GetExceedsPlatform 

func (x *DeploymentSizeRecommendation) GetExceedsPlatform() bool

func (*DeploymentSizeRecommendation) GetExceedsQuota 

func (x *DeploymentSizeRecommendation) GetExceedsQuota() bool

func (*DeploymentSizeRecommendation) GetNodeCount 

func (x *DeploymentSizeRecommendation) GetNodeCount() int32

func (*DeploymentSizeRecommendation) GetNodeDiskSize 

func (x *DeploymentSizeRecommendation) GetNodeDiskSize() int32

func (*DeploymentSizeRecommendation) GetNodeMemorySize 

func (x *DeploymentSizeRecommendation) GetNodeMemorySize() int32

func (*DeploymentSizeRecommendation) GetRequest 

func (x *DeploymentSizeRecommendation) GetRequest() *DeploymentSizeRequest

func (*DeploymentSizeRecommendation) ProtoMessage 

func (*DeploymentSizeRecommendation) ProtoMessage()

func (*DeploymentSizeRecommendation) ProtoReflect added in v0.89.0 

func (x *DeploymentSizeRecommendation) ProtoReflect() protoreflect.Message

func (*DeploymentSizeRecommendation) Reset 

func (x *DeploymentSizeRecommendation) Reset()

func (*DeploymentSizeRecommendation) String 

func (x *DeploymentSizeRecommendation) String() string

type DeploymentSizeRequest 

type DeploymentSizeRequest struct {

	// Size of entire dataset (on disk) in GB.
	// Required field.
	// Must be >= 1.
	DatasetSize int32 `protobuf:"varint,1,opt,name=dataset_size,json=datasetSize,proto3" json:"dataset_size,omitempty"`
	// Primary use case for the database
	// Possible values:
	// - GRAPH
	// - DOCUMENT
	// - MULTIMODEL
	// - KEYVALUE
	Usecase string `protobuf:"bytes,2,opt,name=usecase,proto3" json:"usecase,omitempty"`
	// Customer preferred model
	Model string `protobuf:"bytes,3,opt,name=model,proto3" json:"model,omitempty"`
	// File format on dataset
	// Possible values:
	// - JSON
	// - CSV
	FileFormat string `protobuf:"bytes,4,opt,name=file_format,json=fileFormat,proto3" json:"file_format,omitempty"`
	// Number of documents in the entire dataset (in case of JSON).
	// Number of rows in the entire dataset (in case of CSV).
	NumberOfDocuments int64 `protobuf:"varint,5,opt,name=number_of_documents,json=numberOfDocuments,proto3" json:"number_of_documents,omitempty"`
	// Largest number of columns of the dataset (in case of CSV).
	NumberOfColumns int32 `protobuf:"varint,6,opt,name=number_of_columns,json=numberOfColumns,proto3" json:"number_of_columns,omitempty"`
	// Percentage of dataset_size that is considered "hot"
	// Must be >= 0.0 and <= 1.0
	WorkingSetPercentage float32 `protobuf:"fixed32,7,opt,name=working_set_percentage,json=workingSetPercentage,proto3" json:"working_set_percentage,omitempty"`
	// Percentage of operations that are READ
	// Must be >= 0.0 and <= 1.0
	AccessReadPercentage float32 `protobuf:"fixed32,8,opt,name=access_read_percentage,json=accessReadPercentage,proto3" json:"access_read_percentage,omitempty"`
	// Percentage of operations that are CREATE
	// Must be >= 0.0 and <= 1.0
	AccessCreatePercentage float32 `` /* 131-byte string literal not displayed */
	// Percentage of operations that are UPDATE
	// Must be >= 0.0 and <= 1.0
	AccessUpdatePercentage float32 `` /* 132-byte string literal not displayed */
	// Increase factor of the dataset_size in 1 year.
	GrowthRate float32 `protobuf:"fixed32,11,opt,name=growth_rate,json=growthRate,proto3" json:"growth_rate,omitempty"`
	// Desired number of replicas.
	// Must be >= 3 and <= 5
	ReplicationFactor int32 `protobuf:"varint,12,opt,name=replication_factor,json=replicationFactor,proto3" json:"replication_factor,omitempty"`
	// Identifier of project to request a recommendation in
	ProjectId string `protobuf:"bytes,21,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Identifier of region to request a recommendation in
	RegionId string `protobuf:"bytes,22,opt,name=region_id,json=regionId,proto3" json:"region_id,omitempty"`
	// contains filtered or unexported fields
}

Request arguments for RecommendDeploymentSize.

func (*DeploymentSizeRequest) Descriptor deprecated 

func (*DeploymentSizeRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeploymentSizeRequest.ProtoReflect.Descriptor instead.

func (*DeploymentSizeRequest) GetAccessCreatePercentage 

func (x *DeploymentSizeRequest) GetAccessCreatePercentage() float32

func (*DeploymentSizeRequest) GetAccessReadPercentage 

func (x *DeploymentSizeRequest) GetAccessReadPercentage() float32

func (*DeploymentSizeRequest) GetAccessUpdatePercentage 

func (x *DeploymentSizeRequest) GetAccessUpdatePercentage() float32

func (*DeploymentSizeRequest) GetDatasetSize 

func (x *DeploymentSizeRequest) GetDatasetSize() int32

func (*DeploymentSizeRequest) GetFileFormat 

func (x *DeploymentSizeRequest) GetFileFormat() string

func (*DeploymentSizeRequest) GetGrowthRate 

func (x *DeploymentSizeRequest) GetGrowthRate() float32

func (*DeploymentSizeRequest) GetModel 

func (x *DeploymentSizeRequest) GetModel() string

func (*DeploymentSizeRequest) GetNumberOfColumns 

func (x *DeploymentSizeRequest) GetNumberOfColumns() int32

func (*DeploymentSizeRequest) GetNumberOfDocuments 

func (x *DeploymentSizeRequest) GetNumberOfDocuments() int64

func (*DeploymentSizeRequest) GetProjectId 

func (x *DeploymentSizeRequest) GetProjectId() string

func (*DeploymentSizeRequest) GetRegionId 

func (x *DeploymentSizeRequest) GetRegionId() string

func (*DeploymentSizeRequest) GetReplicationFactor 

func (x *DeploymentSizeRequest) GetReplicationFactor() int32

func (*DeploymentSizeRequest) GetUsecase 

func (x *DeploymentSizeRequest) GetUsecase() string

func (*DeploymentSizeRequest) GetWorkingSetPercentage 

func (x *DeploymentSizeRequest) GetWorkingSetPercentage() float32

func (*DeploymentSizeRequest) ProtoMessage 

func (*DeploymentSizeRequest) ProtoMessage()

func (*DeploymentSizeRequest) ProtoReflect added in v0.89.0 

func (x *DeploymentSizeRequest) ProtoReflect() protoreflect.Message

func (*DeploymentSizeRequest) Reset 

func (x *DeploymentSizeRequest) Reset()

func (*DeploymentSizeRequest) String 

func (x *DeploymentSizeRequest) String() string

type Deployment_BackupRestoreSpec 

type Deployment_BackupRestoreSpec struct {

	// The revision of this BackupRestoreSpec
	Revision int32 `protobuf:"varint,1,opt,name=revision,proto3" json:"revision,omitempty"`
	// The timestamp of when the last revision has been updated.
	LastUpdatedAt *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=last_updated_at,json=lastUpdatedAt,proto3" json:"last_updated_at,omitempty"`
	// Identifier of the user that restored this backup.
	// This is a read-only value.
	RestoredById string `protobuf:"bytes,3,opt,name=restored_by_id,json=restoredById,proto3" json:"restored_by_id,omitempty"`
	// Identifier of a backup to restore to.
	BackupId string `protobuf:"bytes,10,opt,name=backup_id,json=backupId,proto3" json:"backup_id,omitempty"`
	// contains filtered or unexported fields
}

Information about a backup restore. All members of this message are read-only.

func (*Deployment_BackupRestoreSpec) Descriptor deprecated 

func (*Deployment_BackupRestoreSpec) Descriptor() ([]byte, []int)

Deprecated: Use Deployment_BackupRestoreSpec.ProtoReflect.Descriptor instead.

func (*Deployment_BackupRestoreSpec) Equals 

func (source *Deployment_BackupRestoreSpec) Equals(other *Deployment_BackupRestoreSpec) bool

Equals returns true when source & other have the same values

func (*Deployment_BackupRestoreSpec) GetBackupId 

func (x *Deployment_BackupRestoreSpec) GetBackupId() string

func (*Deployment_BackupRestoreSpec) GetLastUpdatedAt 

func (x *Deployment_BackupRestoreSpec) GetLastUpdatedAt() *timestamppb.Timestamp

func (*Deployment_BackupRestoreSpec) GetRestoredById added in v0.79.22 

func (x *Deployment_BackupRestoreSpec) GetRestoredById() string

func (*Deployment_BackupRestoreSpec) GetRevision 

func (x *Deployment_BackupRestoreSpec) GetRevision() int32

func (*Deployment_BackupRestoreSpec) ProtoMessage 

func (*Deployment_BackupRestoreSpec) ProtoMessage()

func (*Deployment_BackupRestoreSpec) ProtoReflect added in v0.89.0 

func (x *Deployment_BackupRestoreSpec) ProtoReflect() protoreflect.Message

func (*Deployment_BackupRestoreSpec) Reset 

func (x *Deployment_BackupRestoreSpec) Reset()

func (*Deployment_BackupRestoreSpec) String 

func (x *Deployment_BackupRestoreSpec) String() string

type Deployment_BackupRestoreStatus 

type Deployment_BackupRestoreStatus struct {

	// The revision of the used BackupRestoreSpec
	Revision int32 `protobuf:"varint,1,opt,name=revision,proto3" json:"revision,omitempty"`
	// The timestamp of when the backup restore status was updated.
	LastUpdatedAt *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=last_updated_at,json=lastUpdatedAt,proto3" json:"last_updated_at,omitempty"`
	// Set if the deployment is preparing or restoring a backup
	Restoring bool `protobuf:"varint,10,opt,name=restoring,proto3" json:"restoring,omitempty"`
	// Status of the restore backup operation.
	// Enum of the following values: "<empty>|Preparing|Restoring|Restored|Failed"
	Status string `protobuf:"bytes,11,opt,name=status,proto3" json:"status,omitempty"`
	// Failure reason of the backup restore (if applicable)
	FailureReason string `protobuf:"bytes,12,opt,name=failure_reason,json=failureReason,proto3" json:"failure_reason,omitempty"`
	// contains filtered or unexported fields
}

The status of backup restore All members of this message are read-only.

func (*Deployment_BackupRestoreStatus) Descriptor deprecated 

func (*Deployment_BackupRestoreStatus) Descriptor() ([]byte, []int)

Deprecated: Use Deployment_BackupRestoreStatus.ProtoReflect.Descriptor instead.

func (*Deployment_BackupRestoreStatus) Equals 

func (source *Deployment_BackupRestoreStatus) Equals(other *Deployment_BackupRestoreStatus) bool

Equals returns true when source & other have the same values

func (*Deployment_BackupRestoreStatus) GetFailureReason 

func (x *Deployment_BackupRestoreStatus) GetFailureReason() string

func (*Deployment_BackupRestoreStatus) GetLastUpdatedAt added in v0.79.23 

func (x *Deployment_BackupRestoreStatus) GetLastUpdatedAt() *timestamppb.Timestamp

func (*Deployment_BackupRestoreStatus) GetRestoring 

func (x *Deployment_BackupRestoreStatus) GetRestoring() bool

func (*Deployment_BackupRestoreStatus) GetRevision 

func (x *Deployment_BackupRestoreStatus) GetRevision() int32

func (*Deployment_BackupRestoreStatus) GetStatus 

func (x *Deployment_BackupRestoreStatus) GetStatus() string

func (*Deployment_BackupRestoreStatus) ProtoMessage 

func (*Deployment_BackupRestoreStatus) ProtoMessage()

func (*Deployment_BackupRestoreStatus) ProtoReflect added in v0.89.0 

func (x *Deployment_BackupRestoreStatus) ProtoReflect() protoreflect.Message

func (*Deployment_BackupRestoreStatus) Reset 

func (x *Deployment_BackupRestoreStatus) Reset()

func (*Deployment_BackupRestoreStatus) String 

func (x *Deployment_BackupRestoreStatus) String() string

type Deployment_CertificateSpec 

type Deployment_CertificateSpec struct {

	// Identifier of the CACertificate used to sign TLS certificates for the deployment.
	// If you change this value after the creation of the deployment a complete
	// rotation of the deployment is required, which will result in some downtime.
	CaCertificateId string `protobuf:"bytes,1,opt,name=ca_certificate_id,json=caCertificateId,proto3" json:"ca_certificate_id,omitempty"`
	// Zero or more DNS names to include in the TLS certificate of the deployment.
	AlternateDnsNames []string `protobuf:"bytes,2,rep,name=alternate_dns_names,json=alternateDnsNames,proto3" json:"alternate_dns_names,omitempty"`
	// contains filtered or unexported fields
}

func (*Deployment_CertificateSpec) Descriptor deprecated 

func (*Deployment_CertificateSpec) Descriptor() ([]byte, []int)

Deprecated: Use Deployment_CertificateSpec.ProtoReflect.Descriptor instead.

func (*Deployment_CertificateSpec) Equals 

func (source *Deployment_CertificateSpec) Equals(other *Deployment_CertificateSpec) bool

Equals returns true when source & other have the same values

func (*Deployment_CertificateSpec) GetAlternateDnsNames 

func (x *Deployment_CertificateSpec) GetAlternateDnsNames() []string

func (*Deployment_CertificateSpec) GetCaCertificateId 

func (x *Deployment_CertificateSpec) GetCaCertificateId() string

func (*Deployment_CertificateSpec) ProtoMessage 

func (*Deployment_CertificateSpec) ProtoMessage()

func (*Deployment_CertificateSpec) ProtoReflect added in v0.89.0 

func (x *Deployment_CertificateSpec) ProtoReflect() protoreflect.Message

func (*Deployment_CertificateSpec) Reset 

func (x *Deployment_CertificateSpec) Reset()

func (*Deployment_CertificateSpec) String 

func (x *Deployment_CertificateSpec) String() string

type Deployment_DiskAutoSizeSettings added in v0.72.4 

type Deployment_DiskAutoSizeSettings struct {

	// Maximum allowed disk size that a node can reach (in GB).
	// [Deprecated] This setting isn't supported anymore.
	MaximumNodeDiskSize int32 `protobuf:"varint,1,opt,name=maximum_node_disk_size,json=maximumNodeDiskSize,proto3" json:"maximum_node_disk_size,omitempty"`
	// contains filtered or unexported fields
}

Deployment's disk autoscaling settings

func (*Deployment_DiskAutoSizeSettings) Clone added in v0.72.4 

func (src *Deployment_DiskAutoSizeSettings) Clone() *Deployment_DiskAutoSizeSettings

Clone creates a deep copy of Deployment_DiskAutoSizeSettings

func (*Deployment_DiskAutoSizeSettings) Descriptor deprecated added in v0.72.4 

func (*Deployment_DiskAutoSizeSettings) Descriptor() ([]byte, []int)

Deprecated: Use Deployment_DiskAutoSizeSettings.ProtoReflect.Descriptor instead.

func (*Deployment_DiskAutoSizeSettings) GetMaximumNodeDiskSize added in v0.72.4 

func (x *Deployment_DiskAutoSizeSettings) GetMaximumNodeDiskSize() int32

func (*Deployment_DiskAutoSizeSettings) ProtoMessage added in v0.72.4 

func (*Deployment_DiskAutoSizeSettings) ProtoMessage()

func (*Deployment_DiskAutoSizeSettings) ProtoReflect added in v0.89.0 

func (x *Deployment_DiskAutoSizeSettings) ProtoReflect() protoreflect.Message

func (*Deployment_DiskAutoSizeSettings) Reset added in v0.72.4 

func (x *Deployment_DiskAutoSizeSettings) Reset()

func (*Deployment_DiskAutoSizeSettings) String added in v0.72.4 

func (x *Deployment_DiskAutoSizeSettings) String() string

type Deployment_Expiration 

type Deployment_Expiration struct {

	// The expiration timestamp of the deployment
	// If not set, the deployment will not expire.
	ExpiresAt *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=expires_at,json=expiresAt,proto3" json:"expires_at,omitempty"`
	// Human readable reason for why the deployment expires (or does not expire).
	Reason string `protobuf:"bytes,2,opt,name=reason,proto3" json:"reason,omitempty"`
	// The timestamp of when the last "this deployment will expire at" email was
	// send.
	// If not set, no such email has been send.
	LastWarningEmailSendAt *timestamppb.Timestamp `` /* 133-byte string literal not displayed */
	// List of email addresses to which the last warning email has been send.
	// Not set when no such email has been send.
	LastWarningEmailSendTo []string `` /* 133-byte string literal not displayed */
	// contains filtered or unexported fields
}

Expiration of the deployment. All members of this message are read-only.

func (*Deployment_Expiration) Descriptor deprecated 

func (*Deployment_Expiration) Descriptor() ([]byte, []int)

Deprecated: Use Deployment_Expiration.ProtoReflect.Descriptor instead.

func (*Deployment_Expiration) GetExpiresAt 

func (x *Deployment_Expiration) GetExpiresAt() *timestamppb.Timestamp

func (*Deployment_Expiration) GetLastWarningEmailSendAt 

func (x *Deployment_Expiration) GetLastWarningEmailSendAt() *timestamppb.Timestamp

func (*Deployment_Expiration) GetLastWarningEmailSendTo 

func (x *Deployment_Expiration) GetLastWarningEmailSendTo() []string

func (*Deployment_Expiration) GetReason 

func (x *Deployment_Expiration) GetReason() string

func (*Deployment_Expiration) ProtoMessage 

func (*Deployment_Expiration) ProtoMessage()

func (*Deployment_Expiration) ProtoReflect added in v0.89.0 

func (x *Deployment_Expiration) ProtoReflect() protoreflect.Message

func (*Deployment_Expiration) Reset 

func (x *Deployment_Expiration) Reset()

func (*Deployment_Expiration) String 

func (x *Deployment_Expiration) String() string

type Deployment_ModelSpec 

type Deployment_ModelSpec struct {

	// Type of model being used
	Model string `protobuf:"bytes,1,opt,name=model,proto3" json:"model,omitempty"`
	// Size of nodes being used
	// This field is ignored set in case the flexible model is used.
	NodeSizeId string `protobuf:"bytes,2,opt,name=node_size_id,json=nodeSizeId,proto3" json:"node_size_id,omitempty"`
	// Number of nodes being used
	// This field is ignored set in case the flexible model is used.
	NodeCount int32 `protobuf:"varint,3,opt,name=node_count,json=nodeCount,proto3" json:"node_count,omitempty"`
	// Amount of disk space per node (in GB)
	// This field is ignored set in case the flexible model is used.
	NodeDiskSize int32 `protobuf:"varint,4,opt,name=node_disk_size,json=nodeDiskSize,proto3" json:"node_disk_size,omitempty"`
	// contains filtered or unexported fields
}

func (*Deployment_ModelSpec) Descriptor deprecated 

func (*Deployment_ModelSpec) Descriptor() ([]byte, []int)

Deprecated: Use Deployment_ModelSpec.ProtoReflect.Descriptor instead.

func (*Deployment_ModelSpec) Equals added in v0.69.2 

func (source *Deployment_ModelSpec) Equals(other *Deployment_ModelSpec) bool

Equals returns true when source and other have the same values

func (*Deployment_ModelSpec) GetModel 

func (x *Deployment_ModelSpec) GetModel() string

func (*Deployment_ModelSpec) GetNodeCount 

func (x *Deployment_ModelSpec) GetNodeCount() int32

func (*Deployment_ModelSpec) GetNodeDiskSize 

func (x *Deployment_ModelSpec) GetNodeDiskSize() int32

func (*Deployment_ModelSpec) GetNodeSizeId 

func (x *Deployment_ModelSpec) GetNodeSizeId() string

func (*Deployment_ModelSpec) IsSingleServer added in v0.81.5 

func (model *Deployment_ModelSpec) IsSingleServer() bool

IsSingleServer returns true if the model yields a single server deployment.

func (*Deployment_ModelSpec) ProtoMessage 

func (*Deployment_ModelSpec) ProtoMessage()

func (*Deployment_ModelSpec) ProtoReflect added in v0.89.0 

func (x *Deployment_ModelSpec) ProtoReflect() protoreflect.Message

func (*Deployment_ModelSpec) Reset 

func (x *Deployment_ModelSpec) Reset()

func (*Deployment_ModelSpec) String 

func (x *Deployment_ModelSpec) String() string

type Deployment_NotificationSettings added in v0.71.2 

type Deployment_NotificationSettings struct {

	// Email addresses that notifications related to this deployment should be sent to.
	EmailAddresses []string `protobuf:"bytes,1,rep,name=email_addresses,json=emailAddresses,proto3" json:"email_addresses,omitempty"`
	// contains filtered or unexported fields
}

Deployment's notification settings

func (*Deployment_NotificationSettings) Descriptor deprecated added in v0.71.2 

func (*Deployment_NotificationSettings) Descriptor() ([]byte, []int)

Deprecated: Use Deployment_NotificationSettings.ProtoReflect.Descriptor instead.

func (*Deployment_NotificationSettings) GetEmailAddresses added in v0.71.2 

func (x *Deployment_NotificationSettings) GetEmailAddresses() []string

func (*Deployment_NotificationSettings) ProtoMessage added in v0.71.2 

func (*Deployment_NotificationSettings) ProtoMessage()

func (*Deployment_NotificationSettings) ProtoReflect added in v0.89.0 

func (x *Deployment_NotificationSettings) ProtoReflect() protoreflect.Message

func (*Deployment_NotificationSettings) Reset added in v0.71.2 

func (x *Deployment_NotificationSettings) Reset()

func (*Deployment_NotificationSettings) String added in v0.71.2 

func (x *Deployment_NotificationSettings) String() string

type Deployment_ServerStatus 

type Deployment_ServerStatus struct {

	// ID of the server
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Type of server (agent|coordinator|dbserver)
	Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	// Human readable description of the status of the deployment.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// The creation timestamp of the server
	CreatedAt *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// Set once the server is ready
	Ready bool `protobuf:"varint,5,opt,name=ready,proto3" json:"ready,omitempty"`
	// Set once the server has been known to be a member of the cluster
	MemberOfCluster bool `protobuf:"varint,6,opt,name=member_of_cluster,json=memberOfCluster,proto3" json:"member_of_cluster,omitempty"`
	// Set if the server is in a failed state
	// Every server is always in 1 (and only 1) of these states: failed/creating/ok/bad/upgrading.
	Failed bool `protobuf:"varint,7,opt,name=failed,proto3" json:"failed,omitempty"`
	// Set if the server is still being created
	// Every server is always in 1 (and only 1) of these states: failed/creating/ok/bad/upgrading.
	Creating bool `protobuf:"varint,8,opt,name=creating,proto3" json:"creating,omitempty"`
	// Set if the server is in the ok state.
	// Every server is always in 1 (and only 1) of these states: failed/creating/ok/bad/upgrading.
	Ok bool `protobuf:"varint,9,opt,name=ok,proto3" json:"ok,omitempty"`
	// Set if the server is in the bad state.
	// Every server is always in 1 (and only 1) of these states: failed/creating/ok/bad/upgrading.
	Bad bool `protobuf:"varint,14,opt,name=bad,proto3" json:"bad,omitempty"`
	// Set if the server is still being upgraded
	// Every server is always in 1 (and only 1) of these states: failed/creating/ok/bad/upgrading.
	Upgrading bool `protobuf:"varint,10,opt,name=upgrading,proto3" json:"upgrading,omitempty"`
	// Latest known ArangoDB version used by this server.
	// Initially this field is empty.
	Version string `protobuf:"bytes,11,opt,name=version,proto3" json:"version,omitempty"`
	// The last started timestamp of the server
	LastStartedAt *timestamppb.Timestamp `protobuf:"bytes,12,opt,name=last_started_at,json=lastStartedAt,proto3" json:"last_started_at,omitempty"`
	// If set, a rotation of this server has been requested.
	RotationPending bool `protobuf:"varint,13,opt,name=rotation_pending,json=rotationPending,proto3" json:"rotation_pending,omitempty"`
	// If set, this server reports that it can be deleted.
	CanBeDeleted bool `protobuf:"varint,15,opt,name=can_be_deleted,json=canBeDeleted,proto3" json:"can_be_deleted,omitempty"`
	// If set, this server is leader in its type (currently applies only to agents).
	IsLeader bool `protobuf:"varint,16,opt,name=is_leader,json=isLeader,proto3" json:"is_leader,omitempty"`
	// Information about the data volume used to store the data
	DataVolumeInfo *DataVolumeInfo `protobuf:"bytes,20,opt,name=data_volume_info,json=dataVolumeInfo,proto3" json:"data_volume_info,omitempty"`
	// Recent number of restarts
	RecentRestarts int32 `protobuf:"varint,30,opt,name=recent_restarts,json=recentRestarts,proto3" json:"recent_restarts,omitempty"`
	// Last known memory usage in bytes
	LastMemoryUsage int64 `protobuf:"varint,31,opt,name=last_memory_usage,json=lastMemoryUsage,proto3" json:"last_memory_usage,omitempty"`
	// Last known CPU usage in vCPU units
	LastCpuUsage float32 `protobuf:"fixed32,32,opt,name=last_cpu_usage,json=lastCpuUsage,proto3" json:"last_cpu_usage,omitempty"`
	// Last known memory limit in bytes
	LastMemoryLimit int64 `protobuf:"varint,33,opt,name=last_memory_limit,json=lastMemoryLimit,proto3" json:"last_memory_limit,omitempty"`
	// Last known CPU limit in vCPU units
	LastCpuLimit float32 `protobuf:"fixed32,34,opt,name=last_cpu_limit,json=lastCpuLimit,proto3" json:"last_cpu_limit,omitempty"`
	// contains filtered or unexported fields
}

Status of a single server (of the ArangoDB cluster)

func (*Deployment_ServerStatus) Clone 

func (s *Deployment_ServerStatus) Clone() *Deployment_ServerStatus

Clone creates a deep clone of the given source

func (*Deployment_ServerStatus) Descriptor deprecated 

func (*Deployment_ServerStatus) Descriptor() ([]byte, []int)

Deprecated: Use Deployment_ServerStatus.ProtoReflect.Descriptor instead.

func (*Deployment_ServerStatus) GetBad added in v0.45.1 

func (x *Deployment_ServerStatus) GetBad() bool

func (*Deployment_ServerStatus) GetCanBeDeleted added in v0.45.1 

func (x *Deployment_ServerStatus) GetCanBeDeleted() bool

func (*Deployment_ServerStatus) GetCreatedAt 

func (x *Deployment_ServerStatus) GetCreatedAt() *timestamppb.Timestamp

func (*Deployment_ServerStatus) GetCreating 

func (x *Deployment_ServerStatus) GetCreating() bool

func (*Deployment_ServerStatus) GetDataVolumeInfo 

func (x *Deployment_ServerStatus) GetDataVolumeInfo() *DataVolumeInfo

func (*Deployment_ServerStatus) GetDescription 

func (x *Deployment_ServerStatus) GetDescription() string

func (*Deployment_ServerStatus) GetFailed 

func (x *Deployment_ServerStatus) GetFailed() bool

func (*Deployment_ServerStatus) GetId 

func (x *Deployment_ServerStatus) GetId() string

func (*Deployment_ServerStatus) GetIsLeader added in v0.48.2 

func (x *Deployment_ServerStatus) GetIsLeader() bool

func (*Deployment_ServerStatus) GetLastCpuLimit added in v0.64.3 

func (x *Deployment_ServerStatus) GetLastCpuLimit() float32

func (*Deployment_ServerStatus) GetLastCpuUsage added in v0.46.0 

func (x *Deployment_ServerStatus) GetLastCpuUsage() float32

func (*Deployment_ServerStatus) GetLastMemoryLimit added in v0.64.3 

func (x *Deployment_ServerStatus) GetLastMemoryLimit() int64

func (*Deployment_ServerStatus) GetLastMemoryUsage added in v0.46.0 

func (x *Deployment_ServerStatus) GetLastMemoryUsage() int64

func (*Deployment_ServerStatus) GetLastStartedAt added in v0.40.2 

func (x *Deployment_ServerStatus) GetLastStartedAt() *timestamppb.Timestamp

func (*Deployment_ServerStatus) GetMemberOfCluster 

func (x *Deployment_ServerStatus) GetMemberOfCluster() bool

func (*Deployment_ServerStatus) GetOk 

func (x *Deployment_ServerStatus) GetOk() bool

func (*Deployment_ServerStatus) GetReady 

func (x *Deployment_ServerStatus) GetReady() bool

func (*Deployment_ServerStatus) GetRecentRestarts added in v0.46.0 

func (x *Deployment_ServerStatus) GetRecentRestarts() int32

func (*Deployment_ServerStatus) GetRotationPending added in v0.43.12 

func (x *Deployment_ServerStatus) GetRotationPending() bool

func (*Deployment_ServerStatus) GetType 

func (x *Deployment_ServerStatus) GetType() string

func (*Deployment_ServerStatus) GetUpgrading 

func (x *Deployment_ServerStatus) GetUpgrading() bool

func (*Deployment_ServerStatus) GetVersion 

func (x *Deployment_ServerStatus) GetVersion() string

func (*Deployment_ServerStatus) ProtoMessage 

func (*Deployment_ServerStatus) ProtoMessage()

func (*Deployment_ServerStatus) ProtoReflect added in v0.89.0 

func (x *Deployment_ServerStatus) ProtoReflect() protoreflect.Message

func (*Deployment_ServerStatus) Reset 

func (x *Deployment_ServerStatus) Reset()

func (*Deployment_ServerStatus) String 

func (x *Deployment_ServerStatus) String() string

type Deployment_ServersSpec 

type Deployment_ServersSpec struct {

	// Number of coordinators of the deployment
	// This field is automatically set unless the flexible model is used.
	Coordinators int32 `protobuf:"varint,1,opt,name=coordinators,proto3" json:"coordinators,omitempty"`
	// Amount of memory (in GB) to allocate for coordinators.
	// This field is automatically set unless the flexible model is used.
	CoordinatorMemorySize int32 `` /* 127-byte string literal not displayed */
	// Custom command line arguments passed to all coordinators.
	// This field is ignored set unless the flexible model is used.
	CoordinatorArgs []string `protobuf:"bytes,3,rep,name=coordinator_args,json=coordinatorArgs,proto3" json:"coordinator_args,omitempty"`
	// Number of dbservers of the deployment
	// This field is automatically set unless the flexible model is used.
	Dbservers int32 `protobuf:"varint,11,opt,name=dbservers,proto3" json:"dbservers,omitempty"`
	// Amount of memory (in GB) to allocate for dbservers.
	// This field is automatically set unless the flexible model is used.
	DbserverMemorySize int32 `protobuf:"varint,12,opt,name=dbserver_memory_size,json=dbserverMemorySize,proto3" json:"dbserver_memory_size,omitempty"`
	// Amount of disk space (in GB) to allocate for dbservers.
	// This field is automatically set unless the flexible model is used.
	DbserverDiskSize int32 `protobuf:"varint,13,opt,name=dbserver_disk_size,json=dbserverDiskSize,proto3" json:"dbserver_disk_size,omitempty"`
	// Custom command line arguments passed to all dbservers.
	// This field is ignored set unless the flexible model is used.
	DbserverArgs []string `protobuf:"bytes,14,rep,name=dbserver_args,json=dbserverArgs,proto3" json:"dbserver_args,omitempty"`
	// The minimum number of dbservers based on the highest replication factor
	// defined by all databases and all collections.
	MinimumDbserversCount int32 `` /* 128-byte string literal not displayed */
	// The minimum amount of disk space (in GB) to allocate for dbservers based on the highest usage of all running DB servers.
	// The nearest size (larger then indicated here) need to be depected if the provider doesn't support all values (See GetServersSpecLimits)
	MinimumDbserverDiskSize int32 `` /* 136-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*Deployment_ServersSpec) Descriptor deprecated 

func (*Deployment_ServersSpec) Descriptor() ([]byte, []int)

Deprecated: Use Deployment_ServersSpec.ProtoReflect.Descriptor instead.

func (*Deployment_ServersSpec) Equals 

func (source *Deployment_ServersSpec) Equals(other *Deployment_ServersSpec) bool

Equals returns true when source & other have the same values

func (*Deployment_ServersSpec) GetCoordinatorArgs 

func (x *Deployment_ServersSpec) GetCoordinatorArgs() []string

func (*Deployment_ServersSpec) GetCoordinatorMemorySize 

func (x *Deployment_ServersSpec) GetCoordinatorMemorySize() int32

func (*Deployment_ServersSpec) GetCoordinators 

func (x *Deployment_ServersSpec) GetCoordinators() int32

func (*Deployment_ServersSpec) GetDbserverArgs 

func (x *Deployment_ServersSpec) GetDbserverArgs() []string

func (*Deployment_ServersSpec) GetDbserverDiskSize 

func (x *Deployment_ServersSpec) GetDbserverDiskSize() int32

func (*Deployment_ServersSpec) GetDbserverMemorySize 

func (x *Deployment_ServersSpec) GetDbserverMemorySize() int32

func (*Deployment_ServersSpec) GetDbservers 

func (x *Deployment_ServersSpec) GetDbservers() int32

func (*Deployment_ServersSpec) GetMinimumDbserverDiskSize added in v0.82.2 

func (x *Deployment_ServersSpec) GetMinimumDbserverDiskSize() int32

func (*Deployment_ServersSpec) GetMinimumDbserversCount added in v0.43.2 

func (x *Deployment_ServersSpec) GetMinimumDbserversCount() int32

func (*Deployment_ServersSpec) ProtoMessage 

func (*Deployment_ServersSpec) ProtoMessage()

func (*Deployment_ServersSpec) ProtoReflect added in v0.89.0 

func (x *Deployment_ServersSpec) ProtoReflect() protoreflect.Message

func (*Deployment_ServersSpec) Reset 

func (x *Deployment_ServersSpec) Reset()

func (*Deployment_ServersSpec) String 

func (x *Deployment_ServersSpec) String() string

type Deployment_Status 

type Deployment_Status struct {

	// Endpoint URL used to reach the deployment
	// This value will be empty during the creation of the deployment.
	// This field always contains the URL of the low port (8529) of the
	// deployment.
	// If a certificate with well known certificate is used, this
	// port is using the well known certificate.
	// Otherwise this port is using the self-signed certificate.
	Endpoint string `protobuf:"bytes,1,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
	// Human readable description of the status of the deployment.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// Set once the deployment has been created.
	Created bool `protobuf:"varint,3,opt,name=created,proto3" json:"created,omitempty"`
	// Set if the deployment is ready to be used.
	// If the deployment has downtime (e.g. because of changing a CA certificate)
	// this will go to false until the downtime is over.
	Ready bool `protobuf:"varint,4,opt,name=ready,proto3" json:"ready,omitempty"`
	// Set if the deployment is being upgraded.
	Upgrading bool `protobuf:"varint,5,opt,name=upgrading,proto3" json:"upgrading,omitempty"`
	// Versions of running servers
	ServerVersions []string `protobuf:"bytes,6,rep,name=server_versions,json=serverVersions,proto3" json:"server_versions,omitempty"`
	// Status of individual servers of the deployment
	Servers []*Deployment_ServerStatus `protobuf:"bytes,7,rep,name=servers,proto3" json:"servers,omitempty"`
	// Set if the ready boolean is transitioned to true for the very first time.
	BootstrappedAt *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=bootstrapped_at,json=bootstrappedAt,proto3" json:"bootstrapped_at,omitempty"`
	// Set if bootstrapped_at has a value, otherwise false.
	Bootstrapped bool `protobuf:"varint,9,opt,name=bootstrapped,proto3" json:"bootstrapped,omitempty"`
	// Endpoint URL used to reach the deployment on the port that uses
	// the self-signed certificate.
	// This endpoint is recommended for machine-to-database connections.
	EndpointSelfSigned string `protobuf:"bytes,10,opt,name=endpoint_self_signed,json=endpointSelfSigned,proto3" json:"endpoint_self_signed,omitempty"`
	// Endpoint URL used to reach the deployment on default port (443)
	// This value will be empty during the creation of the deployment.
	// If a certificate with well known certificate is used, this
	// port is using the well known certificate.
	// Otherwise this port is using the self-signed certificate.
	// This endpoint is recommended for human-to-database connections.
	EndpointDefault string `protobuf:"bytes,11,opt,name=endpoint_default,json=endpointDefault,proto3" json:"endpoint_default,omitempty"`
	// If set, this deployment has a private endpoint, however can contain the public endpoint as well.
	// When switching from a public endpoint to a private endpoint the public endpoint will
	// be available for an hour to support seemlessly migration to the private endpoint.
	PrivateEndpoint bool `protobuf:"varint,20,opt,name=private_endpoint,json=privateEndpoint,proto3" json:"private_endpoint,omitempty"`
	// If set, this deployment has a private endpoint only.
	// When switching from a public endpoint to a private endpoint the public endpoint will
	// be available for an hour to support seemlessly migration to the private endpoint.
	PrivateEndpointOnly bool `protobuf:"varint,21,opt,name=private_endpoint_only,json=privateEndpointOnly,proto3" json:"private_endpoint_only,omitempty"`
	// Endpoint URL used to reach the deployment which is configured as a private endpoint.
	// This field always contains the URL of the low port (8529) of the
	// deployment.
	// If a certificate with well known certificate is used, this
	// port is using the well known certificate, note that the alternate DNS names are not part of this certificate.
	// Otherwise this port is using the self-signed certificate.
	// This endpoint is recommended for human-to-database connections.
	// If no private endpoint is configured this field will be empty.
	EndpointPrivateEndpoint string `` /* 133-byte string literal not displayed */
	// Endpoint URL used to reach the deployment on the port that uses
	// the self-signed certificate.
	// This certificate will contain the specified alternate DNS names as well,
	// so a secure TLS connection can be establised.
	// This endpoint is recommended for machine-to-database connections.
	// If no private endpoint is configured this field will be empty.
	EndpointPrivateEndpointSelfSigned string `` /* 167-byte string literal not displayed */
	// Private Endpoint URL used to reach the deployment on default port (443)
	// This value will be empty during the creation of the deployment & private endpoint.
	// this port is using the well known certificate.
	EndpointPrivateEndpointDefault string `` /* 156-byte string literal not displayed */
	// The status of backup restore (if applicable).
	// This field will be set to empty if a new revision of the spec is available
	BackupRestoreStatus *Deployment_BackupRestoreStatus `protobuf:"bytes,100,opt,name=backup_restore_status,json=backupRestoreStatus,proto3" json:"backup_restore_status,omitempty"`
	// The total size of all backups in the external source (in bytes)
	TotalBackupSizeBytes int64 `` /* 128-byte string literal not displayed */
	// Set if there is any backup currently uploading data to the external source
	BackupUploadInProgress bool `` /* 134-byte string literal not displayed */
	// Set if the deployment is up-to-date and has no pending updates.
	IsUpToDate bool `protobuf:"varint,103,opt,name=is_up_to_date,json=isUpToDate,proto3" json:"is_up_to_date,omitempty"`
	// Set if the deployment is in read-only mode.
	ReadOnly bool `protobuf:"varint,104,opt,name=read_only,json=readOnly,proto3" json:"read_only,omitempty"`
	// contains filtered or unexported fields
}

Status of the deployment All members of this field are read-only.

func (*Deployment_Status) Clone 

func (s *Deployment_Status) Clone() *Deployment_Status

Clone creates a deep clone of the given source

func (*Deployment_Status) Descriptor deprecated 

func (*Deployment_Status) Descriptor() ([]byte, []int)

Deprecated: Use Deployment_Status.ProtoReflect.Descriptor instead.

func (*Deployment_Status) GetBackupRestoreStatus 

func (x *Deployment_Status) GetBackupRestoreStatus() *Deployment_BackupRestoreStatus

func (*Deployment_Status) GetBackupUploadInProgress 

func (x *Deployment_Status) GetBackupUploadInProgress() bool

func (*Deployment_Status) GetBootstrapped 

func (x *Deployment_Status) GetBootstrapped() bool

func (*Deployment_Status) GetBootstrappedAt 

func (x *Deployment_Status) GetBootstrappedAt() *timestamppb.Timestamp

func (*Deployment_Status) GetCreated 

func (x *Deployment_Status) GetCreated() bool

func (*Deployment_Status) GetDescription 

func (x *Deployment_Status) GetDescription() string

func (*Deployment_Status) GetEndpoint 

func (x *Deployment_Status) GetEndpoint() string

func (*Deployment_Status) GetEndpointDefault added in v0.81.2 

func (x *Deployment_Status) GetEndpointDefault() string

func (*Deployment_Status) GetEndpointPrivateEndpoint added in v0.74.12 

func (x *Deployment_Status) GetEndpointPrivateEndpoint() string

func (*Deployment_Status) GetEndpointPrivateEndpointDefault added in v0.82.3 

func (x *Deployment_Status) GetEndpointPrivateEndpointDefault() string

func (*Deployment_Status) GetEndpointPrivateEndpointSelfSigned added in v0.74.12 

func (x *Deployment_Status) GetEndpointPrivateEndpointSelfSigned() string

func (*Deployment_Status) GetEndpointSelfSigned 

func (x *Deployment_Status) GetEndpointSelfSigned() string

func (*Deployment_Status) GetIsUpToDate added in v0.73.7 

func (x *Deployment_Status) GetIsUpToDate() bool

func (*Deployment_Status) GetPrivateEndpoint added in v0.74.12 

func (x *Deployment_Status) GetPrivateEndpoint() bool

func (*Deployment_Status) GetPrivateEndpointOnly added in v0.74.12 

func (x *Deployment_Status) GetPrivateEndpointOnly() bool

func (*Deployment_Status) GetReadOnly added in v0.84.2 

func (x *Deployment_Status) GetReadOnly() bool

func (*Deployment_Status) GetReady 

func (x *Deployment_Status) GetReady() bool

func (*Deployment_Status) GetServerVersions 

func (x *Deployment_Status) GetServerVersions() []string

func (*Deployment_Status) GetServers 

func (x *Deployment_Status) GetServers() []*Deployment_ServerStatus

func (*Deployment_Status) GetTotalBackupSizeBytes 

func (x *Deployment_Status) GetTotalBackupSizeBytes() int64

func (*Deployment_Status) GetUpgrading 

func (x *Deployment_Status) GetUpgrading() bool

func (*Deployment_Status) ProtoMessage 

func (*Deployment_Status) ProtoMessage()

func (*Deployment_Status) ProtoReflect added in v0.89.0 

func (x *Deployment_Status) ProtoReflect() protoreflect.Message

func (*Deployment_Status) Reset 

func (x *Deployment_Status) Reset()

func (*Deployment_Status) String 

func (x *Deployment_Status) String() string

type DiskPerformance added in v0.73.0 

type DiskPerformance struct {

	// System identifier of the disk-performance.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Name of the disk-performance.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Description of the disk-performance.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// If set, this is the default disk performance (inside the requested region).
	IsDefault bool `protobuf:"varint,4,opt,name=is_default,json=isDefault,proto3" json:"is_default,omitempty"`
	// contains filtered or unexported fields
}

DiskPerformance provides information on a specific disk performance option. All fields in this message are read-only values.

func (*DiskPerformance) Descriptor deprecated added in v0.73.0 

func (*DiskPerformance) Descriptor() ([]byte, []int)

Deprecated: Use DiskPerformance.ProtoReflect.Descriptor instead.

func (*DiskPerformance) GetDescription added in v0.73.0 

func (x *DiskPerformance) GetDescription() string

func (*DiskPerformance) GetId added in v0.73.0 

func (x *DiskPerformance) GetId() string

func (*DiskPerformance) GetIsDefault added in v0.73.0 

func (x *DiskPerformance) GetIsDefault() bool

func (*DiskPerformance) GetName added in v0.73.0 

func (x *DiskPerformance) GetName() string

func (*DiskPerformance) ProtoMessage added in v0.73.0 

func (*DiskPerformance) ProtoMessage()

func (*DiskPerformance) ProtoReflect added in v0.89.0 

func (x *DiskPerformance) ProtoReflect() protoreflect.Message

func (*DiskPerformance) Reset added in v0.73.0 

func (x *DiskPerformance) Reset()

func (*DiskPerformance) String added in v0.73.0 

func (x *DiskPerformance) String() string

type DiskPerformanceList added in v0.73.0 

type DiskPerformanceList struct {
	Items []*DiskPerformance `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	// contains filtered or unexported fields
}

List of DiskPerformances.

func (*DiskPerformanceList) Descriptor deprecated added in v0.73.0 

func (*DiskPerformanceList) Descriptor() ([]byte, []int)

Deprecated: Use DiskPerformanceList.ProtoReflect.Descriptor instead.

func (*DiskPerformanceList) GetItems added in v0.73.0 

func (x *DiskPerformanceList) GetItems() []*DiskPerformance

func (*DiskPerformanceList) ProtoMessage added in v0.73.0 

func (*DiskPerformanceList) ProtoMessage()

func (*DiskPerformanceList) ProtoReflect added in v0.89.0 

func (x *DiskPerformanceList) ProtoReflect() protoreflect.Message

func (*DiskPerformanceList) Reset added in v0.73.0 

func (x *DiskPerformanceList) Reset()

func (*DiskPerformanceList) String added in v0.73.0 

func (x *DiskPerformanceList) String() string

type GetDiskPerformanceRequest added in v0.73.0 

type GetDiskPerformanceRequest struct {

	// disk performance identifier (e.g. 'DP30')
	DiskPerformanceId string `protobuf:"bytes,1,opt,name=disk_performance_id,json=diskPerformanceId,proto3" json:"disk_performance_id,omitempty"`
	// Identifier of the region (e.g. 'aks-westeurope').
	RegionId string `protobuf:"bytes,2,opt,name=region_id,json=regionId,proto3" json:"region_id,omitempty"`
	// contains filtered or unexported fields
}

GetDiskPerformanceRequest is used as request in GetDiskPerformance

func (*GetDiskPerformanceRequest) Descriptor deprecated added in v0.73.0 

func (*GetDiskPerformanceRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetDiskPerformanceRequest.ProtoReflect.Descriptor instead.

func (*GetDiskPerformanceRequest) GetDiskPerformanceId added in v0.73.0 

func (x *GetDiskPerformanceRequest) GetDiskPerformanceId() string

func (*GetDiskPerformanceRequest) GetRegionId added in v0.73.0 

func (x *GetDiskPerformanceRequest) GetRegionId() string

func (*GetDiskPerformanceRequest) ProtoMessage added in v0.73.0 

func (*GetDiskPerformanceRequest) ProtoMessage()

func (*GetDiskPerformanceRequest) ProtoReflect added in v0.89.0 

func (x *GetDiskPerformanceRequest) ProtoReflect() protoreflect.Message

func (*GetDiskPerformanceRequest) Reset added in v0.73.0 

func (x *GetDiskPerformanceRequest) Reset()

func (*GetDiskPerformanceRequest) String added in v0.73.0 

func (x *GetDiskPerformanceRequest) String() string

type ImportDataInstructions 

type ImportDataInstructions struct {

	// Lines of code to run arangorestore
	ImportDump []string `protobuf:"bytes,2,rep,name=import_dump,json=importDump,proto3" json:"import_dump,omitempty"`
	// Lines of code to run arangoimport with json file format
	ArangoImportJson []string `protobuf:"bytes,3,rep,name=arango_import_json,json=arangoImportJson,proto3" json:"arango_import_json,omitempty"`
	// Lines of code to run arangoimport with csv file format
	ArangoImportCsv []string `protobuf:"bytes,4,rep,name=arango_import_csv,json=arangoImportCsv,proto3" json:"arango_import_csv,omitempty"`
	// Lines of code to run arangoimport with tsv file format
	ArangoImportTsv []string `protobuf:"bytes,5,rep,name=arango_import_tsv,json=arangoImportTsv,proto3" json:"arango_import_tsv,omitempty"`
	// contains filtered or unexported fields
}

Instructions for importing data into a deployment

func (*ImportDataInstructions) Descriptor deprecated 

func (*ImportDataInstructions) Descriptor() ([]byte, []int)

Deprecated: Use ImportDataInstructions.ProtoReflect.Descriptor instead.

func (*ImportDataInstructions) GetArangoImportCsv added in v0.41.4 

func (x *ImportDataInstructions) GetArangoImportCsv() []string

func (*ImportDataInstructions) GetArangoImportJson added in v0.41.4 

func (x *ImportDataInstructions) GetArangoImportJson() []string

func (*ImportDataInstructions) GetArangoImportTsv added in v0.41.4 

func (x *ImportDataInstructions) GetArangoImportTsv() []string

func (*ImportDataInstructions) GetImportDump 

func (x *ImportDataInstructions) GetImportDump() []string

func (*ImportDataInstructions) ProtoMessage 

func (*ImportDataInstructions) ProtoMessage()

func (*ImportDataInstructions) ProtoReflect added in v0.89.0 

func (x *ImportDataInstructions) ProtoReflect() protoreflect.Message

func (*ImportDataInstructions) Reset 

func (x *ImportDataInstructions) Reset()

func (*ImportDataInstructions) String 

func (x *ImportDataInstructions) String() string

type ListCPUSizesRequest 

type ListCPUSizesRequest struct {

	// Identifier of project that will own a deployment.
	ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Optional identifier of a deployment for which CPU sizes are requested.
	// If specified, only those CPU sizes are listed, that an existing deployment is allowed to have.
	// If specified, project_id field is ignored, and instead read from the deployment.
	DeploymentId string `protobuf:"bytes,2,opt,name=deployment_id,json=deploymentId,proto3" json:"deployment_id,omitempty"`
	// contains filtered or unexported fields
}

Request arguments for ListCPUSizes

func (*ListCPUSizesRequest) Descriptor deprecated 

func (*ListCPUSizesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListCPUSizesRequest.ProtoReflect.Descriptor instead.

func (*ListCPUSizesRequest) GetDeploymentId added in v0.79.25 

func (x *ListCPUSizesRequest) GetDeploymentId() string

func (*ListCPUSizesRequest) GetProjectId 

func (x *ListCPUSizesRequest) GetProjectId() string

func (*ListCPUSizesRequest) ProtoMessage 

func (*ListCPUSizesRequest) ProtoMessage()

func (*ListCPUSizesRequest) ProtoReflect added in v0.89.0 

func (x *ListCPUSizesRequest) ProtoReflect() protoreflect.Message

func (*ListCPUSizesRequest) Reset 

func (x *ListCPUSizesRequest) Reset()

func (*ListCPUSizesRequest) String 

func (x *ListCPUSizesRequest) String() string

type ListDeploymentModelsRequest 

type ListDeploymentModelsRequest struct {

	// Identifier of project that will own a deployment.
	ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Optional identifier of a deployment, so the current model can be added to the list if needed
	// This deployment should be inside the provided project
	DeploymentId string `protobuf:"bytes,2,opt,name=deployment_id,json=deploymentId,proto3" json:"deployment_id,omitempty"`
	// contains filtered or unexported fields
}

Request arguments for ListDeploymentModels

func (*ListDeploymentModelsRequest) Descriptor deprecated 

func (*ListDeploymentModelsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListDeploymentModelsRequest.ProtoReflect.Descriptor instead.

func (*ListDeploymentModelsRequest) GetDeploymentId added in v0.88.8 

func (x *ListDeploymentModelsRequest) GetDeploymentId() string

func (*ListDeploymentModelsRequest) GetProjectId 

func (x *ListDeploymentModelsRequest) GetProjectId() string

func (*ListDeploymentModelsRequest) ProtoMessage 

func (*ListDeploymentModelsRequest) ProtoMessage()

func (*ListDeploymentModelsRequest) ProtoReflect added in v0.89.0 

func (x *ListDeploymentModelsRequest) ProtoReflect() protoreflect.Message

func (*ListDeploymentModelsRequest) Reset 

func (x *ListDeploymentModelsRequest) Reset()

func (*ListDeploymentModelsRequest) String 

func (x *ListDeploymentModelsRequest) String() string

type ListDeploymentsByFilterRequest added in v0.77.10 

type ListDeploymentsByFilterRequest struct {

	// Identifier of the organization to request the deployments for.
	OrganizationId string `protobuf:"bytes,1,opt,name=organization_id,json=organizationId,proto3" json:"organization_id,omitempty"`
	// Return only deployments created in this project.
	// This is an optional field.
	ProjectId string `protobuf:"bytes,2,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Return only deployments created in this region.
	// This is an optional field.
	RegionId string `protobuf:"bytes,3,opt,name=region_id,json=regionId,proto3" json:"region_id,omitempty"`
	// Return only deployments with an expiration date after this timestamp.
	// This will exclude deployments that have no expiration date.
	// This is an optional field.
	ExpiresAfter *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=expires_after,json=expiresAfter,proto3" json:"expires_after,omitempty"`
	// Return only deployments with an expiration date before this timestamp.
	// This will exclude deployments that have no expiration date.
	// This is an optional field.
	ExpiresBefore *timestamppb.Timestamp `protobuf:"bytes,11,opt,name=expires_before,json=expiresBefore,proto3" json:"expires_before,omitempty"`
	// Return only deployments that do not expire.
	DoesNotExpire bool `protobuf:"varint,12,opt,name=does_not_expire,json=doesNotExpire,proto3" json:"does_not_expire,omitempty"`
	// Optional common list options, the context_id is ignored
	Options *v1.ListOptions `protobuf:"bytes,100,opt,name=options,proto3" json:"options,omitempty"`
	// contains filtered or unexported fields
}

Request arguments for ListDeploymentsByFilter.

func (*ListDeploymentsByFilterRequest) Descriptor deprecated added in v0.77.10 

func (*ListDeploymentsByFilterRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListDeploymentsByFilterRequest.ProtoReflect.Descriptor instead.

func (*ListDeploymentsByFilterRequest) GetDoesNotExpire added in v0.77.10 

func (x *ListDeploymentsByFilterRequest) GetDoesNotExpire() bool

func (*ListDeploymentsByFilterRequest) GetExpiresAfter added in v0.77.10 

func (x *ListDeploymentsByFilterRequest) GetExpiresAfter() *timestamppb.Timestamp

func (*ListDeploymentsByFilterRequest) GetExpiresBefore added in v0.77.10 

func (x *ListDeploymentsByFilterRequest) GetExpiresBefore() *timestamppb.Timestamp

func (*ListDeploymentsByFilterRequest) GetOptions added in v0.77.10 

func (x *ListDeploymentsByFilterRequest) GetOptions() *v1.ListOptions

func (*ListDeploymentsByFilterRequest) GetOrganizationId added in v0.77.10 

func (x *ListDeploymentsByFilterRequest) GetOrganizationId() string

func (*ListDeploymentsByFilterRequest) GetProjectId added in v0.77.10 

func (x *ListDeploymentsByFilterRequest) GetProjectId() string

func (*ListDeploymentsByFilterRequest) GetRegionId added in v0.77.10 

func (x *ListDeploymentsByFilterRequest) GetRegionId() string

func (*ListDeploymentsByFilterRequest) ProtoMessage added in v0.77.10 

func (*ListDeploymentsByFilterRequest) ProtoMessage()

func (*ListDeploymentsByFilterRequest) ProtoReflect added in v0.89.0 

func (x *ListDeploymentsByFilterRequest) ProtoReflect() protoreflect.Message

func (*ListDeploymentsByFilterRequest) Reset added in v0.77.10 

func (x *ListDeploymentsByFilterRequest) Reset()

func (*ListDeploymentsByFilterRequest) String added in v0.77.10 

func (x *ListDeploymentsByFilterRequest) String() string

type ListDiskPerformancesRequest added in v0.73.0 

type ListDiskPerformancesRequest struct {

	// Identifier of the region (e.g. 'aks-westeurope').
	// This field is ignored when a deployment_id is provided, otherwise required.
	RegionId string `protobuf:"bytes,1,opt,name=region_id,json=regionId,proto3" json:"region_id,omitempty"`
	// Identifier of the node size (e.g. 'A16').
	// This field is ignored when a deployment_id is provided, otherwise required.
	NodeSizeId string `protobuf:"bytes,2,opt,name=node_size_id,json=nodeSizeId,proto3" json:"node_size_id,omitempty"`
	// Amount of disk space (in GB) to allocate for each dbserver.
	// This field is ignored when a deployment_id is provided, otherwise required.
	DbserverDiskSize int32 `protobuf:"varint,3,opt,name=dbserver_disk_size,json=dbserverDiskSize,proto3" json:"dbserver_disk_size,omitempty"`
	// Optional identifier of the organization for which the disk performances need to be listed.
	// If specified, only those disk performances are listed that the organization is allowed to use
	// for a deployment of a given node_size_id.
	// This field is ignored when a deployment_id is provided.
	OrganizationId string `protobuf:"bytes,4,opt,name=organization_id,json=organizationId,proto3" json:"organization_id,omitempty"`
	// Identifier of the deloyment, used to fill-out the region, node-size and disk-size.
	DeploymentId string `protobuf:"bytes,10,opt,name=deployment_id,json=deploymentId,proto3" json:"deployment_id,omitempty"`
	// contains filtered or unexported fields
}

ListDiskPerformancesRequest is used as request in ListAllDiskPerformances

func (*ListDiskPerformancesRequest) Descriptor deprecated added in v0.73.0 

func (*ListDiskPerformancesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListDiskPerformancesRequest.ProtoReflect.Descriptor instead.

func (*ListDiskPerformancesRequest) GetDbserverDiskSize added in v0.73.0 

func (x *ListDiskPerformancesRequest) GetDbserverDiskSize() int32

func (*ListDiskPerformancesRequest) GetDeploymentId added in v0.73.0 

func (x *ListDiskPerformancesRequest) GetDeploymentId() string

func (*ListDiskPerformancesRequest) GetNodeSizeId added in v0.73.0 

func (x *ListDiskPerformancesRequest) GetNodeSizeId() string

func (*ListDiskPerformancesRequest) GetOrganizationId added in v0.79.26 

func (x *ListDiskPerformancesRequest) GetOrganizationId() string

func (*ListDiskPerformancesRequest) GetRegionId added in v0.73.0 

func (x *ListDiskPerformancesRequest) GetRegionId() string

func (*ListDiskPerformancesRequest) ProtoMessage added in v0.73.0 

func (*ListDiskPerformancesRequest) ProtoMessage()

func (*ListDiskPerformancesRequest) ProtoReflect added in v0.89.0 

func (x *ListDiskPerformancesRequest) ProtoReflect() protoreflect.Message

func (*ListDiskPerformancesRequest) Reset added in v0.73.0 

func (x *ListDiskPerformancesRequest) Reset()

func (*ListDiskPerformancesRequest) String added in v0.73.0 

func (x *ListDiskPerformancesRequest) String() string

type ListVersionsRequest 

type ListVersionsRequest struct {

	// Common list options
	Options *v1.ListOptions `protobuf:"bytes,1,opt,name=options,proto3" json:"options,omitempty"`
	// If set, the result includes all versions for that are available for the
	// organization identified by this ID.
	// If not set, only versions are returned that are available to all organizations.
	OrganizationId string `protobuf:"bytes,2,opt,name=organization_id,json=organizationId,proto3" json:"organization_id,omitempty"`
	// If set, only versions will be returned that are safe to upgrade to from this version.
	CurrentVersion string `protobuf:"bytes,3,opt,name=current_version,json=currentVersion,proto3" json:"current_version,omitempty"`
	// contains filtered or unexported fields
}

Request arguments for ListVersions.

func (*ListVersionsRequest) Descriptor deprecated 

func (*ListVersionsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListVersionsRequest.ProtoReflect.Descriptor instead.

func (*ListVersionsRequest) GetCurrentVersion 

func (x *ListVersionsRequest) GetCurrentVersion() string

func (*ListVersionsRequest) GetOptions 

func (x *ListVersionsRequest) GetOptions() *v1.ListOptions

func (*ListVersionsRequest) GetOrganizationId 

func (x *ListVersionsRequest) GetOrganizationId() string

func (*ListVersionsRequest) ProtoMessage 

func (*ListVersionsRequest) ProtoMessage()

func (*ListVersionsRequest) ProtoReflect added in v0.89.0 

func (x *ListVersionsRequest) ProtoReflect() protoreflect.Message

func (*ListVersionsRequest) Reset 

func (x *ListVersionsRequest) Reset()

func (*ListVersionsRequest) String 

func (x *ListVersionsRequest) String() string

type NodeSize 

type NodeSize struct {

	// System identifier of the node size
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Human readable name of the node size
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Amount of memory (in GB) that is available on this size of node.
	MemorySize int32 `protobuf:"varint,3,opt,name=memory_size,json=memorySize,proto3" json:"memory_size,omitempty"`
	// Minimum amount of disk (in GB) that is available on this size of node.
	MinDiskSize int32 `protobuf:"varint,4,opt,name=min_disk_size,json=minDiskSize,proto3" json:"min_disk_size,omitempty"`
	// Maximum amount of disk (in GB) that is available on this size of node.
	MaxDiskSize int32 `protobuf:"varint,5,opt,name=max_disk_size,json=maxDiskSize,proto3" json:"max_disk_size,omitempty"`
	// CPU size that is available on this size of node (e.g. standard or high).
	CpuSize string `protobuf:"bytes,6,opt,name=cpu_size,json=cpuSize,proto3" json:"cpu_size,omitempty"`
	// If set, contains list of possible disk sizes (in GB) for the node.
	// In that case, this field overrides the min_disk_size & max_disk_size fields.
	DiskSizes []int32 `protobuf:"varint,7,rep,packed,name=disk_sizes,json=diskSizes,proto3" json:"disk_sizes,omitempty"`
	// contains filtered or unexported fields
}

NodeSize specifies the size constraints of different data nodes.

func (*NodeSize) Descriptor deprecated 

func (*NodeSize) Descriptor() ([]byte, []int)

Deprecated: Use NodeSize.ProtoReflect.Descriptor instead.

func (*NodeSize) GetCpuSize 

func (x *NodeSize) GetCpuSize() string

func (*NodeSize) GetDiskSizes 

func (x *NodeSize) GetDiskSizes() []int32

func (*NodeSize) GetId 

func (x *NodeSize) GetId() string

func (*NodeSize) GetMaxDiskSize 

func (x *NodeSize) GetMaxDiskSize() int32

func (*NodeSize) GetMemorySize 

func (x *NodeSize) GetMemorySize() int32

func (*NodeSize) GetMinDiskSize 

func (x *NodeSize) GetMinDiskSize() int32

func (*NodeSize) GetName 

func (x *NodeSize) GetName() string

func (*NodeSize) ProtoMessage 

func (*NodeSize) ProtoMessage()

func (*NodeSize) ProtoReflect added in v0.89.0 

func (x *NodeSize) ProtoReflect() protoreflect.Message

func (*NodeSize) Reset 

func (x *NodeSize) Reset()

func (*NodeSize) String 

func (x *NodeSize) String() string

type NodeSizeList 

type NodeSizeList struct {
	Items []*NodeSize `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	// contains filtered or unexported fields
}

List of node sizes.

func (*NodeSizeList) Descriptor deprecated 

func (*NodeSizeList) Descriptor() ([]byte, []int)

Deprecated: Use NodeSizeList.ProtoReflect.Descriptor instead.

func (*NodeSizeList) GetItems 

func (x *NodeSizeList) GetItems() []*NodeSize

func (*NodeSizeList) ProtoMessage 

func (*NodeSizeList) ProtoMessage()

func (*NodeSizeList) ProtoReflect added in v0.89.0 

func (x *NodeSizeList) ProtoReflect() protoreflect.Message

func (*NodeSizeList) Reset 

func (x *NodeSizeList) Reset()

func (*NodeSizeList) String 

func (x *NodeSizeList) String() string

type NodeSizesRequest 

type NodeSizesRequest struct {

	// Identifier of project that will own a deployment.
	ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Identifier of a region in which a deployment will be created.
	RegionId string `protobuf:"bytes,2,opt,name=region_id,json=regionId,proto3" json:"region_id,omitempty"`
	// If set, project_id & region_id will be taken from this deployment.
	// This also causes the node_size used by this deployment to be included
	// in the result, if it it would not match for new deployments.
	DeploymentId string `protobuf:"bytes,3,opt,name=deployment_id,json=deploymentId,proto3" json:"deployment_id,omitempty"`
	// Identifier of a model of a new deployment will be created.
	// If set, all node sizes available for this model will be returned,
	// otherwise only node sizes that have no restrictions on model will be returned.
	Model string `protobuf:"bytes,4,opt,name=model,proto3" json:"model,omitempty"`
	// Optional identifier of organization that will own a deployment.
	// Ignored if project_id or deployment_id is set.
	OrganizationId string `protobuf:"bytes,5,opt,name=organization_id,json=organizationId,proto3" json:"organization_id,omitempty"`
	// Optional field to include node sizes that are otherwise restricted
	// for the specified projectID / organizationID.
	// By default, the result is restricted based on the organization and project tiers/quotas.
	// Ignored when project_id is "all" and organization_id is not provided.
	IncludeRestricted bool `protobuf:"varint,7,opt,name=include_restricted,json=includeRestricted,proto3" json:"include_restricted,omitempty"`
	// contains filtered or unexported fields
}

Request arguments for ListNodeSizes

func (*NodeSizesRequest) Descriptor deprecated 

func (*NodeSizesRequest) Descriptor() ([]byte, []int)

Deprecated: Use NodeSizesRequest.ProtoReflect.Descriptor instead.

func (*NodeSizesRequest) GetDeploymentId 

func (x *NodeSizesRequest) GetDeploymentId() string

func (*NodeSizesRequest) GetIncludeRestricted added in v0.79.27 

func (x *NodeSizesRequest) GetIncludeRestricted() bool

func (*NodeSizesRequest) GetModel added in v0.64.4 

func (x *NodeSizesRequest) GetModel() string

func (*NodeSizesRequest) GetOrganizationId added in v0.76.5 

func (x *NodeSizesRequest) GetOrganizationId() string

func (*NodeSizesRequest) GetProjectId 

func (x *NodeSizesRequest) GetProjectId() string

func (*NodeSizesRequest) GetRegionId 

func (x *NodeSizesRequest) GetRegionId() string

func (*NodeSizesRequest) ProtoMessage 

func (*NodeSizesRequest) ProtoMessage()

func (*NodeSizesRequest) ProtoReflect added in v0.89.0 

func (x *NodeSizesRequest) ProtoReflect() protoreflect.Message

func (*NodeSizesRequest) Reset 

func (x *NodeSizesRequest) Reset()

func (*NodeSizesRequest) String 

func (x *NodeSizesRequest) String() string

type Notification added in v0.88.10 

type Notification struct {

	// String representation of the Notification
	Notification string `protobuf:"bytes,1,opt,name=notification,proto3" json:"notification,omitempty"`
	// Notification Severity
	Severity NotificationSeverity `protobuf:"varint,2,opt,name=severity,proto3,enum=arangodb.cloud.data.v1.NotificationSeverity" json:"severity,omitempty"`
	// The timestamp of when the notification has been created.
	CreatedAt *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// The timestamp of when the notification has been updated.
	UpdatedAt *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=updated_at,json=updatedAt,proto3" json:"updated_at,omitempty"`
	// The timestamp of when the notification expires.
	ExpiresAt *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=expires_at,json=expiresAt,proto3" json:"expires_at,omitempty"`
	// contains filtered or unexported fields
}

Define the Notification details

func (*Notification) Descriptor deprecated added in v0.88.10 

func (*Notification) Descriptor() ([]byte, []int)

Deprecated: Use Notification.ProtoReflect.Descriptor instead.

func (*Notification) Equals added in v0.88.10 

func (n *Notification) Equals(notification string, severity NotificationSeverity) bool

func (*Notification) GetCreatedAt added in v0.88.10 

func (x *Notification) GetCreatedAt() *timestamppb.Timestamp

func (*Notification) GetExpiresAt added in v0.88.10 

func (x *Notification) GetExpiresAt() *timestamppb.Timestamp

func (*Notification) GetNotification added in v0.88.10 

func (x *Notification) GetNotification() string

func (*Notification) GetSeverity added in v0.88.10 

func (x *Notification) GetSeverity() NotificationSeverity

func (*Notification) GetUpdatedAt added in v0.88.10 

func (x *Notification) GetUpdatedAt() *timestamppb.Timestamp

func (*Notification) ProtoMessage added in v0.88.10 

func (*Notification) ProtoMessage()

func (*Notification) ProtoReflect added in v0.89.0 

func (x *Notification) ProtoReflect() protoreflect.Message

func (*Notification) Reset added in v0.88.10 

func (x *Notification) Reset()

func (*Notification) String added in v0.88.10 

func (x *Notification) String() string

type NotificationSeverity added in v0.88.10 

type NotificationSeverity int32

NotificationSeverity keeps possible severities for notifications 

const (
	// Defines Info level Notification Severity
	NotificationSeverity_NOTIFICATION_SEVERITY_INFO NotificationSeverity = 0
	// Defines Warning level Notification Severity
	NotificationSeverity_NOTIFICATION_SEVERITY_WARNING NotificationSeverity = 1
	// Defines Critical level Notification Severity
	NotificationSeverity_NOTIFICATION_SEVERITY_CRITICAL NotificationSeverity = 2
)

func (NotificationSeverity) Descriptor added in v0.89.0 

func (NotificationSeverity) Descriptor() protoreflect.EnumDescriptor

func (NotificationSeverity) Enum added in v0.89.0 

func (x NotificationSeverity) Enum() *NotificationSeverity

func (NotificationSeverity) EnumDescriptor deprecated added in v0.88.10 

func (NotificationSeverity) EnumDescriptor() ([]byte, []int)

Deprecated: Use NotificationSeverity.Descriptor instead.

func (NotificationSeverity) Number added in v0.89.0 

func (x NotificationSeverity) Number() protoreflect.EnumNumber

func (NotificationSeverity) String added in v0.88.10 

func (x NotificationSeverity) String() string

func (NotificationSeverity) Type added in v0.89.0 

func (NotificationSeverity) Type() protoreflect.EnumType

type RebalanceDeploymentShardsRequest added in v0.58.0 

type RebalanceDeploymentShardsRequest struct {

	// The id of the deployment
	DeploymentId string `protobuf:"bytes,1,opt,name=deployment_id,json=deploymentId,proto3" json:"deployment_id,omitempty"`
	// contains filtered or unexported fields
}

RebalanceDeploymentShardsRequest request for rebalancing shards for a deployment

func (*RebalanceDeploymentShardsRequest) Descriptor deprecated added in v0.58.0 

func (*RebalanceDeploymentShardsRequest) Descriptor() ([]byte, []int)

Deprecated: Use RebalanceDeploymentShardsRequest.ProtoReflect.Descriptor instead.

func (*RebalanceDeploymentShardsRequest) GetDeploymentId added in v0.58.0 

func (x *RebalanceDeploymentShardsRequest) GetDeploymentId() string

func (*RebalanceDeploymentShardsRequest) ProtoMessage added in v0.58.0 

func (*RebalanceDeploymentShardsRequest) ProtoMessage()

func (*RebalanceDeploymentShardsRequest) ProtoReflect added in v0.89.0 

func (x *RebalanceDeploymentShardsRequest) ProtoReflect() protoreflect.Message

func (*RebalanceDeploymentShardsRequest) Reset added in v0.58.0 

func (x *RebalanceDeploymentShardsRequest) Reset()

func (*RebalanceDeploymentShardsRequest) String added in v0.58.0 

func (x *RebalanceDeploymentShardsRequest) String() string

type ReplaceVersionBy added in v0.40.10 

type ReplaceVersionBy struct {

	// The version of the ArangoDB release that it will be upgraded to.
	// Version in the format of major.minor.patch
	// Format details can be found at: https://semver.org/
	Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
	// Human readable reason why this version will be replaced.
	Reason string `protobuf:"bytes,2,opt,name=reason,proto3" json:"reason,omitempty"`
	// Date when the current version will be replaced automatically with the new version.
	// If this field isn’t set (or present) it means no automatic update will happen.
	AutoUpdateDate *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=auto_update_date,json=autoUpdateDate,proto3" json:"auto_update_date,omitempty"`
	// contains filtered or unexported fields
}

ReplaceVersionBy holds replacement instructions.

func (*ReplaceVersionBy) Descriptor deprecated added in v0.40.10 

func (*ReplaceVersionBy) Descriptor() ([]byte, []int)

Deprecated: Use ReplaceVersionBy.ProtoReflect.Descriptor instead.

func (*ReplaceVersionBy) GetAutoUpdateDate added in v0.77.12 

func (x *ReplaceVersionBy) GetAutoUpdateDate() *timestamppb.Timestamp

func (*ReplaceVersionBy) GetReason added in v0.40.10 

func (x *ReplaceVersionBy) GetReason() string

func (*ReplaceVersionBy) GetVersion added in v0.40.10 

func (x *ReplaceVersionBy) GetVersion() string

func (*ReplaceVersionBy) ProtoMessage added in v0.40.10 

func (*ReplaceVersionBy) ProtoMessage()

func (*ReplaceVersionBy) ProtoReflect added in v0.89.0 

func (x *ReplaceVersionBy) ProtoReflect() protoreflect.Message

func (*ReplaceVersionBy) Reset added in v0.40.10 

func (x *ReplaceVersionBy) Reset()

func (*ReplaceVersionBy) String added in v0.40.10 

func (x *ReplaceVersionBy) String() string

type RotateDeploymentServerRequest added in v0.54.0 

type RotateDeploymentServerRequest struct {

	// The id of the deployment this server belongs to.
	DeploymentId string `protobuf:"bytes,1,opt,name=deployment_id,json=deploymentId,proto3" json:"deployment_id,omitempty"`
	// The id of the server to rotate out.
	ServerId string `protobuf:"bytes,2,opt,name=server_id,json=serverId,proto3" json:"server_id,omitempty"`
	// contains filtered or unexported fields
}

RotateDeploymentServerRequest request for rotating out servers for a deployment

func (*RotateDeploymentServerRequest) Descriptor deprecated added in v0.54.0 

func (*RotateDeploymentServerRequest) Descriptor() ([]byte, []int)

Deprecated: Use RotateDeploymentServerRequest.ProtoReflect.Descriptor instead.

func (*RotateDeploymentServerRequest) GetDeploymentId added in v0.54.0 

func (x *RotateDeploymentServerRequest) GetDeploymentId() string

func (*RotateDeploymentServerRequest) GetServerId added in v0.54.0 

func (x *RotateDeploymentServerRequest) GetServerId() string

func (*RotateDeploymentServerRequest) ProtoMessage added in v0.54.0 

func (*RotateDeploymentServerRequest) ProtoMessage()

func (*RotateDeploymentServerRequest) ProtoReflect added in v0.89.0 

func (x *RotateDeploymentServerRequest) ProtoReflect() protoreflect.Message

func (*RotateDeploymentServerRequest) Reset added in v0.54.0 

func (x *RotateDeploymentServerRequest) Reset()

func (*RotateDeploymentServerRequest) String added in v0.54.0 

func (x *RotateDeploymentServerRequest) String() string

type ServersSpecLimits 

type ServersSpecLimits struct {

	// Limits for the number of coordinators of the deployment
	Coordinators *ServersSpecLimits_Limits `protobuf:"bytes,1,opt,name=coordinators,proto3" json:"coordinators,omitempty"`
	// Possible values for the amount of memory (in GB) to allocate
	// for coordinators.
	CoordinatorMemorySize *ServersSpecLimits_Limits `` /* 126-byte string literal not displayed */
	// Limits for the number of dbservers of the deployment
	Dbservers *ServersSpecLimits_Limits `protobuf:"bytes,11,opt,name=dbservers,proto3" json:"dbservers,omitempty"`
	// Possible values for the amount of memory (in GB) to allocate
	// for dbservers.
	DbserverMemorySize *ServersSpecLimits_Limits `protobuf:"bytes,12,opt,name=dbserver_memory_size,json=dbserverMemorySize,proto3" json:"dbserver_memory_size,omitempty"`
	// Amount of disk space (in GB) to allocate for dbservers.
	DbserverDiskSize *ServersSpecLimits_Limits `protobuf:"bytes,13,opt,name=dbserver_disk_size,json=dbserverDiskSize,proto3" json:"dbserver_disk_size,omitempty"`
	// Possible values for the amount of memory (in GB) to allocate
	// for pairs of coordinator, dbserver.
	NodeMemorySize *ServersSpecLimits_Limits `protobuf:"bytes,21,opt,name=node_memory_size,json=nodeMemorySize,proto3" json:"node_memory_size,omitempty"`
	// Possible values for the number of nodes.
	// Value must be min/max (not using allowed_values)
	NodeCount *ServersSpecLimits_Limits `protobuf:"bytes,22,opt,name=node_count,json=nodeCount,proto3" json:"node_count,omitempty"`
	// contains filtered or unexported fields
}

Limits of allowed values for fields of Deployment.ServersSpec.

func (*ServersSpecLimits) Clone added in v0.79.12 

func (s *ServersSpecLimits) Clone() *ServersSpecLimits

Clone creates a deep copy of the given source

func (*ServersSpecLimits) Descriptor deprecated 

func (*ServersSpecLimits) Descriptor() ([]byte, []int)

Deprecated: Use ServersSpecLimits.ProtoReflect.Descriptor instead.

func (*ServersSpecLimits) GetCoordinatorMemorySize 

func (x *ServersSpecLimits) GetCoordinatorMemorySize() *ServersSpecLimits_Limits

func (*ServersSpecLimits) GetCoordinators 

func (x *ServersSpecLimits) GetCoordinators() *ServersSpecLimits_Limits

func (*ServersSpecLimits) GetDbserverDiskSize 

func (x *ServersSpecLimits) GetDbserverDiskSize() *ServersSpecLimits_Limits

func (*ServersSpecLimits) GetDbserverMemorySize 

func (x *ServersSpecLimits) GetDbserverMemorySize() *ServersSpecLimits_Limits

func (*ServersSpecLimits) GetDbservers 

func (x *ServersSpecLimits) GetDbservers() *ServersSpecLimits_Limits

func (*ServersSpecLimits) GetNodeCount 

func (x *ServersSpecLimits) GetNodeCount() *ServersSpecLimits_Limits

func (*ServersSpecLimits) GetNodeMemorySize 

func (x *ServersSpecLimits) GetNodeMemorySize() *ServersSpecLimits_Limits

func (*ServersSpecLimits) ProtoMessage 

func (*ServersSpecLimits) ProtoMessage()

func (*ServersSpecLimits) ProtoReflect added in v0.89.0 

func (x *ServersSpecLimits) ProtoReflect() protoreflect.Message

func (*ServersSpecLimits) Reset 

func (x *ServersSpecLimits) Reset()

func (*ServersSpecLimits) String 

func (x *ServersSpecLimits) String() string

type ServersSpecLimitsRequest 

type ServersSpecLimitsRequest struct {

	// Identifier of project that will own a deployment.
	ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Identifier of a region in which a deployment will be created.
	RegionId string `protobuf:"bytes,2,opt,name=region_id,json=regionId,proto3" json:"region_id,omitempty"`
	// Optional identifier of a deployment for which compatible server specifications are request.
	DeploymentId string `protobuf:"bytes,3,opt,name=deployment_id,json=deploymentId,proto3" json:"deployment_id,omitempty"`
	// contains filtered or unexported fields
}

Request arguments for ListServersSpecLimits

func (*ServersSpecLimitsRequest) Descriptor deprecated 

func (*ServersSpecLimitsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ServersSpecLimitsRequest.ProtoReflect.Descriptor instead.

func (*ServersSpecLimitsRequest) GetDeploymentId 

func (x *ServersSpecLimitsRequest) GetDeploymentId() string

func (*ServersSpecLimitsRequest) GetProjectId 

func (x *ServersSpecLimitsRequest) GetProjectId() string

func (*ServersSpecLimitsRequest) GetRegionId 

func (x *ServersSpecLimitsRequest) GetRegionId() string

func (*ServersSpecLimitsRequest) ProtoMessage 

func (*ServersSpecLimitsRequest) ProtoMessage()

func (*ServersSpecLimitsRequest) ProtoReflect added in v0.89.0 

func (x *ServersSpecLimitsRequest) ProtoReflect() protoreflect.Message

func (*ServersSpecLimitsRequest) Reset 

func (x *ServersSpecLimitsRequest) Reset()

func (*ServersSpecLimitsRequest) String 

func (x *ServersSpecLimitsRequest) String() string

type ServersSpecLimits_Limits 

type ServersSpecLimits_Limits struct {

	// Minimum value
	Min int32 `protobuf:"varint,1,opt,name=min,proto3" json:"min,omitempty"`
	// Maximum value
	Max int32 `protobuf:"varint,2,opt,name=max,proto3" json:"max,omitempty"`
	// Set of allowed values.
	// If this field is non-empty, only one of these values
	// is allowed.
	AllowedValues []int32 `protobuf:"varint,3,rep,packed,name=allowed_values,json=allowedValues,proto3" json:"allowed_values,omitempty"`
	// contains filtered or unexported fields
}

func (*ServersSpecLimits_Limits) Clone added in v0.79.12 

func (s *ServersSpecLimits_Limits) Clone() *ServersSpecLimits_Limits

Clone creates a deep copy of the given source

func (*ServersSpecLimits_Limits) Descriptor deprecated 

func (*ServersSpecLimits_Limits) Descriptor() ([]byte, []int)

Deprecated: Use ServersSpecLimits_Limits.ProtoReflect.Descriptor instead.

func (*ServersSpecLimits_Limits) GetAllowedValues 

func (x *ServersSpecLimits_Limits) GetAllowedValues() []int32

func (*ServersSpecLimits_Limits) GetMax 

func (x *ServersSpecLimits_Limits) GetMax() int32

func (*ServersSpecLimits_Limits) GetMin 

func (x *ServersSpecLimits_Limits) GetMin() int32

func (*ServersSpecLimits_Limits) ProtoMessage 

func (*ServersSpecLimits_Limits) ProtoMessage()

func (*ServersSpecLimits_Limits) ProtoReflect added in v0.89.0 

func (x *ServersSpecLimits_Limits) ProtoReflect() protoreflect.Message

func (*ServersSpecLimits_Limits) Reset 

func (x *ServersSpecLimits_Limits) Reset()

func (*ServersSpecLimits_Limits) String 

func (x *ServersSpecLimits_Limits) String() string

type UnimplementedDataServiceServer 

type UnimplementedDataServiceServer struct {
}

UnimplementedDataServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedDataServiceServer) CalculateDeploymentPrice 

func (*UnimplementedDataServiceServer) CalculateDeploymentPrice(context.Context, *DeploymentPriceRequest) (*DeploymentPrice, error)

func (*UnimplementedDataServiceServer) CalculateDeploymentSize 

func (*UnimplementedDataServiceServer) CalculateDeploymentSize(context.Context, *CalculateDeploymentSizeRequest) (*DeploymentSize, error)

func (*UnimplementedDataServiceServer) CreateDeployment 

func (*UnimplementedDataServiceServer) CreateDeployment(context.Context, *Deployment) (*Deployment, error)

func (*UnimplementedDataServiceServer) CreateTestDatabase added in v0.43.7 

func (*UnimplementedDataServiceServer) CreateTestDatabase(context.Context, *CreateTestDatabaseRequest) (*CreateTestDatabaseResponse, error)

func (*UnimplementedDataServiceServer) DeleteDeployment 

func (*UnimplementedDataServiceServer) DeleteDeployment(context.Context, *v1.IDOptions) (*v1.Empty, error)

func (*UnimplementedDataServiceServer) GetAPIVersion 

func (*UnimplementedDataServiceServer) GetAPIVersion(context.Context, *v1.Empty) (*v1.Version, error)

func (*UnimplementedDataServiceServer) GetConnectDriverInstructions 

func (*UnimplementedDataServiceServer) GetConnectDriverInstructions(context.Context, *v1.IDOptions) (*ConnectDriverInstructions, error)

func (*UnimplementedDataServiceServer) GetDefaultVersion 

func (*UnimplementedDataServiceServer) GetDefaultVersion(context.Context, *v1.Empty) (*Version, error)

func (*UnimplementedDataServiceServer) GetDeployment 

func (*UnimplementedDataServiceServer) GetDeployment(context.Context, *v1.IDOptions) (*Deployment, error)

func (*UnimplementedDataServiceServer) GetDeploymentCredentials 

func (*UnimplementedDataServiceServer) GetDeploymentCredentials(context.Context, *DeploymentCredentialsRequest) (*DeploymentCredentials, error)

func (*UnimplementedDataServiceServer) GetDeploymentFeatures 

func (*UnimplementedDataServiceServer) GetDeploymentFeatures(context.Context, *DeploymentFeaturesRequest) (*DeploymentFeatures, error)

func (*UnimplementedDataServiceServer) GetDeploymentModel added in v0.88.1 

func (*UnimplementedDataServiceServer) GetDeploymentModel(context.Context, *v1.IDOptions) (*DeploymentModel, error)

func (*UnimplementedDataServiceServer) GetDeploymentUpdates added in v0.48.0 

func (*UnimplementedDataServiceServer) GetDeploymentUpdates(*v1.IDOptions, DataService_GetDeploymentUpdatesServer) error

func (*UnimplementedDataServiceServer) GetDiskPerformance added in v0.73.0 

func (*UnimplementedDataServiceServer) GetDiskPerformance(context.Context, *GetDiskPerformanceRequest) (*DiskPerformance, error)

func (*UnimplementedDataServiceServer) GetImportDataInstructions 

func (*UnimplementedDataServiceServer) GetImportDataInstructions(context.Context, *v1.IDOptions) (*ImportDataInstructions, error)

func (*UnimplementedDataServiceServer) GetServersSpecLimits 

func (*UnimplementedDataServiceServer) GetServersSpecLimits(context.Context, *ServersSpecLimitsRequest) (*ServersSpecLimits, error)

func (*UnimplementedDataServiceServer) GetVersion added in v0.78.3 

func (*UnimplementedDataServiceServer) GetVersion(context.Context, *v1.IDOptions) (*Version, error)

func (*UnimplementedDataServiceServer) ListCPUSizes 

func (*UnimplementedDataServiceServer) ListCPUSizes(context.Context, *ListCPUSizesRequest) (*CPUSizeList, error)

func (*UnimplementedDataServiceServer) ListDeploymentModels 

func (*UnimplementedDataServiceServer) ListDeploymentModels(context.Context, *ListDeploymentModelsRequest) (*DeploymentModelList, error)

func (*UnimplementedDataServiceServer) ListDeployments 

func (*UnimplementedDataServiceServer) ListDeployments(context.Context, *v1.ListOptions) (*DeploymentList, error)

func (*UnimplementedDataServiceServer) ListDeploymentsByFilter added in v0.77.10 

func (*UnimplementedDataServiceServer) ListDeploymentsByFilter(context.Context, *ListDeploymentsByFilterRequest) (*DeploymentList, error)

func (*UnimplementedDataServiceServer) ListDiskPerformances added in v0.73.0 

func (*UnimplementedDataServiceServer) ListDiskPerformances(context.Context, *ListDiskPerformancesRequest) (*DiskPerformanceList, error)

func (*UnimplementedDataServiceServer) ListNodeSizes 

func (*UnimplementedDataServiceServer) ListNodeSizes(context.Context, *NodeSizesRequest) (*NodeSizeList, error)

func (*UnimplementedDataServiceServer) ListVersions 

func (*UnimplementedDataServiceServer) ListVersions(context.Context, *ListVersionsRequest) (*VersionList, error)

func (*UnimplementedDataServiceServer) PauseDeployment added in v0.78.6 

func (*UnimplementedDataServiceServer) PauseDeployment(context.Context, *v1.IDOptions) (*v1.Empty, error)

func (*UnimplementedDataServiceServer) RebalanceDeploymentShards added in v0.58.0 

func (*UnimplementedDataServiceServer) RebalanceDeploymentShards(context.Context, *RebalanceDeploymentShardsRequest) (*v1.Empty, error)

func (*UnimplementedDataServiceServer) RecommendDeploymentSize 

func (*UnimplementedDataServiceServer) RecommendDeploymentSize(context.Context, *DeploymentSizeRequest) (*DeploymentSizeRecommendation, error)

func (*UnimplementedDataServiceServer) ResumeDeployment added in v0.43.4 

func (*UnimplementedDataServiceServer) ResumeDeployment(context.Context, *v1.IDOptions) (*v1.Empty, error)

func (*UnimplementedDataServiceServer) RotateDeploymentServer added in v0.54.0 

func (*UnimplementedDataServiceServer) RotateDeploymentServer(context.Context, *RotateDeploymentServerRequest) (*v1.Empty, error)

func (*UnimplementedDataServiceServer) UpdateDeployment 

func (*UnimplementedDataServiceServer) UpdateDeployment(context.Context, *Deployment) (*Deployment, error)

func (*UnimplementedDataServiceServer) UpdateDeploymentScheduledRootPasswordRotation added in v0.73.8 

func (*UnimplementedDataServiceServer) UpdateDeploymentScheduledRootPasswordRotation(context.Context, *UpdateDeploymentScheduledRootPasswordRotationRequest) (*v1.Empty, error)

type UpdateDeploymentScheduledRootPasswordRotationRequest added in v0.73.8 

type UpdateDeploymentScheduledRootPasswordRotationRequest struct {

	// Identifier of the deloyment.
	DeploymentId string `protobuf:"bytes,1,opt,name=deployment_id,json=deploymentId,proto3" json:"deployment_id,omitempty"`
	// Whether scheduled root password rotation should be enabled or not.
	Enabled bool `protobuf:"varint,2,opt,name=enabled,proto3" json:"enabled,omitempty"`
	// contains filtered or unexported fields
}

Request arguments for UpdateDeploymentScheduledRootPasswordRotation

func (*UpdateDeploymentScheduledRootPasswordRotationRequest) Descriptor deprecated added in v0.73.8 

func (*UpdateDeploymentScheduledRootPasswordRotationRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateDeploymentScheduledRootPasswordRotationRequest.ProtoReflect.Descriptor instead.

func (*UpdateDeploymentScheduledRootPasswordRotationRequest) GetDeploymentId added in v0.73.8 

func (x *UpdateDeploymentScheduledRootPasswordRotationRequest) GetDeploymentId() string

func (*UpdateDeploymentScheduledRootPasswordRotationRequest) GetEnabled added in v0.73.8 

func (x *UpdateDeploymentScheduledRootPasswordRotationRequest) GetEnabled() bool

func (*UpdateDeploymentScheduledRootPasswordRotationRequest) ProtoMessage added in v0.73.8 

func (*UpdateDeploymentScheduledRootPasswordRotationRequest) ProtoMessage()

func (*UpdateDeploymentScheduledRootPasswordRotationRequest) ProtoReflect added in v0.89.0 

func (x *UpdateDeploymentScheduledRootPasswordRotationRequest) ProtoReflect() protoreflect.Message

func (*UpdateDeploymentScheduledRootPasswordRotationRequest) Reset added in v0.73.8 

func (x *UpdateDeploymentScheduledRootPasswordRotationRequest) Reset()

func (*UpdateDeploymentScheduledRootPasswordRotationRequest) String added in v0.73.8 

func (x *UpdateDeploymentScheduledRootPasswordRotationRequest) String() string

type UpgradeVersionRecommendation added in v0.60.0 

type UpgradeVersionRecommendation struct {

	// The version of the ArangoDB release that it it is recommend to upgraded to.
	// Version in the format of major.minor.patch
	// Format details can be found at: https://semver.org/
	Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
	// Human readable reason why this version should be upgraded.
	Reason string `protobuf:"bytes,2,opt,name=reason,proto3" json:"reason,omitempty"`
	// contains filtered or unexported fields
}

UpgradeVersionRecommendation holds a recommendation for updating this version.

func (*UpgradeVersionRecommendation) Descriptor deprecated added in v0.60.0 

func (*UpgradeVersionRecommendation) Descriptor() ([]byte, []int)

Deprecated: Use UpgradeVersionRecommendation.ProtoReflect.Descriptor instead.

func (*UpgradeVersionRecommendation) GetReason added in v0.60.0 

func (x *UpgradeVersionRecommendation) GetReason() string

func (*UpgradeVersionRecommendation) GetVersion added in v0.60.0 

func (x *UpgradeVersionRecommendation) GetVersion() string

func (*UpgradeVersionRecommendation) ProtoMessage added in v0.60.0 

func (*UpgradeVersionRecommendation) ProtoMessage()

func (*UpgradeVersionRecommendation) ProtoReflect added in v0.89.0 

func (x *UpgradeVersionRecommendation) ProtoReflect() protoreflect.Message

func (*UpgradeVersionRecommendation) Reset added in v0.60.0 

func (x *UpgradeVersionRecommendation) Reset()

func (*UpgradeVersionRecommendation) String added in v0.60.0 

func (x *UpgradeVersionRecommendation) String() string

type Version 

type Version struct {

	// Version in the format of major.minor.patch
	// Format details can be found at: https://semver.org/
	Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
	// If set, deployments using this version will be upgraded to the ArangoDB release with the
	// version as listed in this message.
	ReplaceBy *ReplaceVersionBy `protobuf:"bytes,2,opt,name=replace_by,json=replaceBy,proto3" json:"replace_by,omitempty"`
	// If set, deployments using this version are recommend to be upgraded to the ArangoDB release with the
	// version as listed in this message.
	UpgradeRecommendation *UpgradeVersionRecommendation `protobuf:"bytes,3,opt,name=upgrade_recommendation,json=upgradeRecommendation,proto3" json:"upgrade_recommendation,omitempty"`
	// If set, this version is not longer actively supported.
	IsEndOfLife bool `protobuf:"varint,4,opt,name=is_end_of_life,json=isEndOfLife,proto3" json:"is_end_of_life,omitempty"`
	// ArangoDB version release notes
	ReleaseNotesUrl string `protobuf:"bytes,5,opt,name=release_notes_url,json=releaseNotesUrl,proto3" json:"release_notes_url,omitempty"`
	// contains filtered or unexported fields
}

Version of an ArangoDB release

func (*Version) Descriptor deprecated 

func (*Version) Descriptor() ([]byte, []int)

Deprecated: Use Version.ProtoReflect.Descriptor instead.

func (*Version) GetIsEndOfLife added in v0.72.7 

func (x *Version) GetIsEndOfLife() bool

func (*Version) GetReleaseNotesUrl added in v0.78.2 

func (x *Version) GetReleaseNotesUrl() string

func (*Version) GetReplaceBy added in v0.40.10 

func (x *Version) GetReplaceBy() *ReplaceVersionBy

func (*Version) GetUpgradeRecommendation added in v0.60.0 

func (x *Version) GetUpgradeRecommendation() *UpgradeVersionRecommendation

func (*Version) GetVersion 

func (x *Version) GetVersion() string

func (*Version) ProtoMessage 

func (*Version) ProtoMessage()

func (*Version) ProtoReflect added in v0.89.0 

func (x *Version) ProtoReflect() protoreflect.Message

func (*Version) Reset 

func (x *Version) Reset()

func (*Version) String 

func (x *Version) String() string

type VersionCallback 

type VersionCallback func(context.Context, *Version) error

VersionCallback is a callback for individual (ArangoDB) versions.

type VersionList 

type VersionList struct {
	Items []*Version `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	// contains filtered or unexported fields
}

List of Versions.

func (*VersionList) Descriptor deprecated 

func (*VersionList) Descriptor() ([]byte, []int)

Deprecated: Use VersionList.ProtoReflect.Descriptor instead.

func (*VersionList) GetItems 

func (x *VersionList) GetItems() []*Version

func (*VersionList) ProtoMessage 

func (*VersionList) ProtoMessage()

func (*VersionList) ProtoReflect added in v0.89.0 

func (x *VersionList) ProtoReflect() protoreflect.Message

func (*VersionList) Reset 

func (x *VersionList) Reset()

func (*VersionList) String 

func (x *VersionList) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.