v1

package
v0.61.1 Latest Latest
Warning

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

Go to latest
Published: Mar 3, 2021 License: Apache-2.0 Imports: 20 Imported by: 0

Documentation

Overview

Package usage/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 (

	// UsageItemKindDeploymentSize indicates a UsageItem that contains cloud
	// resources for Deployment.
	// UsageItems from this kind will not be closed automatically, so open items can exists.
	UsageItemKindDeploymentSize = "DeploymentSize"
	// UsageItemKindNetworkTransferSize indicates a UsageItem that contains
	// the amount of network traffic caused by a deployment (or member of a deployment).
	// UsageItems from this kind will be closed automatically, so no open items can exists.
	// The timespan of this UsageItem is normally 24h (unless the deployment is deleted)
	UsageItemKindNetworkTransferSize = "NetworkTransferSize"
	// UsageItemKindBackupStorageSize indicates a UsageItem that contains
	// the amount of cloud storage used by backups of a deployment.
	// UsageItems from this kind will not be closed automatically, so open items can exists.
	UsageItemKindBackupStorageSize = "BackupStorageSize"
	// UsageItemKindAuditLogSize indicates a UsageItem that contains
	// the amount of resources used by audit log (of a deployment).
	// UsageItems from 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)
	UsageItemKindAuditLogSize = "AuditLogSize"
	// UsageItemKindAuditLogStorageSize indicates a UsageItem that contains
	// the amount of cloud storage used by audit log (of a deployment).
	// UsageItems from this kind will not be closed automatically, so open items can exists.
	UsageItemKindAuditLogStorageSize = "AuditLogStorageSize"
)
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"
)
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 = 2
	// APIPatchVersion contains patch version of this API
	APIPatchVersion = 0
)
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 (
	ErrInvalidLengthUsage = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowUsage   = fmt.Errorf("proto: integer overflow")
)

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 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.

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 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 *types.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 *types.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"`
	// 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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Request arguments for ListUsageItems

func (*ListUsageItemsRequest) Descriptor

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

func (*ListUsageItemsRequest) GetDeploymentId

func (m *ListUsageItemsRequest) GetDeploymentId() string

func (*ListUsageItemsRequest) GetFrom

func (m *ListUsageItemsRequest) GetFrom() *types.Timestamp

func (*ListUsageItemsRequest) GetHasInvoiceId

func (m *ListUsageItemsRequest) GetHasInvoiceId() bool

func (*ListUsageItemsRequest) GetHasNoInvoiceId

func (m *ListUsageItemsRequest) GetHasNoInvoiceId() bool

func (*ListUsageItemsRequest) GetInvoiceId

func (m *ListUsageItemsRequest) GetInvoiceId() string

func (*ListUsageItemsRequest) GetKind

func (m *ListUsageItemsRequest) GetKind() string

func (*ListUsageItemsRequest) GetOptions

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

func (*ListUsageItemsRequest) GetOrganizationId

func (m *ListUsageItemsRequest) GetOrganizationId() string

func (*ListUsageItemsRequest) GetProjectId

func (m *ListUsageItemsRequest) GetProjectId() string

func (*ListUsageItemsRequest) GetResourceKind

func (m *ListUsageItemsRequest) GetResourceKind() string

func (*ListUsageItemsRequest) GetResourceUrl

func (m *ListUsageItemsRequest) GetResourceUrl() string

func (*ListUsageItemsRequest) GetSortDescending

func (m *ListUsageItemsRequest) GetSortDescending() bool

func (*ListUsageItemsRequest) GetTo

func (*ListUsageItemsRequest) Marshal

func (m *ListUsageItemsRequest) Marshal() (dAtA []byte, err error)

func (*ListUsageItemsRequest) MarshalTo

func (m *ListUsageItemsRequest) MarshalTo(dAtA []byte) (int, error)

func (*ListUsageItemsRequest) MarshalToSizedBuffer

func (m *ListUsageItemsRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ListUsageItemsRequest) ProtoMessage

func (*ListUsageItemsRequest) ProtoMessage()

func (*ListUsageItemsRequest) Reset

func (m *ListUsageItemsRequest) Reset()

func (*ListUsageItemsRequest) Size

func (m *ListUsageItemsRequest) Size() (n int)

func (*ListUsageItemsRequest) String

func (m *ListUsageItemsRequest) String() string

func (*ListUsageItemsRequest) Unmarshal

func (m *ListUsageItemsRequest) Unmarshal(dAtA []byte) error

