mobile

Documentation

Index

• Variables
• type APIValue
  • func (me *APIValue) MarshalHCL(properties hcl.Properties) error
  • func (me *APIValue) Schema() map[string]*schema.Schema
  • func (me *APIValue) UnmarshalHCL(decoder hcl.Decoder) error
• type Aggregation
• type Application
  • func (me *Application) Load(data []byte) error
  • func (me *Application) MarshalHCL(properties hcl.Properties) error
  • func (me *Application) Schema() map[string]*schema.Schema
  • func (me *Application) Store() ([]byte, error)
  • func (me *Application) UnmarshalHCL(decoder hcl.Decoder) error
• type ApplicationType
• type BeaconEndpointType
• type IconType
• type MobileCustomApdex
  • func (me *MobileCustomApdex) MarshalHCL(properties hcl.Properties) error
  • func (me *MobileCustomApdex) Schema() map[string]*schema.Schema
  • func (me *MobileCustomApdex) UnmarshalHCL(decoder hcl.Decoder) error
• type Origin
• type PropertyType
• type ServerSideRequestAttribute
  • func (me *ServerSideRequestAttribute) MarshalHCL(properties hcl.Properties) error
  • func (me *ServerSideRequestAttribute) Schema() map[string]*schema.Schema
  • func (me *ServerSideRequestAttribute) UnmarshalHCL(decoder hcl.Decoder) error
• type UserActionAndSessionProperties
  • func (me UserActionAndSessionProperties) MarshalHCL(properties hcl.Properties) error
  • func (me UserActionAndSessionProperties) Schema() map[string]*schema.Schema
  • func (me *UserActionAndSessionProperties) UnmarshalHCL(decoder hcl.Decoder) error
• type UserActionAndSessionProperty

Variables

var Aggregations = struct {
	First Aggregation
	Last  Aggregation
	Max   Aggregation
	Min   Aggregation
	Sum   Aggregation
}{
	First: Aggregation("FIRST"),
	Last:  Aggregation("LAST"),
	Max:   Aggregation("MAX"),
	Min:   Aggregation("MIN"),
	Sum:   Aggregation("SUM"),
}

var ApplicationTypes = struct {
	CustomApplication ApplicationType
	MobileApplication ApplicationType
}{
	CustomApplication: ApplicationType("CUSTOM_APPLICATION"),
	MobileApplication: ApplicationType("MOBILE_APPLICATION"),
}

var BeaconEndpointTypes = struct {
	ClusterActiveGate     BeaconEndpointType
	EnvironmentActiveGate BeaconEndpointType
	InstrumentedWebServer BeaconEndpointType
}{
	ClusterActiveGate:     BeaconEndpointType("CLUSTER_ACTIVE_GATE"),
	EnvironmentActiveGate: BeaconEndpointType("ENVIRONMENT_ACTIVE_GATE"),
	InstrumentedWebServer: BeaconEndpointType("INSTRUMENTED_WEB_SERVER"),
}

var IconTypes = struct {
	AmazonEcho        IconType
	Desktop           IconType
	Embedded          IconType
	IoT               IconType
	MicrosoftHololens IconType
	UFO               IconType
	Users             IconType
}{
	AmazonEcho:        IconType("AMAZON_ECHO"),
	Desktop:           IconType("DESKTOP"),
	Embedded:          IconType("EMBEDDED"),
	IoT:               IconType("IOT"),
	MicrosoftHololens: IconType("MICROSOFT_HOLOLENS"),
	UFO:               IconType("UFO"),
	Users:             IconType("USERS"),
}

var Origins = struct {
	API                        Origin
	ServerSideRequestAttribute Origin
}{
	API:                        Origin("API"),
	ServerSideRequestAttribute: Origin("SERVER_SIDE_REQUEST_ATTRIBUTE"),
}

var PropertyTypes = struct {
	Double PropertyType
	Long   PropertyType
	String PropertyType
}{
	Double: PropertyType("DOUBLE"),
	Long:   PropertyType("LONG"),
	String: PropertyType("STRING"),
}

Types

type APIValue

type APIValue UserActionAndSessionProperty

func (*APIValue) MarshalHCL

func (me *APIValue) MarshalHCL(properties hcl.Properties) error

func (*APIValue) Schema

func (me *APIValue) Schema() map[string]*schema.Schema

func (*APIValue) UnmarshalHCL

func (me *APIValue) UnmarshalHCL(decoder hcl.Decoder) error

type Aggregation

type Aggregation string

type Application

