v1

package
v0.88.9 Latest Latest
Warning

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

 Go to latest Published: Apr 11, 2024 License: Apache-2.0 Imports: 20 Imported by: 0

Documentation

Overview

Package v1 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Package credits/v1 contains the API of Credits services.

Index

Constants

View Source 
const (

	// EventTypeCreditBundleCreated is the type of event fired after a credit bundle is created.
	// SubjectID contains the ID of the credit bundle.
	EventTypeCreditBundleCreated = "credit.creditbundle.created"
	// EventTypeCreditBundleCreated is the type of event fired after a credit bundle is updated.
	// SubjectID contains the ID of the credit bundle.
	EventTypeCreditBundleUpdated = "credit.creditbundle.updated"
	// EventTypeCreditBundleCreated is the type of event fired after a credit bundle is deleted.
	// SubjectID contains the ID of the credit bundle.
	EventTypeCreditBundleDeleted = "credit.creditbundle.deleted"
)
View Source 
const (

	// PermissionCreditUsageReportList is needed for listing credit usage reports.
	PermissionCreditUsageReportList = "credit.creditusagereport.list"
	// PermissionCreditUsageReportGet is needed for getting a single credit usage report.
	PermissionCreditUsageReportGet = "credit.creditusagereport.get"
)
View Source 
const (
	// KindCreditBundle is a constant for the kind of CreditBundle resources.
	KindCreditBundle = "CreditBundle"
	// KindCreditUsageReport is a constant for the kind of CreditUsageReport resources.
	KindCreditUsageReport = "CreditUsageReport"
)
View Source 
const (
	// APIID contains identifier of this API
	APIID = "credits/v1"
	// APIMajorVersion contains major version of this API
	APIMajorVersion = 1
	// APIMinorVersion contains minor version of this API
	APIMinorVersion = 4
	// APIPatchVersion contains patch version of this API
	APIPatchVersion = 0
)
View Source 
const (

	// PermissionCreditBundlesList is needed for listing credit bundles.
	PermissionCreditBundleList = "credit.creditbundle.list"
)
View Source 
const (

	// PermissionCreditBundlesList is needed for listing credit bundle usages.
	PermissionCreditBundleUsageList = "credit.creditbundleusage.list"
)
View Source 
const (

	// PermissionCreditDebtGet is needed for getting credit debt.
	PermissionCreditDebtGet = "credit.creditdebt.get"
)
View Source 
const (

	// PermissionCreditUsageProjectionGet is needed for getting credit usage projection.
	PermissionCreditUsageProjectionGet = "credit.creditbundleusageprojection.get"
)

Variables

View Source 
var (
	ErrInvalidLengthCredits        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowCredits          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupCredits = fmt.Errorf("proto: unexpected end of group")
)

Functions

func CreditBundleURL 

func CreditBundleURL(organizationURL, bundleID string) string

CreditBundleURL creates a resource URL for a credit bundle with the given ID.

func CreditUsageReportURL added in v0.82.0 

func CreditUsageReportURL(organizationURL, reportID string) string

CreditUsageReportURL creates a resource URL for a credit usage report with the given ID.

func ForEachCreditUsage added in v0.82.0 

func ForEachCreditUsage(
	ctx context.Context,
	listFunc func(ctx context.Context, req *ListCreditBundleUsageRequest) (*CreditBundleUsageList, error),
	req *ListCreditBundleUsageRequest,
	cb CreditUsageCallback,
) error

ForEachCreditUsage iterates over all credit usages that match the given filter, and invoke the callback for each item.

func ForEachCreditUsageReport added in v0.82.0 

func ForEachCreditUsageReport(
	ctx context.Context,
	listFunc func(ctx context.Context, req *ListCreditUsageReportsRequest) (*CreditUsageReportList, error),
	req *ListCreditUsageReportsRequest,
	cb CreditUsageReportCallback,
) error

ForEachCreditUsageReport iterates over all credit usage reports that match the given filter, and invoke the callback for each item.

func RegisterCreditsServiceHandler 

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

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

func RegisterCreditsServiceHandlerClient 

func RegisterCreditsServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client CreditsServiceClient) error

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

func RegisterCreditsServiceHandlerFromEndpoint 

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

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

func RegisterCreditsServiceHandlerServer 

func RegisterCreditsServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server CreditsServiceServer) error

RegisterCreditsServiceHandlerServer registers the http handlers for service CreditsService to "mux". UnaryRPC :call CreditsServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906.

func RegisterCreditsServiceServer 

func RegisterCreditsServiceServer(s *grpc.Server, srv CreditsServiceServer)

Types

type CreditBundle 