func (*ListUsageItemsRequest) XXX_DiscardUnknown

func (m *ListUsageItemsRequest) XXX_DiscardUnknown()

func (*ListUsageItemsRequest) XXX_Marshal

func (m *ListUsageItemsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ListUsageItemsRequest) XXX_Merge

func (m *ListUsageItemsRequest) XXX_Merge(src proto.Message)

func (*ListUsageItemsRequest) XXX_Size

func (m *ListUsageItemsRequest) XXX_Size() int

func (*ListUsageItemsRequest) XXX_Unmarshal

func (m *ListUsageItemsRequest) XXX_Unmarshal(b []byte) error

type UnimplementedUsageServiceServer

type UnimplementedUsageServiceServer struct {
}

UnimplementedUsageServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedUsageServiceServer) GetAPIVersion

func (*UnimplementedUsageServiceServer) GetAPIVersion(ctx context.Context, req *v1.Empty) (*v1.Version, error)

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
	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 *types.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 *types.Timestamp `protobuf:"bytes,6,opt,name=ends_at,json=endsAt,proto3" json:"ends_at,omitempty"`
	// 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"`
	// 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.
	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"`
	XXX_NoUnkeyedLiteral struct{}                       `json:"-"`
	XXX_unrecognized     []byte                         `json:"-"`
	XXX_sizecache        int32                          `json:"-"`
}

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

func (*UsageItem) Descriptor

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

func (*UsageItem) GetAuditlogSize added in v0.58.1

func (m *UsageItem) GetAuditlogSize() *UsageItem_AuditLogSize

func (*UsageItem) GetAuditlogStorageSize added in v0.61.0

func (m *UsageItem) GetAuditlogStorageSize() *UsageItem_AuditLogStorageSize

func (*UsageItem) GetBackupStorageSize

func (m *UsageItem) GetBackupStorageSize() *UsageItem_BackupStorageSize

func (*UsageItem) GetDeploymentSize

func (m *UsageItem) GetDeploymentSize() *UsageItem_DeploymentSize

func (*UsageItem) GetEndsAt

func (m *UsageItem) GetEndsAt() *types.Timestamp

func (*UsageItem) GetHasEnded

func (m *UsageItem) GetHasEnded() bool

func (*UsageItem) GetId

func (m *UsageItem) GetId() string

func (*UsageItem) GetInvoiceId

func (m *UsageItem) GetInvoiceId() string

func (*UsageItem) GetKind

func (m *UsageItem) GetKind() string

func (*UsageItem) GetNetworkTransferSize

func (m *UsageItem) GetNetworkTransferSize() *UsageItem_NetworkTransferSize

func (*UsageItem) GetResource

func (m *UsageItem) GetResource() *UsageItem_Resource

func (*UsageItem) GetStartsAt

func (m *UsageItem) GetStartsAt() *types.Timestamp

func (*UsageItem) GetTierId

func (m *UsageItem) GetTierId() string

func (*UsageItem) GetUrl

func (m *UsageItem) GetUrl() string

func (*UsageItem) Marshal

func (m *UsageItem) Marshal() (dAtA []byte, err error)

func (*UsageItem) MarshalTo

func (m *UsageItem) MarshalTo(dAtA []byte) (int, error)

func (*UsageItem) MarshalToSizedBuffer

func (m *UsageItem) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*UsageItem) ProtoMessage

func (*UsageItem) ProtoMessage()

func (*UsageItem) Reset

func (m *UsageItem) Reset()

func (*UsageItem) Size

func (m *UsageItem) Size() (n int)

func (*UsageItem) String

func (m *UsageItem) String() string

func (*UsageItem) Unmarshal

func (m *UsageItem) Unmarshal(dAtA []byte) error

func (*UsageItem) XXX_DiscardUnknown

func (m *UsageItem) XXX_DiscardUnknown()

func (*UsageItem) XXX_Marshal

func (m *UsageItem) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*UsageItem) XXX_Merge

func (m *UsageItem) XXX_Merge(src proto.Message)

func (*UsageItem) XXX_Size

func (m *UsageItem) XXX_Size() int

func (*UsageItem) XXX_Unmarshal

func (m *UsageItem) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{}     `json:"-"`
	XXX_unrecognized     []byte       `json:"-"`
	XXX_sizecache        int32        `json:"-"`
}

List of UsageItems.

func (*UsageItemList) Descriptor

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

func (*UsageItemList) GetItems

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

func (*UsageItemList) Marshal

