v1

package
v0.89.30 Latest Latest
Warning

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

Go to latest
Published: Aug 28, 2026 License: Apache-2.0 Imports: 22 Imported by: 0

Documentation

Overview

Package v1 contains the API of Usage services.

Package v1 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source
const (

	// UsageItemKindV2CPUHour (Billing 2.0) indicates a UsageItem that contains
	// the number of CPU resources allocated for one hour by a deployment (or member of a deployment).
	UsageItemKindV2CPUHour = "CPUHour"

	// UsageItemKindV2MemoryHour (Billing 2.0) indicates a UsageItem that contains
	// the number of memory resources allocated for one hour by a deployment (or member of a deployment).
	UsageItemKindV2MemoryHour = "MemoryHour"

	// UsageItemKindV2StorageHour (Billing 2.0) indicates a UsageItem that contains
	// the number of storage resources allocated for one hour by a deployment (or member of a deployment).
	UsageItemKindV2StorageHour = "StorageHour"

	// UsageItemKindV2StoragePerformanceHour (Billing 2.0) indicates a UsageItem that contains
	// the amount of storage performance resources allocated for one hour by a deployment (or member of a deployment).
	UsageItemKindV2StoragePerformanceHour = "StoragePerformanceHour"

	// UsageItemKindV2GPUHour (Billing 2.0) indicates a UsageItem that contains
	// the number of GPU resources allocated for one hour by a deployment (or member of a deployment).
	UsageItemKindV2GPUHour = "GPUHour"

	// UsageItemKindV2NetworkSize (Billing 2.0) indicates a UsageItem that contains
	// the GiB of the Transfer Network allocated for a deployment (or member of a deployment).
	UsageItemKindV2NetworkSize = "NetworkUsageSize"

	// UsageItemKindV2CloudStorageHour (Billing 2.0) indicates a UsageItem that contains the amount of Cloud Storage usage,
	// e.g., for backup, audit, platform, etc., allocated/used for one hour.
	UsageItemKindV2CloudStorageHour = "CloudStorageHour"

	// UsageItemKindV2DeploymentAEU (Billing 2.0) indicates a UsageItem that contains deployment AEU usage,
	// where AEU = Deployment Size x Deployment Node Count x Deployment AEU Base x Deployment Type Ratio.
	UsageItemKindV2DeploymentAEU = "DeploymentAEU"

	// UsageItemKindV2AuditLogRequests (Billing 2.0) indicates a UsageItem that contains
	// the number of audit-log HTTPS-POST delivery requests (invocations) made for a deployment.
	// Produced for audit-log destinations of type "https-post" only.
	UsageItemKindV2AuditLogRequests = "AuditLogRequests"

	// UsageItemKindV2AuditLogData (Billing 2.0) indicates a UsageItem that contains
	// the number of bytes delivered as audit-log HTTPS-POST request bodies for a deployment.
	// Produced for audit-log destinations of type "https-post" only.
	UsageItemKindV2AuditLogData = "AuditLogData"

	// UsageItemKindV2AddonHour (Billing 2.0) indicates a UsageItem that contains
	// the number of hours a paid addon (identified by addon_id in the payload, e.g.
	// "dedicateddatacluster") was active. The item is anchored on a deployment or,
	// for addons that belong to a whole data cluster, on the data cluster itself.
	UsageItemKindV2AddonHour = "AddonHour"

	// Deprecated: UsageItemKindNetworkTransferSize indicates a UsageItem that contains
	// the amount of network traffic caused by a deployment (or member of a deployment).
	// UsageItems of this kind will be closed automatically, so no open items can exist.
	// The timespan of this UsageItem is normally 24h (unless the deployment is deleted)
	UsageItemKindNetworkTransferSize = "NetworkTransferSize"

	// Deprecated: UsageItemKindDeploymentSize indicates a UsageItem that contains cloud
	// resources for Deployment.
	// UsageItems of this kind will not be closed automatically, so open items can exist.
	// This is replaced by CPUHour + MemoryHour + StorageHour usage kinds
	UsageItemKindDeploymentSize = "DeploymentSize"

	// Deprecated: UsageItemKindBackupStorageSize indicates a UsageItem that contains
	// the amount of cloud storage used by backups of a deployment.
	// UsageItems of this kind will not be closed automatically, so open items can exists.
	// This is replaced by CloudStorageHour usage kind
	UsageItemKindBackupStorageSize = "BackupStorageSize"

	// Deprecated: UsageItemKindAuditLogSize indicates a UsageItem that contains
	// the amount of resources used by audit log (of a deployment).
	// UsageItems of this kind will be closed automatically, so no open items can exists.
	// The timespan of this UsageItem is normally 24h (unless the auditlog or deployment is deleted)
	// This is replaced by StorageHour usage kind
	UsageItemKindAuditLogSize = "AuditLogSize"

	// Deprecated: UsageItemKindAuditLogStorageSize indicates a UsageItem that contains
	// the amount of cloud storage used by audit log (of a deployment).
	// UsageItems of this kind will not be closed automatically, so open items can exists.
	// This is replaced by CloudStorageHour usage kind
	UsageItemKindAuditLogStorageSize = "AuditLogStorageSize"

	// Deprecated: UsageItemKindNotebookSize indicates a UsageItem that contains
	// the number of resources used by the notebooks (of a deployment).
	// UsageItems of this kind will not be closed automatically, so open items can exists.
	UsageItemKindNotebookSize = "NotebookSize"
	// Deprecated: UsageItemKindMLServicesSize indicates a UsageItem that contains
	// the number of resources used by a MLServices resources (of a deployment).
	// UsageItems of this kind will not be closed automatically, so open items can exist.
	UsageItemKindMLServicesSize = "MLServicesSize"
	// Deprecated: UsageItemKindMLJobSize indicates a UsageItem that contains
	// the number of resources used by a ML job (of a MLServices).
	// UsageItems of this kind are closed on creation itself, so open items cannot exist.
	UsageItemKindMLJobSize = "MLJobSize"
	// Deprecated: UsageItemKindGraphAnalyticsJobSize indicates a UsageItem that contains
	// the number of resources used by a GraphAnalytics job.
	// UsageItems of this kind are closed on creation, so open items cannot exist.
	UsageItemKindGraphAnalyticsJobSize = "GraphAnalyticsJobSize"
)
View Source
const (

	// NetworkTransferDestinationInternet specifies the destination (or source) from the ingress/egress as internet data transfer.
	NetworkTransferDestinationInternet = "Internet"
	// NetworkTransferDestinationInCluster specifies the destination (or source) from the ingress/egress as in-cluster data transfer.
	NetworkTransferDestinationInCluster = "InCluster"
	// NetworkTransferDestinationPrivateEndpoint specifies the destination (or source) from the ingress/egress as private-endpoint data transfer.
	NetworkTransferDestinationPrivateEndpoint = "PrivateEndpoint"
)
View Source
const (
	// APIID contains identifier of this API
	APIID = "usage/v1"
	// APIMajorVersion contains major version of this API
	APIMajorVersion = 1
	// APIMinorVersion contains minor version of this API
	APIMinorVersion = 3
	// APIPatchVersion contains patch version of this API
	APIPatchVersion = 10
)
View Source
const (
	// KindUsageItem is a constants for the kind of UsageItem resources.
	KindUsageItem = "UsageItem"
)
View Source
const (

	// PermissionUsageItemList is needed for listing usage items in an organization
	PermissionUsageItemList = "usage.usageitem.list"
)

Variables

View Source
var (
	Granularity_name = map[int32]string{
		0: "GRANULARITY_TOTAL",
		1: "GRANULARITY_DAY",
		2: "GRANULARITY_MONTH",
	}
	Granularity_value = map[string]int32{
		"GRANULARITY_TOTAL": 0,
		"GRANULARITY_DAY":   1,
		"GRANULARITY_MONTH": 2,
	}
)

Enum value maps for Granularity.

BillingV2UsageItemKinds is the full set of Billing 2.0 (V2) usage item kinds, in a stable order. Reference this (or IsBillingV2UsageItemKind) instead of hand-maintaining per-service copies, so new V2 kinds are picked up everywhere: ingestion (everestd), skipping V1 pricing (usage-item-price-calculator), dashboards, validation, etc.

When adding a kind here, also: add its CreditPlan variable mapping (pricingd variableForKind) and Everest component (everestd kindToComponent/quantityForItem) — both are guarded by *_CoversAllV2Kinds tests — and update the idashboard frontend list `creditUsageKindOptions` (apis/usage kinds cannot be imported into TS).

View Source
var File_usage_proto protoreflect.FileDescriptor

Functions

func ForEachUsageItem

func ForEachUsageItem(ctx context.Context, listFunc func(ctx context.Context, req *ListUsageItemsRequest) (*UsageItemList, error),
	req *ListUsageItemsRequest, cb UsageItemCallback) error

ForEachUsageItem iterates over all usage items that match given given filter, invoking the given callback for each usage item.

func IsBillingV2UsageItemKind added in v0.89.22

func IsBillingV2UsageItemKind(kind string) bool

IsBillingV2UsageItemKind reports whether kind is a Billing 2.0 (V2) usage item kind.

func RegisterUsageServiceHandler

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

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

func RegisterUsageServiceHandlerClient

func RegisterUsageServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client UsageServiceClient) error

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

func RegisterUsageServiceHandlerFromEndpoint

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

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

func RegisterUsageServiceHandlerServer

func RegisterUsageServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server UsageServiceServer) error

RegisterUsageServiceHandlerServer registers the http handlers for service UsageService to "mux". UnaryRPC :call UsageServiceServer 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 RegisterUsageServiceHandlerFromEndpoint instead.

func RegisterUsageServiceServer

func RegisterUsageServiceServer(s *grpc.Server, srv UsageServiceServer)

func UsageItemURL

func UsageItemURL(organizationID, usageItemID string) string

UsageItemURL creates a resource URL for the UsageItem with given ID in given context.

Types

type CreditUsage added in v0.89.29

type CreditUsage struct {

	// Aggregated buckets, ordered ascending by period_start.
	Buckets []*CreditUsageBucket `protobuf:"bytes,1,rep,name=buckets,proto3" json:"buckets,omitempty"`
	// Total credits consumed over the whole requested period.
	TotalCredits float64 `protobuf:"fixed64,2,opt,name=total_credits,json=totalCredits,proto3" json:"total_credits,omitempty"`
	// contains filtered or unexported fields
}

Aggregated Billing 2.0 credit consumption.

func (*CreditUsage) Descriptor deprecated added in v0.89.29

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

Deprecated: Use CreditUsage.ProtoReflect.Descriptor instead.

func (*CreditUsage) GetBuckets added in v0.89.29

func (x *CreditUsage) GetBuckets() []*CreditUsageBucket

func (*CreditUsage) GetTotalCredits added in v0.89.29

func (x *CreditUsage) GetTotalCredits() float64

func (*CreditUsage) ProtoMessage added in v0.89.29

func (*CreditUsage) ProtoMessage()

func (*CreditUsage) ProtoReflect added in v0.89.29

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

func (*CreditUsage) Reset added in v0.89.29