type CreditBundle struct {
	// ID of the credit bundle.
	// This is a read-only value.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// URL of this credit bundle.
	// This is a read-only value.
	Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`
	// The organization this credit bundle belongs to.
	// This is a read-only value.
	OrganizationId string `protobuf:"bytes,4,opt,name=organization_id,json=organizationId,proto3" json:"organization_id,omitempty"`
	// The number of credits purchased in this bundle.
	// This is a read-only value.
	CreditsPurchased float32 `protobuf:"fixed32,5,opt,name=credits_purchased,json=creditsPurchased,proto3" json:"credits_purchased,omitempty"`
	// The total price of these credits.
	// This is a read-only value.
	TotalPrice float32 `protobuf:"fixed32,6,opt,name=total_price,json=totalPrice,proto3" json:"total_price,omitempty"`
	// Currency used for total_price.
	// This is a read-only value.
	Currency string `protobuf:"bytes,7,opt,name=currency,proto3" json:"currency,omitempty"`
	// The number of credits remaining in this bundle.
	// This is a read-only value.
	CreditsRemaining float32 `protobuf:"fixed32,8,opt,name=credits_remaining,json=creditsRemaining,proto3" json:"credits_remaining,omitempty"`
	// The date at which this bundle was purchased.
	// This is a read-only value.
	PurchasedAt *types.Timestamp `protobuf:"bytes,9,opt,name=purchased_at,json=purchasedAt,proto3" json:"purchased_at,omitempty"`
	// The date from which this bundle is valid.
	// This is a read-only value.
	ValidFrom *types.Timestamp `protobuf:"bytes,10,opt,name=valid_from,json=validFrom,proto3" json:"valid_from,omitempty"`
	// The date until which this bundle is valid.
	// This is a read-only value.
	ValidUntil *types.Timestamp `protobuf:"bytes,11,opt,name=valid_until,json=validUntil,proto3" json:"valid_until,omitempty"`
	// Timestamp of when this credit bundle was last used.
	LastUsedAt           *types.Timestamp `protobuf:"bytes,12,opt,name=last_used_at,json=lastUsedAt,proto3" json:"last_used_at,omitempty"`
	XXX_NoUnkeyedLiteral struct{}         `json:"-"`
	XXX_unrecognized     []byte           `json:"-"`
	XXX_sizecache        int32            `json:"-"`
}

func (*CreditBundle) Descriptor 

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

func (*CreditBundle) GetCreditsPurchased 

func (m *CreditBundle) GetCreditsPurchased() float32

func (*CreditBundle) GetCreditsRemaining 

func (m *CreditBundle) GetCreditsRemaining() float32

func (*CreditBundle) GetCurrency 

func (m *CreditBundle) GetCurrency() string

func (*CreditBundle) GetId 

func (m *CreditBundle) GetId() string

func (*CreditBundle) GetLastUsedAt added in v0.80.1 

func (m *CreditBundle) GetLastUsedAt() *types.Timestamp

func (*CreditBundle) GetOrganizationId 

func (m *CreditBundle) GetOrganizationId() string

func (*CreditBundle) GetPurchasedAt 

func (m *CreditBundle) GetPurchasedAt() *types.Timestamp

func (*CreditBundle) GetTotalPrice 

func (m *CreditBundle) GetTotalPrice() float32

func (*CreditBundle) GetUrl 

func (m *CreditBundle) GetUrl() string

func (*CreditBundle) GetValidFrom 

func (m *CreditBundle) GetValidFrom() *types.Timestamp

func (*CreditBundle) GetValidUntil 

func (m *CreditBundle) GetValidUntil() *types.Timestamp

func (*CreditBundle) IsExpired 

func (bundle *CreditBundle) IsExpired() bool

IsExpired returns true if a credit bundle is expired.

func (*CreditBundle) IsUsed 

func (bundle *CreditBundle) IsUsed() bool

IsUsed returns true if a credit bundle has been used.

func (*CreditBundle) Marshal 

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

func (*CreditBundle) MarshalTo 

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

func (*CreditBundle) MarshalToSizedBuffer 

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

func (*CreditBundle) ProtoMessage 

func (*CreditBundle) ProtoMessage()

func (*CreditBundle) Reset 

func (m *CreditBundle) Reset()

func (*CreditBundle) Size 

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

func (*CreditBundle) String 

func (m *CreditBundle) String() string

func (*CreditBundle) Unmarshal 

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

func (*CreditBundle) XXX_DiscardUnknown 

func (m *CreditBundle) XXX_DiscardUnknown()

func (*CreditBundle) XXX_Marshal 

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

func (*CreditBundle) XXX_Merge 

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

func (*CreditBundle) XXX_Size 

func (m *CreditBundle) XXX_Size() int

func (*CreditBundle) XXX_Unmarshal 

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

type CreditBundleUsage added in v0.80.1 

type CreditBundleUsage struct {
	// Unique identifier of this credit bundle usage.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// ID of the usage item this credit bundle usage corresponds to.
	UsageItemId string `protobuf:"bytes,2,opt,name=usage_item_id,json=usageItemId,proto3" json:"usage_item_id,omitempty"`
	// ID of the credit bundle from which credit was used.
	CreditBundleId string `protobuf:"bytes,3,opt,name=credit_bundle_id,json=creditBundleId,proto3" json:"credit_bundle_id,omitempty"`
	// ID of the organization this credit bundle (and usage) belongs to.
	OrganizationId string `protobuf:"bytes,4,opt,name=organization_id,json=organizationId,proto3" json:"organization_id,omitempty"`
	// Amount of credits used from the specified credit_bundle_id.
	Usage float32 `protobuf:"fixed32,5,opt,name=usage,proto3" json:"usage,omitempty"`
	// Amount of credits remaining after this usage.
	Remaining float32 `protobuf:"fixed32,6,opt,name=remaining,proto3" json:"remaining,omitempty"`
	// Timestamp at which this credit usage was created.
	CreatedAt            *types.Timestamp `protobuf:"bytes,7,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	XXX_NoUnkeyedLiteral struct{}         `json:"-"`
	XXX_unrecognized     []byte           `json:"-"`
	XXX_sizecache        int32            `json:"-"`
}

Usage of credit bundle. All fields are read-only.

func (*CreditBundleUsage) Descriptor added in v0.80.1 

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

func (*CreditBundleUsage) GetCreatedAt added in v0.80.1 

func (m *CreditBundleUsage) GetCreatedAt() *types.Timestamp

func (*CreditBundleUsage) GetCreditBundleId added in v0.80.1 

func (m *CreditBundleUsage) GetCreditBundleId() string

func (*CreditBundleUsage) GetId added in v0.80.1 

func (m *CreditBundleUsage) GetId() string

func (*CreditBundleUsage) GetOrganizationId added in v0.80.1 

func (m *CreditBundleUsage) GetOrganizationId() string

func (*CreditBundleUsage) GetRemaining added in v0.80.1 

func (m *CreditBundleUsage) GetRemaining() float32

func (*CreditBundleUsage) GetUsage added in v0.80.1 

func (m *CreditBundleUsage) GetUsage() float32

func (*CreditBundleUsage) GetUsageItemId added in v0.80.1 

func (m *CreditBundleUsage) GetUsageItemId() string

func (*CreditBundleUsage) Marshal added in v0.80.1 

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

func (*CreditBundleUsage) MarshalTo added in v0.80.1 

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

func (*CreditBundleUsage) MarshalToSizedBuffer added in v0.80.1 

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

func (*CreditBundleUsage) ProtoMessage added in v0.80.1 

func (*CreditBundleUsage) ProtoMessage()

func (*CreditBundleUsage) Reset added in v0.80.1 

func (m *CreditBundleUsage) Reset()

func (*CreditBundleUsage) Size added in v0.80.1 

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

func (*CreditBundleUsage) String added in v0.80.1 

func (m *CreditBundleUsage) String() string

func (*CreditBundleUsage) Unmarshal added in v0.80.1 

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

func (*CreditBundleUsage) XXX_DiscardUnknown added in v0.80.1 

func (m *CreditBundleUsage) XXX_DiscardUnknown()

func (*CreditBundleUsage) XXX_Marshal added in v0.80.1 

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

func (*CreditBundleUsage) XXX_Merge added in v0.80.1 

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

func (*CreditBundleUsage) XXX_Size added in v0.80.1 

func (m *CreditBundleUsage) XXX_Size() int

func (*CreditBundleUsage) XXX_Unmarshal added in v0.80.1 

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

type CreditBundleUsageList added in v0.80.1 

