insights

Documentation

Index

• type InsightsEmptyRequestModel
• type InsightsGetDetailsResponseModel
  • func GetDetails(settings *playfab.Settings, postData *InsightsEmptyRequestModel, ...) (*InsightsGetDetailsResponseModel, error)
• type InsightsGetLimitsResponseModel
  • func GetLimits(settings *playfab.Settings, postData *InsightsEmptyRequestModel, ...) (*InsightsGetLimitsResponseModel, error)
• type InsightsGetOperationStatusRequestModel
• type InsightsGetOperationStatusResponseModel
  • func GetOperationStatus(settings *playfab.Settings, postData *InsightsGetOperationStatusRequestModel, ...) (*InsightsGetOperationStatusResponseModel, error)
• type InsightsGetPendingOperationsRequestModel
• type InsightsGetPendingOperationsResponseModel
  • func GetPendingOperations(settings *playfab.Settings, postData *InsightsGetPendingOperationsRequestModel, ...) (*InsightsGetPendingOperationsResponseModel, error)
• type InsightsOperationResponseModel
  • func SetPerformance(settings *playfab.Settings, postData *InsightsSetPerformanceRequestModel, ...) (*InsightsOperationResponseModel, error)
  • func SetStorageRetention(settings *playfab.Settings, postData *InsightsSetStorageRetentionRequestModel, ...) (*InsightsOperationResponseModel, error)
• type InsightsPerformanceLevelModel
• type InsightsSetPerformanceRequestModel
• type InsightsSetStorageRetentionRequestModel

Types

type InsightsEmptyRequestModel

type InsightsEmptyRequestModel struct {
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
}

InsightsEmptyRequest

type InsightsGetDetailsResponseModel

type InsightsGetDetailsResponseModel struct {
	// DataUsageMb amount of data (in MB) currently used by Insights.
	DataUsageMb uint32 `json:"DataUsageMb,omitempty"`
	// ErrorMessage details of any error that occurred while retrieving Insights details.
	ErrorMessage string `json:"ErrorMessage,omitempty"`
	// Limits allowed range of values for performance level and data storage retention.
	Limits *InsightsGetLimitsResponseModel `json:"Limits,omitempty"`
	// PendingOperations list of pending Insights operations for the title.
	PendingOperations []InsightsGetOperationStatusResponseModel `json:"PendingOperations,omitempty"`
	// PerformanceLevel current Insights performance level setting.
	PerformanceLevel int32 `json:"PerformanceLevel,omitempty"`
	// RetentionDays current Insights data storage retention value in days.
	RetentionDays int32 `json:"RetentionDays,omitempty"`
}

InsightsGetDetailsResponse

func GetDetails

func GetDetails(settings *playfab.Settings, postData *InsightsEmptyRequestModel, entityToken string) (*InsightsGetDetailsResponseModel, error)

GetDetails gets the current values for the Insights performance and data storage retention, list of pending operations, and the performance and data storage retention limits. https://api.playfab.com/Documentation/Insights/method/GetDetails

type InsightsGetLimitsResponseModel

type InsightsGetLimitsResponseModel struct {
	// DefaultPerformanceLevel default Insights performance level.
	DefaultPerformanceLevel int32 `json:"DefaultPerformanceLevel,omitempty"`
	// DefaultStorageRetentionDays default Insights data storage retention days.
	DefaultStorageRetentionDays int32 `json:"DefaultStorageRetentionDays,omitempty"`
	// StorageMaxRetentionDays maximum allowed data storage retention days.
	StorageMaxRetentionDays int32 `json:"StorageMaxRetentionDays,omitempty"`
	// StorageMinRetentionDays minimum allowed data storage retention days.
	StorageMinRetentionDays int32 `json:"StorageMinRetentionDays,omitempty"`
	// SubMeters list of Insights submeter limits for the allowed performance levels.
	SubMeters []InsightsPerformanceLevelModel `json:"SubMeters,omitempty"`
}

InsightsGetLimitsResponse

func GetLimits

func GetLimits(settings *playfab.Settings, postData *InsightsEmptyRequestModel, entityToken string) (*InsightsGetLimitsResponseModel, error)

GetLimits retrieves the range of allowed values for performance and data storage retention values as well as the submeter details for each performance level. https://api.playfab.com/Documentation/Insights/method/GetLimits

type InsightsGetOperationStatusRequestModel

type InsightsGetOperationStatusRequestModel struct {
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// OperationId id of the Insights operation.
	OperationId string `json:"OperationId,omitempty"`
}

InsightsGetOperationStatusRequest returns the current status for the requested operation id.

type InsightsGetOperationStatusResponseModel