func (x *CreditUsage) Reset()

func (*CreditUsage) String added in v0.89.29

func (x *CreditUsage) String() string

type CreditUsageBucket added in v0.89.29

type CreditUsageBucket struct {

	// Start of the period covered by this bucket, in UTC.
	PeriodStart *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=period_start,json=periodStart,proto3" json:"period_start,omitempty"`
	// Deployment covered by this bucket.
	// Empty unless group_by_deployment was set on the request.
	DeploymentId string `protobuf:"bytes,2,opt,name=deployment_id,json=deploymentId,proto3" json:"deployment_id,omitempty"`
	// Usage component (usage item kind) covered by this bucket.
	// Empty unless group_by_component was set on the request.
	Component string `protobuf:"bytes,3,opt,name=component,proto3" json:"component,omitempty"`
	// Credits consumed in this bucket.
	Credits float64 `protobuf:"fixed64,4,opt,name=credits,proto3" json:"credits,omitempty"`
	// contains filtered or unexported fields
}

A single aggregated bucket of credit consumption.

func (*CreditUsageBucket) Descriptor deprecated added in v0.89.29

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

Deprecated: Use CreditUsageBucket.ProtoReflect.Descriptor instead.

func (*CreditUsageBucket) GetComponent added in v0.89.29

func (x *CreditUsageBucket) GetComponent() string

func (*CreditUsageBucket) GetCredits added in v0.89.29

func (x *CreditUsageBucket) GetCredits() float64

func (*CreditUsageBucket) GetDeploymentId added in v0.89.29

func (x *CreditUsageBucket) GetDeploymentId() string

func (*CreditUsageBucket) GetPeriodStart added in v0.89.29

func (x *CreditUsageBucket) GetPeriodStart() *timestamppb.Timestamp

func (*CreditUsageBucket) ProtoMessage added in v0.89.29

func (*CreditUsageBucket) ProtoMessage()

func (*CreditUsageBucket) ProtoReflect added in v0.89.29

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

func (*CreditUsageBucket) Reset added in v0.89.29

func (x *CreditUsageBucket) Reset()

func (*CreditUsageBucket) String added in v0.89.29

func (x *CreditUsageBucket) String() string

type GetCreditUsageRequest added in v0.89.29

type GetCreditUsageRequest struct {

	// Request credit usage for the organization with this id.
	// This is a required field.
	OrganizationId string `protobuf:"bytes,1,opt,name=organization_id,json=organizationId,proto3" json:"organization_id,omitempty"`
	// Start of the reported period (inclusive).
	// This is a required field.
	From *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=from,proto3" json:"from,omitempty"`
	// End of the reported period (exclusive).
	// This is a required field.
	// The period must not be longer than 366 days.
	To *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=to,proto3" json:"to,omitempty"`
	// Size of the returned time buckets.
	// This is an optional field, defaulting to a single total bucket.
	Granularity Granularity `protobuf:"varint,4,opt,name=granularity,proto3,enum=arangodb.cloud.usage.v1.Granularity" json:"granularity,omitempty"`
	// Limit the report to the deployment with this id.
	// This is an optional field.
	DeploymentId string `protobuf:"bytes,5,opt,name=deployment_id,json=deploymentId,proto3" json:"deployment_id,omitempty"`
	// If set, return one bucket per deployment within each time bucket.
	GroupByDeployment bool `protobuf:"varint,6,opt,name=group_by_deployment,json=groupByDeployment,proto3" json:"group_by_deployment,omitempty"`
	// If set, return one bucket per usage component within each time bucket.
	GroupByComponent bool `protobuf:"varint,7,opt,name=group_by_component,json=groupByComponent,proto3" json:"group_by_component,omitempty"`
	// Limit the report to this usage component, e.g. "MemoryHour".
	// Must be one of the Billing 2.0 usage component kinds; an unknown value
	// is rejected rather than silently returning an empty report.
	// This is an optional field.
	Component string `protobuf:"bytes,8,opt,name=component,proto3" json:"component,omitempty"`
	// contains filtered or unexported fields
}

Request arguments for GetCreditUsage.

func (*GetCreditUsageRequest) Descriptor deprecated added in v0.89.29

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

Deprecated: Use GetCreditUsageRequest.ProtoReflect.Descriptor instead.

func (*GetCreditUsageRequest) GetComponent added in v0.89.30

func (x *GetCreditUsageRequest) GetComponent() string

func (*GetCreditUsageRequest) GetDeploymentId added in v0.89.29

func (x *GetCreditUsageRequest) GetDeploymentId() string

func (*GetCreditUsageRequest) GetFrom added in v0.89.29

func (*GetCreditUsageRequest) GetGranularity added in v0.89.29

func (x *GetCreditUsageRequest) GetGranularity() Granularity

func (*GetCreditUsageRequest) GetGroupByComponent added in v0.89.29

func (x *GetCreditUsageRequest) GetGroupByComponent() bool

func (*GetCreditUsageRequest) GetGroupByDeployment added in v0.89.29

func (x *GetCreditUsageRequest) GetGroupByDeployment() bool

func (*GetCreditUsageRequest) GetOrganizationId added in v0.89.29

func (x *GetCreditUsageRequest) GetOrganizationId() string

func (*GetCreditUsageRequest) GetTo added in v0.89.29

func (*GetCreditUsageRequest) ProtoMessage added in v0.89.29

func (*GetCreditUsageRequest) ProtoMessage()

func (*GetCreditUsageRequest) ProtoReflect added in v0.89.29

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

func (*GetCreditUsageRequest) Reset added in v0.89.29

func (x *GetCreditUsageRequest) Reset()

func (*GetCreditUsageRequest) String added in v0.89.29

func (x *GetCreditUsageRequest) String() string

type Granularity added in v0.89.29

type Granularity int32

Granularity of the time buckets returned by GetCreditUsage.

const (
	// A single bucket covering the whole requested period.
	Granularity_GRANULARITY_TOTAL Granularity = 0
	// One bucket per UTC day.
	Granularity_GRANULARITY_DAY Granularity = 1
	// One bucket per UTC month.
	Granularity_GRANULARITY_MONTH Granularity = 2
)

func (Granularity) Descriptor added in v0.89.29

func (Granularity) Enum added in v0.89.29

func (x Granularity) Enum() *Granularity

func (Granularity) EnumDescriptor deprecated added in v0.89.29

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

Deprecated: Use Granularity.Descriptor instead.

func (Granularity) Number added in v0.89.29

func (x Granularity) Number() protoreflect.EnumNumber

func (Granularity) String added in v0.89.29

func (x Granularity) String() string

func (Granularity) Type added in v0.89.29

type ListUsageItemsRequest