func (m *UsageItemList) Marshal() (dAtA []byte, err error)

func (*UsageItemList) MarshalTo

func (m *UsageItemList) MarshalTo(dAtA []byte) (int, error)

func (*UsageItemList) MarshalToSizedBuffer

func (m *UsageItemList) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*UsageItemList) ProtoMessage

func (*UsageItemList) ProtoMessage()

func (*UsageItemList) Reset

func (m *UsageItemList) Reset()

func (*UsageItemList) Size

func (m *UsageItemList) Size() (n int)

func (*UsageItemList) String

func (m *UsageItemList) String() string

func (*UsageItemList) Unmarshal

func (m *UsageItemList) Unmarshal(dAtA []byte) error

func (*UsageItemList) XXX_DiscardUnknown

func (m *UsageItemList) XXX_DiscardUnknown()

func (*UsageItemList) XXX_Marshal

func (m *UsageItemList) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*UsageItemList) XXX_Merge

func (m *UsageItemList) XXX_Merge(src proto.Message)

func (*UsageItemList) XXX_Size

func (m *UsageItemList) XXX_Size() int

func (*UsageItemList) XXX_Unmarshal

func (m *UsageItemList) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Amount of audit log related resources used by the resource covered by this usage item.

func (*UsageItem_AuditLogSize) Descriptor added in v0.58.1

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

func (*UsageItem_AuditLogSize) GetDestinationType added in v0.61.0

func (m *UsageItem_AuditLogSize) GetDestinationType() string

func (*UsageItem_AuditLogSize) GetEventCount added in v0.61.0

func (m *UsageItem_AuditLogSize) GetEventCount() int64

func (*UsageItem_AuditLogSize) GetEventSize added in v0.61.0

func (m *UsageItem_AuditLogSize) GetEventSize() int64

func (*UsageItem_AuditLogSize) GetHttpsPostCount added in v0.58.1

func (m *UsageItem_AuditLogSize) GetHttpsPostCount() int64

func (*UsageItem_AuditLogSize) Marshal added in v0.58.1

func (m *UsageItem_AuditLogSize) Marshal() (dAtA []byte, err error)

func (*UsageItem_AuditLogSize) MarshalTo added in v0.58.1

func (m *UsageItem_AuditLogSize) MarshalTo(dAtA []byte) (int, error)

func (*UsageItem_AuditLogSize) MarshalToSizedBuffer added in v0.58.1

func (m *UsageItem_AuditLogSize) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*UsageItem_AuditLogSize) ProtoMessage added in v0.58.1

func (*UsageItem_AuditLogSize) ProtoMessage()

func (*UsageItem_AuditLogSize) Reset added in v0.58.1

func (m *UsageItem_AuditLogSize) Reset()

func (*UsageItem_AuditLogSize) Size added in v0.58.1

func (m *UsageItem_AuditLogSize) Size() (n int)

func (*UsageItem_AuditLogSize) String added in v0.58.1

func (m *UsageItem_AuditLogSize) String() string

func (*UsageItem_AuditLogSize) Unmarshal added in v0.58.1

func (m *UsageItem_AuditLogSize) Unmarshal(dAtA []byte) error

func (*UsageItem_AuditLogSize) XXX_DiscardUnknown added in v0.58.1

func (m *UsageItem_AuditLogSize) XXX_DiscardUnknown()

func (*UsageItem_AuditLogSize) XXX_Marshal added in v0.58.1

func (m *UsageItem_AuditLogSize) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*UsageItem_AuditLogSize) XXX_Merge added in v0.58.1

func (m *UsageItem_AuditLogSize) XXX_Merge(src proto.Message)

func (*UsageItem_AuditLogSize) XXX_Size added in v0.58.1

func (m *UsageItem_AuditLogSize) XXX_Size() int

func (*UsageItem_AuditLogSize) XXX_Unmarshal added in v0.58.1

func (m *UsageItem_AuditLogSize) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

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 added in v0.61.0

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

func (*UsageItem_AuditLogStorageSize) GetCloudStorageSize added in v0.61.0

func (m *UsageItem_AuditLogStorageSize) GetCloudStorageSize() int64

func (*UsageItem_AuditLogStorageSize) Marshal added in v0.61.0

func (m *UsageItem_AuditLogStorageSize) Marshal() (dAtA []byte, err error)

func (*UsageItem_AuditLogStorageSize) MarshalTo added in v0.61.0

func (m *UsageItem_AuditLogStorageSize) MarshalTo(dAtA []byte) (int, error)