type InsightsGetOperationStatusResponseModel struct {
	// Message optional message related to the operation details.
	Message string `json:"Message,omitempty"`
	// OperationCompletedTime time the operation was completed.
	OperationCompletedTime time.Time `json:"OperationCompletedTime,omitempty"`
	// OperationId id of the Insights operation.
	OperationId string `json:"OperationId,omitempty"`
	// OperationLastUpdated time the operation status was last updated.
	OperationLastUpdated time.Time `json:"OperationLastUpdated,omitempty"`
	// OperationStartedTime time the operation started.
	OperationStartedTime time.Time `json:"OperationStartedTime,omitempty"`
	// OperationType the type of operation, SetPerformance or SetStorageRetention.
	OperationType string `json:"OperationType,omitempty"`
	// OperationValue the value requested for the operation.
	OperationValue int32 `json:"OperationValue,omitempty"`
	// Status current status of the operation.
	Status string `json:"Status,omitempty"`
}

InsightsGetOperationStatusResponse

func GetOperationStatus

func GetOperationStatus(settings *playfab.Settings, postData *InsightsGetOperationStatusRequestModel, entityToken string) (*InsightsGetOperationStatusResponseModel, error)

GetOperationStatus gets the status of a SetPerformance or SetStorageRetention operation. https://api.playfab.com/Documentation/Insights/method/GetOperationStatus

type InsightsGetPendingOperationsRequestModel

type InsightsGetPendingOperationsRequestModel struct {
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// OperationType the type of pending operations requested, or blank for all operation types.
	OperationType string `json:"OperationType,omitempty"`
}

InsightsGetPendingOperationsRequest returns a list of operations that are in the pending state for the requested operation type.

type InsightsGetPendingOperationsResponseModel

type InsightsGetPendingOperationsResponseModel struct {
	// PendingOperations list of pending Insights operations.
	PendingOperations []InsightsGetOperationStatusResponseModel `json:"PendingOperations,omitempty"`
}

InsightsGetPendingOperationsResponse

func GetPendingOperations

func GetPendingOperations(settings *playfab.Settings, postData *InsightsGetPendingOperationsRequestModel, entityToken string) (*InsightsGetPendingOperationsResponseModel, error)

GetPendingOperations gets a list of pending SetPerformance and/or SetStorageRetention operations for the title. https://api.playfab.com/Documentation/Insights/method/GetPendingOperations

type InsightsOperationResponseModel

type InsightsOperationResponseModel struct {
	// Message optional message related to the operation details.
	Message string `json:"Message,omitempty"`
	// OperationId id of the Insights operation.
	OperationId string `json:"OperationId,omitempty"`
	// OperationType the type of operation, SetPerformance or SetStorageRetention.
	OperationType string `json:"OperationType,omitempty"`
}

InsightsOperationResponse

func SetPerformance

func SetPerformance(settings *playfab.Settings, postData *InsightsSetPerformanceRequestModel, entityToken string) (*InsightsOperationResponseModel, error)

SetPerformance sets the Insights performance level value for the title. https://api.playfab.com/Documentation/Insights/method/SetPerformance

func SetStorageRetention

func SetStorageRetention(settings *playfab.Settings, postData *InsightsSetStorageRetentionRequestModel, entityToken string) (*InsightsOperationResponseModel, error)

SetStorageRetention sets the Insights data storage retention days value for the title. https://api.playfab.com/Documentation/Insights/method/SetStorageRetention

type InsightsPerformanceLevelModel

type InsightsPerformanceLevelModel struct {
	// ActiveEventExports number of allowed active event exports.
	ActiveEventExports int32 `json:"ActiveEventExports,omitempty"`
	// CacheSizeMB maximum cache size.
	CacheSizeMB int32 `json:"CacheSizeMB,omitempty"`
	// Concurrency maximum number of concurrent queries.
	Concurrency int32 `json:"Concurrency,omitempty"`
	// CreditsPerMinute number of Insights credits consumed per minute.
	CreditsPerMinute float64 `json:"CreditsPerMinute,omitempty"`
	// EventsPerSecond maximum events per second.
	EventsPerSecond int32 `json:"EventsPerSecond,omitempty"`
	// Level performance level.
	Level int32 `json:"Level,omitempty"`
	// MaxMemoryPerQueryMB maximum amount of memory allowed per query.
	MaxMemoryPerQueryMB int32 `json:"MaxMemoryPerQueryMB,omitempty"`
	// VirtualCpuCores amount of compute power allocated for queries and operations.
	VirtualCpuCores int32 `json:"VirtualCpuCores,omitempty"`
}

InsightsPerformanceLevel

type InsightsSetPerformanceRequestModel

type InsightsSetPerformanceRequestModel struct {
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// PerformanceLevel the Insights performance level to apply to the title.
	PerformanceLevel int32 `json:"PerformanceLevel,omitempty"`
}

InsightsSetPerformanceRequest sets the performance level to the requested value. Use the GetLimits method to get the allowed values.

type InsightsSetStorageRetentionRequestModel

type InsightsSetStorageRetentionRequestModel struct {
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// RetentionDays the Insights data storage retention value (in days) to apply to the title.
	RetentionDays int32 `json:"RetentionDays,omitempty"`
}

InsightsSetStorageRetentionRequest sets the data storage retention to the requested value. Use the GetLimits method to get the range of allowed values.