type ListUsageItemsRequest struct {

	// Request usage items for the organization with this id.
	// This is a required field.
	OrganizationId string `protobuf:"bytes,1,opt,name=organization_id,json=organizationId,proto3" json:"organization_id,omitempty"`
	// Request usage items that overlaps in time with the time period that starts with this timestamp (inclusive).
	// This is a required field.
	From *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=from,proto3" json:"from,omitempty"`
	// Request usage items that overlaps in time with the time period that ends with this timestamp (exclusive).
	// This is a required field.
	To *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=to,proto3" json:"to,omitempty"`
	// Sort descending (new to old) on started_at field (default is ascending).
	SortDescending bool `protobuf:"varint,4,opt,name=sort_descending,json=sortDescending,proto3" json:"sort_descending,omitempty"`
	// Limit to usage items of this kind
	Kind string `protobuf:"bytes,5,opt,name=kind,proto3" json:"kind,omitempty"`
	// Standard list options
	// This is an optional field.
	Options *v1.ListOptions `protobuf:"bytes,10,opt,name=options,proto3" json:"options,omitempty"`
	// Limit to usage items for the resource with this URL.
	// This is an optional field.
	ResourceUrl string `protobuf:"bytes,11,opt,name=resource_url,json=resourceUrl,proto3" json:"resource_url,omitempty"`
	// Limit to usage items for the resource with this kind.
	// This is an optional field.
	ResourceKind string `protobuf:"bytes,12,opt,name=resource_kind,json=resourceKind,proto3" json:"resource_kind,omitempty"`
	// Limit to usage items for the project with this id.
	// This is an optional field.
	ProjectId string `protobuf:"bytes,13,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Limit to usage items for the deployment with this id.
	// This is an optional field.
	DeploymentId string `protobuf:"bytes,14,opt,name=deployment_id,json=deploymentId,proto3" json:"deployment_id,omitempty"`
	// Limit to usage items for deployments with this node size.
	// This is an optional field.
	NodeSizeId string `protobuf:"bytes,15,opt,name=node_size_id,json=nodeSizeId,proto3" json:"node_size_id,omitempty"`
	// Limit to usage items for deployments in this region.
	// This is an optional field.
	RegionId string `protobuf:"bytes,16,opt,name=region_id,json=regionId,proto3" json:"region_id,omitempty"`
	// If set, limit to usage items that have no invoice_id set.
	HasNoInvoiceId bool `protobuf:"varint,20,opt,name=has_no_invoice_id,json=hasNoInvoiceId,proto3" json:"has_no_invoice_id,omitempty"`
	// If set, limit to usage items that have an invoice_id set.
	HasInvoiceId bool `protobuf:"varint,21,opt,name=has_invoice_id,json=hasInvoiceId,proto3" json:"has_invoice_id,omitempty"`
	// If set, limit to usage items that have the invoice_id set to this specific value.
	// This is an optional field.
	InvoiceId string `protobuf:"bytes,22,opt,name=invoice_id,json=invoiceId,proto3" json:"invoice_id,omitempty"`
	// Request usage items that start at or after given timestamp.
	// This is an optional field.
	NotStartBefore *timestamppb.Timestamp `protobuf:"bytes,23,opt,name=not_start_before,json=notStartBefore,proto3" json:"not_start_before,omitempty"`
	// Limit to usage items for the deployment with this model.
	IncludedTierIds []string `protobuf:"bytes,30,rep,name=included_tier_ids,json=includedTierIds,proto3" json:"included_tier_ids,omitempty"`
	// Limit to usage items for the deployment with this model.
	ExcludedTierIds []string `protobuf:"bytes,31,rep,name=excluded_tier_ids,json=excludedTierIds,proto3" json:"excluded_tier_ids,omitempty"`
	// contains filtered or unexported fields
}

Request arguments for ListUsageItems

func (*ListUsageItemsRequest) Descriptor deprecated

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

Deprecated: Use ListUsageItemsRequest.ProtoReflect.Descriptor instead.

func (*ListUsageItemsRequest) GetDeploymentId

func (x *ListUsageItemsRequest) GetDeploymentId() string

func (*ListUsageItemsRequest) GetExcludedTierIds added in v0.89.5

func (x *ListUsageItemsRequest) GetExcludedTierIds() []string

func (*ListUsageItemsRequest) GetFrom

func (*ListUsageItemsRequest) GetHasInvoiceId

func (x *ListUsageItemsRequest) GetHasInvoiceId() bool

func (*ListUsageItemsRequest) GetHasNoInvoiceId

func (x *ListUsageItemsRequest) GetHasNoInvoiceId() bool

func (*ListUsageItemsRequest) GetIncludedTierIds added in v0.89.5

func (x *ListUsageItemsRequest) GetIncludedTierIds() []string

func (*ListUsageItemsRequest) GetInvoiceId

func (x *ListUsageItemsRequest) GetInvoiceId() string

func (*ListUsageItemsRequest) GetKind

func (x *ListUsageItemsRequest) GetKind() string

func (*ListUsageItemsRequest) GetNodeSizeId added in v0.72.3

func (x *ListUsageItemsRequest) GetNodeSizeId() string

func (*ListUsageItemsRequest) GetNotStartBefore added in v0.74.9

func (x *ListUsageItemsRequest) GetNotStartBefore() *timestamppb.Timestamp

func (*ListUsageItemsRequest) GetOptions

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

func (*ListUsageItemsRequest) GetOrganizationId

func (x *ListUsageItemsRequest) GetOrganizationId() string

func (*ListUsageItemsRequest) GetProjectId

func (x *ListUsageItemsRequest) GetProjectId() string

func (*ListUsageItemsRequest) GetRegionId added in v0.72.3

func (x *ListUsageItemsRequest) GetRegionId() string

func (*ListUsageItemsRequest) GetResourceKind

func (x *ListUsageItemsRequest) GetResourceKind() string

func (*ListUsageItemsRequest) GetResourceUrl

func (x *ListUsageItemsRequest) GetResourceUrl() string

func (*ListUsageItemsRequest) GetSortDescending

func (x *ListUsageItemsRequest) GetSortDescending() bool

func (*ListUsageItemsRequest) GetTo

func (*ListUsageItemsRequest) ProtoMessage

func (*ListUsageItemsRequest) ProtoMessage()

func (*ListUsageItemsRequest) ProtoReflect added in v0.89.0

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

func (*ListUsageItemsRequest) Reset

func (x *ListUsageItemsRequest) Reset()

func (*ListUsageItemsRequest) String

func (x *ListUsageItemsRequest) String() string

type UnimplementedUsageServiceServer

type UnimplementedUsageServiceServer struct {
}

UnimplementedUsageServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedUsageServiceServer) GetAPIVersion

func (*UnimplementedUsageServiceServer) GetCreditUsage added in v0.89.29

func (*UnimplementedUsageServiceServer) ListUsageItems

type UsageItem

type UsageItem struct {

	// System identifier of the usage item.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// URL of this resource
	Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`
	// Kind of usage item.
	// Examples:
	// UsageItemKindNetworkSize (NetworkUsageSize), UsageItemKindCPUHour (CPUHour), etc.
	Kind string `protobuf:"bytes,3,opt,name=kind,proto3" json:"kind,omitempty"`
	// Identification of the resource covered by this usage item
	Resource *UsageItem_Resource `protobuf:"bytes,4,opt,name=resource,proto3" json:"resource,omitempty"`
	// This usage item covers a time period that starts at this timestamp
	StartsAt *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=starts_at,json=startsAt,proto3" json:"starts_at,omitempty"`
	// This usage item covers a time period that ends at this timestamp.
	// If the usage item has not yet ended, this field is is set to the current time.
	EndsAt *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=ends_at,json=endsAt,proto3" json:"ends_at,omitempty"`
	// @Deprecated - will be removed in OAS-12028
	// Set when this usage item has ended.
	HasEnded bool `protobuf:"varint,7,opt,name=has_ended,json=hasEnded,proto3" json:"has_ended,omitempty"`
	// Identifier of the tier the organization was using at the start of this usage period.
	TierId string `protobuf:"bytes,8,opt,name=tier_id,json=tierId,proto3" json:"tier_id,omitempty"`
	// Identifier of the invoice that includes this usage item.
	// The usage item must be ended when this field it set.
	InvoiceId string `protobuf:"bytes,9,opt,name=invoice_id,json=invoiceId,proto3" json:"invoice_id,omitempty"`
	// UsageItem creation time information
	CreatedAt *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// Amount of (computer) resources used by the resource covered by this usage item.
	// This field is only set when the usage item is of kind DeploymentSize.
	DeploymentSize *UsageItem_DeploymentSize `protobuf:"bytes,101,opt,name=deployment_size,json=deploymentSize,proto3" json:"deployment_size,omitempty"`
	// Amount of network traffic used by the resource covered by this usage item.
	// This field is only set when the usage item is of kind NetworkTransferSize
	// (UsageItemKindNetworkTransferSize).
	NetworkTransferSize *UsageItem_NetworkTransferSize `protobuf:"bytes,102,opt,name=network_transfer_size,json=networkTransferSize,proto3" json:"network_transfer_size,omitempty"`
	// Amount of backup related cloud storage used by the resource covered by this usage item.
	// This field is only set when the usage item is of kind BackupStorageSize.
	BackupStorageSize *UsageItem_BackupStorageSize `protobuf:"bytes,103,opt,name=backup_storage_size,json=backupStorageSize,proto3" json:"backup_storage_size,omitempty"`
	// Amount of audit log related resources used by the resource covered by this usage item.
	// This field is only set when the usage item is of kind AuditLogSize.
	AuditlogSize *UsageItem_AuditLogSize `protobuf:"bytes,104,opt,name=auditlog_size,json=auditlogSize,proto3" json:"auditlog_size,omitempty"`
	// Amount of audit log storage related resources used by the resource covered by this usage item.
	// This field is only set when the usage item is of kind AuditLogCloudSize.
	AuditlogStorageSize *UsageItem_AuditLogStorageSize `protobuf:"bytes,105,opt,name=auditlog_storage_size,json=auditlogStorageSize,proto3" json:"auditlog_storage_size,omitempty"`
	// Amount of cloud resources used by a given Notebook.
	// This field is only set when the usage item is of kind NotebookSize.
	NotebookSize *UsageItem_NotebookSize `protobuf:"bytes,106,opt,name=notebook_size,json=notebookSize,proto3" json:"notebook_size,omitempty"`
	// Amount of compute resources used by a given MLServices resource.
	// This field is only set when the usage item is of kind MLServicesSize.
	MlservicesSize *UsageItem_MLServicesSize `protobuf:"bytes,107,opt,name=mlservices_size,json=mlservicesSize,proto3" json:"mlservices_size,omitempty"`
	// Amount of compute resources used by a given ML job.
	// This field is only set when the usage item is of kind MLJobSize.
	MljobSize *UsageItem_MLJobSize `protobuf:"bytes,108,opt,name=mljob_size,json=mljobSize,proto3" json:"mljob_size,omitempty"`
	// Amount of compute resources used by a given ML job.
	// This field is only set when the usage item is of kind MLJobSize.
	GraphanalyticsjobSize *UsageItem_GraphAnalyticsJobSize `` /* 126-byte string literal not displayed */
	// This field is only set when the usage item is of kind CPUHour.
	CpuHour *UsageItem_CPUHour `protobuf:"bytes,120,opt,name=cpu_hour,json=cpuHour,proto3" json:"cpu_hour,omitempty"`
	// This field is only set when the usage item is of kind MemoryHour.
	MemoryHour *UsageItem_MemoryHour `protobuf:"bytes,121,opt,name=memory_hour,json=memoryHour,proto3" json:"memory_hour,omitempty"`
	// This field is only set when the usage item is of kind StorageHour.
	StorageHour *UsageItem_StorageHour `protobuf:"bytes,122,opt,name=storage_hour,json=storageHour,proto3" json:"storage_hour,omitempty"`
	// This field is only set when the usage item is of kind StoragePerformanceHour.
	StoragePerformanceHour *UsageItem_StoragePerformanceHour `` /* 131-byte string literal not displayed */
	// This field is only set when the usage item is of kind GPUHour.
	GpuHour *UsageItem_GPUHour `protobuf:"bytes,124,opt,name=gpu_hour,json=gpuHour,proto3" json:"gpu_hour,omitempty"`
	// This field is only set when the usage item is of kind NetworkUsageSize
	// (UsageItemKindNetworkSize).
	NetworkSize *UsageItem_NetworkSize `protobuf:"bytes,125,opt,name=network_size,json=networkSize,proto3" json:"network_size,omitempty"`
	// This field is only set when the usage item is of kind CloudStorageHour.
	CloudStorageHour *UsageItem_CloudStorageHour `protobuf:"bytes,126,opt,name=cloud_storage_hour,json=cloudStorageHour,proto3" json:"cloud_storage_hour,omitempty"`
	// This field is only set when the usage item is of kind DeploymentAEU.
	DeploymentAeu *UsageItem_DeploymentAEU `protobuf:"bytes,127,opt,name=deployment_aeu,json=deploymentAeu,proto3" json:"deployment_aeu,omitempty"`
	// This field is only set when the usage item is of kind AuditLogRequests.
	AuditLogRequests *UsageItem_AuditLogRequests `protobuf:"bytes,128,opt,name=audit_log_requests,json=auditLogRequests,proto3" json:"audit_log_requests,omitempty"`
	// This field is only set when the usage item is of kind AuditLogData.
	AuditLogData *UsageItem_AuditLogData `protobuf:"bytes,129,opt,name=audit_log_data,json=auditLogData,proto3" json:"audit_log_data,omitempty"`
	// This field is only set when the usage item is of kind AddonHour.
	AddonHour *UsageItem_AddonHour `protobuf:"bytes,130,opt,name=addon_hour,json=addonHour,proto3" json:"addon_hour,omitempty"`
	// contains filtered or unexported fields
}

A UsageItem message contained usage tracking information for a tracked resource (usually deployment) in a specific time period.

func (*UsageItem) Descriptor deprecated

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

Deprecated: Use UsageItem.ProtoReflect.Descriptor instead.

func (*UsageItem) GetAddonHour added in v0.89.26

func (x *UsageItem) GetAddonHour() *UsageItem_AddonHour

func (*UsageItem) GetAuditLogData added in v0.89.22

func (x *UsageItem) GetAuditLogData() *UsageItem_AuditLogData

func (*UsageItem) GetAuditLogRequests added in v0.89.22

func (x *UsageItem) GetAuditLogRequests() *UsageItem_AuditLogRequests

func (*UsageItem) GetAuditlogSize added in v0.58.1

func (x *UsageItem) GetAuditlogSize() *UsageItem_AuditLogSize

func (*UsageItem) GetAuditlogStorageSize added in v0.61.0

func (x *UsageItem) GetAuditlogStorageSize() *UsageItem_AuditLogStorageSize

func (*UsageItem) GetBackupStorageSize

func (x *UsageItem) GetBackupStorageSize() *UsageItem_BackupStorageSize

func (*UsageItem) GetCloudStorageHour added in v0.89.12

func (x *UsageItem) GetCloudStorageHour() *UsageItem_CloudStorageHour

func (*UsageItem) GetCpuHour added in v0.89.12

func (x *UsageItem) GetCpuHour() *UsageItem_CPUHour

func (*UsageItem) GetCreatedAt added in v0.89.12

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

func (*UsageItem) GetDeploymentAeu added in v0.89.12

func (x *UsageItem) GetDeploymentAeu() *UsageItem_DeploymentAEU

func (*UsageItem) GetDeploymentSize