type CreditBundleUsageList struct {
	Items                []*CreditBundleUsage `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	XXX_NoUnkeyedLiteral struct{}             `json:"-"`
	XXX_unrecognized     []byte               `json:"-"`
	XXX_sizecache        int32                `json:"-"`
}

List of CreditBundleUsages.

func (*CreditBundleUsageList) Descriptor added in v0.80.1 

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

func (*CreditBundleUsageList) GetItems added in v0.80.1 

func (m *CreditBundleUsageList) GetItems() []*CreditBundleUsage

func (*CreditBundleUsageList) Marshal added in v0.80.1 

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

func (*CreditBundleUsageList) MarshalTo added in v0.80.1 

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

func (*CreditBundleUsageList) MarshalToSizedBuffer added in v0.80.1 

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

func (*CreditBundleUsageList) ProtoMessage added in v0.80.1 

func (*CreditBundleUsageList) ProtoMessage()

func (*CreditBundleUsageList) Reset added in v0.80.1 

func (m *CreditBundleUsageList) Reset()

func (*CreditBundleUsageList) Size added in v0.80.1 

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

func (*CreditBundleUsageList) String added in v0.80.1 

func (m *CreditBundleUsageList) String() string

func (*CreditBundleUsageList) Unmarshal added in v0.80.1 

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

func (*CreditBundleUsageList) XXX_DiscardUnknown added in v0.80.1 

func (m *CreditBundleUsageList) XXX_DiscardUnknown()

func (*CreditBundleUsageList) XXX_Marshal added in v0.80.1 

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

func (*CreditBundleUsageList) XXX_Merge added in v0.80.1 

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

func (*CreditBundleUsageList) XXX_Size added in v0.80.1 

func (m *CreditBundleUsageList) XXX_Size() int

func (*CreditBundleUsageList) XXX_Unmarshal added in v0.80.1 

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

type CreditBundleUsageProjection added in v0.82.1 

type CreditBundleUsageProjection struct {
	// List of credit usage projections.
	Projections          []*CreditBundleUsageProjection_Projection `protobuf:"bytes,1,rep,name=projections,proto3" json:"projections,omitempty"`
	XXX_NoUnkeyedLiteral struct{}                                  `json:"-"`
	XXX_unrecognized     []byte                                    `json:"-"`
	XXX_sizecache        int32                                     `json:"-"`
}

CreditBundleUsageProjection contains a series of monthly credit usage projections.

func (*CreditBundleUsageProjection) Descriptor added in v0.82.1 

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

func (*CreditBundleUsageProjection) GetProjections added in v0.82.1 

func (m *CreditBundleUsageProjection) GetProjections() []*CreditBundleUsageProjection_Projection

func (*CreditBundleUsageProjection) Marshal added in v0.82.1 

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

func (*CreditBundleUsageProjection) MarshalTo added in v0.82.1 

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

func (*CreditBundleUsageProjection) MarshalToSizedBuffer added in v0.82.1 

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

func (*CreditBundleUsageProjection) ProtoMessage added in v0.82.1 

func (*CreditBundleUsageProjection) ProtoMessage()

func (*CreditBundleUsageProjection) Reset added in v0.82.1 

func (m *CreditBundleUsageProjection) Reset()

func (*CreditBundleUsageProjection) Size added in v0.82.1 

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

func (*CreditBundleUsageProjection) String added in v0.82.1 

func (m *CreditBundleUsageProjection) String() string

func (*CreditBundleUsageProjection) Unmarshal added in v0.82.1 

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

func (*CreditBundleUsageProjection) XXX_DiscardUnknown added in v0.82.1 

func (m *CreditBundleUsageProjection) XXX_DiscardUnknown()

func (*CreditBundleUsageProjection) XXX_Marshal added in v0.82.1 

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

func (*CreditBundleUsageProjection) XXX_Merge added in v0.82.1 

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

func (*CreditBundleUsageProjection) XXX_Size added in v0.82.1 

func (m *CreditBundleUsageProjection) XXX_Size() int

func (*CreditBundleUsageProjection) XXX_Unmarshal added in v0.82.1 

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

type CreditBundleUsageProjection_Projection added in v0.82.1 

type CreditBundleUsageProjection_Projection struct {
	// Usage value projected for the month in the provided timestamp.
	Value float32 `protobuf:"fixed32,1,opt,name=value,proto3" json:"value,omitempty"`
	// Timestamp (month) for which the given usage value is projected.
	Timestamp            *types.Timestamp `protobuf:"bytes,2,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	XXX_NoUnkeyedLiteral struct{}         `json:"-"`
	XXX_unrecognized     []byte           `json:"-"`
	XXX_sizecache        int32            `json:"-"`
}

func (*CreditBundleUsageProjection_Projection) Descriptor added in v0.82.1 

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

func (*CreditBundleUsageProjection_Projection) GetTimestamp added in v0.82.1 

func (m *CreditBundleUsageProjection_Projection) GetTimestamp() *types.Timestamp

func (*CreditBundleUsageProjection_Projection) GetValue added in v0.82.1 

func (m *CreditBundleUsageProjection_Projection) GetValue() float32

func (*CreditBundleUsageProjection_Projection) Marshal added in v0.82.1 

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

func (*CreditBundleUsageProjection_Projection) MarshalTo added in v0.82.1 

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

func (*CreditBundleUsageProjection_Projection) MarshalToSizedBuffer added in v0.82.1 

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

func (*CreditBundleUsageProjection_Projection) ProtoMessage added in v0.82.1 

func (*CreditBundleUsageProjection_Projection) ProtoMessage()

func (*CreditBundleUsageProjection_Projection) Reset added in v0.82.1 

func (m *CreditBundleUsageProjection_Projection) Reset()

func (*CreditBundleUsageProjection_Projection) Size added in v0.82.1 

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

func (*CreditBundleUsageProjection_Projection) String added in v0.82.1 

func (m *CreditBundleUsageProjection_Projection) String() string

func (*CreditBundleUsageProjection_Projection) Unmarshal added in v0.82.1 

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

func (*CreditBundleUsageProjection_Projection) XXX_DiscardUnknown added in v0.82.1 

func (m *CreditBundleUsageProjection_Projection) XXX_DiscardUnknown()

func (*CreditBundleUsageProjection_Projection) XXX_Marshal added in v0.82.1 

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

func (*CreditBundleUsageProjection_Projection) XXX_Merge added in v0.82.1 

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

func (*CreditBundleUsageProjection_Projection) XXX_Size added in v0.82.1 

func (m *CreditBundleUsageProjection_Projection) XXX_Size() int

func (*CreditBundleUsageProjection_Projection) XXX_Unmarshal added in v0.82.1 

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

type CreditBundlesList 

type CreditBundlesList struct {
	Items                []*CreditBundle `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	XXX_NoUnkeyedLiteral struct{}        `json:"-"`
	XXX_unrecognized     []byte          `json:"-"`
	XXX_sizecache        int32           `json:"-"`
}

List of credit bundles

func (*CreditBundlesList) Descriptor 

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

func (*CreditBundlesList) GetItems 

func (m *CreditBundlesList) GetItems() []*CreditBundle

func (*CreditBundlesList) Marshal 

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

func (*CreditBundlesList) MarshalTo 

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

func (*CreditBundlesList) MarshalToSizedBuffer 

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

func (*CreditBundlesList) ProtoMessage 

func (*CreditBundlesList) ProtoMessage()

func (*CreditBundlesList) Reset 

func (m *CreditBundlesList) Reset()

func (*CreditBundlesList) Size 

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

func (*CreditBundlesList) String 

func (m *CreditBundlesList) String() string

func (*CreditBundlesList) Unmarshal 

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

func (*CreditBundlesList) XXX_DiscardUnknown 

func (m *CreditBundlesList) XXX_DiscardUnknown()

func (*CreditBundlesList) XXX_Marshal 

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

func (*CreditBundlesList) XXX_Merge 

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

func (*CreditBundlesList) XXX_Size 

func (m *CreditBundlesList) XXX_Size() int

func (*CreditBundlesList) XXX_Unmarshal 

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

type CreditDebt added in v0.83.0 

type CreditDebt struct {
	// ID of the organization in debt.
	OrganizationId string `protobuf:"bytes,1,opt,name=organization_id,json=organizationId,proto3" json:"organization_id,omitempty"`
	// Amount of debt currently accrued by the specified organization.
	// Zero means no debt.
	Amount float32 `protobuf:"fixed32,2,opt,name=amount,proto3" json:"amount,omitempty"`
	// Timestamp at which this organization first ran out of credits (and went into debt).
	// Not set if there is no debt.
	CreatedAt            *types.Timestamp `protobuf:"bytes,3,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	XXX_NoUnkeyedLiteral struct{}         `json:"-"`
	XXX_unrecognized     []byte           `json:"-"`
	XXX_sizecache        int32            `json:"-"`
}