type Application struct {
	Name                             string                         `json:"name"`                                       // The name of the application
	ApplicationType                  *ApplicationType               `json:"applicationType,omitempty"`                  // The type of the application
	ApplicationID                    *string                        `json:"applicationId,omitempty"`                    // The UUID of the application.\n\nIt is used only by OneAgent to send data to Dynatrace
	IconType                         *IconType                      `json:"iconType,omitempty"`                         // Custom application icon. Mobile apps always use the mobile device icon, so this icon can only be set for custom apps.
	CostControlUserSessionPercentage *int32                         `json:"costControlUserSessionPercentage,omitempty"` // (Field has overlap with `dynatrace_mobile_app_enablement` for mobile and `dynatrace_custom_app_enablement` for custom apps) The percentage of user sessions to be analyzed
	ApdexSettings                    *MobileCustomApdex             `json:"apdexSettings,omitempty"`
	OptInModeEnabled                 bool                           `json:"optInModeEnabled,omitempty"`     // The opt-in mode is enabled (`true`) or disabled (`false`).\n\nThis value is only applicable to mobile and not to custom apps
	SessionReplayEnabled             bool                           `json:"sessionReplayEnabled,omitempty"` // (Field has overlap with `dynatrace_mobile_app_enablement`) The session replay is enabled (`true`) or disabled (`false`).\nThis value is only applicable to mobile and not to custom apps
	SessionReplayOnCrashEnabled      bool                           `json:"sessionReplayOnCrashEnabled"`    // The session replay on crash is enabled (`true`) or disabled (`false`). \n\nEnabling requires both **sessionReplayEnabled** and **optInModeEnabled** values set to `true`.\nAlso, this value is only applicable to mobile and not to custom apps
	BeaconEndpointType               BeaconEndpointType             `json:"beaconEndpointType"`             // The type of the beacon endpoint
	BeaconEndpointUrl                *string                        `json:"beaconEndpointUrl,omitempty"`    // The URL of the beacon endpoint.\n\nOnly applicable when the **beaconEndpointType** is set to `ENVIRONMENT_ACTIVE_GATE` or `INSTRUMENTED_WEB_SERVER`
	KeyUserActions                   collections.Set[string]        `json:"-"`
	Properties                       UserActionAndSessionProperties `json:"-"`
}

Application represents configuration of a mobile or custom application to be created

func (*Application) Load

func (me *Application) Load(data []byte) error

func (*Application) MarshalHCL

func (me *Application) MarshalHCL(properties hcl.Properties) error

func (*Application) Schema

func (me *Application) Schema() map[string]*schema.Schema

func (*Application) Store

func (me *Application) Store() ([]byte, error)

func (*Application) UnmarshalHCL

func (me *Application) UnmarshalHCL(decoder hcl.Decoder) error

type ApplicationType

type ApplicationType string

type BeaconEndpointType

type BeaconEndpointType string

type IconType

type IconType string

type MobileCustomApdex

type MobileCustomApdex struct {
	ToleratedThreshold   int32 `json:"toleratedThreshold"`   // Apdex **tolerable** threshold, in milliseconds: a duration greater than or equal to this value is considered tolerable
	FrustratingThreshold int32 `json:"frustratingThreshold"` // Apdex **frustrated** threshold, in milliseconds: a duration greater than or equal to this value is considered frustrated
	FrustratedOnError    bool  `json:"frustratedOnError"`    // Apdex error condition: if `true` the user session is considered frustrated when an error is reported
}

MobileCustomApdex represents Apdex configuration of a mobile or custom application. \n\nA duration less than the **tolerable** threshold is considered satisfied

func (*MobileCustomApdex) MarshalHCL

func (me *MobileCustomApdex) MarshalHCL(properties hcl.Properties) error

func (*MobileCustomApdex) Schema

func (me *MobileCustomApdex) Schema() map[string]*schema.Schema

func (*MobileCustomApdex) UnmarshalHCL

func (me *MobileCustomApdex) UnmarshalHCL(decoder hcl.Decoder) error

type Origin

type Origin string

type PropertyType

type PropertyType string

type ServerSideRequestAttribute

type ServerSideRequestAttribute UserActionAndSessionProperty

func (*ServerSideRequestAttribute) MarshalHCL

func (me *ServerSideRequestAttribute) MarshalHCL(properties hcl.Properties) error

func (*ServerSideRequestAttribute) Schema

func (me *ServerSideRequestAttribute) Schema() map[string]*schema.Schema

func (*ServerSideRequestAttribute) UnmarshalHCL

func (me *ServerSideRequestAttribute) UnmarshalHCL(decoder hcl.Decoder) error

type UserActionAndSessionProperties

type UserActionAndSessionProperties []*UserActionAndSessionProperty

func (UserActionAndSessionProperties) MarshalHCL

func (me UserActionAndSessionProperties) MarshalHCL(properties hcl.Properties) error

func (UserActionAndSessionProperties) Schema

func (me UserActionAndSessionProperties) Schema() map[string]*schema.Schema

func (*UserActionAndSessionProperties) UnmarshalHCL

func (me *UserActionAndSessionProperties) UnmarshalHCL(decoder hcl.Decoder) error

type UserActionAndSessionProperty

type UserActionAndSessionProperty struct {
	Key                        string       `json:"key"`                                  // The unique key of the mobile session or user action property
	DisplayName                *string      `json:"displayName,omitempty"`                // The display name of the property
	Type                       PropertyType `json:"type"`                                 // The data type of the property
	Origin                     Origin       `json:"origin"`                               // The origin of the property
	Aggregation                *Aggregation `json:"aggregation,omitempty"`                // The aggregation type of the property. It defines how multiple values of the property are aggregated
	StoreAsUserActionProperty  bool         `json:"storeAsUserActionProperty"`            // If `true`, the property is stored as a user action property
	StoreAsSessionProperty     bool         `json:"storeAsSessionProperty"`               // If `true`, the property is stored as a session property
	CleanupRule                *string      `json:"cleanupRule,omitempty"`                // The cleanup rule of the property. Defines how to extract the data you need from a string value. Specify the [regular expression](https://dt-url.net/k9e0iaq) for the data you need there
	ServerSideRequestAttribute *string      `json:"serverSideRequestAttribute,omitempty"` // The ID of the request attribute. Only applicable when the **origin** is set to `SERVER_SIDE_REQUEST_ATTRIBUTE`
	Name                       *string      `json:"name,omitempty"`                       // The name of the reported value. Only applicable when the **origin** is set to `API`
}

UserActionAndSessionProperty represents configuration of the mobile session or user action property