func (x *UsageItem) GetDeploymentSize() *UsageItem_DeploymentSize

func (*UsageItem) GetEndsAt

func (x *UsageItem) GetEndsAt() *timestamppb.Timestamp

func (*UsageItem) GetGpuHour added in v0.89.12

func (x *UsageItem) GetGpuHour() *UsageItem_GPUHour

func (*UsageItem) GetGraphanalyticsjobSize added in v0.88.6

func (x *UsageItem) GetGraphanalyticsjobSize() *UsageItem_GraphAnalyticsJobSize

func (*UsageItem) GetHasEnded

func (x *UsageItem) GetHasEnded() bool

func (*UsageItem) GetId

func (x *UsageItem) GetId() string

func (*UsageItem) GetInvoiceId

func (x *UsageItem) GetInvoiceId() string

func (*UsageItem) GetKind

func (x *UsageItem) GetKind() string

func (*UsageItem) GetMemoryHour added in v0.89.12

func (x *UsageItem) GetMemoryHour() *UsageItem_MemoryHour

func (*UsageItem) GetMljobSize added in v0.88.0

func (x *UsageItem) GetMljobSize() *UsageItem_MLJobSize

func (*UsageItem) GetMlservicesSize added in v0.79.6

func (x *UsageItem) GetMlservicesSize() *UsageItem_MLServicesSize

func (*UsageItem) GetNetworkSize added in v0.89.12

func (x *UsageItem) GetNetworkSize() *UsageItem_NetworkSize

func (*UsageItem) GetNetworkTransferSize

func (x *UsageItem) GetNetworkTransferSize() *UsageItem_NetworkTransferSize

func (*UsageItem) GetNotebookSize added in v0.77.0

func (x *UsageItem) GetNotebookSize() *UsageItem_NotebookSize

func (*UsageItem) GetResource

func (x *UsageItem) GetResource() *UsageItem_Resource

func (*UsageItem) GetStartsAt

func (x *UsageItem) GetStartsAt() *timestamppb.Timestamp

func (*UsageItem) GetStorageHour added in v0.89.12

func (x *UsageItem) GetStorageHour() *UsageItem_StorageHour

func (*UsageItem) GetStoragePerformanceHour added in v0.89.12

func (x *UsageItem) GetStoragePerformanceHour() *UsageItem_StoragePerformanceHour

func (*UsageItem) GetTierId

func (x *UsageItem) GetTierId() string

func (*UsageItem) GetUrl

func (x *UsageItem) GetUrl() string

func (*UsageItem) IsActivePrepaidDeployment added in v0.70.4

func (u *UsageItem) IsActivePrepaidDeployment() bool

IsActivePrepaidDeployment return true if usage item's range overlaps prepaid deployment range

func (*UsageItem) ProtoMessage

func (*UsageItem) ProtoMessage()

func (*UsageItem) ProtoReflect added in v0.89.0

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

func (*UsageItem) Reset

func (x *UsageItem) Reset()

func (*UsageItem) String

func (x *UsageItem) String() string

type UsageItemCallback

type UsageItemCallback func(context.Context, *UsageItem) error

UsageItemCallback is a callback for individual usage items.

type UsageItemList

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

List of UsageItems.

func (*UsageItemList) Descriptor deprecated

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

Deprecated: Use UsageItemList.ProtoReflect.Descriptor instead.

func (*UsageItemList) GetItems

func (x *UsageItemList) GetItems() []*UsageItem

func (*UsageItemList) ProtoMessage

func (*UsageItemList) ProtoMessage()

func (*UsageItemList) ProtoReflect added in v0.89.0

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

func (*UsageItemList) Reset

func (x *UsageItemList) Reset()

func (*UsageItemList) String

func (x *UsageItemList) String() string

type UsageItem_AddonHour added in v0.89.26

type UsageItem_AddonHour struct {

	// Identifier of the addon (e.g. "dedicateddatacluster").
	AddonId string `protobuf:"bytes,1,opt,name=addon_id,json=addonId,proto3" json:"addon_id,omitempty"`
	// Number of hours the addon was active in this usage period.
	AddonHours float64 `protobuf:"fixed64,2,opt,name=addon_hours,json=addonHours,proto3" json:"addon_hours,omitempty"`
	// contains filtered or unexported fields
}

func (*UsageItem_AddonHour) Descriptor deprecated added in v0.89.26

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

Deprecated: Use UsageItem_AddonHour.ProtoReflect.Descriptor instead.

func (*UsageItem_AddonHour) GetAddonHours added in v0.89.26

func (x *UsageItem_AddonHour) GetAddonHours() float64

func (*UsageItem_AddonHour) GetAddonId added in v0.89.26

func (x *UsageItem_AddonHour) GetAddonId() string

func (*UsageItem_AddonHour) ProtoMessage added in v0.89.26

func (*UsageItem_AddonHour) ProtoMessage()

func (*UsageItem_AddonHour) ProtoReflect added in v0.89.26

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

func (*UsageItem_AddonHour) Reset added in v0.89.26

func (x *UsageItem_AddonHour) Reset()

func (*UsageItem_AddonHour) String added in v0.89.26

func (x *UsageItem_AddonHour) String() string

type UsageItem_AuditLogData added in v0.89.22

type UsageItem_AuditLogData struct {

	// Number of bytes delivered as audit-log HTTPS-POST request bodies in this usage period.
	Bytes int64 `protobuf:"varint,1,opt,name=bytes,proto3" json:"bytes,omitempty"`
	// Identifier of the audit-log destination this data was delivered to
	// (AuditLog.Destination.id). See AuditLogRequests.destination_id.
	DestinationId string `protobuf:"bytes,2,opt,name=destination_id,json=destinationId,proto3" json:"destination_id,omitempty"`
	// contains filtered or unexported fields
}

func (*UsageItem_AuditLogData) Descriptor deprecated added in v0.89.22

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

Deprecated: Use UsageItem_AuditLogData.ProtoReflect.Descriptor instead.

func (*UsageItem_AuditLogData) GetBytes added in v0.89.22

func (x *UsageItem_AuditLogData) GetBytes() int64

func (*UsageItem_AuditLogData) GetDestinationId added in v0.89.27

func (x *UsageItem_AuditLogData) GetDestinationId() string

func (*UsageItem_AuditLogData) ProtoMessage added in v0.89.22

func (*UsageItem_AuditLogData) ProtoMessage()

func (*UsageItem_AuditLogData) ProtoReflect added in v0.89.22

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

func (*UsageItem_AuditLogData) Reset added in v0.89.22

func (x *UsageItem_AuditLogData) Reset()

func (*UsageItem_AuditLogData) String added in v0.89.22

func (x *UsageItem_AuditLogData) String() string

type UsageItem_AuditLogRequests added in v0.89.22

type UsageItem_AuditLogRequests struct {

	// Number of audit-log HTTPS-POST delivery requests (invocations) in this usage period.
	Count int64 `protobuf:"varint,1,opt,name=count,proto3" json:"count,omitempty"`
	// Identifier of the audit-log destination these requests were delivered to
	// (AuditLog.Destination.id).
	// A deployment may have several HTTPS-POST destinations, all delivering over
	// the same period; each is charged separately, so this is what keeps their
	// usage items apart. Without it they are identical but for their quantity,
	// and everything downstream that deduplicates on (kind, resource, period) —
	// the usage store and the billing system alike — keeps only one of them.
	DestinationId string `protobuf:"bytes,2,opt,name=destination_id,json=destinationId,proto3" json:"destination_id,omitempty"`
	// contains filtered or unexported fields
}

func (*UsageItem_AuditLogRequests) Descriptor deprecated added in v0.89.22

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

Deprecated: Use UsageItem_AuditLogRequests.ProtoReflect.Descriptor instead.

func (*UsageItem_AuditLogRequests) GetCount added in v0.89.22

func (x *UsageItem_AuditLogRequests) GetCount() int64

func (*UsageItem_AuditLogRequests) GetDestinationId added in v0.89.27

func (x *UsageItem_AuditLogRequests) GetDestinationId() string

func (*UsageItem_AuditLogRequests) ProtoMessage added in v0.89.22

func (*UsageItem_AuditLogRequests) ProtoMessage()

func (*UsageItem_AuditLogRequests) ProtoReflect added in v0.89.22

func (*UsageItem_AuditLogRequests) Reset added in v0.89.22

func (x *UsageItem_AuditLogRequests) Reset()

func (*UsageItem_AuditLogRequests) String added in v0.89.22

func (x *UsageItem_AuditLogRequests) String() string

type UsageItem_AuditLogSize added in v0.58.1

type UsageItem_AuditLogSize struct {

	// Type of destination.
	// Possible values are: "cloud", "https-post"
	DestinationType string `protobuf:"bytes,1,opt,name=destination_type,json=destinationType,proto3" json:"destination_type,omitempty"`
	// Number of events used by audit log.
	// This is the value of DestinationCounters.events (of the timespan covered by this usage item).
	EventCount int64 `protobuf:"varint,11,opt,name=event_count,json=eventCount,proto3" json:"event_count,omitempty"`
	// Number of bytes used by audit log.
	// This is the total of DestinationCounters.bytes_succeeded and bytes_failed (of the timespan covered by this usage item)
	// and depending on the destination type send to the cloud or used as the body of a https post request.
	EventSize int64 `protobuf:"varint,12,opt,name=event_size,json=eventSize,proto3" json:"event_size,omitempty"`
	// Number of https post invocations used by audit log.
	// This is the total of DestinationCounters.https_posts_succeeded and https_posts_failed (of the timespan covered by this usage item).
	// Set when destination_type is "https-post" only
	HttpsPostCount int64 `protobuf:"varint,21,opt,name=https_post_count,json=httpsPostCount,proto3" json:"https_post_count,omitempty"`
	// contains filtered or unexported fields
}

@Deprecated - will be removed in OAS-12028 Amount of audit log related resources used by the resource covered by this usage item.

func (*UsageItem_AuditLogSize) Descriptor deprecated added in v0.58.1

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

Deprecated: Use UsageItem_AuditLogSize.ProtoReflect.Descriptor instead.

func (*UsageItem_AuditLogSize) GetDestinationType added in v0.61.0

func (x *UsageItem_AuditLogSize) GetDestinationType() string

func (*UsageItem_AuditLogSize) GetEventCount added in v0.61.0

func (x *UsageItem_AuditLogSize) GetEventCount() int64

func (*UsageItem_AuditLogSize) GetEventSize added in v0.61.0

func (x *UsageItem_AuditLogSize) GetEventSize() int64

func (*UsageItem_AuditLogSize) GetHttpsPostCount added in v0.58.1

func (x *UsageItem_AuditLogSize) GetHttpsPostCount() int64

func (*UsageItem_AuditLogSize) ProtoMessage added in v0.58.1

func (*UsageItem_AuditLogSize) ProtoMessage()

func (*UsageItem_AuditLogSize) ProtoReflect added in v0.89.0

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

func (*UsageItem_AuditLogSize) Reset added in v0.58.1

func (x *UsageItem_AuditLogSize) Reset()

func (*UsageItem_AuditLogSize) String added in v0.58.1

