EventsResultData Class

Events query result data.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: EventsTraceResult, EventsCustomEventResult, EventsPageViewResult, EventsBrowserTimingResult, EventsRequestResult, EventsDependencyResult, EventsExceptionResult, EventsAvailabilityResultResult, EventsPerformanceCounterResult, EventsCustomMetricResult

All required parameters must be populated in order to send to Azure.

Inheritance
msrest.serialization.Model
EventsResultData

Constructor

EventsResultData(*, id: str = None, count: int = None, timestamp=None, custom_dimensions=None, custom_measurements=None, operation=None, session=None, user=None, cloud=None, ai=None, application=None, client=None, **kwargs)

Parameters

id
str
Required

The unique ID for this event.

count
<xref:long>
Required

Count of the event

timestamp
datetime
Required

Timestamp of the event

custom_dimensions
EventsResultDataCustomDimensions
Required

Custom dimensions of the event

custom_measurements
EventsResultDataCustomMeasurements
Required

Custom measurements of the event

operation
EventsOperationInfo
Required

Operation info of the event

session
EventsSessionInfo
Required

Session info of the event

user
EventsUserInfo
Required

User info of the event

cloud
EventsCloudInfo
Required

Cloud info of the event

ai
EventsAiInfo
Required

AI info of the event

application
EventsApplicationInfo
Required

Application info of the event

client
EventsClientInfo
Required

Client info of the event

type
str
Required

Required. Constant filled by server.

Keyword-Only Parameters

id
Required
count
Required
timestamp
Required
custom_dimensions
Required
custom_measurements
Required
operation
Required
session
Required
user
Required
cloud
Required
ai
Required
application
Required
client
Required

Methods

as_dict

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

deserialize

Parse a str using the RestAPI syntax and return a model.

enable_additional_properties_sending
from_dict

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

is_xml_model
serialize

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

validate

Validate this model recursively and return a list of ValidationError.

as_dict

Return a dict that can be JSONify using json.dump.

Advanced usage might optionally use a callback as parameter:

Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object.

The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.

See the three examples in this file:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

If you want XML serialization, you can pass the kwargs is_xml=True.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Parameters

key_transformer
<xref:function>

A key transformer function.

keep_readonly
default value: True

Returns

A dict JSON compatible object

Return type

deserialize

Parse a str using the RestAPI syntax and return a model.

deserialize(data, content_type=None)

Parameters

data
str
Required

A str using RestAPI structure. JSON by default.

content_type
str
default value: None

JSON by default, set application/xml if XML.

Returns

An instance of this model

Exceptions

DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

Parse a dict using given key extractor return a model.

By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)

from_dict(data, key_extractors=None, content_type=None)

Parameters

data
dict
Required

A dict using RestAPI structure

content_type
str
default value: None

JSON by default, set application/xml if XML.

key_extractors
default value: None

Returns

An instance of this model

Exceptions

DeserializationError if something went wrong

is_xml_model

is_xml_model()

serialize

Return the JSON that would be sent to azure from this model.

This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

If you want XML serialization, you can pass the kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Parameters

keep_readonly
bool
default value: False

If you want to serialize the readonly attributes

Returns

A dict JSON compatible object

Return type

validate

Validate this model recursively and return a list of ValidationError.

validate()

Returns

A list of validation error

Return type