datadog_api_client.v2.model¶

api_error_response¶

class APIErrorResponse(*args, **kwargs)¶

Bases: ModelNormal

API error response.

Parameters:: errors ([str]) – A list of errors.

api_key_create_attributes¶

class APIKeyCreateAttributes(*args, **kwargs)¶

Bases: ModelNormal

Attributes used to create an API Key.

Parameters:: name (str) – Name of the API key.

api_key_create_data¶

class APIKeyCreateData(*args, **kwargs)¶

Bases: ModelNormal

Object used to create an API key.

Parameters:

attributes (APIKeyCreateAttributes) – Attributes used to create an API Key.
type (APIKeysType) – API Keys resource type.

api_key_create_request¶

class APIKeyCreateRequest(*args, **kwargs)¶

Bases: ModelNormal

Request used to create an API key.

Parameters:: data (APIKeyCreateData) – Object used to create an API key.

api_key_relationships¶

class APIKeyRelationships(*args, **kwargs)¶

Bases: ModelNormal

Resources related to the API key.

Parameters:

created_by (RelationshipToUser, optional) – Relationship to user.
modified_by (RelationshipToUser, optional) – Relationship to user.

api_key_response¶

class APIKeyResponse(*args, **kwargs)¶

Bases: ModelNormal

Response for retrieving an API key.

Parameters:

data (FullAPIKey, optional) – Datadog API key.
included ([APIKeyResponseIncludedItem], optional) – Array of objects related to the API key.

api_key_response_included_item¶

class APIKeyResponseIncludedItem(*args, **kwargs)¶

Bases: ModelComposed

An object related to an API key.

Parameters:

attributes (UserAttributes, optional) – Attributes of user object returned by the API.
id (str, optional) – ID of the user.
relationships (UserResponseRelationships, optional) – Relationships of the user object returned by the API.
type (UsersType, optional) – Users resource type.

api_key_update_attributes¶

class APIKeyUpdateAttributes(*args, **kwargs)¶

Bases: ModelNormal

Attributes used to update an API Key.

Parameters:: name (str) – Name of the API key.

api_key_update_data¶

class APIKeyUpdateData(*args, **kwargs)¶

Bases: ModelNormal

Object used to update an API key.

Parameters:

attributes (APIKeyUpdateAttributes) – Attributes used to update an API Key.
id (str) – ID of the API key.
type (APIKeysType) – API Keys resource type.

api_key_update_request¶

class APIKeyUpdateRequest(*args, **kwargs)¶

Bases: ModelNormal

Request used to update an API key.

Parameters:: data (APIKeyUpdateData) – Object used to update an API key.

api_keys_response¶

class APIKeysResponse(*args, **kwargs)¶

Bases: ModelNormal

Response for a list of API keys.

Parameters:

data ([PartialAPIKey], optional) – Array of API keys.
included ([APIKeyResponseIncludedItem], optional) – Array of objects related to the API key.

api_keys_sort¶

class APIKeysSort(*args, **kwargs)¶

Bases: ModelSimple

Sorting options

Parameters:

value (str) – If omitted defaults to “name”. Must be one of [“created_at”, “-created_at”, “last4”, “-last4”, “modified_at”, “-modified_at”, “name”, “-name”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

api_keys_type¶

class APIKeysType(*args, **kwargs)¶

Bases: ModelSimple

API Keys resource type.

Parameters:

value (str) – If omitted defaults to “api_keys”. Must be one of [“api_keys”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

application_key_create_attributes¶

class ApplicationKeyCreateAttributes(*args, **kwargs)¶

Bases: ModelNormal

Attributes used to create an application Key.

Parameters:

name (str) – Name of the application key.
scopes ([str], none_type, optional) – Array of scopes to grant the application key. This feature is in private beta, please contact Datadog support to enable scopes for your application keys.

application_key_create_data¶

class ApplicationKeyCreateData(*args, **kwargs)¶

Bases: ModelNormal

Object used to create an application key.

Parameters:

attributes (ApplicationKeyCreateAttributes) – Attributes used to create an application Key.
type (ApplicationKeysType) – Application Keys resource type.

application_key_create_request¶

class ApplicationKeyCreateRequest(*args, **kwargs)¶

Bases: ModelNormal

Request used to create an application key.

Parameters:: data (ApplicationKeyCreateData) – Object used to create an application key.

application_key_relationships¶

class ApplicationKeyRelationships(*args, **kwargs)¶

Bases: ModelNormal

Resources related to the application key.

Parameters:: owned_by (RelationshipToUser, optional) – Relationship to user.

application_key_response¶

class ApplicationKeyResponse(*args, **kwargs)¶

Bases: ModelNormal

Response for retrieving an application key.

Parameters:

data (FullApplicationKey, optional) – Datadog application key.
included ([ApplicationKeyResponseIncludedItem], optional) – Array of objects related to the application key.

application_key_response_included_item¶

class ApplicationKeyResponseIncludedItem(*args, **kwargs)¶

Bases: ModelComposed

An object related to an application key.

Parameters:

attributes (UserAttributes, optional) – Attributes of user object returned by the API.
id (str, optional) – ID of the user.
relationships (UserResponseRelationships, optional) – Relationships of the user object returned by the API.
type (UsersType, optional) – Users resource type.

application_key_update_attributes¶

class ApplicationKeyUpdateAttributes(*args, **kwargs)¶

Bases: ModelNormal

Attributes used to update an application Key.

Parameters:

name (str, optional) – Name of the application key.
scopes ([str], none_type, optional) – Array of scopes to grant the application key. This feature is in private beta, please contact Datadog support to enable scopes for your application keys.

application_key_update_data¶

class ApplicationKeyUpdateData(*args, **kwargs)¶

Bases: ModelNormal

Object used to update an application key.

Parameters:

attributes (ApplicationKeyUpdateAttributes) – Attributes used to update an application Key.
id (str) – ID of the application key.
type (ApplicationKeysType) – Application Keys resource type.

application_key_update_request¶

class ApplicationKeyUpdateRequest(*args, **kwargs)¶

Bases: ModelNormal

Request used to update an application key.

Parameters:: data (ApplicationKeyUpdateData) – Object used to update an application key.

application_keys_sort¶

class ApplicationKeysSort(*args, **kwargs)¶

Bases: ModelSimple

Sorting options

Parameters:

value (str) – If omitted defaults to “name”. Must be one of [“created_at”, “-created_at”, “last4”, “-last4”, “name”, “-name”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

application_keys_type¶

class ApplicationKeysType(*args, **kwargs)¶

Bases: ModelSimple

Application Keys resource type.

Parameters:

value (str) – If omitted defaults to “application_keys”. Must be one of [“application_keys”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

audit_logs_event¶

class AuditLogsEvent(*args, **kwargs)¶

Bases: ModelNormal

Object description of an Audit Logs event after it is processed and stored by Datadog.

Parameters:

attributes (AuditLogsEventAttributes, optional) – JSON object containing all event attributes and their associated values.
id (str, optional) – Unique ID of the event.
type (AuditLogsEventType, optional) – Type of the event.

audit_logs_event_attributes¶

class AuditLogsEventAttributes(*args, **kwargs)¶

Bases: ModelNormal

JSON object containing all event attributes and their associated values.

Parameters:

attributes ({str: (bool, date, datetime, dict, float, int, list, str, none_type,)}, optional) – JSON object of attributes from Audit Logs events.
service (str, optional) – Name of the application or service generating Audit Logs events. This name is used to correlate Audit Logs to APM, so make sure you specify the same value when you use both products.
tags ([str], optional) – Array of tags associated with your event.
timestamp (datetime, optional) – Timestamp of your event.

audit_logs_event_type¶

class AuditLogsEventType(*args, **kwargs)¶

Bases: ModelSimple

Type of the event.

Parameters:

value (str) – If omitted defaults to “audit”. Must be one of [“audit”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

audit_logs_events_response¶

class AuditLogsEventsResponse(*args, **kwargs)¶

Bases: ModelNormal

Response object with all events matching the request and pagination information.

Parameters:

data ([AuditLogsEvent], optional) – Array of events matching the request.
links (AuditLogsResponseLinks, optional) – Links attributes.
meta (AuditLogsResponseMetadata, optional) – The metadata associated with a request.

audit_logs_query_filter¶

class AuditLogsQueryFilter(*args, **kwargs)¶

Bases: ModelNormal

Search and filter query settings.

Parameters:

_from (str, optional) – Minimum time for the requested events. Supports date, math, and regular timestamps (in milliseconds).
query (str, optional) – Search query following the Audit Logs search syntax.
to (str, optional) – Maximum time for the requested events. Supports date, math, and regular timestamps (in milliseconds).

audit_logs_query_options¶

class AuditLogsQueryOptions(*args, **kwargs)¶

Bases: ModelNormal

Global query options that are used during the query. Note: Specify either timezone or time offset, not both. Otherwise, the query fails.

Parameters:

time_offset (int, optional) – Time offset (in seconds) to apply to the query.
timezone (str, optional) – The timezone can be specified as GMT, UTC, an offset from UTC (like UTC+1), or as a Timezone Database identifier (like America/New_York).

audit_logs_query_page_options¶

class AuditLogsQueryPageOptions(*args, **kwargs)¶

Bases: ModelNormal

Paging attributes for listing events.

Parameters:

cursor (str, optional) – List following results with a cursor provided in the previous query.
limit (int, optional) – Maximum number of events in the response.

audit_logs_response_links¶

class AuditLogsResponseLinks(*args, **kwargs)¶

Bases: ModelNormal

Links attributes.

Parameters:: next (str, optional) – Link for the next set of results. Note that the request can also be made using the POST endpoint.

audit_logs_response_metadata¶

class AuditLogsResponseMetadata(*args, **kwargs)¶

Bases: ModelNormal

The metadata associated with a request.

Parameters:

elapsed (int, optional) – Time elapsed in milliseconds.
page (AuditLogsResponsePage, optional) – Paging attributes.
request_id (str, optional) – The identifier of the request.
status (AuditLogsResponseStatus, optional) – The status of the response.
warnings ([AuditLogsWarning], optional) – A list of warnings (non-fatal errors) encountered. Partial results may return if warnings are present in the response.

audit_logs_response_page¶

class AuditLogsResponsePage(*args, **kwargs)¶

Bases: ModelNormal

Paging attributes.

Parameters:: after (str, optional) – The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of page[cursor].

audit_logs_response_status¶

class AuditLogsResponseStatus(*args, **kwargs)¶

Bases: ModelSimple

The status of the response.

Parameters:

value (str) – Must be one of [“done”, “timeout”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

audit_logs_search_events_request¶

class AuditLogsSearchEventsRequest(*args, **kwargs)¶

Bases: ModelNormal

The request for a Audit Logs events list.

Parameters:

filter (AuditLogsQueryFilter, optional) – Search and filter query settings.
options (AuditLogsQueryOptions, optional) – Global query options that are used during the query. Note: Specify either timezone or time offset, not both. Otherwise, the query fails.
page (AuditLogsQueryPageOptions, optional) – Paging attributes for listing events.
sort (AuditLogsSort, optional) – Sort parameters when querying events.

audit_logs_sort¶

class AuditLogsSort(*args, **kwargs)¶

Bases: ModelSimple

Sort parameters when querying events.

Parameters:

value (str) – Must be one of [“timestamp”, “-timestamp”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

audit_logs_warning¶

class AuditLogsWarning(*args, **kwargs)¶

Bases: ModelNormal

Warning message indicating something that went wrong with the query.

Parameters:

code (str, optional) – Unique code for this type of warning.
detail (str, optional) – Detailed explanation of this specific warning.
title (str, optional) – Short human-readable summary of the warning.

authn_mapping¶

class AuthNMapping(*args, **kwargs)¶

Bases: ModelNormal

The AuthN Mapping object returned by API.

Parameters:

attributes (AuthNMappingAttributes, optional) – Attributes of AuthN Mapping.
id (str) – ID of the AuthN Mapping.
relationships (AuthNMappingRelationships, optional) – All relationships associated with AuthN Mapping.
type (AuthNMappingsType) – AuthN Mappings resource type.

authn_mapping_attributes¶

class AuthNMappingAttributes(*args, **kwargs)¶

Bases: ModelNormal

Attributes of AuthN Mapping.

Parameters:

attribute_key (str, optional) – Key portion of a key/value pair of the attribute sent from the Identity Provider.
attribute_value (str, optional) – Value portion of a key/value pair of the attribute sent from the Identity Provider.
created_at (datetime, optional) – Creation time of the AuthN Mapping.
modified_at (datetime, optional) – Time of last AuthN Mapping modification.
saml_assertion_attribute_id (str, optional) – The ID of the SAML assertion attribute.

authn_mapping_create_attributes¶

class AuthNMappingCreateAttributes(*args, **kwargs)¶

Bases: ModelNormal

Key/Value pair of attributes used for create request.

Parameters:

attribute_key (str, optional) – Key portion of a key/value pair of the attribute sent from the Identity Provider.
attribute_value (str, optional) – Value portion of a key/value pair of the attribute sent from the Identity Provider.

authn_mapping_create_data¶

class AuthNMappingCreateData(*args, **kwargs)¶

Bases: ModelNormal

Data for creating an AuthN Mapping.

Parameters:

attributes (AuthNMappingCreateAttributes, optional) – Key/Value pair of attributes used for create request.
relationships (AuthNMappingCreateRelationships, optional) – Relationship of AuthN Mapping create object to Role.
type (AuthNMappingsType) – AuthN Mappings resource type.

authn_mapping_create_relationships¶

class AuthNMappingCreateRelationships(*args, **kwargs)¶

Bases: ModelNormal

Relationship of AuthN Mapping create object to Role.

Parameters:: role (RelationshipToRole, optional) – Relationship to role.

authn_mapping_create_request¶

class AuthNMappingCreateRequest(*args, **kwargs)¶

Bases: ModelNormal

Request for creating an AuthN Mapping.

Parameters:: data (AuthNMappingCreateData) – Data for creating an AuthN Mapping.

authn_mapping_included¶

class AuthNMappingIncluded(*args, **kwargs)¶

Bases: ModelComposed

Included data in the AuthN Mapping response.

Parameters:

attributes (SAMLAssertionAttributeAttributes, optional) – Key/Value pair of attributes used in SAML assertion attributes.
id (str) – The ID of the SAML assertion attribute.
type (SAMLAssertionAttributesType) – SAML assertion attributes resource type.
relationships (RoleResponseRelationships, optional) – Relationships of the role object returned by the API.

authn_mapping_relationships¶

class AuthNMappingRelationships(*args, **kwargs)¶

Bases: ModelNormal

All relationships associated with AuthN Mapping.

Parameters:

role (RelationshipToRole, optional) – Relationship to role.
saml_assertion_attribute (RelationshipToSAMLAssertionAttribute, optional) – AuthN Mapping relationship to SAML Assertion Attribute.

authn_mapping_response¶

class AuthNMappingResponse(*args, **kwargs)¶

Bases: ModelNormal

AuthN Mapping response from the API.

Parameters:

data (AuthNMapping, optional) – The AuthN Mapping object returned by API.
included ([AuthNMappingIncluded], optional) – Included data in the AuthN Mapping response.

authn_mapping_update_attributes¶

class AuthNMappingUpdateAttributes(*args, **kwargs)¶

Bases: ModelNormal

Key/Value pair of attributes used for update request.

Parameters:

attribute_key (str, optional) – Key portion of a key/value pair of the attribute sent from the Identity Provider.
attribute_value (str, optional) – Value portion of a key/value pair of the attribute sent from the Identity Provider.

authn_mapping_update_data¶

class AuthNMappingUpdateData(*args, **kwargs)¶

Bases: ModelNormal

Data for updating an AuthN Mapping.

Parameters:

attributes (AuthNMappingUpdateAttributes, optional) – Key/Value pair of attributes used for update request.
id (str) – ID of the AuthN Mapping.
relationships (AuthNMappingUpdateRelationships, optional) – Relationship of AuthN Mapping update object to Role.
type (AuthNMappingsType) – AuthN Mappings resource type.

authn_mapping_update_relationships¶

class AuthNMappingUpdateRelationships(*args, **kwargs)¶

Bases: ModelNormal

Relationship of AuthN Mapping update object to Role.

Parameters:: role (RelationshipToRole, optional) – Relationship to role.

authn_mapping_update_request¶

class AuthNMappingUpdateRequest(*args, **kwargs)¶

Bases: ModelNormal

Request to update an AuthN Mapping.

Parameters:: data (AuthNMappingUpdateData) – Data for updating an AuthN Mapping.

authn_mappings_response¶

class AuthNMappingsResponse(*args, **kwargs)¶

Bases: ModelNormal

Array of AuthN Mappings response.

Parameters:

data ([AuthNMapping], optional) – Array of returned AuthN Mappings.
included ([AuthNMappingIncluded], optional) – Included data in the AuthN Mapping response.
meta (ResponseMetaAttributes, optional) – Object describing meta attributes of response.

authn_mappings_sort¶

class AuthNMappingsSort(*args, **kwargs)¶

Bases: ModelSimple

Sorting options for AuthN Mappings.

Parameters:

value (str) – Must be one of [“created_at”, “-created_at”, “role_id”, “-role_id”, “saml_assertion_attribute_id”, “-saml_assertion_attribute_id”, “role.name”, “-role.name”, “saml_assertion_attribute.attribute_key”, “-saml_assertion_attribute.attribute_key”, “saml_assertion_attribute.attribute_value”, “-saml_assertion_attribute.attribute_value”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

authn_mappings_type¶

class AuthNMappingsType(*args, **kwargs)¶

Bases: ModelSimple

AuthN Mappings resource type.

Parameters:

value (str) – If omitted defaults to “authn_mappings”. Must be one of [“authn_mappings”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

chargeback_breakdown¶

class ChargebackBreakdown(*args, **kwargs)¶

Bases: ModelNormal

Charges breakdown.

Parameters:

charge_type (str, optional) – The type of charge for a particular product.
cost (float, optional) – The cost for a particular product and charge type during a given month.
product_name (str, optional) – The product for which cost is being reported.

ci_app_aggregate_bucket_value¶

class CIAppAggregateBucketValue(*args, **kwargs)¶

Bases: ModelComposed

A bucket value, can either be a timeseries or a single value.

ci_app_aggregate_bucket_value_timeseries¶

class CIAppAggregateBucketValueTimeseries(*args, **kwargs)¶

Bases: ModelSimple

A timeseries array.

Parameters:

_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

ci_app_aggregate_bucket_value_timeseries_point¶

class CIAppAggregateBucketValueTimeseriesPoint(*args, **kwargs)¶

Bases: ModelNormal

A timeseries point.

Parameters:

time (datetime, optional) – The time value for this point.
value (float, optional) – The value for this point.

ci_app_aggregate_sort¶

class CIAppAggregateSort(*args, **kwargs)¶

Bases: ModelNormal

A sort rule.

Parameters:

aggregation (CIAppAggregationFunction, optional) – An aggregation function.
metric (str, optional) – The metric to sort by (only used for type=measure ).
order (CIAppSortOrder, optional) – The order to use, ascending or descending.
type (CIAppAggregateSortType, optional) – The type of sorting algorithm.

ci_app_aggregate_sort_type¶

class CIAppAggregateSortType(*args, **kwargs)¶

Bases: ModelSimple

The type of sorting algorithm.

Parameters:

value (str) – If omitted defaults to “alphabetical”. Must be one of [“alphabetical”, “measure”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

ci_app_aggregation_function¶

class CIAppAggregationFunction(*args, **kwargs)¶

Bases: ModelSimple

An aggregation function.

Parameters:

value (str) – Must be one of [“count”, “cardinality”, “pc75”, “pc90”, “pc95”, “pc98”, “pc99”, “sum”, “min”, “max”, “avg”, “median”, “latest”, “earliest”, “most_frequent”, “delta”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

ci_app_compute¶

class CIAppCompute(*args, **kwargs)¶

Bases: ModelNormal

A compute rule to compute metrics or timeseries.

Parameters:

aggregation (CIAppAggregationFunction) – An aggregation function.
interval (str, optional) – The time buckets’ size (only used for type=timeseries) Defaults to a resolution of 150 points.
metric (str, optional) – The metric to use.
type (CIAppComputeType, optional) – The type of compute.

ci_app_compute_type¶

class CIAppComputeType(*args, **kwargs)¶

Bases: ModelSimple

The type of compute.

Parameters:

value (str) – If omitted defaults to “total”. Must be one of [“timeseries”, “total”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If