func (x *UsageItem_AuditLogSize) String() string

type UsageItem_AuditLogStorageSize added in v0.61.0

type UsageItem_AuditLogStorageSize struct {

	// Amount of cloud storage (in bytes) used by audit log.
	CloudStorageSize int64 `protobuf:"varint,1,opt,name=cloud_storage_size,json=cloudStorageSize,proto3" json:"cloud_storage_size,omitempty"`
	// contains filtered or unexported fields
}

@Deprecated - will be removed in OAS-12028 Amount of audit log storage related resources used by the resource covered by this usage item. When this usage type is used, the audit log destination_type is "cloud".

func (*UsageItem_AuditLogStorageSize) Descriptor deprecated added in v0.61.0

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

Deprecated: Use UsageItem_AuditLogStorageSize.ProtoReflect.Descriptor instead.

func (*UsageItem_AuditLogStorageSize) GetCloudStorageSize added in v0.61.0

func (x *UsageItem_AuditLogStorageSize) GetCloudStorageSize() int64

func (*UsageItem_AuditLogStorageSize) ProtoMessage added in v0.61.0

func (*UsageItem_AuditLogStorageSize) ProtoMessage()

func (*UsageItem_AuditLogStorageSize) ProtoReflect added in v0.89.0

func (*UsageItem_AuditLogStorageSize) Reset added in v0.61.0

func (x *UsageItem_AuditLogStorageSize) Reset()

func (*UsageItem_AuditLogStorageSize) String added in v0.61.0

type UsageItem_BackupStorageSize

type UsageItem_BackupStorageSize struct {

	// Amount of cloud storage (in bytes) used by backups of a deployment.
	CloudStorageSize int64 `protobuf:"varint,1,opt,name=cloud_storage_size,json=cloudStorageSize,proto3" json:"cloud_storage_size,omitempty"`
	// Purpose of the cloud storage.
	// Can be 'auditlogs', 'backups', 'platform', etc.
	Purpose string `protobuf:"bytes,2,opt,name=purpose,proto3" json:"purpose,omitempty"`
	// contains filtered or unexported fields
}

@Deprecated - will be removed in OAS-12028 Amount of backup related cloud storage used by the resource covered by this usage item.

func (*UsageItem_BackupStorageSize) Descriptor deprecated

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

Deprecated: Use UsageItem_BackupStorageSize.ProtoReflect.Descriptor instead.

func (*UsageItem_BackupStorageSize) GetCloudStorageSize

func (x *UsageItem_BackupStorageSize) GetCloudStorageSize() int64

func (*UsageItem_BackupStorageSize) GetPurpose added in v0.89.12

func (x *UsageItem_BackupStorageSize) GetPurpose() string

func (*UsageItem_BackupStorageSize) ProtoMessage

func (*UsageItem_BackupStorageSize) ProtoMessage()

func (*UsageItem_BackupStorageSize) ProtoReflect added in v0.89.0

func (*UsageItem_BackupStorageSize) Reset

func (x *UsageItem_BackupStorageSize) Reset()

func (*UsageItem_BackupStorageSize) String

func (x *UsageItem_BackupStorageSize) String() string

type UsageItem_CPUHour added in v0.89.12

type UsageItem_CPUHour struct {

	// Number of CPU hours allocated/used in this usage period.
	CpuHours float64 `protobuf:"fixed64,1,opt,name=cpu_hours,json=cpuHours,proto3" json:"cpu_hours,omitempty"`
	// contains filtered or unexported fields
}

func (*UsageItem_CPUHour) Descriptor deprecated added in v0.89.12

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

Deprecated: Use UsageItem_CPUHour.ProtoReflect.Descriptor instead.

func (*UsageItem_CPUHour) GetCpuHours added in v0.89.12

func (x *UsageItem_CPUHour) GetCpuHours() float64

func (*UsageItem_CPUHour) ProtoMessage added in v0.89.12

func (*UsageItem_CPUHour) ProtoMessage()

func (*UsageItem_CPUHour) ProtoReflect added in v0.89.12

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

func (*UsageItem_CPUHour) Reset added in v0.89.12

func (x *UsageItem_CPUHour) Reset()

func (*UsageItem_CPUHour) String added in v0.89.12

func (x *UsageItem_CPUHour) String() string

type UsageItem_CloudStorageHour added in v0.89.12

type UsageItem_CloudStorageHour struct {

	// Average amount of cloud storage allocated/used during this usage period, in bytes.
	// This value is derived from the average of the cloud storage usage gauge over the covered time range.
	CloudStorageSize int64 `protobuf:"varint,1,opt,name=cloud_storage_size,json=cloudStorageSize,proto3" json:"cloud_storage_size,omitempty"`
	// Optional human-readable breakdown by storage purpose, for example:
	// "Backups: 600.00 MiB, Audit Logs: 120.00 MiB".
	PurposeBreakdown string `protobuf:"bytes,2,opt,name=purpose_breakdown,json=purposeBreakdown,proto3" json:"purpose_breakdown,omitempty"`
	// Billable cloud storage usage during this usage period, in GiB-hours.
	// This value is derived from cloud_storage_size and the duration of the covered time range (24h by default).
	GibHours float64 `protobuf:"fixed64,3,opt,name=gib_hours,json=gibHours,proto3" json:"gib_hours,omitempty"`
	// contains filtered or unexported fields
}

func (*UsageItem_CloudStorageHour) Descriptor deprecated added in v0.89.12

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

Deprecated: Use UsageItem_CloudStorageHour.ProtoReflect.Descriptor instead.

func (*UsageItem_CloudStorageHour) GetCloudStorageSize added in v0.89.12

func (x *UsageItem_CloudStorageHour) GetCloudStorageSize() int64

func (*UsageItem_CloudStorageHour) GetGibHours added in v0.89.13

func (x *UsageItem_CloudStorageHour) GetGibHours() float64

func (*UsageItem_CloudStorageHour) GetPurposeBreakdown added in v0.89.12

func (x *UsageItem_CloudStorageHour) GetPurposeBreakdown() string

func (*UsageItem_CloudStorageHour) ProtoMessage added in v0.89.12

func (*UsageItem_CloudStorageHour) ProtoMessage()

func (*UsageItem_CloudStorageHour) ProtoReflect added in v0.89.12

func (*UsageItem_CloudStorageHour) Reset added in v0.89.12

func (x *UsageItem_CloudStorageHour) Reset()

func (*UsageItem_CloudStorageHour) String added in v0.89.12

func (x *UsageItem_CloudStorageHour) String() string

type UsageItem_DeploymentAEU added in v0.89.12

type UsageItem_DeploymentAEU struct {

	// Number of deployment AEU-hours allocated/used in this usage period.
	DeploymentAeuHours float64 `protobuf:"fixed64,1,opt,name=deployment_aeu_hours,json=deploymentAeuHours,proto3" json:"deployment_aeu_hours,omitempty"`
	// contains filtered or unexported fields
}

func (*UsageItem_DeploymentAEU) Descriptor deprecated added in v0.89.12

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

Deprecated: Use UsageItem_DeploymentAEU.ProtoReflect.Descriptor instead.

func (*UsageItem_DeploymentAEU) GetDeploymentAeuHours added in v0.89.12

func (x *UsageItem_DeploymentAEU) GetDeploymentAeuHours() float64

func (*UsageItem_DeploymentAEU) ProtoMessage added in v0.89.12

func (*UsageItem_DeploymentAEU) ProtoMessage()

func (*UsageItem_DeploymentAEU) ProtoReflect added in v0.89.12

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

func (*UsageItem_DeploymentAEU) Reset added in v0.89.12

func (x *UsageItem_DeploymentAEU) Reset()

func (*UsageItem_DeploymentAEU) String added in v0.89.12

func (x *UsageItem_DeploymentAEU) String() string

type UsageItem_DeploymentSize

type UsageItem_DeploymentSize struct {

	// Number of coordinators of the deployment
	Coordinators int32 `protobuf:"varint,1,opt,name=coordinators,proto3" json:"coordinators,omitempty"`
	// Amount of memory (in GB) allocated for each coordinator.
	CoordinatorMemorySize int32 `` /* 127-byte string literal not displayed */
	// Number of dbservers of the deployment
	Dbservers int32 `protobuf:"varint,11,opt,name=dbservers,proto3" json:"dbservers,omitempty"`
	// Amount of memory (in GB) allocated for each dbserver.
	DbserverMemorySize int32 `protobuf:"varint,12,opt,name=dbserver_memory_size,json=dbserverMemorySize,proto3" json:"dbserver_memory_size,omitempty"`
	// Amount of disk space (in GB) allocated for each dbserver.
	DbserverDiskSize int32 `protobuf:"varint,13,opt,name=dbserver_disk_size,json=dbserverDiskSize,proto3" json:"dbserver_disk_size,omitempty"`
	// Number of agents of the deployment
	Agents int32 `protobuf:"varint,21,opt,name=agents,proto3" json:"agents,omitempty"`
	// Amount of memory (in GB) allocated for each agent.
	AgentMemorySize int32 `protobuf:"varint,22,opt,name=agent_memory_size,json=agentMemorySize,proto3" json:"agent_memory_size,omitempty"`
	// Amount of disk space (in GB) allocated for each agent.
	AgentDiskSize int32 `protobuf:"varint,23,opt,name=agent_disk_size,json=agentDiskSize,proto3" json:"agent_disk_size,omitempty"`
	// Identifier of the node-size used for this deployment (empty for flexible)
	NodeSizeId string `protobuf:"bytes,31,opt,name=node_size_id,json=nodeSizeId,proto3" json:"node_size_id,omitempty"`
	// Identifier of disk performance used for this deployment (if any).
	DiskPerformanceId string `protobuf:"bytes,32,opt,name=disk_performance_id,json=diskPerformanceId,proto3" json:"disk_performance_id,omitempty"`
	// List of identifiers of addons used by the deployment.
	AddonIds []string `protobuf:"bytes,41,rep,name=addon_ids,json=addonIds,proto3" json:"addon_ids,omitempty"`
	// IF true the deployment was in paused state
	IsPaused bool `protobuf:"varint,42,opt,name=is_paused,json=isPaused,proto3" json:"is_paused,omitempty"`
	// Number of gateways of the deployment.
	Gateways int32 `protobuf:"varint,51,opt,name=gateways,proto3" json:"gateways,omitempty"`
	// Amount of memory (in GB) allocated for each gateway.
	GatewayMemorySize float32 `protobuf:"fixed32,52,opt,name=gateway_memory_size,json=gatewayMemorySize,proto3" json:"gateway_memory_size,omitempty"`
	// contains filtered or unexported fields
}

@Deprecated - will be removed in OAS-12028 Amount of (computer) resources used by the resource covered by this usage item.

func (*UsageItem_DeploymentSize) Descriptor deprecated

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

Deprecated: Use UsageItem_DeploymentSize.ProtoReflect.Descriptor instead.

func (*UsageItem_DeploymentSize) GetAddonIds

func (x *UsageItem_DeploymentSize) GetAddonIds() []string

func (*UsageItem_DeploymentSize) GetAgentDiskSize