func (*UsageItem_AuditLogStorageSize) MarshalToSizedBuffer added in v0.61.0

func (m *UsageItem_AuditLogStorageSize) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*UsageItem_AuditLogStorageSize) ProtoMessage added in v0.61.0

func (*UsageItem_AuditLogStorageSize) ProtoMessage()

func (*UsageItem_AuditLogStorageSize) Reset added in v0.61.0

func (m *UsageItem_AuditLogStorageSize) Reset()

func (*UsageItem_AuditLogStorageSize) Size added in v0.61.0

func (m *UsageItem_AuditLogStorageSize) Size() (n int)

func (*UsageItem_AuditLogStorageSize) String added in v0.61.0

func (*UsageItem_AuditLogStorageSize) Unmarshal added in v0.61.0

func (m *UsageItem_AuditLogStorageSize) Unmarshal(dAtA []byte) error

func (*UsageItem_AuditLogStorageSize) XXX_DiscardUnknown added in v0.61.0

func (m *UsageItem_AuditLogStorageSize) XXX_DiscardUnknown()

func (*UsageItem_AuditLogStorageSize) XXX_Marshal added in v0.61.0

func (m *UsageItem_AuditLogStorageSize) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*UsageItem_AuditLogStorageSize) XXX_Merge added in v0.61.0

func (m *UsageItem_AuditLogStorageSize) XXX_Merge(src proto.Message)

func (*UsageItem_AuditLogStorageSize) XXX_Size added in v0.61.0

func (m *UsageItem_AuditLogStorageSize) XXX_Size() int

func (*UsageItem_AuditLogStorageSize) XXX_Unmarshal added in v0.61.0

func (m *UsageItem_AuditLogStorageSize) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Amount of backup related cloud storage used by the resource covered by this usage item.

func (*UsageItem_BackupStorageSize) Descriptor

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

func (*UsageItem_BackupStorageSize) GetCloudStorageSize

func (m *UsageItem_BackupStorageSize) GetCloudStorageSize() int64

func (*UsageItem_BackupStorageSize) Marshal

func (m *UsageItem_BackupStorageSize) Marshal() (dAtA []byte, err error)

func (*UsageItem_BackupStorageSize) MarshalTo

func (m *UsageItem_BackupStorageSize) MarshalTo(dAtA []byte) (int, error)

func (*UsageItem_BackupStorageSize) MarshalToSizedBuffer

func (m *UsageItem_BackupStorageSize) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*UsageItem_BackupStorageSize) ProtoMessage

func (*UsageItem_BackupStorageSize) ProtoMessage()

func (*UsageItem_BackupStorageSize) Reset

func (m *UsageItem_BackupStorageSize) Reset()

func (*UsageItem_BackupStorageSize) Size

func (m *UsageItem_BackupStorageSize) Size() (n int)

func (*UsageItem_BackupStorageSize) String

func (m *UsageItem_BackupStorageSize) String() string

func (*UsageItem_BackupStorageSize) Unmarshal

func (m *UsageItem_BackupStorageSize) Unmarshal(dAtA []byte) error

func (*UsageItem_BackupStorageSize) XXX_DiscardUnknown

func (m *UsageItem_BackupStorageSize) XXX_DiscardUnknown()

func (*UsageItem_BackupStorageSize) XXX_Marshal

func (m *UsageItem_BackupStorageSize) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*UsageItem_BackupStorageSize) XXX_Merge

func (m *UsageItem_BackupStorageSize) XXX_Merge(src proto.Message)

func (*UsageItem_BackupStorageSize) XXX_Size

func (m *UsageItem_BackupStorageSize) XXX_Size() int

func (*UsageItem_BackupStorageSize) XXX_Unmarshal

func (m *UsageItem_BackupStorageSize) XXX_Unmarshal(b []byte) error

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"`
	// 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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Amount of (computer) resources used by the resource covered by this usage item.

func (*UsageItem_DeploymentSize) Descriptor

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

func (*UsageItem_DeploymentSize) GetAddonIds

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

func (*UsageItem_DeploymentSize) GetAgentDiskSize

func (m *UsageItem_DeploymentSize) GetAgentDiskSize() int32

func (*UsageItem_DeploymentSize) GetAgentMemorySize

func (m *UsageItem_DeploymentSize) GetAgentMemorySize() int32

func (*UsageItem_DeploymentSize) GetAgents

func (m *UsageItem_DeploymentSize) GetAgents() int32

func (*UsageItem_DeploymentSize) GetCoordinatorMemorySize