CreditDebt contains the details regarding an organization's credit debt.

func (*CreditDebt) Descriptor added in v0.83.0 

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

func (*CreditDebt) GetAmount added in v0.83.0 

func (m *CreditDebt) GetAmount() float32

func (*CreditDebt) GetCreatedAt added in v0.83.0 

func (m *CreditDebt) GetCreatedAt() *types.Timestamp

func (*CreditDebt) GetOrganizationId added in v0.83.0 

func (m *CreditDebt) GetOrganizationId() string

func (*CreditDebt) Marshal added in v0.83.0 

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

func (*CreditDebt) MarshalTo added in v0.83.0 

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

func (*CreditDebt) MarshalToSizedBuffer added in v0.83.0 

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

func (*CreditDebt) ProtoMessage added in v0.83.0 

func (*CreditDebt) ProtoMessage()

func (*CreditDebt) Reset added in v0.83.0 

func (m *CreditDebt) Reset()

func (*CreditDebt) Size added in v0.83.0 

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

func (*CreditDebt) String added in v0.83.0 

func (m *CreditDebt) String() string

func (*CreditDebt) Unmarshal added in v0.83.0 

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

func (*CreditDebt) XXX_DiscardUnknown added in v0.83.0 

func (m *CreditDebt) XXX_DiscardUnknown()

func (*CreditDebt) XXX_Marshal added in v0.83.0 

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

func (*CreditDebt) XXX_Merge added in v0.83.0 

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

func (*CreditDebt) XXX_Size added in v0.83.0 

func (m *CreditDebt) XXX_Size() int

func (*CreditDebt) XXX_Unmarshal added in v0.83.0 

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

type CreditUsageCallback added in v0.82.0 

type CreditUsageCallback func(context.Context, *CreditBundleUsage) error

CreditUsageCallback is a callback for each credit usage item.

type CreditUsageReport added in v0.82.0 

type CreditUsageReport struct {
	// System identifier of the report.
	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"`
	// ID of the organization to which this report belongs.
	OrganizationId string `protobuf:"bytes,3,opt,name=organization_id,json=organizationId,proto3" json:"organization_id,omitempty"`
	// Amount of credits consumed between the interval in this report (between starts_at and ends_at).
	Amount float32 `protobuf:"fixed32,4,opt,name=amount,proto3" json:"amount,omitempty"`
	// Credit balance at the start of the month.
	OpeningBalance float32 `protobuf:"fixed32,5,opt,name=opening_balance,json=openingBalance,proto3" json:"opening_balance,omitempty"`
	// Credit balance at the end of the month.
	ClosingBalance float32 `protobuf:"fixed32,6,opt,name=closing_balance,json=closingBalance,proto3" json:"closing_balance,omitempty"`
	// Date at which this report was created.
	// This report will contain the monthly usage of the month specified in this timestamp.
	CreatedAt *types.Timestamp `protobuf:"bytes,7,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// List of items in this credit usage report.
	Items []*CreditUsageReport_Item `protobuf:"bytes,100,rep,name=items,proto3" json:"items,omitempty"`
	// Status of the report.
	Status               *CreditUsageReport_Status `protobuf:"bytes,200,opt,name=status,proto3" json:"status,omitempty"`
	XXX_NoUnkeyedLiteral struct{}                  `json:"-"`
	XXX_unrecognized     []byte                    `json:"-"`
	XXX_sizecache        int32                     `json:"-"`
}

CreditUsageReport describes the monthly credit usage for a given organization.

func (*CreditUsageReport) Descriptor added in v0.82.0 

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

func (*CreditUsageReport) GetAmount added in v0.82.0 

func (m *CreditUsageReport) GetAmount() float32

func (*CreditUsageReport) GetClosingBalance added in v0.82.0 

func (m *CreditUsageReport) GetClosingBalance() float32

func (*CreditUsageReport) GetCreatedAt added in v0.82.0 

func (m *CreditUsageReport) GetCreatedAt() *types.Timestamp

func (*CreditUsageReport) GetId added in v0.82.0 

func (m *CreditUsageReport) GetId() string

func (*CreditUsageReport) GetItems added in v0.82.0 

func (m *CreditUsageReport) GetItems() []*CreditUsageReport_Item

func (*CreditUsageReport) GetOpeningBalance added in v0.82.0 

func (m *CreditUsageReport) GetOpeningBalance() float32

func (*CreditUsageReport) GetOrganizationId added in v0.82.0 

func (m *CreditUsageReport) GetOrganizationId() string

func (*CreditUsageReport) GetStatus added in v0.82.0 

func (m *CreditUsageReport) GetStatus() *CreditUsageReport_Status

func (*CreditUsageReport) GetUrl added in v0.82.0 

func (m *CreditUsageReport) GetUrl() string

func (*CreditUsageReport) Marshal added in v0.82.0 

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

func (*CreditUsageReport) MarshalTo added in v0.82.0 

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

func (*CreditUsageReport) MarshalToSizedBuffer added in v0.82.0 

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

func (*CreditUsageReport) ProtoMessage added in v0.82.0 

func (*CreditUsageReport) ProtoMessage()

func (*CreditUsageReport) Reset added in v0.82.0 

func (m *CreditUsageReport) Reset()

func (*CreditUsageReport) Size added in v0.82.0 

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

func (*CreditUsageReport) String added in v0.82.0 

func (m *CreditUsageReport) String() string

func (*CreditUsageReport) Unmarshal added in v0.82.0 

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

func (*CreditUsageReport) XXX_DiscardUnknown added in v0.82.0 

func (m *CreditUsageReport) XXX_DiscardUnknown()

func (*CreditUsageReport) XXX_Marshal added in v0.82.0 

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

func (*CreditUsageReport) XXX_Merge added in v0.82.0 

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

func (*CreditUsageReport) XXX_Size added in v0.82.0 

func (m *CreditUsageReport) XXX_Size() int

func (*CreditUsageReport) XXX_Unmarshal added in v0.82.0 

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

type CreditUsageReportCallback added in v0.82.0 

type CreditUsageReportCallback func(context.Context, *CreditUsageReport) error

CreditUsageReportCallback is a callback for each credit usage report.

type CreditUsageReportList added in v0.82.0 

type CreditUsageReportList struct {
	// List of credit usage reports.
	Items                []*CreditUsageReport `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	XXX_NoUnkeyedLiteral struct{}             `json:"-"`
	XXX_unrecognized     []byte               `json:"-"`
	XXX_sizecache        int32                `json:"-"`
}