func (x *UsageItem_DeploymentSize) GetAgentDiskSize() int32

func (*UsageItem_DeploymentSize) GetAgentMemorySize

func (x *UsageItem_DeploymentSize) GetAgentMemorySize() int32

func (*UsageItem_DeploymentSize) GetAgents

func (x *UsageItem_DeploymentSize) GetAgents() int32

func (*UsageItem_DeploymentSize) GetCoordinatorMemorySize

func (x *UsageItem_DeploymentSize) GetCoordinatorMemorySize() int32

func (*UsageItem_DeploymentSize) GetCoordinators

func (x *UsageItem_DeploymentSize) GetCoordinators() int32

func (*UsageItem_DeploymentSize) GetDbserverDiskSize

func (x *UsageItem_DeploymentSize) GetDbserverDiskSize() int32

func (*UsageItem_DeploymentSize) GetDbserverMemorySize

func (x *UsageItem_DeploymentSize) GetDbserverMemorySize() int32

func (*UsageItem_DeploymentSize) GetDbservers

func (x *UsageItem_DeploymentSize) GetDbservers() int32

func (*UsageItem_DeploymentSize) GetDiskPerformanceId added in v0.72.6

func (x *UsageItem_DeploymentSize) GetDiskPerformanceId() string

func (*UsageItem_DeploymentSize) GetGatewayMemorySize added in v0.89.6

func (x *UsageItem_DeploymentSize) GetGatewayMemorySize() float32

func (*UsageItem_DeploymentSize) GetGateways added in v0.89.6

func (x *UsageItem_DeploymentSize) GetGateways() int32

func (*UsageItem_DeploymentSize) GetIsPaused added in v0.74.11

func (x *UsageItem_DeploymentSize) GetIsPaused() bool

func (*UsageItem_DeploymentSize) GetNodeSizeId

func (x *UsageItem_DeploymentSize) GetNodeSizeId() string

func (*UsageItem_DeploymentSize) ProtoMessage

func (*UsageItem_DeploymentSize) ProtoMessage()

func (*UsageItem_DeploymentSize) ProtoReflect added in v0.89.0

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

func (*UsageItem_DeploymentSize) Reset

func (x *UsageItem_DeploymentSize) Reset()

func (*UsageItem_DeploymentSize) String

func (x *UsageItem_DeploymentSize) String() string

type UsageItem_GPUHour added in v0.89.12

type UsageItem_GPUHour struct {

	// Number of GPU hours allocated/used in this usage period.
	GpuHours float64 `protobuf:"fixed64,1,opt,name=gpu_hours,json=gpuHours,proto3" json:"gpu_hours,omitempty"`
	// contains filtered or unexported fields
}

func (*UsageItem_GPUHour) Descriptor deprecated added in v0.89.12

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

Deprecated: Use UsageItem_GPUHour.ProtoReflect.Descriptor instead.

func (*UsageItem_GPUHour) GetGpuHours added in v0.89.12

func (x *UsageItem_GPUHour) GetGpuHours() float64

func (*UsageItem_GPUHour) ProtoMessage added in v0.89.12

func (*UsageItem_GPUHour) ProtoMessage()

func (*UsageItem_GPUHour) ProtoReflect added in v0.89.12

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

func (*UsageItem_GPUHour) Reset added in v0.89.12

func (x *UsageItem_GPUHour) Reset()

func (*UsageItem_GPUHour) String added in v0.89.12

func (x *UsageItem_GPUHour) String() string

type UsageItem_GraphAnalyticsJobSize added in v0.88.6

type UsageItem_GraphAnalyticsJobSize struct {

	// Amount of memory (in GB) allocated for the job.
	MemorySize int32 `protobuf:"varint,1,opt,name=memory_size,json=memorySize,proto3" json:"memory_size,omitempty"`
	// Amount of CPU units allocated to the job.
	// 1 CPU unit equals 1 physical / virtual CPU.
	CpuSize float32 `protobuf:"fixed32,2,opt,name=cpu_size,json=cpuSize,proto3" json:"cpu_size,omitempty"`
	// Amount of GPU units allocated to the job.
	// 1 CPU unit equals 1 physical / virtual GPU.
	GpuSize float32 `protobuf:"fixed32,3,opt,name=gpu_size,json=gpuSize,proto3" json:"gpu_size,omitempty"`
	// ID of the ML job.
	JobId string `protobuf:"bytes,4,opt,name=job_id,json=jobId,proto3" json:"job_id,omitempty"`
	// Type of Graph Analytics job.
	JobType string `protobuf:"bytes,5,opt,name=job_type,json=jobType,proto3" json:"job_type,omitempty"`
	// contains filtered or unexported fields
}

@Deprecated - will be removed in OAS-12028 Amount of compute resources used by a Graph Analytics Job.

func (*UsageItem_GraphAnalyticsJobSize) Descriptor deprecated added in v0.88.6

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

Deprecated: Use UsageItem_GraphAnalyticsJobSize.ProtoReflect.Descriptor instead.

func (*UsageItem_GraphAnalyticsJobSize) GetCpuSize added in v0.88.6

func (x *UsageItem_GraphAnalyticsJobSize) GetCpuSize() float32

func (*UsageItem_GraphAnalyticsJobSize) GetGpuSize added in v0.88.6

func (x *UsageItem_GraphAnalyticsJobSize) GetGpuSize() float32

func (*UsageItem_GraphAnalyticsJobSize) GetJobId added in v0.88.6

func (*UsageItem_GraphAnalyticsJobSize) GetJobType added in v0.88.6

func (x *UsageItem_GraphAnalyticsJobSize) GetJobType() string

func (*UsageItem_GraphAnalyticsJobSize) GetMemorySize added in v0.88.6

func (x *UsageItem_GraphAnalyticsJobSize) GetMemorySize() int32

func (*UsageItem_GraphAnalyticsJobSize) ProtoMessage added in v0.88.6

func (*UsageItem_GraphAnalyticsJobSize) ProtoMessage()

func (*UsageItem_GraphAnalyticsJobSize) ProtoReflect added in v0.89.0

func (*UsageItem_GraphAnalyticsJobSize) Reset added in v0.88.6

func (*UsageItem_GraphAnalyticsJobSize) String added in v0.88.6

type UsageItem_MLJobSize added in v0.88.0

type UsageItem_MLJobSize struct {

	// Amount of memory (in GB) allocated for the job.
	MemorySize int32 `protobuf:"varint,1,opt,name=memory_size,json=memorySize,proto3" json:"memory_size,omitempty"`
	// Amount of CPU units allocated to the job.
	// 1 CPU unit equals 1 physical / virtual CPU.
	CpuSize float32 `protobuf:"fixed32,2,opt,name=cpu_size,json=cpuSize,proto3" json:"cpu_size,omitempty"`
	// Amount of GPU units allocated to the job.
	// 1 CPU unit equals 1 physical / virtual GPU.
	GpuSize float32 `protobuf:"fixed32,3,opt,name=gpu_size,json=gpuSize,proto3" json:"gpu_size,omitempty"`
	// ID of the ML job.
	JobId string `protobuf:"bytes,4,opt,name=job_id,json=jobId,proto3" json:"job_id,omitempty"`
	// Type of ML Job (training, prediction, etc.)
	JobType string `protobuf:"bytes,5,opt,name=job_type,json=jobType,proto3" json:"job_type,omitempty"`
	// contains filtered or unexported fields
}

@Deprecated - will be removed in OAS-12028 Amount of compute resources used by a ML Job.

func (*UsageItem_MLJobSize) Descriptor deprecated added in v0.88.0

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

Deprecated: Use UsageItem_MLJobSize.ProtoReflect.Descriptor instead.

func (*UsageItem_MLJobSize) GetCpuSize added in v0.88.0

func (x *UsageItem_MLJobSize) GetCpuSize() float32

func (*UsageItem_MLJobSize) GetGpuSize added in v0.88.0

func (x *UsageItem_MLJobSize) GetGpuSize() float32

func (*UsageItem_MLJobSize) GetJobId added in v0.88.0

func (x *UsageItem_MLJobSize) GetJobId() string

func (*UsageItem_MLJobSize) GetJobType added in v0.88.0

func (x *UsageItem_MLJobSize) GetJobType() string

func (*UsageItem_MLJobSize) GetMemorySize added in v0.88.0

func (x *UsageItem_MLJobSize) GetMemorySize() int32

func (*UsageItem_MLJobSize) ProtoMessage added in v0.88.0

func (*UsageItem_MLJobSize) ProtoMessage()

func (*UsageItem_MLJobSize) ProtoReflect added in v0.89.0

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

func (*UsageItem_MLJobSize) Reset added in v0.88.0

func (x *UsageItem_MLJobSize) Reset()

func (*UsageItem_MLJobSize) String added in v0.88.0

func (x *UsageItem_MLJobSize) String() string

type UsageItem_MLServicesSize added in v0.79.6

type UsageItem_MLServicesSize struct {

	// Number of training API servers.
	TrainingApis int32 `protobuf:"varint,1,opt,name=training_apis,json=trainingApis,proto3" json:"training_apis,omitempty"`
	// Amount of memory (in GB) allocated for each training API server.
	TrainingApiMemorySize int64 `` /* 129-byte string literal not displayed */
	// Amount of CPU units allocated to the training API server.
	// 1 CPU unit equals 1 physical / virtual CPU.
	TrainingApiCpuSize float32 `protobuf:"fixed32,3,opt,name=training_api_cpu_size,json=trainingApiCpuSize,proto3" json:"training_api_cpu_size,omitempty"`
	// Number of prediction API servers.
	PredictionApis int32 `protobuf:"varint,4,opt,name=prediction_apis,json=predictionApis,proto3" json:"prediction_apis,omitempty"`
	// Amount of memory (in GB) allocated for each prediction API server.
	PredictionApiMemorySize int64 `` /* 135-byte string literal not displayed */
	// Amount of CPU units allocated to the prediction API server.
	// 1 CPU unit equals 1 physical / virtual CPU.
	PredictionApiCpuSize float32 `` /* 127-byte string literal not displayed */
	// Number of projects API servers.
	ProjectsApis int32 `protobuf:"varint,7,opt,name=projects_apis,json=projectsApis,proto3" json:"projects_apis,omitempty"`
	// Amount of memory (in GB) allocated for each projects API server.
	ProjectsApiMemorySize int64 `` /* 129-byte string literal not displayed */
	// Amount of CPU units allocated to the projects API server.
	// 1 CPU unit equals 1 physical / virtual CPU.
	ProjectsApiCpuSize float32 `protobuf:"fixed32,9,opt,name=projects_api_cpu_size,json=projectsApiCpuSize,proto3" json:"projects_api_cpu_size,omitempty"`
	// contains filtered or unexported fields
}

@Deprecated - will be removed in OAS-12028 Amount of compute resources used by a given MLServices resource.

func (*UsageItem_MLServicesSize) Descriptor deprecated added in v0.79.6

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

Deprecated: Use UsageItem_MLServicesSize.ProtoReflect.Descriptor instead.

func (*UsageItem_MLServicesSize) GetPredictionApiCpuSize added in v0.79.6