func (m *UsageItem_DeploymentSize) GetCoordinatorMemorySize() int32

func (*UsageItem_DeploymentSize) GetCoordinators

func (m *UsageItem_DeploymentSize) GetCoordinators() int32

func (*UsageItem_DeploymentSize) GetDbserverDiskSize

func (m *UsageItem_DeploymentSize) GetDbserverDiskSize() int32

func (*UsageItem_DeploymentSize) GetDbserverMemorySize

func (m *UsageItem_DeploymentSize) GetDbserverMemorySize() int32

func (*UsageItem_DeploymentSize) GetDbservers

func (m *UsageItem_DeploymentSize) GetDbservers() int32

func (*UsageItem_DeploymentSize) GetNodeSizeId

func (m *UsageItem_DeploymentSize) GetNodeSizeId() string

func (*UsageItem_DeploymentSize) Marshal

func (m *UsageItem_DeploymentSize) Marshal() (dAtA []byte, err error)

func (*UsageItem_DeploymentSize) MarshalTo

func (m *UsageItem_DeploymentSize) MarshalTo(dAtA []byte) (int, error)

func (*UsageItem_DeploymentSize) MarshalToSizedBuffer

func (m *UsageItem_DeploymentSize) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*UsageItem_DeploymentSize) ProtoMessage

func (*UsageItem_DeploymentSize) ProtoMessage()

func (*UsageItem_DeploymentSize) Reset

func (m *UsageItem_DeploymentSize) Reset()

func (*UsageItem_DeploymentSize) Size

func (m *UsageItem_DeploymentSize) Size() (n int)

func (*UsageItem_DeploymentSize) String

func (m *UsageItem_DeploymentSize) String() string

func (*UsageItem_DeploymentSize) Unmarshal

func (m *UsageItem_DeploymentSize) Unmarshal(dAtA []byte) error

func (*UsageItem_DeploymentSize) XXX_DiscardUnknown

func (m *UsageItem_DeploymentSize) XXX_DiscardUnknown()

func (*UsageItem_DeploymentSize) XXX_Marshal

func (m *UsageItem_DeploymentSize) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*UsageItem_DeploymentSize) XXX_Merge

func (m *UsageItem_DeploymentSize) XXX_Merge(src proto.Message)

func (*UsageItem_DeploymentSize) XXX_Size

func (m *UsageItem_DeploymentSize) XXX_Size() int

func (*UsageItem_DeploymentSize) XXX_Unmarshal

func (m *UsageItem_DeploymentSize) XXX_Unmarshal(b []byte) error

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 */
	XXX_NoUnkeyedLiteral    struct{} `json:"-"`
	XXX_unrecognized        []byte   `json:"-"`
	XXX_sizecache           int32    `json:"-"`
}

Amount of network traffic used by the resource covered by this usage item.

func (*UsageItem_NetworkTransferSize) Descriptor

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

func (*UsageItem_NetworkTransferSize) GetDestination added in v0.40.2

func (m *UsageItem_NetworkTransferSize) GetDestination() string

func (*UsageItem_NetworkTransferSize) GetTotalTransferEgressSize

func (m *UsageItem_NetworkTransferSize) GetTotalTransferEgressSize() int64

func (*UsageItem_NetworkTransferSize) GetTotalTransferIngressSize

func (m *UsageItem_NetworkTransferSize) GetTotalTransferIngressSize() int64

func (*UsageItem_NetworkTransferSize) Marshal

func (m *UsageItem_NetworkTransferSize) Marshal() (dAtA []byte, err error)

func (*UsageItem_NetworkTransferSize) MarshalTo

func (m *UsageItem_NetworkTransferSize) MarshalTo(dAtA []byte) (int, error)

func (*UsageItem_NetworkTransferSize) MarshalToSizedBuffer

func (m *UsageItem_NetworkTransferSize) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*UsageItem_NetworkTransferSize) ProtoMessage

func (*UsageItem_NetworkTransferSize) ProtoMessage()

func (*UsageItem_NetworkTransferSize) Reset

func (m *UsageItem_NetworkTransferSize) Reset()

func (*UsageItem_NetworkTransferSize) Size

func (m *UsageItem_NetworkTransferSize) Size() (n int)

func (*UsageItem_NetworkTransferSize) String

func (*UsageItem_NetworkTransferSize) Unmarshal

func (m *UsageItem_NetworkTransferSize) Unmarshal(dAtA []byte) error