func (*CreditUsageReportList) Descriptor added in v0.82.0 

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

func (*CreditUsageReportList) GetItems added in v0.82.0 

func (m *CreditUsageReportList) GetItems() []*CreditUsageReport

func (*CreditUsageReportList) Marshal added in v0.82.0 

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

func (*CreditUsageReportList) MarshalTo added in v0.82.0 

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

func (*CreditUsageReportList) MarshalToSizedBuffer added in v0.82.0 

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

func (*CreditUsageReportList) ProtoMessage added in v0.82.0 

func (*CreditUsageReportList) ProtoMessage()

func (*CreditUsageReportList) Reset added in v0.82.0 

func (m *CreditUsageReportList) Reset()

func (*CreditUsageReportList) Size added in v0.82.0 

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

func (*CreditUsageReportList) String added in v0.82.0 

func (m *CreditUsageReportList) String() string

func (*CreditUsageReportList) Unmarshal added in v0.82.0 

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

func (*CreditUsageReportList) XXX_DiscardUnknown added in v0.82.0 

func (m *CreditUsageReportList) XXX_DiscardUnknown()

func (*CreditUsageReportList) XXX_Marshal added in v0.82.0 

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

func (*CreditUsageReportList) XXX_Merge added in v0.82.0 

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

func (*CreditUsageReportList) XXX_Size added in v0.82.0 

func (m *CreditUsageReportList) XXX_Size() int

func (*CreditUsageReportList) XXX_Unmarshal added in v0.82.0 

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

type CreditUsageReport_Item added in v0.82.0 