func (x *UsageItem_MLServicesSize) GetPredictionApiCpuSize() float32

func (*UsageItem_MLServicesSize) GetPredictionApiMemorySize added in v0.79.6

func (x *UsageItem_MLServicesSize) GetPredictionApiMemorySize() int64

func (*UsageItem_MLServicesSize) GetPredictionApis added in v0.79.6

func (x *UsageItem_MLServicesSize) GetPredictionApis() int32

func (*UsageItem_MLServicesSize) GetProjectsApiCpuSize added in v0.79.6

func (x *UsageItem_MLServicesSize) GetProjectsApiCpuSize() float32

func (*UsageItem_MLServicesSize) GetProjectsApiMemorySize added in v0.79.6

func (x *UsageItem_MLServicesSize) GetProjectsApiMemorySize() int64

func (*UsageItem_MLServicesSize) GetProjectsApis added in v0.79.6

func (x *UsageItem_MLServicesSize) GetProjectsApis() int32

func (*UsageItem_MLServicesSize) GetTrainingApiCpuSize added in v0.79.6

func (x *UsageItem_MLServicesSize) GetTrainingApiCpuSize() float32

func (*UsageItem_MLServicesSize) GetTrainingApiMemorySize added in v0.79.6

func (x *UsageItem_MLServicesSize) GetTrainingApiMemorySize() int64

func (*UsageItem_MLServicesSize) GetTrainingApis added in v0.79.6

func (x *UsageItem_MLServicesSize) GetTrainingApis() int32

func (*UsageItem_MLServicesSize) ProtoMessage added in v0.79.6

func (*UsageItem_MLServicesSize) ProtoMessage()

func (*UsageItem_MLServicesSize) ProtoReflect added in v0.89.0

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

func (*UsageItem_MLServicesSize) Reset added in v0.79.6

func (x *UsageItem_MLServicesSize) Reset()

func (*UsageItem_MLServicesSize) String added in v0.79.6

func (x *UsageItem_MLServicesSize) String() string

type UsageItem_MemoryHour added in v0.89.12

type UsageItem_MemoryHour struct {

	// Number of memory GiB hours allocated/used in this usage period.
	MemoryGibHours float64 `protobuf:"fixed64,1,opt,name=memory_gib_hours,json=memoryGibHours,proto3" json:"memory_gib_hours,omitempty"`
	// contains filtered or unexported fields
}

func (*UsageItem_MemoryHour) Descriptor deprecated added in v0.89.12

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

Deprecated: Use UsageItem_MemoryHour.ProtoReflect.Descriptor instead.

func (*UsageItem_MemoryHour) GetMemoryGibHours added in v0.89.12

func (x *UsageItem_MemoryHour) GetMemoryGibHours() float64

func (*UsageItem_MemoryHour) ProtoMessage added in v0.89.12

func (*UsageItem_MemoryHour) ProtoMessage()

func (*UsageItem_MemoryHour) ProtoReflect added in v0.89.12

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

func (*UsageItem_MemoryHour) Reset added in v0.89.12

func (x *UsageItem_MemoryHour) Reset()

func (*UsageItem_MemoryHour) String added in v0.89.12

func (x *UsageItem_MemoryHour) String() string

type UsageItem_NetworkSize added in v0.89.12

type UsageItem_NetworkSize struct {

	// The destination (or source) the network traffic going to (or coming from).
	// Can be 'Internet', 'PrivateEndpoint' or 'InCluster'.
	Destination string `protobuf:"bytes,1,opt,name=destination,proto3" json:"destination,omitempty"`
	// Total amount of network ingress traffic in bytes for the usage period.
	TotalTransferIngressSize int64 `` /* 138-byte string literal not displayed */
	// Total amount of network egress traffic in bytes for the usage period.
	TotalTransferEgressSize int64 `` /* 135-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*UsageItem_NetworkSize) Descriptor deprecated added in v0.89.12

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

Deprecated: Use UsageItem_NetworkSize.ProtoReflect.Descriptor instead.

func (*UsageItem_NetworkSize) GetDestination added in v0.89.12

func (x *UsageItem_NetworkSize) GetDestination() string

func (*UsageItem_NetworkSize) GetTotalTransferEgressSize added in v0.89.12

func (x *UsageItem_NetworkSize) GetTotalTransferEgressSize() int64

func (*UsageItem_NetworkSize) GetTotalTransferIngressSize added in v0.89.12

func (x *UsageItem_NetworkSize) GetTotalTransferIngressSize() int64

func (*UsageItem_NetworkSize) ProtoMessage added in v0.89.12

func (*UsageItem_NetworkSize) ProtoMessage()

func (*UsageItem_NetworkSize) ProtoReflect added in v0.89.12

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

func (*UsageItem_NetworkSize) Reset added in v0.89.12

func (x *UsageItem_NetworkSize) Reset()

func (*UsageItem_NetworkSize) String added in v0.89.12

func (x *UsageItem_NetworkSize) String() string

type UsageItem_NetworkTransferSize

type UsageItem_NetworkTransferSize struct {

	// The destination (or source) the network traffic going to (or coming from)
	// Can be 'Internet' or 'InCluster'
	// An empty string means 'Internet'
	Destination string `protobuf:"bytes,1,opt,name=destination,proto3" json:"destination,omitempty"`
	// Total amount of network ingress traffic (in bytes) caused by the use of a deployment.
	// Destination 'Internet': This is traffic coming from the internet, so excluding inner cluster traffic
	// Destination 'InCluster': This is in-cluster traffic only
	// This is always excluding backup traffic (downloads).
	TotalTransferIngressSize int64 `` /* 138-byte string literal not displayed */
	// Total amount of network egress traffic (in bytes) caused by the use of a deployment.
	// Destination 'Internet': This is traffic going to the internet, so excluding inner cluster traffic
	// Destination 'InCluster': This is in-cluster traffic only
	// This is always excluding backup traffic (uploads).
	TotalTransferEgressSize int64 `` /* 135-byte string literal not displayed */
	// contains filtered or unexported fields
}

@Deprecated - will be removed in OAS-12028 Amount of network traffic used by the resource covered by this usage item.

func (*UsageItem_NetworkTransferSize) Descriptor deprecated

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

Deprecated: Use UsageItem_NetworkTransferSize.ProtoReflect.Descriptor instead.

func (*UsageItem_NetworkTransferSize) GetDestination added in v0.40.2

func (x *UsageItem_NetworkTransferSize) GetDestination() string

func (*UsageItem_NetworkTransferSize) GetTotalTransferEgressSize

func (x *UsageItem_NetworkTransferSize) GetTotalTransferEgressSize() int64

func (*UsageItem_NetworkTransferSize) GetTotalTransferIngressSize

func (x *UsageItem_NetworkTransferSize) GetTotalTransferIngressSize() int64

func (*UsageItem_NetworkTransferSize) ProtoMessage

func (*UsageItem_NetworkTransferSize) ProtoMessage()

func (*UsageItem_NetworkTransferSize) ProtoReflect added in v0.89.0

func (*UsageItem_NetworkTransferSize) Reset

func (x *UsageItem_NetworkTransferSize) Reset()

func (*UsageItem_NetworkTransferSize) String

type UsageItem_NotebookSize added in v0.77.0

type UsageItem_NotebookSize struct {

	// Amount of CPU units allocated to the notebook.
	// 1 CPU unit equals 1 physical / virtual CPU.
	CpuSize float32 `protobuf:"fixed32,1,opt,name=cpu_size,json=cpuSize,proto3" json:"cpu_size,omitempty"`
	// Amount of memory allocated to the notebook (in GiB).
	MemorySize int64 `protobuf:"varint,2,opt,name=memory_size,json=memorySize,proto3" json:"memory_size,omitempty"`
	// Size of the disk allocated to the notebook (in GiB).
	DiskSize int64 `protobuf:"varint,3,opt,name=disk_size,json=diskSize,proto3" json:"disk_size,omitempty"`
	// If the Notebook is paused (Hibernated phase).
	IsPaused bool `protobuf:"varint,4,opt,name=is_paused,json=isPaused,proto3" json:"is_paused,omitempty"`
	// ID of the type of Notebook that is being used.
	NotebookModelId string `protobuf:"bytes,5,opt,name=notebook_model_id,json=notebookModelId,proto3" json:"notebook_model_id,omitempty"`
	// Amount of GPU units allocated to the notebook.
	// 1 GPU unit equals 1 physical / virtual GPU.
	GpuSize float32 `protobuf:"fixed32,6,opt,name=gpu_size,json=gpuSize,proto3" json:"gpu_size,omitempty"`
	// contains filtered or unexported fields
}

@Deprecated - will be removed in OAS-12028 Amount of cloud resources used by a given Notebook. This field is only set when the usage item is of kind NotebookSize.

func (*UsageItem_NotebookSize) Descriptor deprecated added in v0.77.0

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

Deprecated: Use UsageItem_NotebookSize.ProtoReflect.Descriptor instead.

func (*UsageItem_NotebookSize) GetCpuSize added in v0.77.0

func (x *UsageItem_NotebookSize) GetCpuSize() float32

func (*UsageItem_NotebookSize) GetDiskSize added in v0.77.0

func (x *UsageItem_NotebookSize) GetDiskSize() int64

func (*UsageItem_NotebookSize) GetGpuSize added in v0.79.17

func (x *UsageItem_NotebookSize) GetGpuSize() float32

func (*UsageItem_NotebookSize) GetIsPaused added in v0.77.0

func (x *UsageItem_NotebookSize) GetIsPaused() bool

func (*UsageItem_NotebookSize) GetMemorySize added in v0.77.0

func (x *UsageItem_NotebookSize) GetMemorySize() int64

func (*UsageItem_NotebookSize) GetNotebookModelId added in v0.77.7

func (x *UsageItem_NotebookSize) GetNotebookModelId() string

func (*UsageItem_NotebookSize) ProtoMessage added in v0.77.0

func (*UsageItem_NotebookSize) ProtoMessage()

func (*UsageItem_NotebookSize) ProtoReflect added in v0.89.0

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

func (*UsageItem_NotebookSize) Reset added in v0.77.0

func (x *UsageItem_NotebookSize) Reset()

func (*UsageItem_NotebookSize) String added in v0.77.0

func (x *UsageItem_NotebookSize) String() string

type UsageItem_Resource

