Documentation
¶
Index ¶
- Variables
- type ReportingPolicy
- func (*ReportingPolicy) Descriptor() ([]byte, []int)deprecated
- func (x *ReportingPolicy) GetQuantityTolerance() float64
- func (x *ReportingPolicy) GetRequiredFields() []string
- func (x *ReportingPolicy) GetTenantId() string
- func (x *ReportingPolicy) GetWindowSeconds() int32
- func (*ReportingPolicy) ProtoMessage()
- func (x *ReportingPolicy) ProtoReflect() protoreflect.Message
- func (x *ReportingPolicy) Reset()
- func (x *ReportingPolicy) String() string
- type SetReportingPolicyRequest
- func (*SetReportingPolicyRequest) Descriptor() ([]byte, []int)deprecated
- func (x *SetReportingPolicyRequest) GetPolicy() *ReportingPolicy
- func (x *SetReportingPolicyRequest) GetVer() string
- func (*SetReportingPolicyRequest) ProtoMessage()
- func (x *SetReportingPolicyRequest) ProtoReflect() protoreflect.Message
- func (x *SetReportingPolicyRequest) Reset()
- func (x *SetReportingPolicyRequest) String() string
- type SetReportingPolicyResponse
- func (*SetReportingPolicyResponse) Descriptor() ([]byte, []int)deprecated
- func (x *SetReportingPolicyResponse) GetPolicy() *ReportingPolicy
- func (x *SetReportingPolicyResponse) GetVer() string
- func (*SetReportingPolicyResponse) ProtoMessage()
- func (x *SetReportingPolicyResponse) ProtoReflect() protoreflect.Message
- func (x *SetReportingPolicyResponse) Reset()
- func (x *SetReportingPolicyResponse) String() string
- type SetTenantFeeRateRequest
- func (*SetTenantFeeRateRequest) Descriptor() ([]byte, []int)deprecated
- func (x *SetTenantFeeRateRequest) GetRate() *TenantFeeRate
- func (x *SetTenantFeeRateRequest) GetVer() string
- func (*SetTenantFeeRateRequest) ProtoMessage()
- func (x *SetTenantFeeRateRequest) ProtoReflect() protoreflect.Message
- func (x *SetTenantFeeRateRequest) Reset()
- func (x *SetTenantFeeRateRequest) String() string
- type SetTenantFeeRateResponse
- func (*SetTenantFeeRateResponse) Descriptor() ([]byte, []int)deprecated
- func (x *SetTenantFeeRateResponse) GetRate() *TenantFeeRate
- func (x *SetTenantFeeRateResponse) GetVer() string
- func (*SetTenantFeeRateResponse) ProtoMessage()
- func (x *SetTenantFeeRateResponse) ProtoReflect() protoreflect.Message
- func (x *SetTenantFeeRateResponse) Reset()
- func (x *SetTenantFeeRateResponse) String() string
- type TenantFeeRate
- func (*TenantFeeRate) Descriptor() ([]byte, []int)deprecated
- func (x *TenantFeeRate) GetFeeRateBps() int32
- func (x *TenantFeeRate) GetNotes() string
- func (x *TenantFeeRate) GetTenantId() string
- func (*TenantFeeRate) ProtoMessage()
- func (x *TenantFeeRate) ProtoReflect() protoreflect.Message
- func (x *TenantFeeRate) Reset()
- func (x *TenantFeeRate) String() string
Constants ¶
This section is empty.
Variables ¶
var File_fora_admin_v1_admin_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type ReportingPolicy ¶
type ReportingPolicy struct {
// The tenant whose reporting policy is being replaced.
TenantId string `protobuf:"bytes,1,opt,name=tenant_id,json=tenantId,proto3" json:"tenant_id,omitempty"`
// Report field names the usage-report validator requires. The wire constrains
// only the token shape; which names are meaningful is defined by the receiving
// Exchange and may change without a contract change. Names are a set: repeats
// are rejected. Empty means no required fields.
RequiredFields []string `protobuf:"bytes,2,rep,name=required_fields,json=requiredFields,proto3" json:"required_fields,omitempty"`
// Accepted relative deviation between estimated and reported quantity, as a
// fraction: 0 requires an exact match, 1 accepts any deviation. Omitted: the
// receiving Exchange's default tolerance applies.
QuantityTolerance *float64 `protobuf:"fixed64,3,opt,name=quantity_tolerance,json=quantityTolerance,proto3,oneof" json:"quantity_tolerance,omitempty"`
// Reporting window in seconds. Applies to obligations minted after this call;
// obligations already issued keep the window they were minted with. Capped at
// one year. Omitted: the receiving Exchange's default applies.
WindowSeconds *int32 `protobuf:"varint,4,opt,name=window_seconds,json=windowSeconds,proto3,oneof" json:"window_seconds,omitempty"`
// contains filtered or unexported fields
}
ReportingPolicy is the reporting-policy payload shared by SetReportingPolicy's request and response. The field rules live here once, so the write and the echoed read-back stay in lockstep.
func (*ReportingPolicy) Descriptor
deprecated
func (*ReportingPolicy) Descriptor() ([]byte, []int)
Deprecated: Use ReportingPolicy.ProtoReflect.Descriptor instead.
func (*ReportingPolicy) GetQuantityTolerance ¶
func (x *ReportingPolicy) GetQuantityTolerance() float64
func (*ReportingPolicy) GetRequiredFields ¶
func (x *ReportingPolicy) GetRequiredFields() []string
func (*ReportingPolicy) GetTenantId ¶
func (x *ReportingPolicy) GetTenantId() string
func (*ReportingPolicy) GetWindowSeconds ¶
func (x *ReportingPolicy) GetWindowSeconds() int32
func (*ReportingPolicy) ProtoMessage ¶
func (*ReportingPolicy) ProtoMessage()
func (*ReportingPolicy) ProtoReflect ¶
func (x *ReportingPolicy) ProtoReflect() protoreflect.Message
func (*ReportingPolicy) Reset ¶
func (x *ReportingPolicy) Reset()
func (*ReportingPolicy) String ¶
func (x *ReportingPolicy) String() string
type SetReportingPolicyRequest ¶
type SetReportingPolicyRequest struct {
// FORA protocol version — "1.0". Stamped by the sender from a single
// constant; advisory on receive. See "Protocol version" in fora.proto.
Ver string `protobuf:"bytes,1,opt,name=ver,proto3" json:"ver,omitempty"`
// The reporting policy to apply. Required — an absent payload would otherwise
// skip validation of its fields.
Policy *ReportingPolicy `protobuf:"bytes,2,opt,name=policy,proto3" json:"policy,omitempty"`
// contains filtered or unexported fields
}
func (*SetReportingPolicyRequest) Descriptor
deprecated
func (*SetReportingPolicyRequest) Descriptor() ([]byte, []int)
Deprecated: Use SetReportingPolicyRequest.ProtoReflect.Descriptor instead.
func (*SetReportingPolicyRequest) GetPolicy ¶
func (x *SetReportingPolicyRequest) GetPolicy() *ReportingPolicy
func (*SetReportingPolicyRequest) GetVer ¶
func (x *SetReportingPolicyRequest) GetVer() string
func (*SetReportingPolicyRequest) ProtoMessage ¶
func (*SetReportingPolicyRequest) ProtoMessage()
func (*SetReportingPolicyRequest) ProtoReflect ¶
func (x *SetReportingPolicyRequest) ProtoReflect() protoreflect.Message
func (*SetReportingPolicyRequest) Reset ¶
func (x *SetReportingPolicyRequest) Reset()
func (*SetReportingPolicyRequest) String ¶
func (x *SetReportingPolicyRequest) String() string
type SetReportingPolicyResponse ¶
type SetReportingPolicyResponse struct {
// FORA protocol version — "1.0". Stamped by the sender from a single
// constant; advisory on receive. See "Protocol version" in fora.proto.
Ver string `protobuf:"bytes,1,opt,name=ver,proto3" json:"ver,omitempty"`
// The reporting policy as persisted.
Policy *ReportingPolicy `protobuf:"bytes,2,opt,name=policy,proto3" json:"policy,omitempty"`
// contains filtered or unexported fields
}
func (*SetReportingPolicyResponse) Descriptor
deprecated
func (*SetReportingPolicyResponse) Descriptor() ([]byte, []int)
Deprecated: Use SetReportingPolicyResponse.ProtoReflect.Descriptor instead.
func (*SetReportingPolicyResponse) GetPolicy ¶
func (x *SetReportingPolicyResponse) GetPolicy() *ReportingPolicy
func (*SetReportingPolicyResponse) GetVer ¶
func (x *SetReportingPolicyResponse) GetVer() string
func (*SetReportingPolicyResponse) ProtoMessage ¶
func (*SetReportingPolicyResponse) ProtoMessage()
func (*SetReportingPolicyResponse) ProtoReflect ¶
func (x *SetReportingPolicyResponse) ProtoReflect() protoreflect.Message
func (*SetReportingPolicyResponse) Reset ¶
func (x *SetReportingPolicyResponse) Reset()
func (*SetReportingPolicyResponse) String ¶
func (x *SetReportingPolicyResponse) String() string
type SetTenantFeeRateRequest ¶
type SetTenantFeeRateRequest struct {
// FORA protocol version — "1.0". Stamped by the sender from a single
// constant; advisory on receive. See "Protocol version" in fora.proto.
Ver string `protobuf:"bytes,1,opt,name=ver,proto3" json:"ver,omitempty"`
// The fee rate to apply. Required — an absent payload would otherwise skip
// validation of its fields.
Rate *TenantFeeRate `protobuf:"bytes,2,opt,name=rate,proto3" json:"rate,omitempty"`
// contains filtered or unexported fields
}
func (*SetTenantFeeRateRequest) Descriptor
deprecated
func (*SetTenantFeeRateRequest) Descriptor() ([]byte, []int)
Deprecated: Use SetTenantFeeRateRequest.ProtoReflect.Descriptor instead.
func (*SetTenantFeeRateRequest) GetRate ¶
func (x *SetTenantFeeRateRequest) GetRate() *TenantFeeRate
func (*SetTenantFeeRateRequest) GetVer ¶
func (x *SetTenantFeeRateRequest) GetVer() string
func (*SetTenantFeeRateRequest) ProtoMessage ¶
func (*SetTenantFeeRateRequest) ProtoMessage()
func (*SetTenantFeeRateRequest) ProtoReflect ¶
func (x *SetTenantFeeRateRequest) ProtoReflect() protoreflect.Message
func (*SetTenantFeeRateRequest) Reset ¶
func (x *SetTenantFeeRateRequest) Reset()
func (*SetTenantFeeRateRequest) String ¶
func (x *SetTenantFeeRateRequest) String() string
type SetTenantFeeRateResponse ¶
type SetTenantFeeRateResponse struct {
// FORA protocol version — "1.0". Stamped by the sender from a single
// constant; advisory on receive. See "Protocol version" in fora.proto.
Ver string `protobuf:"bytes,1,opt,name=ver,proto3" json:"ver,omitempty"`
// The fee rate as persisted.
Rate *TenantFeeRate `protobuf:"bytes,2,opt,name=rate,proto3" json:"rate,omitempty"`
// contains filtered or unexported fields
}
func (*SetTenantFeeRateResponse) Descriptor
deprecated
func (*SetTenantFeeRateResponse) Descriptor() ([]byte, []int)
Deprecated: Use SetTenantFeeRateResponse.ProtoReflect.Descriptor instead.
func (*SetTenantFeeRateResponse) GetRate ¶
func (x *SetTenantFeeRateResponse) GetRate() *TenantFeeRate
func (*SetTenantFeeRateResponse) GetVer ¶
func (x *SetTenantFeeRateResponse) GetVer() string
func (*SetTenantFeeRateResponse) ProtoMessage ¶
func (*SetTenantFeeRateResponse) ProtoMessage()
func (*SetTenantFeeRateResponse) ProtoReflect ¶
func (x *SetTenantFeeRateResponse) ProtoReflect() protoreflect.Message
func (*SetTenantFeeRateResponse) Reset ¶
func (x *SetTenantFeeRateResponse) Reset()
func (*SetTenantFeeRateResponse) String ¶
func (x *SetTenantFeeRateResponse) String() string
type TenantFeeRate ¶
type TenantFeeRate struct {
// The tenant whose fee rate is being set.
TenantId string `protobuf:"bytes,1,opt,name=tenant_id,json=tenantId,proto3" json:"tenant_id,omitempty"`
// Fee rate in basis points of gross: fee = floor(gross * bps / 10000).
// Below 10000 keeps the fee strictly under 100%; integer basis points avoid
// float drift when aggregating many charges. 0 is a legitimate explicit
// value ("no fee"), not an unset sentinel.
FeeRateBps int32 `protobuf:"varint,2,opt,name=fee_rate_bps,json=feeRateBps,proto3" json:"fee_rate_bps,omitempty"`
// Operator commentary on the rate (why it was set, by whom, ticket link).
// Omitted clears any existing note.
Notes *string `protobuf:"bytes,3,opt,name=notes,proto3,oneof" json:"notes,omitempty"`
// contains filtered or unexported fields
}
TenantFeeRate is the fee-rate payload shared by SetTenantFeeRate's request and response. The field rules live here once, so the write and the echoed read-back stay in lockstep.
func (*TenantFeeRate) Descriptor
deprecated
func (*TenantFeeRate) Descriptor() ([]byte, []int)
Deprecated: Use TenantFeeRate.ProtoReflect.Descriptor instead.
func (*TenantFeeRate) GetFeeRateBps ¶
func (x *TenantFeeRate) GetFeeRateBps() int32
func (*TenantFeeRate) GetNotes ¶
func (x *TenantFeeRate) GetNotes() string
func (*TenantFeeRate) GetTenantId ¶
func (x *TenantFeeRate) GetTenantId() string
func (*TenantFeeRate) ProtoMessage ¶
func (*TenantFeeRate) ProtoMessage()
func (*TenantFeeRate) ProtoReflect ¶
func (x *TenantFeeRate) ProtoReflect() protoreflect.Message
func (*TenantFeeRate) Reset ¶
func (x *TenantFeeRate) Reset()
func (*TenantFeeRate) String ¶
func (x *TenantFeeRate) String() string