type CreditUsageReport_Item struct {
	// Identifiers of the Credit usages that this item covers.
	CreditusageIds []string `protobuf:"bytes,1,rep,name=creditusage_ids,json=creditusageIds,proto3" json:"creditusage_ids,omitempty"`
	// Amount of credits for this item.
	Amount float32 `protobuf:"fixed32,2,opt,name=amount,proto3" json:"amount,omitempty"`
	// Human readable description of this item
	Description          string   `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*CreditUsageReport_Item) Descriptor added in v0.82.0 

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

func (*CreditUsageReport_Item) GetAmount added in v0.82.0 

func (m *CreditUsageReport_Item) GetAmount() float32

func (*CreditUsageReport_Item) GetCreditusageIds added in v0.82.0 

func (m *CreditUsageReport_Item) GetCreditusageIds() []string

func (*CreditUsageReport_Item) GetDescription added in v0.82.0 

func (m *CreditUsageReport_Item) GetDescription() string

func (*CreditUsageReport_Item) Marshal added in v0.82.0 

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

func (*CreditUsageReport_Item) MarshalTo added in v0.82.0 

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

func (*CreditUsageReport_Item) MarshalToSizedBuffer added in v0.82.0 

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

func (*CreditUsageReport_Item) ProtoMessage added in v0.82.0 

func (*CreditUsageReport_Item) ProtoMessage()

func (*CreditUsageReport_Item) Reset added in v0.82.0 

func (m *CreditUsageReport_Item) Reset()

func (*CreditUsageReport_Item) Size added in v0.82.0 

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

func (*CreditUsageReport_Item) String added in v0.82.0 

func (m *CreditUsageReport_Item) String() string

func (*CreditUsageReport_Item) Unmarshal added in v0.82.0 

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

func (*CreditUsageReport_Item) XXX_DiscardUnknown added in v0.82.0 

func (m *CreditUsageReport_Item) XXX_DiscardUnknown()

func (*CreditUsageReport_Item) XXX_Marshal added in v0.82.0 

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

func (*CreditUsageReport_Item) XXX_Merge added in v0.82.0 

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

func (*CreditUsageReport_Item) XXX_Size added in v0.82.0 

func (m *CreditUsageReport_Item) XXX_Size() int

func (*CreditUsageReport_Item) XXX_Unmarshal added in v0.82.0 

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

type CreditUsageReport_Status added in v0.82.0 

type CreditUsageReport_Status struct {
	// If set, the items in this report are complete for the month specified in `created_at`.
	// No more items will be added to this report once this field is set.
	IsComplete           bool     `protobuf:"varint,1,opt,name=is_complete,json=isComplete,proto3" json:"is_complete,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Status of the report.

func (*CreditUsageReport_Status) Descriptor added in v0.82.0 

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

func (*CreditUsageReport_Status) GetIsComplete added in v0.82.0 

func (m *CreditUsageReport_Status) GetIsComplete() bool

func (*CreditUsageReport_Status) Marshal added in v0.82.0 

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

func (*CreditUsageReport_Status) MarshalTo added in v0.82.0 

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

func (*CreditUsageReport_Status) MarshalToSizedBuffer added in v0.82.0 

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

func (*CreditUsageReport_Status) ProtoMessage added in v0.82.0 

func (*CreditUsageReport_Status) ProtoMessage()

func (*CreditUsageReport_Status) Reset added in v0.82.0 

func (m *CreditUsageReport_Status) Reset()

func (*CreditUsageReport_Status) Size added in v0.82.0 

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

func (*CreditUsageReport_Status) String added in v0.82.0 

func (m *CreditUsageReport_Status) String() string

func (*CreditUsageReport_Status) Unmarshal added in v0.82.0 

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

func (*CreditUsageReport_Status) XXX_DiscardUnknown added in v0.82.0 

func (m *CreditUsageReport_Status) XXX_DiscardUnknown()

func (*CreditUsageReport_Status) XXX_Marshal added in v0.82.0 

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

func (*CreditUsageReport_Status) XXX_Merge added in v0.82.0 

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

func (*CreditUsageReport_Status) XXX_Size added in v0.82.0 

func (m *CreditUsageReport_Status) XXX_Size() int

func (*CreditUsageReport_Status) XXX_Unmarshal added in v0.82.0 

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

type CreditsServiceClient 

type CreditsServiceClient interface {
	// Get the current API version of this service.
	// Required permissions:
	// - None (authenticated only)
	GetAPIVersion(ctx context.Context, in *v1.Empty, opts ...grpc.CallOption) (*v1.Version, error)
	// List credit bundles for an organization based on the provided request.
	// Required permissions:
	// - credit.creditbundle.list on the organization identified by the given organization ID
	ListCreditBundles(ctx context.Context, in *ListCreditBundlesRequest, opts ...grpc.CallOption) (*CreditBundlesList, error)
	// List credit bundle usages for an organization based on the provided request.
	// Required permissions:
	// - credit.creditbundleusage.list on the organization identified by the given organization ID.
	ListCreditBundlesUsage(ctx context.Context, in *ListCreditBundleUsageRequest, opts ...grpc.CallOption) (*CreditBundleUsageList, error)
	// List the credit reports for the organization identified by the given
	// organization ID that match the given criteria.
	// Required permissions:
	// - credit.creditusagereport.list on the organization identified by the given organization ID
	ListCreditUsageReports(ctx context.Context, in *ListCreditUsageReportsRequest, opts ...grpc.CallOption) (*CreditUsageReportList, error)
	// Get a credit usage report identified by the given ID.
	// Required permissions:
	// - credit.creditusagereport.get on the organization that owns the report.
	GetCreditUsageReport(ctx context.Context, in *v1.IDOptions, opts ...grpc.CallOption) (*CreditUsageReport, error)
	// Get a credit usage report identified by the given ID, as a PDF document.
	// The server sends the PDF over a stream once rendered.
	// The stream is closed after the PDF is sent.
	// Required permissions:
	// - credit.creditusagereport.get on the organization that owns the report.
	GetCreditUsageReportPDF(ctx context.Context, in *v1.IDOptions, opts ...grpc.CallOption) (CreditsService_GetCreditUsageReportPDFClient, error)
	// Get credit usage projection for an organization identified by the given organization ID.
	// This will return a projected credit usage for each month in the future, until the credits run out.
	// Required permissions:
	// - credit.creditbundleusageprojection.get on the organization identified by the given organization ID.
	GetCreditBundleUsageProjection(ctx context.Context, in *GetCreditBundleUsageProjectionRequest, opts ...grpc.CallOption) (*CreditBundleUsageProjection, error)
	// Get the total amount of credit debt accrued by an organization identified by the ID.
	// An organization starts accumulating debt from the moment it runs out of credits.
	// The debt is paid off upon purchasing additional credit bundles.
	// Note: debt usage is allowed only for a limited period of time, after which the organization's deployments are paused.
	// Required permissions:
	// - credit.creditdebt.get on the organization identified by the given organization ID.
	GetOrganizationCreditDebt(ctx context.Context, in *v1.IDOptions, opts ...grpc.CallOption) (*CreditDebt, error)
}

CreditsServiceClient is the client API for CreditsService service.

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

func NewCreditsServiceClient 

func NewCreditsServiceClient(cc *grpc.ClientConn) CreditsServiceClient

type CreditsServiceServer 

type CreditsServiceServer interface {
	// Get the current API version of this service.
	// Required permissions:
	// - None (authenticated only)
	GetAPIVersion(context.Context, *v1.Empty) (*v1.Version, error)
	// List credit bundles for an organization based on the provided request.
	// Required permissions:
	// - credit.creditbundle.list on the organization identified by the given organization ID
	ListCreditBundles(context.Context, *ListCreditBundlesRequest) (*CreditBundlesList, error)
	// List credit bundle usages for an organization based on the provided request.
	// Required permissions:
	// - credit.creditbundleusage.list on the organization identified by the given organization ID.
	ListCreditBundlesUsage(context.Context, *ListCreditBundleUsageRequest) (*CreditBundleUsageList, error)
	// List the credit reports for the organization identified by the given
	// organization ID that match the given criteria.
	// Required permissions:
	// - credit.creditusagereport.list on the organization identified by the given organization ID
	ListCreditUsageReports(context.Context, *ListCreditUsageReportsRequest) (*CreditUsageReportList, error)
	// Get a credit usage report identified by the given ID.
	// Required permissions:
	// - credit.creditusagereport.get on the organization that owns the report.
	GetCreditUsageReport(context.Context, *v1.IDOptions) (*CreditUsageReport, error)
	// Get a credit usage report identified by the given ID, as a PDF document.
	// The server sends the PDF over a stream once rendered.
	// The stream is closed after the PDF is sent.
	// Required permissions:
	// - credit.creditusagereport.get on the organization that owns the report.
	GetCreditUsageReportPDF(*v1.IDOptions, CreditsService_GetCreditUsageReportPDFServer) error
	// Get credit usage projection for an organization identified by the given organization ID.
	// This will return a projected credit usage for each month in the future, until the credits run out.
	// Required permissions:
	// - credit.creditbundleusageprojection.get on the organization identified by the given organization ID.
	GetCreditBundleUsageProjection(context.Context, *GetCreditBundleUsageProjectionRequest) (*CreditBundleUsageProjection, error)
	// Get the total amount of credit debt accrued by an organization identified by the ID.
	// An organization starts accumulating debt from the moment it runs out of credits.
	// The debt is paid off upon purchasing additional credit bundles.
	// Note: debt usage is allowed only for a limited period of time, after which the organization's deployments are paused.
	// Required permissions:
	// - credit.creditdebt.get on the organization identified by the given organization ID.
	GetOrganizationCreditDebt(context.Context, *v1.IDOptions) (*CreditDebt, error)
}

CreditsServiceServer is the server API for CreditsService service.

type CreditsService_GetCreditUsageReportPDFClient added in v0.82.0 

type CreditsService_GetCreditUsageReportPDFClient interface {
	Recv() (*PDFDocument, error)
	grpc.ClientStream
}

type CreditsService_GetCreditUsageReportPDFServer added in v0.82.0 

type CreditsService_GetCreditUsageReportPDFServer interface {
	Send(*PDFDocument) error
	grpc.ServerStream
}

type GetCreditBundleUsageProjectionRequest added in v0.82.1 

type GetCreditBundleUsageProjectionRequest struct {
	// Identifier of the organization for which a credit usage projection is requested.
	OrganizationId string `protobuf:"bytes,1,opt,name=organization_id,json=organizationId,proto3" json:"organization_id,omitempty"`
	// Maximum number of projections to return.
	// This is an optional field.
	// If unspecified, defaults to 3.
	ProjectionsLimit     int32    `protobuf:"varint,2,opt,name=projections_limit,json=projectionsLimit,proto3" json:"projections_limit,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Request for GetCreditBundleUsageProjection rpc.

func (*GetCreditBundleUsageProjectionRequest) Descriptor added in v0.82.1 

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

func (*GetCreditBundleUsageProjectionRequest) GetOrganizationId added in v0.82.1 

func (m *GetCreditBundleUsageProjectionRequest) GetOrganizationId() string

func (*GetCreditBundleUsageProjectionRequest) GetProjectionsLimit added in v0.82.1 

func (m *GetCreditBundleUsageProjectionRequest) GetProjectionsLimit() int32

func (*GetCreditBundleUsageProjectionRequest) Marshal added in v0.82.1 

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

func (*GetCreditBundleUsageProjectionRequest) MarshalTo added in v0.82.1 

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

func (*GetCreditBundleUsageProjectionRequest) MarshalToSizedBuffer added in v0.82.1 

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

func (*GetCreditBundleUsageProjectionRequest) ProtoMessage added in v0.82.1 

func (*GetCreditBundleUsageProjectionRequest) ProtoMessage()

func (*GetCreditBundleUsageProjectionRequest) Reset added in v0.82.1 

func (m *GetCreditBundleUsageProjectionRequest) Reset()

func (*GetCreditBundleUsageProjectionRequest) Size added in v0.82.1 

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

func (*GetCreditBundleUsageProjectionRequest) String added in v0.82.1 

func (m *GetCreditBundleUsageProjectionRequest) String() string

func (*GetCreditBundleUsageProjectionRequest) Unmarshal added in v0.82.1 

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

func (*GetCreditBundleUsageProjectionRequest) XXX_DiscardUnknown added in v0.82.1 

func (m *GetCreditBundleUsageProjectionRequest) XXX_DiscardUnknown()

func (*GetCreditBundleUsageProjectionRequest) XXX_Marshal added in v0.82.1 

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

func (*GetCreditBundleUsageProjectionRequest) XXX_Merge added in v0.82.1 

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

func (*GetCreditBundleUsageProjectionRequest) XXX_Size added in v0.82.1 

func (m *GetCreditBundleUsageProjectionRequest) XXX_Size() int

func (*GetCreditBundleUsageProjectionRequest) XXX_Unmarshal added in v0.82.1 

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

type ListCreditBundleUsageRequest added in v0.80.1 

type ListCreditBundleUsageRequest struct {
	// The organization this credit bundle belongs to.
	// This is a required field.
	OrganizationId string `protobuf:"bytes,1,opt,name=organization_id,json=organizationId,proto3" json:"organization_id,omitempty"`
	// If set, list the usage for the specified credit bundle only.
	// By default, returns the usage for all credit bundles in this organization.
	// This is an optional field.
	CreditBundleId string `protobuf:"bytes,2,opt,name=credit_bundle_id,json=creditBundleId,proto3" json:"credit_bundle_id,omitempty"`
	// The date from which credit usage should be listed.
	// If unspecified, defaults to the date 7 days before `ends_at`.
	// This is an optional field.
	StartsAt *types.Timestamp `protobuf:"bytes,3,opt,name=starts_at,json=startsAt,proto3" json:"starts_at,omitempty"`
	// The date until which credit usage should be listed.
	// If unspecified, defaults to the current date (at the time of calling the API).
	// This is an optional field.
	EndsAt *types.Timestamp `protobuf:"bytes,4,opt,name=ends_at,json=endsAt,proto3" json:"ends_at,omitempty"`
	// If set, list the usage for the specified usage item only.
	// This is an optional field.
	UsageItemId string `protobuf:"bytes,5,opt,name=usage_item_id,json=usageItemId,proto3" json:"usage_item_id,omitempty"`
	// Common list options
	// context_id is ignored.
	Options              *v1.ListOptions `protobuf:"bytes,20,opt,name=options,proto3" json:"options,omitempty"`
	XXX_NoUnkeyedLiteral struct{}        `json:"-"`
	XXX_unrecognized     []byte          `json:"-"`
	XXX_sizecache        int32           `json:"-"`
}

Request for listing credit bundle usages.

func (*ListCreditBundleUsageRequest) Descriptor added in v0.80.1 

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

func (*ListCreditBundleUsageRequest) GetCreditBundleId added in v0.80.1 

func (m *ListCreditBundleUsageRequest) GetCreditBundleId() string

func (*ListCreditBundleUsageRequest) GetEndsAt added in v0.80.1 

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

func (*ListCreditBundleUsageRequest) GetOptions added in v0.80.1 

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

func (*ListCreditBundleUsageRequest) GetOrganizationId added in v0.80.1 

func (m *ListCreditBundleUsageRequest) GetOrganizationId() string

func (*ListCreditBundleUsageRequest) GetStartsAt added in v0.80.1 

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

func (*ListCreditBundleUsageRequest) GetUsageItemId added in v0.80.2 

func (m *ListCreditBundleUsageRequest) GetUsageItemId() string

func (*ListCreditBundleUsageRequest) Marshal added in v0.80.1 

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

func (*ListCreditBundleUsageRequest) MarshalTo added in v0.80.1 

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

func (*ListCreditBundleUsageRequest) MarshalToSizedBuffer added in v0.80.1 

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

func (*ListCreditBundleUsageRequest) ProtoMessage added in v0.80.1 

func (*ListCreditBundleUsageRequest) ProtoMessage()

func (*ListCreditBundleUsageRequest) Reset added in v0.80.1 

func (m *ListCreditBundleUsageRequest) Reset()

func (*ListCreditBundleUsageRequest) Size added in v0.80.1 

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

func (*ListCreditBundleUsageRequest) String added in v0.80.1 

func (m *ListCreditBundleUsageRequest) String() string

func (*ListCreditBundleUsageRequest) Unmarshal added in v0.80.1 

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

func (*ListCreditBundleUsageRequest) XXX_DiscardUnknown added in v0.80.1 

func (m *ListCreditBundleUsageRequest) XXX_DiscardUnknown()

func (*ListCreditBundleUsageRequest) XXX_Marshal added in v0.80.1 

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

func (*ListCreditBundleUsageRequest) XXX_Merge added in v0.80.1 

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

func (*ListCreditBundleUsageRequest) XXX_Size added in v0.80.1 

func (m *ListCreditBundleUsageRequest) XXX_Size() int

func (*ListCreditBundleUsageRequest) XXX_Unmarshal added in v0.80.1 

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

type ListCreditBundlesRequest 

type ListCreditBundlesRequest struct {
	// ID of the organization for which credit bundles are listed.
	// This is a required field.
	OrganizationId string `protobuf:"bytes,1,opt,name=organization_id,json=organizationId,proto3" json:"organization_id,omitempty"`
	// If set, exclude expired bundles.
	ExcludeExpired       bool     `protobuf:"varint,2,opt,name=exclude_expired,json=excludeExpired,proto3" json:"exclude_expired,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Request for listing credit bundles

func (*ListCreditBundlesRequest) Descriptor 

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

func (*ListCreditBundlesRequest) GetExcludeExpired 

func (m *ListCreditBundlesRequest) GetExcludeExpired() bool

func (*ListCreditBundlesRequest) GetOrganizationId 

func (m *ListCreditBundlesRequest) GetOrganizationId() string

func (*ListCreditBundlesRequest) Marshal 

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

func (*ListCreditBundlesRequest) MarshalTo 

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

func (*ListCreditBundlesRequest) MarshalToSizedBuffer 

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

func (*ListCreditBundlesRequest) ProtoMessage 

func (*ListCreditBundlesRequest) ProtoMessage()

func (*ListCreditBundlesRequest) Reset 

func (m *ListCreditBundlesRequest) Reset()

func (*ListCreditBundlesRequest) Size 

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

func (*ListCreditBundlesRequest) String 

func (m *ListCreditBundlesRequest) String() string

func (*ListCreditBundlesRequest) Unmarshal 

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

func (*ListCreditBundlesRequest) XXX_DiscardUnknown 

func (m *ListCreditBundlesRequest) XXX_DiscardUnknown()

func (*ListCreditBundlesRequest) XXX_Marshal 

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

func (*ListCreditBundlesRequest) XXX_Merge 

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

func (*ListCreditBundlesRequest) XXX_Size 

func (m *ListCreditBundlesRequest) XXX_Size() int

func (*ListCreditBundlesRequest) XXX_Unmarshal 

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

type ListCreditUsageReportsRequest added in v0.82.0 

type ListCreditUsageReportsRequest struct {
	// Identifier of the organization for which credit reports are listed.
	OrganizationId string `protobuf:"bytes,1,opt,name=organization_id,json=organizationId,proto3" json:"organization_id,omitempty"`
	// Request reports that are created at or after this timestamp.
	// This is an optional field.
	From *types.Timestamp `protobuf:"bytes,2,opt,name=from,proto3" json:"from,omitempty"`
	// Request reports that are created before this timestamp.
	// This is an optional field.
	To *types.Timestamp `protobuf:"bytes,3,opt,name=to,proto3" json:"to,omitempty"`
	// Common list options
	// context_id is ignored.
	Options              *v1.ListOptions `protobuf:"bytes,20,opt,name=options,proto3" json:"options,omitempty"`
	XXX_NoUnkeyedLiteral struct{}        `json:"-"`
	XXX_unrecognized     []byte          `json:"-"`
	XXX_sizecache        int32           `json:"-"`
}

Request for ListCreditUsageReports rpc.

func (*ListCreditUsageReportsRequest) Descriptor added in v0.82.0 

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

func (*ListCreditUsageReportsRequest) GetFrom added in v0.82.0 

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

func (*ListCreditUsageReportsRequest) GetOptions added in v0.82.0 

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

func (*ListCreditUsageReportsRequest) GetOrganizationId added in v0.82.0 

func (m *ListCreditUsageReportsRequest) GetOrganizationId() string

func (*ListCreditUsageReportsRequest) GetTo added in v0.82.0 

func (m *ListCreditUsageReportsRequest) GetTo() *types.Timestamp

func (*ListCreditUsageReportsRequest) Marshal added in v0.82.0 

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

func (*ListCreditUsageReportsRequest) MarshalTo added in v0.82.0 

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

func (*ListCreditUsageReportsRequest) MarshalToSizedBuffer added in v0.82.0 

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

func (*ListCreditUsageReportsRequest) ProtoMessage added in v0.82.0 

func (*ListCreditUsageReportsRequest) ProtoMessage()

func (*ListCreditUsageReportsRequest) Reset added in v0.82.0 

func (m *ListCreditUsageReportsRequest) Reset()

func (*ListCreditUsageReportsRequest) Size added in v0.82.0 

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

func (*ListCreditUsageReportsRequest) String added in v0.82.0 

func (m *ListCreditUsageReportsRequest) String() string

func (*ListCreditUsageReportsRequest) Unmarshal added in v0.82.0 

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

func (*ListCreditUsageReportsRequest) XXX_DiscardUnknown added in v0.82.0 

func (m *ListCreditUsageReportsRequest) XXX_DiscardUnknown()

func (*ListCreditUsageReportsRequest) XXX_Marshal added in v0.82.0 

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

func (*ListCreditUsageReportsRequest) XXX_Merge added in v0.82.0 

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

func (*ListCreditUsageReportsRequest) XXX_Size added in v0.82.0 

func (m *ListCreditUsageReportsRequest) XXX_Size() int

func (*ListCreditUsageReportsRequest) XXX_Unmarshal added in v0.82.0 

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

type PDFDocument added in v0.82.0 

type PDFDocument struct {
	// The contents of the PDF.
	// This is a read-only field.
	Contents []byte `protobuf:"bytes,1,opt,name=contents,proto3" json:"contents,omitempty"`
	// Name of the PDF file.
	// This is a ready-only field.
	Filename             string   `protobuf:"bytes,2,opt,name=filename,proto3" json:"filename,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

PDFDocument contains the PDF representation of a CreditUsageReport.

func (*PDFDocument) Descriptor added in v0.82.0 

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

func (*PDFDocument) GetContents added in v0.82.0 

func (m *PDFDocument) GetContents() []byte

func (*PDFDocument) GetFilename added in v0.82.0 

func (m *PDFDocument) GetFilename() string

func (*PDFDocument) Marshal added in v0.82.0 

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

func (*PDFDocument) MarshalTo added in v0.82.0 

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

func (*PDFDocument) MarshalToSizedBuffer added in v0.82.0 

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

func (*PDFDocument) ProtoMessage added in v0.82.0 

func (*PDFDocument) ProtoMessage()

func (*PDFDocument) Reset added in v0.82.0 

func (m *PDFDocument) Reset()

func (*PDFDocument) Size added in v0.82.0 

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

func (*PDFDocument) String added in v0.82.0 

func (m *PDFDocument) String() string

func (*PDFDocument) Unmarshal added in v0.82.0 

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

func (*PDFDocument) XXX_DiscardUnknown added in v0.82.0 

func (m *PDFDocument) XXX_DiscardUnknown()

func (*PDFDocument) XXX_Marshal added in v0.82.0 

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

func (*PDFDocument) XXX_Merge added in v0.82.0 

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

func (*PDFDocument) XXX_Size added in v0.82.0 

func (m *PDFDocument) XXX_Size() int

func (*PDFDocument) XXX_Unmarshal added in v0.82.0 

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

type UnimplementedCreditsServiceServer 

type UnimplementedCreditsServiceServer struct {
}

UnimplementedCreditsServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedCreditsServiceServer) GetAPIVersion added in v0.81.4 

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

func (*UnimplementedCreditsServiceServer) GetCreditBundleUsageProjection added in v0.82.1 

func (*UnimplementedCreditsServiceServer) GetCreditBundleUsageProjection(ctx context.Context, req *GetCreditBundleUsageProjectionRequest) (*CreditBundleUsageProjection, error)

func (*UnimplementedCreditsServiceServer) GetCreditUsageReport added in v0.82.0 

func (*UnimplementedCreditsServiceServer) GetCreditUsageReport(ctx context.Context, req *v1.IDOptions) (*CreditUsageReport, error)

func (*UnimplementedCreditsServiceServer) GetCreditUsageReportPDF added in v0.82.0 

func (*UnimplementedCreditsServiceServer) GetCreditUsageReportPDF(req *v1.IDOptions, srv CreditsService_GetCreditUsageReportPDFServer) error

func (*UnimplementedCreditsServiceServer) GetOrganizationCreditDebt added in v0.83.0 

func (*UnimplementedCreditsServiceServer) GetOrganizationCreditDebt(ctx context.Context, req *v1.IDOptions) (*CreditDebt, error)

func (*UnimplementedCreditsServiceServer) ListCreditBundles 

func (*UnimplementedCreditsServiceServer) ListCreditBundles(ctx context.Context, req *ListCreditBundlesRequest) (*CreditBundlesList, error)

func (*UnimplementedCreditsServiceServer) ListCreditBundlesUsage added in v0.80.1 

func (*UnimplementedCreditsServiceServer) ListCreditBundlesUsage(ctx context.Context, req *ListCreditBundleUsageRequest) (*CreditBundleUsageList, error)

func (*UnimplementedCreditsServiceServer) ListCreditUsageReports added in v0.82.0 

func (*UnimplementedCreditsServiceServer) ListCreditUsageReports(ctx context.Context, req *ListCreditUsageReportsRequest) (*CreditUsageReportList, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

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