type UsageItem_Resource struct {

	// System identifier of the resource that this usage item covers.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// URL of the resource that this usage item covers
	Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`
	// Kind of resource that this usage item covers.
	Kind string `protobuf:"bytes,3,opt,name=kind,proto3" json:"kind,omitempty"`
	// Human readable description of the resource that this usage item covers.
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// Identifier of the organization that owns the resource that this usage item covers.
	OrganizationId string `protobuf:"bytes,5,opt,name=organization_id,json=organizationId,proto3" json:"organization_id,omitempty"`
	// @Deprecated - will be removed in OAS-12028
	// Name of the organization that owns the resource that this usage item covers.
	OrganizationName string `protobuf:"bytes,6,opt,name=organization_name,json=organizationName,proto3" json:"organization_name,omitempty"`
	// Identifier of the project that owns the resource that this usage item covers.
	// This field is optional when the kind is AuditLogSize, depending if the audit log is for a deployment (set) or ArangoGraph Insights Platform (empty)
	ProjectId string `protobuf:"bytes,7,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// @Deprecated - will be removed in OAS-12028
	// Name of the project that owns the resource that this usage item covers.
	// This field is optional when the kind is AuditLogSize, depending if the audit log is for a deployment (set) or ArangoGraph Insights Platform (empty)
	ProjectName string `protobuf:"bytes,8,opt,name=project_name,json=projectName,proto3" json:"project_name,omitempty"`
	// Identifier of the deployment that owns the resource that this usage item covers.
	// This field is optional when the kind is AuditLogSize, depending if the audit log is for a deployment (set) or ArangoGraph Insights Platform (empty)
	DeploymentId string `protobuf:"bytes,9,opt,name=deployment_id,json=deploymentId,proto3" json:"deployment_id,omitempty"`
	// @Deprecated - will be removed in OAS-12028
	// Name of the deployment that owns the resource that this usage item covers.
	// This field is optional when the kind is AuditLogSize, depending if the audit log is for a deployment (set) or ArangoGraph Insights Platform (empty)
	DeploymentName string `protobuf:"bytes,10,opt,name=deployment_name,json=deploymentName,proto3" json:"deployment_name,omitempty"`
	// Name of the deployment member that owns the resource that this usage item covers.
	// This field is only set when the usage item is specific for a member of the deployment (e.g. network transfer)
	DeploymentMemberName string `protobuf:"bytes,11,opt,name=deployment_member_name,json=deploymentMemberName,proto3" json:"deployment_member_name,omitempty"`
	// Identifier of the cloud provider that is used to run the deployment.
	// This field is optional when the kind is AuditLogSize, depending if the audit log is for a deployment (set) or ArangoGraph Insights Platform (empty)
	CloudProviderId string `protobuf:"bytes,12,opt,name=cloud_provider_id,json=cloudProviderId,proto3" json:"cloud_provider_id,omitempty"`
	// Identifier of the cloud region that is used to run the deployment.
	// This field is optional when the kind is AuditLogSize, depending if the audit log is for a deployment (set) or ArangoGraph Insights Platform (empty)
	CloudRegionId string `protobuf:"bytes,13,opt,name=cloud_region_id,json=cloudRegionId,proto3" json:"cloud_region_id,omitempty"`
	// Identifier of the support plan that is attached to the deployment.
	// This field is not filled-out when the kind is AuditLogSize
	SupportPlanId string `protobuf:"bytes,14,opt,name=support_plan_id,json=supportPlanId,proto3" json:"support_plan_id,omitempty"`
	// Model of the deployment
	// This field is not filled-out when the kind is AuditLogSize
	DeploymentModel string `protobuf:"bytes,15,opt,name=deployment_model,json=deploymentModel,proto3" json:"deployment_model,omitempty"`
	// Identifier of the PrepaidDeployment that this deployment is attached to (if any)
	PrepaidDeploymentId string `protobuf:"bytes,16,opt,name=prepaid_deployment_id,json=prepaidDeploymentId,proto3" json:"prepaid_deployment_id,omitempty"`
	// Timestamp when the prepaid_deployment starts (relevant when prepaid_deployment_id is set only)
	PrepaidDeploymentStartsAt *timestamppb.Timestamp `` /* 141-byte string literal not displayed */
	// Timestamp when the prepaid_deployment ends (relevant when prepaid_deployment_id is set only)
	PrepaidDeploymentEndsAt *timestamppb.Timestamp `` /* 135-byte string literal not displayed */
	// Identifiers of the credit bundles (if any) that were used to pay for this usage item.
	CreditBundleIds []string `protobuf:"bytes,19,rep,name=credit_bundle_ids,json=creditBundleIds,proto3" json:"credit_bundle_ids,omitempty"`
	// contains filtered or unexported fields
}

func (*UsageItem_Resource) Descriptor deprecated

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

Deprecated: Use UsageItem_Resource.ProtoReflect.Descriptor instead.

func (*UsageItem_Resource) GetCloudProviderId

func (x *UsageItem_Resource) GetCloudProviderId() string

func (*UsageItem_Resource) GetCloudRegionId

func (x *UsageItem_Resource) GetCloudRegionId() string

func (*UsageItem_Resource) GetCreditBundleIds added in v0.81.3

func (x *UsageItem_Resource) GetCreditBundleIds() []string

func (*UsageItem_Resource) GetDeploymentId

func (x *UsageItem_Resource) GetDeploymentId() string

func (*UsageItem_Resource) GetDeploymentMemberName

func (x *UsageItem_Resource) GetDeploymentMemberName() string

func (*UsageItem_Resource) GetDeploymentModel

func (x *UsageItem_Resource) GetDeploymentModel() string

func (*UsageItem_Resource) GetDeploymentName

func (x *UsageItem_Resource) GetDeploymentName() string

func (*UsageItem_Resource) GetDescription

func (x *UsageItem_Resource) GetDescription() string

func (*UsageItem_Resource) GetId

func (x *UsageItem_Resource) GetId() string

func (*UsageItem_Resource) GetKind

func (x *UsageItem_Resource) GetKind() string

func (*UsageItem_Resource) GetOrganizationId

func (x *UsageItem_Resource) GetOrganizationId() string

func (*UsageItem_Resource) GetOrganizationName

func (x *UsageItem_Resource) GetOrganizationName() string

func (*UsageItem_Resource) GetPrepaidDeploymentEndsAt added in v0.70.0

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

func (*UsageItem_Resource) GetPrepaidDeploymentId added in v0.69.0

func (x *UsageItem_Resource) GetPrepaidDeploymentId() string

func (*UsageItem_Resource) GetPrepaidDeploymentStartsAt added in v0.70.0

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

func (*UsageItem_Resource) GetProjectId

func (x *UsageItem_Resource) GetProjectId() string

func (*UsageItem_Resource) GetProjectName

func (x *UsageItem_Resource) GetProjectName() string

func (*UsageItem_Resource) GetSupportPlanId

func (x *UsageItem_Resource) GetSupportPlanId() string

func (*UsageItem_Resource) GetUrl

func (x *UsageItem_Resource) GetUrl() string

func (*UsageItem_Resource) ProtoMessage

func (*UsageItem_Resource) ProtoMessage()

func (*UsageItem_Resource) ProtoReflect added in v0.89.0

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

func (*UsageItem_Resource) Reset

func (x *UsageItem_Resource) Reset()

func (*UsageItem_Resource) String

func (x *UsageItem_Resource) String() string

type UsageItem_StorageHour added in v0.89.12

type UsageItem_StorageHour struct {

	// Number of storage GiB hours allocated/used in this usage period.
	StorageGibHours float64 `protobuf:"fixed64,1,opt,name=storage_gib_hours,json=storageGibHours,proto3" json:"storage_gib_hours,omitempty"`
	// contains filtered or unexported fields
}

func (*UsageItem_StorageHour) Descriptor deprecated added in v0.89.12

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

Deprecated: Use UsageItem_StorageHour.ProtoReflect.Descriptor instead.

func (*UsageItem_StorageHour) GetStorageGibHours added in v0.89.12

func (x *UsageItem_StorageHour) GetStorageGibHours() float64

func (*UsageItem_StorageHour) ProtoMessage added in v0.89.12

func (*UsageItem_StorageHour) ProtoMessage()

func (*UsageItem_StorageHour) ProtoReflect added in v0.89.12

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

func (*UsageItem_StorageHour) Reset added in v0.89.12

func (x *UsageItem_StorageHour) Reset()

func (*UsageItem_StorageHour) String added in v0.89.12

func (x *UsageItem_StorageHour) String() string

type UsageItem_StoragePerformanceHour added in v0.89.12

type UsageItem_StoragePerformanceHour struct {

	// Number of storage performance unit-hours allocated/used in this usage period.
	// One unit is one billable data volume; the value does not depend on volume size.
	StoragePerformanceUnitHours float64 `` /* 148-byte string literal not displayed */
	// Identifier of the disk performance tier the volumes ran at (e.g. "dp30", "dp100").
	// Selects the per-tier rate when the item is priced.
	DiskPerformanceId string `protobuf:"bytes,2,opt,name=disk_performance_id,json=diskPerformanceId,proto3" json:"disk_performance_id,omitempty"`
	// contains filtered or unexported fields
}

func (*UsageItem_StoragePerformanceHour) Descriptor deprecated added in v0.89.12

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

Deprecated: Use UsageItem_StoragePerformanceHour.ProtoReflect.Descriptor instead.

func (*UsageItem_StoragePerformanceHour) GetDiskPerformanceId added in v0.89.25

func (x *UsageItem_StoragePerformanceHour) GetDiskPerformanceId() string

func (*UsageItem_StoragePerformanceHour) GetStoragePerformanceUnitHours added in v0.89.12

func (x *UsageItem_StoragePerformanceHour) GetStoragePerformanceUnitHours() float64

func (*UsageItem_StoragePerformanceHour) ProtoMessage added in v0.89.12

func (*UsageItem_StoragePerformanceHour) ProtoMessage()

func (*UsageItem_StoragePerformanceHour) ProtoReflect added in v0.89.12

func (*UsageItem_StoragePerformanceHour) Reset added in v0.89.12

func (*UsageItem_StoragePerformanceHour) String added in v0.89.12

type UsageServiceClient

type UsageServiceClient 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 UsageItem resources in the organization identified by the given
	// organization ID that match the given criteria.
	// Required permissions:
	// - usage.usageitem.list on the organization identified by the given organization ID
	ListUsageItems(ctx context.Context, in *ListUsageItemsRequest, opts ...grpc.CallOption) (*UsageItemList, error)
	// Fetch aggregated Billing 2.0 credit consumption for the organization
	// identified by the given organization ID.
	// Only Billing 2.0 usage components are included, and usage on non-billable
	// tiers is excluded.
	// Required permissions:
	// - usage.usageitem.list on the organization identified by the given organization ID
	GetCreditUsage(ctx context.Context, in *GetCreditUsageRequest, opts ...grpc.CallOption) (*CreditUsage, error)
}

UsageServiceClient is the client API for UsageService service.

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

type UsageServiceServer

type UsageServiceServer interface {
	// Get the current API version of this service.
	// Required permissions:
	// - None
	GetAPIVersion(context.Context, *v1.Empty) (*v1.Version, error)
	// Fetch all UsageItem resources in the organization identified by the given
	// organization ID that match the given criteria.
	// Required permissions:
	// - usage.usageitem.list on the organization identified by the given organization ID
	ListUsageItems(context.Context, *ListUsageItemsRequest) (*UsageItemList, error)
	// Fetch aggregated Billing 2.0 credit consumption for the organization
	// identified by the given organization ID.
	// Only Billing 2.0 usage components are included, and usage on non-billable
	// tiers is excluded.
	// Required permissions:
	// - usage.usageitem.list on the organization identified by the given organization ID
	GetCreditUsage(context.Context, *GetCreditUsageRequest) (*CreditUsage, error)
}

UsageServiceServer is the server API for UsageService service.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL