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
- Variables
- func CreditBundleURL(organizationURL, bundleID string) string
- func RegisterCreditsServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterCreditsServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client CreditsServiceClient) error
- func RegisterCreditsServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterCreditsServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server CreditsServiceServer) error
- func RegisterCreditsServiceServer(s *grpc.Server, srv CreditsServiceServer)
- type CreditBundle
- func (*CreditBundle) Descriptor() ([]byte, []int)
- func (m *CreditBundle) GetCreditsPurchased() float32
- func (m *CreditBundle) GetCreditsRemaining() float32
- func (m *CreditBundle) GetCurrency() string
- func (m *CreditBundle) GetId() string
- func (m *CreditBundle) GetLastUsedAt() *types.Timestamp
- func (m *CreditBundle) GetOrganizationId() string
- func (m *CreditBundle) GetPurchasedAt() *types.Timestamp
- func (m *CreditBundle) GetTotalPrice() float32
- func (m *CreditBundle) GetUrl() string
- func (m *CreditBundle) GetValidFrom() *types.Timestamp
- func (m *CreditBundle) GetValidUntil() *types.Timestamp
- func (bundle *CreditBundle) IsExpired() bool
- func (bundle *CreditBundle) IsUsed() bool
- func (m *CreditBundle) Marshal() (dAtA []byte, err error)
- func (m *CreditBundle) MarshalTo(dAtA []byte) (int, error)
- func (m *CreditBundle) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*CreditBundle) ProtoMessage()
- func (m *CreditBundle) Reset()
- func (m *CreditBundle) Size() (n int)
- func (m *CreditBundle) String() string
- func (m *CreditBundle) Unmarshal(dAtA []byte) error
- func (m *CreditBundle) XXX_DiscardUnknown()
- func (m *CreditBundle) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *CreditBundle) XXX_Merge(src proto.Message)
- func (m *CreditBundle) XXX_Size() int
- func (m *CreditBundle) XXX_Unmarshal(b []byte) error
- type CreditBundleUsage
- func (*CreditBundleUsage) Descriptor() ([]byte, []int)
- func (m *CreditBundleUsage) GetCreatedAt() *types.Timestamp
- func (m *CreditBundleUsage) GetCreditBundleId() string
- func (m *CreditBundleUsage) GetId() string
- func (m *CreditBundleUsage) GetOrganizationId() string
- func (m *CreditBundleUsage) GetRemaining() float32
- func (m *CreditBundleUsage) GetUsage() float32
- func (m *CreditBundleUsage) GetUsageItemId() string
- func (m *CreditBundleUsage) Marshal() (dAtA []byte, err error)
- func (m *CreditBundleUsage) MarshalTo(dAtA []byte) (int, error)
- func (m *CreditBundleUsage) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*CreditBundleUsage) ProtoMessage()
- func (m *CreditBundleUsage) Reset()
- func (m *CreditBundleUsage) Size() (n int)
- func (m *CreditBundleUsage) String() string
- func (m *CreditBundleUsage) Unmarshal(dAtA []byte) error
- func (m *CreditBundleUsage) XXX_DiscardUnknown()
- func (m *CreditBundleUsage) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *CreditBundleUsage) XXX_Merge(src proto.Message)
- func (m *CreditBundleUsage) XXX_Size() int
- func (m *CreditBundleUsage) XXX_Unmarshal(b []byte) error
- type CreditBundleUsageList
- func (*CreditBundleUsageList) Descriptor() ([]byte, []int)
- func (m *CreditBundleUsageList) GetItems() []*CreditBundleUsage
- func (m *CreditBundleUsageList) Marshal() (dAtA []byte, err error)
- func (m *CreditBundleUsageList) MarshalTo(dAtA []byte) (int, error)
- func (m *CreditBundleUsageList) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*CreditBundleUsageList) ProtoMessage()
- func (m *CreditBundleUsageList) Reset()
- func (m *CreditBundleUsageList) Size() (n int)
- func (m *CreditBundleUsageList) String() string
- func (m *CreditBundleUsageList) Unmarshal(dAtA []byte) error
- func (m *CreditBundleUsageList) XXX_DiscardUnknown()
- func (m *CreditBundleUsageList) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *CreditBundleUsageList) XXX_Merge(src proto.Message)
- func (m *CreditBundleUsageList) XXX_Size() int
- func (m *CreditBundleUsageList) XXX_Unmarshal(b []byte) error
- type CreditBundlesList
- func (*CreditBundlesList) Descriptor() ([]byte, []int)
- func (m *CreditBundlesList) GetItems() []*CreditBundle
- func (m *CreditBundlesList) Marshal() (dAtA []byte, err error)
- func (m *CreditBundlesList) MarshalTo(dAtA []byte) (int, error)
- func (m *CreditBundlesList) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*CreditBundlesList) ProtoMessage()
- func (m *CreditBundlesList) Reset()
- func (m *CreditBundlesList) Size() (n int)
- func (m *CreditBundlesList) String() string
- func (m *CreditBundlesList) Unmarshal(dAtA []byte) error
- func (m *CreditBundlesList) XXX_DiscardUnknown()
- func (m *CreditBundlesList) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *CreditBundlesList) XXX_Merge(src proto.Message)
- func (m *CreditBundlesList) XXX_Size() int
- func (m *CreditBundlesList) XXX_Unmarshal(b []byte) error
- type CreditsServiceClient
- type CreditsServiceServer
- type ListCreditBundleUsageRequest
- func (*ListCreditBundleUsageRequest) Descriptor() ([]byte, []int)
- func (m *ListCreditBundleUsageRequest) GetCreditBundleId() string
- func (m *ListCreditBundleUsageRequest) GetEndsAt() *types.Timestamp
- func (m *ListCreditBundleUsageRequest) GetOptions() *v1.ListOptions
- func (m *ListCreditBundleUsageRequest) GetOrganizationId() string
- func (m *ListCreditBundleUsageRequest) GetStartsAt() *types.Timestamp
- func (m *ListCreditBundleUsageRequest) GetUsageItemId() string
- func (m *ListCreditBundleUsageRequest) Marshal() (dAtA []byte, err error)
- func (m *ListCreditBundleUsageRequest) MarshalTo(dAtA []byte) (int, error)
- func (m *ListCreditBundleUsageRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*ListCreditBundleUsageRequest) ProtoMessage()
- func (m *ListCreditBundleUsageRequest) Reset()
- func (m *ListCreditBundleUsageRequest) Size() (n int)
- func (m *ListCreditBundleUsageRequest) String() string
- func (m *ListCreditBundleUsageRequest) Unmarshal(dAtA []byte) error
- func (m *ListCreditBundleUsageRequest) XXX_DiscardUnknown()
- func (m *ListCreditBundleUsageRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *ListCreditBundleUsageRequest) XXX_Merge(src proto.Message)
- func (m *ListCreditBundleUsageRequest) XXX_Size() int
- func (m *ListCreditBundleUsageRequest) XXX_Unmarshal(b []byte) error
- type ListCreditBundlesRequest
- func (*ListCreditBundlesRequest) Descriptor() ([]byte, []int)
- func (m *ListCreditBundlesRequest) GetExcludeExpired() bool
- func (m *ListCreditBundlesRequest) GetOrganizationId() string
- func (m *ListCreditBundlesRequest) Marshal() (dAtA []byte, err error)
- func (m *ListCreditBundlesRequest) MarshalTo(dAtA []byte) (int, error)
- func (m *ListCreditBundlesRequest) MarshalToSizedBuffer(dAtA []byte) (int, error)
- func (*ListCreditBundlesRequest) ProtoMessage()
- func (m *ListCreditBundlesRequest) Reset()
- func (m *ListCreditBundlesRequest) Size() (n int)
- func (m *ListCreditBundlesRequest) String() string
- func (m *ListCreditBundlesRequest) Unmarshal(dAtA []byte) error
- func (m *ListCreditBundlesRequest) XXX_DiscardUnknown()
- func (m *ListCreditBundlesRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *ListCreditBundlesRequest) XXX_Merge(src proto.Message)
- func (m *ListCreditBundlesRequest) XXX_Size() int
- func (m *ListCreditBundlesRequest) XXX_Unmarshal(b []byte) error
- type UnimplementedCreditsServiceServer
- func (*UnimplementedCreditsServiceServer) GetAPIVersion(ctx context.Context, req *v1.Empty) (*v1.Version, error)
- func (*UnimplementedCreditsServiceServer) ListCreditBundles(ctx context.Context, req *ListCreditBundlesRequest) (*CreditBundlesList, error)
- func (*UnimplementedCreditsServiceServer) ListCreditBundlesUsage(ctx context.Context, req *ListCreditBundleUsageRequest) (*CreditBundleUsageList, error)
Constants ¶
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" )
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 = 1 // APIPatchVersion contains patch version of this API APIPatchVersion = 2 )
const (
// KindCreditBundle is a constant for the kind of CreditBundle resources.
KindCreditBundle = "CreditBundle"
)
const (
// PermissionCreditBundlesList is needed for listing credit bundles.
PermissionCreditBundleList = "credit.creditbundle.list"
)
const (
// PermissionCreditBundlesList is needed for listing credit bundle usages.
PermissionCreditBundleUsageList = "credit.creditbundleusage.list"
)
Variables ¶
Functions ¶
func CreditBundleURL ¶
CreditBundleURL creates a resource URL for a credit bundle with the given ID.
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) 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 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 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 permisisons: // - credit.creditbundleusage.list on the organization identified by the given organization ID. ListCreditBundlesUsage(ctx context.Context, in *ListCreditBundleUsageRequest, opts ...grpc.CallOption) (*CreditBundleUsageList, 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 permisisons: // - credit.creditbundleusage.list on the organization identified by the given organization ID. ListCreditBundlesUsage(context.Context, *ListCreditBundleUsageRequest) (*CreditBundleUsageList, error) }
CreditsServiceServer is the server API for CreditsService service.
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 UnimplementedCreditsServiceServer ¶
type UnimplementedCreditsServiceServer struct { }
UnimplementedCreditsServiceServer can be embedded to have forward compatible implementations.
func (*UnimplementedCreditsServiceServer) GetAPIVersion ¶ added in v0.81.4
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)