func (*UsageItem_NetworkTransferSize) XXX_DiscardUnknown

func (m *UsageItem_NetworkTransferSize) XXX_DiscardUnknown()

func (*UsageItem_NetworkTransferSize) XXX_Marshal

func (m *UsageItem_NetworkTransferSize) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*UsageItem_NetworkTransferSize) XXX_Merge

func (m *UsageItem_NetworkTransferSize) XXX_Merge(src proto.Message)

func (*UsageItem_NetworkTransferSize) XXX_Size

func (m *UsageItem_NetworkTransferSize) XXX_Size() int

func (*UsageItem_NetworkTransferSize) XXX_Unmarshal

func (m *UsageItem_NetworkTransferSize) XXX_Unmarshal(b []byte) error

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"`
	// 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 Oasis platform (empty)
	ProjectId string `protobuf:"bytes,7,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// 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 Oasis 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 Oasis platform (empty)
	DeploymentId string `protobuf:"bytes,9,opt,name=deployment_id,json=deploymentId,proto3" json:"deployment_id,omitempty"`
	// 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 Oasis 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 Oasis 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 Oasis 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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*UsageItem_Resource) Descriptor

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

func (*UsageItem_Resource) GetCloudProviderId

func (m *UsageItem_Resource) GetCloudProviderId() string

func (*UsageItem_Resource) GetCloudRegionId

func (m *UsageItem_Resource) GetCloudRegionId() string

func (*UsageItem_Resource) GetDeploymentId

func (m *UsageItem_Resource) GetDeploymentId() string

func (*UsageItem_Resource) GetDeploymentMemberName

func (m *UsageItem_Resource) GetDeploymentMemberName() string

func (*UsageItem_Resource) GetDeploymentModel

func (m *UsageItem_Resource) GetDeploymentModel() string

func (*UsageItem_Resource) GetDeploymentName

func (m *UsageItem_Resource) GetDeploymentName() string

func (*UsageItem_Resource) GetDescription

func (m *UsageItem_Resource) GetDescription() string

func (*UsageItem_Resource) GetId

func (m *UsageItem_Resource) GetId() string

func (*UsageItem_Resource) GetKind

func (m *UsageItem_Resource) GetKind() string

func (*UsageItem_Resource) GetOrganizationId

func (m *UsageItem_Resource) GetOrganizationId() string

func (*UsageItem_Resource) GetOrganizationName

func (m *UsageItem_Resource) GetOrganizationName() string

func (*UsageItem_Resource) GetProjectId

func (m *UsageItem_Resource) GetProjectId() string

func (*UsageItem_Resource) GetProjectName

func (m *UsageItem_Resource) GetProjectName() string

func (*UsageItem_Resource) GetSupportPlanId

func (m *UsageItem_Resource) GetSupportPlanId() string

func (*UsageItem_Resource) GetUrl

func (m *UsageItem_Resource) GetUrl() string

func (*UsageItem_Resource) Marshal

func (m *UsageItem_Resource) Marshal() (dAtA []byte, err error)

func (*UsageItem_Resource) MarshalTo

func (m *UsageItem_Resource) MarshalTo(dAtA []byte) (int, error)

func (*UsageItem_Resource) MarshalToSizedBuffer

func (m *UsageItem_Resource) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*UsageItem_Resource) ProtoMessage

func (*UsageItem_Resource) ProtoMessage()

func (*UsageItem_Resource) Reset

func (m *UsageItem_Resource) Reset()

func (*UsageItem_Resource) Size

func (m *UsageItem_Resource) Size() (n int)

func (*UsageItem_Resource) String

func (m *UsageItem_Resource) String() string

func (*UsageItem_Resource) Unmarshal

func (m *UsageItem_Resource) Unmarshal(dAtA []byte) error

func (*UsageItem_Resource) XXX_DiscardUnknown

func (m *UsageItem_Resource) XXX_DiscardUnknown()

func (*UsageItem_Resource) XXX_Marshal

func (m *UsageItem_Resource) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*UsageItem_Resource) XXX_Merge

func (m *UsageItem_Resource) XXX_Merge(src proto.Message)

func (*UsageItem_Resource) XXX_Size

func (m *UsageItem_Resource) XXX_Size() int

func (*UsageItem_Resource) XXX_Unmarshal

func (m *UsageItem_Resource) XXX_Unmarshal(b []byte) error

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)
}

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.

func NewUsageServiceClient

func NewUsageServiceClient(cc *grpc.ClientConn) UsageServiceClient

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)
}

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