Documentation
¶
Index ¶
- Constants
- type Constraint
- type CreateConstraintRequest
- func (m *CreateConstraintRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *CreateConstraintRequest) MarshalBinary() ([]byte, error)
- func (m *CreateConstraintRequest) UnmarshalBinary(b []byte) error
- func (m *CreateConstraintRequest) Validate(formats strfmt.Registry) error
- type CreateFlagRequest
- type CreateSegmentRequest
- type CreateTagRequest
- type CreateVariantRequest
- type DatarDayEntry
- type DatarFlagSummaryResponse
- func (m *DatarFlagSummaryResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *DatarFlagSummaryResponse) MarshalBinary() ([]byte, error)
- func (m *DatarFlagSummaryResponse) UnmarshalBinary(b []byte) error
- func (m *DatarFlagSummaryResponse) Validate(formats strfmt.Registry) error
- type DatarSegmentEntry
- type DatarSummaryFlag
- type DatarSummaryResponse
- type DatarVariantEntry
- type Distribution
- type DuplicateFlagRequest
- type Error
- type EvalContext
- type EvalDebugLog
- type EvalResult
- type EvaluationBatchRequest
- func (m *EvaluationBatchRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *EvaluationBatchRequest) MarshalBinary() ([]byte, error)
- func (m *EvaluationBatchRequest) UnmarshalBinary(b []byte) error
- func (m *EvaluationBatchRequest) Validate(formats strfmt.Registry) error
- type EvaluationBatchResponse
- func (m *EvaluationBatchResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *EvaluationBatchResponse) MarshalBinary() ([]byte, error)
- func (m *EvaluationBatchResponse) UnmarshalBinary(b []byte) error
- func (m *EvaluationBatchResponse) Validate(formats strfmt.Registry) error
- type EvaluationEntity
- type Exposure
- type ExposureRowError
- type ExposuresRequest
- type ExposuresResponse
- type Flag
- type FlagSnapshot
- type FlagSnapshotMaxID
- type Health
- type PutDistributionsRequest
- func (m *PutDistributionsRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *PutDistributionsRequest) MarshalBinary() ([]byte, error)
- func (m *PutDistributionsRequest) UnmarshalBinary(b []byte) error
- func (m *PutDistributionsRequest) Validate(formats strfmt.Registry) error
- type PutFlagRequest
- type PutSegmentReorderRequest
- func (m *PutSegmentReorderRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *PutSegmentReorderRequest) MarshalBinary() ([]byte, error)
- func (m *PutSegmentReorderRequest) UnmarshalBinary(b []byte) error
- func (m *PutSegmentReorderRequest) Validate(formats strfmt.Registry) error
- type PutSegmentRequest
- type PutVariantRequest
- type Segment
- type SegmentDebugLog
- type SetFlagEnabledRequest
- type Tag
- type Variant
Constants ¶
const ( // ConstraintOperatorEQ captures enum value "EQ" ConstraintOperatorEQ string = "EQ" // ConstraintOperatorNEQ captures enum value "NEQ" ConstraintOperatorNEQ string = "NEQ" // ConstraintOperatorLT captures enum value "LT" ConstraintOperatorLT string = "LT" // ConstraintOperatorLTE captures enum value "LTE" ConstraintOperatorLTE string = "LTE" // ConstraintOperatorGT captures enum value "GT" ConstraintOperatorGT string = "GT" // ConstraintOperatorGTE captures enum value "GTE" ConstraintOperatorGTE string = "GTE" // ConstraintOperatorEREG captures enum value "EREG" ConstraintOperatorEREG string = "EREG" // ConstraintOperatorNEREG captures enum value "NEREG" ConstraintOperatorNEREG string = "NEREG" // ConstraintOperatorIN captures enum value "IN" ConstraintOperatorIN string = "IN" // ConstraintOperatorNOTIN captures enum value "NOTIN" ConstraintOperatorNOTIN string = "NOTIN" // ConstraintOperatorCONTAINS captures enum value "CONTAINS" ConstraintOperatorCONTAINS string = "CONTAINS" // ConstraintOperatorNOTCONTAINS captures enum value "NOTCONTAINS" ConstraintOperatorNOTCONTAINS string = "NOTCONTAINS" )
const ( // EvalContextFlagTagsOperatorANY captures enum value "ANY" EvalContextFlagTagsOperatorANY string = "ANY" // EvalContextFlagTagsOperatorALL captures enum value "ALL" EvalContextFlagTagsOperatorALL string = "ALL" )
const ( // EvalResultRecordSourceEvaluation captures enum value "evaluation" EvalResultRecordSourceEvaluation string = "evaluation" // EvalResultRecordSourceExposure captures enum value "exposure" EvalResultRecordSourceExposure string = "exposure" )
const ( // EvaluationBatchRequestFlagTagsOperatorANY captures enum value "ANY" EvaluationBatchRequestFlagTagsOperatorANY string = "ANY" // EvaluationBatchRequestFlagTagsOperatorALL captures enum value "ALL" EvaluationBatchRequestFlagTagsOperatorALL string = "ALL" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Constraint ¶
type Constraint struct {
// id
// Read Only: true
// Minimum: 1
ID int64 `json:"id,omitempty"`
// operator
// Required: true
// Min Length: 1
// Enum: ["EQ","NEQ","LT","LTE","GT","GTE","EREG","NEREG","IN","NOTIN","CONTAINS","NOTCONTAINS"]
Operator *string `json:"operator"`
// The property name from the entity context to evaluate. Supports nested field access: use dots (e.g., `user.name`) for nested objects and brackets (e.g., `users[0]`) for array indices.
//
// Required: true
// Min Length: 1
Property *string `json:"property"`
// value
// Required: true
// Min Length: 1
Value *string `json:"value"`
}
Constraint constraint
swagger:model constraint
func (*Constraint) ContextValidate ¶
ContextValidate validate this constraint based on the context it is used
func (*Constraint) MarshalBinary ¶
func (m *Constraint) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Constraint) UnmarshalBinary ¶
func (m *Constraint) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateConstraintRequest ¶
type CreateConstraintRequest struct {
// operator
// Required: true
// Min Length: 1
Operator *string `json:"operator"`
// The property name from the entity context to evaluate. Supports nested field access: use dots (e.g., `user.name`) for nested objects and brackets (e.g., `users[0]`) for array indices.
//
// Required: true
// Min Length: 1
Property *string `json:"property"`
// value
// Required: true
// Min Length: 1
Value *string `json:"value"`
}
CreateConstraintRequest create constraint request
swagger:model createConstraintRequest
func (*CreateConstraintRequest) ContextValidate ¶
func (m *CreateConstraintRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this create constraint request based on context it is used
func (*CreateConstraintRequest) MarshalBinary ¶
func (m *CreateConstraintRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateConstraintRequest) UnmarshalBinary ¶
func (m *CreateConstraintRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateFlagRequest ¶
type CreateFlagRequest struct {
// description
// Required: true
// Min Length: 1
Description *string `json:"description"`
// unique key representation of the flag
Key string `json:"key,omitempty"`
// template for flag creation
Template string `json:"template,omitempty"`
}
CreateFlagRequest create flag request
swagger:model createFlagRequest
func (*CreateFlagRequest) ContextValidate ¶
ContextValidate validates this create flag request based on context it is used
func (*CreateFlagRequest) MarshalBinary ¶
func (m *CreateFlagRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateFlagRequest) UnmarshalBinary ¶
func (m *CreateFlagRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateSegmentRequest ¶
type CreateSegmentRequest struct {
// description
// Required: true
// Min Length: 1
Description *string `json:"description"`
// rollout percent
// Required: true
// Maximum: 100
// Minimum: 0
RolloutPercent *int64 `json:"rolloutPercent"`
}
CreateSegmentRequest create segment request
swagger:model createSegmentRequest
func (*CreateSegmentRequest) ContextValidate ¶
ContextValidate validates this create segment request based on context it is used
func (*CreateSegmentRequest) MarshalBinary ¶
func (m *CreateSegmentRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateSegmentRequest) UnmarshalBinary ¶
func (m *CreateSegmentRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateTagRequest ¶
type CreateTagRequest struct {
// value
// Required: true
// Min Length: 1
Value *string `json:"value"`
}
CreateTagRequest create tag request
swagger:model createTagRequest
func (*CreateTagRequest) ContextValidate ¶
ContextValidate validates this create tag request based on context it is used
func (*CreateTagRequest) MarshalBinary ¶
func (m *CreateTagRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateTagRequest) UnmarshalBinary ¶
func (m *CreateTagRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateVariantRequest ¶
type CreateVariantRequest struct {
// attachment
Attachment any `json:"attachment,omitempty"`
// key
// Required: true
// Min Length: 1
Key *string `json:"key"`
}
CreateVariantRequest create variant request
swagger:model createVariantRequest
func (*CreateVariantRequest) ContextValidate ¶
ContextValidate validates this create variant request based on context it is used
func (*CreateVariantRequest) MarshalBinary ¶
func (m *CreateVariantRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateVariantRequest) UnmarshalBinary ¶
func (m *CreateVariantRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DatarDayEntry ¶
type DatarDayEntry struct {
// count
Count int64 `json:"count,omitempty"`
// date
// Format: date
Date strfmt.Date `json:"date,omitempty"`
}
DatarDayEntry datar day entry
swagger:model datarDayEntry
func (*DatarDayEntry) ContextValidate ¶
ContextValidate validates this datar day entry based on context it is used
func (*DatarDayEntry) MarshalBinary ¶
func (m *DatarDayEntry) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DatarDayEntry) UnmarshalBinary ¶
func (m *DatarDayEntry) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DatarFlagSummaryResponse ¶
type DatarFlagSummaryResponse struct {
// flag ID
FlagID int64 `json:"flagID,omitempty"`
// traffic by day
TrafficByDay []*DatarDayEntry `json:"trafficByDay"`
// traffic by segment
TrafficBySegment []*DatarSegmentEntry `json:"trafficBySegment"`
// traffic by variant
TrafficByVariant []*DatarVariantEntry `json:"trafficByVariant"`
}
DatarFlagSummaryResponse datar flag summary response
swagger:model datarFlagSummaryResponse
func (*DatarFlagSummaryResponse) ContextValidate ¶
func (m *DatarFlagSummaryResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this datar flag summary response based on the context it is used
func (*DatarFlagSummaryResponse) MarshalBinary ¶
func (m *DatarFlagSummaryResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DatarFlagSummaryResponse) UnmarshalBinary ¶
func (m *DatarFlagSummaryResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DatarSegmentEntry ¶
type DatarSegmentEntry struct {
// count
Count int64 `json:"count,omitempty"`
// segment ID
SegmentID int64 `json:"segmentID,omitempty"`
}
DatarSegmentEntry datar segment entry
swagger:model datarSegmentEntry
func (*DatarSegmentEntry) ContextValidate ¶
ContextValidate validates this datar segment entry based on context it is used
func (*DatarSegmentEntry) MarshalBinary ¶
func (m *DatarSegmentEntry) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DatarSegmentEntry) UnmarshalBinary ¶
func (m *DatarSegmentEntry) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DatarSummaryFlag ¶
type DatarSummaryFlag struct {
// description
Description string `json:"description,omitempty"`
// enabled
Enabled bool `json:"enabled,omitempty"`
// flag ID
FlagID int64 `json:"flagID,omitempty"`
// flag key
FlagKey string `json:"flagKey,omitempty"`
// last evaluated at
// Format: date-time
LastEvaluatedAt strfmt.DateTime `json:"lastEvaluatedAt,omitempty"`
// total eval count
TotalEvalCount int64 `json:"totalEvalCount,omitempty"`
}
DatarSummaryFlag datar summary flag
swagger:model datarSummaryFlag
func (*DatarSummaryFlag) ContextValidate ¶
ContextValidate validates this datar summary flag based on context it is used
func (*DatarSummaryFlag) MarshalBinary ¶
func (m *DatarSummaryFlag) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DatarSummaryFlag) UnmarshalBinary ¶
func (m *DatarSummaryFlag) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DatarSummaryResponse ¶
type DatarSummaryResponse struct {
// flags
Flags []*DatarSummaryFlag `json:"flags"`
}
DatarSummaryResponse datar summary response
swagger:model datarSummaryResponse
func (*DatarSummaryResponse) ContextValidate ¶
ContextValidate validate this datar summary response based on the context it is used
func (*DatarSummaryResponse) MarshalBinary ¶
func (m *DatarSummaryResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DatarSummaryResponse) UnmarshalBinary ¶
func (m *DatarSummaryResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DatarVariantEntry ¶
type DatarVariantEntry struct {
// count
Count int64 `json:"count,omitempty"`
// variant ID
VariantID int64 `json:"variantID,omitempty"`
}
DatarVariantEntry datar variant entry
swagger:model datarVariantEntry
func (*DatarVariantEntry) ContextValidate ¶
ContextValidate validates this datar variant entry based on context it is used
func (*DatarVariantEntry) MarshalBinary ¶
func (m *DatarVariantEntry) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DatarVariantEntry) UnmarshalBinary ¶
func (m *DatarVariantEntry) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Distribution ¶
type Distribution struct {
// id
// Read Only: true
// Minimum: 1
ID int64 `json:"id,omitempty"`
// percent
// Required: true
// Maximum: 100
// Minimum: 0
Percent *int64 `json:"percent"`
// variant ID
// Required: true
// Minimum: 1
VariantID *int64 `json:"variantID"`
// variant key
// Required: true
// Min Length: 1
VariantKey *string `json:"variantKey"`
}
Distribution distribution
swagger:model distribution
func (*Distribution) ContextValidate ¶
ContextValidate validate this distribution based on the context it is used
func (*Distribution) MarshalBinary ¶
func (m *Distribution) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Distribution) UnmarshalBinary ¶
func (m *Distribution) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DuplicateFlagRequest ¶
type DuplicateFlagRequest struct {
// description for the new flag; defaults to source description with " (cloned)" suffix if omitted or empty
Description string `json:"description,omitempty"`
// unique key for the new flag; auto-generated if omitted or empty
Key string `json:"key,omitempty"`
}
DuplicateFlagRequest duplicate flag request
swagger:model duplicateFlagRequest
func (*DuplicateFlagRequest) ContextValidate ¶
ContextValidate validates this duplicate flag request based on context it is used
func (*DuplicateFlagRequest) MarshalBinary ¶
func (m *DuplicateFlagRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DuplicateFlagRequest) UnmarshalBinary ¶
func (m *DuplicateFlagRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Error ¶
type Error struct {
// message
// Required: true
// Min Length: 1
Message *string `json:"message"`
}
Error error
swagger:model error
func (*Error) ContextValidate ¶
ContextValidate validates this error based on context it is used
func (*Error) MarshalBinary ¶
MarshalBinary interface implementation
func (*Error) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type EvalContext ¶
type EvalContext struct {
// enable debug
EnableDebug bool `json:"enableDebug,omitempty"`
// entity context
EntityContext any `json:"entityContext,omitempty"`
// entityID is used to deterministically at random to evaluate the flag result. If it's empty, flagr will randomly generate one.
EntityID string `json:"entityID,omitempty"`
// entity type
EntityType string `json:"entityType,omitempty"`
// flagID
// Minimum: 1
FlagID int64 `json:"flagID,omitempty"`
// flagKey. flagID or flagKey will resolve to the same flag. Either works.
FlagKey string `json:"flagKey,omitempty"`
// flagTags. flagTags looks up flags by tag. Either works.
FlagTags []string `json:"flagTags,omitempty"`
// determine how flagTags is used to filter flags to be evaluated. OR extends the evaluation to those which contains at least one of the provided flagTags or AND limit the evaluation to those which contains all the flagTags.
// Enum: ["ANY","ALL"]
FlagTagsOperator *string `json:"flagTagsOperator,omitempty"`
}
EvalContext eval context
swagger:model evalContext
func (*EvalContext) ContextValidate ¶
ContextValidate validates this eval context based on context it is used
func (*EvalContext) MarshalBinary ¶
func (m *EvalContext) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EvalContext) UnmarshalBinary ¶
func (m *EvalContext) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EvalDebugLog ¶
type EvalDebugLog struct {
// msg
Msg string `json:"msg,omitempty"`
// segment debug logs
SegmentDebugLogs []*SegmentDebugLog `json:"segmentDebugLogs"`
}
EvalDebugLog eval debug log
swagger:model evalDebugLog
func (*EvalDebugLog) ContextValidate ¶
ContextValidate validate this eval debug log based on the context it is used
func (*EvalDebugLog) MarshalBinary ¶
func (m *EvalDebugLog) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EvalDebugLog) UnmarshalBinary ¶
func (m *EvalDebugLog) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EvalResult ¶
type EvalResult struct {
// Whether data records (impression logging) are enabled for this flag.
DataRecordsEnabled bool `json:"dataRecordsEnabled,omitempty"`
// eval context
EvalContext *EvalContext `json:"evalContext,omitempty"`
// eval debug log
EvalDebugLog *EvalDebugLog `json:"evalDebugLog,omitempty"`
// flag ID
FlagID int64 `json:"flagID,omitempty"`
// flag key
FlagKey string `json:"flagKey,omitempty"`
// flag snapshot ID
FlagSnapshotID int64 `json:"flagSnapshotID,omitempty"`
// flagTags. flagTags looks up flags by tag. Either works.
FlagTags []string `json:"flagTags,omitempty"`
// evaluation for eval API results; exposure for client-reported impressions via POST /exposures (same data recorders as eval)
// Enum: ["evaluation","exposure"]
RecordSource string `json:"recordSource,omitempty"`
// segment ID
SegmentID int64 `json:"segmentID,omitempty"`
// timestamp
Timestamp string `json:"timestamp,omitempty"`
// variant attachment
VariantAttachment any `json:"variantAttachment,omitempty"`
// variant ID
VariantID int64 `json:"variantID,omitempty"`
// variant key
VariantKey string `json:"variantKey,omitempty"`
}
EvalResult eval result
swagger:model evalResult
func (*EvalResult) ContextValidate ¶
ContextValidate validate this eval result based on the context it is used
func (*EvalResult) MarshalBinary ¶
func (m *EvalResult) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EvalResult) UnmarshalBinary ¶
func (m *EvalResult) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EvaluationBatchRequest ¶
type EvaluationBatchRequest struct {
// enable debug
EnableDebug bool `json:"enableDebug,omitempty"`
// entities
// Required: true
// Min Items: 1
Entities []*EvaluationEntity `json:"entities"`
// flagIDs
// Min Items: 1
FlagIDs []int64 `json:"flagIDs"`
// flagKeys. Either flagIDs, flagKeys or flagTags works. If pass in multiples, Flagr may return duplicate results.
// Min Items: 1
FlagKeys []string `json:"flagKeys"`
// flagTags. Either flagIDs, flagKeys or flagTags works. If pass in multiples, Flagr may return duplicate results.
// Min Items: 1
FlagTags []string `json:"flagTags"`
// determine how flagTags is used to filter flags to be evaluated. OR extends the evaluation to those which contains at least one of the provided flagTags or AND limit the evaluation to those which contains all the flagTags.
// Enum: ["ANY","ALL"]
FlagTagsOperator *string `json:"flagTagsOperator,omitempty"`
}
EvaluationBatchRequest evaluation batch request
swagger:model evaluationBatchRequest
func (*EvaluationBatchRequest) ContextValidate ¶
func (m *EvaluationBatchRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this evaluation batch request based on the context it is used
func (*EvaluationBatchRequest) MarshalBinary ¶
func (m *EvaluationBatchRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EvaluationBatchRequest) UnmarshalBinary ¶
func (m *EvaluationBatchRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EvaluationBatchResponse ¶
type EvaluationBatchResponse struct {
// evaluation results
// Required: true
EvaluationResults []*EvalResult `json:"evaluationResults"`
}
EvaluationBatchResponse evaluation batch response
swagger:model evaluationBatchResponse
func (*EvaluationBatchResponse) ContextValidate ¶
func (m *EvaluationBatchResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this evaluation batch response based on the context it is used
func (*EvaluationBatchResponse) MarshalBinary ¶
func (m *EvaluationBatchResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EvaluationBatchResponse) UnmarshalBinary ¶
func (m *EvaluationBatchResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EvaluationEntity ¶
type EvaluationEntity struct {
// entity context
EntityContext any `json:"entityContext,omitempty"`
// entity ID
EntityID string `json:"entityID,omitempty"`
// entity type
EntityType string `json:"entityType,omitempty"`
}
EvaluationEntity evaluation entity
swagger:model evaluationEntity
func (*EvaluationEntity) ContextValidate ¶
ContextValidate validates this evaluation entity based on context it is used
func (*EvaluationEntity) MarshalBinary ¶
func (m *EvaluationEntity) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EvaluationEntity) UnmarshalBinary ¶
func (m *EvaluationEntity) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Exposure ¶
type Exposure struct {
// Optional attributes recorded on evalContext.entityContext (same field as POST /evaluation). Include impression-specific keys here (e.g. page path); exposure does not re-run segment constraints.
EntityContext any `json:"entityContext,omitempty"`
// entity ID
// Required: true
EntityID *string `json:"entityID"`
// entity type
EntityType string `json:"entityType,omitempty"`
// flag ID
FlagID int64 `json:"flagID,omitempty"`
// flag key
FlagKey string `json:"flagKey,omitempty"`
// flag snapshot ID
FlagSnapshotID int64 `json:"flagSnapshotID,omitempty"`
// timestamp
// Format: date-time
Timestamp strfmt.DateTime `json:"timestamp,omitempty"`
// variant ID
VariantID int64 `json:"variantID,omitempty"`
// variant key
VariantKey string `json:"variantKey,omitempty"`
}
Exposure exposure
swagger:model exposure
func (*Exposure) ContextValidate ¶
ContextValidate validates this exposure based on context it is used
func (*Exposure) MarshalBinary ¶
MarshalBinary interface implementation
func (*Exposure) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ExposureRowError ¶
type ExposureRowError struct {
// index
Index int64 `json:"index,omitempty"`
// message
Message string `json:"message,omitempty"`
}
ExposureRowError exposure row error
swagger:model exposureRowError
func (*ExposureRowError) ContextValidate ¶
ContextValidate validates this exposure row error based on context it is used
func (*ExposureRowError) MarshalBinary ¶
func (m *ExposureRowError) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ExposureRowError) UnmarshalBinary ¶
func (m *ExposureRowError) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ExposuresRequest ¶
type ExposuresRequest struct {
// exposures
// Required: true
// Min Items: 1
Exposures []*Exposure `json:"exposures"`
}
ExposuresRequest exposures request
swagger:model exposuresRequest
func (*ExposuresRequest) ContextValidate ¶
ContextValidate validate this exposures request based on the context it is used
func (*ExposuresRequest) MarshalBinary ¶
func (m *ExposuresRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ExposuresRequest) UnmarshalBinary ¶
func (m *ExposuresRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ExposuresResponse ¶
type ExposuresResponse struct {
// errors
Errors []*ExposureRowError `json:"errors"`
// logged count
LoggedCount int64 `json:"loggedCount,omitempty"`
// message
Message string `json:"message,omitempty"`
}
ExposuresResponse exposures response
swagger:model exposuresResponse
func (*ExposuresResponse) ContextValidate ¶
ContextValidate validate this exposures response based on the context it is used
func (*ExposuresResponse) MarshalBinary ¶
func (m *ExposuresResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ExposuresResponse) UnmarshalBinary ¶
func (m *ExposuresResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Flag ¶
type Flag struct {
// created by
CreatedBy string `json:"createdBy,omitempty"`
// when true and FLAGR_RECORDER_ENABLED is set, evaluation and exposure rows are written to configured data recorders (e.g. kafka).
// Required: true
DataRecordsEnabled *bool `json:"dataRecordsEnabled"`
// description
// Required: true
// Min Length: 1
Description *string `json:"description"`
// enabled
// Required: true
Enabled *bool `json:"enabled"`
// it will override the entityType in the evaluation logs if it's not empty
EntityType string `json:"entityType,omitempty"`
// id
// Read Only: true
// Minimum: 1
ID int64 `json:"id,omitempty"`
// unique key representation of the flag
// Min Length: 1
Key string `json:"key,omitempty"`
// flag usage details in markdown format
Notes string `json:"notes,omitempty"`
// segments
Segments []*Segment `json:"segments"`
// tags
Tags []*Tag `json:"tags"`
// updated at
// Format: date-time
UpdatedAt strfmt.DateTime `json:"updatedAt,omitempty"`
// updated by
UpdatedBy string `json:"updatedBy,omitempty"`
// variants
Variants []*Variant `json:"variants"`
}
Flag flag
swagger:model flag
func (*Flag) ContextValidate ¶
ContextValidate validate this flag based on the context it is used
func (*Flag) MarshalBinary ¶
MarshalBinary interface implementation
func (*Flag) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type FlagSnapshot ¶
type FlagSnapshot struct {
// flag
// Required: true
Flag *Flag `json:"flag"`
// id
// Read Only: true
// Minimum: 1
ID int64 `json:"id,omitempty"`
// updated at
// Required: true
// Min Length: 1
UpdatedAt *string `json:"updatedAt"`
// updated by
UpdatedBy string `json:"updatedBy,omitempty"`
}
FlagSnapshot flag snapshot
swagger:model flagSnapshot
func (*FlagSnapshot) ContextValidate ¶
ContextValidate validate this flag snapshot based on the context it is used
func (*FlagSnapshot) MarshalBinary ¶
func (m *FlagSnapshot) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*FlagSnapshot) UnmarshalBinary ¶
func (m *FlagSnapshot) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type FlagSnapshotMaxID ¶
type FlagSnapshotMaxID struct {
// max ID
MaxID int64 `json:"maxID,omitempty"`
}
FlagSnapshotMaxID flag snapshot max ID
swagger:model flagSnapshotMaxID
func (*FlagSnapshotMaxID) ContextValidate ¶
ContextValidate validates this flag snapshot max ID based on context it is used
func (*FlagSnapshotMaxID) MarshalBinary ¶
func (m *FlagSnapshotMaxID) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*FlagSnapshotMaxID) UnmarshalBinary ¶
func (m *FlagSnapshotMaxID) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Health ¶
type Health struct {
// true when the server runs in eval-only mode (e.g. json_file/json_http drivers) and flag write APIs are disabled
EvalOnlyMode bool `json:"evalOnlyMode,omitempty"`
// status
Status string `json:"status,omitempty"`
}
Health health
swagger:model health
func (*Health) ContextValidate ¶
ContextValidate validates this health based on context it is used
func (*Health) MarshalBinary ¶
MarshalBinary interface implementation
func (*Health) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type PutDistributionsRequest ¶
type PutDistributionsRequest struct {
// distributions
// Required: true
Distributions []*Distribution `json:"distributions"`
}
PutDistributionsRequest put distributions request
swagger:model putDistributionsRequest
func (*PutDistributionsRequest) ContextValidate ¶
func (m *PutDistributionsRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this put distributions request based on the context it is used
func (*PutDistributionsRequest) MarshalBinary ¶
func (m *PutDistributionsRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PutDistributionsRequest) UnmarshalBinary ¶
func (m *PutDistributionsRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PutFlagRequest ¶
type PutFlagRequest struct {
// when true and FLAGR_RECORDER_ENABLED is set, evaluation and exposure rows are written to configured data recorders (e.g. kafka).
DataRecordsEnabled *bool `json:"dataRecordsEnabled,omitempty"`
// description
// Min Length: 1
Description *string `json:"description,omitempty"`
// enabled
Enabled *bool `json:"enabled,omitempty"`
// it will overwrite entityType into evaluation logs if it's not empty
EntityType *string `json:"entityType,omitempty"`
// key
Key *string `json:"key,omitempty"`
// notes
Notes *string `json:"notes,omitempty"`
}
PutFlagRequest put flag request
swagger:model putFlagRequest
func (*PutFlagRequest) ContextValidate ¶
ContextValidate validates this put flag request based on context it is used
func (*PutFlagRequest) MarshalBinary ¶
func (m *PutFlagRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PutFlagRequest) UnmarshalBinary ¶
func (m *PutFlagRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PutSegmentReorderRequest ¶
type PutSegmentReorderRequest struct {
// segment IDs
// Required: true
// Min Items: 1
SegmentIDs []int64 `json:"segmentIDs"`
}
PutSegmentReorderRequest put segment reorder request
swagger:model putSegmentReorderRequest
func (*PutSegmentReorderRequest) ContextValidate ¶
func (m *PutSegmentReorderRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this put segment reorder request based on context it is used
func (*PutSegmentReorderRequest) MarshalBinary ¶
func (m *PutSegmentReorderRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PutSegmentReorderRequest) UnmarshalBinary ¶
func (m *PutSegmentReorderRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PutSegmentRequest ¶
type PutSegmentRequest struct {
// description
// Required: true
// Min Length: 1
Description *string `json:"description"`
// rollout percent
// Required: true
// Maximum: 100
// Minimum: 0
RolloutPercent *int64 `json:"rolloutPercent"`
}
PutSegmentRequest put segment request
swagger:model putSegmentRequest
func (*PutSegmentRequest) ContextValidate ¶
ContextValidate validates this put segment request based on context it is used
func (*PutSegmentRequest) MarshalBinary ¶
func (m *PutSegmentRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PutSegmentRequest) UnmarshalBinary ¶
func (m *PutSegmentRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PutVariantRequest ¶
type PutVariantRequest struct {
// attachment
Attachment any `json:"attachment,omitempty"`
// key
// Required: true
// Min Length: 1
Key *string `json:"key"`
}
PutVariantRequest put variant request
swagger:model putVariantRequest
func (*PutVariantRequest) ContextValidate ¶
ContextValidate validates this put variant request based on context it is used
func (*PutVariantRequest) MarshalBinary ¶
func (m *PutVariantRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PutVariantRequest) UnmarshalBinary ¶
func (m *PutVariantRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Segment ¶
type Segment struct {
// constraints
Constraints []*Constraint `json:"constraints"`
// description
// Required: true
// Min Length: 1
Description *string `json:"description"`
// distributions
Distributions []*Distribution `json:"distributions"`
// id
// Read Only: true
// Minimum: 1
ID int64 `json:"id,omitempty"`
// rank
// Required: true
// Minimum: 0
Rank *int64 `json:"rank"`
// rollout percent
// Required: true
// Maximum: 100
// Minimum: 0
RolloutPercent *int64 `json:"rolloutPercent"`
}
Segment segment
swagger:model segment
func (*Segment) ContextValidate ¶
ContextValidate validate this segment based on the context it is used
func (*Segment) MarshalBinary ¶
MarshalBinary interface implementation
func (*Segment) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type SegmentDebugLog ¶
type SegmentDebugLog struct {
// msg
Msg string `json:"msg,omitempty"`
// segment ID
// Minimum: 1
SegmentID int64 `json:"segmentID,omitempty"`
}
SegmentDebugLog segment debug log
swagger:model segmentDebugLog
func (*SegmentDebugLog) ContextValidate ¶
ContextValidate validates this segment debug log based on context it is used
func (*SegmentDebugLog) MarshalBinary ¶
func (m *SegmentDebugLog) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SegmentDebugLog) UnmarshalBinary ¶
func (m *SegmentDebugLog) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SetFlagEnabledRequest ¶
type SetFlagEnabledRequest struct {
// enabled
// Required: true
Enabled *bool `json:"enabled"`
}
SetFlagEnabledRequest set flag enabled request
swagger:model setFlagEnabledRequest
func (*SetFlagEnabledRequest) ContextValidate ¶
ContextValidate validates this set flag enabled request based on context it is used
func (*SetFlagEnabledRequest) MarshalBinary ¶
func (m *SetFlagEnabledRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SetFlagEnabledRequest) UnmarshalBinary ¶
func (m *SetFlagEnabledRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Tag ¶
type Tag struct {
// id
// Read Only: true
// Minimum: 1
ID int64 `json:"id,omitempty"`
// value
// Required: true
// Min Length: 1
Value *string `json:"value"`
}
Tag tag
swagger:model tag
func (*Tag) ContextValidate ¶
ContextValidate validate this tag based on the context it is used
func (*Tag) MarshalBinary ¶
MarshalBinary interface implementation
func (*Tag) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Variant ¶
type Variant struct {
// attachment
Attachment any `json:"attachment,omitempty"`
// id
// Read Only: true
// Minimum: 1
ID int64 `json:"id,omitempty"`
// key
// Required: true
// Min Length: 1
Key *string `json:"key"`
}
Variant variant
swagger:model variant
func (*Variant) ContextValidate ¶
ContextValidate validate this variant based on the context it is used
func (*Variant) MarshalBinary ¶
MarshalBinary interface implementation
func (*Variant) UnmarshalBinary ¶
UnmarshalBinary interface implementation
Source Files
¶
- constraint.go
- create_constraint_request.go
- create_flag_request.go
- create_segment_request.go
- create_tag_request.go
- create_variant_request.go
- datar_day_entry.go
- datar_flag_summary_response.go
- datar_segment_entry.go
- datar_summary_flag.go
- datar_summary_response.go
- datar_variant_entry.go
- distribution.go
- duplicate_flag_request.go
- error.go
- eval_context.go
- eval_debug_log.go
- eval_result.go
- evaluation_batch_request.go
- evaluation_batch_response.go
- evaluation_entity.go
- exposure.go
- exposure_row_error.go
- exposures_request.go
- exposures_response.go
- flag.go
- flag_snapshot.go
- flag_snapshot_max_id.go
- health.go
- put_distributions_request.go
- put_flag_request.go
- put_segment_reorder_request.go
- put_segment_request.go
- put_variant_request.go
- segment.go
- segment_debug_log.go
- set_flag_enabled_request.go
- tag.go
- variant.go