Maintenance yes MIT license Open Source? Yes! made-with-python code-black vulnerabilities codecov

PyTan: Python API for the Tanium Platform

PyTan is an all-in-one API wrapper for Tanium and is comprised of multiple modular layers that make it easy to extend or add new functionality.

Since the inception of PyTan in October of 2014 it has grown in scope, complexity, and adoption. This version marks the fourth redesign, and it has vast improvements over the previous versions.

Read why PyTan was created and the list of features to get an understanding of the intent and capabilities of PyTan.

Installation is simple using standard Python packaging tools.

Table of Contents

Purpose

PyTan was created for a number of reasons:

  1. To provide a way for Python programmers to work with the Tanium API using native Python objects.
  2. To provide workflow encapsulation for Python programmers that contains the order of steps it takes to do something. For each step in a workflow, a workflow knows what attributes need to be defined in a request, how to handle the response, and how the response should be passed on to the next step.
  3. To provide a command line interface for non Python programmers that exposes the workflow encapsulation via a Python script that takes in arguments and options and passes them on to the underlying workflow.

Features

  1. Automation

    Create scripts that automate any concept you can think of.

    For example: You can write a script that asks a question, gets the results, and emails it to you. Then you can schedule that script via Task Scheduler/cron/etc to run every night.

  2. Integration

    Create seamless integrations with other products.

    For example: You can write an integration with a ticketing system to have it automatically ask a question and include the results in the ticket.

  3. Complete API exposure

    Anything that Tanium can do can be done via PyTan.

    It is a complete exposure of the Tanium API, which is what the web browser interface uses to perform all of its functions.

  4. Workflow encapsulation

    Workflows remove the need for users of the Tanium API to know how requests must be sent for a given set of operations.

    For instance:

    • Asking a question, waiting for results, and then getting result data can equate to over 100 API calls.
    • Creating a user, assigning it to various RBAC roles, user groups, and so on can take over 30 API calls.

    Todo

    No workflows are shipped with PyTan as of yet. It will take time to convert all of the workflows from PyTan 2.x into the new architecture built for PyTan 3.x.

    Planned for version: 3.1.0

  5. Command Line encapsulation around Workflows

    Command Line Interfaces make it so that users of the Tanium API do not even need to know PyTan to utilize the various workflows provided by PyTan.

    There are people in the IT world that prefer to work from a command line. PyTan makes that possible for users of Tanium.

    Todo

    No command line interfaces are shipped with PyTan as of yet. The workflows will need to be done first, and then the logic for how to wrap those workflows seamlessly into command line scripts will take some effort.

    Planned for version: 3.2.0

  6. Security

    PyTan version 3 enforces SSL certificate validation for each Tanium server it connects to, and will prompt on the initial connection to a Tanium server for validity by showing information from the certificate and asking the user if it is valid.

    It also provides a secure method for storing credentials to disk at state, making it so that credentials aren’t stored in plain text on scripts somewhere on disk.

  7. Multiplatform support

    PyTan is written with the goal of working out of the box on all major Operating systems.

  8. Python 2 and 3 support

    PyTan version 3 supports both Python 2 and Python 3. Previous versions of PyTan only supported Python 2.

  9. Layered concept

    PyTan version 3 has all of its functionality organized into specific layers that build on top of each other.

    This version has 10 layers which make it vastly easier to maintain and extend PyTan, whereas previous versions of PyTan had all of the functionality bundled into one to three layers.

    All layers utilize Abstract Base Classes to establish a contract on the implementation of that specific layer.

    This allows each layer to have a well defined interface that enforces each implementation of that layer to work the same. It also makes it easy to support new API types, API commands, API versions, and more.

    For example: Authentication methods, API Clients, API Adapters, API Results, and API objects will each work the same regardless of the underlying implementation.

  10. Version checking

    Each layer in PyTan3 that relies on the Tanium API has the ability to specify that the Tanium platform servers version is an exact version, or is at least a minimum version, or is at most a maximum version.

    This allows each object in a layer to specify what version(s) it will work with.

  11. Type Checking

    Each layer in PyTan3 that relies on the Tanium API has the ability to specify what type of API it supports.

Installation

PyTan is actively maintained on GitHub, where the code is always available.

Make sure you have installed a supported version of Python.

Installing PyTan via pip or pipenv will automatically install all of the necessary dependencies.

Install into the system site-packages using pip

$ pip install pytan3

Read more about pip

Install into a virtual environment using pipenv

$ pipenv install pytan3

Read more about pipenv

Clone the pytan3 repository using git

$ git clone git://github.com/tanium/pytan3.git

Directly from GitHub

Get the master branch which will always be the most recent stable release, or download a specific version from the releases page.

Todo

It is planned to create a batteries included distribution of PyTan for Windows that will include Python 3.7.x as well as PyTan and all of its dependencies.

Planned for version: 3.2.0

Future Releases

3.1.0

Rough ETA: 2019-04-01

  • enhancement: Add workflows from PyTan v2
  • enhancement: Add API commands for ImportObject, ExportObject, VerifySignature, and UploadFile
  • enhancement: Add ability for test suite to automatically use Authentication Store
  • enhancement: Add utility to generate Authentication Store
  • verify: Verify that options supplied in REST tanium-options header do not conflict with options supplied in URL as parameters

3.2.0

Rough ETA: 2019-05-01

  • enhancement: Add Command Line Interfaces
  • enhancement: Add API interfaces to API Clients: module API passthru, /hash API, /string API, /file API, /cache API
  • enhancement: Create a batteries included distribution

Supported Versions

Supported Python versions

  • 3.7.x
  • 2.7.x

Note

While Python 2.7.x is currently supported and tested, due to it’s EOL of January 2020 it will be dropped from the testing category very soon.

It will remain supported until the next major rewrite of PyTan or until pip drops support for Python 2.7.x, whichever comes first.

Note

Other versions of Python could work beyond the tested versions.

If PyTan fails to work with a supported version of Python, it will be fixed as long as the changes required do not introduce breaking changes to the PyTan API and do not break support for the supported versions.

Supported Operating Systems

  • Windows 10
  • Windows 2010 and later
  • Windows Server 2008 R2 and later
  • Mac OS X 10.12 “Sierra” and later
  • Any recent and major Linux distribution

Tested Operating systems for Python 3.7.2

  • Windows 10 Professional
  • Windows Server 2008 R2
  • Windows Server 2012 R2
  • Mac OS X 10.14.3 “Mojave”
  • Ubuntu 18.04.2 LTS (Bionic Beaver)

Tested Operating systems for Python 3.7.1

  • Mac OS X 10.14.3 “Mojave”

Tested Operating systems for Python 3.7.0

  • Mac OS X 10.14.3 “Mojave”

Tested Operating systems for Python 2.7.15

  • Windows 10 Professional
  • Windows Server 2008 R2
  • Windows Server 2012 R2
  • Mac OS X 10.14.3 “Mojave”
  • Ubuntu 18.04.2 LTS (Bionic Beaver)

Note

PyTan is written on Mac OS X, so that will always be the most tested.

Supported Tanium Versions

  • Tanium 7.2.314.xxxx
  • Tanium 7.3.314.xxxx

Tested Tanium SOAP API versions

  • Tanium 7.2.314.3181
  • Tanium 7.3.314.3424
  • Tanium 7.3.314.3641

Tested Tanium REST API versions

  • Tanium 7.3.314.3424
  • Tanium 7.3.314.3641

Note

REST API only exists in versions after 7.3.314.3424.

Note

PyTan is not supported or tested on versions earlier than 7.2.314.xxxx, but a large portion of functionality should still work.

Release Strategy

All releases will have tags and branches named after their version number, and will also be published on the releases page.

Major releases

A major release will include breaking changes. If the previous release was v2.0.0 the next version will be v3.0.0.

Breaking changes are changes that break backwards compatibility with prior versions. If an API command was removed or the interface for a layer is completely different, that would only happen in a Major release.

Major releases may also include miscellaneous bug fixes. The core developers of PyTan are committed to providing a good user experience. This means we’re also committed to preserving backwards compatibility as much as possible. Major releases will be infrequent and will need strong justifications before they are considered.

With that in mind, PyTan version 3 is a major release and as such has a vastly different architecture than version 2.

Any scripts that were written to use version 2 will not work with version 3.

Minor releases

A minor release will not include breaking changes but may include miscellaneous bug fixes. If the previous version of PyTan released was v3.1.0 a minor release would be versioned as v3.2.0.

Minor releases will be backwards compatible with releases that have the same major version number. In other words, all versions that would start with v3. should be compatible with each other.

Micro releases

A micro release will only include bug fixes that were missed when the previous version was released. If the previous version of PyTan released v3.1.0 the hotfix release would be versioned as v3.1.1.

Getting Help

Have a bug report or feature request?

Do not hesitate to file an issue with the appropriate label and with as many details as possible.

Feature requests are always welcome, especially for new workflows.

If you need help using PyTan, please ask your Technical Account Manager for assistance or email the author and maintainer of PyTan: Jim Olsen.

Giving Help

Contributions are most welcome. If you are not familiar with how to contribute to a project on GitHub, feel free to read this.

Since the foundation of PyTan is done, the next release of PyTan is focusing on Workflows. The design of how Workflows will be implemented is still being hashed out, but when it is finalized Workflow contributions will be very welcome.

The master branch is the stable branch, and should never have pull requests. Instead, pull requests should be performed against development version branches. The current version under development will always be named after the intended release followed by -dev, for example: 3.1.0-dev.

Maintainers:

Contributors:

  • None as of yet

API Layers

  1. HTTP Client

    The lowest layer and the core foundation of PyTan that handles sending and receiving requests using the requests package. It provides SSL certificate validation and user verification similar to a web browser, recording of requests and responses to files, and more.

  2. Authentication Methods

    Authentication methods use an HTTP Client to authenticate against a Tanium platform server and receive a session token. They provide functionalities such as login, logout, logout all, and validate token.

  3. Authentication Store

    The Authentication Store provides a secure way to store an Authentication method.

  4. API Clients

    API clients use an HTTP Client and an Authentication Method to communicate with a specific type of API.

    API Clients know how to communicate with a specific API path, but do not have any native ability to construct the request bodies or parse the response bodies.

  5. API Object Modules

    API Object Modules contain the object definitions used by the Tanium API as native Python objects.

    They are automatically generated using the WSDL for a given Tanium Platform version, and can be modified to work with a specific platform version and API type.

  6. Models for API Object Modules

    API Models provide the base classes that make API Objects work like Python objects. They contain the functionality for list objects from the Tanium API to work like Python lists, and for item objects from the Tanium API to work like Python objects with each of the defined attributes from the API exposed as attributes on the object.

  7. Adapters

    Adapters use an API client combined with an API object module to create and send requests. Adapters are responsible for:

    • Exposing API commands like get, add, delete, modify, and more.
    • Converting (serializing) a Python object from an API object module into a text string.
    • Creating a request body that contains the converted python object in a format that a given type of API understands.
    • Sending the request body using an API client and returning the response in a Result.

  8. Results

    Results are heavily tethered to an Adapter, and are responsible for:

    • Checking for errors in the response and throwing the appropriate exception when an object already exists, an object is not found, a request was not properly formed, or a response returned an error.
    • Parsing the response from a request sent by an Adapter into a Python dictionary object.
    • Converting (deserializing) the objects or data set in the response into a Python object from an API object module.

  9. Workflows

    Workflows rely on an Adapter and encapsulate all of the steps needed to perform complex operations into one function. A number of workflows are planned:

    • Adding, updating, deleting users, groups, RBAC, dashboards, and more…
    • Asking saved questions and getitng the answers back in various output forms
    • Asking parsed questions and getitng the answers back in various output forms
    • Asking manually crafted questions and getitng the answers back in various output forms
    • And more…

    Todo

    No workflows are shipped with PyTan as of yet. It will take time to convert all of the workflows from PyTan 2.x into the new architecture built for PyTan 3.x.

    Planned for version: 3.1.0

  10. Command Line Interfaces

    The highest layer that provides Python scripts that expose Workflows to command line users and removes the need for a user to know how to program in Python in order to utilize PyTan.

    Todo

    No command line interfaces are shipped with PyTan as of yet. The workflows will need to be done first, and then the logic for how to wrap those workflows seamlessly into command line scripts will take some effort.

    Planned for version: 3.2.0

API Reference

Python object layer and workflow encapsulation for Tanium’s API.

HTTP Client

Client for making HTTP requests.

pytan3.http_client.CERT_FILE = '{http_client.parsed_url.hostname}.pem'

str – Certificate filename template for Certify.__call__().

pytan3.http_client.RECORD_FILE = '%Y_%m_%dT%H_%M_%S_%fZ.json'

str – Record filename template for HttpClient.response_hook_disk().

pytan3.http_client.SHOW_CERT = 'no'

bool – Default prompt value for “Show full certificate info” in Certify.verify_hook().

Will use OS Environment variable “PYTAN_SHOW_CERT” if set.

pytan3.http_client.SHOW_CHAIN = 'no'

bool – Default prompt value for “Show certificate chain info” in Certify.verify_hook().

Will use OS Environment variable “PYTAN_SHOW_CHAIN” if set.

pytan3.http_client.CERT_VALID = 'no'

bool – Default prompt value for “Consider certificate valid” in Certify.verify_hook().

Will use OS Environment variable “PYTAN_CERT_VALID” if set.

class pytan3.http_client.HttpClient(url, timeout=5, lvl='info')[source]

Bases: object

Convenience class for requests package.

CLEAN_HOOKS = {'/api/v\\d?/session': ['clean_hook_auth_rest'], '/auth': ['clean_hook_auth']}

dict – URL regex matches for cleaning bodies in cleaning hooks.

CLEAN_AUTH_KEYS = ['username', 'password', 'domain', 'secondary']

list of str – Keys to clean in cleaning hooks.

CLEAN_HIDE = '###HIDDEN###'

str – Text to use to hide values in cleaning hooks.

__init__(url, timeout=5, lvl='info')[source]

Constructor.

Parameters:
  • url (str) – URL to use.
  • timeout (int, optional) –

    Connect timeout to use for requests.

    Defaults to: 5.

  • lvl (str, optional) –

    Logging level for this object.

    Defaults to: “info”.
log = None

logging.Logger – Log for this object.

timeout = None

int – Connect timeout used for all requests.

parsed_url = None

UrlParser – Parsed version of URL.

last_request = None

requests.PreparedRequest – Last request sent.

last_response = None

requests.Response – Last response received.

history = None

list – History of all responses received.

Used by HttpClient.response_hook_history().

record_path = None

pathlib.Path – Path to store response recordings to.

session = None

requests.Session – Requests session object.

certify = None

Certify – Certificate Magic object.

url

Get the URL string from HttpClient.parsed_url.

Returns:str
__str__()[source]

Show object info.

Returns:str
__repr__()[source]

Show object info.

Returns:str
__call__(method='get', path='', data=None, timeout=5, params=None, headers=None, b64_headers=None, verify=True, **kwargs)[source]

Create, prepare a request, and then send it.

Parameters:
  • method (str, optional) –

    Method to use.

    Defaults to: “get”.

  • path (str, optional) –

    Path to append to HttpClient.url for this request.

    Defaults to: “”.

  • data (str, optional) –

    Data to send with POST.

    Defaults to: None.

  • timeout (int, optional) –

    Response timeout.

    Defaults to: 5.

  • params (dict, optional) –

    URL parameters.

    Defaults to: None.

  • headers (dict, optional) –

    Headers.

    Defaults to: None.

  • b64_headers (list of str, optional) –

    Headers to base 64 encode.

    Defaults to: None.

  • verify (bool or str, optional) –

    Enable/Disable SSL certificate validation using built in CAs, or a path to custom cert.

    Defaults to: True.

  • **kwargs –

    cause (str): String to explain purpose of request.

    Defaults to: “”.

Notes

If verify is True or None, verification is done using default/built in CA. OS env vars $REQUESTS_CA_BUNDLE, and $CURL_CA_BUNDLE are used if set and trust_env is True, and if trust_env is False session’s verify is used.

If verify is False, no verification is done. This overrides OS env and session’s verify for this request and no verification is done at all. Don’t do this.

If verify is a str, verification is done with PEM file at path. This overrides OS env and session’s verify for this request.

Caveat: If previous request made with session and close has not been called on session, the verify of the previous request will be used no matter what is supplied here.

Returns:requests.Response
control_hook(enable, hook)[source]

Add or remove a hook from HttpClient.session.

Parameters:
  • enable (bool) – True: Add hook to session. False: Remove hook from session.
  • hook (object) – Hook function to add/remove to session.
Returns:

True/False if hook was actually removed/added.
Return type:

bool
control_hook_record_disk(enable=False, path=None, path_sub='records')[source]

Add or remove session hook for recording responses to disk.

Parameters:
control_hook_record_history(enable=False)[source]

Add or remove session hook for recording in local class.

Parameters:enable (bool, optional) –

Add/remove HttpClient.response_hook_history() to session hooks.

Defaults to: False.
response_hook_log_debug(response, *args, **kwargs)[source]

Response hook to log info.

Parameters:
Returns:

requests.Response
response_hook_clean(response, *args, **kwargs)[source]

Response hook to add cleaned versions of request/response body and headers.

Parameters:
Returns:

requests.Response
static clean_hook_auth_rest(http_client, response)[source]

Clean hook to hide auth keys in a response from REST session route.

Parameters:
Returns:

requests.Response
static clean_hook_auth(http_client, response)[source]

Clean hook to hide auth headers in a response from /auth API.

Parameters:
Returns:

requests.Response
response_hook_history(response, *args, **kwargs)[source]

Response hook to add response to HttpClient.history.

Parameters:
response_hook_disk(response, *args, **kwargs)[source]

Response hook to write response to HttpClient.record_path.

Parameters:
Returns:

requests.Response
serialize_response(response)[source]

Churn a response into JSON serializeable format.

Parameters:response (requests.Response) – Response object to churn.
Returns:dict
parse_url(url)[source]

Parse a URL using UrlParser.

Parameters:url (str) – URL to parse.
Returns:UrlParser
user_agent

Build a user agent string for use in headers.

Returns:str

Certificate verification for HTTP Client

class pytan3.http_client.Certify(http_client, lvl='info')[source]

Bases: object

Certificate verification magic.

__init__(http_client, lvl='info')[source]

Constructor.

Parameters:
  • http_client (HttpClient) – Client to use for getting certificates and configuring the verify attribute on HttpClient.session
  • lvl (str, optional) –

    Logging level for this object.

    Defaults to: “info”.
log = None

logging.Logger – Logger for this object.

http_client = None

HttpClient – Client for this object.

using_custom_cert = None

bool – If we are using a cert from disk or not.

__call__(path=None, path_sub='certs', path_file='{http_client.parsed_url.hostname}.pem', verify_hook=None, overwrite=False, lvl=None)[source]

Validate, find, or get certificate for URL.

Parameters:
  • path (str or pathlib.Path, optional) –

    Storage directory to use. If empty, resolve path via pytan3.utils.tools.get_storage_dir().

    Defaults to: None.

  • path_sub (str, optional) –

    Sub directory under path that should contain path_file.

    Defaults to: “certs”

  • path_file (str, optional) –

    Filename to use for cert file under path / path_sub.

    Defaults to: CERT_FILE

  • verify_hook (callable or False) –

    A callable used to verify a SSL cert from URL before writing it to disk.

    Only used if default cert is invalid and path/path_sub/path_file does not exist.

    If False, cert is written to disk without running any verify hook.

    If None, uses Certify.verify_hook() as verify hook.

    If callable, called with args: store, store_chain, and parsed_url.

    Defaults to: None.

  • overwrite (bool, optional) –

    Overwrite cert at path if already exists.

    Defaults to: False.

  • lvl (str, optional) –

    If not None, change logging level for this object.

    Defaults to: None.
Raises:

exceptions.CertificateNotFoundWarning – If cert at URL is not valid using default cert validation, and no cert can be found at path.
__str__()[source]

Show object info.

Returns:str
__repr__()[source]

Show object info.

Returns:str
write_pem(path, overwrite=False)[source]

Write a certificate in PEM format to disk.

Parameters:
  • path (str or pathlib.Path) – Path to write PEM certificate to.
  • overwrite (bool, optional) –

    Overwrite cert at path if already exists.

    Defaults to: False.
Returns:

pathlib.Path
static verify_hook(store, store_chain, parsed_url)[source]

Verify cert by prompting user, default hook.

Parameters:
Raises:

exceptions.CertificateInvalidError – If user replies No to validity prompt.
store

Get CertStore for URL.

Returns:cert_human.CertStore
store_chain

Get CertChainStore for URL.

Returns:cert_human.CertChainStore
_fetch_stores

Get the CertStore and CertChainStore for URL.

Returns:(cert_human.CertStore, cert_human.CertChainStore)
check_default()[source]

Check if cert for URL is valid without setting a specific path.

Returns:bool
check_path(path)[source]

Check if cert at path is valid for URL.

Parameters:path (str or pathlib.Path) – Path to PEM certificate file.

Notes

If validation is successful, the verify attribute on HttpClient.session will be set to path.

Raises:exceptions.CertificateInvalidError – If path fails verification.

URL Parser for HTTP Client

class pytan3.http_client.UrlParser(url, default_scheme='')[source]

Bases: object

Parse a URL and ensure it has the neccessary bits.

__init__(url, default_scheme='')[source]

Constructor.

Parameters:
  • url (str) – URL to parse
  • default_scheme (str, optional) –

    If no scheme in URL, use this.

    Defaults to: “”
Raises:

exceptions.ModuleError – If parsed URL winds up without a hostname, port, or scheme.
_init_url = None

str – Initial URL provided.

_init_scheme = None

str – Default scheme provided.

_init_parsed = None

urllib.parse.ParseResult – First pass of parsing URL.

parsed = None

urllib.parse.ParseResult – Second pass of parsing URL.

__str__()[source]

Show object info.

Returns:str
__repr__()[source]

Show object info.

Returns:str
hostname

Hostname part from UrlParser.parsed.

Returns:str
port

Port part from UrlParser.parsed.

Returns:int
scheme

Scheme part from UrlParser.parsed.

Returns:str
url

Get scheme, hostname, and port from UrlParser.parsed.

Returns:str
url_full

Get full URL from UrlParser.parsed.

Returns:str
parsed_str

Create string of UrlParser.parsed.

Returns:str
make_netloc(host, port)[source]

Create netloc from host and port.

Parameters:
  • host (str) – Host part to use in netloc.
  • port (str) – Port part to use in netloc.
Returns:

str
reparse(parsed, default_scheme='')[source]

Reparse a parsed URL into a parsed URL with values fixed.

Parameters:
  • parsed (urllib.parse.ParseResult) – Parsed URL to reparse.
  • default_scheme (str, optional) –

    If no scheme in URL, use this.

    Defaults to: “”
Returns:

urllib.parse.ParseResult
unparse_base(p)[source]

Unparse a parsed URL into just the scheme, hostname, and port parts.

Parameters:p (urllib.parse.ParseResult) – Parsed URL to unparse.
Returns:str
unparse_all(p)[source]

Unparse a parsed URL with all the parts.

Parameters:p (urllib.parse.ParseResult) – Parsed URL to unparse.
Returns:str

Exceptions for HTTP Client

Exceptions and warnings for pytan3.http_client.

exception pytan3.http_client.exceptions.ModuleError[source]

Bases: pytan3.exceptions.PyTanError

Parent of all exceptions for pytan3.http_client.

Thrown by:
exception pytan3.http_client.exceptions.ModuleWarning[source]

Bases: pytan3.exceptions.PyTanWarning

Parent of all warnings for pytan3.http_client.

Thrown by:

exception pytan3.http_client.exceptions.CertificateNotFoundWarning[source]

Bases: pytan3.http_client.exceptions.ModuleWarning

Thrown when a cert can not be found.

Thrown by:
exception pytan3.http_client.exceptions.CertificateInvalidError[source]

Bases: pytan3.http_client.exceptions.ModuleError

Thrown when cert is invalid from path or from user prompt.

Thrown by:

Authentication Methods

Authentication methods for the Tanium API.

pytan3.auth_methods.DEFAULT_NAME = 'credentials'

str – Default AuthMethod name to load in load().

Abstract Base Class for all Authentication Methods

class pytan3.auth_methods.AuthMethod[source]

Bases: object

Abstract base class for all AuthMethods.

classmethod get_name()[source]

Get the ref name of this class for use by load().

Returns:str
classmethod get_version_req()[source]

Get the min, max, and eq version requirements of this class.

Notes

Dict can specify keys: “vmin”, “vmax”, “veq”.

This class method gets called by pytan3.utils.versions.version_check_obj_req() to perform version checks.

Returns:dict
classmethod get_args()[source]

Get all arguments used by this class.

Returns:list
classmethod get_args_required()[source]

Get all arguments used by this class that are required.

Returns:list
classmethod get_args_secure()[source]

Get all arguments used by this class that need their prompt input hidden.

Returns:list
classmethod from_store(store, **kwargs)[source]

Create an instance of this class from an pytan3.auth_store.AuthStore.

Parameters:store (pytan3.auth_store.AuthStore) – AuthStore to get AuthMethod arguments from.
Returns:AuthMethod
http_client

Get the HTTP Client for this object.

Returns:pytan3.http_client.HttpClient
token

Get or set a token.

Notes

If no token received, login() to get one.

If token expired, login() to get a new one.

If token has been received, validate() to validate token.

If token fails validation, login() to get a new one.

Returns:str
token_headers

Get dict with token for use in headers.

Returns:dict
uid

Get user ID for token if a token has been received.

Returns:str
logged_in

Check if a token has been received.

Returns:bool
login(**kwargs)[source]

Send a login request to receive a token.

Raises:exceptions.LoginError – If status code in response is not 200.
Returns:str
logout(**kwargs)[source]

Send a logout request to revoke a token.

Raises:
Returns:

None
logout_all(**kwargs)[source]

Send a logout request to revoke all tokens associated with this token.

Raises:
Returns:

None
validate(**kwargs)[source]

Send a validate request to check that token is still valid.

Raises:
Returns:

str
create_store(**kwargs)[source]

Create an instance of pytan3.auth_store.AuthStore from this object.

Returns:pytan3.auth_store.AuthStore
_abc_impl = <_abc_data object>

Common Mixins for all Authentication Methods

class pytan3.auth_methods.CommonMixin(http_client, login_timeout=5, logout_timeout=5, expires_after=295, ver_check=True, lvl='info')[source]

Bases: object

Shared methods common amongst all AuthMethod.

__init__(http_client, login_timeout=5, logout_timeout=5, expires_after=295, ver_check=True, lvl='info')[source]

Constructor.

Parameters:
  • http_client (pytan3.http_client.HttpClient) – Object for sending HTTP requests.
  • login_timeout (int, optional) –

    Timeout for login and validate responses in seconds.

    Defaults to: 5.

  • logout_timeout (int, optional) –

    Timeout for logout responses in seconds.

    Defaults to: 5.

  • expires_after (int, optional) –

    Life of received tokens in seconds.

    Defaults to: 295.

  • ver_check (bool, optional) –

    Perform version checks against the platform version from pytan3.api_clients.get_version() using pytan3.utils.versions.version_check_obj_req().

    Defaults to: True.

  • lvl (str, optional) –

    Logging level for this object.

    Defaults to: “info”.
log = None

logging.Logger – Log for this object.

revalidate_after = None

int – Revalidate token if last_used is higher than this.

__str__()[source]

Show object info.

Returns:str
__repr__()[source]

Show object info.

Returns:str
classmethod from_store(store, **kwargs)[source]

Create an instance of this class from an pytan3.auth_store.AuthStore.

Parameters:
Returns:

AuthMethod
http_client

Get the HTTP Client for this object.

Returns:pytan3.http_client.HttpClient
token

Get a token.

Notes

If logged_in is False, login() to get one.

If expired is True, login() to get a new one.

If logged_in is True, and last_used is older than revalidate_after, validate() to re-validate token.

If validate() fails validation, login() to get a new one.

Returns:str
token_headers

Get dict with token for use in headers.

Returns:dict
uid

Get user ID for token if a token has been received.

Returns:str
logged_in

Check if a token has been received.

Returns:bool
expired

Check if token has expired.

Returns:bool
last_used

Get the number of seconds since token was issued or last used.

Returns:int
login(**kwargs)[source]

Send a login request to receive a token.

Parameters:**kwargs –
cause (str):
String to explain purpose of request.

Defaults to: “Get new token”.
Raises:exceptions.LoginError – If status code in response is not 200.
Returns:str
logout(**kwargs)[source]

Send a logout request to revoke a token.

Parameters:

**kwargs –

cause (str):

String to explain purpose of request.

Defaults to: “Revoke token”.

headers (dict):

Headers to send in request.

Defaults to: {}.
Raises:
Returns:

None
logout_all(**kwargs)[source]

Send a logout request to revoke all tokens associated with this token.

Parameters:

**kwargs –

cause (str):

String to explain purpose of request.

Defaults to: “Revoke all tokens”.

headers (dict):

Headers to send in request.

Defaults to: {}.
Raises:
Returns:

None
validate(**kwargs)[source]

Send a validate request to check that token is still valid.

Parameters:

**kwargs –

cause (str):

String to explain purpose of request.

Defaults to: “Validate token”.

headers (dict):

Headers to send in request.

Defaults to: {}.
Raises:
Returns:

str
create_store(**kwargs)[source]

Create an instance of pytan3.auth_store.AuthStore from this object.

Returns:pytan3.auth_store.AuthStore

Utilities for all Authentication Methods

pytan3.auth_methods.validate_token(token)[source]

Validate that a token is properly formed.

Parameters:token (str) – Token to validate
Returns:bool

Loaders for all Authentication Methods

pytan3.auth_methods.load(obj='credentials')[source]

Get an AuthMethod class.

:param obj (str or AuthMethod or AuthMethod or: pytan3.auth_store.AuthStore, optional):

AuthStore object or AuthMethod object, class, or name of AuthMethod.

Defaults to: DEFAULT_NAME.

Raises
exceptions.ModuleError:
If obj is not a valid type, name, obj, or cls.
Returns:AuthMethod

Exceptions for all Authentication Methods

Exceptions and warnings for pytan3.auth_methods.

exception pytan3.auth_methods.exceptions.ModuleError[source]

Bases: pytan3.exceptions.PyTanError

Parent of all exceptions for pytan3.auth_methods.

Thrown by:
exception pytan3.auth_methods.exceptions.ModuleWarning[source]

Bases: pytan3.exceptions.PyTanWarning

Parent of all warnings for pytan3.auth_methods.

Thrown by:

exception pytan3.auth_methods.exceptions.MethodError(auth_method, info=None, response=None)[source]

Bases: pytan3.auth_methods.exceptions.ModuleError

Parent of all pytan3.auth_methods.AuthMethod exceptions.

Thrown by:

msg = 'Authentication Method Error!'

str – Error message to use in exception.

__init__(auth_method, info=None, response=None)[source]

Constructor.

Parameters:
  • auth_method (pytan3.auth_methods.AuthMethod) – Object where exception was thrown from.
  • info (str, optional) –

    Additional error info message to show.

    Defaults to: None.

  • response (requests.Response, optional) –

    Response associated with this exception, if any.

    Defaults to: None.
error = None

str – Error message that was thrown.

exception pytan3.auth_methods.exceptions.InvalidToken(auth_method, info=None, response=None)[source]

Bases: pytan3.auth_methods.exceptions.MethodError

Thrown when validate_token fails.

Thrown by:
msg = 'Supplied token is invalid!'

str – Error message to use in exception.

exception pytan3.auth_methods.exceptions.NotLoggedInError(auth_method, info=None, response=None)[source]

Bases: pytan3.auth_methods.exceptions.MethodError

Thrown when logout called before login.

Thrown by:
msg = 'Not logged in, unable to logout/validate token. Must login first!'

str – Error message to use in exception.

exception pytan3.auth_methods.exceptions.LoginError(auth_method, info=None, response=None)[source]

Bases: pytan3.auth_methods.exceptions.MethodError

Thrown when login response has any status_code other than 200.

Thrown by:
msg = 'Login failed. Response status code is not 200!'

str – Error message to use in exception.

exception pytan3.auth_methods.exceptions.LogoutError(auth_method, info=None, response=None)[source]

Bases: pytan3.auth_methods.exceptions.MethodError

Thrown when logout fails.

Thrown by:
msg = 'Logout failed. Verify the supplied credentials!'

str – Error message to use in exception.

Authentication Method Types

Credentials Authentication Method
class pytan3.auth_methods.Credentials(http_client, username, password, domain='', secondary='', login_timeout=5, logout_timeout=5, expires_after=295, ver_check=True, lvl='info')[source]

Bases: pytan3.auth_methods.CommonMixin, pytan3.auth_methods.AuthMethod

Method that uses credentials to interact with the ‘/auth’ API.

__init__(http_client, username, password, domain='', secondary='', login_timeout=5, logout_timeout=5, expires_after=295, ver_check=True, lvl='info')[source]

Constructor.

Parameters:
  • http_client (pytan3.http_client.HttpClient) – HTTP client.
  • username (str) – Header to pass to /auth API.
  • password (str) – Header to pass to /auth API.
  • domain (str, optional) –

    Header to pass to /auth API.

    Defaults to: “”

  • secondary (str, optional) –

    Header to pass to /auth API.

    Defaults to: “”

  • login_timeout (int, optional) –

    Timeout for login and validate responses in seconds.

    Defaults to: 5.

  • logout_timeout (int, optional) –

    Timeout for logout responses in seconds.

    Defaults to: 5.

  • expires_after (int, optional) –

    Life of received tokens in seconds.

    Defaults to: 295.

  • ver_check (bool, optional) –

    Perform version checks against the platform version from pytan3.api_clients.get_version() using pytan3.utils.versions.version_check_obj_req().

    Defaults to: True.

  • lvl (str, optional) –

    Logging level for this object.

    Defaults to: “info”.
classmethod get_name()[source]

Get the ref name of this class for use by load().

Returns:str
classmethod get_version_req()[source]

Get the min, max, and eq version requirements of this class.

Notes

Dict can specify keys: “vmin”, “vmax”, “veq”.

This class method gets called by pytan3.utils.versions.version_check_obj_req() to perform version checks.

Returns:dict
classmethod get_args()[source]

Get all arguments used by this class.

Returns:list
classmethod get_args_required()[source]

Get all arguments used by this class that are required.

Returns:list
classmethod get_args_secure()[source]

Get all arguments used by this class that need their prompt input hidden.

Returns:list
_abc_impl = <_abc_data object>
REST Credentials Authentication Method
class pytan3.auth_methods.RestCredentials(http_client, username, password, domain='', secondary='', login_timeout=5, logout_timeout=5, expires_after=295, ver_check=True, lvl='info')[source]

Bases: pytan3.auth_methods.CommonMixin, pytan3.auth_methods.AuthMethod

Method that uses credentials to interact with the REST ‘session’ API.

__init__(http_client, username, password, domain='', secondary='', login_timeout=5, logout_timeout=5, expires_after=295, ver_check=True, lvl='info')[source]

Constructor.

Parameters:
  • http_client (pytan3.http_client.HttpClient) – HTTP client.
  • username (str) – Header to pass to /api/v2/session REST API.
  • password (str) – Header to pass to /api/v2/session REST API.
  • domain (str, optional) –

    Header to pass to /api/v2/session REST API.

    Defaults to: “”

  • secondary (str, optional) –

    Header to pass to /api/v2/session REST API.

    Defaults to: “”

  • login_timeout (int, optional) –

    Timeout for login and validate responses in seconds.

    Defaults to: 5.

  • logout_timeout (int, optional) –

    Timeout for logout responses in seconds.

    Defaults to: 5.

  • expires_after (int, optional) –

    Life of received tokens in seconds.

    Defaults to: 295.

  • ver_check (bool, optional) –

    Perform version checks against the platform version from pytan3.api_clients.get_version() using pytan3.utils.versions.version_check_obj_req().

    Defaults to: True.

  • lvl (str, optional) –

    Logging level.

    Defaults to: “info”.
classmethod get_name()[source]

Get the ref name of this class for use by load().

Returns:str
classmethod get_version_req()[source]

Get the min, max, and eq version requirements of this class.

Notes

Dict can specify keys: “vmin”, “vmax”, “veq”.

This class method gets called by pytan3.utils.versions.version_check_obj_req() to perform version checks.

Returns:dict
classmethod get_args()[source]

Get all arguments used by this class.

Returns:list
classmethod get_args_required()[source]

Get all arguments used by this class that are required.

Returns:list
classmethod get_args_secure()[source]

Get all arguments used by this class that need their prompt input hidden.

Returns:list
_abc_impl = <_abc_data object>
rest_version

Version of REST API for this method.

Returns:int
login(**kwargs)[source]

Send a login request to receive a token.

Parameters:**kwargs –

cause (str): String to explain purpose of request.

Defaults to: “Get new token”.
Raises:exceptions.LoginError – If status code in response is not 200.
Returns:str
logout(**kwargs)[source]

Send a logout request to revoke a token.

Parameters:

**kwargs –

cause (str): String to explain purpose of request.

Defaults to: “Revoke token”.
Raises:
Returns:

None
logout_all(**kwargs)[source]

Send a logout request to revoke all tokens associated with this token.

Raises:NotImplementedError – REST ‘session’ endpoint does not have a logout all target.
validate(**kwargs)[source]

Send a validate request to check that token is still valid.

Parameters:

**kwargs –

cause (str):

String to explain purpose of request.

Defaults to: “Validate token”.
Raises:
Returns:

str
Session ID Authentication Method
class pytan3.auth_methods.SessionId(http_client, session, login_timeout=5, logout_timeout=5, expires_after=295, ver_check=True, lvl='info')[source]

Bases: pytan3.auth_methods.CommonMixin, pytan3.auth_methods.AuthMethod

Method that uses session id to interact with the ‘/auth’ API.

__init__(http_client, session, login_timeout=5, logout_timeout=5, expires_after=295, ver_check=True, lvl='info')[source]

Constructor.

Parameters:
  • http_client (pytan3.http_client.HttpClient) – HTTP client.
  • session (str) – Header to pass to /auth API.
  • login_timeout (int, optional) –

    Timeout for login and validate responses in seconds.

    Defaults to: 5.

  • logout_timeout (int, optional) –

    Timeout for logout responses in seconds.

    Defaults to: 5.

  • expires_after (int, optional) –

    Life of received tokens in seconds.

    Defaults to: 295.

  • ver_check (bool, optional) –

    Perform version checks against the platform version from pytan3.api_clients.get_version() using pytan3.utils.versions.version_check_obj_req().

    Defaults to: True.

  • lvl (str, optional) –

    Logging level for this object.

    Defaults to: “info”.
classmethod get_name()[source]

Get the ref name of this class for use by load().

Returns:str
classmethod get_version_req()[source]

Get the min, max, and eq version requirements of this class.

Notes

Dict can specify keys: “vmin”, “vmax”, “veq”.

This class method gets called by pytan3.utils.versions.version_check_obj_req() to perform version checks.

Returns:dict
classmethod get_args()[source]

Get all arguments used by this class.

Returns:list
classmethod get_args_required()[source]

Get all arguments used by this class that are required.

Returns:list
classmethod get_args_secure()[source]

Get all arguments used by this class that need their prompt input hidden.

Returns:list
token

Get a token.

Notes

If CommonMixin.logged_in is False, can not login to get a new one with just a session.

If CommonMixin.expired is True, can not login to get a new one with just a session.

If CommonMixin.logged_in is True, and CommonMixin.last_used is older than CommonMixin.revalidate_after, CommonMixin.validate() to re-validate token.

If CommonMixin.validate() fails validation, can not login to get a new one with just a session.

Returns:str
login(**kwargs)[source]

Send a login request to receive a token.

Raises:exceptions.LoginError – If status code in response is not 200.
Returns:str
_abc_impl = <_abc_data object>

Authentication Store

Secure storage for Authentication methods.

pytan3.auth_store.DEFAULT_NAME = 'credentials'

str – Default pytan3.auth_methods.AuthMethod name to load in AuthStore.

pytan3.auth_store.STORE_FILE = '{http_client.parsed_url.hostname}.store'

str – Store filename template filename to use in AuthStore.

Will use OS Environment variable “PYTAN_STORE_FILE” if set.

class pytan3.auth_store.AuthStore(http_client, method='credentials', secret=None, data=None, src='init', lvl='info')[source]

Bases: object

Secure storage for pytan3.auth_methods.AuthMethod.

__init__(http_client, method='credentials', secret=None, data=None, src='init', lvl='info')[source]

Constructor.

Parameters:
  • http_client (pytan3.http_client.HttpClient) – HTTP client.
  • method (str or pytan3.auth_methods.AuthMethod, optional) –

    AuthMethod to use for this object.

    Defaults to: DEFAULT_NAME.

  • secret (str, optional) –

    Encryption key.

    Will use STORE_SECRET as default if None.

    Defaults to: None.

  • data (dict, optional) –

    Initialize data store with dict.

    Defaults to: None.

  • src (str, optional) –

    Where this store came from.

    Defaults to: “init”.

  • lvl (str, optional) –

    Logging level.

    Defaults to: “info”.
__str__()[source]

Show object info.

Returns:str
__repr__()[source]

Show object info.

Returns:str
http_client

Get the HTTP Client for this object.

Returns:pytan3.http_client.HttpClient
set(key, value)[source]

Set key value in data.

Parameters:
  • key (str) – Key name to set in data.
  • value (str) – Value to set for key in data.
get(key, required=True)[source]

Get key value from data.

Parameters:
  • key (str) – Key to get,
  • required (bool, optional) –

    Raise error if key not found in store.

    Defaults to: True.
Raises:

exceptions.ModuleError – If key is required and not found.
Returns:

str
secret

Get the secret for this store.

Returns:str
method

Get the method class for this store.

Returns:pytan3.auth_methods.AuthMethod
create_method(**kwargs)[source]

Create an pytan3.auth_methods.AuthMethod from this store.

Parameters:**kwargs – Rest of kwargs passed to pytan3.auth_methods.AuthMethod.from_store().
Returns:pytan3.auth_methods.AuthMethod
to_stream(stream=None)[source]

Write this stores encrypted data to a file like object.

Parameters:stream (io.IOBase, optional) –

Object to write store to.

If None, create and return a six.StringIO.

Defaults to: None.
Returns:io.IOBase
to_path(path=None, path_sub='stores', path_file='{http_client.parsed_url.hostname}.store', overwrite=False)[source]

Write this stores encrypted data to a path.

Parameters:
  • path (str or pathlib.Path, optional) –

    Storage directory to use. If empty, resolve path via pytan3.utils.tools.get_storage_dir().

    Defaults to: None.

  • path_sub (str, optional) –

    Sub directory under path that should contain path_file.

    Defaults to: “stores”

  • path_file (str, optional) –

    Filename to use for store file under path / path_sub.

    Defaults to: STORE_FILE

  • overwrite (bool, optional) –

    If True, if store_file exists, overwrite and throw warning.

    If False, if store_file exists, do not overwrite and throw exception.

    If None, if store_file exists, do not overwrite and throw warning.

    Defaults to: False.
Raises:
Returns:

Absolute full path where store file was written.
Return type:

pathlib.Path
to_string()[source]

Write this stores encrypted data to a string.

Returns:str
classmethod from_stream(http_client, stream, secret=None, src='stream', lvl='info')[source]

Create store from encrypted data in a file like object.

Parameters:
  • http_client (pytan3.http_client.HttpClient) – HTTP client.
  • stream (io.IOBase) – File like object to read from.
  • secret (str, optional) –

    Decryption key.

    Will use STORE_SECRET as default if None.

    Defaults to: None.

  • src (str, optional) –

    Where this store came from.

    Defaults to: “stream”.

  • lvl (str, optional) –

    Logging level for this object.

    Defaults to: “info”.
Returns:

AuthStore
classmethod from_string(http_client, string, secret=None, lvl='info')[source]

Create store from encrypted data in a string.

Parameters:
  • http_client (pytan3.http_client.HttpClient) – HTTP client.
  • string (str) – String to read from.
  • secret (str, optional) –

    Decryption key.

    Will use STORE_SECRET as default if None.

    Defaults to: None.

  • lvl (str, optional) –

    Logging level for this object.

    Defaults to: “info”.
Returns:

AuthStore
classmethod from_path(http_client, path=None, path_sub='stores', path_file='{http_client.parsed_url.hostname}.store', secret=None, lvl='info')[source]

Create store from encrypted data in a file.

Parameters:
  • http_client (pytan3.http_client.HttpClient) – HTTP client.
  • path (str or pathlib.Path, optional) –

    Storage directory to use. If empty, resolve path via pytan3.utils.tools.get_storage_dir().

    Defaults to: None.

  • path_sub (str, optional) –

    Sub directory under path that should contain path_file.

    Defaults to: “stores”

  • path_file (str, optional) –

    Filename to use for store file under path / path_sub.

    Defaults to: STORE_FILE

  • secret (str, optional) –

    Decryption key.

    Will use STORE_SECRET as default if None.

    Defaults to: None.

  • lvl (str, optional) –

    Logging level for this object.

    Defaults to: “info”.
Raises:

(exceptions.ModuleError) – If path does not exist as a file.
Returns:

AuthStore
classmethod _decrypt(data, http_client, secret=None)[source]

Decrypt data using secret.

Parameters:
  • data (str) – Data to decrypt.
  • http_client (pytan3.http_client.HttpClient) – HTTP client.
  • secret (str, optional) –

    Decryption key.

    Will use STORE_SECRET as default if None.

    Defaults to: None.
Returns:

str
classmethod _encrypt(data, http_client, secret=None)[source]

Encrypt data using secret.

Parameters:
  • data (str) – Data to encrypt.
  • http_client (pytan3.http_client.HttpClient) – HTTP client.
  • secret (str, optional) –

    Decryption key.

    Will use STORE_SECRET as default if None.

    Defaults to: None.
Returns:

str
classmethod _build_key(http_client, secret=None)[source]

Build an encryption key by combining an SSL cert PEM and a secret.

Parameters:
  • http_client (pytan3.http_client.HttpClient) – HTTP client.
  • secret (str, optional) –

    Decryption key.

    Will use STORE_SECRET as default if None.

    Defaults to: None.
Returns:

str

Exceptions for Authentication Store

Exceptions and warnings for pytan3.auth_store.

exception pytan3.auth_store.exceptions.ModuleError[source]

Bases: pytan3.exceptions.PyTanError

Parent of all pytan3.auth_store exceptions.

Thrown by:
exception pytan3.auth_store.exceptions.ModuleWarning[source]

Bases: pytan3.exceptions.PyTanWarning

Parent of all pytan3.auth_store warnings.

Thrown by:

API Clients

Clients for making API requests to Tanium.

pytan3.api_clients.DEFAULT_TYPE = 'soap'

str – Default ApiClient type to load in load_type().

pytan3.api_clients.DEFAULT_NAME = 'soap'

str – Default ApiClient name to load in load().

pytan3.api_clients.WSDL_PATH = '/libraries/taniumjs/console.wsdl'

str – URL path to find console.wsdl in get_wsdl().

Abstract Base Class for all API Clients

class pytan3.api_clients.ApiClient[source]

Bases: object

Abstract base class for all ApiClients.

classmethod get_name()[source]

Get the ref name of this class for use by load().

Returns:str
classmethod get_type()[source]

Get the ref type of this class for use by load_type().

Returns:str
classmethod get_version_req()[source]

Get the min, max, and eq version requirements of this class.

Notes

Dict can specify keys: “vmin”, “vmax”, “veq”.

This class method gets called by pytan3.utils.versions.version_check_obj_req() to perform version checks.

Returns:dict
auth_method

Get the AuthMethod for this object.

Returns:pytan3.auth_methods.AuthMethod
http_client

Get the HTTP Client for this object.

Returns:pytan3.http_client.HttpClient
url

Get the URL from ApiClient.http_client.

Returns:str
version

Get the platform version from ApiClient.config.

Returns:str
config

Get the deserialized config.json from ApiClient.url.

Returns:dict
info

Get the deserialized info.json from ApiClient.url.

Returns:dict
_abc_impl = <_abc_data object>

All SOAP API Clients

Soap API Client
class pytan3.api_clients.Soap(http_client, auth_method, ver_check=True, lvl='info')[source]

Bases: pytan3.api_clients.ApiClient

Client for making SOAP API requests to Tanium.

__init__(http_client, auth_method, ver_check=True, lvl='info')[source]

Constructor.

Parameters:
log = None

logging.Logger – Log for this object.

__str__()[source]

Show object info.

Returns:str
__repr__()[source]

Show object info.

Returns:str
__call__(data, timeout=30, **kwargs)[source]

Get response of POST of data to /soap and return a response object.

Parameters:
  • data (str) – Body to send in request.
  • timeout (int, optional) –

    Response timeout.

    Defaults to: 30.

  • **kwargs –
    cause (str):
    String to explain purpose of request.

    Defaults to: “”.

    headers (dict):
    Headers to send in request.

    Defaults to: {}.
Returns:

requests.Response
classmethod get_name()[source]

Get the ref name of this object for use by load().

Returns:str
classmethod get_type()[source]

Get the ref type of this object for use by load_type().

Returns:str
classmethod get_version_req()[source]

Get the min, max, and eq version requirements of this class.

Notes

Dict can specify keys: “vmin”, “vmax”, “veq”.

This class method gets called by pytan3.utils.versions.version_check_obj_req() to perform version checks.

Returns:dict
auth_method

Get the AuthMethod for this object.

Returns:pytan3.auth_methods.AuthMethod
http_client

Get the HTTP Client for this object.

Returns:pytan3.http_client.HttpClient
url

Get the URL from ApiClient.http_client.

Returns:str
version

Get the platform version from ApiClient.config.

Returns:str
config

Get the deserialized config.json from ApiClient.url.

Returns:dict
info

Get the deserialized info.json from ApiClient.url.

Returns:dict
_abc_impl = <_abc_data object>

All REST API Clients

Rest API Client
class pytan3.api_clients.Rest(http_client, auth_method, ver_check=True, lvl='info')[source]

Bases: pytan3.api_clients.ApiClient

Client for making REST API requests to Tanium for versions 7.3 and above.

__init__(http_client, auth_method, ver_check=True, lvl='info')[source]

Constructor.

Parameters:
log = None

logging.Logger – Log for this object.

__str__()[source]

Show object info.

Returns:str
__repr__()[source]

Show object info.

Returns:str
__call__(endpoint, method='get', data=None, timeout=30, **kwargs)[source]

Get response of request of method to /api/v$version/$endpoint?$params.

Parameters:
  • endpoint (str) – Endpoint of rest api
  • method (str, optional) –

    Method to use in request.

    Defaults to: “get”.

  • data (str, optional) –

    Body to send in request.

    Defaults to: None

  • timeout (int, optional) –

    Response timeout.

    Defaults to: 30.

  • **kwargs –
    cause (str):
    String to explain purpose of request.

    Defaults to: “”.

    headers (dict):
    Headers to send in request.

    Defaults to: {}.

    version (int):
    Version of REST API.

    Defaults to: 2.

    params (dict):
    Params to send encoded in URL.

    Defaults to: {}.
Returns:

requests.Response
classmethod get_name()[source]

Get the ref name of this object for use by load().

Returns:str
classmethod get_type()[source]

Get the ref type of this object for use by load_type().

Returns:str
classmethod get_version_req()[source]

Get the min, max, and eq version requirements of this class.

Notes

Dict can specify keys: “vmin”, “vmax”, “veq”.

This class method gets called by pytan3.utils.versions.version_check_obj_req() to perform version checks.

Returns:dict
rest_version

Get the API version to use when communicating with the REST API.

Returns:int
auth_method

Get the AuthMethod for this object.

Returns:pytan3.auth_methods.AuthMethod
http_client

Get the HTTP Client for this object.

Returns:pytan3.http_client.HttpClient
url

Get the URL from ApiClient.http_client.

Returns:str
version

Get the platform version from ApiClient.config.

Returns:str
config

Get the deserialized config.json from ApiClient.url.

Returns:dict
info

Get the deserialized info.json from ApiClient.url.

Returns:dict
_abc_impl = <_abc_data object>

Loaders for all API Clients

pytan3.api_clients.load_type(obj='soap')[source]

Get a ApiClient by type from ApiClient.get_type().

Parameters:obj (str, optional) –

ApiClient type to load.

Defaults to: DEFAULT_TYPE.
Raises
exceptions.ModuleError:
Unable to find a valid ApiClient with the supplied type.
Returns:ApiClient
pytan3.api_clients.load(obj='soap')[source]

Get a ApiClient by name from ApiClient.get_name().

Parameters:obj (str or ApiClient or ApiClient, optional) –

ApiClient object, class, or name.

Defaults to: DEFAULT_NAME.
Raises
exceptions.ModuleError:
Unable to find a valid ApiClient with the supplied name.
Returns:ApiClient

Utilities for all API Clients

pytan3.api_clients.get_version(http_client)[source]

Get serverVersion key from get_config().

Parameters:http_client (pytan3.http_client.HttpClient) – Object for sending HTTP request.
Raises:exceptions.GetPlatformVersionWarning – On error getting serverVersion key.
Returns:str
pytan3.api_clients.get_wsdl(http_client)[source]

Get response of GET to /libraries/taniumjs/console.wsdl.

Parameters:http_client (pytan3.http_client.HttpClient) – Object for sending HTTP request.
Returns:str
pytan3.api_clients.get_config(http_client, cause='')[source]

Get response of GET to /config/console.json.

Parameters:http_client (pytan3.http_client.HttpClient) – Object for sending HTTP request.
Returns:dict

Exceptions for all API Clients

Exceptions and warnings for pytan3.api_clients.

exception pytan3.api_clients.exceptions.ModuleError[source]

Bases: pytan3.exceptions.PyTanError

Parent of all exceptions for pytan3.api_clients.

Thrown by:
exception pytan3.api_clients.exceptions.ModuleWarning[source]

Bases: pytan3.exceptions.PyTanWarning

Parent of all warnings for pytan3.api_clients.

Thrown by:

exception pytan3.api_clients.exceptions.GetPlatformVersionWarning[source]

Bases: pytan3.api_clients.exceptions.ModuleWarning

Thrown when an issue happens while trying to get the platform version.

Thrown by:

API Object Modules

Python objects for Tanium’s API.

pytan3.api_objects.API_TYPES = ['rest', 'soap']

list of str – All API object module types supported.

pytan3.api_objects.DEFAULT_TYPE = 'soap'

str – Default API_TYPES type to load in load().

pytan3.api_objects.PATTERN = '{api_type}_*.py'

str – Glob pattern to find modules in get_versions().

Container for API Object Modules

class pytan3.api_objects.ApiObjects(module_file, adhoc_warn=True)[source]

Bases: object

Encapsulation object for an API Object module.

__init__(module_file, adhoc_warn=True)[source]

Constructor.

Parameters:
  • module_file (str) – API Object module file name in import string format.
  • adhoc_warn (bool, optional) –

    Enable warnings about adhoc added simple attributes to API Objects.

    Defaults to: True.
_module = None

pytan3.api_objects – Imported API Objects module.

_models = None

pytan3.api_models – API Models module.

__str__()[source]

Show object info.

Returns:str
__repr__()[source]

Show object info.

Returns:str
control_adhoc_warnings(enable=False)[source]

Enable or disable warnings about adhoc added simple attributes.

Parameters:enable (bool, optional) –

Enable warnings.

Defaults to: True.
ApiModel

Get the ApiModel.

Returns:pytan3.api_models.ApiModel
ApiItem

Get the ApiItem.

Returns:pytan3.api_models.ApiItem
ApiList

Get the ApiList.

Returns:pytan3.api_models.ApiList
module

Get the API objects module.

Returns:object
module_type

Get the API type.

Returns:str
module_version

Get the API version.

Returns:str
module_dt

Get the date time format string.

Returns:str
module_dt_format(dt)[source]

Format a datetime string using module_dt.

Parameters:dt (str) – String to format.
Returns:datetime.datetime
module_version_dict

Get the API version.

Returns:dict
cls_item

Get all of the ApiItem classes.

Returns:list of pytan3.api_models.ApiItem
cls_list

Get all of the ApiItem classes.

Returns:list of pytan3.api_models.ApiList
cls_all

Get all of the ApiItem and ApiList classes.

Returns:list of pytan3.api_models.ApiModel
cls_name_map_item

Get a map of API key name to class for all ApiItem classes.

Returns:dict
cls_name_map_list

Get a map of API key name to class for all ApiList classes.

Returns:dict
cls_name_map_all

Get a map of API key name to class for all ApiItem and ApiList classes.

Returns:dict
cls_item_by_name(name)[source]

Get an ApiItem class by API name.

Parameters:name (str) – Name of object used in API calls.
Returns:pytan3.api_models.ApiItem
cls_list_by_name(name)[source]

Get an ApiList class by API name.

Parameters:name (str) – Name of object used in API calls.
Returns:pytan3.api_models.ApiList
cls_by_name(name)[source]

Get an ApiItem or ApiList by API name.

Parameters:name (str) – Name of object used in API calls.
Returns:pytan3.api_models.ApiModel
classmethod load(api_type='soap', veq='', vmax='', vmin='', vshrink=True)[source]

Import an API module for version and type.

Parameters:
  • api_type (str, optional) –

    Type of object module to load, must be one of API_TYPES.

    Defaults to: DEFAULT_TYPE.

  • veq (str, optional) –

    Exact version that API object module file must match.

    Defaults to: “”.

  • vmin (str, optional) –

    Minimum version that API object module file must match.

    Defaults to: “”.

  • vmax (str, optional) –

    Maximum version that API object module file must match.

    Defaults to: “”.

  • vshrink (bool or int, optional) –

    If True, shrink API object module file version down to match the same length as veq, vmax, and vmin.

    If False, do not shrink API object module file version at all.

    If int, shrink API object module file version, veq, vmax, and vmin down to this length.

    Defaults to: True.
Raises:

exceptions.ModuleError – If api_type not in API_TYPES.
Returns:

ApiObjects

Utilities for API Object Modules

pytan3.api_objects.get_versions(api_type='soap')[source]

Search for API object module files of api_type.

Parameters:api_type (str, optional) –

Type of object module to load, must be one of API_TYPES.

Defaults to: DEFAULT_TYPE.
Raises:exceptions.NoVersionFoundError – If no API module files matching PATTERN are found.
Returns:list of dict
pytan3.api_objects.find_version(api_type='soap', veq='', vmax='', vmin='', vshrink=True)[source]

Find a API module files that match version and type.

Parameters:
  • api_type (str, optional) –

    Type of object module to find, must be one of API_TYPES.

    Defaults to: DEFAULT_TYPE.

  • veq (str, optional) –

    Exact version that API object module file must match.

    Defaults to: “”.

  • vmin (str, optional) –

    Minimum version that API object module file must match.

    Defaults to: “”.

  • vmax (str, optional) –

    Maximum version that API object module file must match.

    Defaults to: “”.

  • vshrink (bool, optional) –

    If True, shrink API object module file version down to match the same length as veq, vmax, and vmin.

    If False, do not shrink API object module file version at all.

    If int, shrink API object module file version, veq, vmax, and vmin down to this length.

    Defaults to: True.
Raises:

exceptions.NoVersionFoundError – If no API module files match api_type, veq, vmax, and vmin.
Returns:

dict

Loaders for API Object Modules

pytan3.api_objects.load(api_type='soap', veq='', vmax='', vmin='', vshrink=True)[source]

Import an API module for version and type.

Parameters:
  • api_type (str, optional) –

    Type of object module to load, must be one of API_TYPES.

    Defaults to: DEFAULT_TYPE.

  • veq (str, optional) –

    Exact version of object module of type to load.

    Defaults to: “”.

  • vmin (str, optional) –

    Minimum version of object module of type to load.

    Defaults to: “”.

  • vmax (str, optional) –

    Maximum version of object module of type to load.

    Defaults to: “”.

  • vshrink (bool or int, optional) –

    If True, shrink API object module file version down to match the same length as veq, vmax, and vmin.

    If False, do not shrink API object module file version at all.

    If int, shrink API object module file version, veq, vmax, and vmin down to this length.

    Defaults to: True.
Raises:

exceptions.ModuleError – If api_type not in API_TYPES.
Returns:

ApiObjects

Exceptions for API Object Modules

Exceptions and warnings for pytan3.api_objects.

exception pytan3.api_objects.exceptions.ModuleError[source]

Bases: pytan3.exceptions.PyTanError

Parent of all exceptions for pytan3.api_objects.

Thrown from:

exception pytan3.api_objects.exceptions.ModuleWarning[source]

Bases: pytan3.exceptions.PyTanWarning

Parent of all warnings for pytan3.api_objects.

Thrown from:

exception pytan3.api_objects.exceptions.NoVersionFoundError[source]

Bases: pytan3.api_objects.exceptions.ModuleError

Exception handler when finding a version of an API object module.

Thrown from:
exception pytan3.api_objects.exceptions.UnknownApiNameError(name, name_map, module)[source]

Bases: pytan3.api_objects.exceptions.ModuleError

Exception handler when unable to find an API name for an API object.

Thrown from:
__init__(name, name_map, module)[source]

Constructor.

Parameters:
  • name (str) – API name being searched for.
  • name_map (dict) – Map of all API names to API objects.
  • module (object) – Source API module of name_map.
name = None

str – API name being searched for.

name_map = None

dict – Map of all API names to API objects.

module = None

object – Source API module of name_map.

error = None

str – Error message that was thrown.

REST API Object Modules

REST API Object Module for Version 7.3.314.3424

Python objects for Tanium’s API.

pytan3.api_objects.rest_7_3_314_3424.float_types = (<class 'float'>,)

tuple of type – Float types.

pytan3.api_objects.rest_7_3_314_3424.integer_types = (<class 'int'>,)

tuple of type – Integer types.

pytan3.api_objects.rest_7_3_314_3424.string_types = (<class 'str'>,)

tuple of type – String types.

pytan3.api_objects.rest_7_3_314_3424.simple_types = (<class 'int'>, <class 'str'>, <class 'float'>)

tuple of type – All types that should be considered simple types.

pytan3.api_objects.rest_7_3_314_3424.TYPE = 'rest'

str – Type of API this module was built from.

pytan3.api_objects.rest_7_3_314_3424.API_DT = '%Y-%m-%dT%H:%M:%SZ'

str – Datetime format for this API type and version.

pytan3.api_objects.rest_7_3_314_3424.api_fixes()[source]

Fix incorrect attribute definitions on auto generated ApiModel classes.

pytan3.api_objects.rest_7_3_314_3424.expand_cls_globals()[source]

Replace str values with global vars for attrs on ApiModel classes.

Quite the funky chicken dance for solving issues with order of class definition.

pytan3.api_objects.rest_7_3_314_3424.expand_global(obj)[source]

Replace str values with global vars recursively.

Parameters:obj (str or dict or list) – Object to expand into global var.
Returns:String objects are the only ones that will be expanded.
Return type:str or dict or list or object
pytan3.api_objects.rest_7_3_314_3424.get_api_all_item()[source]

Get map of class name to class for all ApiItem subclasses.

Returns:dict
pytan3.api_objects.rest_7_3_314_3424.get_api_all_list()[source]

Get map of class name to class for all ApiList subclasses.

Returns:dict
pytan3.api_objects.rest_7_3_314_3424.get_api_all_model()[source]

Get map of class name to class for all ApiItem and ApiList subclasses.

Returns:dict
class pytan3.api_objects.rest_7_3_314_3424.ApiModel[source]

Bases: pytan3.api_models.ApiModel

Model for a complex item in the API.

class pytan3.api_objects.rest_7_3_314_3424.ApiItem(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiModel, pytan3.api_models.ApiItem

Model for a complex item in the API.

class pytan3.api_objects.rest_7_3_314_3424.ApiList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiModel, pytan3.api_models.ApiList

Model for an array in the API.

api_coerce_items_hook(attr, value, op)[source]

Check hook that allows subclasses to modify list items.

Parameters:
  • attr (str) – Attribute being set on this object.
  • value (ApiList or list or tuple) – The list object holding items.
  • op (str) – Operation being performed that called this method.

Notes

REST arrays can include a CacheInfo object in them. This checks to see if any item is a CacheInfo object, and if so:

  • “cache_info” gets added as a complex attr.
  • “cache_info” attribute is set to value of item.
  • item is not included in return list.
Returns:The list of items modified or as is.
Return type:list
class pytan3.api_objects.rest_7_3_314_3424.ResultInfoList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Manually defined API array object.

API_NAME = 'result_infos'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'max_available_age': (<class 'int'>,), 'now': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['now', 'max_available_age']

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'result_infos'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ResultInfo

__repr__()[source]

Make repr output be same as str output.

Returns:str
class pytan3.api_objects.rest_7_3_314_3424.ResultInfo(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Manually defined API object.

API_NAME = 'result_info'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'age': (<class 'int'>,), 'archived_question_id': (<class 'int'>,), 'error_count': (<class 'int'>,), 'estimated_total': (<class 'int'>,), 'expire_seconds': (<class 'int'>,), 'id': (<class 'int'>,), 'issue_seconds': (<class 'int'>,), 'mr_passed': (<class 'int'>,), 'mr_tested': (<class 'int'>,), 'no_results_count': (<class 'int'>,), 'passed': (<class 'int'>,), 'question_id': (<class 'int'>,), 'report_count': (<class 'int'>,), 'row_count': (<class 'int'>,), 'row_count_flag': (<class 'int'>,), 'row_count_machines': (<class 'int'>,), 'saved_question_id': (<class 'int'>,), 'seconds_since_issued': (<class 'int'>,), 'select_count': (<class 'int'>,), 'tested': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['question_id', 'estimated_total', 'row_count', 'mr_tested', 'mr_passed']

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ResultInfoList

API_LIST_API_NAME = 'result_infos'

str – Name of API_LIST_CLS used in API calls.

__repr__()[source]

Make repr output be same as str output.

Returns:str
class pytan3.api_objects.rest_7_3_314_3424.ResultSetList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Manually defined API array object.

API_NAME = 'result_sets'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'max_available_age': (<class 'int'>,), 'now': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['now', 'max_available_age']

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'result_sets'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ResultSet

class pytan3.api_objects.rest_7_3_314_3424.MergedResultSet(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Manually defined API object.

API_NAME = 'merged_result_set'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'max_available_age': (<class 'str'>,), 'now': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'result_infos': <class 'pytan3.api_objects.rest_7_3_314_3424.ResultInfoList'>, 'result_sets': <class 'pytan3.api_objects.rest_7_3_314_3424.ResultSetList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['now', 'max_available_age']

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.ResultSet(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Manually defined API object.

API_NAME = 'result_set'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'age': (<class 'int'>,), 'archived_question_id': (<class 'int'>,), 'cache_id': (<class 'int'>,), 'error_count': (<class 'int'>,), 'estimated_total': (<class 'int'>,), 'expiration': (<class 'int'>,), 'expire_seconds': (<class 'int'>,), 'filtered_row_count': (<class 'int'>,), 'filtered_row_count_machines': (<class 'int'>,), 'id': (<class 'int'>,), 'issue_seconds': (<class 'int'>,), 'item_count': (<class 'int'>,), 'mr_passed': (<class 'int'>,), 'mr_tested': (<class 'int'>,), 'no_results_count': (<class 'int'>,), 'passed': (<class 'int'>,), 'question_id': (<class 'int'>,), 'report_count': (<class 'int'>,), 'row_count': (<class 'int'>,), 'row_count_machines': (<class 'int'>,), 'saved_question_id': (<class 'int'>,), 'seconds_since_issued': (<class 'int'>,), 'select_count': (<class 'int'>,), 'tested': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'columns': <class 'pytan3.api_objects.rest_7_3_314_3424.ColumnList'>, 'rows': <class 'pytan3.api_objects.rest_7_3_314_3424.RowList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['question_id', 'estimated_total', 'mr_tested', 'mr_passed', 'row_count', 'columns']

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ResultSetList

API_LIST_API_NAME = 'result_sets'

str – Name of API_LIST_CLS used in API calls.

__init__(**kwargs)[source]

Constructor.

Notes

Sets Column.API_DATA_SET so column objects can access rows.

Sets RowColumn.API_COLUMN to the index correlated Column so row columns can access the column name, result type, etc.

Sets Column.API_IDX and RowColumn.API_IDX so column objects know what their index is without having to do lookups.

Parameters:**kwargs – Passed back to parent class.
class pytan3.api_objects.rest_7_3_314_3424.ColumnList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Manually defined API array object.

API_NAME = 'cs'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['names']

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'c'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Column

__repr__()[source]

Make repr output be same as str output.

Returns:str
names

Expose column names of all Column in this obj.

Returns:list of str
__getitem__(value)[source]

Support indexing of names.

Parameters:value (int or str) – If int: Index of item to retrieve from self. If str: Column name to index correlate from ColumnList.names
Returns:The RowColumn object at index value from names.
Return type:RowColumn
class pytan3.api_objects.rest_7_3_314_3424.Column(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Manually defined API object.

API_DATA_SET = None

ResultSet – Parent of this object, set by ResultSet.__init__().

API_IDX = None

int – Index of this object in ColumnList.

API_NAME = 'c'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'hash': (<class 'int'>,), 'name': (<class 'str'>,), 'type': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['name', 'result_type', 'hash']

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ColumnList

API_LIST_API_NAME = 'cs'

str – Name of API_LIST_CLS used in API calls.

result_type

Expose simple attr “rt” as result_type.

Notes

Will try to map str from “rt” as int to constants from Sensor.API_CONSTANTS.

Returns:str
get_values(attr='value', join=None)[source]

Get values of this column from all rows.

Parameters:
  • attr (str, optional) –

    Attribute to get values of.

    Defaults to: “value”.

  • join (str, optional) –

    String to join multi value columns.

    Defaults to: None.
Returns:

list of str
class pytan3.api_objects.rest_7_3_314_3424.RowList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Manually defined API array object.

API_NAME = 'rs'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'r'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Row

__repr__()[source]

Make repr output be same as str output.

Returns:str
class pytan3.api_objects.rest_7_3_314_3424.Row(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Manually defined API object.

API_NAME = 'r'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'cid': (<class 'int'>,), 'id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'data': <class 'pytan3.api_objects.rest_7_3_314_3424.RowColumnList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['id', 'cid', 'columns']

list or str – Attributes to add to str formatting.

API_LIST_API_NAME = 'rs'

str – Name of API_LIST_CLS used in API calls.

API_LIST_CLS

ApiItem: Item class this list class holds.

alias of RowList

__repr__()[source]

Make repr output be same as str output.

Returns:str
__getitem__(value)[source]

Support indexing of columns.

Parameters:value (int or str) – If int: Index of item to retrieve from columns. If str: Column name to index correlate from ColumnList.names
Returns:The RowColumn object at index value from columns.
Return type:RowColumn
names

Return the names of each row column from RowColumn.API_COLUMN.

Returns:list of str
columns

Expose complex attr “data” as “columns”.

Returns:RowColumnList
__len__()[source]

Expose length of columns.

Returns:int
get_values(meta=False, hashes=False, join=None)[source]

Get all values from all columns in this row.

Parameters:
  • meta (bool, optional) –

    Include sensor hash and result type for each column.

    Defaults to: False.

  • hashes (bool, optional) –

    Include hashes of values.

    Defaults to: False.

  • join (str, optional) –

    String to join multi value columns.

    Defaults to: None.
Returns:

dict
class pytan3.api_objects.rest_7_3_314_3424.RowColumnList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Manually defined API array object.

API_NAME = 'rc'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'row_columns'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of RowColumn

class pytan3.api_objects.rest_7_3_314_3424.RowColumn(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Manually defined API array object.

API_COLUMN = None

Column – Index correlated column, set by ResultSet.__init__().

API_IDX = None

int – Index of this object in RowColumnList.

API_NAME = 'row_column'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['name', 'hash', 'result_type']

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'v'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of RowValue

name

Expose column name from API_COLUMN.

Returns:str
result_type

Expose column result type from API_COLUMN.

Returns:str
hash

Expose column sensor hash from API_COLUMN.

Returns:str
get_values(attr='value', join=None)[source]

Get all values from this row column.

Parameters:
  • attr (str, optional) –

    Attribute to get values of.

    Defaults to: “value”.

  • join (str, optional) –

    String to join multi value columns.

    Defaults to: None.
Returns:

list or str
class pytan3.api_objects.rest_7_3_314_3424.RowValue(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Manually defined API object.

API_NAME = 'v'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'hash': (<class 'int'>,), 'text': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['hash', 'value']

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of RowColumn

API_LIST_API_NAME = 'row_column'

str – Name of API_LIST_CLS used in API calls.

value

Expose simple attr “text” as value.

Returns:str
class pytan3.api_objects.rest_7_3_314_3424.ParseQuestionResultList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Manually defined API array object.

API_NAME = 'parse_question_results'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'parse_question_result'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ParseQuestionResult

class pytan3.api_objects.rest_7_3_314_3424.ParseQuestionResult(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Manually defined API object.

API_NAME = 'parse_question_result'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'force_computer_id_flag': (<class 'int'>,), 'from_canonical_text': (<class 'int'>,), 'question_text': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'selects': <class 'pytan3.api_objects.rest_7_3_314_3424.SelectList'>, 'sensor_references': <class 'pytan3.api_objects.rest_7_3_314_3424.SensorReferenceList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['hash', 'text']

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ParseQuestionResultList

API_LIST_API_NAME = 'questions'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.SensorQuery(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'sensor_query'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_query'

str – Name of object in source file.

API_SIMPLE = {'platform': (<class 'str'>,), 'script': (<class 'str'>,), 'script_type': (<class 'str'>,), 'signature': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SensorQueryList

API_LIST_API_NAME = 'sensor_querys'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.SensorSubcolumn(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'sensor_subcolumn'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_subcolumn'

str – Name of object in source file.

API_SIMPLE = {'exclude_from_parse_flag': (<class 'int'>,), 'hidden_flag': (<class 'int'>,), 'ignore_case_flag': (<class 'int'>,), 'index': (<class 'int'>,), 'name': (<class 'str'>,), 'value_type': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SensorSubcolumnList

API_LIST_API_NAME = 'sensor_subcolumns'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.SensorStat(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'sensor_stat'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_stat'

str – Name of object in source file.

API_SIMPLE = {'count': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'other_bytes_avg': (<class 'float'>,), 'other_bytes_std': (<class 'float'>,), 'read_bytes_avg': (<class 'float'>,), 'read_bytes_std': (<class 'float'>,), 'real_ms_avg': (<class 'float'>,), 'real_ms_max': (<class 'float'>,), 'real_ms_min': (<class 'float'>,), 'real_ms_std': (<class 'float'>,), 'sys_ms_avg': (<class 'float'>,), 'sys_ms_std': (<class 'float'>,), 'user_ms_avg': (<class 'float'>,), 'user_ms_std': (<class 'float'>,), 'what_hash': (<class 'int'>,), 'write_bytes_avg': (<class 'float'>,), 'write_bytes_std': (<class 'float'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SensorStatList

API_LIST_API_NAME = 'sensor_stats'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.SavedActionPolicy(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'saved_action_policy'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_action_policy'

str – Name of object in source file.

API_SIMPLE = {'max_age': (<class 'int'>,), 'min_count': (<class 'int'>,), 'row_filter_group_id': (<class 'int'>,), 'saved_question_group_id': (<class 'int'>,), 'saved_question_id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'row_filter_group': <class 'pytan3.api_objects.rest_7_3_314_3424.Group'>, 'saved_question_group': <class 'pytan3.api_objects.rest_7_3_314_3424.Group'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.SavedActionApproval(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'saved_action_approval'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_action_approval'

str – Name of object in source file.

API_SIMPLE = {'approved_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'owner_user_id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'metadata': <class 'pytan3.api_objects.rest_7_3_314_3424.MetadataList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SavedActionApprovalList

API_LIST_API_NAME = 'saved_action_approvals'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.SavedAction(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'saved_action'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_action'

str – Name of object in source file.

API_SIMPLE = {'action_group_id': (<class 'int'>,), 'approved_flag': (<class 'int'>,), 'cache_row_id': (<class 'int'>,), 'comment': (<class 'str'>,), 'creation_time': (<class 'str'>,), 'distribute_seconds': (<class 'int'>,), 'end_time': (<class 'str'>,), 'expire_seconds': (<class 'int'>,), 'id': (<class 'int'>,), 'issue_count': (<class 'int'>,), 'issue_seconds': (<class 'int'>,), 'last_start_time': (<class 'str'>,), 'name': (<class 'str'>,), 'next_start_time': (<class 'str'>,), 'policy_flag': (<class 'int'>,), 'public_flag': (<class 'int'>,), 'start_time': (<class 'str'>,), 'status': (<class 'int'>,), 'user_start_time': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'action_group': <class 'pytan3.api_objects.rest_7_3_314_3424.Group'>, 'approver': <class 'pytan3.api_objects.rest_7_3_314_3424.User'>, 'last_action': <class 'pytan3.api_objects.rest_7_3_314_3424.Action'>, 'metadata': <class 'pytan3.api_objects.rest_7_3_314_3424.MetadataList'>, 'package_spec': <class 'pytan3.api_objects.rest_7_3_314_3424.PackageSpec'>, 'policy': <class 'pytan3.api_objects.rest_7_3_314_3424.SavedActionPolicy'>, 'row_ids': <class 'pytan3.api_objects.rest_7_3_314_3424.SavedActionRowIdList'>, 'target_group': <class 'pytan3.api_objects.rest_7_3_314_3424.Group'>, 'user': <class 'pytan3.api_objects.rest_7_3_314_3424.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SavedActionList

API_LIST_API_NAME = 'saved_actions'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.Sensor(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'sensor'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor'

str – Name of object in source file.

API_SIMPLE = {'cache_row_id': (<class 'int'>,), 'category': (<class 'str'>,), 'creation_time': (<class 'str'>,), 'deleted_flag': (<class 'int'>,), 'delimiter': (<class 'str'>,), 'description': (<class 'str'>,), 'exclude_from_parse_flag': (<class 'int'>,), 'hash': (<class 'int'>,), 'hidden_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'ignore_case_flag': (<class 'int'>,), 'keep_duplicates_flag': (<class 'int'>,), 'last_modified_by': (<class 'str'>,), 'max_age_seconds': (<class 'int'>,), 'modification_time': (<class 'str'>,), 'name': (<class 'str'>,), 'parameter_definition': (<class 'str'>,), 'preview_sensor_flag': (<class 'int'>,), 'source_hash': (<class 'int'>,), 'source_id': (<class 'int'>,), 'source_name': (<class 'str'>,), 'string_count': (<class 'int'>,), 'value_type': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set': <class 'pytan3.api_objects.rest_7_3_314_3424.IdReference'>, 'metadata': <class 'pytan3.api_objects.rest_7_3_314_3424.MetadataList'>, 'mod_user': <class 'pytan3.api_objects.rest_7_3_314_3424.User'>, 'parameters': <class 'pytan3.api_objects.rest_7_3_314_3424.ParameterList'>, 'queries': <class 'pytan3.api_objects.rest_7_3_314_3424.SensorQueryList'>, 'string_hints': <class 'pytan3.api_objects.rest_7_3_314_3424.StringHintList'>, 'subcolumns': <class 'pytan3.api_objects.rest_7_3_314_3424.SensorSubcolumnList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {'BES_DATETIME_RESULT': 4, 'BES_SENSOR': 2, 'DATASIZE_RESULT': 8, 'HASH_RESULT': 0, 'IP_RESULT': 5, 'JS_SENSOR': 7, 'MULTITYPE_SENSOR': 6, 'NUMERIC_INTEGER_RESULT': 9, 'NUMERIC_RESULT': 3, 'PSHELL_SENSOR': 5, 'PY_SENSOR': 8, 'REGEX_RESULT': 11, 'TEXT_RESULT': 1, 'TIMEDIFF_REUSLT': 7, 'VBS_SENSOR': 4, 'VERSION_RESULT': 2, 'WMI_DATETIME_RESULT': 6, 'WMI_SENSOR': 1}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SensorList

API_LIST_API_NAME = 'sensors'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.AuditData(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'audit_data'

str – Name of object used in API calls.

API_NAME_SRC = 'audit_data'

str – Name of object in source file.

API_SIMPLE = {'cache_row_id': (<class 'int'>,), 'creation_time': (<class 'str'>,), 'details': (<class 'str'>,), 'last_modified_by': (<class 'str'>,), 'modification_time': (<class 'str'>,), 'modifier_user_id': (<class 'int'>,), 'object_id': (<class 'int'>,), 'type': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'mod_user': <class 'pytan3.api_objects.rest_7_3_314_3424.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of AuditDataList

API_LIST_API_NAME = 'audit_datas'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.AuditLog(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'audit_log'

str – Name of object used in API calls.

API_NAME_SRC = 'audit_log'

str – Name of object in source file.

API_SIMPLE = {'creation_time': (<class 'str'>,), 'details': (<class 'str'>,), 'end_time': (<class 'str'>,), 'id': (<class 'int'>,), 'last_modified_by': (<class 'str'>,), 'modification_time': (<class 'str'>,), 'modifier_user_id': (<class 'int'>,), 'object_id': (<class 'int'>,), 'start_time': (<class 'str'>,), 'type': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.rest_7_3_314_3424.CacheInfo'>, 'entries': <class 'pytan3.api_objects.rest_7_3_314_3424.AuditDataList'>, 'mod_user': <class 'pytan3.api_objects.rest_7_3_314_3424.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of AuditLogList

API_LIST_API_NAME = 'audit_logs'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.Server(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'server'

str – Name of object used in API calls.

API_NAME_SRC = 'server'

str – Name of object in source file.

API_SIMPLE = {'heart_beat': (<class 'str'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ServerList

API_LIST_API_NAME = 'servers'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.MetadataItem(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'metadata_item'

str – Name of object used in API calls.

API_NAME_SRC = 'metadata_item'

str – Name of object in source file.

API_SIMPLE = {'admin_flag': (<class 'int'>,), 'name': (<class 'str'>,), 'value': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of MetadataList

API_LIST_API_NAME = 'metadatas'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.Filter(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'filter'

str – Name of object used in API calls.

API_NAME_SRC = 'filter'

str – Name of object in source file.

API_SIMPLE = {'aggregation': (<class 'str'>,), 'all_times_flag': (<class 'int'>,), 'all_values_flag': (<class 'int'>,), 'delimiter': (<class 'str'>,), 'delimiter_index': (<class 'int'>,), 'end_time': (<class 'str'>,), 'id': (<class 'int'>,), 'ignore_case_flag': (<class 'int'>,), 'max_age_seconds': (<class 'int'>,), 'not_flag': (<class 'int'>,), 'operator': (<class 'str'>,), 'start_time': (<class 'str'>,), 'substring_flag': (<class 'int'>,), 'substring_length': (<class 'int'>,), 'substring_start': (<class 'int'>,), 'utf8_flag': (<class 'int'>,), 'value': (<class 'str'>,), 'value_type': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'sensor': <class 'pytan3.api_objects.rest_7_3_314_3424.Sensor'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of FilterList

API_LIST_API_NAME = 'filters'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.IdReference(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'id_reference'

str – Name of object used in API calls.

API_NAME_SRC = 'id_reference'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,), 'name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.Group(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'group'

str – Name of object used in API calls.

API_NAME_SRC = 'group'

str – Name of object in source file.

API_SIMPLE = {'and_flag': (<class 'int'>,), 'deleted_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'not_flag': (<class 'int'>,), 'saved_question_id': (<class 'int'>,), 'source_id': (<class 'int'>,), 'text': (<class 'str'>,), 'track_computer_id_flag': (<class 'int'>,), 'track_computer_id_interval': (<class 'int'>,), 'type': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'filters': <class 'pytan3.api_objects.rest_7_3_314_3424.FilterList'>, 'parameters': <class 'pytan3.api_objects.rest_7_3_314_3424.ParameterList'>, 'sub_groups': <class 'pytan3.api_objects.rest_7_3_314_3424.GroupList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of GroupList

API_LIST_API_NAME = 'groups'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.Select(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'select'

str – Name of object used in API calls.

API_NAME_SRC = 'select'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'filter': <class 'pytan3.api_objects.rest_7_3_314_3424.Filter'>, 'group': <class 'pytan3.api_objects.rest_7_3_314_3424.Group'>, 'sensor': <class 'pytan3.api_objects.rest_7_3_314_3424.Sensor'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SelectList

API_LIST_API_NAME = 'selects'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.XmlError(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'xml_error'

str – Name of object used in API calls.

API_NAME_SRC = 'xml_error'

str – Name of object in source file.

API_SIMPLE = {'error_context': (<class 'str'>,), 'exception': (<class 'str'>,), 'type': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ErrorList

API_LIST_API_NAME = 'errors'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.CacheInfo(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'cache_info'

str – Name of object used in API calls.

API_NAME_SRC = 'cache_info'

str – Name of object in source file.

API_SIMPLE = {'cache_id': (<class 'int'>,), 'cache_row_count': (<class 'int'>,), 'expiration': (<class 'str'>,), 'filtered_row_count': (<class 'int'>,), 'page_row_count': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'errors': <class 'pytan3.api_objects.rest_7_3_314_3424.ErrorList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.QuestionListInfo(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'question_list_info'

str – Name of object used in API calls.

API_NAME_SRC = 'question_list_info'

str – Name of object in source file.

API_SIMPLE = {'highest_id': (<class 'int'>,), 'total_count': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.Question(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'question'

str – Name of object used in API calls.

API_NAME_SRC = 'question'

str – Name of object in source file.

API_SIMPLE = {'action_tracking_flag': (<class 'int'>,), 'cache_row_id': (<class 'int'>,), 'expiration': (<class 'str'>,), 'expire_seconds': (<class 'int'>,), 'force_computer_id_flag': (<class 'int'>,), 'from_canonical_text': (<class 'int'>,), 'hidden_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'index': (<class 'int'>,), 'is_expired': (<class 'int'>,), 'name': (<class 'str'>,), 'query_text': (<class 'str'>,), 'skip_lock_flag': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'context_group': <class 'pytan3.api_objects.rest_7_3_314_3424.Group'>, 'group': <class 'pytan3.api_objects.rest_7_3_314_3424.Group'>, 'management_rights_group': <class 'pytan3.api_objects.rest_7_3_314_3424.Group'>, 'saved_question': <class 'pytan3.api_objects.rest_7_3_314_3424.SavedQuestion'>, 'selects': <class 'pytan3.api_objects.rest_7_3_314_3424.SelectList'>, 'user': <class 'pytan3.api_objects.rest_7_3_314_3424.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of QuestionList

API_LIST_API_NAME = 'questions'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.PackageFileTemplate(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'package_file_template'

str – Name of object used in API calls.

API_NAME_SRC = 'package_file_template'

str – Name of object in source file.

API_SIMPLE = {'download_seconds': (<class 'int'>,), 'hash': (<class 'str'>,), 'name': (<class 'str'>,), 'source': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of PackageFileTemplateList

API_LIST_API_NAME = 'package_file_templates'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.PackageFileStatus(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'package_file_status'

str – Name of object used in API calls.

API_NAME_SRC = 'package_file_status'

str – Name of object in source file.

API_SIMPLE = {'bytes_downloaded': (<class 'int'>,), 'bytes_total': (<class 'int'>,), 'cache_message': (<class 'str'>,), 'cache_status': (<class 'str'>,), 'download_start_time': (<class 'str'>,), 'last_download_progress_time': (<class 'str'>,), 'server_id': (<class 'int'>,), 'server_name': (<class 'str'>,), 'status': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of PackageFileStatusList

API_LIST_API_NAME = 'package_file_statuss'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.PackageFile(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'package_file'

str – Name of object used in API calls.

API_NAME_SRC = 'package_file'

str – Name of object in source file.

API_SIMPLE = {'bytes_downloaded': (<class 'int'>,), 'bytes_total': (<class 'int'>,), 'cache_status': (<class 'str'>,), 'deleted_flag': (<class 'int'>,), 'download_seconds': (<class 'int'>,), 'download_start_time': (<class 'str'>,), 'hash': (<class 'str'>,), 'id': (<class 'int'>,), 'last_download_progress_time': (<class 'str'>,), 'name': (<class 'str'>,), 'size': (<class 'int'>,), 'source': (<class 'str'>,), 'status': (<class 'int'>,), 'trigger_download': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'file_status': <class 'pytan3.api_objects.rest_7_3_314_3424.PackageFileStatusList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of PackageFileList

API_LIST_API_NAME = 'package_files'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.PackageSpec(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'package_spec'

str – Name of object used in API calls.

API_NAME_SRC = 'package_spec'

str – Name of object in source file.

API_SIMPLE = {'available_time': (<class 'str'>,), 'cache_row_id': (<class 'int'>,), 'command': (<class 'str'>,), 'command_timeout': (<class 'int'>,), 'creation_time': (<class 'str'>,), 'deleted_flag': (<class 'int'>,), 'display_name': (<class 'str'>,), 'expire_seconds': (<class 'int'>,), 'hidden_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'last_modified_by': (<class 'str'>,), 'last_update': (<class 'str'>,), 'modification_time': (<class 'str'>,), 'name': (<class 'str'>,), 'parameter_definition': (<class 'str'>,), 'process_group_flag': (<class 'int'>,), 'signature': (<class 'str'>,), 'skip_lock_flag': (<class 'int'>,), 'source_hash': (<class 'str'>,), 'source_hash_changed_flag': (<class 'int'>,), 'source_id': (<class 'int'>,), 'source_name': (<class 'str'>,), 'verify_expire_seconds': (<class 'int'>,), 'verify_group_id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set': <class 'pytan3.api_objects.rest_7_3_314_3424.IdReference'>, 'file_templates': <class 'pytan3.api_objects.rest_7_3_314_3424.PackageFileTemplateList'>, 'files': <class 'pytan3.api_objects.rest_7_3_314_3424.PackageFileList'>, 'metadata': <class 'pytan3.api_objects.rest_7_3_314_3424.MetadataList'>, 'mod_user': <class 'pytan3.api_objects.rest_7_3_314_3424.User'>, 'parameters': <class 'pytan3.api_objects.rest_7_3_314_3424.ParameterList'>, 'sensors': <class 'pytan3.api_objects.rest_7_3_314_3424.SensorList'>, 'verify_group': <class 'pytan3.api_objects.rest_7_3_314_3424.Group'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of PackageSpecList

API_LIST_API_NAME = 'package_specs'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.ClientStatus(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'client_status'

str – Name of object used in API calls.

API_NAME_SRC = 'client_status'

str – Name of object in source file.

API_SIMPLE = {'cache_row_id': (<class 'int'>,), 'computer_id': (<class 'str'>,), 'full_version': (<class 'str'>,), 'host_name': (<class 'str'>,), 'ipaddress_client': (<class 'str'>,), 'ipaddress_server': (<class 'str'>,), 'last_registration': (<class 'str'>,), 'port_number': (<class 'int'>,), 'protocol_version': (<class 'int'>,), 'public_key_valid': (<class 'int'>,), 'receive_state': (<class 'str'>,), 'registered_with_tls': (<class 'int'>,), 'send_state': (<class 'str'>,), 'status': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SystemStatusList

API_LIST_API_NAME = 'system_status'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.SystemSetting(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'system_setting'

str – Name of object used in API calls.

API_NAME_SRC = 'system_setting'

str – Name of object in source file.

API_SIMPLE = {'cache_row_id': (<class 'int'>,), 'default_value': (<class 'str'>,), 'hidden_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'read_only_flag': (<class 'int'>,), 'setting_type': (<class 'str'>,), 'value': (<class 'str'>,), 'value_type': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'audit_data': <class 'pytan3.api_objects.rest_7_3_314_3424.AuditData'>, 'metadata': <class 'pytan3.api_objects.rest_7_3_314_3424.MetadataList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SystemSettingList

API_LIST_API_NAME = 'system_settings'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.SoapError(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'soap_error'

str – Name of object used in API calls.

API_NAME_SRC = 'soap_error'

str – Name of object in source file.

API_SIMPLE = {'context': (<class 'str'>,), 'exception_name': (<class 'str'>,), 'object_name': (<class 'str'>,), 'object_request': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.WhiteListedUrl(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'white_listed_url'

str – Name of object used in API calls.

API_NAME_SRC = 'white_listed_url'

str – Name of object in source file.

API_SIMPLE = {'chunk_id': (<class 'str'>,), 'download_seconds': (<class 'int'>,), 'expire_seconds': (<class 'int'>,), 'id': (<class 'int'>,), 'url_regex': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'metadata': <class 'pytan3.api_objects.rest_7_3_314_3424.MetadataList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of WhiteListedUrlList

API_LIST_API_NAME = 'white_listed_urls'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.VersionAggregate(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'version_aggregate'

str – Name of object used in API calls.

API_NAME_SRC = 'version_aggregate'

str – Name of object in source file.

API_SIMPLE = {'count': (<class 'int'>,), 'filtered': (<class 'int'>,), 'version_string': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of VersionAggregateList

API_LIST_API_NAME = 'version_aggregates'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.SystemStatusAggregate(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'system_status_aggregate'

str – Name of object used in API calls.

API_NAME_SRC = 'system_status_aggregate'

str – Name of object in source file.

API_SIMPLE = {'blocked_count': (<class 'int'>,), 'leader_count': (<class 'int'>,), 'normal_count': (<class 'int'>,), 'receive_backward_count': (<class 'int'>,), 'receive_forward_count': (<class 'int'>,), 'receive_none_count': (<class 'int'>,), 'receive_ok_count': (<class 'int'>,), 'registered_with_tls_count': (<class 'int'>,), 'send_backward_count': (<class 'int'>,), 'send_forward_count': (<class 'int'>,), 'send_none_count': (<class 'int'>,), 'send_ok_count': (<class 'int'>,), 'slowlink_count': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'versions': <class 'pytan3.api_objects.rest_7_3_314_3424.VersionAggregateList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.UserRole(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'user_role'

str – Name of object used in API calls.

API_NAME_SRC = 'user_role'

str – Name of object in source file.

API_SIMPLE = {'description': (<class 'str'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'permissions': <class 'pytan3.api_objects.rest_7_3_314_3424.PermissionList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of UserRoleList

API_LIST_API_NAME = 'roles'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.UserOwnedObjectIds(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'user_owned_object_ids'

str – Name of object used in API calls.

API_NAME_SRC = 'user_owned_object_ids'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'plugin_schedules': <class 'pytan3.api_objects.rest_7_3_314_3424.PluginScheduleList'>, 'saved_actions': <class 'pytan3.api_objects.rest_7_3_314_3424.SavedActionList'>, 'saved_questions': <class 'pytan3.api_objects.rest_7_3_314_3424.SavedQuestionList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.User(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'user'

str – Name of object used in API calls.

API_NAME_SRC = 'user'

str – Name of object in source file.

API_SIMPLE = {'active_session_count': (<class 'int'>,), 'deleted_flag': (<class 'int'>,), 'display_name': (<class 'str'>,), 'domain': (<class 'str'>,), 'effective_group_id': (<class 'int'>,), 'external_flag': (<class 'int'>,), 'group_id': (<class 'int'>,), 'id': (<class 'int'>,), 'last_login': (<class 'str'>,), 'local_admin_flag': (<class 'int'>,), 'locked_out': (<class 'int'>,), 'name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set_roles': <class 'pytan3.api_objects.rest_7_3_314_3424.ContentSetRoleList'>, 'effective_content_set_privileges': <class 'pytan3.api_objects.rest_7_3_314_3424.EffectiveContentSetPrivilegeList'>, 'metadata': <class 'pytan3.api_objects.rest_7_3_314_3424.MetadataList'>, 'owned_object_ids': <class 'pytan3.api_objects.rest_7_3_314_3424.UserOwnedObjectIds'>, 'permissions': <class 'pytan3.api_objects.rest_7_3_314_3424.PermissionList'>, 'roles': <class 'pytan3.api_objects.rest_7_3_314_3424.UserRoleList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of UserList

API_LIST_API_NAME = 'users'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.ActionListInfo(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'action_list_info'

str – Name of object used in API calls.

API_NAME_SRC = 'action_list_info'

str – Name of object in source file.

API_SIMPLE = {'highest_id': (<class 'int'>,), 'total_count': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.Action(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'action'

str – Name of object used in API calls.

API_NAME_SRC = 'action'

str – Name of object in source file.

API_SIMPLE = {'cache_row_id': (<class 'int'>,), 'comment': (<class 'str'>,), 'creation_time': (<class 'str'>,), 'distribute_seconds': (<class 'int'>,), 'expiration_time': (<class 'str'>,), 'expire_seconds': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'skip_lock_flag': (<class 'int'>,), 'start_time': (<class 'str'>,), 'status': (<class 'str'>,), 'stopped_flag': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'action_group': <class 'pytan3.api_objects.rest_7_3_314_3424.Group'>, 'approver': <class 'pytan3.api_objects.rest_7_3_314_3424.User'>, 'history_saved_question': <class 'pytan3.api_objects.rest_7_3_314_3424.SavedQuestion'>, 'metadata': <class 'pytan3.api_objects.rest_7_3_314_3424.MetadataList'>, 'package_spec': <class 'pytan3.api_objects.rest_7_3_314_3424.PackageSpec'>, 'saved_action': <class 'pytan3.api_objects.rest_7_3_314_3424.SavedAction'>, 'target_group': <class 'pytan3.api_objects.rest_7_3_314_3424.Group'>, 'user': <class 'pytan3.api_objects.rest_7_3_314_3424.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ActionList

API_LIST_API_NAME = 'actions'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.ActionStop(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'action_stop'

str – Name of object used in API calls.

API_NAME_SRC = 'action_stop'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'action': <class 'pytan3.api_objects.rest_7_3_314_3424.Action'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ActionStopList

API_LIST_API_NAME = 'action_stops'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.ArchivedQuestion(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'archived_question'

str – Name of object used in API calls.

API_NAME_SRC = 'archived_question'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ArchivedQuestionList

API_LIST_API_NAME = 'archived_questions'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.SavedQuestion(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'saved_question'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_question'

str – Name of object in source file.

API_SIMPLE = {'action_tracking_flag': (<class 'int'>,), 'archive_enabled_flag': (<class 'int'>,), 'cache_row_id': (<class 'int'>,), 'deleted_flag': (<class 'int'>,), 'expire_seconds': (<class 'int'>,), 'hidden_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'index': (<class 'int'>,), 'issue_seconds': (<class 'int'>,), 'issue_seconds_never_flag': (<class 'int'>,), 'keep_seconds': (<class 'int'>,), 'mod_time': (<class 'str'>,), 'most_recent_question_id': (<class 'int'>,), 'name': (<class 'str'>,), 'public_flag': (<class 'int'>,), 'query_text': (<class 'str'>,), 'row_count_flag': (<class 'int'>,), 'seeding_question_ids': (<class 'str'>,), 'skip_schedule_on_update_flag': (<class 'int'>,), 'sort_column': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'archive_owner': <class 'pytan3.api_objects.rest_7_3_314_3424.User'>, 'content_set': <class 'pytan3.api_objects.rest_7_3_314_3424.IdReference'>, 'metadata': <class 'pytan3.api_objects.rest_7_3_314_3424.MetadataList'>, 'mod_user': <class 'pytan3.api_objects.rest_7_3_314_3424.User'>, 'packages': <class 'pytan3.api_objects.rest_7_3_314_3424.PackageSpecList'>, 'question': <class 'pytan3.api_objects.rest_7_3_314_3424.Question'>, 'user': <class 'pytan3.api_objects.rest_7_3_314_3424.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SavedQuestionList

API_LIST_API_NAME = 'saved_questions'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.ParseJob(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'parse_job'

str – Name of object used in API calls.

API_NAME_SRC = 'parse_job'

str – Name of object in source file.

API_SIMPLE = {'parser_version': (<class 'int'>,), 'question_text': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ParseJobList

API_LIST_API_NAME = 'parse_jobs'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.Parameter(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'parameter'

str – Name of object used in API calls.

API_NAME_SRC = 'parameter'

str – Name of object in source file.

API_SIMPLE = {'key': (<class 'str'>,), 'type': (<class 'int'>,), 'value': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ParameterList

API_LIST_API_NAME = 'parameters'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.ParseResult(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'parse_result'

str – Name of object used in API calls.

API_NAME_SRC = 'parse_result'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,), 'parameter_definition': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'parameters': <class 'pytan3.api_objects.rest_7_3_314_3424.ParameterList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ParseResultList

API_LIST_API_NAME = 'parse_results'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.SensorReference(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'sensor_reference'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_reference'

str – Name of object in source file.

API_SIMPLE = {'name': (<class 'str'>,), 'real_ms_avg': (<class 'int'>,), 'start_char': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SensorReferenceList

API_LIST_API_NAME = 'sensor_references'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.ParseResultGroup(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'parse_result_group'

str – Name of object used in API calls.

API_NAME_SRC = 'parse_result_group'

str – Name of object in source file.

API_SIMPLE = {'question_text': (<class 'str'>,), 'score': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'parameter_values': <class 'pytan3.api_objects.rest_7_3_314_3424.ParameterValueList'>, 'parse_results': <class 'pytan3.api_objects.rest_7_3_314_3424.ParseResultList'>, 'question': <class 'pytan3.api_objects.rest_7_3_314_3424.Question'>, 'question_group_sensors': <class 'pytan3.api_objects.rest_7_3_314_3424.SensorList'>, 'sensor_references': <class 'pytan3.api_objects.rest_7_3_314_3424.SensorReferenceList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ParseResultGroupList

API_LIST_API_NAME = 'parse_result_groups'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.ClientCount(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'client_count'

str – Name of object used in API calls.

API_NAME_SRC = 'client_count'

str – Name of object in source file.

API_SIMPLE = {'count': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.PluginArgument(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'plugin_argument'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_argument'

str – Name of object in source file.

API_SIMPLE = {'name': (<class 'str'>,), 'type': (<class 'str'>,), 'value': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of PluginArgumentList

API_LIST_API_NAME = 'plugin_arguments'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.UploadFile(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'upload_file'

str – Name of object used in API calls.

API_NAME_SRC = 'upload_file'

str – Name of object in source file.

API_SIMPLE = {'bytes': (<class 'str'>,), 'destination_file': (<class 'str'>,), 'file_cached': (<class 'int'>,), 'file_size': (<class 'int'>,), 'force_overwrite': (<class 'int'>,), 'hash': (<class 'str'>,), 'id': (<class 'int'>,), 'key': (<class 'str'>,), 'part_size': (<class 'int'>,), 'percent_complete': (<class 'int'>,), 'start_pos': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of UploadFileList

API_LIST_API_NAME = 'upload_files'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.UploadFileStatus(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'upload_file_status'

str – Name of object used in API calls.

API_NAME_SRC = 'upload_file_status'

str – Name of object in source file.

API_SIMPLE = {'file_cached': (<class 'int'>,), 'hash': (<class 'str'>,), 'percent_complete': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'file_parts': <class 'pytan3.api_objects.rest_7_3_314_3424.UploadFileList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.Plugin(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'plugin'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin'

str – Name of object in source file.

API_SIMPLE = {'allow_rest': (<class 'int'>,), 'bundle': (<class 'str'>,), 'cache_row_id': (<class 'int'>,), 'execution_id': (<class 'int'>,), 'exit_code': (<class 'int'>,), 'filename': (<class 'str'>,), 'input': (<class 'str'>,), 'local_admin_flag': (<class 'int'>,), 'name': (<class 'str'>,), 'path': (<class 'str'>,), 'plugin_server': (<class 'str'>,), 'plugin_url': (<class 'str'>,), 'raw_http_request': (<class 'int'>,), 'raw_http_response': (<class 'int'>,), 'run_detached_flag': (<class 'int'>,), 'script_response': (<class 'str'>,), 'status': (<class 'str'>,), 'status_file_content': (<class 'str'>,), 'timeout_seconds': (<class 'int'>,), 'type': (<class 'str'>,), 'use_json_flag': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'arguments': <class 'pytan3.api_objects.rest_7_3_314_3424.PluginArgumentList'>, 'commands': <class 'pytan3.api_objects.rest_7_3_314_3424.PluginCommandList'>, 'content_set': <class 'pytan3.api_objects.rest_7_3_314_3424.ContentSet'>, 'metadata': <class 'pytan3.api_objects.rest_7_3_314_3424.MetadataList'>, 'permissions': <class 'pytan3.api_objects.rest_7_3_314_3424.PermissionList'>, 'sql_response': <class 'pytan3.api_objects.rest_7_3_314_3424.PluginSql'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {'SCRIPT': 'Script', 'SQL': 'SQL'}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of PluginList

API_LIST_API_NAME = 'plugins'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.PluginSchedule(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'plugin_schedule'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_schedule'

str – Name of object in source file.

API_SIMPLE = {'deleted_flag': (<class 'int'>,), 'enabled': (<class 'int'>,), 'end_date': (<class 'str'>,), 'end_hour': (<class 'int'>,), 'id': (<class 'int'>,), 'input': (<class 'str'>,), 'last_exit_code': (<class 'int'>,), 'last_run_text': (<class 'str'>,), 'last_run_time': (<class 'str'>,), 'modification_time': (<class 'str'>,), 'name': (<class 'str'>,), 'plugin_bundle': (<class 'str'>,), 'plugin_name': (<class 'str'>,), 'plugin_server': (<class 'str'>,), 'run_interval_seconds': (<class 'int'>,), 'run_on_days': (<class 'str'>,), 'start_date': (<class 'str'>,), 'start_hour': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'arguments': <class 'pytan3.api_objects.rest_7_3_314_3424.PluginArgumentList'>, 'last_run_sql': <class 'pytan3.api_objects.rest_7_3_314_3424.PluginSql'>, 'mod_user': <class 'pytan3.api_objects.rest_7_3_314_3424.User'>, 'user': <class 'pytan3.api_objects.rest_7_3_314_3424.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of PluginScheduleList

API_LIST_API_NAME = 'plugin_schedules'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.ComputerGroupSpec(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'computer_group_spec'

str – Name of object used in API calls.

API_NAME_SRC = 'computer_group_spec'

str – Name of object in source file.

API_SIMPLE = {'computer_name': (<class 'str'>,), 'id': (<class 'int'>,), 'ip_address': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ComputerSpecList

API_LIST_API_NAME = 'computer_specs'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.ComputerGroup(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'computer_group'

str – Name of object used in API calls.

API_NAME_SRC = 'computer_group'

str – Name of object in source file.

API_SIMPLE = {'deleted_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'computer_specs': <class 'pytan3.api_objects.rest_7_3_314_3424.ComputerSpecList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ComputerGroupList

API_LIST_API_NAME = 'computer_groups'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.VerifySignature(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'verify_signature'

str – Name of object used in API calls.

API_NAME_SRC = 'verify_signature'

str – Name of object in source file.

API_SIMPLE = {'bytes': (<class 'str'>,), 'id': (<class 'int'>,), 'type': (<class 'str'>,), 'verified': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.ObjectList(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'object_list'

str – Name of object used in API calls.

API_NAME_SRC = 'object_list'

str – Name of object in source file.

API_SIMPLE = {'export_id': (<class 'str'>,), 'export_version': (<class 'int'>,), 'import_content': (<class 'str'>,), 'server_info': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'action': <class 'pytan3.api_objects.rest_7_3_314_3424.Action'>, 'action_group': <class 'pytan3.api_objects.rest_7_3_314_3424.ActionGroup'>, 'action_groups': <class 'pytan3.api_objects.rest_7_3_314_3424.ActionGroupList'>, 'action_stop': <class 'pytan3.api_objects.rest_7_3_314_3424.ActionStop'>, 'action_stops': <class 'pytan3.api_objects.rest_7_3_314_3424.ActionStopList'>, 'actions': <class 'pytan3.api_objects.rest_7_3_314_3424.ActionList'>, 'archived_question': <class 'pytan3.api_objects.rest_7_3_314_3424.ArchivedQuestion'>, 'archived_questions': <class 'pytan3.api_objects.rest_7_3_314_3424.ArchivedQuestionList'>, 'audit_log': <class 'pytan3.api_objects.rest_7_3_314_3424.AuditLog'>, 'audit_logs': <class 'pytan3.api_objects.rest_7_3_314_3424.AuditLogList'>, 'client_count': <class 'pytan3.api_objects.rest_7_3_314_3424.ClientCount'>, 'client_status': <class 'pytan3.api_objects.rest_7_3_314_3424.ClientStatus'>, 'computer_group': <class 'pytan3.api_objects.rest_7_3_314_3424.ComputerGroup'>, 'computer_groups': <class 'pytan3.api_objects.rest_7_3_314_3424.ComputerGroupList'>, 'content_set': <class 'pytan3.api_objects.rest_7_3_314_3424.ContentSet'>, 'content_set_privilege': <class 'pytan3.api_objects.rest_7_3_314_3424.ContentSetPrivilege'>, 'content_set_privileges': <class 'pytan3.api_objects.rest_7_3_314_3424.ContentSetPrivilegeList'>, 'content_set_role': <class 'pytan3.api_objects.rest_7_3_314_3424.ContentSetRole'>, 'content_set_role_membership': <class 'pytan3.api_objects.rest_7_3_314_3424.ContentSetRoleMembership'>, 'content_set_role_memberships': <class 'pytan3.api_objects.rest_7_3_314_3424.ContentSetRoleMembershipList'>, 'content_set_role_privilege': <class 'pytan3.api_objects.rest_7_3_314_3424.ContentSetRolePrivilege'>, 'content_set_role_privileges': <class 'pytan3.api_objects.rest_7_3_314_3424.ContentSetRolePrivilegeList'>, 'content_set_roles': <class 'pytan3.api_objects.rest_7_3_314_3424.ContentSetRoleList'>, 'content_set_user_group_role_membership': <class 'pytan3.api_objects.rest_7_3_314_3424.ContentSetUserGroupRoleMembership'>, 'content_set_user_group_role_memberships': <class 'pytan3.api_objects.rest_7_3_314_3424.ContentSetUserGroupRoleMembershipList'>, 'content_sets': <class 'pytan3.api_objects.rest_7_3_314_3424.ContentSetList'>, 'effective_content_set_privileges': <class 'pytan3.api_objects.rest_7_3_314_3424.EffectiveContentSetPrivilegeRequest'>, 'group': <class 'pytan3.api_objects.rest_7_3_314_3424.Group'>, 'groups': <class 'pytan3.api_objects.rest_7_3_314_3424.GroupList'>, 'hashed_string': <class 'pytan3.api_objects.rest_7_3_314_3424.HashedString'>, 'hashed_strings': <class 'pytan3.api_objects.rest_7_3_314_3424.HashedStringList'>, 'import_conflict_details': <class 'pytan3.api_objects.rest_7_3_314_3424.ImportConflictDetailList'>, 'ldap_sync_connector': <class 'pytan3.api_objects.rest_7_3_314_3424.LdapSyncConnector'>, 'ldap_sync_connectors': <class 'pytan3.api_objects.rest_7_3_314_3424.LdapSyncConnectorList'>, 'package_file': <class 'pytan3.api_objects.rest_7_3_314_3424.PackageFile'>, 'package_files': <class 'pytan3.api_objects.rest_7_3_314_3424.PackageFileList'>, 'package_spec': <class 'pytan3.api_objects.rest_7_3_314_3424.PackageSpec'>, 'package_specs': <class 'pytan3.api_objects.rest_7_3_314_3424.PackageSpecList'>, 'parse_job': <class 'pytan3.api_objects.rest_7_3_314_3424.ParseJob'>, 'parse_jobs': <class 'pytan3.api_objects.rest_7_3_314_3424.ParseJobList'>, 'parse_result_group': <class 'pytan3.api_objects.rest_7_3_314_3424.ParseResultGroup'>, 'parse_result_groups': <class 'pytan3.api_objects.rest_7_3_314_3424.ParseResultGroupList'>, 'plugin': <class 'pytan3.api_objects.rest_7_3_314_3424.Plugin'>, 'plugin_schedule': <class 'pytan3.api_objects.rest_7_3_314_3424.PluginSchedule'>, 'plugin_schedules': <class 'pytan3.api_objects.rest_7_3_314_3424.PluginScheduleList'>, 'plugins': <class 'pytan3.api_objects.rest_7_3_314_3424.PluginList'>, 'question': <class 'pytan3.api_objects.rest_7_3_314_3424.Question'>, 'questions': <class 'pytan3.api_objects.rest_7_3_314_3424.QuestionList'>, 'roles': <class 'pytan3.api_objects.rest_7_3_314_3424.UserRoleList'>, 'saved_action': <class 'pytan3.api_objects.rest_7_3_314_3424.SavedAction'>, 'saved_action_approval': <class 'pytan3.api_objects.rest_7_3_314_3424.SavedActionApproval'>, 'saved_action_approvals': <class 'pytan3.api_objects.rest_7_3_314_3424.SavedActionApprovalList'>, 'saved_actions': <class 'pytan3.api_objects.rest_7_3_314_3424.SavedActionList'>, 'saved_question': <class 'pytan3.api_objects.rest_7_3_314_3424.SavedQuestion'>, 'saved_question_package_specs': <class 'pytan3.api_objects.rest_7_3_314_3424.SavedQuestionPackageSpecs'>, 'saved_question_question': <class 'pytan3.api_objects.rest_7_3_314_3424.SavedQuestionQuestion'>, 'saved_question_questions': <class 'pytan3.api_objects.rest_7_3_314_3424.SavedQuestionQuestionList'>, 'saved_questions': <class 'pytan3.api_objects.rest_7_3_314_3424.SavedQuestionList'>, 'sensor': <class 'pytan3.api_objects.rest_7_3_314_3424.Sensor'>, 'sensor_stat': <class 'pytan3.api_objects.rest_7_3_314_3424.SensorStat'>, 'sensor_stats': <class 'pytan3.api_objects.rest_7_3_314_3424.SensorStatList'>, 'sensors': <class 'pytan3.api_objects.rest_7_3_314_3424.SensorList'>, 'server_host': <class 'pytan3.api_objects.rest_7_3_314_3424.ServerHost'>, 'server_hosts': <class 'pytan3.api_objects.rest_7_3_314_3424.ServerHostList'>, 'server_throttle': <class 'pytan3.api_objects.rest_7_3_314_3424.ServerThrottle'>, 'server_throttle_status': <class 'pytan3.api_objects.rest_7_3_314_3424.ServerThrottleStatus'>, 'server_throttle_statuses': <class 'pytan3.api_objects.rest_7_3_314_3424.ServerThrottleStatusList'>, 'server_throttles': <class 'pytan3.api_objects.rest_7_3_314_3424.ServerThrottleList'>, 'site_throttle': <class 'pytan3.api_objects.rest_7_3_314_3424.SiteThrottle'>, 'site_throttle_status': <class 'pytan3.api_objects.rest_7_3_314_3424.SiteThrottleStatus'>, 'site_throttles': <class 'pytan3.api_objects.rest_7_3_314_3424.SiteThrottleList'>, 'site_throttles_statuses': <class 'pytan3.api_objects.rest_7_3_314_3424.SiteThrottleStatusList'>, 'soap_error': <class 'pytan3.api_objects.rest_7_3_314_3424.SoapError'>, 'solution': <class 'pytan3.api_objects.rest_7_3_314_3424.Solution'>, 'solutions': <class 'pytan3.api_objects.rest_7_3_314_3424.SolutionList'>, 'system_setting': <class 'pytan3.api_objects.rest_7_3_314_3424.SystemSetting'>, 'system_settings': <class 'pytan3.api_objects.rest_7_3_314_3424.SystemSettingList'>, 'system_status': <class 'pytan3.api_objects.rest_7_3_314_3424.SystemStatusList'>, 'upload_file': <class 'pytan3.api_objects.rest_7_3_314_3424.UploadFile'>, 'upload_file_status': <class 'pytan3.api_objects.rest_7_3_314_3424.UploadFileStatus'>, 'user': <class 'pytan3.api_objects.rest_7_3_314_3424.User'>, 'user_group': <class 'pytan3.api_objects.rest_7_3_314_3424.UserGroup'>, 'user_groups': <class 'pytan3.api_objects.rest_7_3_314_3424.UserGroupList'>, 'users': <class 'pytan3.api_objects.rest_7_3_314_3424.UserList'>, 'verify_signature': <class 'pytan3.api_objects.rest_7_3_314_3424.VerifySignature'>, 'white_listed_url': <class 'pytan3.api_objects.rest_7_3_314_3424.WhiteListedUrl'>, 'white_listed_urls': <class 'pytan3.api_objects.rest_7_3_314_3424.WhiteListedUrlList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.ImportConflictDetail(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'import_conflict_detail'

str – Name of object used in API calls.

API_NAME_SRC = 'import_conflict_detail'

str – Name of object in source file.

API_SIMPLE = {'diff': (<class 'str'>,), 'is_new': (<class 'int'>,), 'name': (<class 'str'>,), 'type': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ImportConflictDetailList

API_LIST_API_NAME = 'import_conflict_details'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.CacheFilter(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'cache_filter'

str – Name of object used in API calls.

API_NAME_SRC = 'cache_filter'

str – Name of object in source file.

API_SIMPLE = {'and_flag': (<class 'int'>,), 'field': (<class 'str'>,), 'not_flag': (<class 'int'>,), 'operator': (<class 'str'>,), 'type': (<class 'str'>,), 'value': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'sub_filters': <class 'pytan3.api_objects.rest_7_3_314_3424.CacheFilterList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of CacheFilterList

API_LIST_API_NAME = 'cache_filters'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.Options(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'options'

str – Name of object used in API calls.

API_NAME_SRC = 'options'

str – Name of object in source file.

API_SIMPLE = {'aggregate_by_value_flag': (<class 'int'>,), 'aggregate_over_time_flag': (<class 'int'>,), 'allow_cdata_base64_encode_flag': (<class 'int'>,), 'audit_history_size': (<class 'int'>,), 'cache_expiration': (<class 'int'>,), 'cache_id': (<class 'int'>,), 'cache_sort_fields': (<class 'str'>,), 'cdata_base64_encoded': (<class 'int'>,), 'context_id': (<class 'int'>,), 'disable_live_snapshots': (<class 'int'>,), 'export_dont_include_related': (<class 'int'>,), 'export_flag': (<class 'int'>,), 'export_format': (<class 'int'>,), 'export_hide_csv_header_flag': (<class 'int'>,), 'export_leading_text': (<class 'str'>,), 'export_omit_soap_envelope': (<class 'int'>,), 'export_trailing_text': (<class 'str'>,), 'filter_not_flag': (<class 'int'>,), 'filter_string': (<class 'str'>,), 'flags': (<class 'int'>,), 'hide_errors_flag': (<class 'int'>,), 'hide_no_results_flag': (<class 'int'>,), 'import_analyze_conflicts_only': (<class 'int'>,), 'import_existing_ignore_content_set': (<class 'int'>,), 'include_answer_times_flag': (<class 'int'>,), 'include_hashes_flag': (<class 'int'>,), 'include_hidden_flag': (<class 'int'>,), 'include_user_details': (<class 'int'>,), 'include_user_owned_object_ids_flag': (<class 'int'>,), 'json_pretty_print': (<class 'int'>,), 'live_snapshot_always_use_seconds': (<class 'int'>,), 'live_snapshot_expiration_seconds': (<class 'int'>,), 'live_snapshot_invalidate_report_count_percentage': (<class 'int'>,), 'live_snapshot_report_count_threshold': (<class 'int'>,), 'most_recent_flag': (<class 'int'>,), 'no_result_row_collation_flag': (<class 'int'>,), 'pct_done_limit': (<class 'int'>,), 'recent_result_buckets': (<class 'str'>,), 'return_cdata_flag': (<class 'int'>,), 'return_lists_flag': (<class 'int'>,), 'row_count': (<class 'int'>,), 'row_counts_only_flag': (<class 'int'>,), 'row_start': (<class 'int'>,), 'sample_count': (<class 'int'>,), 'sample_frequency': (<class 'int'>,), 'sample_start': (<class 'int'>,), 'saved_question_qids_allow_multiple_flag': (<class 'int'>,), 'saved_question_qids_ignore_mr_group_flag': (<class 'int'>,), 'saved_question_qids_include_expired_flag': (<class 'int'>,), 'saved_question_qids_reissue_flag': (<class 'int'>,), 'script_data': (<class 'str'>,), 'sort_order': (<class 'str'>,), 'suppress_object_list': (<class 'int'>,), 'suppress_scripts': (<class 'int'>,), 'use_error_objects': (<class 'int'>,), 'use_json': (<class 'int'>,), 'use_user_context_flag': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_filters': <class 'pytan3.api_objects.rest_7_3_314_3424.CacheFilterList'>, 'import_conflict_options': <class 'pytan3.api_objects.rest_7_3_314_3424.ImportConflictOptions'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.ContentSet(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'content_set'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set'

str – Name of object in source file.

API_SIMPLE = {'description': (<class 'str'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'reserved_name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'metadata': <class 'pytan3.api_objects.rest_7_3_314_3424.MetadataList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ContentSetList

API_LIST_API_NAME = 'content_sets'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.ContentSetRolePrivilegeOnRole(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'content_set_role_privilege_on_role'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role_privilege_on_role'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set': <class 'pytan3.api_objects.rest_7_3_314_3424.IdReference'>, 'content_set_privilege': <class 'pytan3.api_objects.rest_7_3_314_3424.IdReference'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ContentSetRolePrivilegeOnRoleList

API_LIST_API_NAME = 'content_set_role_privilege_on_roles'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.ContentSetRole(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'content_set_role'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role'

str – Name of object in source file.

API_SIMPLE = {'all_content_sets_flag': (<class 'int'>,), 'category': (<class 'str'>,), 'deny_flag': (<class 'int'>,), 'description': (<class 'str'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'reserved_name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set_role_privileges': <class 'pytan3.api_objects.rest_7_3_314_3424.ContentSetRolePrivilegeOnRoleList'>, 'metadata': <class 'pytan3.api_objects.rest_7_3_314_3424.MetadataList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ContentSetRoleList

API_LIST_API_NAME = 'content_set_roles'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.ContentSetRoleMembership(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'content_set_role_membership'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role_membership'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set_role': <class 'pytan3.api_objects.rest_7_3_314_3424.IdReference'>, 'user': <class 'pytan3.api_objects.rest_7_3_314_3424.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ContentSetRoleMembershipList

API_LIST_API_NAME = 'content_set_role_memberships'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.ContentSetUserGroupRoleMembership(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'content_set_user_group_role_membership'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_user_group_role_membership'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set_role': <class 'pytan3.api_objects.rest_7_3_314_3424.IdReference'>, 'user_group': <class 'pytan3.api_objects.rest_7_3_314_3424.IdReference'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ContentSetUserGroupRoleMembershipList

API_LIST_API_NAME = 'content_set_user_group_role_memberships'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.ContentSetPrivilege(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'content_set_privilege'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_privilege'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,), 'name': (<class 'str'>,), 'privilege_module': (<class 'str'>,), 'privilege_type': (<class 'str'>,), 'reserved_name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'metadata': <class 'pytan3.api_objects.rest_7_3_314_3424.MetadataList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ContentSetPrivilegeList

API_LIST_API_NAME = 'content_set_privileges'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.ContentSetRolePrivilege(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'content_set_role_privilege'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role_privilege'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set': <class 'pytan3.api_objects.rest_7_3_314_3424.IdReference'>, 'content_set_privilege': <class 'pytan3.api_objects.rest_7_3_314_3424.IdReference'>, 'content_set_role': <class 'pytan3.api_objects.rest_7_3_314_3424.IdReference'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ContentSetRolePrivilegeList

API_LIST_API_NAME = 'content_set_role_privileges'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.EffectiveContentSetPrivilege(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'effective_content_set_privilege'

str – Name of object used in API calls.

API_NAME_SRC = 'effective_content_set_privilege'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set': <class 'pytan3.api_objects.rest_7_3_314_3424.ContentSet'>, 'content_set_privilege_list': <class 'pytan3.api_objects.rest_7_3_314_3424.ContentSetPrivilegeList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of EffectiveContentSetPrivilegeList

API_LIST_API_NAME = 'effective_content_set_privileges'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.Dashboard(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'dashboard'

str – Name of object used in API calls.

API_NAME_SRC = 'dashboard'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,), 'name': (<class 'str'>,), 'public_flag': (<class 'int'>,), 'text': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set': <class 'pytan3.api_objects.rest_7_3_314_3424.ContentSet'>, 'group': <class 'pytan3.api_objects.rest_7_3_314_3424.Group'>, 'saved_question_list': <class 'pytan3.api_objects.rest_7_3_314_3424.SavedQuestionList'>, 'user': <class 'pytan3.api_objects.rest_7_3_314_3424.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of DashboardList

API_LIST_API_NAME = 'dashboards'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.DashboardGroup(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'dashboard_group'

str – Name of object used in API calls.

API_NAME_SRC = 'dashboard_group'

str – Name of object in source file.

API_SIMPLE = {'display_index': (<class 'int'>,), 'editable_flag': (<class 'int'>,), 'icon': (<class 'str'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'other_flag': (<class 'int'>,), 'public_flag': (<class 'int'>,), 'text': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set': <class 'pytan3.api_objects.rest_7_3_314_3424.ContentSet'>, 'dashboard_list': <class 'pytan3.api_objects.rest_7_3_314_3424.DashboardList'>, 'user': <class 'pytan3.api_objects.rest_7_3_314_3424.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.UserGroup(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'user_group'

str – Name of object used in API calls.

API_NAME_SRC = 'user_group'

str – Name of object in source file.

API_SIMPLE = {'deleted_flag': (<class 'int'>,), 'exclusive_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set_roles': <class 'pytan3.api_objects.rest_7_3_314_3424.ContentSetRoleList'>, 'group': <class 'pytan3.api_objects.rest_7_3_314_3424.Group'>, 'user_list': <class 'pytan3.api_objects.rest_7_3_314_3424.UserList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of UserGroupList

API_LIST_API_NAME = 'user_groups'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.Solution(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'solution'

str – Name of object used in API calls.

API_NAME_SRC = 'solution'

str – Name of object in source file.

API_SIMPLE = {'category': (<class 'str'>,), 'delete_xml_url': (<class 'str'>,), 'deleted_flag': (<class 'int'>,), 'description': (<class 'str'>,), 'dup_resolve_type': (<class 'int'>,), 'id': (<class 'int'>,), 'imported_by': (<class 'str'>,), 'imported_version': (<class 'str'>,), 'installed_xml_url': (<class 'str'>,), 'last_update': (<class 'str'>,), 'name': (<class 'str'>,), 'signature': (<class 'str'>,), 'solution_id': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SolutionList

API_LIST_API_NAME = 'solutions'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.ActionGroup(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'action_group'

str – Name of object used in API calls.

API_NAME_SRC = 'action_group'

str – Name of object in source file.

API_SIMPLE = {'and_flag': (<class 'int'>,), 'deleted_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'public_flag': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'groups': <class 'pytan3.api_objects.rest_7_3_314_3424.GroupList'>, 'user_groups': <class 'pytan3.api_objects.rest_7_3_314_3424.UserGroupList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ActionGroupList

API_LIST_API_NAME = 'action_groups'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.SavedQuestionPackageSpecs(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'saved_question_package_specs'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_question_package_specs'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'packages': <class 'pytan3.api_objects.rest_7_3_314_3424.PackageSpecList'>, 'saved_question': <class 'pytan3.api_objects.rest_7_3_314_3424.IdReference'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.SavedQuestionQuestion(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'saved_question_question'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_question_question'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'questions': <class 'pytan3.api_objects.rest_7_3_314_3424.QuestionList'>, 'saved_question': <class 'pytan3.api_objects.rest_7_3_314_3424.IdReference'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SavedQuestionQuestionList

API_LIST_API_NAME = 'saved_question_questions'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.LdapSyncConnector(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'ldap_sync_connector'

str – Name of object used in API calls.

API_NAME_SRC = 'ldap_sync_connector'

str – Name of object in source file.

API_SIMPLE = {'base_groups': (<class 'str'>,), 'base_users': (<class 'str'>,), 'disable_ldap_auth': (<class 'int'>,), 'disable_referrals_flag': (<class 'int'>,), 'enable': (<class 'int'>,), 'filter_groups': (<class 'str'>,), 'filter_users': (<class 'str'>,), 'group_id': (<class 'str'>,), 'group_member': (<class 'str'>,), 'group_name': (<class 'str'>,), 'host': (<class 'str'>,), 'id': (<class 'int'>,), 'last_sync_result': (<class 'str'>,), 'last_sync_timestamp': (<class 'str'>,), 'ldap_password': (<class 'str'>,), 'ldap_user': (<class 'str'>,), 'members_only_flag': (<class 'int'>,), 'name': (<class 'str'>,), 'port': (<class 'int'>,), 'secure': (<class 'int'>,), 'use_ntlm': (<class 'int'>,), 'user_display_name': (<class 'str'>,), 'user_domain': (<class 'str'>,), 'user_id': (<class 'str'>,), 'user_member_of': (<class 'str'>,), 'user_name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of LdapSyncConnectorList

API_LIST_API_NAME = 'ldap_sync_connectors'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.ServerThrottle(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'server_throttle'

str – Name of object used in API calls.

API_NAME_SRC = 'server_throttle'

str – Name of object in source file.

API_SIMPLE = {'bandwidth_bytes_limit': (<class 'int'>,), 'connection_limit': (<class 'int'>,), 'deleted_flag': (<class 'int'>,), 'download_bandwidth_bytes_limit': (<class 'int'>,), 'download_connection_limit': (<class 'int'>,), 'id': (<class 'int'>,), 'ip_address': (<class 'str'>,), 'name': (<class 'str'>,), 'sensor_bandwidth_bytes_limit': (<class 'int'>,), 'sensor_connection_limit': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ServerThrottleList

API_LIST_API_NAME = 'server_throttles'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.SiteThrottle(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'site_throttle'

str – Name of object used in API calls.

API_NAME_SRC = 'site_throttle'

str – Name of object in source file.

API_SIMPLE = {'all_subnets_flag': (<class 'int'>,), 'bandwidth_bytes_limit': (<class 'int'>,), 'deleted_flag': (<class 'int'>,), 'download_bandwidth_bytes_limit': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'sensor_bandwidth_bytes_limit': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'subnets': <class 'pytan3.api_objects.rest_7_3_314_3424.SiteThrottleSubnetList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SiteThrottleList

API_LIST_API_NAME = 'site_throttles'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.SiteThrottleSubnet(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'site_throttle_subnet'

str – Name of object used in API calls.

API_NAME_SRC = 'site_throttle_subnet'

str – Name of object in source file.

API_SIMPLE = {'range': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SiteThrottleSubnetList

API_LIST_API_NAME = 'site_throttle_subnets'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.ServerThrottleStatus(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'server_throttle_status'

str – Name of object used in API calls.

API_NAME_SRC = 'server_throttle_status'

str – Name of object in source file.

API_SIMPLE = {'download_queue_delay_milliseconds': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'queue_delay_milliseconds': (<class 'int'>,), 'sensor_queue_delay_milliseconds': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ServerThrottleStatusList

API_LIST_API_NAME = 'server_throttle_statuses'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.SiteThrottleStatus(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'site_throttle_status'

str – Name of object used in API calls.

API_NAME_SRC = 'site_throttle_status'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,), 'name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'subnets': <class 'pytan3.api_objects.rest_7_3_314_3424.SiteThrottleSubnetStatusList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SiteThrottleStatusList

API_LIST_API_NAME = 'site_throttles_statuses'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.SiteThrottleSubnetStatus(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'site_throttle_subnet_status'

str – Name of object used in API calls.

API_NAME_SRC = 'site_throttle_subnet_status'

str – Name of object in source file.

API_SIMPLE = {'download_queue_delay_milliseconds': (<class 'int'>,), 'queue_delay_milliseconds': (<class 'int'>,), 'range': (<class 'str'>,), 'sensor_queue_delay_milliseconds': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SiteThrottleSubnetStatusList

API_LIST_API_NAME = 'site_throttle_subnet_statuss'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.HashedString(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'hashed_string'

str – Name of object used in API calls.

API_NAME_SRC = 'hashed_string'

str – Name of object in source file.

API_SIMPLE = {'collision_flag': (<class 'int'>,), 'error_flag': (<class 'int'>,), 'first_collision': (<class 'str'>,), 'second_collision': (<class 'str'>,), 'sensor_hash': (<class 'int'>,), 'value': (<class 'str'>,), 'value_hash': (<class 'int'>,), 'which_computer_id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'first_computer_id': <class 'pytan3.api_objects.rest_7_3_314_3424.ComputerIdList'>, 'second_computer_id': <class 'pytan3.api_objects.rest_7_3_314_3424.ComputerIdList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of HashedStringList

API_LIST_API_NAME = 'hashed_strings'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3424.SensorQueryList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'sensor_querys'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_query_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'query'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SensorQuery

class pytan3.api_objects.rest_7_3_314_3424.SensorSubcolumnList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'sensor_subcolumns'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_subcolumn_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'subcolumn'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SensorSubcolumn

class pytan3.api_objects.rest_7_3_314_3424.StringHintList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'string_hints'

str – Name of object used in API calls.

API_NAME_SRC = 'string_hint_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'string_hint'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'str'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.rest_7_3_314_3424.SensorList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'sensors'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.rest_7_3_314_3424.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'sensor'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Sensor

class pytan3.api_objects.rest_7_3_314_3424.SensorStatList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'sensor_stats'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_stat_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'sensor_stat'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SensorStat

class pytan3.api_objects.rest_7_3_314_3424.SavedActionApprovalList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'saved_action_approvals'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_action_approval_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'saved_action_approval'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SavedActionApproval

class pytan3.api_objects.rest_7_3_314_3424.SavedActionRowIdList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'saved_action_row_ids'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_action_row_id_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'row_id'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'int'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.rest_7_3_314_3424.SavedActionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'saved_actions'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_action_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.rest_7_3_314_3424.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'saved_action'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SavedAction

class pytan3.api_objects.rest_7_3_314_3424.AuditDataList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'audit_datas'

str – Name of object used in API calls.

API_NAME_SRC = 'audit_data_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.rest_7_3_314_3424.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'entry'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of AuditData

class pytan3.api_objects.rest_7_3_314_3424.AuditLogList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'audit_logs'

str – Name of object used in API calls.

API_NAME_SRC = 'audit_log_list'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,), 'type': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'entries'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of AuditLog

class pytan3.api_objects.rest_7_3_314_3424.ServerList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'servers'

str – Name of object used in API calls.

API_NAME_SRC = 'server_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'server'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Server

class pytan3.api_objects.rest_7_3_314_3424.ServerHost(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'server_host'

str – Name of object used in API calls.

API_NAME_SRC = 'server_host'

str – Name of object in source file.

API_SIMPLE = {'heart_beat_age_in_minute': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'servers'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ServerList

class pytan3.api_objects.rest_7_3_314_3424.ServerHostList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'server_hosts'

str – Name of object used in API calls.

API_NAME_SRC = 'server_host_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'server_host'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ServerHost

class pytan3.api_objects.rest_7_3_314_3424.MetadataList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'metadatas'

str – Name of object used in API calls.

API_NAME_SRC = 'metadata_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'item'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of MetadataItem

class pytan3.api_objects.rest_7_3_314_3424.GroupList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'groups'

str – Name of object used in API calls.

API_NAME_SRC = 'group_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.rest_7_3_314_3424.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'group'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Group

class pytan3.api_objects.rest_7_3_314_3424.FilterList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'filters'

str – Name of object used in API calls.

API_NAME_SRC = 'filter_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'filter'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Filter

class pytan3.api_objects.rest_7_3_314_3424.SelectList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'selects'

str – Name of object used in API calls.

API_NAME_SRC = 'select_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'select'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Select

class pytan3.api_objects.rest_7_3_314_3424.ErrorList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'errors'

str – Name of object used in API calls.

API_NAME_SRC = 'error_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'error'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of XmlError

class pytan3.api_objects.rest_7_3_314_3424.QuestionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'questions'

str – Name of object used in API calls.

API_NAME_SRC = 'question_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.rest_7_3_314_3424.CacheInfo'>, 'info': <class 'pytan3.api_objects.rest_7_3_314_3424.QuestionListInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'question'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Question

class pytan3.api_objects.rest_7_3_314_3424.PackageFileTemplateList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'package_file_templates'

str – Name of object used in API calls.

API_NAME_SRC = 'package_file_template_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'file_template'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of PackageFileTemplate

class pytan3.api_objects.rest_7_3_314_3424.PackageFileStatusList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'package_file_statuss'

str – Name of object used in API calls.

API_NAME_SRC = 'package_file_status_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'status'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of PackageFileStatus

class pytan3.api_objects.rest_7_3_314_3424.PackageFileList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'package_files'

str – Name of object used in API calls.

API_NAME_SRC = 'package_file_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'file'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of PackageFile

class pytan3.api_objects.rest_7_3_314_3424.PackageSpecList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'package_specs'

str – Name of object used in API calls.

API_NAME_SRC = 'package_spec_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.rest_7_3_314_3424.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'package_spec'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of PackageSpec

class pytan3.api_objects.rest_7_3_314_3424.WhiteListedUrlList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'white_listed_urls'

str – Name of object used in API calls.

API_NAME_SRC = 'white_listed_url_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'white_listed_url'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of WhiteListedUrl

class pytan3.api_objects.rest_7_3_314_3424.VersionAggregateList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'version_aggregates'

str – Name of object used in API calls.

API_NAME_SRC = 'version_aggregate_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'version'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of VersionAggregate

class pytan3.api_objects.rest_7_3_314_3424.SystemStatusList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'system_status'

str – Name of object used in API calls.

API_NAME_SRC = 'system_status_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'aggregate': <class 'pytan3.api_objects.rest_7_3_314_3424.SystemStatusAggregate'>, 'cache_info': <class 'pytan3.api_objects.rest_7_3_314_3424.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'client_status'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ClientStatus

class pytan3.api_objects.rest_7_3_314_3424.SystemSettingList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'system_settings'

str – Name of object used in API calls.

API_NAME_SRC = 'system_setting_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.rest_7_3_314_3424.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'system_setting'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SystemSetting

class pytan3.api_objects.rest_7_3_314_3424.UserList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'users'

str – Name of object used in API calls.

API_NAME_SRC = 'user_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'user'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of User

class pytan3.api_objects.rest_7_3_314_3424.PermissionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'permissions'

str – Name of object used in API calls.

API_NAME_SRC = 'permission_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {'ACTION_APPROVE': 'action_approval', 'ACTION_READ': 'action_read', 'ACTION_WRITE': 'action_write', 'ADMIN': 'admin', 'CLIENTS_READ': 'clients_read', 'CONTENT_ADMIN': 'content_admin', 'NOTIFICATION_WRITE': 'notification_write', 'QUESTION_LOG_READ': 'question_log_read', 'QUESTION_READ': 'question_read', 'QUESTION_WRITE': 'question_write', 'SENSOR_READ': 'sensor_read', 'SENSOR_WRITE': 'sensor_write'}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'permission'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'str'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.rest_7_3_314_3424.UserRoleList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'roles'

str – Name of object used in API calls.

API_NAME_SRC = 'user_role_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'role'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of UserRole

class pytan3.api_objects.rest_7_3_314_3424.ActionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'actions'

str – Name of object used in API calls.

API_NAME_SRC = 'action_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.rest_7_3_314_3424.CacheInfo'>, 'info': <class 'pytan3.api_objects.rest_7_3_314_3424.ActionListInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'action'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Action

class pytan3.api_objects.rest_7_3_314_3424.ActionStopList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'action_stops'

str – Name of object used in API calls.

API_NAME_SRC = 'action_stop_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'action_stop'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ActionStop

class pytan3.api_objects.rest_7_3_314_3424.ArchivedQuestionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'archived_questions'

str – Name of object used in API calls.

API_NAME_SRC = 'archived_question_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'archived_question'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ArchivedQuestion

class pytan3.api_objects.rest_7_3_314_3424.SavedQuestionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'saved_questions'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_question_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.rest_7_3_314_3424.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'saved_question'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SavedQuestion

class pytan3.api_objects.rest_7_3_314_3424.ParseJobList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'parse_jobs'

str – Name of object used in API calls.

API_NAME_SRC = 'parse_job_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'parse_job'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ParseJob

class pytan3.api_objects.rest_7_3_314_3424.ParseResultGroupList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'parse_result_groups'

str – Name of object used in API calls.

API_NAME_SRC = 'parse_result_group_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'parse_result_group'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ParseResultGroup

class pytan3.api_objects.rest_7_3_314_3424.ParseResultList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'parse_results'

str – Name of object used in API calls.

API_NAME_SRC = 'parse_result_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'parse_result'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ParseResult

class pytan3.api_objects.rest_7_3_314_3424.ParameterList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'parameters'

str – Name of object used in API calls.

API_NAME_SRC = 'parameter_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'parameter'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Parameter

class pytan3.api_objects.rest_7_3_314_3424.ParameterValueList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'parameter_values'

str – Name of object used in API calls.

API_NAME_SRC = 'parameter_value_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'value'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'str'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.rest_7_3_314_3424.SensorReferenceList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'sensor_references'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_reference_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'sensor_reference'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SensorReference

class pytan3.api_objects.rest_7_3_314_3424.PluginArgumentList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'plugin_arguments'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_argument_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'argument'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of PluginArgument

class pytan3.api_objects.rest_7_3_314_3424.PluginSqlResultList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'plugin_sql_results'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_sql_result_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'value'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'str'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.rest_7_3_314_3424.PluginSqlColumnList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'plugin_sql_columns'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_sql_column_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'name'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'str'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.rest_7_3_314_3424.PluginSql(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'plugin_sql'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_sql'

str – Name of object in source file.

API_SIMPLE = {'result_count': (<class 'int'>,), 'rows_affected': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'columns': <class 'pytan3.api_objects.rest_7_3_314_3424.PluginSqlColumnList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'result_row'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of PluginSqlResultList

class pytan3.api_objects.rest_7_3_314_3424.PluginCommandList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'plugin_commands'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_command_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'command'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'str'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.rest_7_3_314_3424.UploadFileList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'upload_files'

str – Name of object used in API calls.

API_NAME_SRC = 'upload_file_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'upload_file'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of UploadFile

class pytan3.api_objects.rest_7_3_314_3424.PluginList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'plugins'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.rest_7_3_314_3424.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'plugin'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Plugin

class pytan3.api_objects.rest_7_3_314_3424.PluginScheduleList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'plugin_schedules'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_schedule_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.rest_7_3_314_3424.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'plugin_schedule'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of PluginSchedule

class pytan3.api_objects.rest_7_3_314_3424.ComputerSpecList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'computer_specs'

str – Name of object used in API calls.

API_NAME_SRC = 'computer_spec_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.rest_7_3_314_3424.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'computer_spec'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ComputerGroupSpec

class pytan3.api_objects.rest_7_3_314_3424.ComputerGroupList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'computer_groups'

str – Name of object used in API calls.

API_NAME_SRC = 'computer_group_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.rest_7_3_314_3424.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'computer_group'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ComputerGroup

class pytan3.api_objects.rest_7_3_314_3424.ImportConflictDetailList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'import_conflict_details'

str – Name of object used in API calls.

API_NAME_SRC = 'import_conflict_detail_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'import_conflict_detail'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ImportConflictDetail

class pytan3.api_objects.rest_7_3_314_3424.CacheFilterList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'cache_filters'

str – Name of object used in API calls.

API_NAME_SRC = 'cache_filter_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'filter'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of CacheFilter

class pytan3.api_objects.rest_7_3_314_3424.ImportConflictOptions(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'import_conflict_options'

str – Name of object used in API calls.

API_NAME_SRC = 'import_conflict_options'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'import_conflict_option'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'int'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.rest_7_3_314_3424.ContentSetList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'content_sets'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'content_set'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ContentSet

class pytan3.api_objects.rest_7_3_314_3424.ContentSetRolePrivilegeOnRoleList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'content_set_role_privilege_on_roles'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role_privilege_on_role_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'content_set_role_privilege'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ContentSetRolePrivilegeOnRole

class pytan3.api_objects.rest_7_3_314_3424.ContentSetRoleList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'content_set_roles'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'content_set_role'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ContentSetRole

class pytan3.api_objects.rest_7_3_314_3424.ContentSetRoleMembershipList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'content_set_role_memberships'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role_membership_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'content_set_role_membership'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ContentSetRoleMembership

class pytan3.api_objects.rest_7_3_314_3424.ContentSetUserGroupRoleMembershipList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'content_set_user_group_role_memberships'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_user_group_role_membership_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'content_set_user_group_role_membership'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ContentSetUserGroupRoleMembership

class pytan3.api_objects.rest_7_3_314_3424.ContentSetPrivilegeList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'content_set_privileges'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_privilege_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'content_set_privilege'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ContentSetPrivilege

class pytan3.api_objects.rest_7_3_314_3424.ContentSetRolePrivilegeList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'content_set_role_privileges'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role_privilege_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'content_set_role_privilege'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ContentSetRolePrivilege

class pytan3.api_objects.rest_7_3_314_3424.EffectiveContentSetPrivilegeRequest(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'effective_content_set_privilege_request'

str – Name of object used in API calls.

API_NAME_SRC = 'effective_content_set_privilege_request'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'user'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of User

class pytan3.api_objects.rest_7_3_314_3424.EffectiveContentSetPrivilegeList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'effective_content_set_privileges'

str – Name of object used in API calls.

API_NAME_SRC = 'effective_content_set_privilege_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'effective_content_set_privilege'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of EffectiveContentSetPrivilege

class pytan3.api_objects.rest_7_3_314_3424.DashboardList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'dashboards'

str – Name of object used in API calls.

API_NAME_SRC = 'dashboard_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'dashboard'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Dashboard

class pytan3.api_objects.rest_7_3_314_3424.UserGroupList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'user_groups'

str – Name of object used in API calls.

API_NAME_SRC = 'user_group_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'user_group'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of UserGroup

class pytan3.api_objects.rest_7_3_314_3424.SolutionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'solutions'

str – Name of object used in API calls.

API_NAME_SRC = 'solution_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'solution'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Solution

class pytan3.api_objects.rest_7_3_314_3424.ActionGroupList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'action_groups'

str – Name of object used in API calls.

API_NAME_SRC = 'action_group_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'action_group'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ActionGroup

class pytan3.api_objects.rest_7_3_314_3424.SavedQuestionQuestionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'saved_question_questions'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_question_question_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'saved_question_question'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SavedQuestionQuestion

class pytan3.api_objects.rest_7_3_314_3424.LdapSyncConnectorList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'ldap_sync_connectors'

str – Name of object used in API calls.

API_NAME_SRC = 'ldap_sync_connector_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'ldap_sync_connector'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of LdapSyncConnector

class pytan3.api_objects.rest_7_3_314_3424.ServerThrottleList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'server_throttles'

str – Name of object used in API calls.

API_NAME_SRC = 'server_throttle_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'server_throttle'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ServerThrottle

class pytan3.api_objects.rest_7_3_314_3424.SiteThrottleList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'site_throttles'

str – Name of object used in API calls.

API_NAME_SRC = 'site_throttle_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'site_throttle'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SiteThrottle

class pytan3.api_objects.rest_7_3_314_3424.SiteThrottleSubnetList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'site_throttle_subnets'

str – Name of object used in API calls.

API_NAME_SRC = 'site_throttle_subnet_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'subnet'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SiteThrottleSubnet

class pytan3.api_objects.rest_7_3_314_3424.ServerThrottleStatusList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'server_throttle_statuses'

str – Name of object used in API calls.

API_NAME_SRC = 'server_throttle_status_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'server_throttle_status'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ServerThrottleStatus

class pytan3.api_objects.rest_7_3_314_3424.SiteThrottleStatusList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'site_throttles_statuses'

str – Name of object used in API calls.

API_NAME_SRC = 'site_throttle_status_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'site_throttle_status'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SiteThrottleStatus

class pytan3.api_objects.rest_7_3_314_3424.SiteThrottleSubnetStatusList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'site_throttle_subnet_statuss'

str – Name of object used in API calls.

API_NAME_SRC = 'site_throttle_subnet_status_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'subnet'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SiteThrottleSubnetStatus

class pytan3.api_objects.rest_7_3_314_3424.ComputerIdList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'computer_ids'

str – Name of object used in API calls.

API_NAME_SRC = 'computer_id_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'id'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'int'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.rest_7_3_314_3424.HashedStringList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'hashed_strings'

str – Name of object used in API calls.

API_NAME_SRC = 'hashed_string_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'hashed_string'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of HashedString

pytan3.api_objects.rest_7_3_314_3424.BUILD_META = {'date': '2019-02-22 07:46:01.956314', 'script': 'build_objects_from_wsdl.py', 'script_platform': 'Darwin-18.2.0-x86_64-i386-64bit', 'script_python': '3.7.2 (default, Feb 20 2019, 14:09:01) ', 'script_version': '3.0.0', 'source_file': '/libraries/taniumjs/console.wsdl', 'source_file_date': '2019-02-22 07:29:24.898113'}

dict – How this module was built (date/time in UTC format).

pytan3.api_objects.rest_7_3_314_3424.COMMANDS = ['AddObject', 'GetObject', 'MoveObject', 'TransferObject', 'UpdateObject', 'DeleteObject', 'GetSavedQuestions', 'GetResultInfo', 'GetResultData', 'GetMergedResultData', 'UploadFile', 'RunPlugin', 'ExportObject', 'ImportObject', 'VerifySignature']

list of str – API commands.

pytan3.api_objects.rest_7_3_314_3424.VERSION = {'build': 3424, 'major': 7, 'minor': 3, 'protocol': 314, 'string': '7.3.314.3424'}

dict – Tanium API version these objects are intended to be used for.

REST API Object Module for Version 7.3.314.3641

Python objects for Tanium’s API.

pytan3.api_objects.rest_7_3_314_3641.float_types = (<class 'float'>,)

tuple of type – Float types.

pytan3.api_objects.rest_7_3_314_3641.integer_types = (<class 'int'>,)

tuple of type – Integer types.

pytan3.api_objects.rest_7_3_314_3641.string_types = (<class 'str'>,)

tuple of type – String types.

pytan3.api_objects.rest_7_3_314_3641.simple_types = (<class 'int'>, <class 'str'>, <class 'float'>)

tuple of type – All types that should be considered simple types.

pytan3.api_objects.rest_7_3_314_3641.TYPE = 'rest'

str – Type of API this module was built from.

pytan3.api_objects.rest_7_3_314_3641.API_DT = '%Y-%m-%dT%H:%M:%SZ'

str – Datetime format for this API type and version.

pytan3.api_objects.rest_7_3_314_3641.api_fixes()[source]

Fix incorrect attribute definitions on auto generated ApiModel classes.

pytan3.api_objects.rest_7_3_314_3641.expand_cls_globals()[source]

Replace str values with global vars for attrs on ApiModel classes.

Quite the funky chicken dance for solving issues with order of class definition.

pytan3.api_objects.rest_7_3_314_3641.expand_global(obj)[source]

Replace str values with global vars recursively.

Parameters:obj (str or dict or list) – Object to expand into global var.
Returns:String objects are the only ones that will be expanded.
Return type:str or dict or list or object
pytan3.api_objects.rest_7_3_314_3641.get_api_all_item()[source]

Get map of class name to class for all ApiItem subclasses.

Returns:dict
pytan3.api_objects.rest_7_3_314_3641.get_api_all_list()[source]

Get map of class name to class for all ApiList subclasses.

Returns:dict
pytan3.api_objects.rest_7_3_314_3641.get_api_all_model()[source]

Get map of class name to class for all ApiItem and ApiList subclasses.

Returns:dict
class pytan3.api_objects.rest_7_3_314_3641.ApiModel[source]

Bases: pytan3.api_models.ApiModel

Model for a complex item in the API.

class pytan3.api_objects.rest_7_3_314_3641.ApiItem(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiModel, pytan3.api_models.ApiItem

Model for a complex item in the API.

class pytan3.api_objects.rest_7_3_314_3641.ApiList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiModel, pytan3.api_models.ApiList

Model for an array in the API.

api_coerce_items_hook(attr, value, op)[source]

Check hook that allows subclasses to modify list items.

Parameters:
  • attr (str) – Attribute being set on this object.
  • value (ApiList or list or tuple) – The list object holding items.
  • op (str) – Operation being performed that called this method.

Notes

REST arrays can include a CacheInfo object in them. This checks to see if any item is a CacheInfo object, and if so:

  • “cache_info” gets added as a complex attr.
  • “cache_info” attribute is set to value of item.
  • item is not included in return list.
Returns:The list of items modified or as is.
Return type:list
class pytan3.api_objects.rest_7_3_314_3641.ResultInfoList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Manually defined API array object.

API_NAME = 'result_infos'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'max_available_age': (<class 'int'>,), 'now': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['now', 'max_available_age']

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'result_infos'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ResultInfo

__repr__()[source]

Make repr output be same as str output.

Returns:str
class pytan3.api_objects.rest_7_3_314_3641.ResultInfo(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Manually defined API object.

API_NAME = 'result_info'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'age': (<class 'int'>,), 'archived_question_id': (<class 'int'>,), 'error_count': (<class 'int'>,), 'estimated_total': (<class 'int'>,), 'expire_seconds': (<class 'int'>,), 'id': (<class 'int'>,), 'issue_seconds': (<class 'int'>,), 'mr_passed': (<class 'int'>,), 'mr_tested': (<class 'int'>,), 'no_results_count': (<class 'int'>,), 'passed': (<class 'int'>,), 'question_id': (<class 'int'>,), 'report_count': (<class 'int'>,), 'row_count': (<class 'int'>,), 'row_count_flag': (<class 'int'>,), 'row_count_machines': (<class 'int'>,), 'saved_question_id': (<class 'int'>,), 'seconds_since_issued': (<class 'int'>,), 'select_count': (<class 'int'>,), 'tested': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['question_id', 'estimated_total', 'row_count', 'mr_tested', 'mr_passed']

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ResultInfoList

API_LIST_API_NAME = 'result_infos'

str – Name of API_LIST_CLS used in API calls.

__repr__()[source]

Make repr output be same as str output.

Returns:str
class pytan3.api_objects.rest_7_3_314_3641.ResultSetList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Manually defined API array object.

API_NAME = 'result_sets'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'max_available_age': (<class 'int'>,), 'now': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['now', 'max_available_age']

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'result_sets'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ResultSet

class pytan3.api_objects.rest_7_3_314_3641.MergedResultSet(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Manually defined API object.

API_NAME = 'merged_result_set'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'max_available_age': (<class 'str'>,), 'now': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'result_infos': <class 'pytan3.api_objects.rest_7_3_314_3641.ResultInfoList'>, 'result_sets': <class 'pytan3.api_objects.rest_7_3_314_3641.ResultSetList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['now', 'max_available_age']

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.ResultSet(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Manually defined API object.

API_NAME = 'result_set'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'age': (<class 'int'>,), 'archived_question_id': (<class 'int'>,), 'cache_id': (<class 'int'>,), 'error_count': (<class 'int'>,), 'estimated_total': (<class 'int'>,), 'expiration': (<class 'int'>,), 'expire_seconds': (<class 'int'>,), 'filtered_row_count': (<class 'int'>,), 'filtered_row_count_machines': (<class 'int'>,), 'id': (<class 'int'>,), 'issue_seconds': (<class 'int'>,), 'item_count': (<class 'int'>,), 'mr_passed': (<class 'int'>,), 'mr_tested': (<class 'int'>,), 'no_results_count': (<class 'int'>,), 'passed': (<class 'int'>,), 'question_id': (<class 'int'>,), 'report_count': (<class 'int'>,), 'row_count': (<class 'int'>,), 'row_count_machines': (<class 'int'>,), 'saved_question_id': (<class 'int'>,), 'seconds_since_issued': (<class 'int'>,), 'select_count': (<class 'int'>,), 'tested': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'columns': <class 'pytan3.api_objects.rest_7_3_314_3641.ColumnList'>, 'rows': <class 'pytan3.api_objects.rest_7_3_314_3641.RowList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['question_id', 'estimated_total', 'mr_tested', 'mr_passed', 'row_count', 'columns']

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ResultSetList

API_LIST_API_NAME = 'result_sets'

str – Name of API_LIST_CLS used in API calls.

__init__(**kwargs)[source]

Constructor.

Notes

Sets Column.API_DATA_SET so column objects can access rows.

Sets RowColumn.API_COLUMN to the index correlated Column so row columns can access the column name, result type, etc.

Sets Column.API_IDX and RowColumn.API_IDX so column objects know what their index is without having to do lookups.

Parameters:**kwargs – Passed back to parent class.
class pytan3.api_objects.rest_7_3_314_3641.ColumnList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Manually defined API array object.

API_NAME = 'cs'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['names']

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'c'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Column

__repr__()[source]

Make repr output be same as str output.

Returns:str
names

Expose column names of all Column in this obj.

Returns:list of str
__getitem__(value)[source]

Support indexing of names.

Parameters:value (int or str) – If int: Index of item to retrieve from self. If str: Column name to index correlate from ColumnList.names
Returns:The RowColumn object at index value from names.
Return type:RowColumn
class pytan3.api_objects.rest_7_3_314_3641.Column(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Manually defined API object.

API_DATA_SET = None

ResultSet – Parent of this object, set by ResultSet.__init__().

API_IDX = None

int – Index of this object in ColumnList.

API_NAME = 'c'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'hash': (<class 'int'>,), 'name': (<class 'str'>,), 'type': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['name', 'result_type', 'hash']

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ColumnList

API_LIST_API_NAME = 'cs'

str – Name of API_LIST_CLS used in API calls.

result_type

Expose simple attr “rt” as result_type.

Notes

Will try to map str from “rt” as int to constants from Sensor.API_CONSTANTS.

Returns:str
get_values(attr='value', join=None)[source]

Get values of this column from all rows.

Parameters:
  • attr (str, optional) –

    Attribute to get values of.

    Defaults to: “value”.

  • join (str, optional) –

    String to join multi value columns.

    Defaults to: None.
Returns:

list of str
class pytan3.api_objects.rest_7_3_314_3641.RowList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Manually defined API array object.

API_NAME = 'rs'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'r'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Row

__repr__()[source]

Make repr output be same as str output.

Returns:str
class pytan3.api_objects.rest_7_3_314_3641.Row(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Manually defined API object.

API_NAME = 'r'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'cid': (<class 'int'>,), 'id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'data': <class 'pytan3.api_objects.rest_7_3_314_3641.RowColumnList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['id', 'cid', 'columns']

list or str – Attributes to add to str formatting.

API_LIST_API_NAME = 'rs'

str – Name of API_LIST_CLS used in API calls.

API_LIST_CLS

ApiItem: Item class this list class holds.

alias of RowList

__repr__()[source]

Make repr output be same as str output.

Returns:str
__getitem__(value)[source]

Support indexing of columns.

Parameters:value (int or str) – If int: Index of item to retrieve from columns. If str: Column name to index correlate from ColumnList.names
Returns:The RowColumn object at index value from columns.
Return type:RowColumn
names

Return the names of each row column from RowColumn.API_COLUMN.

Returns:list of str
columns

Expose complex attr “data” as “columns”.

Returns:RowColumnList
__len__()[source]

Expose length of columns.

Returns:int
get_values(meta=False, hashes=False, join=None)[source]

Get all values from all columns in this row.

Parameters:
  • meta (bool, optional) –

    Include sensor hash and result type for each column.

    Defaults to: False.

  • hashes (bool, optional) –

    Include hashes of values.

    Defaults to: False.

  • join (str, optional) –

    String to join multi value columns.

    Defaults to: None.
Returns:

dict
class pytan3.api_objects.rest_7_3_314_3641.RowColumnList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Manually defined API array object.

API_NAME = 'rc'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'row_columns'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of RowColumn

class pytan3.api_objects.rest_7_3_314_3641.RowColumn(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Manually defined API array object.

API_COLUMN = None

Column – Index correlated column, set by ResultSet.__init__().

API_IDX = None

int – Index of this object in RowColumnList.

API_NAME = 'row_column'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['name', 'hash', 'result_type']

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'v'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of RowValue

name

Expose column name from API_COLUMN.

Returns:str
result_type

Expose column result type from API_COLUMN.

Returns:str
hash

Expose column sensor hash from API_COLUMN.

Returns:str
get_values(attr='value', join=None)[source]

Get all values from this row column.

Parameters:
  • attr (str, optional) –

    Attribute to get values of.

    Defaults to: “value”.

  • join (str, optional) –

    String to join multi value columns.

    Defaults to: None.
Returns:

list or str
class pytan3.api_objects.rest_7_3_314_3641.RowValue(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Manually defined API object.

API_NAME = 'v'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'hash': (<class 'int'>,), 'text': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['hash', 'value']

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of RowColumn

API_LIST_API_NAME = 'row_column'

str – Name of API_LIST_CLS used in API calls.

value

Expose simple attr “text” as value.

Returns:str
class pytan3.api_objects.rest_7_3_314_3641.ParseQuestionResultList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Manually defined API array object.

API_NAME = 'parse_question_results'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'parse_question_result'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ParseQuestionResult

class pytan3.api_objects.rest_7_3_314_3641.ParseQuestionResult(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Manually defined API object.

API_NAME = 'parse_question_result'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'force_computer_id_flag': (<class 'int'>,), 'from_canonical_text': (<class 'int'>,), 'question_text': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'selects': <class 'pytan3.api_objects.rest_7_3_314_3641.SelectList'>, 'sensor_references': <class 'pytan3.api_objects.rest_7_3_314_3641.SensorReferenceList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['hash', 'text']

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ParseQuestionResultList

API_LIST_API_NAME = 'questions'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.SensorQuery(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'sensor_query'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_query'

str – Name of object in source file.

API_SIMPLE = {'platform': (<class 'str'>,), 'script': (<class 'str'>,), 'script_type': (<class 'str'>,), 'signature': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SensorQueryList

API_LIST_API_NAME = 'sensor_querys'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.SensorSubcolumn(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'sensor_subcolumn'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_subcolumn'

str – Name of object in source file.

API_SIMPLE = {'exclude_from_parse_flag': (<class 'int'>,), 'hidden_flag': (<class 'int'>,), 'ignore_case_flag': (<class 'int'>,), 'index': (<class 'int'>,), 'name': (<class 'str'>,), 'value_type': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SensorSubcolumnList

API_LIST_API_NAME = 'sensor_subcolumns'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.SensorStat(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'sensor_stat'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_stat'

str – Name of object in source file.

API_SIMPLE = {'count': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'other_bytes_avg': (<class 'float'>,), 'other_bytes_std': (<class 'float'>,), 'read_bytes_avg': (<class 'float'>,), 'read_bytes_std': (<class 'float'>,), 'real_ms_avg': (<class 'float'>,), 'real_ms_max': (<class 'float'>,), 'real_ms_min': (<class 'float'>,), 'real_ms_std': (<class 'float'>,), 'sys_ms_avg': (<class 'float'>,), 'sys_ms_std': (<class 'float'>,), 'user_ms_avg': (<class 'float'>,), 'user_ms_std': (<class 'float'>,), 'what_hash': (<class 'int'>,), 'write_bytes_avg': (<class 'float'>,), 'write_bytes_std': (<class 'float'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SensorStatList

API_LIST_API_NAME = 'sensor_stats'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.SavedActionPolicy(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'saved_action_policy'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_action_policy'

str – Name of object in source file.

API_SIMPLE = {'max_age': (<class 'int'>,), 'min_count': (<class 'int'>,), 'row_filter_group_id': (<class 'int'>,), 'saved_question_group_id': (<class 'int'>,), 'saved_question_id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'row_filter_group': <class 'pytan3.api_objects.rest_7_3_314_3641.Group'>, 'saved_question_group': <class 'pytan3.api_objects.rest_7_3_314_3641.Group'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.SavedActionApproval(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'saved_action_approval'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_action_approval'

str – Name of object in source file.

API_SIMPLE = {'approved_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'owner_user_id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'metadata': <class 'pytan3.api_objects.rest_7_3_314_3641.MetadataList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SavedActionApprovalList

API_LIST_API_NAME = 'saved_action_approvals'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.SavedAction(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'saved_action'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_action'

str – Name of object in source file.

API_SIMPLE = {'action_group_id': (<class 'int'>,), 'approved_flag': (<class 'int'>,), 'cache_row_id': (<class 'int'>,), 'comment': (<class 'str'>,), 'creation_time': (<class 'str'>,), 'distribute_seconds': (<class 'int'>,), 'end_time': (<class 'str'>,), 'expire_seconds': (<class 'int'>,), 'id': (<class 'int'>,), 'issue_count': (<class 'int'>,), 'issue_seconds': (<class 'int'>,), 'last_start_time': (<class 'str'>,), 'name': (<class 'str'>,), 'next_start_time': (<class 'str'>,), 'policy_flag': (<class 'int'>,), 'public_flag': (<class 'int'>,), 'start_time': (<class 'str'>,), 'status': (<class 'int'>,), 'user_start_time': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'action_group': <class 'pytan3.api_objects.rest_7_3_314_3641.Group'>, 'approver': <class 'pytan3.api_objects.rest_7_3_314_3641.User'>, 'last_action': <class 'pytan3.api_objects.rest_7_3_314_3641.Action'>, 'metadata': <class 'pytan3.api_objects.rest_7_3_314_3641.MetadataList'>, 'package_spec': <class 'pytan3.api_objects.rest_7_3_314_3641.PackageSpec'>, 'policy': <class 'pytan3.api_objects.rest_7_3_314_3641.SavedActionPolicy'>, 'row_ids': <class 'pytan3.api_objects.rest_7_3_314_3641.SavedActionRowIdList'>, 'target_group': <class 'pytan3.api_objects.rest_7_3_314_3641.Group'>, 'user': <class 'pytan3.api_objects.rest_7_3_314_3641.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SavedActionList

API_LIST_API_NAME = 'saved_actions'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.Sensor(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'sensor'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor'

str – Name of object in source file.

API_SIMPLE = {'cache_row_id': (<class 'int'>,), 'category': (<class 'str'>,), 'creation_time': (<class 'str'>,), 'deleted_flag': (<class 'int'>,), 'delimiter': (<class 'str'>,), 'description': (<class 'str'>,), 'exclude_from_parse_flag': (<class 'int'>,), 'hash': (<class 'int'>,), 'hidden_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'ignore_case_flag': (<class 'int'>,), 'keep_duplicates_flag': (<class 'int'>,), 'last_modified_by': (<class 'str'>,), 'max_age_seconds': (<class 'int'>,), 'modification_time': (<class 'str'>,), 'name': (<class 'str'>,), 'parameter_definition': (<class 'str'>,), 'preview_sensor_flag': (<class 'int'>,), 'source_hash': (<class 'int'>,), 'source_id': (<class 'int'>,), 'source_name': (<class 'str'>,), 'string_count': (<class 'int'>,), 'value_type': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set': <class 'pytan3.api_objects.rest_7_3_314_3641.IdReference'>, 'metadata': <class 'pytan3.api_objects.rest_7_3_314_3641.MetadataList'>, 'mod_user': <class 'pytan3.api_objects.rest_7_3_314_3641.User'>, 'parameters': <class 'pytan3.api_objects.rest_7_3_314_3641.ParameterList'>, 'queries': <class 'pytan3.api_objects.rest_7_3_314_3641.SensorQueryList'>, 'string_hints': <class 'pytan3.api_objects.rest_7_3_314_3641.StringHintList'>, 'subcolumns': <class 'pytan3.api_objects.rest_7_3_314_3641.SensorSubcolumnList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {'BES_DATETIME_RESULT': 4, 'BES_SENSOR': 2, 'DATASIZE_RESULT': 8, 'HASH_RESULT': 0, 'IP_RESULT': 5, 'JS_SENSOR': 7, 'MULTITYPE_SENSOR': 6, 'NUMERIC_INTEGER_RESULT': 9, 'NUMERIC_RESULT': 3, 'PSHELL_SENSOR': 5, 'PY_SENSOR': 8, 'REGEX_RESULT': 11, 'TEXT_RESULT': 1, 'TIMEDIFF_REUSLT': 7, 'VBS_SENSOR': 4, 'VERSION_RESULT': 2, 'WMI_DATETIME_RESULT': 6, 'WMI_SENSOR': 1}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SensorList

API_LIST_API_NAME = 'sensors'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.AuditData(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'audit_data'

str – Name of object used in API calls.

API_NAME_SRC = 'audit_data'

str – Name of object in source file.

API_SIMPLE = {'cache_row_id': (<class 'int'>,), 'creation_time': (<class 'str'>,), 'details': (<class 'str'>,), 'last_modified_by': (<class 'str'>,), 'modification_time': (<class 'str'>,), 'modifier_user_id': (<class 'int'>,), 'object_id': (<class 'int'>,), 'type': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'mod_user': <class 'pytan3.api_objects.rest_7_3_314_3641.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of AuditDataList

API_LIST_API_NAME = 'audit_datas'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.AuditLog(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'audit_log'

str – Name of object used in API calls.

API_NAME_SRC = 'audit_log'

str – Name of object in source file.

API_SIMPLE = {'creation_time': (<class 'str'>,), 'details': (<class 'str'>,), 'end_time': (<class 'str'>,), 'id': (<class 'int'>,), 'last_modified_by': (<class 'str'>,), 'modification_time': (<class 'str'>,), 'modifier_user_id': (<class 'int'>,), 'object_id': (<class 'int'>,), 'start_time': (<class 'str'>,), 'type': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.rest_7_3_314_3641.CacheInfo'>, 'entries': <class 'pytan3.api_objects.rest_7_3_314_3641.AuditDataList'>, 'mod_user': <class 'pytan3.api_objects.rest_7_3_314_3641.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of AuditLogList

API_LIST_API_NAME = 'audit_logs'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.Server(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'server'

str – Name of object used in API calls.

API_NAME_SRC = 'server'

str – Name of object in source file.

API_SIMPLE = {'heart_beat': (<class 'str'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ServerList

API_LIST_API_NAME = 'servers'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.MetadataItem(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'metadata_item'

str – Name of object used in API calls.

API_NAME_SRC = 'metadata_item'

str – Name of object in source file.

API_SIMPLE = {'admin_flag': (<class 'int'>,), 'name': (<class 'str'>,), 'value': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of MetadataList

API_LIST_API_NAME = 'metadatas'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.Filter(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'filter'

str – Name of object used in API calls.

API_NAME_SRC = 'filter'

str – Name of object in source file.

API_SIMPLE = {'aggregation': (<class 'str'>,), 'all_times_flag': (<class 'int'>,), 'all_values_flag': (<class 'int'>,), 'delimiter': (<class 'str'>,), 'delimiter_index': (<class 'int'>,), 'end_time': (<class 'str'>,), 'id': (<class 'int'>,), 'ignore_case_flag': (<class 'int'>,), 'max_age_seconds': (<class 'int'>,), 'not_flag': (<class 'int'>,), 'operator': (<class 'str'>,), 'start_time': (<class 'str'>,), 'substring_flag': (<class 'int'>,), 'substring_length': (<class 'int'>,), 'substring_start': (<class 'int'>,), 'utf8_flag': (<class 'int'>,), 'value': (<class 'str'>,), 'value_type': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'sensor': <class 'pytan3.api_objects.rest_7_3_314_3641.Sensor'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of FilterList

API_LIST_API_NAME = 'filters'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.IdReference(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'id_reference'

str – Name of object used in API calls.

API_NAME_SRC = 'id_reference'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,), 'name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.Group(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'group'

str – Name of object used in API calls.

API_NAME_SRC = 'group'

str – Name of object in source file.

API_SIMPLE = {'and_flag': (<class 'int'>,), 'deleted_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'not_flag': (<class 'int'>,), 'saved_question_id': (<class 'int'>,), 'source_id': (<class 'int'>,), 'text': (<class 'str'>,), 'track_computer_id_flag': (<class 'int'>,), 'track_computer_id_interval': (<class 'int'>,), 'type': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'filters': <class 'pytan3.api_objects.rest_7_3_314_3641.FilterList'>, 'parameters': <class 'pytan3.api_objects.rest_7_3_314_3641.ParameterList'>, 'sub_groups': <class 'pytan3.api_objects.rest_7_3_314_3641.GroupList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of GroupList

API_LIST_API_NAME = 'groups'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.Select(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'select'

str – Name of object used in API calls.

API_NAME_SRC = 'select'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'filter': <class 'pytan3.api_objects.rest_7_3_314_3641.Filter'>, 'group': <class 'pytan3.api_objects.rest_7_3_314_3641.Group'>, 'sensor': <class 'pytan3.api_objects.rest_7_3_314_3641.Sensor'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SelectList

API_LIST_API_NAME = 'selects'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.XmlError(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'xml_error'

str – Name of object used in API calls.

API_NAME_SRC = 'xml_error'

str – Name of object in source file.

API_SIMPLE = {'error_context': (<class 'str'>,), 'exception': (<class 'str'>,), 'type': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ErrorList

API_LIST_API_NAME = 'errors'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.CacheInfo(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'cache_info'

str – Name of object used in API calls.

API_NAME_SRC = 'cache_info'

str – Name of object in source file.

API_SIMPLE = {'cache_id': (<class 'int'>,), 'cache_row_count': (<class 'int'>,), 'expiration': (<class 'str'>,), 'filtered_row_count': (<class 'int'>,), 'page_row_count': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'errors': <class 'pytan3.api_objects.rest_7_3_314_3641.ErrorList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.QuestionListInfo(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'question_list_info'

str – Name of object used in API calls.

API_NAME_SRC = 'question_list_info'

str – Name of object in source file.

API_SIMPLE = {'highest_id': (<class 'int'>,), 'total_count': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.Question(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'question'

str – Name of object used in API calls.

API_NAME_SRC = 'question'

str – Name of object in source file.

API_SIMPLE = {'action_tracking_flag': (<class 'int'>,), 'cache_row_id': (<class 'int'>,), 'expiration': (<class 'str'>,), 'expire_seconds': (<class 'int'>,), 'force_computer_id_flag': (<class 'int'>,), 'from_canonical_text': (<class 'int'>,), 'hidden_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'index': (<class 'int'>,), 'is_expired': (<class 'int'>,), 'name': (<class 'str'>,), 'query_text': (<class 'str'>,), 'skip_lock_flag': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'context_group': <class 'pytan3.api_objects.rest_7_3_314_3641.Group'>, 'group': <class 'pytan3.api_objects.rest_7_3_314_3641.Group'>, 'management_rights_group': <class 'pytan3.api_objects.rest_7_3_314_3641.Group'>, 'saved_question': <class 'pytan3.api_objects.rest_7_3_314_3641.SavedQuestion'>, 'selects': <class 'pytan3.api_objects.rest_7_3_314_3641.SelectList'>, 'user': <class 'pytan3.api_objects.rest_7_3_314_3641.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of QuestionList

API_LIST_API_NAME = 'questions'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.PackageFileTemplate(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'package_file_template'

str – Name of object used in API calls.

API_NAME_SRC = 'package_file_template'

str – Name of object in source file.

API_SIMPLE = {'download_seconds': (<class 'int'>,), 'hash': (<class 'str'>,), 'name': (<class 'str'>,), 'source': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of PackageFileTemplateList

API_LIST_API_NAME = 'package_file_templates'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.PackageFileStatus(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'package_file_status'

str – Name of object used in API calls.

API_NAME_SRC = 'package_file_status'

str – Name of object in source file.

API_SIMPLE = {'bytes_downloaded': (<class 'int'>,), 'bytes_total': (<class 'int'>,), 'cache_message': (<class 'str'>,), 'cache_status': (<class 'str'>,), 'download_start_time': (<class 'str'>,), 'last_download_progress_time': (<class 'str'>,), 'server_id': (<class 'int'>,), 'server_name': (<class 'str'>,), 'status': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of PackageFileStatusList

API_LIST_API_NAME = 'package_file_statuss'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.PackageFile(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'package_file'

str – Name of object used in API calls.

API_NAME_SRC = 'package_file'

str – Name of object in source file.

API_SIMPLE = {'bytes_downloaded': (<class 'int'>,), 'bytes_total': (<class 'int'>,), 'cache_status': (<class 'str'>,), 'deleted_flag': (<class 'int'>,), 'download_seconds': (<class 'int'>,), 'download_start_time': (<class 'str'>,), 'hash': (<class 'str'>,), 'id': (<class 'int'>,), 'last_download_progress_time': (<class 'str'>,), 'name': (<class 'str'>,), 'size': (<class 'int'>,), 'source': (<class 'str'>,), 'status': (<class 'int'>,), 'trigger_download': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'file_status': <class 'pytan3.api_objects.rest_7_3_314_3641.PackageFileStatusList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of PackageFileList

API_LIST_API_NAME = 'package_files'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.PackageSpec(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'package_spec'

str – Name of object used in API calls.

API_NAME_SRC = 'package_spec'

str – Name of object in source file.

API_SIMPLE = {'available_time': (<class 'str'>,), 'cache_row_id': (<class 'int'>,), 'command': (<class 'str'>,), 'command_timeout': (<class 'int'>,), 'creation_time': (<class 'str'>,), 'deleted_flag': (<class 'int'>,), 'display_name': (<class 'str'>,), 'expire_seconds': (<class 'int'>,), 'hidden_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'last_modified_by': (<class 'str'>,), 'last_update': (<class 'str'>,), 'modification_time': (<class 'str'>,), 'name': (<class 'str'>,), 'parameter_definition': (<class 'str'>,), 'process_group_flag': (<class 'int'>,), 'signature': (<class 'str'>,), 'skip_lock_flag': (<class 'int'>,), 'source_hash': (<class 'str'>,), 'source_hash_changed_flag': (<class 'int'>,), 'source_id': (<class 'int'>,), 'source_name': (<class 'str'>,), 'verify_expire_seconds': (<class 'int'>,), 'verify_group_id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set': <class 'pytan3.api_objects.rest_7_3_314_3641.IdReference'>, 'file_templates': <class 'pytan3.api_objects.rest_7_3_314_3641.PackageFileTemplateList'>, 'files': <class 'pytan3.api_objects.rest_7_3_314_3641.PackageFileList'>, 'metadata': <class 'pytan3.api_objects.rest_7_3_314_3641.MetadataList'>, 'mod_user': <class 'pytan3.api_objects.rest_7_3_314_3641.User'>, 'parameters': <class 'pytan3.api_objects.rest_7_3_314_3641.ParameterList'>, 'sensors': <class 'pytan3.api_objects.rest_7_3_314_3641.SensorList'>, 'verify_group': <class 'pytan3.api_objects.rest_7_3_314_3641.Group'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of PackageSpecList

API_LIST_API_NAME = 'package_specs'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.ClientStatus(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'client_status'

str – Name of object used in API calls.

API_NAME_SRC = 'client_status'

str – Name of object in source file.

API_SIMPLE = {'cache_row_id': (<class 'int'>,), 'computer_id': (<class 'str'>,), 'full_version': (<class 'str'>,), 'host_name': (<class 'str'>,), 'ipaddress_client': (<class 'str'>,), 'ipaddress_server': (<class 'str'>,), 'last_registration': (<class 'str'>,), 'port_number': (<class 'int'>,), 'protocol_version': (<class 'int'>,), 'public_key_valid': (<class 'int'>,), 'receive_state': (<class 'str'>,), 'registered_with_tls': (<class 'int'>,), 'send_state': (<class 'str'>,), 'status': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SystemStatusList

API_LIST_API_NAME = 'system_status'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.SystemSetting(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'system_setting'

str – Name of object used in API calls.

API_NAME_SRC = 'system_setting'

str – Name of object in source file.

API_SIMPLE = {'cache_row_id': (<class 'int'>,), 'default_value': (<class 'str'>,), 'hidden_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'read_only_flag': (<class 'int'>,), 'setting_type': (<class 'str'>,), 'value': (<class 'str'>,), 'value_type': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'audit_data': <class 'pytan3.api_objects.rest_7_3_314_3641.AuditData'>, 'metadata': <class 'pytan3.api_objects.rest_7_3_314_3641.MetadataList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SystemSettingList

API_LIST_API_NAME = 'system_settings'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.SoapError(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'soap_error'

str – Name of object used in API calls.

API_NAME_SRC = 'soap_error'

str – Name of object in source file.

API_SIMPLE = {'context': (<class 'str'>,), 'exception_name': (<class 'str'>,), 'object_name': (<class 'str'>,), 'object_request': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.WhiteListedUrl(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'white_listed_url'

str – Name of object used in API calls.

API_NAME_SRC = 'white_listed_url'

str – Name of object in source file.

API_SIMPLE = {'chunk_id': (<class 'str'>,), 'download_seconds': (<class 'int'>,), 'expire_seconds': (<class 'int'>,), 'id': (<class 'int'>,), 'url_regex': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'metadata': <class 'pytan3.api_objects.rest_7_3_314_3641.MetadataList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of WhiteListedUrlList

API_LIST_API_NAME = 'white_listed_urls'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.VersionAggregate(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'version_aggregate'

str – Name of object used in API calls.

API_NAME_SRC = 'version_aggregate'

str – Name of object in source file.

API_SIMPLE = {'count': (<class 'int'>,), 'filtered': (<class 'int'>,), 'version_string': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of VersionAggregateList

API_LIST_API_NAME = 'version_aggregates'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.SystemStatusAggregate(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'system_status_aggregate'

str – Name of object used in API calls.

API_NAME_SRC = 'system_status_aggregate'

str – Name of object in source file.

API_SIMPLE = {'blocked_count': (<class 'int'>,), 'leader_count': (<class 'int'>,), 'normal_count': (<class 'int'>,), 'receive_backward_count': (<class 'int'>,), 'receive_forward_count': (<class 'int'>,), 'receive_none_count': (<class 'int'>,), 'receive_ok_count': (<class 'int'>,), 'registered_with_tls_count': (<class 'int'>,), 'send_backward_count': (<class 'int'>,), 'send_forward_count': (<class 'int'>,), 'send_none_count': (<class 'int'>,), 'send_ok_count': (<class 'int'>,), 'slowlink_count': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'versions': <class 'pytan3.api_objects.rest_7_3_314_3641.VersionAggregateList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.UserRole(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'user_role'

str – Name of object used in API calls.

API_NAME_SRC = 'user_role'

str – Name of object in source file.

API_SIMPLE = {'description': (<class 'str'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'permissions': <class 'pytan3.api_objects.rest_7_3_314_3641.PermissionList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of UserRoleList

API_LIST_API_NAME = 'roles'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.UserOwnedObjectIds(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'user_owned_object_ids'

str – Name of object used in API calls.

API_NAME_SRC = 'user_owned_object_ids'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'plugin_schedules': <class 'pytan3.api_objects.rest_7_3_314_3641.PluginScheduleList'>, 'saved_actions': <class 'pytan3.api_objects.rest_7_3_314_3641.SavedActionList'>, 'saved_questions': <class 'pytan3.api_objects.rest_7_3_314_3641.SavedQuestionList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.User(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'user'

str – Name of object used in API calls.

API_NAME_SRC = 'user'

str – Name of object in source file.

API_SIMPLE = {'active_session_count': (<class 'int'>,), 'deleted_flag': (<class 'int'>,), 'display_name': (<class 'str'>,), 'domain': (<class 'str'>,), 'effective_group_id': (<class 'int'>,), 'external_flag': (<class 'int'>,), 'group_id': (<class 'int'>,), 'id': (<class 'int'>,), 'last_login': (<class 'str'>,), 'local_admin_flag': (<class 'int'>,), 'locked_out': (<class 'int'>,), 'name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set_roles': <class 'pytan3.api_objects.rest_7_3_314_3641.ContentSetRoleList'>, 'effective_content_set_privileges': <class 'pytan3.api_objects.rest_7_3_314_3641.EffectiveContentSetPrivilegeList'>, 'metadata': <class 'pytan3.api_objects.rest_7_3_314_3641.MetadataList'>, 'owned_object_ids': <class 'pytan3.api_objects.rest_7_3_314_3641.UserOwnedObjectIds'>, 'permissions': <class 'pytan3.api_objects.rest_7_3_314_3641.PermissionList'>, 'roles': <class 'pytan3.api_objects.rest_7_3_314_3641.UserRoleList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of UserList

API_LIST_API_NAME = 'users'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.ActionListInfo(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'action_list_info'

str – Name of object used in API calls.

API_NAME_SRC = 'action_list_info'

str – Name of object in source file.

API_SIMPLE = {'highest_id': (<class 'int'>,), 'total_count': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.Action(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'action'

str – Name of object used in API calls.

API_NAME_SRC = 'action'

str – Name of object in source file.

API_SIMPLE = {'cache_row_id': (<class 'int'>,), 'comment': (<class 'str'>,), 'creation_time': (<class 'str'>,), 'distribute_seconds': (<class 'int'>,), 'expiration_time': (<class 'str'>,), 'expire_seconds': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'skip_lock_flag': (<class 'int'>,), 'start_time': (<class 'str'>,), 'status': (<class 'str'>,), 'stopped_flag': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'action_group': <class 'pytan3.api_objects.rest_7_3_314_3641.Group'>, 'approver': <class 'pytan3.api_objects.rest_7_3_314_3641.User'>, 'history_saved_question': <class 'pytan3.api_objects.rest_7_3_314_3641.SavedQuestion'>, 'metadata': <class 'pytan3.api_objects.rest_7_3_314_3641.MetadataList'>, 'package_spec': <class 'pytan3.api_objects.rest_7_3_314_3641.PackageSpec'>, 'saved_action': <class 'pytan3.api_objects.rest_7_3_314_3641.SavedAction'>, 'target_group': <class 'pytan3.api_objects.rest_7_3_314_3641.Group'>, 'user': <class 'pytan3.api_objects.rest_7_3_314_3641.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ActionList

API_LIST_API_NAME = 'actions'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.ActionStop(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'action_stop'

str – Name of object used in API calls.

API_NAME_SRC = 'action_stop'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'action': <class 'pytan3.api_objects.rest_7_3_314_3641.Action'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ActionStopList

API_LIST_API_NAME = 'action_stops'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.ArchivedQuestion(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'archived_question'

str – Name of object used in API calls.

API_NAME_SRC = 'archived_question'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ArchivedQuestionList

API_LIST_API_NAME = 'archived_questions'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.SavedQuestion(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'saved_question'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_question'

str – Name of object in source file.

API_SIMPLE = {'action_tracking_flag': (<class 'int'>,), 'archive_enabled_flag': (<class 'int'>,), 'cache_row_id': (<class 'int'>,), 'deleted_flag': (<class 'int'>,), 'expire_seconds': (<class 'int'>,), 'hidden_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'index': (<class 'int'>,), 'issue_seconds': (<class 'int'>,), 'issue_seconds_never_flag': (<class 'int'>,), 'keep_seconds': (<class 'int'>,), 'mod_time': (<class 'str'>,), 'most_recent_question_id': (<class 'int'>,), 'name': (<class 'str'>,), 'public_flag': (<class 'int'>,), 'query_text': (<class 'str'>,), 'row_count_flag': (<class 'int'>,), 'seeding_question_ids': (<class 'str'>,), 'skip_schedule_on_update_flag': (<class 'int'>,), 'sort_column': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'archive_owner': <class 'pytan3.api_objects.rest_7_3_314_3641.User'>, 'content_set': <class 'pytan3.api_objects.rest_7_3_314_3641.IdReference'>, 'metadata': <class 'pytan3.api_objects.rest_7_3_314_3641.MetadataList'>, 'mod_user': <class 'pytan3.api_objects.rest_7_3_314_3641.User'>, 'packages': <class 'pytan3.api_objects.rest_7_3_314_3641.PackageSpecList'>, 'question': <class 'pytan3.api_objects.rest_7_3_314_3641.Question'>, 'user': <class 'pytan3.api_objects.rest_7_3_314_3641.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SavedQuestionList

API_LIST_API_NAME = 'saved_questions'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.ParseJob(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'parse_job'

str – Name of object used in API calls.

API_NAME_SRC = 'parse_job'

str – Name of object in source file.

API_SIMPLE = {'parser_version': (<class 'int'>,), 'question_text': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ParseJobList

API_LIST_API_NAME = 'parse_jobs'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.Parameter(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'parameter'

str – Name of object used in API calls.

API_NAME_SRC = 'parameter'

str – Name of object in source file.

API_SIMPLE = {'key': (<class 'str'>,), 'type': (<class 'int'>,), 'value': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ParameterList

API_LIST_API_NAME = 'parameters'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.ParseResult(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'parse_result'

str – Name of object used in API calls.

API_NAME_SRC = 'parse_result'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,), 'parameter_definition': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'parameters': <class 'pytan3.api_objects.rest_7_3_314_3641.ParameterList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ParseResultList

API_LIST_API_NAME = 'parse_results'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.SensorReference(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'sensor_reference'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_reference'

str – Name of object in source file.

API_SIMPLE = {'name': (<class 'str'>,), 'real_ms_avg': (<class 'int'>,), 'start_char': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SensorReferenceList

API_LIST_API_NAME = 'sensor_references'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.ParseResultGroup(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'parse_result_group'

str – Name of object used in API calls.

API_NAME_SRC = 'parse_result_group'

str – Name of object in source file.

API_SIMPLE = {'question_text': (<class 'str'>,), 'score': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'parameter_values': <class 'pytan3.api_objects.rest_7_3_314_3641.ParameterValueList'>, 'parse_results': <class 'pytan3.api_objects.rest_7_3_314_3641.ParseResultList'>, 'question': <class 'pytan3.api_objects.rest_7_3_314_3641.Question'>, 'question_group_sensors': <class 'pytan3.api_objects.rest_7_3_314_3641.SensorList'>, 'sensor_references': <class 'pytan3.api_objects.rest_7_3_314_3641.SensorReferenceList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ParseResultGroupList

API_LIST_API_NAME = 'parse_result_groups'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.ClientCount(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'client_count'

str – Name of object used in API calls.

API_NAME_SRC = 'client_count'

str – Name of object in source file.

API_SIMPLE = {'count': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.PluginArgument(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'plugin_argument'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_argument'

str – Name of object in source file.

API_SIMPLE = {'name': (<class 'str'>,), 'type': (<class 'str'>,), 'value': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of PluginArgumentList

API_LIST_API_NAME = 'plugin_arguments'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.UploadFile(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'upload_file'

str – Name of object used in API calls.

API_NAME_SRC = 'upload_file'

str – Name of object in source file.

API_SIMPLE = {'bytes': (<class 'str'>,), 'destination_file': (<class 'str'>,), 'file_cached': (<class 'int'>,), 'file_size': (<class 'int'>,), 'force_overwrite': (<class 'int'>,), 'hash': (<class 'str'>,), 'id': (<class 'int'>,), 'key': (<class 'str'>,), 'part_size': (<class 'int'>,), 'percent_complete': (<class 'int'>,), 'start_pos': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of UploadFileList

API_LIST_API_NAME = 'upload_files'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.UploadFileStatus(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'upload_file_status'

str – Name of object used in API calls.

API_NAME_SRC = 'upload_file_status'

str – Name of object in source file.

API_SIMPLE = {'file_cached': (<class 'int'>,), 'hash': (<class 'str'>,), 'percent_complete': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'file_parts': <class 'pytan3.api_objects.rest_7_3_314_3641.UploadFileList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.Plugin(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'plugin'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin'

str – Name of object in source file.

API_SIMPLE = {'allow_rest': (<class 'int'>,), 'bundle': (<class 'str'>,), 'cache_row_id': (<class 'int'>,), 'execution_id': (<class 'int'>,), 'exit_code': (<class 'int'>,), 'filename': (<class 'str'>,), 'input': (<class 'str'>,), 'local_admin_flag': (<class 'int'>,), 'name': (<class 'str'>,), 'path': (<class 'str'>,), 'plugin_server': (<class 'str'>,), 'plugin_url': (<class 'str'>,), 'raw_http_request': (<class 'int'>,), 'raw_http_response': (<class 'int'>,), 'run_detached_flag': (<class 'int'>,), 'script_response': (<class 'str'>,), 'status': (<class 'str'>,), 'status_file_content': (<class 'str'>,), 'timeout_seconds': (<class 'int'>,), 'type': (<class 'str'>,), 'use_json_flag': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'arguments': <class 'pytan3.api_objects.rest_7_3_314_3641.PluginArgumentList'>, 'commands': <class 'pytan3.api_objects.rest_7_3_314_3641.PluginCommandList'>, 'content_set': <class 'pytan3.api_objects.rest_7_3_314_3641.ContentSet'>, 'metadata': <class 'pytan3.api_objects.rest_7_3_314_3641.MetadataList'>, 'permissions': <class 'pytan3.api_objects.rest_7_3_314_3641.PermissionList'>, 'sql_response': <class 'pytan3.api_objects.rest_7_3_314_3641.PluginSql'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {'SCRIPT': 'Script', 'SQL': 'SQL'}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of PluginList

API_LIST_API_NAME = 'plugins'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.PluginSchedule(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'plugin_schedule'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_schedule'

str – Name of object in source file.

API_SIMPLE = {'deleted_flag': (<class 'int'>,), 'enabled': (<class 'int'>,), 'end_date': (<class 'str'>,), 'end_hour': (<class 'int'>,), 'id': (<class 'int'>,), 'input': (<class 'str'>,), 'last_exit_code': (<class 'int'>,), 'last_run_text': (<class 'str'>,), 'last_run_time': (<class 'str'>,), 'modification_time': (<class 'str'>,), 'name': (<class 'str'>,), 'plugin_bundle': (<class 'str'>,), 'plugin_name': (<class 'str'>,), 'plugin_server': (<class 'str'>,), 'run_interval_seconds': (<class 'int'>,), 'run_on_days': (<class 'str'>,), 'start_date': (<class 'str'>,), 'start_hour': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'arguments': <class 'pytan3.api_objects.rest_7_3_314_3641.PluginArgumentList'>, 'last_run_sql': <class 'pytan3.api_objects.rest_7_3_314_3641.PluginSql'>, 'mod_user': <class 'pytan3.api_objects.rest_7_3_314_3641.User'>, 'user': <class 'pytan3.api_objects.rest_7_3_314_3641.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of PluginScheduleList

API_LIST_API_NAME = 'plugin_schedules'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.ComputerGroupSpec(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'computer_group_spec'

str – Name of object used in API calls.

API_NAME_SRC = 'computer_group_spec'

str – Name of object in source file.

API_SIMPLE = {'computer_name': (<class 'str'>,), 'id': (<class 'int'>,), 'ip_address': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ComputerSpecList

API_LIST_API_NAME = 'computer_specs'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.ComputerGroup(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'computer_group'

str – Name of object used in API calls.

API_NAME_SRC = 'computer_group'

str – Name of object in source file.

API_SIMPLE = {'deleted_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'computer_specs': <class 'pytan3.api_objects.rest_7_3_314_3641.ComputerSpecList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ComputerGroupList

API_LIST_API_NAME = 'computer_groups'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.VerifySignature(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'verify_signature'

str – Name of object used in API calls.

API_NAME_SRC = 'verify_signature'

str – Name of object in source file.

API_SIMPLE = {'bytes': (<class 'str'>,), 'id': (<class 'int'>,), 'type': (<class 'str'>,), 'verified': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.ObjectList(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'object_list'

str – Name of object used in API calls.

API_NAME_SRC = 'object_list'

str – Name of object in source file.

API_SIMPLE = {'export_id': (<class 'str'>,), 'export_version': (<class 'int'>,), 'import_content': (<class 'str'>,), 'server_info': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'action': <class 'pytan3.api_objects.rest_7_3_314_3641.Action'>, 'action_group': <class 'pytan3.api_objects.rest_7_3_314_3641.ActionGroup'>, 'action_groups': <class 'pytan3.api_objects.rest_7_3_314_3641.ActionGroupList'>, 'action_stop': <class 'pytan3.api_objects.rest_7_3_314_3641.ActionStop'>, 'action_stops': <class 'pytan3.api_objects.rest_7_3_314_3641.ActionStopList'>, 'actions': <class 'pytan3.api_objects.rest_7_3_314_3641.ActionList'>, 'archived_question': <class 'pytan3.api_objects.rest_7_3_314_3641.ArchivedQuestion'>, 'archived_questions': <class 'pytan3.api_objects.rest_7_3_314_3641.ArchivedQuestionList'>, 'audit_log': <class 'pytan3.api_objects.rest_7_3_314_3641.AuditLog'>, 'audit_logs': <class 'pytan3.api_objects.rest_7_3_314_3641.AuditLogList'>, 'client_count': <class 'pytan3.api_objects.rest_7_3_314_3641.ClientCount'>, 'client_status': <class 'pytan3.api_objects.rest_7_3_314_3641.ClientStatus'>, 'computer_group': <class 'pytan3.api_objects.rest_7_3_314_3641.ComputerGroup'>, 'computer_groups': <class 'pytan3.api_objects.rest_7_3_314_3641.ComputerGroupList'>, 'content_set': <class 'pytan3.api_objects.rest_7_3_314_3641.ContentSet'>, 'content_set_privilege': <class 'pytan3.api_objects.rest_7_3_314_3641.ContentSetPrivilege'>, 'content_set_privileges': <class 'pytan3.api_objects.rest_7_3_314_3641.ContentSetPrivilegeList'>, 'content_set_role': <class 'pytan3.api_objects.rest_7_3_314_3641.ContentSetRole'>, 'content_set_role_membership': <class 'pytan3.api_objects.rest_7_3_314_3641.ContentSetRoleMembership'>, 'content_set_role_memberships': <class 'pytan3.api_objects.rest_7_3_314_3641.ContentSetRoleMembershipList'>, 'content_set_role_privilege': <class 'pytan3.api_objects.rest_7_3_314_3641.ContentSetRolePrivilege'>, 'content_set_role_privileges': <class 'pytan3.api_objects.rest_7_3_314_3641.ContentSetRolePrivilegeList'>, 'content_set_roles': <class 'pytan3.api_objects.rest_7_3_314_3641.ContentSetRoleList'>, 'content_set_user_group_role_membership': <class 'pytan3.api_objects.rest_7_3_314_3641.ContentSetUserGroupRoleMembership'>, 'content_set_user_group_role_memberships': <class 'pytan3.api_objects.rest_7_3_314_3641.ContentSetUserGroupRoleMembershipList'>, 'content_sets': <class 'pytan3.api_objects.rest_7_3_314_3641.ContentSetList'>, 'effective_content_set_privileges': <class 'pytan3.api_objects.rest_7_3_314_3641.EffectiveContentSetPrivilegeRequest'>, 'group': <class 'pytan3.api_objects.rest_7_3_314_3641.Group'>, 'groups': <class 'pytan3.api_objects.rest_7_3_314_3641.GroupList'>, 'hashed_string': <class 'pytan3.api_objects.rest_7_3_314_3641.HashedString'>, 'hashed_strings': <class 'pytan3.api_objects.rest_7_3_314_3641.HashedStringList'>, 'import_conflict_details': <class 'pytan3.api_objects.rest_7_3_314_3641.ImportConflictDetailList'>, 'ldap_sync_connector': <class 'pytan3.api_objects.rest_7_3_314_3641.LdapSyncConnector'>, 'ldap_sync_connectors': <class 'pytan3.api_objects.rest_7_3_314_3641.LdapSyncConnectorList'>, 'package_file': <class 'pytan3.api_objects.rest_7_3_314_3641.PackageFile'>, 'package_files': <class 'pytan3.api_objects.rest_7_3_314_3641.PackageFileList'>, 'package_spec': <class 'pytan3.api_objects.rest_7_3_314_3641.PackageSpec'>, 'package_specs': <class 'pytan3.api_objects.rest_7_3_314_3641.PackageSpecList'>, 'parse_job': <class 'pytan3.api_objects.rest_7_3_314_3641.ParseJob'>, 'parse_jobs': <class 'pytan3.api_objects.rest_7_3_314_3641.ParseJobList'>, 'parse_result_group': <class 'pytan3.api_objects.rest_7_3_314_3641.ParseResultGroup'>, 'parse_result_groups': <class 'pytan3.api_objects.rest_7_3_314_3641.ParseResultGroupList'>, 'plugin': <class 'pytan3.api_objects.rest_7_3_314_3641.Plugin'>, 'plugin_schedule': <class 'pytan3.api_objects.rest_7_3_314_3641.PluginSchedule'>, 'plugin_schedules': <class 'pytan3.api_objects.rest_7_3_314_3641.PluginScheduleList'>, 'plugins': <class 'pytan3.api_objects.rest_7_3_314_3641.PluginList'>, 'question': <class 'pytan3.api_objects.rest_7_3_314_3641.Question'>, 'questions': <class 'pytan3.api_objects.rest_7_3_314_3641.QuestionList'>, 'roles': <class 'pytan3.api_objects.rest_7_3_314_3641.UserRoleList'>, 'saved_action': <class 'pytan3.api_objects.rest_7_3_314_3641.SavedAction'>, 'saved_action_approval': <class 'pytan3.api_objects.rest_7_3_314_3641.SavedActionApproval'>, 'saved_action_approvals': <class 'pytan3.api_objects.rest_7_3_314_3641.SavedActionApprovalList'>, 'saved_actions': <class 'pytan3.api_objects.rest_7_3_314_3641.SavedActionList'>, 'saved_question': <class 'pytan3.api_objects.rest_7_3_314_3641.SavedQuestion'>, 'saved_question_package_specs': <class 'pytan3.api_objects.rest_7_3_314_3641.SavedQuestionPackageSpecs'>, 'saved_question_question': <class 'pytan3.api_objects.rest_7_3_314_3641.SavedQuestionQuestion'>, 'saved_question_questions': <class 'pytan3.api_objects.rest_7_3_314_3641.SavedQuestionQuestionList'>, 'saved_questions': <class 'pytan3.api_objects.rest_7_3_314_3641.SavedQuestionList'>, 'sensor': <class 'pytan3.api_objects.rest_7_3_314_3641.Sensor'>, 'sensor_stat': <class 'pytan3.api_objects.rest_7_3_314_3641.SensorStat'>, 'sensor_stats': <class 'pytan3.api_objects.rest_7_3_314_3641.SensorStatList'>, 'sensors': <class 'pytan3.api_objects.rest_7_3_314_3641.SensorList'>, 'server_host': <class 'pytan3.api_objects.rest_7_3_314_3641.ServerHost'>, 'server_hosts': <class 'pytan3.api_objects.rest_7_3_314_3641.ServerHostList'>, 'server_throttle': <class 'pytan3.api_objects.rest_7_3_314_3641.ServerThrottle'>, 'server_throttle_status': <class 'pytan3.api_objects.rest_7_3_314_3641.ServerThrottleStatus'>, 'server_throttle_statuses': <class 'pytan3.api_objects.rest_7_3_314_3641.ServerThrottleStatusList'>, 'server_throttles': <class 'pytan3.api_objects.rest_7_3_314_3641.ServerThrottleList'>, 'site_throttle': <class 'pytan3.api_objects.rest_7_3_314_3641.SiteThrottle'>, 'site_throttle_status': <class 'pytan3.api_objects.rest_7_3_314_3641.SiteThrottleStatus'>, 'site_throttles': <class 'pytan3.api_objects.rest_7_3_314_3641.SiteThrottleList'>, 'site_throttles_statuses': <class 'pytan3.api_objects.rest_7_3_314_3641.SiteThrottleStatusList'>, 'soap_error': <class 'pytan3.api_objects.rest_7_3_314_3641.SoapError'>, 'solution': <class 'pytan3.api_objects.rest_7_3_314_3641.Solution'>, 'solutions': <class 'pytan3.api_objects.rest_7_3_314_3641.SolutionList'>, 'system_setting': <class 'pytan3.api_objects.rest_7_3_314_3641.SystemSetting'>, 'system_settings': <class 'pytan3.api_objects.rest_7_3_314_3641.SystemSettingList'>, 'system_status': <class 'pytan3.api_objects.rest_7_3_314_3641.SystemStatusList'>, 'upload_file': <class 'pytan3.api_objects.rest_7_3_314_3641.UploadFile'>, 'upload_file_status': <class 'pytan3.api_objects.rest_7_3_314_3641.UploadFileStatus'>, 'user': <class 'pytan3.api_objects.rest_7_3_314_3641.User'>, 'user_group': <class 'pytan3.api_objects.rest_7_3_314_3641.UserGroup'>, 'user_groups': <class 'pytan3.api_objects.rest_7_3_314_3641.UserGroupList'>, 'users': <class 'pytan3.api_objects.rest_7_3_314_3641.UserList'>, 'verify_signature': <class 'pytan3.api_objects.rest_7_3_314_3641.VerifySignature'>, 'white_listed_url': <class 'pytan3.api_objects.rest_7_3_314_3641.WhiteListedUrl'>, 'white_listed_urls': <class 'pytan3.api_objects.rest_7_3_314_3641.WhiteListedUrlList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.ImportConflictDetail(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'import_conflict_detail'

str – Name of object used in API calls.

API_NAME_SRC = 'import_conflict_detail'

str – Name of object in source file.

API_SIMPLE = {'diff': (<class 'str'>,), 'is_new': (<class 'int'>,), 'name': (<class 'str'>,), 'type': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ImportConflictDetailList

API_LIST_API_NAME = 'import_conflict_details'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.CacheFilter(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'cache_filter'

str – Name of object used in API calls.

API_NAME_SRC = 'cache_filter'

str – Name of object in source file.

API_SIMPLE = {'and_flag': (<class 'int'>,), 'field': (<class 'str'>,), 'not_flag': (<class 'int'>,), 'operator': (<class 'str'>,), 'type': (<class 'str'>,), 'value': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'sub_filters': <class 'pytan3.api_objects.rest_7_3_314_3641.CacheFilterList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of CacheFilterList

API_LIST_API_NAME = 'cache_filters'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.Options(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'options'

str – Name of object used in API calls.

API_NAME_SRC = 'options'

str – Name of object in source file.

API_SIMPLE = {'aggregate_by_value_flag': (<class 'int'>,), 'aggregate_over_time_flag': (<class 'int'>,), 'allow_cdata_base64_encode_flag': (<class 'int'>,), 'audit_history_size': (<class 'int'>,), 'cache_expiration': (<class 'int'>,), 'cache_id': (<class 'int'>,), 'cache_sort_fields': (<class 'str'>,), 'cdata_base64_encoded': (<class 'int'>,), 'context_id': (<class 'int'>,), 'disable_live_snapshots': (<class 'int'>,), 'export_dont_include_related': (<class 'int'>,), 'export_flag': (<class 'int'>,), 'export_format': (<class 'int'>,), 'export_hide_csv_header_flag': (<class 'int'>,), 'export_leading_text': (<class 'str'>,), 'export_omit_soap_envelope': (<class 'int'>,), 'export_trailing_text': (<class 'str'>,), 'filter_not_flag': (<class 'int'>,), 'filter_string': (<class 'str'>,), 'flags': (<class 'int'>,), 'hide_errors_flag': (<class 'int'>,), 'hide_no_results_flag': (<class 'int'>,), 'import_analyze_conflicts_only': (<class 'int'>,), 'import_existing_ignore_content_set': (<class 'int'>,), 'include_answer_times_flag': (<class 'int'>,), 'include_hashes_flag': (<class 'int'>,), 'include_hidden_flag': (<class 'int'>,), 'include_user_details': (<class 'int'>,), 'include_user_owned_object_ids_flag': (<class 'int'>,), 'json_pretty_print': (<class 'int'>,), 'live_snapshot_always_use_seconds': (<class 'int'>,), 'live_snapshot_expiration_seconds': (<class 'int'>,), 'live_snapshot_invalidate_report_count_percentage': (<class 'int'>,), 'live_snapshot_report_count_threshold': (<class 'int'>,), 'most_recent_flag': (<class 'int'>,), 'no_result_row_collation_flag': (<class 'int'>,), 'pct_done_limit': (<class 'int'>,), 'recent_result_buckets': (<class 'str'>,), 'return_cdata_flag': (<class 'int'>,), 'return_lists_flag': (<class 'int'>,), 'row_count': (<class 'int'>,), 'row_counts_only_flag': (<class 'int'>,), 'row_start': (<class 'int'>,), 'sample_count': (<class 'int'>,), 'sample_frequency': (<class 'int'>,), 'sample_start': (<class 'int'>,), 'saved_question_qids_allow_multiple_flag': (<class 'int'>,), 'saved_question_qids_ignore_mr_group_flag': (<class 'int'>,), 'saved_question_qids_include_expired_flag': (<class 'int'>,), 'saved_question_qids_reissue_flag': (<class 'int'>,), 'script_data': (<class 'str'>,), 'sort_order': (<class 'str'>,), 'suppress_object_list': (<class 'int'>,), 'suppress_scripts': (<class 'int'>,), 'use_error_objects': (<class 'int'>,), 'use_json': (<class 'int'>,), 'use_user_context_flag': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_filters': <class 'pytan3.api_objects.rest_7_3_314_3641.CacheFilterList'>, 'import_conflict_options': <class 'pytan3.api_objects.rest_7_3_314_3641.ImportConflictOptions'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.ContentSet(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'content_set'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set'

str – Name of object in source file.

API_SIMPLE = {'description': (<class 'str'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'reserved_name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'metadata': <class 'pytan3.api_objects.rest_7_3_314_3641.MetadataList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ContentSetList

API_LIST_API_NAME = 'content_sets'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.ContentSetRolePrivilegeOnRole(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'content_set_role_privilege_on_role'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role_privilege_on_role'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set': <class 'pytan3.api_objects.rest_7_3_314_3641.IdReference'>, 'content_set_privilege': <class 'pytan3.api_objects.rest_7_3_314_3641.IdReference'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ContentSetRolePrivilegeOnRoleList

API_LIST_API_NAME = 'content_set_role_privilege_on_roles'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.ContentSetRole(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'content_set_role'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role'

str – Name of object in source file.

API_SIMPLE = {'all_content_sets_flag': (<class 'int'>,), 'category': (<class 'str'>,), 'deny_flag': (<class 'int'>,), 'description': (<class 'str'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'reserved_name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set_role_privileges': <class 'pytan3.api_objects.rest_7_3_314_3641.ContentSetRolePrivilegeOnRoleList'>, 'metadata': <class 'pytan3.api_objects.rest_7_3_314_3641.MetadataList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ContentSetRoleList

API_LIST_API_NAME = 'content_set_roles'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.ContentSetRoleMembership(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'content_set_role_membership'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role_membership'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set_role': <class 'pytan3.api_objects.rest_7_3_314_3641.IdReference'>, 'user': <class 'pytan3.api_objects.rest_7_3_314_3641.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ContentSetRoleMembershipList

API_LIST_API_NAME = 'content_set_role_memberships'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.ContentSetUserGroupRoleMembership(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'content_set_user_group_role_membership'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_user_group_role_membership'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set_role': <class 'pytan3.api_objects.rest_7_3_314_3641.IdReference'>, 'user_group': <class 'pytan3.api_objects.rest_7_3_314_3641.IdReference'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ContentSetUserGroupRoleMembershipList

API_LIST_API_NAME = 'content_set_user_group_role_memberships'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.ContentSetPrivilege(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'content_set_privilege'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_privilege'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,), 'name': (<class 'str'>,), 'privilege_module': (<class 'str'>,), 'privilege_type': (<class 'str'>,), 'reserved_name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'metadata': <class 'pytan3.api_objects.rest_7_3_314_3641.MetadataList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ContentSetPrivilegeList

API_LIST_API_NAME = 'content_set_privileges'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.ContentSetRolePrivilege(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'content_set_role_privilege'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role_privilege'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set': <class 'pytan3.api_objects.rest_7_3_314_3641.IdReference'>, 'content_set_privilege': <class 'pytan3.api_objects.rest_7_3_314_3641.IdReference'>, 'content_set_role': <class 'pytan3.api_objects.rest_7_3_314_3641.IdReference'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ContentSetRolePrivilegeList

API_LIST_API_NAME = 'content_set_role_privileges'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.EffectiveContentSetPrivilege(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'effective_content_set_privilege'

str – Name of object used in API calls.

API_NAME_SRC = 'effective_content_set_privilege'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set': <class 'pytan3.api_objects.rest_7_3_314_3641.ContentSet'>, 'content_set_privilege_list': <class 'pytan3.api_objects.rest_7_3_314_3641.ContentSetPrivilegeList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of EffectiveContentSetPrivilegeList

API_LIST_API_NAME = 'effective_content_set_privileges'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.Dashboard(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'dashboard'

str – Name of object used in API calls.

API_NAME_SRC = 'dashboard'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,), 'name': (<class 'str'>,), 'public_flag': (<class 'int'>,), 'text': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set': <class 'pytan3.api_objects.rest_7_3_314_3641.ContentSet'>, 'group': <class 'pytan3.api_objects.rest_7_3_314_3641.Group'>, 'saved_question_list': <class 'pytan3.api_objects.rest_7_3_314_3641.SavedQuestionList'>, 'user': <class 'pytan3.api_objects.rest_7_3_314_3641.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of DashboardList

API_LIST_API_NAME = 'dashboards'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.DashboardGroup(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'dashboard_group'

str – Name of object used in API calls.

API_NAME_SRC = 'dashboard_group'

str – Name of object in source file.

API_SIMPLE = {'display_index': (<class 'int'>,), 'editable_flag': (<class 'int'>,), 'icon': (<class 'str'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'other_flag': (<class 'int'>,), 'public_flag': (<class 'int'>,), 'text': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set': <class 'pytan3.api_objects.rest_7_3_314_3641.ContentSet'>, 'dashboard_list': <class 'pytan3.api_objects.rest_7_3_314_3641.DashboardList'>, 'user': <class 'pytan3.api_objects.rest_7_3_314_3641.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.UserGroup(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'user_group'

str – Name of object used in API calls.

API_NAME_SRC = 'user_group'

str – Name of object in source file.

API_SIMPLE = {'deleted_flag': (<class 'int'>,), 'exclusive_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set_roles': <class 'pytan3.api_objects.rest_7_3_314_3641.ContentSetRoleList'>, 'group': <class 'pytan3.api_objects.rest_7_3_314_3641.Group'>, 'metadata': <class 'pytan3.api_objects.rest_7_3_314_3641.MetadataList'>, 'user_list': <class 'pytan3.api_objects.rest_7_3_314_3641.UserList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of UserGroupList

API_LIST_API_NAME = 'user_groups'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.Solution(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'solution'

str – Name of object used in API calls.

API_NAME_SRC = 'solution'

str – Name of object in source file.

API_SIMPLE = {'category': (<class 'str'>,), 'delete_xml_url': (<class 'str'>,), 'deleted_flag': (<class 'int'>,), 'description': (<class 'str'>,), 'dup_resolve_type': (<class 'int'>,), 'id': (<class 'int'>,), 'imported_by': (<class 'str'>,), 'imported_version': (<class 'str'>,), 'installed_xml_url': (<class 'str'>,), 'last_update': (<class 'str'>,), 'name': (<class 'str'>,), 'signature': (<class 'str'>,), 'solution_id': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SolutionList

API_LIST_API_NAME = 'solutions'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.ActionGroup(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'action_group'

str – Name of object used in API calls.

API_NAME_SRC = 'action_group'

str – Name of object in source file.

API_SIMPLE = {'and_flag': (<class 'int'>,), 'deleted_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'public_flag': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'groups': <class 'pytan3.api_objects.rest_7_3_314_3641.GroupList'>, 'user_groups': <class 'pytan3.api_objects.rest_7_3_314_3641.UserGroupList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ActionGroupList

API_LIST_API_NAME = 'action_groups'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.SavedQuestionPackageSpecs(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'saved_question_package_specs'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_question_package_specs'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'packages': <class 'pytan3.api_objects.rest_7_3_314_3641.PackageSpecList'>, 'saved_question': <class 'pytan3.api_objects.rest_7_3_314_3641.IdReference'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.SavedQuestionQuestion(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'saved_question_question'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_question_question'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'questions': <class 'pytan3.api_objects.rest_7_3_314_3641.QuestionList'>, 'saved_question': <class 'pytan3.api_objects.rest_7_3_314_3641.IdReference'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SavedQuestionQuestionList

API_LIST_API_NAME = 'saved_question_questions'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.LdapSyncConnector(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'ldap_sync_connector'

str – Name of object used in API calls.

API_NAME_SRC = 'ldap_sync_connector'

str – Name of object in source file.

API_SIMPLE = {'base_groups': (<class 'str'>,), 'base_users': (<class 'str'>,), 'disable_ldap_auth': (<class 'int'>,), 'disable_referrals_flag': (<class 'int'>,), 'enable': (<class 'int'>,), 'filter_groups': (<class 'str'>,), 'filter_users': (<class 'str'>,), 'group_id': (<class 'str'>,), 'group_member': (<class 'str'>,), 'group_name': (<class 'str'>,), 'host': (<class 'str'>,), 'id': (<class 'int'>,), 'last_sync_result': (<class 'str'>,), 'last_sync_timestamp': (<class 'str'>,), 'ldap_password': (<class 'str'>,), 'ldap_user': (<class 'str'>,), 'members_only_flag': (<class 'int'>,), 'name': (<class 'str'>,), 'port': (<class 'int'>,), 'secure': (<class 'int'>,), 'sync_individual_members_flag': (<class 'int'>,), 'use_ntlm': (<class 'int'>,), 'user_display_name': (<class 'str'>,), 'user_domain': (<class 'str'>,), 'user_id': (<class 'str'>,), 'user_member_of': (<class 'str'>,), 'user_name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of LdapSyncConnectorList

API_LIST_API_NAME = 'ldap_sync_connectors'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.ServerThrottle(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'server_throttle'

str – Name of object used in API calls.

API_NAME_SRC = 'server_throttle'

str – Name of object in source file.

API_SIMPLE = {'bandwidth_bytes_limit': (<class 'int'>,), 'connection_limit': (<class 'int'>,), 'deleted_flag': (<class 'int'>,), 'download_bandwidth_bytes_limit': (<class 'int'>,), 'download_connection_limit': (<class 'int'>,), 'id': (<class 'int'>,), 'ip_address': (<class 'str'>,), 'name': (<class 'str'>,), 'sensor_bandwidth_bytes_limit': (<class 'int'>,), 'sensor_connection_limit': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ServerThrottleList

API_LIST_API_NAME = 'server_throttles'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.SiteThrottle(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'site_throttle'

str – Name of object used in API calls.

API_NAME_SRC = 'site_throttle'

str – Name of object in source file.

API_SIMPLE = {'all_subnets_flag': (<class 'int'>,), 'bandwidth_bytes_limit': (<class 'int'>,), 'deleted_flag': (<class 'int'>,), 'download_bandwidth_bytes_limit': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'sensor_bandwidth_bytes_limit': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'subnets': <class 'pytan3.api_objects.rest_7_3_314_3641.SiteThrottleSubnetList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SiteThrottleList

API_LIST_API_NAME = 'site_throttles'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.SiteThrottleSubnet(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'site_throttle_subnet'

str – Name of object used in API calls.

API_NAME_SRC = 'site_throttle_subnet'

str – Name of object in source file.

API_SIMPLE = {'range': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SiteThrottleSubnetList

API_LIST_API_NAME = 'site_throttle_subnets'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.ServerThrottleStatus(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'server_throttle_status'

str – Name of object used in API calls.

API_NAME_SRC = 'server_throttle_status'

str – Name of object in source file.

API_SIMPLE = {'download_queue_delay_milliseconds': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'queue_delay_milliseconds': (<class 'int'>,), 'sensor_queue_delay_milliseconds': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ServerThrottleStatusList

API_LIST_API_NAME = 'server_throttle_statuses'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.SiteThrottleStatus(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'site_throttle_status'

str – Name of object used in API calls.

API_NAME_SRC = 'site_throttle_status'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,), 'name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'subnets': <class 'pytan3.api_objects.rest_7_3_314_3641.SiteThrottleSubnetStatusList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SiteThrottleStatusList

API_LIST_API_NAME = 'site_throttles_statuses'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.SiteThrottleSubnetStatus(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'site_throttle_subnet_status'

str – Name of object used in API calls.

API_NAME_SRC = 'site_throttle_subnet_status'

str – Name of object in source file.

API_SIMPLE = {'download_queue_delay_milliseconds': (<class 'int'>,), 'queue_delay_milliseconds': (<class 'int'>,), 'range': (<class 'str'>,), 'sensor_queue_delay_milliseconds': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SiteThrottleSubnetStatusList

API_LIST_API_NAME = 'site_throttle_subnet_statuss'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.HashedString(**kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'hashed_string'

str – Name of object used in API calls.

API_NAME_SRC = 'hashed_string'

str – Name of object in source file.

API_SIMPLE = {'collision_flag': (<class 'int'>,), 'error_flag': (<class 'int'>,), 'first_collision': (<class 'str'>,), 'second_collision': (<class 'str'>,), 'sensor_hash': (<class 'int'>,), 'value': (<class 'str'>,), 'value_hash': (<class 'int'>,), 'which_computer_id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'first_computer_id': <class 'pytan3.api_objects.rest_7_3_314_3641.ComputerIdList'>, 'second_computer_id': <class 'pytan3.api_objects.rest_7_3_314_3641.ComputerIdList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of HashedStringList

API_LIST_API_NAME = 'hashed_strings'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.rest_7_3_314_3641.SensorQueryList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'sensor_querys'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_query_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'query'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SensorQuery

class pytan3.api_objects.rest_7_3_314_3641.SensorSubcolumnList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'sensor_subcolumns'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_subcolumn_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'subcolumn'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SensorSubcolumn

class pytan3.api_objects.rest_7_3_314_3641.StringHintList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'string_hints'

str – Name of object used in API calls.

API_NAME_SRC = 'string_hint_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'string_hint'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'str'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.rest_7_3_314_3641.SensorList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'sensors'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.rest_7_3_314_3641.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'sensor'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Sensor

class pytan3.api_objects.rest_7_3_314_3641.SensorStatList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'sensor_stats'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_stat_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'sensor_stat'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SensorStat

class pytan3.api_objects.rest_7_3_314_3641.SavedActionApprovalList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'saved_action_approvals'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_action_approval_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'saved_action_approval'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SavedActionApproval

class pytan3.api_objects.rest_7_3_314_3641.SavedActionRowIdList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'saved_action_row_ids'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_action_row_id_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'row_id'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'int'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.rest_7_3_314_3641.SavedActionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'saved_actions'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_action_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.rest_7_3_314_3641.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'saved_action'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SavedAction

class pytan3.api_objects.rest_7_3_314_3641.AuditDataList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'audit_datas'

str – Name of object used in API calls.

API_NAME_SRC = 'audit_data_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.rest_7_3_314_3641.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'entry'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of AuditData

class pytan3.api_objects.rest_7_3_314_3641.AuditLogList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'audit_logs'

str – Name of object used in API calls.

API_NAME_SRC = 'audit_log_list'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,), 'type': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'entries'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of AuditLog

class pytan3.api_objects.rest_7_3_314_3641.ServerList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'servers'

str – Name of object used in API calls.

API_NAME_SRC = 'server_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'server'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Server

class pytan3.api_objects.rest_7_3_314_3641.ServerHost(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'server_host'

str – Name of object used in API calls.

API_NAME_SRC = 'server_host'

str – Name of object in source file.

API_SIMPLE = {'heart_beat_age_in_minute': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'servers'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ServerList

class pytan3.api_objects.rest_7_3_314_3641.ServerHostList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'server_hosts'

str – Name of object used in API calls.

API_NAME_SRC = 'server_host_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'server_host'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ServerHost

class pytan3.api_objects.rest_7_3_314_3641.MetadataList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'metadatas'

str – Name of object used in API calls.

API_NAME_SRC = 'metadata_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'item'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of MetadataItem

class pytan3.api_objects.rest_7_3_314_3641.GroupList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'groups'

str – Name of object used in API calls.

API_NAME_SRC = 'group_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.rest_7_3_314_3641.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'group'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Group

class pytan3.api_objects.rest_7_3_314_3641.FilterList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'filters'

str – Name of object used in API calls.

API_NAME_SRC = 'filter_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'filter'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Filter

class pytan3.api_objects.rest_7_3_314_3641.SelectList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'selects'

str – Name of object used in API calls.

API_NAME_SRC = 'select_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'select'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Select

class pytan3.api_objects.rest_7_3_314_3641.ErrorList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'errors'

str – Name of object used in API calls.

API_NAME_SRC = 'error_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'error'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of XmlError

class pytan3.api_objects.rest_7_3_314_3641.QuestionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'questions'

str – Name of object used in API calls.

API_NAME_SRC = 'question_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.rest_7_3_314_3641.CacheInfo'>, 'info': <class 'pytan3.api_objects.rest_7_3_314_3641.QuestionListInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'question'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Question

class pytan3.api_objects.rest_7_3_314_3641.PackageFileTemplateList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'package_file_templates'

str – Name of object used in API calls.

API_NAME_SRC = 'package_file_template_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'file_template'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of PackageFileTemplate

class pytan3.api_objects.rest_7_3_314_3641.PackageFileStatusList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'package_file_statuss'

str – Name of object used in API calls.

API_NAME_SRC = 'package_file_status_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'status'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of PackageFileStatus

class pytan3.api_objects.rest_7_3_314_3641.PackageFileList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'package_files'

str – Name of object used in API calls.

API_NAME_SRC = 'package_file_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'file'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of PackageFile

class pytan3.api_objects.rest_7_3_314_3641.PackageSpecList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'package_specs'

str – Name of object used in API calls.

API_NAME_SRC = 'package_spec_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.rest_7_3_314_3641.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'package_spec'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of PackageSpec

class pytan3.api_objects.rest_7_3_314_3641.WhiteListedUrlList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'white_listed_urls'

str – Name of object used in API calls.

API_NAME_SRC = 'white_listed_url_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'white_listed_url'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of WhiteListedUrl

class pytan3.api_objects.rest_7_3_314_3641.VersionAggregateList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'version_aggregates'

str – Name of object used in API calls.

API_NAME_SRC = 'version_aggregate_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'version'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of VersionAggregate

class pytan3.api_objects.rest_7_3_314_3641.SystemStatusList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'system_status'

str – Name of object used in API calls.

API_NAME_SRC = 'system_status_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'aggregate': <class 'pytan3.api_objects.rest_7_3_314_3641.SystemStatusAggregate'>, 'cache_info': <class 'pytan3.api_objects.rest_7_3_314_3641.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'client_status'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ClientStatus

class pytan3.api_objects.rest_7_3_314_3641.SystemSettingList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'system_settings'

str – Name of object used in API calls.

API_NAME_SRC = 'system_setting_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.rest_7_3_314_3641.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'system_setting'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SystemSetting

class pytan3.api_objects.rest_7_3_314_3641.UserList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'users'

str – Name of object used in API calls.

API_NAME_SRC = 'user_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'user'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of User

class pytan3.api_objects.rest_7_3_314_3641.PermissionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'permissions'

str – Name of object used in API calls.

API_NAME_SRC = 'permission_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {'ACTION_APPROVE': 'action_approval', 'ACTION_READ': 'action_read', 'ACTION_WRITE': 'action_write', 'ADMIN': 'admin', 'CLIENTS_READ': 'clients_read', 'CONTENT_ADMIN': 'content_admin', 'NOTIFICATION_WRITE': 'notification_write', 'QUESTION_LOG_READ': 'question_log_read', 'QUESTION_READ': 'question_read', 'QUESTION_WRITE': 'question_write', 'SENSOR_READ': 'sensor_read', 'SENSOR_WRITE': 'sensor_write'}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'permission'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'str'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.rest_7_3_314_3641.UserRoleList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'roles'

str – Name of object used in API calls.

API_NAME_SRC = 'user_role_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'role'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of UserRole

class pytan3.api_objects.rest_7_3_314_3641.ActionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'actions'

str – Name of object used in API calls.

API_NAME_SRC = 'action_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.rest_7_3_314_3641.CacheInfo'>, 'info': <class 'pytan3.api_objects.rest_7_3_314_3641.ActionListInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'action'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Action

class pytan3.api_objects.rest_7_3_314_3641.ActionStopList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'action_stops'

str – Name of object used in API calls.

API_NAME_SRC = 'action_stop_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'action_stop'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ActionStop

class pytan3.api_objects.rest_7_3_314_3641.ArchivedQuestionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'archived_questions'

str – Name of object used in API calls.

API_NAME_SRC = 'archived_question_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'archived_question'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ArchivedQuestion

class pytan3.api_objects.rest_7_3_314_3641.SavedQuestionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'saved_questions'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_question_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.rest_7_3_314_3641.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'saved_question'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SavedQuestion

class pytan3.api_objects.rest_7_3_314_3641.ParseJobList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'parse_jobs'

str – Name of object used in API calls.

API_NAME_SRC = 'parse_job_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'parse_job'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ParseJob

class pytan3.api_objects.rest_7_3_314_3641.ParseResultGroupList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'parse_result_groups'

str – Name of object used in API calls.

API_NAME_SRC = 'parse_result_group_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'parse_result_group'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ParseResultGroup

class pytan3.api_objects.rest_7_3_314_3641.ParseResultList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'parse_results'

str – Name of object used in API calls.

API_NAME_SRC = 'parse_result_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'parse_result'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ParseResult

class pytan3.api_objects.rest_7_3_314_3641.ParameterList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'parameters'

str – Name of object used in API calls.

API_NAME_SRC = 'parameter_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'parameter'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Parameter

class pytan3.api_objects.rest_7_3_314_3641.ParameterValueList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'parameter_values'

str – Name of object used in API calls.

API_NAME_SRC = 'parameter_value_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'value'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'str'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.rest_7_3_314_3641.SensorReferenceList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'sensor_references'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_reference_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'sensor_reference'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SensorReference

class pytan3.api_objects.rest_7_3_314_3641.PluginArgumentList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'plugin_arguments'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_argument_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'argument'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of PluginArgument

class pytan3.api_objects.rest_7_3_314_3641.PluginSqlResultList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'plugin_sql_results'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_sql_result_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'value'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'str'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.rest_7_3_314_3641.PluginSqlColumnList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'plugin_sql_columns'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_sql_column_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'name'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'str'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.rest_7_3_314_3641.PluginSql(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'plugin_sql'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_sql'

str – Name of object in source file.

API_SIMPLE = {'result_count': (<class 'int'>,), 'rows_affected': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'columns': <class 'pytan3.api_objects.rest_7_3_314_3641.PluginSqlColumnList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'result_row'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of PluginSqlResultList

class pytan3.api_objects.rest_7_3_314_3641.PluginCommandList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'plugin_commands'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_command_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'command'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'str'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.rest_7_3_314_3641.UploadFileList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'upload_files'

str – Name of object used in API calls.

API_NAME_SRC = 'upload_file_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'upload_file'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of UploadFile

class pytan3.api_objects.rest_7_3_314_3641.PluginList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'plugins'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.rest_7_3_314_3641.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'plugin'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Plugin

class pytan3.api_objects.rest_7_3_314_3641.PluginScheduleList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'plugin_schedules'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_schedule_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.rest_7_3_314_3641.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'plugin_schedule'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of PluginSchedule

class pytan3.api_objects.rest_7_3_314_3641.ComputerSpecList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'computer_specs'

str – Name of object used in API calls.

API_NAME_SRC = 'computer_spec_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.rest_7_3_314_3641.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'computer_spec'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ComputerGroupSpec

class pytan3.api_objects.rest_7_3_314_3641.ComputerGroupList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'computer_groups'

str – Name of object used in API calls.

API_NAME_SRC = 'computer_group_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.rest_7_3_314_3641.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'computer_group'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ComputerGroup

class pytan3.api_objects.rest_7_3_314_3641.ImportConflictDetailList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'import_conflict_details'

str – Name of object used in API calls.

API_NAME_SRC = 'import_conflict_detail_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'import_conflict_detail'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ImportConflictDetail

class pytan3.api_objects.rest_7_3_314_3641.CacheFilterList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'cache_filters'

str – Name of object used in API calls.

API_NAME_SRC = 'cache_filter_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'filter'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of CacheFilter

class pytan3.api_objects.rest_7_3_314_3641.ImportConflictOptions(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'import_conflict_options'

str – Name of object used in API calls.

API_NAME_SRC = 'import_conflict_options'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'import_conflict_option'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'int'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.rest_7_3_314_3641.ContentSetList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'content_sets'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'content_set'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ContentSet

class pytan3.api_objects.rest_7_3_314_3641.ContentSetRolePrivilegeOnRoleList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'content_set_role_privilege_on_roles'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role_privilege_on_role_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'content_set_role_privilege'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ContentSetRolePrivilegeOnRole

class pytan3.api_objects.rest_7_3_314_3641.ContentSetRoleList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'content_set_roles'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'content_set_role'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ContentSetRole

class pytan3.api_objects.rest_7_3_314_3641.ContentSetRoleMembershipList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'content_set_role_memberships'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role_membership_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'content_set_role_membership'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ContentSetRoleMembership

class pytan3.api_objects.rest_7_3_314_3641.ContentSetUserGroupRoleMembershipList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'content_set_user_group_role_memberships'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_user_group_role_membership_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'content_set_user_group_role_membership'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ContentSetUserGroupRoleMembership

class pytan3.api_objects.rest_7_3_314_3641.ContentSetPrivilegeList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'content_set_privileges'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_privilege_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'content_set_privilege'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ContentSetPrivilege

class pytan3.api_objects.rest_7_3_314_3641.ContentSetRolePrivilegeList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'content_set_role_privileges'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role_privilege_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'content_set_role_privilege'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ContentSetRolePrivilege

class pytan3.api_objects.rest_7_3_314_3641.EffectiveContentSetPrivilegeRequest(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'effective_content_set_privilege_request'

str – Name of object used in API calls.

API_NAME_SRC = 'effective_content_set_privilege_request'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'user'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of User

class pytan3.api_objects.rest_7_3_314_3641.EffectiveContentSetPrivilegeList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'effective_content_set_privileges'

str – Name of object used in API calls.

API_NAME_SRC = 'effective_content_set_privilege_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'effective_content_set_privilege'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of EffectiveContentSetPrivilege

class pytan3.api_objects.rest_7_3_314_3641.DashboardList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'dashboards'

str – Name of object used in API calls.

API_NAME_SRC = 'dashboard_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'dashboard'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Dashboard

class pytan3.api_objects.rest_7_3_314_3641.UserGroupList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'user_groups'

str – Name of object used in API calls.

API_NAME_SRC = 'user_group_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'user_group'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of UserGroup

class pytan3.api_objects.rest_7_3_314_3641.SolutionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'solutions'

str – Name of object used in API calls.

API_NAME_SRC = 'solution_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'solution'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Solution

class pytan3.api_objects.rest_7_3_314_3641.ActionGroupList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'action_groups'

str – Name of object used in API calls.

API_NAME_SRC = 'action_group_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'action_group'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ActionGroup

class pytan3.api_objects.rest_7_3_314_3641.SavedQuestionQuestionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'saved_question_questions'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_question_question_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'saved_question_question'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SavedQuestionQuestion

class pytan3.api_objects.rest_7_3_314_3641.LdapSyncConnectorList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'ldap_sync_connectors'

str – Name of object used in API calls.

API_NAME_SRC = 'ldap_sync_connector_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'ldap_sync_connector'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of LdapSyncConnector

class pytan3.api_objects.rest_7_3_314_3641.ServerThrottleList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'server_throttles'

str – Name of object used in API calls.

API_NAME_SRC = 'server_throttle_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'server_throttle'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ServerThrottle

class pytan3.api_objects.rest_7_3_314_3641.SiteThrottleList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'site_throttles'

str – Name of object used in API calls.

API_NAME_SRC = 'site_throttle_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'site_throttle'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SiteThrottle

class pytan3.api_objects.rest_7_3_314_3641.SiteThrottleSubnetList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'site_throttle_subnets'

str – Name of object used in API calls.

API_NAME_SRC = 'site_throttle_subnet_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'subnet'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SiteThrottleSubnet

class pytan3.api_objects.rest_7_3_314_3641.ServerThrottleStatusList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'server_throttle_statuses'

str – Name of object used in API calls.

API_NAME_SRC = 'server_throttle_status_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'server_throttle_status'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ServerThrottleStatus

class pytan3.api_objects.rest_7_3_314_3641.SiteThrottleStatusList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'site_throttles_statuses'

str – Name of object used in API calls.

API_NAME_SRC = 'site_throttle_status_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'site_throttle_status'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SiteThrottleStatus

class pytan3.api_objects.rest_7_3_314_3641.SiteThrottleSubnetStatusList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'site_throttle_subnet_statuss'

str – Name of object used in API calls.

API_NAME_SRC = 'site_throttle_subnet_status_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'subnet'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SiteThrottleSubnetStatus

class pytan3.api_objects.rest_7_3_314_3641.ComputerIdList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'computer_ids'

str – Name of object used in API calls.

API_NAME_SRC = 'computer_id_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'id'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'int'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.rest_7_3_314_3641.HashedStringList(*args, **kwargs)[source]

Bases: pytan3.api_objects.rest_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'hashed_strings'

str – Name of object used in API calls.

API_NAME_SRC = 'hashed_string_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'hashed_string'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of HashedString

pytan3.api_objects.rest_7_3_314_3641.BUILD_META = {'date': '2019-02-22 07:46:08.408656', 'script': 'build_objects_from_wsdl.py', 'script_platform': 'Darwin-18.2.0-x86_64-i386-64bit', 'script_python': '3.7.2 (default, Feb 20 2019, 14:09:01) ', 'script_version': '3.0.0', 'source_file': '/libraries/taniumjs/console.wsdl', 'source_file_date': '2019-02-22 07:29:24.912505'}

dict – How this module was built (date/time in UTC format).

pytan3.api_objects.rest_7_3_314_3641.COMMANDS = ['AddObject', 'GetObject', 'MoveObject', 'TransferObject', 'UpdateObject', 'DeleteObject', 'GetSavedQuestions', 'GetResultInfo', 'GetResultData', 'GetMergedResultData', 'UploadFile', 'RunPlugin', 'ExportObject', 'ImportObject', 'VerifySignature']

list of str – API commands.

pytan3.api_objects.rest_7_3_314_3641.VERSION = {'build': 3641, 'major': 7, 'minor': 3, 'protocol': 314, 'string': '7.3.314.3641'}

dict – Tanium API version these objects are intended to be used for.

SOAP API Object Modules

SOAP API Object Module for Version 7.2.314.3181

Python objects for Tanium’s API.

pytan3.api_objects.soap_7_2_314_3181.float_types = (<class 'float'>,)

tuple of type – Float types.

pytan3.api_objects.soap_7_2_314_3181.integer_types = (<class 'int'>,)

tuple of type – Integer types.

pytan3.api_objects.soap_7_2_314_3181.string_types = (<class 'str'>,)

tuple of type – String types.

pytan3.api_objects.soap_7_2_314_3181.simple_types = (<class 'int'>, <class 'str'>, <class 'float'>)

tuple of type – All types that should be considered simple types.

pytan3.api_objects.soap_7_2_314_3181.TYPE = 'soap'

str – Type of API this module was built from.

pytan3.api_objects.soap_7_2_314_3181.API_DT = '%Y-%m-%dT%H:%M:%S'

str – Datetime format for this API type and version.

pytan3.api_objects.soap_7_2_314_3181.api_fixes()[source]

Fix incorrect attribute definitions on auto generated ApiModel classes.

pytan3.api_objects.soap_7_2_314_3181.expand_cls_globals()[source]

Replace str values with global vars for attrs on ApiModel classes.

Quite the funky chicken dance for solving issues with order of class definition.

pytan3.api_objects.soap_7_2_314_3181.expand_global(obj)[source]

Replace str values with global vars recursively.

Parameters:obj (str or dict or list) – Object to expand into global var.
Returns:String objects are the only ones that will be expanded.
Return type:str or dict or list or object
pytan3.api_objects.soap_7_2_314_3181.get_api_all_item()[source]

Get map of class name to class for all ApiItem subclasses.

Returns:dict
pytan3.api_objects.soap_7_2_314_3181.get_api_all_list()[source]

Get map of class name to class for all ApiList subclasses.

Returns:dict
pytan3.api_objects.soap_7_2_314_3181.get_api_all_model()[source]

Get map of class name to class for all ApiItem and ApiList subclasses.

Returns:dict
class pytan3.api_objects.soap_7_2_314_3181.ApiModel[source]

Bases: pytan3.api_models.ApiModel

Model for a complex item in the API.

class pytan3.api_objects.soap_7_2_314_3181.ApiItem(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiModel, pytan3.api_models.ApiItem

Model for a complex item in the API.

class pytan3.api_objects.soap_7_2_314_3181.ApiList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiModel, pytan3.api_models.ApiList

Model for an array in the API.

class pytan3.api_objects.soap_7_2_314_3181.ResultInfoList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Manually defined API array object.

API_NAME = 'result_infos'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'max_available_age': (<class 'int'>,), 'now': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['now', 'max_available_age']

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'result_info'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ResultInfo

__repr__()[source]

Make repr output be same as str output.

Returns:str
class pytan3.api_objects.soap_7_2_314_3181.ResultInfo(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Manually defined API object.

API_NAME = 'result_info'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'age': (<class 'int'>,), 'archived_question_id': (<class 'int'>,), 'error_count': (<class 'int'>,), 'estimated_total': (<class 'int'>,), 'expire_seconds': (<class 'int'>,), 'id': (<class 'int'>,), 'issue_seconds': (<class 'int'>,), 'mr_passed': (<class 'int'>,), 'mr_tested': (<class 'int'>,), 'no_results_count': (<class 'int'>,), 'passed': (<class 'int'>,), 'question_id': (<class 'int'>,), 'report_count': (<class 'int'>,), 'row_count': (<class 'int'>,), 'row_count_flag': (<class 'int'>,), 'row_count_machines': (<class 'int'>,), 'saved_question_id': (<class 'int'>,), 'seconds_since_issued': (<class 'int'>,), 'select_count': (<class 'int'>,), 'tested': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['question_id', 'estimated_total', 'row_count', 'mr_tested', 'mr_passed']

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ResultInfoList

API_LIST_API_NAME = 'result_infos'

str – Name of API_LIST_CLS used in API calls.

__repr__()[source]

Make repr output be same as str output.

Returns:str
class pytan3.api_objects.soap_7_2_314_3181.ResultSetList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Manually defined API array object.

API_NAME = 'result_sets'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'now': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['now']

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'result_set'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ResultSet

class pytan3.api_objects.soap_7_2_314_3181.MergedResultSet(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Manually defined API object.

API_NAME = 'merged_result'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'max_available_age': (<class 'str'>,), 'now': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'result_infos': <class 'pytan3.api_objects.soap_7_2_314_3181.ResultInfoList'>, 'result_sets': <class 'pytan3.api_objects.soap_7_2_314_3181.ResultSetList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['now', 'max_available_age']

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.ResultSet(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Manually defined API object.

API_NAME = 'result_set'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'age': (<class 'int'>,), 'archived_question_id': (<class 'int'>,), 'cache_id': (<class 'int'>,), 'error_count': (<class 'int'>,), 'estimated_total': (<class 'int'>,), 'expiration': (<class 'int'>,), 'expire_seconds': (<class 'int'>,), 'filtered_row_count': (<class 'int'>,), 'filtered_row_count_machines': (<class 'int'>,), 'id': (<class 'int'>,), 'issue_seconds': (<class 'int'>,), 'item_count': (<class 'int'>,), 'mr_passed': (<class 'int'>,), 'mr_tested': (<class 'int'>,), 'no_results_count': (<class 'int'>,), 'passed': (<class 'int'>,), 'question_id': (<class 'int'>,), 'report_count': (<class 'int'>,), 'row_count': (<class 'int'>,), 'row_count_machines': (<class 'int'>,), 'saved_question_id': (<class 'int'>,), 'seconds_since_issued': (<class 'int'>,), 'select_count': (<class 'int'>,), 'tested': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cs': <class 'pytan3.api_objects.soap_7_2_314_3181.ColumnList'>, 'rs': <class 'pytan3.api_objects.soap_7_2_314_3181.RowList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['question_id', 'estimated_total', 'mr_tested', 'mr_passed', 'row_count', 'columns']

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ResultSetList

API_LIST_API_NAME = 'result_sets'

str – Name of API_LIST_CLS used in API calls.

__init__(**kwargs)[source]

Constructor.

Notes

Sets Column.API_DATA_SET so column objects can access rows.

Sets RowColumn.API_COLUMN to the index correlated Column so row columns can access the column name, result type, etc.

Sets Column.API_IDX and RowColumn.API_IDX so column objects know what their index is without having to do lookups.

Parameters:**kwargs – Passed back to parent class.
rows

Expose complex attr “rs” as “rows”.

Returns:list
columns

Expose complex attr “cs” as “columns”.

Returns:list
class pytan3.api_objects.soap_7_2_314_3181.ColumnList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Manually defined API array object.

API_NAME = 'cs'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['names']

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'c'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Column

__repr__()[source]

Make repr output be same as str output.

Returns:str
names

Expose column names of all Column in this obj.

Returns:list of str
__getitem__(value)[source]

Support indexing of names.

Parameters:value (int or str) – If int: Index of item to retrieve from simple attr “c”. If str: Column name to index correlate from names
Returns:The RowColumn object at index value from names.
Return type:RowColumn
class pytan3.api_objects.soap_7_2_314_3181.Column(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Manually defined API object.

API_DATA_SET = None

ResultSet – Parent of this object, set by ResultSet.__init__().

API_IDX = None

int – Index of this object in ColumnList.

API_NAME = 'c'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'dn': (<class 'str'>,), 'rt': (<class 'int'>,), 'wh': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['name', 'result_type', 'hash']

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ColumnList

API_LIST_API_NAME = 'cs'

str – Name of API_LIST_CLS used in API calls.

name

Expose simple attr “dn” as name.

Returns:str
hash

Expose simple attr “wh” as hash.

Returns:str
type

Expose simple attr “rt” as type.

Returns:str
result_type

Expose simple attr “rt” as result_type.

Notes

Will try to map str from “rt” as int to constants from Sensor.API_CONSTANTS.

Returns:str
get_values(attr='value', join=None)[source]

Get values of this column from all rows.

Parameters:
  • attr (str, optional) –

    Attribute to get values of.

    Defaults to: “value”.

  • join (str, optional) –

    String to join multi value columns.

    Defaults to: None.
Returns:

list of str
class pytan3.api_objects.soap_7_2_314_3181.RowList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Manually defined API array object.

API_NAME = 'rs'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'r'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Row

__repr__()[source]

Make repr output be same as str output.

Returns:str
class pytan3.api_objects.soap_7_2_314_3181.Row(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Manually defined API object.

API_NAME = 'r'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'cid': (<class 'int'>,), 'id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'c': <class 'pytan3.api_objects.soap_7_2_314_3181.RowColumnList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['id', 'cid', 'columns']

list or str – Attributes to add to str formatting.

API_LIST_API_NAME = 'rs'

str – Name of API_LIST_CLS used in API calls.

API_LIST_CLS

ApiItem: Item class this list class holds.

alias of RowList

__repr__()[source]

Make repr output be same as str output.

Returns:str
__getitem__(value)[source]

Support indexing of names.

Parameters:value (int or str) – If int: Index of item to retrieve from names. If str: Column name to index correlate from ColumnList.names
Returns:The RowColumn object at index value from names.
Return type:RowColumn
names

Return the names of each row column from RowColumn.API_COLUMN.

Returns:list of str
columns

Expose complex attr “c” as “columns”.

Returns:RowColumnList
__len__()[source]

Expose length of columns.

Returns:int
get_values(meta=False, hashes=False, join=None)[source]

Get all values from all columns in this row.

Parameters:
  • meta (bool, optional) –

    Include sensor hash and result type for each column.

    Defaults to: False.

  • hashes (bool, optional) –

    Include hashes of values.

    Defaults to: False.

  • join (str, optional) –

    String to join multi value columns.

    Defaults to: None.
Returns:

dict
class pytan3.api_objects.soap_7_2_314_3181.RowColumnList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Manually defined API array object.

API_NAME = 'rc'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'row_columns'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of RowColumn

api_coerce_items_hook(attr, value, op)[source]

Check hook that allows subclasses to modify list items.

Parameters:
  • attr (str) – Attribute being set on this object.
  • value (ApiList or list or tuple) – The list object holding items.
  • op (str) – Operation being performed that called this method.

Examples

This converts all “v” attributes of each column for this row into a list of dicts:

>>> # single value columns "v" is a single dict:
>>> {"v": {"h": "", "text": ""}}
>>> # multiple value columns "v" is a list of dict:
>>> {"v": [{"h": "", "text": ""}, {"h": "", "text": ""}]}
>>> # Count columns "v" is a string:
>>> {"v": "1"}
>>> # all become:
>>> {"v": [{"text": "", "hash": ""}]}

Notes

The driving force behind this is basically just the Count column. It returns a string of the value, instead of a dict or a list of dicts.

Returns:The list of items modified or as is.
Return type:list
class pytan3.api_objects.soap_7_2_314_3181.RowColumn(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Manually defined API array object.

API_COLUMN = None

Column – Index correlated column, set by ResultSet.__init__().

API_IDX = None

int – Index of this object in RowColumnList.

API_NAME = 'row_column'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['name', 'hash', 'result_type']

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'v'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of RowValue

name

Expose column name from API_COLUMN.

Returns:str
result_type

Expose column result type from API_COLUMN.

Returns:str
hash

Expose column sensor hash from API_COLUMN.

Returns:str
get_values(attr='value', join=None)[source]

Get all values from this row column.

Parameters:
  • attr (str, optional) –

    Attribute to get values of.

    Defaults to: “value”.

  • join (str, optional) –

    String to join multi value columns.

    Defaults to: None.
Returns:

list or str
class pytan3.api_objects.soap_7_2_314_3181.RowValue(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Manually defined API object.

API_NAME = 'v'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'h': (<class 'int'>,), 'text': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['hash', 'value']

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of RowColumn

API_LIST_API_NAME = 'row_column'

str – Name of API_LIST_CLS used in API calls.

hash

Expose simple attr “h” as hash.

Returns:str
value

Expose simple attr “text” as value.

Returns:str
class pytan3.api_objects.soap_7_2_314_3181.SensorQuery(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'sensor_query'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_query'

str – Name of object in source file.

API_SIMPLE = {'platform': (<class 'str'>,), 'script': (<class 'str'>,), 'script_type': (<class 'str'>,), 'signature': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SensorQueryList

API_LIST_API_NAME = 'sensor_querys'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.SensorSubcolumn(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'sensor_subcolumn'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_subcolumn'

str – Name of object in source file.

API_SIMPLE = {'exclude_from_parse_flag': (<class 'int'>,), 'hidden_flag': (<class 'int'>,), 'ignore_case_flag': (<class 'int'>,), 'index': (<class 'int'>,), 'name': (<class 'str'>,), 'value_type': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SensorSubcolumnList

API_LIST_API_NAME = 'sensor_subcolumns'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.SensorStat(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'sensor_stat'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_stat'

str – Name of object in source file.

API_SIMPLE = {'count': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'other_bytes_avg': (<class 'float'>,), 'other_bytes_std': (<class 'float'>,), 'read_bytes_avg': (<class 'float'>,), 'read_bytes_std': (<class 'float'>,), 'real_ms_avg': (<class 'float'>,), 'real_ms_max': (<class 'float'>,), 'real_ms_min': (<class 'float'>,), 'real_ms_std': (<class 'float'>,), 'sys_ms_avg': (<class 'float'>,), 'sys_ms_std': (<class 'float'>,), 'user_ms_avg': (<class 'float'>,), 'user_ms_std': (<class 'float'>,), 'what_hash': (<class 'int'>,), 'write_bytes_avg': (<class 'float'>,), 'write_bytes_std': (<class 'float'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SensorStatList

API_LIST_API_NAME = 'sensor_stats'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.SavedActionPolicy(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'saved_action_policy'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_action_policy'

str – Name of object in source file.

API_SIMPLE = {'max_age': (<class 'int'>,), 'min_count': (<class 'int'>,), 'row_filter_group_id': (<class 'int'>,), 'saved_question_group_id': (<class 'int'>,), 'saved_question_id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'row_filter_group': <class 'pytan3.api_objects.soap_7_2_314_3181.Group'>, 'saved_question_group': <class 'pytan3.api_objects.soap_7_2_314_3181.Group'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.SavedActionApproval(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'saved_action_approval'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_action_approval'

str – Name of object in source file.

API_SIMPLE = {'approved_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'owner_user_id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'metadata': <class 'pytan3.api_objects.soap_7_2_314_3181.MetadataList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SavedActionApprovalList

API_LIST_API_NAME = 'saved_action_approvals'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.SavedAction(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'saved_action'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_action'

str – Name of object in source file.

API_SIMPLE = {'action_group_id': (<class 'int'>,), 'approved_flag': (<class 'int'>,), 'cache_row_id': (<class 'int'>,), 'comment': (<class 'str'>,), 'creation_time': (<class 'str'>,), 'distribute_seconds': (<class 'int'>,), 'end_time': (<class 'str'>,), 'expire_seconds': (<class 'int'>,), 'id': (<class 'int'>,), 'issue_count': (<class 'int'>,), 'issue_seconds': (<class 'int'>,), 'last_start_time': (<class 'str'>,), 'name': (<class 'str'>,), 'next_start_time': (<class 'str'>,), 'policy_flag': (<class 'int'>,), 'public_flag': (<class 'int'>,), 'start_time': (<class 'str'>,), 'status': (<class 'int'>,), 'user_start_time': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'action_group': <class 'pytan3.api_objects.soap_7_2_314_3181.Group'>, 'approver': <class 'pytan3.api_objects.soap_7_2_314_3181.User'>, 'last_action': <class 'pytan3.api_objects.soap_7_2_314_3181.Action'>, 'metadata': <class 'pytan3.api_objects.soap_7_2_314_3181.MetadataList'>, 'package_spec': <class 'pytan3.api_objects.soap_7_2_314_3181.PackageSpec'>, 'policy': <class 'pytan3.api_objects.soap_7_2_314_3181.SavedActionPolicy'>, 'row_ids': <class 'pytan3.api_objects.soap_7_2_314_3181.SavedActionRowIdList'>, 'target_group': <class 'pytan3.api_objects.soap_7_2_314_3181.Group'>, 'user': <class 'pytan3.api_objects.soap_7_2_314_3181.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SavedActionList

API_LIST_API_NAME = 'saved_actions'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.Sensor(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'sensor'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor'

str – Name of object in source file.

API_SIMPLE = {'cache_row_id': (<class 'int'>,), 'category': (<class 'str'>,), 'creation_time': (<class 'str'>,), 'deleted_flag': (<class 'int'>,), 'delimiter': (<class 'str'>,), 'description': (<class 'str'>,), 'exclude_from_parse_flag': (<class 'int'>,), 'hash': (<class 'int'>,), 'hidden_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'ignore_case_flag': (<class 'int'>,), 'keep_duplicates_flag': (<class 'int'>,), 'last_modified_by': (<class 'str'>,), 'max_age_seconds': (<class 'int'>,), 'modification_time': (<class 'str'>,), 'name': (<class 'str'>,), 'parameter_definition': (<class 'str'>,), 'preview_sensor_flag': (<class 'int'>,), 'source_hash': (<class 'int'>,), 'source_id': (<class 'int'>,), 'source_name': (<class 'str'>,), 'string_count': (<class 'int'>,), 'value_type': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set': <class 'pytan3.api_objects.soap_7_2_314_3181.IdReference'>, 'metadata': <class 'pytan3.api_objects.soap_7_2_314_3181.MetadataList'>, 'mod_user': <class 'pytan3.api_objects.soap_7_2_314_3181.User'>, 'parameters': <class 'pytan3.api_objects.soap_7_2_314_3181.ParameterList'>, 'queries': <class 'pytan3.api_objects.soap_7_2_314_3181.SensorQueryList'>, 'string_hints': <class 'pytan3.api_objects.soap_7_2_314_3181.StringHintList'>, 'subcolumns': <class 'pytan3.api_objects.soap_7_2_314_3181.SensorSubcolumnList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {'BES_DATETIME_RESULT': 4, 'BES_SENSOR': 2, 'DATASIZE_RESULT': 8, 'HASH_RESULT': 0, 'IP_RESULT': 5, 'JS_SENSOR': 7, 'MULTITYPE_SENSOR': 6, 'NUMERIC_INTEGER_RESULT': 9, 'NUMERIC_RESULT': 3, 'PSHELL_SENSOR': 5, 'PY_SENSOR': 8, 'REGEX_RESULT': 11, 'TEXT_RESULT': 1, 'TIMEDIFF_REUSLT': 7, 'VBS_SENSOR': 4, 'VERSION_RESULT': 2, 'WMI_DATETIME_RESULT': 6, 'WMI_SENSOR': 1}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SensorList

API_LIST_API_NAME = 'sensors'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.AuditData(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'audit_data'

str – Name of object used in API calls.

API_NAME_SRC = 'audit_data'

str – Name of object in source file.

API_SIMPLE = {'cache_row_id': (<class 'int'>,), 'creation_time': (<class 'str'>,), 'details': (<class 'str'>,), 'last_modified_by': (<class 'str'>,), 'modification_time': (<class 'str'>,), 'modifier_user_id': (<class 'int'>,), 'object_id': (<class 'int'>,), 'type': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'mod_user': <class 'pytan3.api_objects.soap_7_2_314_3181.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of AuditDataList

API_LIST_API_NAME = 'audit_datas'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.AuditLog(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'audit_log'

str – Name of object used in API calls.

API_NAME_SRC = 'audit_log'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,), 'type': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'entries': <class 'pytan3.api_objects.soap_7_2_314_3181.AuditDataList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of AuditLogList

API_LIST_API_NAME = 'audit_logs'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.MetadataItem(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'metadata_item'

str – Name of object used in API calls.

API_NAME_SRC = 'metadata_item'

str – Name of object in source file.

API_SIMPLE = {'admin_flag': (<class 'int'>,), 'name': (<class 'str'>,), 'value': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of MetadataList

API_LIST_API_NAME = 'metadatas'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.Filter(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'filter'

str – Name of object used in API calls.

API_NAME_SRC = 'filter'

str – Name of object in source file.

API_SIMPLE = {'aggregation': (<class 'str'>,), 'all_times_flag': (<class 'int'>,), 'all_values_flag': (<class 'int'>,), 'delimiter': (<class 'str'>,), 'delimiter_index': (<class 'int'>,), 'end_time': (<class 'str'>,), 'id': (<class 'int'>,), 'ignore_case_flag': (<class 'int'>,), 'max_age_seconds': (<class 'int'>,), 'not_flag': (<class 'int'>,), 'operator': (<class 'str'>,), 'start_time': (<class 'str'>,), 'substring_flag': (<class 'int'>,), 'substring_length': (<class 'int'>,), 'substring_start': (<class 'int'>,), 'utf8_flag': (<class 'int'>,), 'value': (<class 'str'>,), 'value_type': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'sensor': <class 'pytan3.api_objects.soap_7_2_314_3181.Sensor'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of FilterList

API_LIST_API_NAME = 'filters'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.IdReference(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'id_reference'

str – Name of object used in API calls.

API_NAME_SRC = 'id_reference'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,), 'name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.Group(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'group'

str – Name of object used in API calls.

API_NAME_SRC = 'group'

str – Name of object in source file.

API_SIMPLE = {'and_flag': (<class 'int'>,), 'deleted_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'not_flag': (<class 'int'>,), 'saved_question_id': (<class 'int'>,), 'source_id': (<class 'int'>,), 'text': (<class 'str'>,), 'track_computer_id_flag': (<class 'int'>,), 'track_computer_id_interval': (<class 'int'>,), 'type': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'filters': <class 'pytan3.api_objects.soap_7_2_314_3181.FilterList'>, 'parameters': <class 'pytan3.api_objects.soap_7_2_314_3181.ParameterList'>, 'sub_groups': <class 'pytan3.api_objects.soap_7_2_314_3181.GroupList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of GroupList

API_LIST_API_NAME = 'groups'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.Select(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'select'

str – Name of object used in API calls.

API_NAME_SRC = 'select'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'filter': <class 'pytan3.api_objects.soap_7_2_314_3181.Filter'>, 'group': <class 'pytan3.api_objects.soap_7_2_314_3181.Group'>, 'sensor': <class 'pytan3.api_objects.soap_7_2_314_3181.Sensor'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SelectList

API_LIST_API_NAME = 'selects'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.XmlError(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'xml_error'

str – Name of object used in API calls.

API_NAME_SRC = 'xml_error'

str – Name of object in source file.

API_SIMPLE = {'error_context': (<class 'str'>,), 'exception': (<class 'str'>,), 'type': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ErrorList

API_LIST_API_NAME = 'errors'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.CacheInfo(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'cache_info'

str – Name of object used in API calls.

API_NAME_SRC = 'cache_info'

str – Name of object in source file.

API_SIMPLE = {'cache_id': (<class 'int'>,), 'cache_row_count': (<class 'int'>,), 'expiration': (<class 'str'>,), 'filtered_row_count': (<class 'int'>,), 'page_row_count': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'errors': <class 'pytan3.api_objects.soap_7_2_314_3181.ErrorList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.QuestionListInfo(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'question_list_info'

str – Name of object used in API calls.

API_NAME_SRC = 'question_list_info'

str – Name of object in source file.

API_SIMPLE = {'highest_id': (<class 'int'>,), 'total_count': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.Question(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'question'

str – Name of object used in API calls.

API_NAME_SRC = 'question'

str – Name of object in source file.

API_SIMPLE = {'action_tracking_flag': (<class 'int'>,), 'cache_row_id': (<class 'int'>,), 'expiration': (<class 'str'>,), 'expire_seconds': (<class 'int'>,), 'force_computer_id_flag': (<class 'int'>,), 'from_canonical_text': (<class 'int'>,), 'hidden_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'index': (<class 'int'>,), 'is_expired': (<class 'int'>,), 'name': (<class 'str'>,), 'query_text': (<class 'str'>,), 'skip_lock_flag': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'context_group': <class 'pytan3.api_objects.soap_7_2_314_3181.Group'>, 'group': <class 'pytan3.api_objects.soap_7_2_314_3181.Group'>, 'management_rights_group': <class 'pytan3.api_objects.soap_7_2_314_3181.Group'>, 'saved_question': <class 'pytan3.api_objects.soap_7_2_314_3181.SavedQuestion'>, 'selects': <class 'pytan3.api_objects.soap_7_2_314_3181.SelectList'>, 'user': <class 'pytan3.api_objects.soap_7_2_314_3181.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of QuestionList

API_LIST_API_NAME = 'questions'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.PackageFileTemplate(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'package_file_template'

str – Name of object used in API calls.

API_NAME_SRC = 'package_file_template'

str – Name of object in source file.

API_SIMPLE = {'download_seconds': (<class 'int'>,), 'hash': (<class 'str'>,), 'name': (<class 'str'>,), 'source': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of PackageFileTemplateList

API_LIST_API_NAME = 'package_file_templates'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.PackageFileStatus(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'package_file_status'

str – Name of object used in API calls.

API_NAME_SRC = 'package_file_status'

str – Name of object in source file.

API_SIMPLE = {'bytes_downloaded': (<class 'int'>,), 'bytes_total': (<class 'int'>,), 'cache_message': (<class 'str'>,), 'cache_status': (<class 'str'>,), 'download_start_time': (<class 'str'>,), 'last_download_progress_time': (<class 'str'>,), 'server_id': (<class 'int'>,), 'server_name': (<class 'str'>,), 'status': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of PackageFileStatusList

API_LIST_API_NAME = 'package_file_statuss'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.PackageFile(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'package_file'

str – Name of object used in API calls.

API_NAME_SRC = 'package_file'

str – Name of object in source file.

API_SIMPLE = {'bytes_downloaded': (<class 'int'>,), 'bytes_total': (<class 'int'>,), 'cache_status': (<class 'str'>,), 'deleted_flag': (<class 'int'>,), 'download_seconds': (<class 'int'>,), 'download_start_time': (<class 'str'>,), 'hash': (<class 'str'>,), 'id': (<class 'int'>,), 'last_download_progress_time': (<class 'str'>,), 'name': (<class 'str'>,), 'size': (<class 'int'>,), 'source': (<class 'str'>,), 'status': (<class 'int'>,), 'trigger_download': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'file_status': <class 'pytan3.api_objects.soap_7_2_314_3181.PackageFileStatusList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of PackageFileList

API_LIST_API_NAME = 'package_files'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.PackageSpec(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'package_spec'

str – Name of object used in API calls.

API_NAME_SRC = 'package_spec'

str – Name of object in source file.

API_SIMPLE = {'available_time': (<class 'str'>,), 'cache_row_id': (<class 'int'>,), 'command': (<class 'str'>,), 'command_timeout': (<class 'int'>,), 'creation_time': (<class 'str'>,), 'deleted_flag': (<class 'int'>,), 'display_name': (<class 'str'>,), 'expire_seconds': (<class 'int'>,), 'hidden_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'last_modified_by': (<class 'str'>,), 'last_update': (<class 'str'>,), 'modification_time': (<class 'str'>,), 'name': (<class 'str'>,), 'parameter_definition': (<class 'str'>,), 'process_group_flag': (<class 'int'>,), 'signature': (<class 'str'>,), 'skip_lock_flag': (<class 'int'>,), 'source_hash': (<class 'str'>,), 'source_hash_changed_flag': (<class 'int'>,), 'source_id': (<class 'int'>,), 'source_name': (<class 'str'>,), 'verify_expire_seconds': (<class 'int'>,), 'verify_group_id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set': <class 'pytan3.api_objects.soap_7_2_314_3181.IdReference'>, 'file_templates': <class 'pytan3.api_objects.soap_7_2_314_3181.PackageFileTemplateList'>, 'files': <class 'pytan3.api_objects.soap_7_2_314_3181.PackageFileList'>, 'metadata': <class 'pytan3.api_objects.soap_7_2_314_3181.MetadataList'>, 'mod_user': <class 'pytan3.api_objects.soap_7_2_314_3181.User'>, 'parameters': <class 'pytan3.api_objects.soap_7_2_314_3181.ParameterList'>, 'sensors': <class 'pytan3.api_objects.soap_7_2_314_3181.SensorList'>, 'verify_group': <class 'pytan3.api_objects.soap_7_2_314_3181.Group'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of PackageSpecList

API_LIST_API_NAME = 'package_specs'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.ClientStatus(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'client_status'

str – Name of object used in API calls.

API_NAME_SRC = 'client_status'

str – Name of object in source file.

API_SIMPLE = {'cache_row_id': (<class 'int'>,), 'computer_id': (<class 'str'>,), 'full_version': (<class 'str'>,), 'host_name': (<class 'str'>,), 'ipaddress_client': (<class 'str'>,), 'ipaddress_server': (<class 'str'>,), 'last_registration': (<class 'str'>,), 'port_number': (<class 'int'>,), 'protocol_version': (<class 'int'>,), 'public_key_valid': (<class 'int'>,), 'receive_state': (<class 'str'>,), 'registered_with_tls': (<class 'int'>,), 'send_state': (<class 'str'>,), 'status': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SystemStatusList

API_LIST_API_NAME = 'system_status'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.SystemSetting(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'system_setting'

str – Name of object used in API calls.

API_NAME_SRC = 'system_setting'

str – Name of object in source file.

API_SIMPLE = {'cache_row_id': (<class 'int'>,), 'default_value': (<class 'str'>,), 'hidden_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'read_only_flag': (<class 'int'>,), 'setting_type': (<class 'str'>,), 'value': (<class 'str'>,), 'value_type': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'audit_data': <class 'pytan3.api_objects.soap_7_2_314_3181.AuditData'>, 'metadata': <class 'pytan3.api_objects.soap_7_2_314_3181.MetadataList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SystemSettingList

API_LIST_API_NAME = 'system_settings'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.SoapError(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'soap_error'

str – Name of object used in API calls.

API_NAME_SRC = 'soap_error'

str – Name of object in source file.

API_SIMPLE = {'context': (<class 'str'>,), 'exception_name': (<class 'str'>,), 'object_name': (<class 'str'>,), 'object_request': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.WhiteListedUrl(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'white_listed_url'

str – Name of object used in API calls.

API_NAME_SRC = 'white_listed_url'

str – Name of object in source file.

API_SIMPLE = {'chunk_id': (<class 'str'>,), 'download_seconds': (<class 'int'>,), 'expire_seconds': (<class 'int'>,), 'id': (<class 'int'>,), 'url_regex': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'metadata': <class 'pytan3.api_objects.soap_7_2_314_3181.MetadataList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of WhiteListedUrlList

API_LIST_API_NAME = 'white_listed_urls'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.VersionAggregate(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'version_aggregate'

str – Name of object used in API calls.

API_NAME_SRC = 'version_aggregate'

str – Name of object in source file.

API_SIMPLE = {'count': (<class 'int'>,), 'filtered': (<class 'int'>,), 'version_string': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of VersionAggregateList

API_LIST_API_NAME = 'version_aggregates'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.SystemStatusAggregate(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'system_status_aggregate'

str – Name of object used in API calls.

API_NAME_SRC = 'system_status_aggregate'

str – Name of object in source file.

API_SIMPLE = {'blocked_count': (<class 'int'>,), 'leader_count': (<class 'int'>,), 'normal_count': (<class 'int'>,), 'receive_backward_count': (<class 'int'>,), 'receive_forward_count': (<class 'int'>,), 'receive_none_count': (<class 'int'>,), 'receive_ok_count': (<class 'int'>,), 'registered_with_tls_count': (<class 'int'>,), 'send_backward_count': (<class 'int'>,), 'send_forward_count': (<class 'int'>,), 'send_none_count': (<class 'int'>,), 'send_ok_count': (<class 'int'>,), 'slowlink_count': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'versions': <class 'pytan3.api_objects.soap_7_2_314_3181.VersionAggregateList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.UserRole(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'user_role'

str – Name of object used in API calls.

API_NAME_SRC = 'user_role'

str – Name of object in source file.

API_SIMPLE = {'description': (<class 'str'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'permissions': <class 'pytan3.api_objects.soap_7_2_314_3181.PermissionList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of UserRoleList

API_LIST_API_NAME = 'roles'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.UserOwnedObjectIds(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'user_owned_object_ids'

str – Name of object used in API calls.

API_NAME_SRC = 'user_owned_object_ids'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'plugin_schedules': <class 'pytan3.api_objects.soap_7_2_314_3181.PluginScheduleList'>, 'saved_actions': <class 'pytan3.api_objects.soap_7_2_314_3181.SavedActionList'>, 'saved_questions': <class 'pytan3.api_objects.soap_7_2_314_3181.SavedQuestionList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.User(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'user'

str – Name of object used in API calls.

API_NAME_SRC = 'user'

str – Name of object in source file.

API_SIMPLE = {'active_session_count': (<class 'int'>,), 'deleted_flag': (<class 'int'>,), 'display_name': (<class 'str'>,), 'domain': (<class 'str'>,), 'effective_group_id': (<class 'int'>,), 'external_flag': (<class 'int'>,), 'group_id': (<class 'int'>,), 'id': (<class 'int'>,), 'last_login': (<class 'str'>,), 'local_admin_flag': (<class 'int'>,), 'locked_out': (<class 'int'>,), 'name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set_roles': <class 'pytan3.api_objects.soap_7_2_314_3181.ContentSetRoleList'>, 'effective_content_set_privileges': <class 'pytan3.api_objects.soap_7_2_314_3181.EffectiveContentSetPrivilegeList'>, 'metadata': <class 'pytan3.api_objects.soap_7_2_314_3181.MetadataList'>, 'owned_object_ids': <class 'pytan3.api_objects.soap_7_2_314_3181.UserOwnedObjectIds'>, 'permissions': <class 'pytan3.api_objects.soap_7_2_314_3181.PermissionList'>, 'roles': <class 'pytan3.api_objects.soap_7_2_314_3181.UserRoleList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of UserList

API_LIST_API_NAME = 'users'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.ActionListInfo(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'action_list_info'

str – Name of object used in API calls.

API_NAME_SRC = 'action_list_info'

str – Name of object in source file.

API_SIMPLE = {'highest_id': (<class 'int'>,), 'total_count': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.Action(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'action'

str – Name of object used in API calls.

API_NAME_SRC = 'action'

str – Name of object in source file.

API_SIMPLE = {'cache_row_id': (<class 'int'>,), 'comment': (<class 'str'>,), 'creation_time': (<class 'str'>,), 'distribute_seconds': (<class 'int'>,), 'expiration_time': (<class 'str'>,), 'expire_seconds': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'skip_lock_flag': (<class 'int'>,), 'start_time': (<class 'str'>,), 'status': (<class 'str'>,), 'stopped_flag': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'action_group': <class 'pytan3.api_objects.soap_7_2_314_3181.Group'>, 'approver': <class 'pytan3.api_objects.soap_7_2_314_3181.User'>, 'history_saved_question': <class 'pytan3.api_objects.soap_7_2_314_3181.SavedQuestion'>, 'metadata': <class 'pytan3.api_objects.soap_7_2_314_3181.MetadataList'>, 'package_spec': <class 'pytan3.api_objects.soap_7_2_314_3181.PackageSpec'>, 'saved_action': <class 'pytan3.api_objects.soap_7_2_314_3181.SavedAction'>, 'target_group': <class 'pytan3.api_objects.soap_7_2_314_3181.Group'>, 'user': <class 'pytan3.api_objects.soap_7_2_314_3181.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ActionList

API_LIST_API_NAME = 'actions'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.ActionStop(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'action_stop'

str – Name of object used in API calls.

API_NAME_SRC = 'action_stop'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'action': <class 'pytan3.api_objects.soap_7_2_314_3181.Action'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ActionStopList

API_LIST_API_NAME = 'action_stops'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.ArchivedQuestion(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'archived_question'

str – Name of object used in API calls.

API_NAME_SRC = 'archived_question'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ArchivedQuestionList

API_LIST_API_NAME = 'archived_questions'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.SavedQuestion(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'saved_question'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_question'

str – Name of object in source file.

API_SIMPLE = {'action_tracking_flag': (<class 'int'>,), 'archive_enabled_flag': (<class 'int'>,), 'cache_row_id': (<class 'int'>,), 'deleted_flag': (<class 'int'>,), 'expire_seconds': (<class 'int'>,), 'hidden_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'index': (<class 'int'>,), 'issue_seconds': (<class 'int'>,), 'issue_seconds_never_flag': (<class 'int'>,), 'keep_seconds': (<class 'int'>,), 'mod_time': (<class 'str'>,), 'most_recent_question_id': (<class 'int'>,), 'name': (<class 'str'>,), 'public_flag': (<class 'int'>,), 'query_text': (<class 'str'>,), 'row_count_flag': (<class 'int'>,), 'skip_schedule_on_update_flag': (<class 'int'>,), 'sort_column': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'archive_owner': <class 'pytan3.api_objects.soap_7_2_314_3181.User'>, 'content_set': <class 'pytan3.api_objects.soap_7_2_314_3181.IdReference'>, 'metadata': <class 'pytan3.api_objects.soap_7_2_314_3181.MetadataList'>, 'mod_user': <class 'pytan3.api_objects.soap_7_2_314_3181.User'>, 'packages': <class 'pytan3.api_objects.soap_7_2_314_3181.PackageSpecList'>, 'question': <class 'pytan3.api_objects.soap_7_2_314_3181.Question'>, 'user': <class 'pytan3.api_objects.soap_7_2_314_3181.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SavedQuestionList

API_LIST_API_NAME = 'saved_questions'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.ParseJob(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'parse_job'

str – Name of object used in API calls.

API_NAME_SRC = 'parse_job'

str – Name of object in source file.

API_SIMPLE = {'parser_version': (<class 'int'>,), 'question_text': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ParseJobList

API_LIST_API_NAME = 'parse_jobs'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.Parameter(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'parameter'

str – Name of object used in API calls.

API_NAME_SRC = 'parameter'

str – Name of object in source file.

API_SIMPLE = {'key': (<class 'str'>,), 'type': (<class 'int'>,), 'value': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ParameterList

API_LIST_API_NAME = 'parameters'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.ParseResult(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'parse_result'

str – Name of object used in API calls.

API_NAME_SRC = 'parse_result'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,), 'parameter_definition': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'parameters': <class 'pytan3.api_objects.soap_7_2_314_3181.ParameterList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ParseResultList

API_LIST_API_NAME = 'parse_results'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.SensorReference(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'sensor_reference'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_reference'

str – Name of object in source file.

API_SIMPLE = {'name': (<class 'str'>,), 'real_ms_avg': (<class 'int'>,), 'start_char': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SensorReferenceList

API_LIST_API_NAME = 'sensor_references'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.ParseResultGroup(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'parse_result_group'

str – Name of object used in API calls.

API_NAME_SRC = 'parse_result_group'

str – Name of object in source file.

API_SIMPLE = {'question_text': (<class 'str'>,), 'score': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'parameter_values': <class 'pytan3.api_objects.soap_7_2_314_3181.ParameterValueList'>, 'parse_results': <class 'pytan3.api_objects.soap_7_2_314_3181.ParseResultList'>, 'question': <class 'pytan3.api_objects.soap_7_2_314_3181.Question'>, 'question_group_sensors': <class 'pytan3.api_objects.soap_7_2_314_3181.SensorList'>, 'sensor_references': <class 'pytan3.api_objects.soap_7_2_314_3181.SensorReferenceList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ParseResultGroupList

API_LIST_API_NAME = 'parse_result_groups'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.ClientCount(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'client_count'

str – Name of object used in API calls.

API_NAME_SRC = 'client_count'

str – Name of object in source file.

API_SIMPLE = {'count': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.PluginArgument(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'plugin_argument'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_argument'

str – Name of object in source file.

API_SIMPLE = {'name': (<class 'str'>,), 'type': (<class 'str'>,), 'value': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of PluginArgumentList

API_LIST_API_NAME = 'plugin_arguments'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.UploadFile(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'upload_file'

str – Name of object used in API calls.

API_NAME_SRC = 'upload_file'

str – Name of object in source file.

API_SIMPLE = {'bytes': (<class 'str'>,), 'destination_file': (<class 'str'>,), 'file_cached': (<class 'int'>,), 'file_size': (<class 'int'>,), 'force_overwrite': (<class 'int'>,), 'hash': (<class 'str'>,), 'id': (<class 'int'>,), 'key': (<class 'str'>,), 'part_size': (<class 'int'>,), 'percent_complete': (<class 'int'>,), 'start_pos': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of UploadFileList

API_LIST_API_NAME = 'upload_files'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.UploadFileStatus(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'upload_file_status'

str – Name of object used in API calls.

API_NAME_SRC = 'upload_file_status'

str – Name of object in source file.

API_SIMPLE = {'file_cached': (<class 'int'>,), 'hash': (<class 'str'>,), 'percent_complete': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'file_parts': <class 'pytan3.api_objects.soap_7_2_314_3181.UploadFileList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.Plugin(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'plugin'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin'

str – Name of object in source file.

API_SIMPLE = {'allow_rest': (<class 'int'>,), 'bundle': (<class 'str'>,), 'cache_row_id': (<class 'int'>,), 'execution_id': (<class 'int'>,), 'exit_code': (<class 'int'>,), 'filename': (<class 'str'>,), 'input': (<class 'str'>,), 'local_admin_flag': (<class 'int'>,), 'name': (<class 'str'>,), 'path': (<class 'str'>,), 'plugin_server': (<class 'str'>,), 'plugin_url': (<class 'str'>,), 'raw_http_request': (<class 'int'>,), 'raw_http_response': (<class 'int'>,), 'run_detached_flag': (<class 'int'>,), 'script_response': (<class 'str'>,), 'status': (<class 'str'>,), 'status_file_content': (<class 'str'>,), 'timeout_seconds': (<class 'int'>,), 'type': (<class 'str'>,), 'use_json_flag': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'arguments': <class 'pytan3.api_objects.soap_7_2_314_3181.PluginArgumentList'>, 'commands': <class 'pytan3.api_objects.soap_7_2_314_3181.PluginCommandList'>, 'content_set': <class 'pytan3.api_objects.soap_7_2_314_3181.ContentSet'>, 'metadata': <class 'pytan3.api_objects.soap_7_2_314_3181.MetadataList'>, 'permissions': <class 'pytan3.api_objects.soap_7_2_314_3181.PermissionList'>, 'sql_response': <class 'pytan3.api_objects.soap_7_2_314_3181.PluginSql'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {'SCRIPT': 'Script', 'SQL': 'SQL'}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of PluginList

API_LIST_API_NAME = 'plugins'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.PluginSchedule(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'plugin_schedule'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_schedule'

str – Name of object in source file.

API_SIMPLE = {'deleted_flag': (<class 'int'>,), 'enabled': (<class 'int'>,), 'end_date': (<class 'str'>,), 'end_hour': (<class 'int'>,), 'id': (<class 'int'>,), 'input': (<class 'str'>,), 'last_exit_code': (<class 'int'>,), 'last_run_text': (<class 'str'>,), 'last_run_time': (<class 'str'>,), 'modification_time': (<class 'str'>,), 'name': (<class 'str'>,), 'plugin_bundle': (<class 'str'>,), 'plugin_name': (<class 'str'>,), 'plugin_server': (<class 'str'>,), 'run_interval_seconds': (<class 'int'>,), 'run_on_days': (<class 'str'>,), 'start_date': (<class 'str'>,), 'start_hour': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'arguments': <class 'pytan3.api_objects.soap_7_2_314_3181.PluginArgumentList'>, 'last_run_sql': <class 'pytan3.api_objects.soap_7_2_314_3181.PluginSql'>, 'mod_user': <class 'pytan3.api_objects.soap_7_2_314_3181.User'>, 'user': <class 'pytan3.api_objects.soap_7_2_314_3181.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of PluginScheduleList

API_LIST_API_NAME = 'plugin_schedules'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.ComputerGroupSpec(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'computer_group_spec'

str – Name of object used in API calls.

API_NAME_SRC = 'computer_group_spec'

str – Name of object in source file.

API_SIMPLE = {'computer_name': (<class 'str'>,), 'id': (<class 'int'>,), 'ip_address': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ComputerSpecList

API_LIST_API_NAME = 'computer_specs'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.ComputerGroup(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'computer_group'

str – Name of object used in API calls.

API_NAME_SRC = 'computer_group'

str – Name of object in source file.

API_SIMPLE = {'deleted_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'computer_specs': <class 'pytan3.api_objects.soap_7_2_314_3181.ComputerSpecList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ComputerGroupList

API_LIST_API_NAME = 'computer_groups'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.ObjectList(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'object_list'

str – Name of object used in API calls.

API_NAME_SRC = 'object_list'

str – Name of object in source file.

API_SIMPLE = {'export_id': (<class 'str'>,), 'export_version': (<class 'int'>,), 'import_conflict_detail': (<class 'str'>,), 'import_content': (<class 'str'>,), 'server_info': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'action': <class 'pytan3.api_objects.soap_7_2_314_3181.Action'>, 'action_group': <class 'pytan3.api_objects.soap_7_2_314_3181.ActionGroup'>, 'action_groups': <class 'pytan3.api_objects.soap_7_2_314_3181.ActionGroupList'>, 'action_stop': <class 'pytan3.api_objects.soap_7_2_314_3181.ActionStop'>, 'action_stops': <class 'pytan3.api_objects.soap_7_2_314_3181.ActionStopList'>, 'actions': <class 'pytan3.api_objects.soap_7_2_314_3181.ActionList'>, 'archived_question': <class 'pytan3.api_objects.soap_7_2_314_3181.ArchivedQuestion'>, 'archived_questions': <class 'pytan3.api_objects.soap_7_2_314_3181.ArchivedQuestionList'>, 'audit_log': <class 'pytan3.api_objects.soap_7_2_314_3181.AuditLog'>, 'audit_logs': <class 'pytan3.api_objects.soap_7_2_314_3181.AuditLogList'>, 'client_count': <class 'pytan3.api_objects.soap_7_2_314_3181.ClientCount'>, 'client_status': <class 'pytan3.api_objects.soap_7_2_314_3181.ClientStatus'>, 'computer_group': <class 'pytan3.api_objects.soap_7_2_314_3181.ComputerGroup'>, 'computer_groups': <class 'pytan3.api_objects.soap_7_2_314_3181.ComputerGroupList'>, 'content_set': <class 'pytan3.api_objects.soap_7_2_314_3181.ContentSet'>, 'content_set_privilege': <class 'pytan3.api_objects.soap_7_2_314_3181.ContentSetPrivilege'>, 'content_set_privileges': <class 'pytan3.api_objects.soap_7_2_314_3181.ContentSetPrivilegeList'>, 'content_set_role': <class 'pytan3.api_objects.soap_7_2_314_3181.ContentSetRole'>, 'content_set_role_membership': <class 'pytan3.api_objects.soap_7_2_314_3181.ContentSetRoleMembership'>, 'content_set_role_memberships': <class 'pytan3.api_objects.soap_7_2_314_3181.ContentSetRoleMembershipList'>, 'content_set_role_privilege': <class 'pytan3.api_objects.soap_7_2_314_3181.ContentSetRolePrivilege'>, 'content_set_role_privileges': <class 'pytan3.api_objects.soap_7_2_314_3181.ContentSetRolePrivilegeList'>, 'content_set_roles': <class 'pytan3.api_objects.soap_7_2_314_3181.ContentSetRoleList'>, 'content_set_user_group_role_membership': <class 'pytan3.api_objects.soap_7_2_314_3181.ContentSetUserGroupRoleMembership'>, 'content_set_user_group_role_memberships': <class 'pytan3.api_objects.soap_7_2_314_3181.ContentSetUserGroupRoleMembershipList'>, 'content_sets': <class 'pytan3.api_objects.soap_7_2_314_3181.ContentSetList'>, 'effective_content_set_privileges': <class 'pytan3.api_objects.soap_7_2_314_3181.EffectiveContentSetPrivilegeRequest'>, 'group': <class 'pytan3.api_objects.soap_7_2_314_3181.Group'>, 'groups': <class 'pytan3.api_objects.soap_7_2_314_3181.GroupList'>, 'hashed_string': <class 'pytan3.api_objects.soap_7_2_314_3181.HashedString'>, 'hashed_strings': <class 'pytan3.api_objects.soap_7_2_314_3181.HashedStringList'>, 'ldap_sync_connector': <class 'pytan3.api_objects.soap_7_2_314_3181.LdapSyncConnector'>, 'ldap_sync_connector_list': <class 'pytan3.api_objects.soap_7_2_314_3181.LdapSyncConnectorList'>, 'package_file': <class 'pytan3.api_objects.soap_7_2_314_3181.PackageFile'>, 'package_files': <class 'pytan3.api_objects.soap_7_2_314_3181.PackageFileList'>, 'package_spec': <class 'pytan3.api_objects.soap_7_2_314_3181.PackageSpec'>, 'package_specs': <class 'pytan3.api_objects.soap_7_2_314_3181.PackageSpecList'>, 'parse_job': <class 'pytan3.api_objects.soap_7_2_314_3181.ParseJob'>, 'parse_jobs': <class 'pytan3.api_objects.soap_7_2_314_3181.ParseJobList'>, 'parse_result_group': <class 'pytan3.api_objects.soap_7_2_314_3181.ParseResultGroup'>, 'parse_result_groups': <class 'pytan3.api_objects.soap_7_2_314_3181.ParseResultGroupList'>, 'plugin': <class 'pytan3.api_objects.soap_7_2_314_3181.Plugin'>, 'plugin_schedule': <class 'pytan3.api_objects.soap_7_2_314_3181.PluginSchedule'>, 'plugin_schedules': <class 'pytan3.api_objects.soap_7_2_314_3181.PluginScheduleList'>, 'plugins': <class 'pytan3.api_objects.soap_7_2_314_3181.PluginList'>, 'question': <class 'pytan3.api_objects.soap_7_2_314_3181.Question'>, 'questions': <class 'pytan3.api_objects.soap_7_2_314_3181.QuestionList'>, 'roles': <class 'pytan3.api_objects.soap_7_2_314_3181.UserRoleList'>, 'saved_action': <class 'pytan3.api_objects.soap_7_2_314_3181.SavedAction'>, 'saved_action_approval': <class 'pytan3.api_objects.soap_7_2_314_3181.SavedActionApproval'>, 'saved_action_approvals': <class 'pytan3.api_objects.soap_7_2_314_3181.SavedActionApprovalList'>, 'saved_actions': <class 'pytan3.api_objects.soap_7_2_314_3181.SavedActionList'>, 'saved_question': <class 'pytan3.api_objects.soap_7_2_314_3181.SavedQuestion'>, 'saved_question_package_specs': <class 'pytan3.api_objects.soap_7_2_314_3181.SavedQuestionPackageSpecs'>, 'saved_question_question': <class 'pytan3.api_objects.soap_7_2_314_3181.SavedQuestionQuestion'>, 'saved_question_questions': <class 'pytan3.api_objects.soap_7_2_314_3181.SavedQuestionQuestionList'>, 'saved_questions': <class 'pytan3.api_objects.soap_7_2_314_3181.SavedQuestionList'>, 'sensor': <class 'pytan3.api_objects.soap_7_2_314_3181.Sensor'>, 'sensor_stat': <class 'pytan3.api_objects.soap_7_2_314_3181.SensorStat'>, 'sensor_stats': <class 'pytan3.api_objects.soap_7_2_314_3181.SensorStatList'>, 'sensors': <class 'pytan3.api_objects.soap_7_2_314_3181.SensorList'>, 'soap_error': <class 'pytan3.api_objects.soap_7_2_314_3181.SoapError'>, 'solution': <class 'pytan3.api_objects.soap_7_2_314_3181.Solution'>, 'solutions': <class 'pytan3.api_objects.soap_7_2_314_3181.SolutionList'>, 'system_setting': <class 'pytan3.api_objects.soap_7_2_314_3181.SystemSetting'>, 'system_settings': <class 'pytan3.api_objects.soap_7_2_314_3181.SystemSettingList'>, 'system_status': <class 'pytan3.api_objects.soap_7_2_314_3181.SystemStatusList'>, 'upload_file': <class 'pytan3.api_objects.soap_7_2_314_3181.UploadFile'>, 'upload_file_status': <class 'pytan3.api_objects.soap_7_2_314_3181.UploadFileStatus'>, 'user': <class 'pytan3.api_objects.soap_7_2_314_3181.User'>, 'user_group': <class 'pytan3.api_objects.soap_7_2_314_3181.UserGroup'>, 'user_groups': <class 'pytan3.api_objects.soap_7_2_314_3181.UserGroupList'>, 'users': <class 'pytan3.api_objects.soap_7_2_314_3181.UserList'>, 'white_listed_url': <class 'pytan3.api_objects.soap_7_2_314_3181.WhiteListedUrl'>, 'white_listed_urls': <class 'pytan3.api_objects.soap_7_2_314_3181.WhiteListedUrlList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.CacheFilter(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'cache_filter'

str – Name of object used in API calls.

API_NAME_SRC = 'cache_filter'

str – Name of object in source file.

API_SIMPLE = {'and_flag': (<class 'int'>,), 'field': (<class 'str'>,), 'not_flag': (<class 'int'>,), 'operator': (<class 'str'>,), 'type': (<class 'str'>,), 'value': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'sub_filters': <class 'pytan3.api_objects.soap_7_2_314_3181.CacheFilterList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of CacheFilterList

API_LIST_API_NAME = 'cache_filters'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.Options(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'options'

str – Name of object used in API calls.

API_NAME_SRC = 'options'

str – Name of object in source file.

API_SIMPLE = {'aggregate_over_time_flag': (<class 'int'>,), 'allow_cdata_base64_encode_flag': (<class 'int'>,), 'audit_history_size': (<class 'int'>,), 'cache_expiration': (<class 'int'>,), 'cache_id': (<class 'int'>,), 'cache_sort_fields': (<class 'str'>,), 'cdata_base64_encoded': (<class 'int'>,), 'context_id': (<class 'int'>,), 'disable_live_snapshots': (<class 'int'>,), 'export_dont_include_related': (<class 'int'>,), 'export_flag': (<class 'int'>,), 'export_format': (<class 'int'>,), 'export_hide_csv_header_flag': (<class 'int'>,), 'export_leading_text': (<class 'str'>,), 'export_omit_soap_envelope': (<class 'int'>,), 'export_trailing_text': (<class 'str'>,), 'filter_not_flag': (<class 'int'>,), 'filter_string': (<class 'str'>,), 'flags': (<class 'int'>,), 'hide_errors_flag': (<class 'int'>,), 'hide_no_results_flag': (<class 'int'>,), 'import_analyze_conflicts_only': (<class 'int'>,), 'import_existing_ignore_content_set': (<class 'int'>,), 'include_answer_times_flag': (<class 'int'>,), 'include_hashes_flag': (<class 'int'>,), 'include_hidden_flag': (<class 'int'>,), 'include_user_details': (<class 'int'>,), 'include_user_owned_object_ids_flag': (<class 'int'>,), 'json_pretty_print': (<class 'int'>,), 'live_snapshot_always_use_seconds': (<class 'int'>,), 'live_snapshot_expiration_seconds': (<class 'int'>,), 'live_snapshot_invalidate_report_count_percentage': (<class 'int'>,), 'live_snapshot_report_count_threshold': (<class 'int'>,), 'most_recent_flag': (<class 'int'>,), 'no_result_row_collation_flag': (<class 'int'>,), 'pct_done_limit': (<class 'int'>,), 'recent_result_buckets': (<class 'str'>,), 'return_cdata_flag': (<class 'int'>,), 'return_lists_flag': (<class 'int'>,), 'row_count': (<class 'int'>,), 'row_counts_only_flag': (<class 'int'>,), 'row_start': (<class 'int'>,), 'sample_count': (<class 'int'>,), 'sample_frequency': (<class 'int'>,), 'sample_start': (<class 'int'>,), 'saved_question_qids_allow_multiple_flag': (<class 'int'>,), 'saved_question_qids_ignore_mr_group_flag': (<class 'int'>,), 'saved_question_qids_include_expired_flag': (<class 'int'>,), 'saved_question_qids_reissue_flag': (<class 'int'>,), 'script_data': (<class 'str'>,), 'sort_order': (<class 'str'>,), 'suppress_object_list': (<class 'int'>,), 'suppress_scripts': (<class 'int'>,), 'use_error_objects': (<class 'int'>,), 'use_json': (<class 'int'>,), 'use_user_context_flag': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_filters': <class 'pytan3.api_objects.soap_7_2_314_3181.CacheFilterList'>, 'import_conflict_options': <class 'pytan3.api_objects.soap_7_2_314_3181.ImportConflictOptions'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.ContentSet(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'content_set'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set'

str – Name of object in source file.

API_SIMPLE = {'description': (<class 'str'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'reserved_name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'metadata': <class 'pytan3.api_objects.soap_7_2_314_3181.MetadataList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ContentSetList

API_LIST_API_NAME = 'content_sets'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.ContentSetRolePrivilegeOnRole(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'content_set_role_privilege_on_role'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role_privilege_on_role'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set': <class 'pytan3.api_objects.soap_7_2_314_3181.IdReference'>, 'content_set_privilege': <class 'pytan3.api_objects.soap_7_2_314_3181.IdReference'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ContentSetRolePrivilegeOnRoleList

API_LIST_API_NAME = 'content_set_role_privilege_on_roles'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.ContentSetRole(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'content_set_role'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role'

str – Name of object in source file.

API_SIMPLE = {'all_content_sets_flag': (<class 'int'>,), 'category': (<class 'str'>,), 'deny_flag': (<class 'int'>,), 'description': (<class 'str'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'reserved_name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set_role_privileges': <class 'pytan3.api_objects.soap_7_2_314_3181.ContentSetRolePrivilegeOnRoleList'>, 'metadata': <class 'pytan3.api_objects.soap_7_2_314_3181.MetadataList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ContentSetRoleList

API_LIST_API_NAME = 'content_set_roles'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.ContentSetRoleMembership(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'content_set_role_membership'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role_membership'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set_role': <class 'pytan3.api_objects.soap_7_2_314_3181.IdReference'>, 'user': <class 'pytan3.api_objects.soap_7_2_314_3181.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ContentSetRoleMembershipList

API_LIST_API_NAME = 'content_set_role_memberships'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.ContentSetUserGroupRoleMembership(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'content_set_user_group_role_membership'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_user_group_role_membership'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set_role': <class 'pytan3.api_objects.soap_7_2_314_3181.IdReference'>, 'user_group': <class 'pytan3.api_objects.soap_7_2_314_3181.IdReference'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ContentSetUserGroupRoleMembershipList

API_LIST_API_NAME = 'content_set_user_group_role_memberships'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.ContentSetPrivilege(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'content_set_privilege'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_privilege'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,), 'name': (<class 'str'>,), 'privilege_module': (<class 'str'>,), 'privilege_type': (<class 'str'>,), 'reserved_name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'metadata': <class 'pytan3.api_objects.soap_7_2_314_3181.MetadataList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ContentSetPrivilegeList

API_LIST_API_NAME = 'content_set_privileges'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.ContentSetRolePrivilege(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'content_set_role_privilege'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role_privilege'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set': <class 'pytan3.api_objects.soap_7_2_314_3181.IdReference'>, 'content_set_privilege': <class 'pytan3.api_objects.soap_7_2_314_3181.IdReference'>, 'content_set_role': <class 'pytan3.api_objects.soap_7_2_314_3181.IdReference'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ContentSetRolePrivilegeList

API_LIST_API_NAME = 'content_set_role_privileges'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.EffectiveContentSetPrivilege(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'effective_content_set_privilege'

str – Name of object used in API calls.

API_NAME_SRC = 'effective_content_set_privilege'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set': <class 'pytan3.api_objects.soap_7_2_314_3181.ContentSet'>, 'content_set_privilege_list': <class 'pytan3.api_objects.soap_7_2_314_3181.ContentSetPrivilegeList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of EffectiveContentSetPrivilegeList

API_LIST_API_NAME = 'effective_content_set_privileges'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.Dashboard(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'dashboard'

str – Name of object used in API calls.

API_NAME_SRC = 'dashboard'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,), 'name': (<class 'str'>,), 'public_flag': (<class 'int'>,), 'text': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set': <class 'pytan3.api_objects.soap_7_2_314_3181.ContentSet'>, 'group': <class 'pytan3.api_objects.soap_7_2_314_3181.Group'>, 'saved_question_list': <class 'pytan3.api_objects.soap_7_2_314_3181.SavedQuestionList'>, 'user': <class 'pytan3.api_objects.soap_7_2_314_3181.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of DashboardList

API_LIST_API_NAME = 'dashboards'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.DashboardGroup(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'dashboard_group'

str – Name of object used in API calls.

API_NAME_SRC = 'dashboard_group'

str – Name of object in source file.

API_SIMPLE = {'display_index': (<class 'int'>,), 'editable_flag': (<class 'int'>,), 'icon': (<class 'str'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'other_flag': (<class 'int'>,), 'public_flag': (<class 'int'>,), 'text': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set': <class 'pytan3.api_objects.soap_7_2_314_3181.ContentSet'>, 'dashboard_list': <class 'pytan3.api_objects.soap_7_2_314_3181.DashboardList'>, 'user': <class 'pytan3.api_objects.soap_7_2_314_3181.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.UserGroup(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'user_group'

str – Name of object used in API calls.

API_NAME_SRC = 'user_group'

str – Name of object in source file.

API_SIMPLE = {'deleted_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set_roles': <class 'pytan3.api_objects.soap_7_2_314_3181.ContentSetRoleList'>, 'group': <class 'pytan3.api_objects.soap_7_2_314_3181.Group'>, 'user_list': <class 'pytan3.api_objects.soap_7_2_314_3181.UserList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of UserGroupList

API_LIST_API_NAME = 'user_groups'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.Solution(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'solution'

str – Name of object used in API calls.

API_NAME_SRC = 'solution'

str – Name of object in source file.

API_SIMPLE = {'category': (<class 'str'>,), 'delete_xml_url': (<class 'str'>,), 'deleted_flag': (<class 'int'>,), 'description': (<class 'str'>,), 'dup_resolve_type': (<class 'int'>,), 'id': (<class 'int'>,), 'imported_by': (<class 'str'>,), 'imported_version': (<class 'str'>,), 'installed_xml_url': (<class 'str'>,), 'last_update': (<class 'str'>,), 'name': (<class 'str'>,), 'signature': (<class 'str'>,), 'solution_id': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SolutionList

API_LIST_API_NAME = 'solutions'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.ActionGroup(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'action_group'

str – Name of object used in API calls.

API_NAME_SRC = 'action_group'

str – Name of object in source file.

API_SIMPLE = {'and_flag': (<class 'int'>,), 'deleted_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'public_flag': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'groups': <class 'pytan3.api_objects.soap_7_2_314_3181.GroupList'>, 'user_groups': <class 'pytan3.api_objects.soap_7_2_314_3181.UserGroupList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ActionGroupList

API_LIST_API_NAME = 'action_groups'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.SavedQuestionPackageSpecs(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'saved_question_package_specs'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_question_package_specs'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'packages': <class 'pytan3.api_objects.soap_7_2_314_3181.PackageSpecList'>, 'saved_question': <class 'pytan3.api_objects.soap_7_2_314_3181.IdReference'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.SavedQuestionQuestion(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'saved_question_question'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_question_question'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'questions': <class 'pytan3.api_objects.soap_7_2_314_3181.QuestionList'>, 'saved_question': <class 'pytan3.api_objects.soap_7_2_314_3181.IdReference'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SavedQuestionQuestionList

API_LIST_API_NAME = 'saved_question_questions'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.LdapSyncConnector(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'ldap_sync_connector'

str – Name of object used in API calls.

API_NAME_SRC = 'ldap_sync_connector'

str – Name of object in source file.

API_SIMPLE = {'base_groups': (<class 'str'>,), 'base_users': (<class 'str'>,), 'disable_ldap_auth': (<class 'int'>,), 'enable': (<class 'int'>,), 'filter_groups': (<class 'str'>,), 'filter_users': (<class 'str'>,), 'group_id': (<class 'str'>,), 'group_member': (<class 'str'>,), 'group_name': (<class 'str'>,), 'host': (<class 'str'>,), 'id': (<class 'int'>,), 'last_sync_result': (<class 'str'>,), 'last_sync_timestamp': (<class 'str'>,), 'ldap_password': (<class 'str'>,), 'ldap_user': (<class 'str'>,), 'members_only_flag': (<class 'int'>,), 'name': (<class 'str'>,), 'port': (<class 'int'>,), 'secure': (<class 'int'>,), 'use_ntlm': (<class 'int'>,), 'user_display_name': (<class 'str'>,), 'user_domain': (<class 'str'>,), 'user_id': (<class 'str'>,), 'user_name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of LdapSyncConnectorList

API_LIST_API_NAME = 'ldap_sync_connector_list'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.HashedString(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiItem

Automagically generated API object.

API_NAME = 'hashed_string'

str – Name of object used in API calls.

API_NAME_SRC = 'hashed_string'

str – Name of object in source file.

API_SIMPLE = {'collision_flag': (<class 'int'>,), 'error_flag': (<class 'int'>,), 'first_collision': (<class 'str'>,), 'second_collision': (<class 'str'>,), 'sensor_hash': (<class 'int'>,), 'value': (<class 'str'>,), 'value_hash': (<class 'int'>,), 'which_computer_id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'first_computer_id': <class 'pytan3.api_objects.soap_7_2_314_3181.ComputerIdList'>, 'second_computer_id': <class 'pytan3.api_objects.soap_7_2_314_3181.ComputerIdList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of HashedStringList

API_LIST_API_NAME = 'hashed_strings'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_2_314_3181.SensorQueryList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'sensor_querys'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_query_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'query'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SensorQuery

class pytan3.api_objects.soap_7_2_314_3181.SensorSubcolumnList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'sensor_subcolumns'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_subcolumn_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'subcolumn'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SensorSubcolumn

class pytan3.api_objects.soap_7_2_314_3181.StringHintList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'string_hints'

str – Name of object used in API calls.

API_NAME_SRC = 'string_hint_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'string_hint'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'str'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.soap_7_2_314_3181.SensorList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'sensors'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_2_314_3181.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'sensor'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Sensor

class pytan3.api_objects.soap_7_2_314_3181.SensorStatList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'sensor_stats'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_stat_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'sensor_stat'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SensorStat

class pytan3.api_objects.soap_7_2_314_3181.SavedActionApprovalList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'saved_action_approvals'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_action_approval_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'saved_action_approval'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SavedActionApproval

class pytan3.api_objects.soap_7_2_314_3181.SavedActionRowIdList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'saved_action_row_ids'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_action_row_id_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'row_id'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'int'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.soap_7_2_314_3181.SavedActionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'saved_actions'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_action_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_2_314_3181.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'saved_action'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SavedAction

class pytan3.api_objects.soap_7_2_314_3181.AuditDataList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'audit_datas'

str – Name of object used in API calls.

API_NAME_SRC = 'audit_data_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_2_314_3181.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'entry'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of AuditData

class pytan3.api_objects.soap_7_2_314_3181.AuditLogList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'audit_logs'

str – Name of object used in API calls.

API_NAME_SRC = 'audit_log_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'audit_log'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of AuditLog

class pytan3.api_objects.soap_7_2_314_3181.MetadataList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'metadatas'

str – Name of object used in API calls.

API_NAME_SRC = 'metadata_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'item'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of MetadataItem

class pytan3.api_objects.soap_7_2_314_3181.GroupList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'groups'

str – Name of object used in API calls.

API_NAME_SRC = 'group_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_2_314_3181.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'group'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Group

class pytan3.api_objects.soap_7_2_314_3181.FilterList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'filters'

str – Name of object used in API calls.

API_NAME_SRC = 'filter_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'filter'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Filter

class pytan3.api_objects.soap_7_2_314_3181.SelectList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'selects'

str – Name of object used in API calls.

API_NAME_SRC = 'select_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'select'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Select

class pytan3.api_objects.soap_7_2_314_3181.ErrorList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'errors'

str – Name of object used in API calls.

API_NAME_SRC = 'error_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'error'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of XmlError

class pytan3.api_objects.soap_7_2_314_3181.QuestionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'questions'

str – Name of object used in API calls.

API_NAME_SRC = 'question_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_2_314_3181.CacheInfo'>, 'info': <class 'pytan3.api_objects.soap_7_2_314_3181.QuestionListInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'question'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Question

class pytan3.api_objects.soap_7_2_314_3181.PackageFileTemplateList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'package_file_templates'

str – Name of object used in API calls.

API_NAME_SRC = 'package_file_template_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'file_template'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of PackageFileTemplate

class pytan3.api_objects.soap_7_2_314_3181.PackageFileStatusList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'package_file_statuss'

str – Name of object used in API calls.

API_NAME_SRC = 'package_file_status_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'status'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of PackageFileStatus

class pytan3.api_objects.soap_7_2_314_3181.PackageFileList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'package_files'

str – Name of object used in API calls.

API_NAME_SRC = 'package_file_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'file'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of PackageFile

class pytan3.api_objects.soap_7_2_314_3181.PackageSpecList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'package_specs'

str – Name of object used in API calls.

API_NAME_SRC = 'package_spec_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_2_314_3181.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'package_spec'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of PackageSpec

class pytan3.api_objects.soap_7_2_314_3181.WhiteListedUrlList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'white_listed_urls'

str – Name of object used in API calls.

API_NAME_SRC = 'white_listed_url_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'white_listed_url'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of WhiteListedUrl

class pytan3.api_objects.soap_7_2_314_3181.VersionAggregateList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'version_aggregates'

str – Name of object used in API calls.

API_NAME_SRC = 'version_aggregate_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'version'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of VersionAggregate

class pytan3.api_objects.soap_7_2_314_3181.SystemStatusList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'system_status'

str – Name of object used in API calls.

API_NAME_SRC = 'system_status_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'aggregate': <class 'pytan3.api_objects.soap_7_2_314_3181.SystemStatusAggregate'>, 'cache_info': <class 'pytan3.api_objects.soap_7_2_314_3181.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'client_status'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ClientStatus

class pytan3.api_objects.soap_7_2_314_3181.SystemSettingList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'system_settings'

str – Name of object used in API calls.

API_NAME_SRC = 'system_setting_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_2_314_3181.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'system_setting'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SystemSetting

class pytan3.api_objects.soap_7_2_314_3181.UserList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'users'

str – Name of object used in API calls.

API_NAME_SRC = 'user_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'user'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of User

class pytan3.api_objects.soap_7_2_314_3181.PermissionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'permissions'

str – Name of object used in API calls.

API_NAME_SRC = 'permission_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {'ACTION_APPROVE': 'action_approval', 'ACTION_READ': 'action_read', 'ACTION_WRITE': 'action_write', 'ADMIN': 'admin', 'CLIENTS_READ': 'clients_read', 'CONTENT_ADMIN': 'content_admin', 'NOTIFICATION_WRITE': 'notification_write', 'QUESTION_LOG_READ': 'question_log_read', 'QUESTION_READ': 'question_read', 'QUESTION_WRITE': 'question_write', 'SENSOR_READ': 'sensor_read', 'SENSOR_WRITE': 'sensor_write'}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'permission'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'str'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.soap_7_2_314_3181.UserRoleList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'roles'

str – Name of object used in API calls.

API_NAME_SRC = 'user_role_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'role'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of UserRole

class pytan3.api_objects.soap_7_2_314_3181.ActionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'actions'

str – Name of object used in API calls.

API_NAME_SRC = 'action_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_2_314_3181.CacheInfo'>, 'info': <class 'pytan3.api_objects.soap_7_2_314_3181.ActionListInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'action'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Action

class pytan3.api_objects.soap_7_2_314_3181.ActionStopList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'action_stops'

str – Name of object used in API calls.

API_NAME_SRC = 'action_stop_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'action_stop'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ActionStop

class pytan3.api_objects.soap_7_2_314_3181.ArchivedQuestionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'archived_questions'

str – Name of object used in API calls.

API_NAME_SRC = 'archived_question_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'archived_question'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ArchivedQuestion

class pytan3.api_objects.soap_7_2_314_3181.SavedQuestionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'saved_questions'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_question_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_2_314_3181.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'saved_question'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SavedQuestion

class pytan3.api_objects.soap_7_2_314_3181.ParseJobList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'parse_jobs'

str – Name of object used in API calls.

API_NAME_SRC = 'parse_job_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'parse_job'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ParseJob

class pytan3.api_objects.soap_7_2_314_3181.ParseResultGroupList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'parse_result_groups'

str – Name of object used in API calls.

API_NAME_SRC = 'parse_result_group_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'parse_result_group'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ParseResultGroup

class pytan3.api_objects.soap_7_2_314_3181.ParseResultList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'parse_results'

str – Name of object used in API calls.

API_NAME_SRC = 'parse_result_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'parse_result'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ParseResult

class pytan3.api_objects.soap_7_2_314_3181.ParameterList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'parameters'

str – Name of object used in API calls.

API_NAME_SRC = 'parameter_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'parameter'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Parameter

class pytan3.api_objects.soap_7_2_314_3181.ParameterValueList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'parameter_values'

str – Name of object used in API calls.

API_NAME_SRC = 'parameter_value_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'value'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'str'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.soap_7_2_314_3181.SensorReferenceList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'sensor_references'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_reference_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'sensor_reference'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SensorReference

class pytan3.api_objects.soap_7_2_314_3181.PluginArgumentList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'plugin_arguments'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_argument_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'argument'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of PluginArgument

class pytan3.api_objects.soap_7_2_314_3181.PluginSqlResultList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'plugin_sql_results'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_sql_result_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'value'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'str'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.soap_7_2_314_3181.PluginSqlColumnList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'plugin_sql_columns'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_sql_column_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'name'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'str'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.soap_7_2_314_3181.PluginSql(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'plugin_sql'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_sql'

str – Name of object in source file.

API_SIMPLE = {'result_count': (<class 'int'>,), 'rows_affected': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'columns': <class 'pytan3.api_objects.soap_7_2_314_3181.PluginSqlColumnList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'result_row'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of PluginSqlResultList

class pytan3.api_objects.soap_7_2_314_3181.PluginCommandList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'plugin_commands'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_command_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'command'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'str'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.soap_7_2_314_3181.UploadFileList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'upload_files'

str – Name of object used in API calls.

API_NAME_SRC = 'upload_file_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'upload_file'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of UploadFile

class pytan3.api_objects.soap_7_2_314_3181.PluginList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'plugins'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_2_314_3181.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'plugin'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Plugin

class pytan3.api_objects.soap_7_2_314_3181.PluginScheduleList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'plugin_schedules'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_schedule_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_2_314_3181.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'plugin_schedule'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of PluginSchedule

class pytan3.api_objects.soap_7_2_314_3181.ComputerSpecList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'computer_specs'

str – Name of object used in API calls.

API_NAME_SRC = 'computer_spec_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_2_314_3181.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'computer_spec'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ComputerGroupSpec

class pytan3.api_objects.soap_7_2_314_3181.ComputerGroupList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'computer_groups'

str – Name of object used in API calls.

API_NAME_SRC = 'computer_group_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_2_314_3181.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'computer_group'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ComputerGroup

class pytan3.api_objects.soap_7_2_314_3181.CacheFilterList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'cache_filters'

str – Name of object used in API calls.

API_NAME_SRC = 'cache_filter_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'filter'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of CacheFilter

class pytan3.api_objects.soap_7_2_314_3181.ImportConflictOptions(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'import_conflict_options'

str – Name of object used in API calls.

API_NAME_SRC = 'import_conflict_options'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'import_conflict_option'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'int'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.soap_7_2_314_3181.ContentSetList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'content_sets'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'content_set'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ContentSet

class pytan3.api_objects.soap_7_2_314_3181.ContentSetRolePrivilegeOnRoleList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'content_set_role_privilege_on_roles'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role_privilege_on_role_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'content_set_role_privilege'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ContentSetRolePrivilegeOnRole

class pytan3.api_objects.soap_7_2_314_3181.ContentSetRoleList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'content_set_roles'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'content_set_role'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ContentSetRole

class pytan3.api_objects.soap_7_2_314_3181.ContentSetRoleMembershipList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'content_set_role_memberships'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role_membership_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'content_set_role_membership'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ContentSetRoleMembership

class pytan3.api_objects.soap_7_2_314_3181.ContentSetUserGroupRoleMembershipList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'content_set_user_group_role_memberships'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_user_group_role_membership_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'content_set_user_group_role_membership'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ContentSetUserGroupRoleMembership

class pytan3.api_objects.soap_7_2_314_3181.ContentSetPrivilegeList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'content_set_privileges'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_privilege_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'content_set_privilege'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ContentSetPrivilege

class pytan3.api_objects.soap_7_2_314_3181.ContentSetRolePrivilegeList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'content_set_role_privileges'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role_privilege_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'content_set_role_privilege'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ContentSetRolePrivilege

class pytan3.api_objects.soap_7_2_314_3181.EffectiveContentSetPrivilegeRequest(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'effective_content_set_privilege_request'

str – Name of object used in API calls.

API_NAME_SRC = 'effective_content_set_privilege_request'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'user'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of User

class pytan3.api_objects.soap_7_2_314_3181.EffectiveContentSetPrivilegeList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'effective_content_set_privileges'

str – Name of object used in API calls.

API_NAME_SRC = 'effective_content_set_privilege_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'effective_content_set_privilege'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of EffectiveContentSetPrivilege

class pytan3.api_objects.soap_7_2_314_3181.DashboardList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'dashboards'

str – Name of object used in API calls.

API_NAME_SRC = 'dashboard_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'dashboard'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Dashboard

class pytan3.api_objects.soap_7_2_314_3181.UserGroupList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'user_groups'

str – Name of object used in API calls.

API_NAME_SRC = 'user_group_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'user_group'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of UserGroup

class pytan3.api_objects.soap_7_2_314_3181.SolutionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'solutions'

str – Name of object used in API calls.

API_NAME_SRC = 'solution_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'solution'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Solution

class pytan3.api_objects.soap_7_2_314_3181.ActionGroupList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'action_groups'

str – Name of object used in API calls.

API_NAME_SRC = 'action_group_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'action_group'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ActionGroup

class pytan3.api_objects.soap_7_2_314_3181.SavedQuestionQuestionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'saved_question_questions'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_question_question_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'saved_question_question'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SavedQuestionQuestion

class pytan3.api_objects.soap_7_2_314_3181.LdapSyncConnectorList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'ldap_sync_connector_list'

str – Name of object used in API calls.

API_NAME_SRC = 'ldap_sync_connector_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'ldap_sync_connector'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of LdapSyncConnector

class pytan3.api_objects.soap_7_2_314_3181.ComputerIdList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'computer_ids'

str – Name of object used in API calls.

API_NAME_SRC = 'computer_id_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'id'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'int'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.soap_7_2_314_3181.HashedStringList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_2_314_3181.ApiList

Automagically generated API array object.

API_NAME = 'hashed_strings'

str – Name of object used in API calls.

API_NAME_SRC = 'hashed_string_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'hashed_string'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of HashedString

pytan3.api_objects.soap_7_2_314_3181.BUILD_META = {'date': '2019-02-22 07:46:06.368436', 'script': 'build_objects_from_wsdl.py', 'script_platform': 'Darwin-18.2.0-x86_64-i386-64bit', 'script_python': '3.7.2 (default, Feb 20 2019, 14:09:01) ', 'script_version': '3.0.0', 'source_file': '/libraries/taniumjs/console.wsdl', 'source_file_date': '2019-02-22 07:29:24.906604'}

dict – How this module was built (date/time in UTC format).

pytan3.api_objects.soap_7_2_314_3181.COMMANDS = ['AddObject', 'GetObject', 'MoveObject', 'TransferObject', 'UpdateObject', 'DeleteObject', 'GetSavedQuestions', 'GetResultInfo', 'GetResultData', 'GetMergedResultData', 'UploadFile', 'RunPlugin', 'ExportObject', 'ImportObject']

list of str – API commands.

pytan3.api_objects.soap_7_2_314_3181.VERSION = {'build': 3181, 'major': 7, 'minor': 2, 'protocol': 314, 'string': '7.2.314.3181'}

dict – Tanium API version these objects are intended to be used for.

SOAP API Object Module for Version 7.3.314.3424

Python objects for Tanium’s API.

pytan3.api_objects.soap_7_3_314_3424.float_types = (<class 'float'>,)

tuple of type – Float types.

pytan3.api_objects.soap_7_3_314_3424.integer_types = (<class 'int'>,)

tuple of type – Integer types.

pytan3.api_objects.soap_7_3_314_3424.string_types = (<class 'str'>,)

tuple of type – String types.

pytan3.api_objects.soap_7_3_314_3424.simple_types = (<class 'int'>, <class 'str'>, <class 'float'>)

tuple of type – All types that should be considered simple types.

pytan3.api_objects.soap_7_3_314_3424.TYPE = 'soap'

str – Type of API this module was built from.

pytan3.api_objects.soap_7_3_314_3424.API_DT = '%Y-%m-%dT%H:%M:%S'

str – Datetime format for this API type and version.

pytan3.api_objects.soap_7_3_314_3424.api_fixes()[source]

Fix incorrect attribute definitions on auto generated ApiModel classes.

pytan3.api_objects.soap_7_3_314_3424.expand_cls_globals()[source]

Replace str values with global vars for attrs on ApiModel classes.

Quite the funky chicken dance for solving issues with order of class definition.

pytan3.api_objects.soap_7_3_314_3424.expand_global(obj)[source]

Replace str values with global vars recursively.

Parameters:obj (str or dict or list) – Object to expand into global var.
Returns:String objects are the only ones that will be expanded.
Return type:str or dict or list or object
pytan3.api_objects.soap_7_3_314_3424.get_api_all_item()[source]

Get map of class name to class for all ApiItem subclasses.

Returns:dict
pytan3.api_objects.soap_7_3_314_3424.get_api_all_list()[source]

Get map of class name to class for all ApiList subclasses.

Returns:dict
pytan3.api_objects.soap_7_3_314_3424.get_api_all_model()[source]

Get map of class name to class for all ApiItem and ApiList subclasses.

Returns:dict
class pytan3.api_objects.soap_7_3_314_3424.ApiModel[source]

Bases: pytan3.api_models.ApiModel

Model for a complex item in the API.

class pytan3.api_objects.soap_7_3_314_3424.ApiItem(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiModel, pytan3.api_models.ApiItem

Model for a complex item in the API.

class pytan3.api_objects.soap_7_3_314_3424.ApiList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiModel, pytan3.api_models.ApiList

Model for an array in the API.

class pytan3.api_objects.soap_7_3_314_3424.ResultInfoList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Manually defined API array object.

API_NAME = 'result_infos'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'max_available_age': (<class 'int'>,), 'now': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['now', 'max_available_age']

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'result_info'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ResultInfo

__repr__()[source]

Make repr output be same as str output.

Returns:str
class pytan3.api_objects.soap_7_3_314_3424.ResultInfo(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Manually defined API object.

API_NAME = 'result_info'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'age': (<class 'int'>,), 'archived_question_id': (<class 'int'>,), 'error_count': (<class 'int'>,), 'estimated_total': (<class 'int'>,), 'expire_seconds': (<class 'int'>,), 'id': (<class 'int'>,), 'issue_seconds': (<class 'int'>,), 'mr_passed': (<class 'int'>,), 'mr_tested': (<class 'int'>,), 'no_results_count': (<class 'int'>,), 'passed': (<class 'int'>,), 'question_id': (<class 'int'>,), 'report_count': (<class 'int'>,), 'row_count': (<class 'int'>,), 'row_count_flag': (<class 'int'>,), 'row_count_machines': (<class 'int'>,), 'saved_question_id': (<class 'int'>,), 'seconds_since_issued': (<class 'int'>,), 'select_count': (<class 'int'>,), 'tested': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['question_id', 'estimated_total', 'row_count', 'mr_tested', 'mr_passed']

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ResultInfoList

API_LIST_API_NAME = 'result_infos'

str – Name of API_LIST_CLS used in API calls.

__repr__()[source]

Make repr output be same as str output.

Returns:str
class pytan3.api_objects.soap_7_3_314_3424.ResultSetList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Manually defined API array object.

API_NAME = 'result_sets'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'now': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['now']

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'result_set'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ResultSet

class pytan3.api_objects.soap_7_3_314_3424.MergedResultSet(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Manually defined API object.

API_NAME = 'merged_result'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'max_available_age': (<class 'str'>,), 'now': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'result_infos': <class 'pytan3.api_objects.soap_7_3_314_3424.ResultInfoList'>, 'result_sets': <class 'pytan3.api_objects.soap_7_3_314_3424.ResultSetList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['now', 'max_available_age']

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.ResultSet(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Manually defined API object.

API_NAME = 'result_set'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'age': (<class 'int'>,), 'archived_question_id': (<class 'int'>,), 'cache_id': (<class 'int'>,), 'error_count': (<class 'int'>,), 'estimated_total': (<class 'int'>,), 'expiration': (<class 'int'>,), 'expire_seconds': (<class 'int'>,), 'filtered_row_count': (<class 'int'>,), 'filtered_row_count_machines': (<class 'int'>,), 'id': (<class 'int'>,), 'issue_seconds': (<class 'int'>,), 'item_count': (<class 'int'>,), 'mr_passed': (<class 'int'>,), 'mr_tested': (<class 'int'>,), 'no_results_count': (<class 'int'>,), 'passed': (<class 'int'>,), 'question_id': (<class 'int'>,), 'report_count': (<class 'int'>,), 'row_count': (<class 'int'>,), 'row_count_machines': (<class 'int'>,), 'saved_question_id': (<class 'int'>,), 'seconds_since_issued': (<class 'int'>,), 'select_count': (<class 'int'>,), 'tested': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cs': <class 'pytan3.api_objects.soap_7_3_314_3424.ColumnList'>, 'rs': <class 'pytan3.api_objects.soap_7_3_314_3424.RowList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['question_id', 'estimated_total', 'mr_tested', 'mr_passed', 'row_count', 'columns']

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ResultSetList

API_LIST_API_NAME = 'result_sets'

str – Name of API_LIST_CLS used in API calls.

__init__(**kwargs)[source]

Constructor.

Notes

Sets Column.API_DATA_SET so column objects can access rows.

Sets RowColumn.API_COLUMN to the index correlated Column so row columns can access the column name, result type, etc.

Sets Column.API_IDX and RowColumn.API_IDX so column objects know what their index is without having to do lookups.

Parameters:**kwargs – Passed back to parent class.
rows

Expose complex attr “rs” as “rows”.

Returns:list
columns

Expose complex attr “cs” as “columns”.

Returns:list
class pytan3.api_objects.soap_7_3_314_3424.ColumnList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Manually defined API array object.

API_NAME = 'cs'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['names']

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'c'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Column

__repr__()[source]

Make repr output be same as str output.

Returns:str
names

Expose column names of all Column in this obj.

Returns:list of str
__getitem__(value)[source]

Support indexing of names.

Parameters:value (int or str) – If int: Index of item to retrieve from simple attr “c”. If str: Column name to index correlate from names
Returns:The RowColumn object at index value from names.
Return type:RowColumn
class pytan3.api_objects.soap_7_3_314_3424.Column(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Manually defined API object.

API_DATA_SET = None

ResultSet – Parent of this object, set by ResultSet.__init__().

API_IDX = None

int – Index of this object in ColumnList.

API_NAME = 'c'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'dn': (<class 'str'>,), 'rt': (<class 'int'>,), 'wh': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['name', 'result_type', 'hash']

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ColumnList

API_LIST_API_NAME = 'cs'

str – Name of API_LIST_CLS used in API calls.

name

Expose simple attr “dn” as name.

Returns:str
hash

Expose simple attr “wh” as hash.

Returns:str
type

Expose simple attr “rt” as type.

Returns:str
result_type

Expose simple attr “rt” as result_type.

Notes

Will try to map str from “rt” as int to constants from Sensor.API_CONSTANTS.

Returns:str
get_values(attr='value', join=None)[source]

Get values of this column from all rows.

Parameters:
  • attr (str, optional) –

    Attribute to get values of.

    Defaults to: “value”.

  • join (str, optional) –

    String to join multi value columns.

    Defaults to: None.
Returns:

list of str
class pytan3.api_objects.soap_7_3_314_3424.RowList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Manually defined API array object.

API_NAME = 'rs'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'r'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Row

__repr__()[source]

Make repr output be same as str output.

Returns:str
class pytan3.api_objects.soap_7_3_314_3424.Row(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Manually defined API object.

API_NAME = 'r'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'cid': (<class 'int'>,), 'id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'c': <class 'pytan3.api_objects.soap_7_3_314_3424.RowColumnList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['id', 'cid', 'columns']

list or str – Attributes to add to str formatting.

API_LIST_API_NAME = 'rs'

str – Name of API_LIST_CLS used in API calls.

API_LIST_CLS

ApiItem: Item class this list class holds.

alias of RowList

__repr__()[source]

Make repr output be same as str output.

Returns:str
__getitem__(value)[source]

Support indexing of names.

Parameters:value (int or str) – If int: Index of item to retrieve from names. If str: Column name to index correlate from ColumnList.names
Returns:The RowColumn object at index value from names.
Return type:RowColumn
names

Return the names of each row column from RowColumn.API_COLUMN.

Returns:list of str
columns

Expose complex attr “c” as “columns”.

Returns:RowColumnList
__len__()[source]

Expose length of columns.

Returns:int
get_values(meta=False, hashes=False, join=None)[source]

Get all values from all columns in this row.

Parameters:
  • meta (bool, optional) –

    Include sensor hash and result type for each column.

    Defaults to: False.

  • hashes (bool, optional) –

    Include hashes of values.

    Defaults to: False.

  • join (str, optional) –

    String to join multi value columns.

    Defaults to: None.
Returns:

dict
class pytan3.api_objects.soap_7_3_314_3424.RowColumnList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Manually defined API array object.

API_NAME = 'rc'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'row_columns'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of RowColumn

api_coerce_items_hook(attr, value, op)[source]

Check hook that allows subclasses to modify list items.

Parameters:
  • attr (str) – Attribute being set on this object.
  • value (ApiList or list or tuple) – The list object holding items.
  • op (str) – Operation being performed that called this method.

Examples

This converts all “v” attributes of each column for this row into a list of dicts:

>>> # single value columns "v" is a single dict:
>>> {"v": {"h": "", "text": ""}}
>>> # multiple value columns "v" is a list of dict:
>>> {"v": [{"h": "", "text": ""}, {"h": "", "text": ""}]}
>>> # Count columns "v" is a string:
>>> {"v": "1"}
>>> # all become:
>>> {"v": [{"text": "", "hash": ""}]}

Notes

The driving force behind this is basically just the Count column. It returns a string of the value, instead of a dict or a list of dicts.

Returns:The list of items modified or as is.
Return type:list
class pytan3.api_objects.soap_7_3_314_3424.RowColumn(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Manually defined API array object.

API_COLUMN = None

Column – Index correlated column, set by ResultSet.__init__().

API_IDX = None

int – Index of this object in RowColumnList.

API_NAME = 'row_column'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['name', 'hash', 'result_type']

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'v'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of RowValue

name

Expose column name from API_COLUMN.

Returns:str
result_type

Expose column result type from API_COLUMN.

Returns:str
hash

Expose column sensor hash from API_COLUMN.

Returns:str
get_values(attr='value', join=None)[source]

Get all values from this row column.

Parameters:
  • attr (str, optional) –

    Attribute to get values of.

    Defaults to: “value”.

  • join (str, optional) –

    String to join multi value columns.

    Defaults to: None.
Returns:

list or str
class pytan3.api_objects.soap_7_3_314_3424.RowValue(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Manually defined API object.

API_NAME = 'v'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'h': (<class 'int'>,), 'text': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['hash', 'value']

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of RowColumn

API_LIST_API_NAME = 'row_column'

str – Name of API_LIST_CLS used in API calls.

hash

Expose simple attr “h” as hash.

Returns:str
value

Expose simple attr “text” as value.

Returns:str
class pytan3.api_objects.soap_7_3_314_3424.SensorQuery(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'sensor_query'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_query'

str – Name of object in source file.

API_SIMPLE = {'platform': (<class 'str'>,), 'script': (<class 'str'>,), 'script_type': (<class 'str'>,), 'signature': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SensorQueryList

API_LIST_API_NAME = 'sensor_querys'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.SensorSubcolumn(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'sensor_subcolumn'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_subcolumn'

str – Name of object in source file.

API_SIMPLE = {'exclude_from_parse_flag': (<class 'int'>,), 'hidden_flag': (<class 'int'>,), 'ignore_case_flag': (<class 'int'>,), 'index': (<class 'int'>,), 'name': (<class 'str'>,), 'value_type': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SensorSubcolumnList

API_LIST_API_NAME = 'sensor_subcolumns'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.SensorStat(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'sensor_stat'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_stat'

str – Name of object in source file.

API_SIMPLE = {'count': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'other_bytes_avg': (<class 'float'>,), 'other_bytes_std': (<class 'float'>,), 'read_bytes_avg': (<class 'float'>,), 'read_bytes_std': (<class 'float'>,), 'real_ms_avg': (<class 'float'>,), 'real_ms_max': (<class 'float'>,), 'real_ms_min': (<class 'float'>,), 'real_ms_std': (<class 'float'>,), 'sys_ms_avg': (<class 'float'>,), 'sys_ms_std': (<class 'float'>,), 'user_ms_avg': (<class 'float'>,), 'user_ms_std': (<class 'float'>,), 'what_hash': (<class 'int'>,), 'write_bytes_avg': (<class 'float'>,), 'write_bytes_std': (<class 'float'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SensorStatList

API_LIST_API_NAME = 'sensor_stats'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.SavedActionPolicy(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'saved_action_policy'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_action_policy'

str – Name of object in source file.

API_SIMPLE = {'max_age': (<class 'int'>,), 'min_count': (<class 'int'>,), 'row_filter_group_id': (<class 'int'>,), 'saved_question_group_id': (<class 'int'>,), 'saved_question_id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'row_filter_group': <class 'pytan3.api_objects.soap_7_3_314_3424.Group'>, 'saved_question_group': <class 'pytan3.api_objects.soap_7_3_314_3424.Group'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.SavedActionApproval(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'saved_action_approval'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_action_approval'

str – Name of object in source file.

API_SIMPLE = {'approved_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'owner_user_id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'metadata': <class 'pytan3.api_objects.soap_7_3_314_3424.MetadataList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SavedActionApprovalList

API_LIST_API_NAME = 'saved_action_approvals'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.SavedAction(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'saved_action'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_action'

str – Name of object in source file.

API_SIMPLE = {'action_group_id': (<class 'int'>,), 'approved_flag': (<class 'int'>,), 'cache_row_id': (<class 'int'>,), 'comment': (<class 'str'>,), 'creation_time': (<class 'str'>,), 'distribute_seconds': (<class 'int'>,), 'end_time': (<class 'str'>,), 'expire_seconds': (<class 'int'>,), 'id': (<class 'int'>,), 'issue_count': (<class 'int'>,), 'issue_seconds': (<class 'int'>,), 'last_start_time': (<class 'str'>,), 'name': (<class 'str'>,), 'next_start_time': (<class 'str'>,), 'policy_flag': (<class 'int'>,), 'public_flag': (<class 'int'>,), 'start_time': (<class 'str'>,), 'status': (<class 'int'>,), 'user_start_time': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'action_group': <class 'pytan3.api_objects.soap_7_3_314_3424.Group'>, 'approver': <class 'pytan3.api_objects.soap_7_3_314_3424.User'>, 'last_action': <class 'pytan3.api_objects.soap_7_3_314_3424.Action'>, 'metadata': <class 'pytan3.api_objects.soap_7_3_314_3424.MetadataList'>, 'package_spec': <class 'pytan3.api_objects.soap_7_3_314_3424.PackageSpec'>, 'policy': <class 'pytan3.api_objects.soap_7_3_314_3424.SavedActionPolicy'>, 'row_ids': <class 'pytan3.api_objects.soap_7_3_314_3424.SavedActionRowIdList'>, 'target_group': <class 'pytan3.api_objects.soap_7_3_314_3424.Group'>, 'user': <class 'pytan3.api_objects.soap_7_3_314_3424.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SavedActionList

API_LIST_API_NAME = 'saved_actions'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.Sensor(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'sensor'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor'

str – Name of object in source file.

API_SIMPLE = {'cache_row_id': (<class 'int'>,), 'category': (<class 'str'>,), 'creation_time': (<class 'str'>,), 'deleted_flag': (<class 'int'>,), 'delimiter': (<class 'str'>,), 'description': (<class 'str'>,), 'exclude_from_parse_flag': (<class 'int'>,), 'hash': (<class 'int'>,), 'hidden_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'ignore_case_flag': (<class 'int'>,), 'keep_duplicates_flag': (<class 'int'>,), 'last_modified_by': (<class 'str'>,), 'max_age_seconds': (<class 'int'>,), 'modification_time': (<class 'str'>,), 'name': (<class 'str'>,), 'parameter_definition': (<class 'str'>,), 'preview_sensor_flag': (<class 'int'>,), 'source_hash': (<class 'int'>,), 'source_id': (<class 'int'>,), 'source_name': (<class 'str'>,), 'string_count': (<class 'int'>,), 'value_type': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set': <class 'pytan3.api_objects.soap_7_3_314_3424.IdReference'>, 'metadata': <class 'pytan3.api_objects.soap_7_3_314_3424.MetadataList'>, 'mod_user': <class 'pytan3.api_objects.soap_7_3_314_3424.User'>, 'parameters': <class 'pytan3.api_objects.soap_7_3_314_3424.ParameterList'>, 'queries': <class 'pytan3.api_objects.soap_7_3_314_3424.SensorQueryList'>, 'string_hints': <class 'pytan3.api_objects.soap_7_3_314_3424.StringHintList'>, 'subcolumns': <class 'pytan3.api_objects.soap_7_3_314_3424.SensorSubcolumnList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {'BES_DATETIME_RESULT': 4, 'BES_SENSOR': 2, 'DATASIZE_RESULT': 8, 'HASH_RESULT': 0, 'IP_RESULT': 5, 'JS_SENSOR': 7, 'MULTITYPE_SENSOR': 6, 'NUMERIC_INTEGER_RESULT': 9, 'NUMERIC_RESULT': 3, 'PSHELL_SENSOR': 5, 'PY_SENSOR': 8, 'REGEX_RESULT': 11, 'TEXT_RESULT': 1, 'TIMEDIFF_REUSLT': 7, 'VBS_SENSOR': 4, 'VERSION_RESULT': 2, 'WMI_DATETIME_RESULT': 6, 'WMI_SENSOR': 1}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SensorList

API_LIST_API_NAME = 'sensors'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.AuditData(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'audit_data'

str – Name of object used in API calls.

API_NAME_SRC = 'audit_data'

str – Name of object in source file.

API_SIMPLE = {'cache_row_id': (<class 'int'>,), 'creation_time': (<class 'str'>,), 'details': (<class 'str'>,), 'last_modified_by': (<class 'str'>,), 'modification_time': (<class 'str'>,), 'modifier_user_id': (<class 'int'>,), 'object_id': (<class 'int'>,), 'type': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'mod_user': <class 'pytan3.api_objects.soap_7_3_314_3424.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of AuditDataList

API_LIST_API_NAME = 'audit_datas'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.AuditLog(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'audit_log'

str – Name of object used in API calls.

API_NAME_SRC = 'audit_log'

str – Name of object in source file.

API_SIMPLE = {'end_time': (<class 'str'>,), 'id': (<class 'int'>,), 'start_time': (<class 'str'>,), 'type': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'entries': <class 'pytan3.api_objects.soap_7_3_314_3424.AuditDataList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of AuditLogList

API_LIST_API_NAME = 'audit_logs'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.Server(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'server'

str – Name of object used in API calls.

API_NAME_SRC = 'server'

str – Name of object in source file.

API_SIMPLE = {'heart_beat': (<class 'str'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ServerList

API_LIST_API_NAME = 'servers'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.MetadataItem(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'metadata_item'

str – Name of object used in API calls.

API_NAME_SRC = 'metadata_item'

str – Name of object in source file.

API_SIMPLE = {'admin_flag': (<class 'int'>,), 'name': (<class 'str'>,), 'value': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of MetadataList

API_LIST_API_NAME = 'metadatas'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.Filter(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'filter'

str – Name of object used in API calls.

API_NAME_SRC = 'filter'

str – Name of object in source file.

API_SIMPLE = {'aggregation': (<class 'str'>,), 'all_times_flag': (<class 'int'>,), 'all_values_flag': (<class 'int'>,), 'delimiter': (<class 'str'>,), 'delimiter_index': (<class 'int'>,), 'end_time': (<class 'str'>,), 'id': (<class 'int'>,), 'ignore_case_flag': (<class 'int'>,), 'max_age_seconds': (<class 'int'>,), 'not_flag': (<class 'int'>,), 'operator': (<class 'str'>,), 'start_time': (<class 'str'>,), 'substring_flag': (<class 'int'>,), 'substring_length': (<class 'int'>,), 'substring_start': (<class 'int'>,), 'utf8_flag': (<class 'int'>,), 'value': (<class 'str'>,), 'value_type': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'sensor': <class 'pytan3.api_objects.soap_7_3_314_3424.Sensor'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of FilterList

API_LIST_API_NAME = 'filters'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.IdReference(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'id_reference'

str – Name of object used in API calls.

API_NAME_SRC = 'id_reference'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,), 'name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.Group(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'group'

str – Name of object used in API calls.

API_NAME_SRC = 'group'

str – Name of object in source file.

API_SIMPLE = {'and_flag': (<class 'int'>,), 'deleted_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'not_flag': (<class 'int'>,), 'saved_question_id': (<class 'int'>,), 'source_id': (<class 'int'>,), 'text': (<class 'str'>,), 'track_computer_id_flag': (<class 'int'>,), 'track_computer_id_interval': (<class 'int'>,), 'type': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'filters': <class 'pytan3.api_objects.soap_7_3_314_3424.FilterList'>, 'parameters': <class 'pytan3.api_objects.soap_7_3_314_3424.ParameterList'>, 'sub_groups': <class 'pytan3.api_objects.soap_7_3_314_3424.GroupList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of GroupList

API_LIST_API_NAME = 'groups'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.Select(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'select'

str – Name of object used in API calls.

API_NAME_SRC = 'select'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'filter': <class 'pytan3.api_objects.soap_7_3_314_3424.Filter'>, 'group': <class 'pytan3.api_objects.soap_7_3_314_3424.Group'>, 'sensor': <class 'pytan3.api_objects.soap_7_3_314_3424.Sensor'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SelectList

API_LIST_API_NAME = 'selects'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.XmlError(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'xml_error'

str – Name of object used in API calls.

API_NAME_SRC = 'xml_error'

str – Name of object in source file.

API_SIMPLE = {'error_context': (<class 'str'>,), 'exception': (<class 'str'>,), 'type': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ErrorList

API_LIST_API_NAME = 'errors'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.CacheInfo(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'cache_info'

str – Name of object used in API calls.

API_NAME_SRC = 'cache_info'

str – Name of object in source file.

API_SIMPLE = {'cache_id': (<class 'int'>,), 'cache_row_count': (<class 'int'>,), 'expiration': (<class 'str'>,), 'filtered_row_count': (<class 'int'>,), 'page_row_count': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'errors': <class 'pytan3.api_objects.soap_7_3_314_3424.ErrorList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.QuestionListInfo(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'question_list_info'

str – Name of object used in API calls.

API_NAME_SRC = 'question_list_info'

str – Name of object in source file.

API_SIMPLE = {'highest_id': (<class 'int'>,), 'total_count': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.Question(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'question'

str – Name of object used in API calls.

API_NAME_SRC = 'question'

str – Name of object in source file.

API_SIMPLE = {'action_tracking_flag': (<class 'int'>,), 'cache_row_id': (<class 'int'>,), 'expiration': (<class 'str'>,), 'expire_seconds': (<class 'int'>,), 'force_computer_id_flag': (<class 'int'>,), 'from_canonical_text': (<class 'int'>,), 'hidden_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'index': (<class 'int'>,), 'is_expired': (<class 'int'>,), 'name': (<class 'str'>,), 'query_text': (<class 'str'>,), 'skip_lock_flag': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'context_group': <class 'pytan3.api_objects.soap_7_3_314_3424.Group'>, 'group': <class 'pytan3.api_objects.soap_7_3_314_3424.Group'>, 'management_rights_group': <class 'pytan3.api_objects.soap_7_3_314_3424.Group'>, 'saved_question': <class 'pytan3.api_objects.soap_7_3_314_3424.SavedQuestion'>, 'selects': <class 'pytan3.api_objects.soap_7_3_314_3424.SelectList'>, 'user': <class 'pytan3.api_objects.soap_7_3_314_3424.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of QuestionList

API_LIST_API_NAME = 'questions'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.PackageFileTemplate(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'package_file_template'

str – Name of object used in API calls.

API_NAME_SRC = 'package_file_template'

str – Name of object in source file.

API_SIMPLE = {'download_seconds': (<class 'int'>,), 'hash': (<class 'str'>,), 'name': (<class 'str'>,), 'source': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of PackageFileTemplateList

API_LIST_API_NAME = 'package_file_templates'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.PackageFileStatus(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'package_file_status'

str – Name of object used in API calls.

API_NAME_SRC = 'package_file_status'

str – Name of object in source file.

API_SIMPLE = {'bytes_downloaded': (<class 'int'>,), 'bytes_total': (<class 'int'>,), 'cache_message': (<class 'str'>,), 'cache_status': (<class 'str'>,), 'download_start_time': (<class 'str'>,), 'last_download_progress_time': (<class 'str'>,), 'server_id': (<class 'int'>,), 'server_name': (<class 'str'>,), 'status': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of PackageFileStatusList

API_LIST_API_NAME = 'package_file_statuss'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.PackageFile(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'package_file'

str – Name of object used in API calls.

API_NAME_SRC = 'package_file'

str – Name of object in source file.

API_SIMPLE = {'bytes_downloaded': (<class 'int'>,), 'bytes_total': (<class 'int'>,), 'cache_status': (<class 'str'>,), 'deleted_flag': (<class 'int'>,), 'download_seconds': (<class 'int'>,), 'download_start_time': (<class 'str'>,), 'hash': (<class 'str'>,), 'id': (<class 'int'>,), 'last_download_progress_time': (<class 'str'>,), 'name': (<class 'str'>,), 'size': (<class 'int'>,), 'source': (<class 'str'>,), 'status': (<class 'int'>,), 'trigger_download': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'file_status': <class 'pytan3.api_objects.soap_7_3_314_3424.PackageFileStatusList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of PackageFileList

API_LIST_API_NAME = 'package_files'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.PackageSpec(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'package_spec'

str – Name of object used in API calls.

API_NAME_SRC = 'package_spec'

str – Name of object in source file.

API_SIMPLE = {'available_time': (<class 'str'>,), 'cache_row_id': (<class 'int'>,), 'command': (<class 'str'>,), 'command_timeout': (<class 'int'>,), 'creation_time': (<class 'str'>,), 'deleted_flag': (<class 'int'>,), 'display_name': (<class 'str'>,), 'expire_seconds': (<class 'int'>,), 'hidden_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'last_modified_by': (<class 'str'>,), 'last_update': (<class 'str'>,), 'modification_time': (<class 'str'>,), 'name': (<class 'str'>,), 'parameter_definition': (<class 'str'>,), 'process_group_flag': (<class 'int'>,), 'signature': (<class 'str'>,), 'skip_lock_flag': (<class 'int'>,), 'source_hash': (<class 'str'>,), 'source_hash_changed_flag': (<class 'int'>,), 'source_id': (<class 'int'>,), 'source_name': (<class 'str'>,), 'verify_expire_seconds': (<class 'int'>,), 'verify_group_id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set': <class 'pytan3.api_objects.soap_7_3_314_3424.IdReference'>, 'file_templates': <class 'pytan3.api_objects.soap_7_3_314_3424.PackageFileTemplateList'>, 'files': <class 'pytan3.api_objects.soap_7_3_314_3424.PackageFileList'>, 'metadata': <class 'pytan3.api_objects.soap_7_3_314_3424.MetadataList'>, 'mod_user': <class 'pytan3.api_objects.soap_7_3_314_3424.User'>, 'parameters': <class 'pytan3.api_objects.soap_7_3_314_3424.ParameterList'>, 'sensors': <class 'pytan3.api_objects.soap_7_3_314_3424.SensorList'>, 'verify_group': <class 'pytan3.api_objects.soap_7_3_314_3424.Group'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of PackageSpecList

API_LIST_API_NAME = 'package_specs'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.ClientStatus(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'client_status'

str – Name of object used in API calls.

API_NAME_SRC = 'client_status'

str – Name of object in source file.

API_SIMPLE = {'cache_row_id': (<class 'int'>,), 'computer_id': (<class 'str'>,), 'full_version': (<class 'str'>,), 'host_name': (<class 'str'>,), 'ipaddress_client': (<class 'str'>,), 'ipaddress_server': (<class 'str'>,), 'last_registration': (<class 'str'>,), 'port_number': (<class 'int'>,), 'protocol_version': (<class 'int'>,), 'public_key_valid': (<class 'int'>,), 'receive_state': (<class 'str'>,), 'registered_with_tls': (<class 'int'>,), 'send_state': (<class 'str'>,), 'status': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SystemStatusList

API_LIST_API_NAME = 'system_status'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.SystemSetting(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'system_setting'

str – Name of object used in API calls.

API_NAME_SRC = 'system_setting'

str – Name of object in source file.

API_SIMPLE = {'cache_row_id': (<class 'int'>,), 'default_value': (<class 'str'>,), 'hidden_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'read_only_flag': (<class 'int'>,), 'setting_type': (<class 'str'>,), 'value': (<class 'str'>,), 'value_type': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'audit_data': <class 'pytan3.api_objects.soap_7_3_314_3424.AuditData'>, 'metadata': <class 'pytan3.api_objects.soap_7_3_314_3424.MetadataList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SystemSettingList

API_LIST_API_NAME = 'system_settings'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.SoapError(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'soap_error'

str – Name of object used in API calls.

API_NAME_SRC = 'soap_error'

str – Name of object in source file.

API_SIMPLE = {'context': (<class 'str'>,), 'exception_name': (<class 'str'>,), 'object_name': (<class 'str'>,), 'object_request': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.WhiteListedUrl(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'white_listed_url'

str – Name of object used in API calls.

API_NAME_SRC = 'white_listed_url'

str – Name of object in source file.

API_SIMPLE = {'chunk_id': (<class 'str'>,), 'download_seconds': (<class 'int'>,), 'expire_seconds': (<class 'int'>,), 'id': (<class 'int'>,), 'url_regex': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'metadata': <class 'pytan3.api_objects.soap_7_3_314_3424.MetadataList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of WhiteListedUrlList

API_LIST_API_NAME = 'white_listed_urls'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.VersionAggregate(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'version_aggregate'

str – Name of object used in API calls.

API_NAME_SRC = 'version_aggregate'

str – Name of object in source file.

API_SIMPLE = {'count': (<class 'int'>,), 'filtered': (<class 'int'>,), 'version_string': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of VersionAggregateList

API_LIST_API_NAME = 'version_aggregates'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.SystemStatusAggregate(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'system_status_aggregate'

str – Name of object used in API calls.

API_NAME_SRC = 'system_status_aggregate'

str – Name of object in source file.

API_SIMPLE = {'blocked_count': (<class 'int'>,), 'leader_count': (<class 'int'>,), 'normal_count': (<class 'int'>,), 'receive_backward_count': (<class 'int'>,), 'receive_forward_count': (<class 'int'>,), 'receive_none_count': (<class 'int'>,), 'receive_ok_count': (<class 'int'>,), 'registered_with_tls_count': (<class 'int'>,), 'send_backward_count': (<class 'int'>,), 'send_forward_count': (<class 'int'>,), 'send_none_count': (<class 'int'>,), 'send_ok_count': (<class 'int'>,), 'slowlink_count': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'versions': <class 'pytan3.api_objects.soap_7_3_314_3424.VersionAggregateList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.UserRole(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'user_role'

str – Name of object used in API calls.

API_NAME_SRC = 'user_role'

str – Name of object in source file.

API_SIMPLE = {'description': (<class 'str'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'permissions': <class 'pytan3.api_objects.soap_7_3_314_3424.PermissionList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of UserRoleList

API_LIST_API_NAME = 'roles'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.UserOwnedObjectIds(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'user_owned_object_ids'

str – Name of object used in API calls.

API_NAME_SRC = 'user_owned_object_ids'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'plugin_schedules': <class 'pytan3.api_objects.soap_7_3_314_3424.PluginScheduleList'>, 'saved_actions': <class 'pytan3.api_objects.soap_7_3_314_3424.SavedActionList'>, 'saved_questions': <class 'pytan3.api_objects.soap_7_3_314_3424.SavedQuestionList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.User(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'user'

str – Name of object used in API calls.

API_NAME_SRC = 'user'

str – Name of object in source file.

API_SIMPLE = {'active_session_count': (<class 'int'>,), 'deleted_flag': (<class 'int'>,), 'display_name': (<class 'str'>,), 'domain': (<class 'str'>,), 'effective_group_id': (<class 'int'>,), 'external_flag': (<class 'int'>,), 'group_id': (<class 'int'>,), 'id': (<class 'int'>,), 'last_login': (<class 'str'>,), 'local_admin_flag': (<class 'int'>,), 'locked_out': (<class 'int'>,), 'name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set_roles': <class 'pytan3.api_objects.soap_7_3_314_3424.ContentSetRoleList'>, 'effective_content_set_privileges': <class 'pytan3.api_objects.soap_7_3_314_3424.EffectiveContentSetPrivilegeList'>, 'metadata': <class 'pytan3.api_objects.soap_7_3_314_3424.MetadataList'>, 'owned_object_ids': <class 'pytan3.api_objects.soap_7_3_314_3424.UserOwnedObjectIds'>, 'permissions': <class 'pytan3.api_objects.soap_7_3_314_3424.PermissionList'>, 'roles': <class 'pytan3.api_objects.soap_7_3_314_3424.UserRoleList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of UserList

API_LIST_API_NAME = 'users'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.ActionListInfo(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'action_list_info'

str – Name of object used in API calls.

API_NAME_SRC = 'action_list_info'

str – Name of object in source file.

API_SIMPLE = {'highest_id': (<class 'int'>,), 'total_count': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.Action(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'action'

str – Name of object used in API calls.

API_NAME_SRC = 'action'

str – Name of object in source file.

API_SIMPLE = {'cache_row_id': (<class 'int'>,), 'comment': (<class 'str'>,), 'creation_time': (<class 'str'>,), 'distribute_seconds': (<class 'int'>,), 'expiration_time': (<class 'str'>,), 'expire_seconds': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'skip_lock_flag': (<class 'int'>,), 'start_time': (<class 'str'>,), 'status': (<class 'str'>,), 'stopped_flag': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'action_group': <class 'pytan3.api_objects.soap_7_3_314_3424.Group'>, 'approver': <class 'pytan3.api_objects.soap_7_3_314_3424.User'>, 'history_saved_question': <class 'pytan3.api_objects.soap_7_3_314_3424.SavedQuestion'>, 'metadata': <class 'pytan3.api_objects.soap_7_3_314_3424.MetadataList'>, 'package_spec': <class 'pytan3.api_objects.soap_7_3_314_3424.PackageSpec'>, 'saved_action': <class 'pytan3.api_objects.soap_7_3_314_3424.SavedAction'>, 'target_group': <class 'pytan3.api_objects.soap_7_3_314_3424.Group'>, 'user': <class 'pytan3.api_objects.soap_7_3_314_3424.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ActionList

API_LIST_API_NAME = 'actions'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.ActionStop(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'action_stop'

str – Name of object used in API calls.

API_NAME_SRC = 'action_stop'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'action': <class 'pytan3.api_objects.soap_7_3_314_3424.Action'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ActionStopList

API_LIST_API_NAME = 'action_stops'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.ArchivedQuestion(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'archived_question'

str – Name of object used in API calls.

API_NAME_SRC = 'archived_question'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ArchivedQuestionList

API_LIST_API_NAME = 'archived_questions'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.SavedQuestion(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'saved_question'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_question'

str – Name of object in source file.

API_SIMPLE = {'action_tracking_flag': (<class 'int'>,), 'archive_enabled_flag': (<class 'int'>,), 'cache_row_id': (<class 'int'>,), 'deleted_flag': (<class 'int'>,), 'expire_seconds': (<class 'int'>,), 'hidden_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'index': (<class 'int'>,), 'issue_seconds': (<class 'int'>,), 'issue_seconds_never_flag': (<class 'int'>,), 'keep_seconds': (<class 'int'>,), 'mod_time': (<class 'str'>,), 'most_recent_question_id': (<class 'int'>,), 'name': (<class 'str'>,), 'public_flag': (<class 'int'>,), 'query_text': (<class 'str'>,), 'row_count_flag': (<class 'int'>,), 'seeding_question_ids': (<class 'str'>,), 'skip_schedule_on_update_flag': (<class 'int'>,), 'sort_column': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'archive_owner': <class 'pytan3.api_objects.soap_7_3_314_3424.User'>, 'content_set': <class 'pytan3.api_objects.soap_7_3_314_3424.IdReference'>, 'metadata': <class 'pytan3.api_objects.soap_7_3_314_3424.MetadataList'>, 'mod_user': <class 'pytan3.api_objects.soap_7_3_314_3424.User'>, 'packages': <class 'pytan3.api_objects.soap_7_3_314_3424.PackageSpecList'>, 'question': <class 'pytan3.api_objects.soap_7_3_314_3424.Question'>, 'user': <class 'pytan3.api_objects.soap_7_3_314_3424.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SavedQuestionList

API_LIST_API_NAME = 'saved_questions'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.ParseJob(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'parse_job'

str – Name of object used in API calls.

API_NAME_SRC = 'parse_job'

str – Name of object in source file.

API_SIMPLE = {'parser_version': (<class 'int'>,), 'question_text': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ParseJobList

API_LIST_API_NAME = 'parse_jobs'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.Parameter(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'parameter'

str – Name of object used in API calls.

API_NAME_SRC = 'parameter'

str – Name of object in source file.

API_SIMPLE = {'key': (<class 'str'>,), 'type': (<class 'int'>,), 'value': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ParameterList

API_LIST_API_NAME = 'parameters'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.ParseResult(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'parse_result'

str – Name of object used in API calls.

API_NAME_SRC = 'parse_result'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,), 'parameter_definition': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'parameters': <class 'pytan3.api_objects.soap_7_3_314_3424.ParameterList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ParseResultList

API_LIST_API_NAME = 'parse_results'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.SensorReference(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'sensor_reference'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_reference'

str – Name of object in source file.

API_SIMPLE = {'name': (<class 'str'>,), 'real_ms_avg': (<class 'int'>,), 'start_char': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SensorReferenceList

API_LIST_API_NAME = 'sensor_references'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.ParseResultGroup(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'parse_result_group'

str – Name of object used in API calls.

API_NAME_SRC = 'parse_result_group'

str – Name of object in source file.

API_SIMPLE = {'question_text': (<class 'str'>,), 'score': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'parameter_values': <class 'pytan3.api_objects.soap_7_3_314_3424.ParameterValueList'>, 'parse_results': <class 'pytan3.api_objects.soap_7_3_314_3424.ParseResultList'>, 'question': <class 'pytan3.api_objects.soap_7_3_314_3424.Question'>, 'question_group_sensors': <class 'pytan3.api_objects.soap_7_3_314_3424.SensorList'>, 'sensor_references': <class 'pytan3.api_objects.soap_7_3_314_3424.SensorReferenceList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ParseResultGroupList

API_LIST_API_NAME = 'parse_result_groups'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.ClientCount(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'client_count'

str – Name of object used in API calls.

API_NAME_SRC = 'client_count'

str – Name of object in source file.

API_SIMPLE = {'count': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.PluginArgument(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'plugin_argument'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_argument'

str – Name of object in source file.

API_SIMPLE = {'name': (<class 'str'>,), 'type': (<class 'str'>,), 'value': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of PluginArgumentList

API_LIST_API_NAME = 'plugin_arguments'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.UploadFile(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'upload_file'

str – Name of object used in API calls.

API_NAME_SRC = 'upload_file'

str – Name of object in source file.

API_SIMPLE = {'bytes': (<class 'str'>,), 'destination_file': (<class 'str'>,), 'file_cached': (<class 'int'>,), 'file_size': (<class 'int'>,), 'force_overwrite': (<class 'int'>,), 'hash': (<class 'str'>,), 'id': (<class 'int'>,), 'key': (<class 'str'>,), 'part_size': (<class 'int'>,), 'percent_complete': (<class 'int'>,), 'start_pos': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of UploadFileList

API_LIST_API_NAME = 'upload_files'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.UploadFileStatus(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'upload_file_status'

str – Name of object used in API calls.

API_NAME_SRC = 'upload_file_status'

str – Name of object in source file.

API_SIMPLE = {'file_cached': (<class 'int'>,), 'hash': (<class 'str'>,), 'percent_complete': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'file_parts': <class 'pytan3.api_objects.soap_7_3_314_3424.UploadFileList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.Plugin(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'plugin'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin'

str – Name of object in source file.

API_SIMPLE = {'allow_rest': (<class 'int'>,), 'bundle': (<class 'str'>,), 'cache_row_id': (<class 'int'>,), 'execution_id': (<class 'int'>,), 'exit_code': (<class 'int'>,), 'filename': (<class 'str'>,), 'input': (<class 'str'>,), 'local_admin_flag': (<class 'int'>,), 'name': (<class 'str'>,), 'path': (<class 'str'>,), 'plugin_server': (<class 'str'>,), 'plugin_url': (<class 'str'>,), 'raw_http_request': (<class 'int'>,), 'raw_http_response': (<class 'int'>,), 'run_detached_flag': (<class 'int'>,), 'script_response': (<class 'str'>,), 'status': (<class 'str'>,), 'status_file_content': (<class 'str'>,), 'timeout_seconds': (<class 'int'>,), 'type': (<class 'str'>,), 'use_json_flag': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'arguments': <class 'pytan3.api_objects.soap_7_3_314_3424.PluginArgumentList'>, 'commands': <class 'pytan3.api_objects.soap_7_3_314_3424.PluginCommandList'>, 'content_set': <class 'pytan3.api_objects.soap_7_3_314_3424.ContentSet'>, 'metadata': <class 'pytan3.api_objects.soap_7_3_314_3424.MetadataList'>, 'permissions': <class 'pytan3.api_objects.soap_7_3_314_3424.PermissionList'>, 'sql_response': <class 'pytan3.api_objects.soap_7_3_314_3424.PluginSql'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {'SCRIPT': 'Script', 'SQL': 'SQL'}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of PluginList

API_LIST_API_NAME = 'plugins'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.PluginSchedule(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'plugin_schedule'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_schedule'

str – Name of object in source file.

API_SIMPLE = {'deleted_flag': (<class 'int'>,), 'enabled': (<class 'int'>,), 'end_date': (<class 'str'>,), 'end_hour': (<class 'int'>,), 'id': (<class 'int'>,), 'input': (<class 'str'>,), 'last_exit_code': (<class 'int'>,), 'last_run_text': (<class 'str'>,), 'last_run_time': (<class 'str'>,), 'modification_time': (<class 'str'>,), 'name': (<class 'str'>,), 'plugin_bundle': (<class 'str'>,), 'plugin_name': (<class 'str'>,), 'plugin_server': (<class 'str'>,), 'run_interval_seconds': (<class 'int'>,), 'run_on_days': (<class 'str'>,), 'start_date': (<class 'str'>,), 'start_hour': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'arguments': <class 'pytan3.api_objects.soap_7_3_314_3424.PluginArgumentList'>, 'last_run_sql': <class 'pytan3.api_objects.soap_7_3_314_3424.PluginSql'>, 'mod_user': <class 'pytan3.api_objects.soap_7_3_314_3424.User'>, 'user': <class 'pytan3.api_objects.soap_7_3_314_3424.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of PluginScheduleList

API_LIST_API_NAME = 'plugin_schedules'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.ComputerGroupSpec(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'computer_group_spec'

str – Name of object used in API calls.

API_NAME_SRC = 'computer_group_spec'

str – Name of object in source file.

API_SIMPLE = {'computer_name': (<class 'str'>,), 'id': (<class 'int'>,), 'ip_address': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ComputerSpecList

API_LIST_API_NAME = 'computer_specs'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.ComputerGroup(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'computer_group'

str – Name of object used in API calls.

API_NAME_SRC = 'computer_group'

str – Name of object in source file.

API_SIMPLE = {'deleted_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'computer_specs': <class 'pytan3.api_objects.soap_7_3_314_3424.ComputerSpecList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ComputerGroupList

API_LIST_API_NAME = 'computer_groups'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.VerifySignature(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'verify_signature'

str – Name of object used in API calls.

API_NAME_SRC = 'verify_signature'

str – Name of object in source file.

API_SIMPLE = {'bytes': (<class 'str'>,), 'id': (<class 'int'>,), 'type': (<class 'str'>,), 'verified': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.ObjectList(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'object_list'

str – Name of object used in API calls.

API_NAME_SRC = 'object_list'

str – Name of object in source file.

API_SIMPLE = {'export_id': (<class 'str'>,), 'export_version': (<class 'int'>,), 'import_content': (<class 'str'>,), 'server_info': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'action': <class 'pytan3.api_objects.soap_7_3_314_3424.Action'>, 'action_group': <class 'pytan3.api_objects.soap_7_3_314_3424.ActionGroup'>, 'action_groups': <class 'pytan3.api_objects.soap_7_3_314_3424.ActionGroupList'>, 'action_stop': <class 'pytan3.api_objects.soap_7_3_314_3424.ActionStop'>, 'action_stops': <class 'pytan3.api_objects.soap_7_3_314_3424.ActionStopList'>, 'actions': <class 'pytan3.api_objects.soap_7_3_314_3424.ActionList'>, 'archived_question': <class 'pytan3.api_objects.soap_7_3_314_3424.ArchivedQuestion'>, 'archived_questions': <class 'pytan3.api_objects.soap_7_3_314_3424.ArchivedQuestionList'>, 'audit_log': <class 'pytan3.api_objects.soap_7_3_314_3424.AuditLog'>, 'audit_logs': <class 'pytan3.api_objects.soap_7_3_314_3424.AuditLogList'>, 'client_count': <class 'pytan3.api_objects.soap_7_3_314_3424.ClientCount'>, 'client_status': <class 'pytan3.api_objects.soap_7_3_314_3424.ClientStatus'>, 'computer_group': <class 'pytan3.api_objects.soap_7_3_314_3424.ComputerGroup'>, 'computer_groups': <class 'pytan3.api_objects.soap_7_3_314_3424.ComputerGroupList'>, 'content_set': <class 'pytan3.api_objects.soap_7_3_314_3424.ContentSet'>, 'content_set_privilege': <class 'pytan3.api_objects.soap_7_3_314_3424.ContentSetPrivilege'>, 'content_set_privileges': <class 'pytan3.api_objects.soap_7_3_314_3424.ContentSetPrivilegeList'>, 'content_set_role': <class 'pytan3.api_objects.soap_7_3_314_3424.ContentSetRole'>, 'content_set_role_membership': <class 'pytan3.api_objects.soap_7_3_314_3424.ContentSetRoleMembership'>, 'content_set_role_memberships': <class 'pytan3.api_objects.soap_7_3_314_3424.ContentSetRoleMembershipList'>, 'content_set_role_privilege': <class 'pytan3.api_objects.soap_7_3_314_3424.ContentSetRolePrivilege'>, 'content_set_role_privileges': <class 'pytan3.api_objects.soap_7_3_314_3424.ContentSetRolePrivilegeList'>, 'content_set_roles': <class 'pytan3.api_objects.soap_7_3_314_3424.ContentSetRoleList'>, 'content_set_user_group_role_membership': <class 'pytan3.api_objects.soap_7_3_314_3424.ContentSetUserGroupRoleMembership'>, 'content_set_user_group_role_memberships': <class 'pytan3.api_objects.soap_7_3_314_3424.ContentSetUserGroupRoleMembershipList'>, 'content_sets': <class 'pytan3.api_objects.soap_7_3_314_3424.ContentSetList'>, 'effective_content_set_privileges': <class 'pytan3.api_objects.soap_7_3_314_3424.EffectiveContentSetPrivilegeRequest'>, 'group': <class 'pytan3.api_objects.soap_7_3_314_3424.Group'>, 'groups': <class 'pytan3.api_objects.soap_7_3_314_3424.GroupList'>, 'hashed_string': <class 'pytan3.api_objects.soap_7_3_314_3424.HashedString'>, 'hashed_strings': <class 'pytan3.api_objects.soap_7_3_314_3424.HashedStringList'>, 'import_conflict_details': <class 'pytan3.api_objects.soap_7_3_314_3424.ImportConflictDetailList'>, 'ldap_sync_connector': <class 'pytan3.api_objects.soap_7_3_314_3424.LdapSyncConnector'>, 'ldap_sync_connectors': <class 'pytan3.api_objects.soap_7_3_314_3424.LdapSyncConnectorList'>, 'package_file': <class 'pytan3.api_objects.soap_7_3_314_3424.PackageFile'>, 'package_files': <class 'pytan3.api_objects.soap_7_3_314_3424.PackageFileList'>, 'package_spec': <class 'pytan3.api_objects.soap_7_3_314_3424.PackageSpec'>, 'package_specs': <class 'pytan3.api_objects.soap_7_3_314_3424.PackageSpecList'>, 'parse_job': <class 'pytan3.api_objects.soap_7_3_314_3424.ParseJob'>, 'parse_jobs': <class 'pytan3.api_objects.soap_7_3_314_3424.ParseJobList'>, 'parse_result_group': <class 'pytan3.api_objects.soap_7_3_314_3424.ParseResultGroup'>, 'parse_result_groups': <class 'pytan3.api_objects.soap_7_3_314_3424.ParseResultGroupList'>, 'plugin': <class 'pytan3.api_objects.soap_7_3_314_3424.Plugin'>, 'plugin_schedule': <class 'pytan3.api_objects.soap_7_3_314_3424.PluginSchedule'>, 'plugin_schedules': <class 'pytan3.api_objects.soap_7_3_314_3424.PluginScheduleList'>, 'plugins': <class 'pytan3.api_objects.soap_7_3_314_3424.PluginList'>, 'question': <class 'pytan3.api_objects.soap_7_3_314_3424.Question'>, 'questions': <class 'pytan3.api_objects.soap_7_3_314_3424.QuestionList'>, 'roles': <class 'pytan3.api_objects.soap_7_3_314_3424.UserRoleList'>, 'saved_action': <class 'pytan3.api_objects.soap_7_3_314_3424.SavedAction'>, 'saved_action_approval': <class 'pytan3.api_objects.soap_7_3_314_3424.SavedActionApproval'>, 'saved_action_approvals': <class 'pytan3.api_objects.soap_7_3_314_3424.SavedActionApprovalList'>, 'saved_actions': <class 'pytan3.api_objects.soap_7_3_314_3424.SavedActionList'>, 'saved_question': <class 'pytan3.api_objects.soap_7_3_314_3424.SavedQuestion'>, 'saved_question_package_specs': <class 'pytan3.api_objects.soap_7_3_314_3424.SavedQuestionPackageSpecs'>, 'saved_question_question': <class 'pytan3.api_objects.soap_7_3_314_3424.SavedQuestionQuestion'>, 'saved_question_questions': <class 'pytan3.api_objects.soap_7_3_314_3424.SavedQuestionQuestionList'>, 'saved_questions': <class 'pytan3.api_objects.soap_7_3_314_3424.SavedQuestionList'>, 'sensor': <class 'pytan3.api_objects.soap_7_3_314_3424.Sensor'>, 'sensor_stat': <class 'pytan3.api_objects.soap_7_3_314_3424.SensorStat'>, 'sensor_stats': <class 'pytan3.api_objects.soap_7_3_314_3424.SensorStatList'>, 'sensors': <class 'pytan3.api_objects.soap_7_3_314_3424.SensorList'>, 'server_host': <class 'pytan3.api_objects.soap_7_3_314_3424.ServerHost'>, 'server_hosts': <class 'pytan3.api_objects.soap_7_3_314_3424.ServerHostList'>, 'server_throttle': <class 'pytan3.api_objects.soap_7_3_314_3424.ServerThrottle'>, 'server_throttle_status': <class 'pytan3.api_objects.soap_7_3_314_3424.ServerThrottleStatus'>, 'server_throttle_statuses': <class 'pytan3.api_objects.soap_7_3_314_3424.ServerThrottleStatusList'>, 'server_throttles': <class 'pytan3.api_objects.soap_7_3_314_3424.ServerThrottleList'>, 'site_throttle': <class 'pytan3.api_objects.soap_7_3_314_3424.SiteThrottle'>, 'site_throttle_status': <class 'pytan3.api_objects.soap_7_3_314_3424.SiteThrottleStatus'>, 'site_throttles': <class 'pytan3.api_objects.soap_7_3_314_3424.SiteThrottleList'>, 'site_throttles_statuses': <class 'pytan3.api_objects.soap_7_3_314_3424.SiteThrottleStatusList'>, 'soap_error': <class 'pytan3.api_objects.soap_7_3_314_3424.SoapError'>, 'solution': <class 'pytan3.api_objects.soap_7_3_314_3424.Solution'>, 'solutions': <class 'pytan3.api_objects.soap_7_3_314_3424.SolutionList'>, 'system_setting': <class 'pytan3.api_objects.soap_7_3_314_3424.SystemSetting'>, 'system_settings': <class 'pytan3.api_objects.soap_7_3_314_3424.SystemSettingList'>, 'system_status': <class 'pytan3.api_objects.soap_7_3_314_3424.SystemStatusList'>, 'upload_file': <class 'pytan3.api_objects.soap_7_3_314_3424.UploadFile'>, 'upload_file_status': <class 'pytan3.api_objects.soap_7_3_314_3424.UploadFileStatus'>, 'user': <class 'pytan3.api_objects.soap_7_3_314_3424.User'>, 'user_group': <class 'pytan3.api_objects.soap_7_3_314_3424.UserGroup'>, 'user_groups': <class 'pytan3.api_objects.soap_7_3_314_3424.UserGroupList'>, 'users': <class 'pytan3.api_objects.soap_7_3_314_3424.UserList'>, 'verify_signature': <class 'pytan3.api_objects.soap_7_3_314_3424.VerifySignature'>, 'white_listed_url': <class 'pytan3.api_objects.soap_7_3_314_3424.WhiteListedUrl'>, 'white_listed_urls': <class 'pytan3.api_objects.soap_7_3_314_3424.WhiteListedUrlList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.ImportConflictDetail(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'import_conflict_detail'

str – Name of object used in API calls.

API_NAME_SRC = 'import_conflict_detail'

str – Name of object in source file.

API_SIMPLE = {'diff': (<class 'str'>,), 'is_new': (<class 'int'>,), 'name': (<class 'str'>,), 'type': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ImportConflictDetailList

API_LIST_API_NAME = 'import_conflict_details'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.CacheFilter(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'cache_filter'

str – Name of object used in API calls.

API_NAME_SRC = 'cache_filter'

str – Name of object in source file.

API_SIMPLE = {'and_flag': (<class 'int'>,), 'field': (<class 'str'>,), 'not_flag': (<class 'int'>,), 'operator': (<class 'str'>,), 'type': (<class 'str'>,), 'value': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'sub_filters': <class 'pytan3.api_objects.soap_7_3_314_3424.CacheFilterList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of CacheFilterList

API_LIST_API_NAME = 'cache_filters'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.Options(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'options'

str – Name of object used in API calls.

API_NAME_SRC = 'options'

str – Name of object in source file.

API_SIMPLE = {'aggregate_by_value_flag': (<class 'int'>,), 'aggregate_over_time_flag': (<class 'int'>,), 'allow_cdata_base64_encode_flag': (<class 'int'>,), 'audit_history_size': (<class 'int'>,), 'cache_expiration': (<class 'int'>,), 'cache_id': (<class 'int'>,), 'cache_sort_fields': (<class 'str'>,), 'cdata_base64_encoded': (<class 'int'>,), 'context_id': (<class 'int'>,), 'disable_live_snapshots': (<class 'int'>,), 'export_dont_include_related': (<class 'int'>,), 'export_flag': (<class 'int'>,), 'export_format': (<class 'int'>,), 'export_hide_csv_header_flag': (<class 'int'>,), 'export_leading_text': (<class 'str'>,), 'export_omit_soap_envelope': (<class 'int'>,), 'export_trailing_text': (<class 'str'>,), 'filter_not_flag': (<class 'int'>,), 'filter_string': (<class 'str'>,), 'flags': (<class 'int'>,), 'hide_errors_flag': (<class 'int'>,), 'hide_no_results_flag': (<class 'int'>,), 'import_analyze_conflicts_only': (<class 'int'>,), 'import_existing_ignore_content_set': (<class 'int'>,), 'include_answer_times_flag': (<class 'int'>,), 'include_hashes_flag': (<class 'int'>,), 'include_hidden_flag': (<class 'int'>,), 'include_user_details': (<class 'int'>,), 'include_user_owned_object_ids_flag': (<class 'int'>,), 'json_pretty_print': (<class 'int'>,), 'live_snapshot_always_use_seconds': (<class 'int'>,), 'live_snapshot_expiration_seconds': (<class 'int'>,), 'live_snapshot_invalidate_report_count_percentage': (<class 'int'>,), 'live_snapshot_report_count_threshold': (<class 'int'>,), 'most_recent_flag': (<class 'int'>,), 'no_result_row_collation_flag': (<class 'int'>,), 'pct_done_limit': (<class 'int'>,), 'recent_result_buckets': (<class 'str'>,), 'return_cdata_flag': (<class 'int'>,), 'return_lists_flag': (<class 'int'>,), 'row_count': (<class 'int'>,), 'row_counts_only_flag': (<class 'int'>,), 'row_start': (<class 'int'>,), 'sample_count': (<class 'int'>,), 'sample_frequency': (<class 'int'>,), 'sample_start': (<class 'int'>,), 'saved_question_qids_allow_multiple_flag': (<class 'int'>,), 'saved_question_qids_ignore_mr_group_flag': (<class 'int'>,), 'saved_question_qids_include_expired_flag': (<class 'int'>,), 'saved_question_qids_reissue_flag': (<class 'int'>,), 'script_data': (<class 'str'>,), 'sort_order': (<class 'str'>,), 'suppress_object_list': (<class 'int'>,), 'suppress_scripts': (<class 'int'>,), 'use_error_objects': (<class 'int'>,), 'use_json': (<class 'int'>,), 'use_user_context_flag': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_filters': <class 'pytan3.api_objects.soap_7_3_314_3424.CacheFilterList'>, 'import_conflict_options': <class 'pytan3.api_objects.soap_7_3_314_3424.ImportConflictOptions'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.ContentSet(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'content_set'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set'

str – Name of object in source file.

API_SIMPLE = {'description': (<class 'str'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'reserved_name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'metadata': <class 'pytan3.api_objects.soap_7_3_314_3424.MetadataList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ContentSetList

API_LIST_API_NAME = 'content_sets'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.ContentSetRolePrivilegeOnRole(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'content_set_role_privilege_on_role'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role_privilege_on_role'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set': <class 'pytan3.api_objects.soap_7_3_314_3424.IdReference'>, 'content_set_privilege': <class 'pytan3.api_objects.soap_7_3_314_3424.IdReference'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ContentSetRolePrivilegeOnRoleList

API_LIST_API_NAME = 'content_set_role_privilege_on_roles'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.ContentSetRole(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'content_set_role'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role'

str – Name of object in source file.

API_SIMPLE = {'all_content_sets_flag': (<class 'int'>,), 'category': (<class 'str'>,), 'deny_flag': (<class 'int'>,), 'description': (<class 'str'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'reserved_name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set_role_privileges': <class 'pytan3.api_objects.soap_7_3_314_3424.ContentSetRolePrivilegeOnRoleList'>, 'metadata': <class 'pytan3.api_objects.soap_7_3_314_3424.MetadataList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ContentSetRoleList

API_LIST_API_NAME = 'content_set_roles'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.ContentSetRoleMembership(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'content_set_role_membership'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role_membership'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set_role': <class 'pytan3.api_objects.soap_7_3_314_3424.IdReference'>, 'user': <class 'pytan3.api_objects.soap_7_3_314_3424.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ContentSetRoleMembershipList

API_LIST_API_NAME = 'content_set_role_memberships'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.ContentSetUserGroupRoleMembership(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'content_set_user_group_role_membership'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_user_group_role_membership'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set_role': <class 'pytan3.api_objects.soap_7_3_314_3424.IdReference'>, 'user_group': <class 'pytan3.api_objects.soap_7_3_314_3424.IdReference'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ContentSetUserGroupRoleMembershipList

API_LIST_API_NAME = 'content_set_user_group_role_memberships'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.ContentSetPrivilege(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'content_set_privilege'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_privilege'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,), 'name': (<class 'str'>,), 'privilege_module': (<class 'str'>,), 'privilege_type': (<class 'str'>,), 'reserved_name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'metadata': <class 'pytan3.api_objects.soap_7_3_314_3424.MetadataList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ContentSetPrivilegeList

API_LIST_API_NAME = 'content_set_privileges'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.ContentSetRolePrivilege(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'content_set_role_privilege'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role_privilege'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set': <class 'pytan3.api_objects.soap_7_3_314_3424.IdReference'>, 'content_set_privilege': <class 'pytan3.api_objects.soap_7_3_314_3424.IdReference'>, 'content_set_role': <class 'pytan3.api_objects.soap_7_3_314_3424.IdReference'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ContentSetRolePrivilegeList

API_LIST_API_NAME = 'content_set_role_privileges'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.EffectiveContentSetPrivilege(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'effective_content_set_privilege'

str – Name of object used in API calls.

API_NAME_SRC = 'effective_content_set_privilege'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set': <class 'pytan3.api_objects.soap_7_3_314_3424.ContentSet'>, 'content_set_privilege_list': <class 'pytan3.api_objects.soap_7_3_314_3424.ContentSetPrivilegeList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of EffectiveContentSetPrivilegeList

API_LIST_API_NAME = 'effective_content_set_privileges'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.Dashboard(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'dashboard'

str – Name of object used in API calls.

API_NAME_SRC = 'dashboard'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,), 'name': (<class 'str'>,), 'public_flag': (<class 'int'>,), 'text': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set': <class 'pytan3.api_objects.soap_7_3_314_3424.ContentSet'>, 'group': <class 'pytan3.api_objects.soap_7_3_314_3424.Group'>, 'saved_question_list': <class 'pytan3.api_objects.soap_7_3_314_3424.SavedQuestionList'>, 'user': <class 'pytan3.api_objects.soap_7_3_314_3424.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of DashboardList

API_LIST_API_NAME = 'dashboards'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.DashboardGroup(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'dashboard_group'

str – Name of object used in API calls.

API_NAME_SRC = 'dashboard_group'

str – Name of object in source file.

API_SIMPLE = {'display_index': (<class 'int'>,), 'editable_flag': (<class 'int'>,), 'icon': (<class 'str'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'other_flag': (<class 'int'>,), 'public_flag': (<class 'int'>,), 'text': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set': <class 'pytan3.api_objects.soap_7_3_314_3424.ContentSet'>, 'dashboard_list': <class 'pytan3.api_objects.soap_7_3_314_3424.DashboardList'>, 'user': <class 'pytan3.api_objects.soap_7_3_314_3424.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.UserGroup(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'user_group'

str – Name of object used in API calls.

API_NAME_SRC = 'user_group'

str – Name of object in source file.

API_SIMPLE = {'deleted_flag': (<class 'int'>,), 'exclusive_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set_roles': <class 'pytan3.api_objects.soap_7_3_314_3424.ContentSetRoleList'>, 'group': <class 'pytan3.api_objects.soap_7_3_314_3424.Group'>, 'user_list': <class 'pytan3.api_objects.soap_7_3_314_3424.UserList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of UserGroupList

API_LIST_API_NAME = 'user_groups'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.Solution(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'solution'

str – Name of object used in API calls.

API_NAME_SRC = 'solution'

str – Name of object in source file.

API_SIMPLE = {'category': (<class 'str'>,), 'delete_xml_url': (<class 'str'>,), 'deleted_flag': (<class 'int'>,), 'description': (<class 'str'>,), 'dup_resolve_type': (<class 'int'>,), 'id': (<class 'int'>,), 'imported_by': (<class 'str'>,), 'imported_version': (<class 'str'>,), 'installed_xml_url': (<class 'str'>,), 'last_update': (<class 'str'>,), 'name': (<class 'str'>,), 'signature': (<class 'str'>,), 'solution_id': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SolutionList

API_LIST_API_NAME = 'solutions'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.ActionGroup(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'action_group'

str – Name of object used in API calls.

API_NAME_SRC = 'action_group'

str – Name of object in source file.

API_SIMPLE = {'and_flag': (<class 'int'>,), 'deleted_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'public_flag': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'groups': <class 'pytan3.api_objects.soap_7_3_314_3424.GroupList'>, 'user_groups': <class 'pytan3.api_objects.soap_7_3_314_3424.UserGroupList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ActionGroupList

API_LIST_API_NAME = 'action_groups'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.SavedQuestionPackageSpecs(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'saved_question_package_specs'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_question_package_specs'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'packages': <class 'pytan3.api_objects.soap_7_3_314_3424.PackageSpecList'>, 'saved_question': <class 'pytan3.api_objects.soap_7_3_314_3424.IdReference'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.SavedQuestionQuestion(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'saved_question_question'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_question_question'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'questions': <class 'pytan3.api_objects.soap_7_3_314_3424.QuestionList'>, 'saved_question': <class 'pytan3.api_objects.soap_7_3_314_3424.IdReference'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SavedQuestionQuestionList

API_LIST_API_NAME = 'saved_question_questions'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.LdapSyncConnector(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'ldap_sync_connector'

str – Name of object used in API calls.

API_NAME_SRC = 'ldap_sync_connector'

str – Name of object in source file.

API_SIMPLE = {'base_groups': (<class 'str'>,), 'base_users': (<class 'str'>,), 'disable_ldap_auth': (<class 'int'>,), 'disable_referrals_flag': (<class 'int'>,), 'enable': (<class 'int'>,), 'filter_groups': (<class 'str'>,), 'filter_users': (<class 'str'>,), 'group_id': (<class 'str'>,), 'group_member': (<class 'str'>,), 'group_name': (<class 'str'>,), 'host': (<class 'str'>,), 'id': (<class 'int'>,), 'last_sync_result': (<class 'str'>,), 'last_sync_timestamp': (<class 'str'>,), 'ldap_password': (<class 'str'>,), 'ldap_user': (<class 'str'>,), 'members_only_flag': (<class 'int'>,), 'name': (<class 'str'>,), 'port': (<class 'int'>,), 'secure': (<class 'int'>,), 'use_ntlm': (<class 'int'>,), 'user_display_name': (<class 'str'>,), 'user_domain': (<class 'str'>,), 'user_id': (<class 'str'>,), 'user_member_of': (<class 'str'>,), 'user_name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of LdapSyncConnectorList

API_LIST_API_NAME = 'ldap_sync_connectors'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.ServerThrottle(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'server_throttle'

str – Name of object used in API calls.

API_NAME_SRC = 'server_throttle'

str – Name of object in source file.

API_SIMPLE = {'bandwidth_bytes_limit': (<class 'int'>,), 'connection_limit': (<class 'int'>,), 'deleted_flag': (<class 'int'>,), 'download_bandwidth_bytes_limit': (<class 'int'>,), 'download_connection_limit': (<class 'int'>,), 'id': (<class 'int'>,), 'ip_address': (<class 'str'>,), 'name': (<class 'str'>,), 'sensor_bandwidth_bytes_limit': (<class 'int'>,), 'sensor_connection_limit': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ServerThrottleList

API_LIST_API_NAME = 'server_throttles'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.SiteThrottle(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'site_throttle'

str – Name of object used in API calls.

API_NAME_SRC = 'site_throttle'

str – Name of object in source file.

API_SIMPLE = {'all_subnets_flag': (<class 'int'>,), 'bandwidth_bytes_limit': (<class 'int'>,), 'deleted_flag': (<class 'int'>,), 'download_bandwidth_bytes_limit': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'sensor_bandwidth_bytes_limit': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'subnets': <class 'pytan3.api_objects.soap_7_3_314_3424.SiteThrottleSubnetList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SiteThrottleList

API_LIST_API_NAME = 'site_throttles'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.SiteThrottleSubnet(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'site_throttle_subnet'

str – Name of object used in API calls.

API_NAME_SRC = 'site_throttle_subnet'

str – Name of object in source file.

API_SIMPLE = {'range': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SiteThrottleSubnetList

API_LIST_API_NAME = 'site_throttle_subnets'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.ServerThrottleStatus(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'server_throttle_status'

str – Name of object used in API calls.

API_NAME_SRC = 'server_throttle_status'

str – Name of object in source file.

API_SIMPLE = {'download_queue_delay_milliseconds': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'queue_delay_milliseconds': (<class 'int'>,), 'sensor_queue_delay_milliseconds': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ServerThrottleStatusList

API_LIST_API_NAME = 'server_throttle_statuses'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.SiteThrottleStatus(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'site_throttle_status'

str – Name of object used in API calls.

API_NAME_SRC = 'site_throttle_status'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,), 'name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'subnets': <class 'pytan3.api_objects.soap_7_3_314_3424.SiteThrottleSubnetStatusList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SiteThrottleStatusList

API_LIST_API_NAME = 'site_throttles_statuses'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.SiteThrottleSubnetStatus(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'site_throttle_subnet_status'

str – Name of object used in API calls.

API_NAME_SRC = 'site_throttle_subnet_status'

str – Name of object in source file.

API_SIMPLE = {'download_queue_delay_milliseconds': (<class 'int'>,), 'queue_delay_milliseconds': (<class 'int'>,), 'range': (<class 'str'>,), 'sensor_queue_delay_milliseconds': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SiteThrottleSubnetStatusList

API_LIST_API_NAME = 'site_throttle_subnet_statuss'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.HashedString(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiItem

Automagically generated API object.

API_NAME = 'hashed_string'

str – Name of object used in API calls.

API_NAME_SRC = 'hashed_string'

str – Name of object in source file.

API_SIMPLE = {'collision_flag': (<class 'int'>,), 'error_flag': (<class 'int'>,), 'first_collision': (<class 'str'>,), 'second_collision': (<class 'str'>,), 'sensor_hash': (<class 'int'>,), 'value': (<class 'str'>,), 'value_hash': (<class 'int'>,), 'which_computer_id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'first_computer_id': <class 'pytan3.api_objects.soap_7_3_314_3424.ComputerIdList'>, 'second_computer_id': <class 'pytan3.api_objects.soap_7_3_314_3424.ComputerIdList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of HashedStringList

API_LIST_API_NAME = 'hashed_strings'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3424.SensorQueryList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'sensor_querys'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_query_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'query'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SensorQuery

class pytan3.api_objects.soap_7_3_314_3424.SensorSubcolumnList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'sensor_subcolumns'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_subcolumn_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'subcolumn'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SensorSubcolumn

class pytan3.api_objects.soap_7_3_314_3424.StringHintList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'string_hints'

str – Name of object used in API calls.

API_NAME_SRC = 'string_hint_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'string_hint'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'str'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.soap_7_3_314_3424.SensorList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'sensors'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_3_314_3424.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'sensor'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Sensor

class pytan3.api_objects.soap_7_3_314_3424.SensorStatList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'sensor_stats'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_stat_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'sensor_stat'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SensorStat

class pytan3.api_objects.soap_7_3_314_3424.SavedActionApprovalList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'saved_action_approvals'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_action_approval_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'saved_action_approval'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SavedActionApproval

class pytan3.api_objects.soap_7_3_314_3424.SavedActionRowIdList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'saved_action_row_ids'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_action_row_id_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'row_id'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'int'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.soap_7_3_314_3424.SavedActionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'saved_actions'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_action_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_3_314_3424.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'saved_action'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SavedAction

class pytan3.api_objects.soap_7_3_314_3424.AuditDataList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'audit_datas'

str – Name of object used in API calls.

API_NAME_SRC = 'audit_data_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_3_314_3424.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'entry'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of AuditData

class pytan3.api_objects.soap_7_3_314_3424.AuditLogList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'audit_logs'

str – Name of object used in API calls.

API_NAME_SRC = 'audit_log_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'audit_log'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of AuditLog

class pytan3.api_objects.soap_7_3_314_3424.ServerList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'servers'

str – Name of object used in API calls.

API_NAME_SRC = 'server_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'server'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Server

class pytan3.api_objects.soap_7_3_314_3424.ServerHost(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'server_host'

str – Name of object used in API calls.

API_NAME_SRC = 'server_host'

str – Name of object in source file.

API_SIMPLE = {'heart_beat_age_in_minute': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'servers'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ServerList

class pytan3.api_objects.soap_7_3_314_3424.ServerHostList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'server_hosts'

str – Name of object used in API calls.

API_NAME_SRC = 'server_host_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'server_host'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ServerHost

class pytan3.api_objects.soap_7_3_314_3424.MetadataList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'metadatas'

str – Name of object used in API calls.

API_NAME_SRC = 'metadata_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'item'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of MetadataItem

class pytan3.api_objects.soap_7_3_314_3424.GroupList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'groups'

str – Name of object used in API calls.

API_NAME_SRC = 'group_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_3_314_3424.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'group'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Group

class pytan3.api_objects.soap_7_3_314_3424.FilterList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'filters'

str – Name of object used in API calls.

API_NAME_SRC = 'filter_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'filter'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Filter

class pytan3.api_objects.soap_7_3_314_3424.SelectList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'selects'

str – Name of object used in API calls.

API_NAME_SRC = 'select_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'select'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Select

class pytan3.api_objects.soap_7_3_314_3424.ErrorList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'errors'

str – Name of object used in API calls.

API_NAME_SRC = 'error_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'error'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of XmlError

class pytan3.api_objects.soap_7_3_314_3424.QuestionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'questions'

str – Name of object used in API calls.

API_NAME_SRC = 'question_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_3_314_3424.CacheInfo'>, 'info': <class 'pytan3.api_objects.soap_7_3_314_3424.QuestionListInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'question'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Question

class pytan3.api_objects.soap_7_3_314_3424.PackageFileTemplateList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'package_file_templates'

str – Name of object used in API calls.

API_NAME_SRC = 'package_file_template_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'file_template'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of PackageFileTemplate

class pytan3.api_objects.soap_7_3_314_3424.PackageFileStatusList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'package_file_statuss'

str – Name of object used in API calls.

API_NAME_SRC = 'package_file_status_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'status'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of PackageFileStatus

class pytan3.api_objects.soap_7_3_314_3424.PackageFileList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'package_files'

str – Name of object used in API calls.

API_NAME_SRC = 'package_file_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'file'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of PackageFile

class pytan3.api_objects.soap_7_3_314_3424.PackageSpecList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'package_specs'

str – Name of object used in API calls.

API_NAME_SRC = 'package_spec_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_3_314_3424.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'package_spec'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of PackageSpec

class pytan3.api_objects.soap_7_3_314_3424.WhiteListedUrlList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'white_listed_urls'

str – Name of object used in API calls.

API_NAME_SRC = 'white_listed_url_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'white_listed_url'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of WhiteListedUrl

class pytan3.api_objects.soap_7_3_314_3424.VersionAggregateList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'version_aggregates'

str – Name of object used in API calls.

API_NAME_SRC = 'version_aggregate_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'version'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of VersionAggregate

class pytan3.api_objects.soap_7_3_314_3424.SystemStatusList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'system_status'

str – Name of object used in API calls.

API_NAME_SRC = 'system_status_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'aggregate': <class 'pytan3.api_objects.soap_7_3_314_3424.SystemStatusAggregate'>, 'cache_info': <class 'pytan3.api_objects.soap_7_3_314_3424.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'client_status'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ClientStatus

class pytan3.api_objects.soap_7_3_314_3424.SystemSettingList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'system_settings'

str – Name of object used in API calls.

API_NAME_SRC = 'system_setting_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_3_314_3424.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'system_setting'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SystemSetting

class pytan3.api_objects.soap_7_3_314_3424.UserList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'users'

str – Name of object used in API calls.

API_NAME_SRC = 'user_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'user'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of User

class pytan3.api_objects.soap_7_3_314_3424.PermissionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'permissions'

str – Name of object used in API calls.

API_NAME_SRC = 'permission_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {'ACTION_APPROVE': 'action_approval', 'ACTION_READ': 'action_read', 'ACTION_WRITE': 'action_write', 'ADMIN': 'admin', 'CLIENTS_READ': 'clients_read', 'CONTENT_ADMIN': 'content_admin', 'NOTIFICATION_WRITE': 'notification_write', 'QUESTION_LOG_READ': 'question_log_read', 'QUESTION_READ': 'question_read', 'QUESTION_WRITE': 'question_write', 'SENSOR_READ': 'sensor_read', 'SENSOR_WRITE': 'sensor_write'}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'permission'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'str'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.soap_7_3_314_3424.UserRoleList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'roles'

str – Name of object used in API calls.

API_NAME_SRC = 'user_role_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'role'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of UserRole

class pytan3.api_objects.soap_7_3_314_3424.ActionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'actions'

str – Name of object used in API calls.

API_NAME_SRC = 'action_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_3_314_3424.CacheInfo'>, 'info': <class 'pytan3.api_objects.soap_7_3_314_3424.ActionListInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'action'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Action

class pytan3.api_objects.soap_7_3_314_3424.ActionStopList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'action_stops'

str – Name of object used in API calls.

API_NAME_SRC = 'action_stop_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'action_stop'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ActionStop

class pytan3.api_objects.soap_7_3_314_3424.ArchivedQuestionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'archived_questions'

str – Name of object used in API calls.

API_NAME_SRC = 'archived_question_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'archived_question'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ArchivedQuestion

class pytan3.api_objects.soap_7_3_314_3424.SavedQuestionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'saved_questions'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_question_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_3_314_3424.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'saved_question'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SavedQuestion

class pytan3.api_objects.soap_7_3_314_3424.ParseJobList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'parse_jobs'

str – Name of object used in API calls.

API_NAME_SRC = 'parse_job_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'parse_job'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ParseJob

class pytan3.api_objects.soap_7_3_314_3424.ParseResultGroupList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'parse_result_groups'

str – Name of object used in API calls.

API_NAME_SRC = 'parse_result_group_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'parse_result_group'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ParseResultGroup

class pytan3.api_objects.soap_7_3_314_3424.ParseResultList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'parse_results'

str – Name of object used in API calls.

API_NAME_SRC = 'parse_result_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'parse_result'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ParseResult

class pytan3.api_objects.soap_7_3_314_3424.ParameterList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'parameters'

str – Name of object used in API calls.

API_NAME_SRC = 'parameter_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'parameter'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Parameter

class pytan3.api_objects.soap_7_3_314_3424.ParameterValueList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'parameter_values'

str – Name of object used in API calls.

API_NAME_SRC = 'parameter_value_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'value'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'str'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.soap_7_3_314_3424.SensorReferenceList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'sensor_references'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_reference_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'sensor_reference'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SensorReference

class pytan3.api_objects.soap_7_3_314_3424.PluginArgumentList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'plugin_arguments'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_argument_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'argument'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of PluginArgument

class pytan3.api_objects.soap_7_3_314_3424.PluginSqlResultList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'plugin_sql_results'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_sql_result_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'value'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'str'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.soap_7_3_314_3424.PluginSqlColumnList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'plugin_sql_columns'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_sql_column_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'name'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'str'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.soap_7_3_314_3424.PluginSql(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'plugin_sql'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_sql'

str – Name of object in source file.

API_SIMPLE = {'result_count': (<class 'int'>,), 'rows_affected': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'columns': <class 'pytan3.api_objects.soap_7_3_314_3424.PluginSqlColumnList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'result_row'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of PluginSqlResultList

class pytan3.api_objects.soap_7_3_314_3424.PluginCommandList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'plugin_commands'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_command_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'command'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'str'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.soap_7_3_314_3424.UploadFileList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'upload_files'

str – Name of object used in API calls.

API_NAME_SRC = 'upload_file_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'upload_file'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of UploadFile

class pytan3.api_objects.soap_7_3_314_3424.PluginList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'plugins'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_3_314_3424.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'plugin'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Plugin

class pytan3.api_objects.soap_7_3_314_3424.PluginScheduleList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'plugin_schedules'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_schedule_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_3_314_3424.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'plugin_schedule'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of PluginSchedule

class pytan3.api_objects.soap_7_3_314_3424.ComputerSpecList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'computer_specs'

str – Name of object used in API calls.

API_NAME_SRC = 'computer_spec_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_3_314_3424.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'computer_spec'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ComputerGroupSpec

class pytan3.api_objects.soap_7_3_314_3424.ComputerGroupList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'computer_groups'

str – Name of object used in API calls.

API_NAME_SRC = 'computer_group_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_3_314_3424.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'computer_group'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ComputerGroup

class pytan3.api_objects.soap_7_3_314_3424.ImportConflictDetailList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'import_conflict_details'

str – Name of object used in API calls.

API_NAME_SRC = 'import_conflict_detail_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'import_conflict_detail'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ImportConflictDetail

class pytan3.api_objects.soap_7_3_314_3424.CacheFilterList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'cache_filters'

str – Name of object used in API calls.

API_NAME_SRC = 'cache_filter_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'filter'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of CacheFilter

class pytan3.api_objects.soap_7_3_314_3424.ImportConflictOptions(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'import_conflict_options'

str – Name of object used in API calls.

API_NAME_SRC = 'import_conflict_options'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'import_conflict_option'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'int'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.soap_7_3_314_3424.ContentSetList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'content_sets'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'content_set'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ContentSet

class pytan3.api_objects.soap_7_3_314_3424.ContentSetRolePrivilegeOnRoleList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'content_set_role_privilege_on_roles'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role_privilege_on_role_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'content_set_role_privilege'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ContentSetRolePrivilegeOnRole

class pytan3.api_objects.soap_7_3_314_3424.ContentSetRoleList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'content_set_roles'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'content_set_role'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ContentSetRole

class pytan3.api_objects.soap_7_3_314_3424.ContentSetRoleMembershipList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'content_set_role_memberships'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role_membership_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'content_set_role_membership'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ContentSetRoleMembership

class pytan3.api_objects.soap_7_3_314_3424.ContentSetUserGroupRoleMembershipList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'content_set_user_group_role_memberships'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_user_group_role_membership_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'content_set_user_group_role_membership'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ContentSetUserGroupRoleMembership

class pytan3.api_objects.soap_7_3_314_3424.ContentSetPrivilegeList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'content_set_privileges'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_privilege_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'content_set_privilege'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ContentSetPrivilege

class pytan3.api_objects.soap_7_3_314_3424.ContentSetRolePrivilegeList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'content_set_role_privileges'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role_privilege_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'content_set_role_privilege'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ContentSetRolePrivilege

class pytan3.api_objects.soap_7_3_314_3424.EffectiveContentSetPrivilegeRequest(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'effective_content_set_privilege_request'

str – Name of object used in API calls.

API_NAME_SRC = 'effective_content_set_privilege_request'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'user'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of User

class pytan3.api_objects.soap_7_3_314_3424.EffectiveContentSetPrivilegeList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'effective_content_set_privileges'

str – Name of object used in API calls.

API_NAME_SRC = 'effective_content_set_privilege_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'effective_content_set_privilege'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of EffectiveContentSetPrivilege

class pytan3.api_objects.soap_7_3_314_3424.DashboardList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'dashboards'

str – Name of object used in API calls.

API_NAME_SRC = 'dashboard_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'dashboard'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Dashboard

class pytan3.api_objects.soap_7_3_314_3424.UserGroupList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'user_groups'

str – Name of object used in API calls.

API_NAME_SRC = 'user_group_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'user_group'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of UserGroup

class pytan3.api_objects.soap_7_3_314_3424.SolutionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'solutions'

str – Name of object used in API calls.

API_NAME_SRC = 'solution_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'solution'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Solution

class pytan3.api_objects.soap_7_3_314_3424.ActionGroupList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'action_groups'

str – Name of object used in API calls.

API_NAME_SRC = 'action_group_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'action_group'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ActionGroup

class pytan3.api_objects.soap_7_3_314_3424.SavedQuestionQuestionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'saved_question_questions'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_question_question_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'saved_question_question'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SavedQuestionQuestion

class pytan3.api_objects.soap_7_3_314_3424.LdapSyncConnectorList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'ldap_sync_connectors'

str – Name of object used in API calls.

API_NAME_SRC = 'ldap_sync_connector_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'ldap_sync_connector'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of LdapSyncConnector

class pytan3.api_objects.soap_7_3_314_3424.ServerThrottleList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'server_throttles'

str – Name of object used in API calls.

API_NAME_SRC = 'server_throttle_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'server_throttle'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ServerThrottle

class pytan3.api_objects.soap_7_3_314_3424.SiteThrottleList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'site_throttles'

str – Name of object used in API calls.

API_NAME_SRC = 'site_throttle_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'site_throttle'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SiteThrottle

class pytan3.api_objects.soap_7_3_314_3424.SiteThrottleSubnetList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'site_throttle_subnets'

str – Name of object used in API calls.

API_NAME_SRC = 'site_throttle_subnet_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'subnet'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SiteThrottleSubnet

class pytan3.api_objects.soap_7_3_314_3424.ServerThrottleStatusList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'server_throttle_statuses'

str – Name of object used in API calls.

API_NAME_SRC = 'server_throttle_status_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'server_throttle_status'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ServerThrottleStatus

class pytan3.api_objects.soap_7_3_314_3424.SiteThrottleStatusList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'site_throttles_statuses'

str – Name of object used in API calls.

API_NAME_SRC = 'site_throttle_status_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'site_throttle_status'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SiteThrottleStatus

class pytan3.api_objects.soap_7_3_314_3424.SiteThrottleSubnetStatusList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'site_throttle_subnet_statuss'

str – Name of object used in API calls.

API_NAME_SRC = 'site_throttle_subnet_status_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'subnet'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SiteThrottleSubnetStatus

class pytan3.api_objects.soap_7_3_314_3424.ComputerIdList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'computer_ids'

str – Name of object used in API calls.

API_NAME_SRC = 'computer_id_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'id'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'int'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.soap_7_3_314_3424.HashedStringList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3424.ApiList

Automagically generated API array object.

API_NAME = 'hashed_strings'

str – Name of object used in API calls.

API_NAME_SRC = 'hashed_string_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'hashed_string'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of HashedString

pytan3.api_objects.soap_7_3_314_3424.BUILD_META = {'date': '2019-02-22 07:46:01.956314', 'script': 'build_objects_from_wsdl.py', 'script_platform': 'Darwin-18.2.0-x86_64-i386-64bit', 'script_python': '3.7.2 (default, Feb 20 2019, 14:09:01) ', 'script_version': '3.0.0', 'source_file': '/libraries/taniumjs/console.wsdl', 'source_file_date': '2019-02-22 07:29:24.898113'}

dict – How this module was built (date/time in UTC format).

pytan3.api_objects.soap_7_3_314_3424.COMMANDS = ['AddObject', 'GetObject', 'MoveObject', 'TransferObject', 'UpdateObject', 'DeleteObject', 'GetSavedQuestions', 'GetResultInfo', 'GetResultData', 'GetMergedResultData', 'UploadFile', 'RunPlugin', 'ExportObject', 'ImportObject', 'VerifySignature']

list of str – API commands.

pytan3.api_objects.soap_7_3_314_3424.VERSION = {'build': 3424, 'major': 7, 'minor': 3, 'protocol': 314, 'string': '7.3.314.3424'}

dict – Tanium API version these objects are intended to be used for.

SOAP API Object Module for Version 7.3.314.3641

Python objects for Tanium’s API.

pytan3.api_objects.soap_7_3_314_3641.float_types = (<class 'float'>,)

tuple of type – Float types.

pytan3.api_objects.soap_7_3_314_3641.integer_types = (<class 'int'>,)

tuple of type – Integer types.

pytan3.api_objects.soap_7_3_314_3641.string_types = (<class 'str'>,)

tuple of type – String types.

pytan3.api_objects.soap_7_3_314_3641.simple_types = (<class 'int'>, <class 'str'>, <class 'float'>)

tuple of type – All types that should be considered simple types.

pytan3.api_objects.soap_7_3_314_3641.TYPE = 'soap'

str – Type of API this module was built from.

pytan3.api_objects.soap_7_3_314_3641.API_DT = '%Y-%m-%dT%H:%M:%S'

str – Datetime format for this API type and version.

pytan3.api_objects.soap_7_3_314_3641.api_fixes()[source]

Fix incorrect attribute definitions on auto generated ApiModel classes.

pytan3.api_objects.soap_7_3_314_3641.expand_cls_globals()[source]

Replace str values with global vars for attrs on ApiModel classes.

Quite the funky chicken dance for solving issues with order of class definition.

pytan3.api_objects.soap_7_3_314_3641.expand_global(obj)[source]

Replace str values with global vars recursively.

Parameters:obj (str or dict or list) – Object to expand into global var.
Returns:String objects are the only ones that will be expanded.
Return type:str or dict or list or object
pytan3.api_objects.soap_7_3_314_3641.get_api_all_item()[source]

Get map of class name to class for all ApiItem subclasses.

Returns:dict
pytan3.api_objects.soap_7_3_314_3641.get_api_all_list()[source]

Get map of class name to class for all ApiList subclasses.

Returns:dict
pytan3.api_objects.soap_7_3_314_3641.get_api_all_model()[source]

Get map of class name to class for all ApiItem and ApiList subclasses.

Returns:dict
class pytan3.api_objects.soap_7_3_314_3641.ApiModel[source]

Bases: pytan3.api_models.ApiModel

Model for a complex item in the API.

class pytan3.api_objects.soap_7_3_314_3641.ApiItem(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiModel, pytan3.api_models.ApiItem

Model for a complex item in the API.

class pytan3.api_objects.soap_7_3_314_3641.ApiList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiModel, pytan3.api_models.ApiList

Model for an array in the API.

class pytan3.api_objects.soap_7_3_314_3641.ResultInfoList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Manually defined API array object.

API_NAME = 'result_infos'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'max_available_age': (<class 'int'>,), 'now': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['now', 'max_available_age']

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'result_info'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ResultInfo

__repr__()[source]

Make repr output be same as str output.

Returns:str
class pytan3.api_objects.soap_7_3_314_3641.ResultInfo(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Manually defined API object.

API_NAME = 'result_info'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'age': (<class 'int'>,), 'archived_question_id': (<class 'int'>,), 'error_count': (<class 'int'>,), 'estimated_total': (<class 'int'>,), 'expire_seconds': (<class 'int'>,), 'id': (<class 'int'>,), 'issue_seconds': (<class 'int'>,), 'mr_passed': (<class 'int'>,), 'mr_tested': (<class 'int'>,), 'no_results_count': (<class 'int'>,), 'passed': (<class 'int'>,), 'question_id': (<class 'int'>,), 'report_count': (<class 'int'>,), 'row_count': (<class 'int'>,), 'row_count_flag': (<class 'int'>,), 'row_count_machines': (<class 'int'>,), 'saved_question_id': (<class 'int'>,), 'seconds_since_issued': (<class 'int'>,), 'select_count': (<class 'int'>,), 'tested': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['question_id', 'estimated_total', 'row_count', 'mr_tested', 'mr_passed']

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ResultInfoList

API_LIST_API_NAME = 'result_infos'

str – Name of API_LIST_CLS used in API calls.

__repr__()[source]

Make repr output be same as str output.

Returns:str
class pytan3.api_objects.soap_7_3_314_3641.ResultSetList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Manually defined API array object.

API_NAME = 'result_sets'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'now': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['now']

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'result_set'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ResultSet

class pytan3.api_objects.soap_7_3_314_3641.MergedResultSet(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Manually defined API object.

API_NAME = 'merged_result'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'max_available_age': (<class 'str'>,), 'now': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'result_infos': <class 'pytan3.api_objects.soap_7_3_314_3641.ResultInfoList'>, 'result_sets': <class 'pytan3.api_objects.soap_7_3_314_3641.ResultSetList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['now', 'max_available_age']

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.ResultSet(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Manually defined API object.

API_NAME = 'result_set'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'age': (<class 'int'>,), 'archived_question_id': (<class 'int'>,), 'cache_id': (<class 'int'>,), 'error_count': (<class 'int'>,), 'estimated_total': (<class 'int'>,), 'expiration': (<class 'int'>,), 'expire_seconds': (<class 'int'>,), 'filtered_row_count': (<class 'int'>,), 'filtered_row_count_machines': (<class 'int'>,), 'id': (<class 'int'>,), 'issue_seconds': (<class 'int'>,), 'item_count': (<class 'int'>,), 'mr_passed': (<class 'int'>,), 'mr_tested': (<class 'int'>,), 'no_results_count': (<class 'int'>,), 'passed': (<class 'int'>,), 'question_id': (<class 'int'>,), 'report_count': (<class 'int'>,), 'row_count': (<class 'int'>,), 'row_count_machines': (<class 'int'>,), 'saved_question_id': (<class 'int'>,), 'seconds_since_issued': (<class 'int'>,), 'select_count': (<class 'int'>,), 'tested': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cs': <class 'pytan3.api_objects.soap_7_3_314_3641.ColumnList'>, 'rs': <class 'pytan3.api_objects.soap_7_3_314_3641.RowList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['question_id', 'estimated_total', 'mr_tested', 'mr_passed', 'row_count', 'columns']

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ResultSetList

API_LIST_API_NAME = 'result_sets'

str – Name of API_LIST_CLS used in API calls.

__init__(**kwargs)[source]

Constructor.

Notes

Sets Column.API_DATA_SET so column objects can access rows.

Sets RowColumn.API_COLUMN to the index correlated Column so row columns can access the column name, result type, etc.

Sets Column.API_IDX and RowColumn.API_IDX so column objects know what their index is without having to do lookups.

Parameters:**kwargs – Passed back to parent class.
rows

Expose complex attr “rs” as “rows”.

Returns:list
columns

Expose complex attr “cs” as “columns”.

Returns:list
class pytan3.api_objects.soap_7_3_314_3641.ColumnList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Manually defined API array object.

API_NAME = 'cs'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['names']

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'c'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Column

__repr__()[source]

Make repr output be same as str output.

Returns:str
names

Expose column names of all Column in this obj.

Returns:list of str
__getitem__(value)[source]

Support indexing of names.

Parameters:value (int or str) – If int: Index of item to retrieve from simple attr “c”. If str: Column name to index correlate from names
Returns:The RowColumn object at index value from names.
Return type:RowColumn
class pytan3.api_objects.soap_7_3_314_3641.Column(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Manually defined API object.

API_DATA_SET = None

ResultSet – Parent of this object, set by ResultSet.__init__().

API_IDX = None

int – Index of this object in ColumnList.

API_NAME = 'c'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'dn': (<class 'str'>,), 'rt': (<class 'int'>,), 'wh': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['name', 'result_type', 'hash']

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ColumnList

API_LIST_API_NAME = 'cs'

str – Name of API_LIST_CLS used in API calls.

name

Expose simple attr “dn” as name.

Returns:str
hash

Expose simple attr “wh” as hash.

Returns:str
type

Expose simple attr “rt” as type.

Returns:str
result_type

Expose simple attr “rt” as result_type.

Notes

Will try to map str from “rt” as int to constants from Sensor.API_CONSTANTS.

Returns:str
get_values(attr='value', join=None)[source]

Get values of this column from all rows.

Parameters:
  • attr (str, optional) –

    Attribute to get values of.

    Defaults to: “value”.

  • join (str, optional) –

    String to join multi value columns.

    Defaults to: None.
Returns:

list of str
class pytan3.api_objects.soap_7_3_314_3641.RowList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Manually defined API array object.

API_NAME = 'rs'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'r'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Row

__repr__()[source]

Make repr output be same as str output.

Returns:str
class pytan3.api_objects.soap_7_3_314_3641.Row(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Manually defined API object.

API_NAME = 'r'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'cid': (<class 'int'>,), 'id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'c': <class 'pytan3.api_objects.soap_7_3_314_3641.RowColumnList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['id', 'cid', 'columns']

list or str – Attributes to add to str formatting.

API_LIST_API_NAME = 'rs'

str – Name of API_LIST_CLS used in API calls.

API_LIST_CLS

ApiItem: Item class this list class holds.

alias of RowList

__repr__()[source]

Make repr output be same as str output.

Returns:str
__getitem__(value)[source]

Support indexing of names.

Parameters:value (int or str) – If int: Index of item to retrieve from names. If str: Column name to index correlate from ColumnList.names
Returns:The RowColumn object at index value from names.
Return type:RowColumn
names

Return the names of each row column from RowColumn.API_COLUMN.

Returns:list of str
columns

Expose complex attr “c” as “columns”.

Returns:RowColumnList
__len__()[source]

Expose length of columns.

Returns:int
get_values(meta=False, hashes=False, join=None)[source]

Get all values from all columns in this row.

Parameters:
  • meta (bool, optional) –

    Include sensor hash and result type for each column.

    Defaults to: False.

  • hashes (bool, optional) –

    Include hashes of values.

    Defaults to: False.

  • join (str, optional) –

    String to join multi value columns.

    Defaults to: None.
Returns:

dict
class pytan3.api_objects.soap_7_3_314_3641.RowColumnList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Manually defined API array object.

API_NAME = 'rc'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'row_columns'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of RowColumn

api_coerce_items_hook(attr, value, op)[source]

Check hook that allows subclasses to modify list items.

Parameters:
  • attr (str) – Attribute being set on this object.
  • value (ApiList or list or tuple) – The list object holding items.
  • op (str) – Operation being performed that called this method.

Examples

This converts all “v” attributes of each column for this row into a list of dicts:

>>> # single value columns "v" is a single dict:
>>> {"v": {"h": "", "text": ""}}
>>> # multiple value columns "v" is a list of dict:
>>> {"v": [{"h": "", "text": ""}, {"h": "", "text": ""}]}
>>> # Count columns "v" is a string:
>>> {"v": "1"}
>>> # all become:
>>> {"v": [{"text": "", "hash": ""}]}

Notes

The driving force behind this is basically just the Count column. It returns a string of the value, instead of a dict or a list of dicts.

Returns:The list of items modified or as is.
Return type:list
class pytan3.api_objects.soap_7_3_314_3641.RowColumn(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Manually defined API array object.

API_COLUMN = None

Column – Index correlated column, set by ResultSet.__init__().

API_IDX = None

int – Index of this object in RowColumnList.

API_NAME = 'row_column'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['name', 'hash', 'result_type']

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'v'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of RowValue

name

Expose column name from API_COLUMN.

Returns:str
result_type

Expose column result type from API_COLUMN.

Returns:str
hash

Expose column sensor hash from API_COLUMN.

Returns:str
get_values(attr='value', join=None)[source]

Get all values from this row column.

Parameters:
  • attr (str, optional) –

    Attribute to get values of.

    Defaults to: “value”.

  • join (str, optional) –

    String to join multi value columns.

    Defaults to: None.
Returns:

list or str
class pytan3.api_objects.soap_7_3_314_3641.RowValue(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Manually defined API object.

API_NAME = 'v'

str – Name of object used in API calls.

API_NAME_SRC = ''

str – Name of object in source file.

API_SIMPLE = {'h': (<class 'int'>,), 'text': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = ['hash', 'value']

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of RowColumn

API_LIST_API_NAME = 'row_column'

str – Name of API_LIST_CLS used in API calls.

hash

Expose simple attr “h” as hash.

Returns:str
value

Expose simple attr “text” as value.

Returns:str
class pytan3.api_objects.soap_7_3_314_3641.SensorQuery(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'sensor_query'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_query'

str – Name of object in source file.

API_SIMPLE = {'platform': (<class 'str'>,), 'script': (<class 'str'>,), 'script_type': (<class 'str'>,), 'signature': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SensorQueryList

API_LIST_API_NAME = 'sensor_querys'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.SensorSubcolumn(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'sensor_subcolumn'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_subcolumn'

str – Name of object in source file.

API_SIMPLE = {'exclude_from_parse_flag': (<class 'int'>,), 'hidden_flag': (<class 'int'>,), 'ignore_case_flag': (<class 'int'>,), 'index': (<class 'int'>,), 'name': (<class 'str'>,), 'value_type': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SensorSubcolumnList

API_LIST_API_NAME = 'sensor_subcolumns'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.SensorStat(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'sensor_stat'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_stat'

str – Name of object in source file.

API_SIMPLE = {'count': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'other_bytes_avg': (<class 'float'>,), 'other_bytes_std': (<class 'float'>,), 'read_bytes_avg': (<class 'float'>,), 'read_bytes_std': (<class 'float'>,), 'real_ms_avg': (<class 'float'>,), 'real_ms_max': (<class 'float'>,), 'real_ms_min': (<class 'float'>,), 'real_ms_std': (<class 'float'>,), 'sys_ms_avg': (<class 'float'>,), 'sys_ms_std': (<class 'float'>,), 'user_ms_avg': (<class 'float'>,), 'user_ms_std': (<class 'float'>,), 'what_hash': (<class 'int'>,), 'write_bytes_avg': (<class 'float'>,), 'write_bytes_std': (<class 'float'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SensorStatList

API_LIST_API_NAME = 'sensor_stats'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.SavedActionPolicy(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'saved_action_policy'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_action_policy'

str – Name of object in source file.

API_SIMPLE = {'max_age': (<class 'int'>,), 'min_count': (<class 'int'>,), 'row_filter_group_id': (<class 'int'>,), 'saved_question_group_id': (<class 'int'>,), 'saved_question_id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'row_filter_group': <class 'pytan3.api_objects.soap_7_3_314_3641.Group'>, 'saved_question_group': <class 'pytan3.api_objects.soap_7_3_314_3641.Group'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.SavedActionApproval(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'saved_action_approval'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_action_approval'

str – Name of object in source file.

API_SIMPLE = {'approved_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'owner_user_id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'metadata': <class 'pytan3.api_objects.soap_7_3_314_3641.MetadataList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SavedActionApprovalList

API_LIST_API_NAME = 'saved_action_approvals'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.SavedAction(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'saved_action'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_action'

str – Name of object in source file.

API_SIMPLE = {'action_group_id': (<class 'int'>,), 'approved_flag': (<class 'int'>,), 'cache_row_id': (<class 'int'>,), 'comment': (<class 'str'>,), 'creation_time': (<class 'str'>,), 'distribute_seconds': (<class 'int'>,), 'end_time': (<class 'str'>,), 'expire_seconds': (<class 'int'>,), 'id': (<class 'int'>,), 'issue_count': (<class 'int'>,), 'issue_seconds': (<class 'int'>,), 'last_start_time': (<class 'str'>,), 'name': (<class 'str'>,), 'next_start_time': (<class 'str'>,), 'policy_flag': (<class 'int'>,), 'public_flag': (<class 'int'>,), 'start_time': (<class 'str'>,), 'status': (<class 'int'>,), 'user_start_time': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'action_group': <class 'pytan3.api_objects.soap_7_3_314_3641.Group'>, 'approver': <class 'pytan3.api_objects.soap_7_3_314_3641.User'>, 'last_action': <class 'pytan3.api_objects.soap_7_3_314_3641.Action'>, 'metadata': <class 'pytan3.api_objects.soap_7_3_314_3641.MetadataList'>, 'package_spec': <class 'pytan3.api_objects.soap_7_3_314_3641.PackageSpec'>, 'policy': <class 'pytan3.api_objects.soap_7_3_314_3641.SavedActionPolicy'>, 'row_ids': <class 'pytan3.api_objects.soap_7_3_314_3641.SavedActionRowIdList'>, 'target_group': <class 'pytan3.api_objects.soap_7_3_314_3641.Group'>, 'user': <class 'pytan3.api_objects.soap_7_3_314_3641.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SavedActionList

API_LIST_API_NAME = 'saved_actions'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.Sensor(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'sensor'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor'

str – Name of object in source file.

API_SIMPLE = {'cache_row_id': (<class 'int'>,), 'category': (<class 'str'>,), 'creation_time': (<class 'str'>,), 'deleted_flag': (<class 'int'>,), 'delimiter': (<class 'str'>,), 'description': (<class 'str'>,), 'exclude_from_parse_flag': (<class 'int'>,), 'hash': (<class 'int'>,), 'hidden_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'ignore_case_flag': (<class 'int'>,), 'keep_duplicates_flag': (<class 'int'>,), 'last_modified_by': (<class 'str'>,), 'max_age_seconds': (<class 'int'>,), 'modification_time': (<class 'str'>,), 'name': (<class 'str'>,), 'parameter_definition': (<class 'str'>,), 'preview_sensor_flag': (<class 'int'>,), 'source_hash': (<class 'int'>,), 'source_id': (<class 'int'>,), 'source_name': (<class 'str'>,), 'string_count': (<class 'int'>,), 'value_type': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set': <class 'pytan3.api_objects.soap_7_3_314_3641.IdReference'>, 'metadata': <class 'pytan3.api_objects.soap_7_3_314_3641.MetadataList'>, 'mod_user': <class 'pytan3.api_objects.soap_7_3_314_3641.User'>, 'parameters': <class 'pytan3.api_objects.soap_7_3_314_3641.ParameterList'>, 'queries': <class 'pytan3.api_objects.soap_7_3_314_3641.SensorQueryList'>, 'string_hints': <class 'pytan3.api_objects.soap_7_3_314_3641.StringHintList'>, 'subcolumns': <class 'pytan3.api_objects.soap_7_3_314_3641.SensorSubcolumnList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {'BES_DATETIME_RESULT': 4, 'BES_SENSOR': 2, 'DATASIZE_RESULT': 8, 'HASH_RESULT': 0, 'IP_RESULT': 5, 'JS_SENSOR': 7, 'MULTITYPE_SENSOR': 6, 'NUMERIC_INTEGER_RESULT': 9, 'NUMERIC_RESULT': 3, 'PSHELL_SENSOR': 5, 'PY_SENSOR': 8, 'REGEX_RESULT': 11, 'TEXT_RESULT': 1, 'TIMEDIFF_REUSLT': 7, 'VBS_SENSOR': 4, 'VERSION_RESULT': 2, 'WMI_DATETIME_RESULT': 6, 'WMI_SENSOR': 1}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SensorList

API_LIST_API_NAME = 'sensors'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.AuditData(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'audit_data'

str – Name of object used in API calls.

API_NAME_SRC = 'audit_data'

str – Name of object in source file.

API_SIMPLE = {'cache_row_id': (<class 'int'>,), 'creation_time': (<class 'str'>,), 'details': (<class 'str'>,), 'last_modified_by': (<class 'str'>,), 'modification_time': (<class 'str'>,), 'modifier_user_id': (<class 'int'>,), 'object_id': (<class 'int'>,), 'type': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'mod_user': <class 'pytan3.api_objects.soap_7_3_314_3641.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of AuditDataList

API_LIST_API_NAME = 'audit_datas'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.AuditLog(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'audit_log'

str – Name of object used in API calls.

API_NAME_SRC = 'audit_log'

str – Name of object in source file.

API_SIMPLE = {'end_time': (<class 'str'>,), 'id': (<class 'int'>,), 'start_time': (<class 'str'>,), 'type': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'entries': <class 'pytan3.api_objects.soap_7_3_314_3641.AuditDataList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of AuditLogList

API_LIST_API_NAME = 'audit_logs'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.Server(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'server'

str – Name of object used in API calls.

API_NAME_SRC = 'server'

str – Name of object in source file.

API_SIMPLE = {'heart_beat': (<class 'str'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ServerList

API_LIST_API_NAME = 'servers'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.MetadataItem(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'metadata_item'

str – Name of object used in API calls.

API_NAME_SRC = 'metadata_item'

str – Name of object in source file.

API_SIMPLE = {'admin_flag': (<class 'int'>,), 'name': (<class 'str'>,), 'value': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of MetadataList

API_LIST_API_NAME = 'metadatas'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.Filter(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'filter'

str – Name of object used in API calls.

API_NAME_SRC = 'filter'

str – Name of object in source file.

API_SIMPLE = {'aggregation': (<class 'str'>,), 'all_times_flag': (<class 'int'>,), 'all_values_flag': (<class 'int'>,), 'delimiter': (<class 'str'>,), 'delimiter_index': (<class 'int'>,), 'end_time': (<class 'str'>,), 'id': (<class 'int'>,), 'ignore_case_flag': (<class 'int'>,), 'max_age_seconds': (<class 'int'>,), 'not_flag': (<class 'int'>,), 'operator': (<class 'str'>,), 'start_time': (<class 'str'>,), 'substring_flag': (<class 'int'>,), 'substring_length': (<class 'int'>,), 'substring_start': (<class 'int'>,), 'utf8_flag': (<class 'int'>,), 'value': (<class 'str'>,), 'value_type': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'sensor': <class 'pytan3.api_objects.soap_7_3_314_3641.Sensor'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of FilterList

API_LIST_API_NAME = 'filters'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.IdReference(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'id_reference'

str – Name of object used in API calls.

API_NAME_SRC = 'id_reference'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,), 'name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.Group(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'group'

str – Name of object used in API calls.

API_NAME_SRC = 'group'

str – Name of object in source file.

API_SIMPLE = {'and_flag': (<class 'int'>,), 'deleted_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'not_flag': (<class 'int'>,), 'saved_question_id': (<class 'int'>,), 'source_id': (<class 'int'>,), 'text': (<class 'str'>,), 'track_computer_id_flag': (<class 'int'>,), 'track_computer_id_interval': (<class 'int'>,), 'type': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'filters': <class 'pytan3.api_objects.soap_7_3_314_3641.FilterList'>, 'parameters': <class 'pytan3.api_objects.soap_7_3_314_3641.ParameterList'>, 'sub_groups': <class 'pytan3.api_objects.soap_7_3_314_3641.GroupList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of GroupList

API_LIST_API_NAME = 'groups'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.Select(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'select'

str – Name of object used in API calls.

API_NAME_SRC = 'select'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'filter': <class 'pytan3.api_objects.soap_7_3_314_3641.Filter'>, 'group': <class 'pytan3.api_objects.soap_7_3_314_3641.Group'>, 'sensor': <class 'pytan3.api_objects.soap_7_3_314_3641.Sensor'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SelectList

API_LIST_API_NAME = 'selects'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.XmlError(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'xml_error'

str – Name of object used in API calls.

API_NAME_SRC = 'xml_error'

str – Name of object in source file.

API_SIMPLE = {'error_context': (<class 'str'>,), 'exception': (<class 'str'>,), 'type': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ErrorList

API_LIST_API_NAME = 'errors'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.CacheInfo(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'cache_info'

str – Name of object used in API calls.

API_NAME_SRC = 'cache_info'

str – Name of object in source file.

API_SIMPLE = {'cache_id': (<class 'int'>,), 'cache_row_count': (<class 'int'>,), 'expiration': (<class 'str'>,), 'filtered_row_count': (<class 'int'>,), 'page_row_count': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'errors': <class 'pytan3.api_objects.soap_7_3_314_3641.ErrorList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.QuestionListInfo(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'question_list_info'

str – Name of object used in API calls.

API_NAME_SRC = 'question_list_info'

str – Name of object in source file.

API_SIMPLE = {'highest_id': (<class 'int'>,), 'total_count': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.Question(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'question'

str – Name of object used in API calls.

API_NAME_SRC = 'question'

str – Name of object in source file.

API_SIMPLE = {'action_tracking_flag': (<class 'int'>,), 'cache_row_id': (<class 'int'>,), 'expiration': (<class 'str'>,), 'expire_seconds': (<class 'int'>,), 'force_computer_id_flag': (<class 'int'>,), 'from_canonical_text': (<class 'int'>,), 'hidden_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'index': (<class 'int'>,), 'is_expired': (<class 'int'>,), 'name': (<class 'str'>,), 'query_text': (<class 'str'>,), 'skip_lock_flag': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'context_group': <class 'pytan3.api_objects.soap_7_3_314_3641.Group'>, 'group': <class 'pytan3.api_objects.soap_7_3_314_3641.Group'>, 'management_rights_group': <class 'pytan3.api_objects.soap_7_3_314_3641.Group'>, 'saved_question': <class 'pytan3.api_objects.soap_7_3_314_3641.SavedQuestion'>, 'selects': <class 'pytan3.api_objects.soap_7_3_314_3641.SelectList'>, 'user': <class 'pytan3.api_objects.soap_7_3_314_3641.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of QuestionList

API_LIST_API_NAME = 'questions'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.PackageFileTemplate(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'package_file_template'

str – Name of object used in API calls.

API_NAME_SRC = 'package_file_template'

str – Name of object in source file.

API_SIMPLE = {'download_seconds': (<class 'int'>,), 'hash': (<class 'str'>,), 'name': (<class 'str'>,), 'source': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of PackageFileTemplateList

API_LIST_API_NAME = 'package_file_templates'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.PackageFileStatus(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'package_file_status'

str – Name of object used in API calls.

API_NAME_SRC = 'package_file_status'

str – Name of object in source file.

API_SIMPLE = {'bytes_downloaded': (<class 'int'>,), 'bytes_total': (<class 'int'>,), 'cache_message': (<class 'str'>,), 'cache_status': (<class 'str'>,), 'download_start_time': (<class 'str'>,), 'last_download_progress_time': (<class 'str'>,), 'server_id': (<class 'int'>,), 'server_name': (<class 'str'>,), 'status': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of PackageFileStatusList

API_LIST_API_NAME = 'package_file_statuss'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.PackageFile(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'package_file'

str – Name of object used in API calls.

API_NAME_SRC = 'package_file'

str – Name of object in source file.

API_SIMPLE = {'bytes_downloaded': (<class 'int'>,), 'bytes_total': (<class 'int'>,), 'cache_status': (<class 'str'>,), 'deleted_flag': (<class 'int'>,), 'download_seconds': (<class 'int'>,), 'download_start_time': (<class 'str'>,), 'hash': (<class 'str'>,), 'id': (<class 'int'>,), 'last_download_progress_time': (<class 'str'>,), 'name': (<class 'str'>,), 'size': (<class 'int'>,), 'source': (<class 'str'>,), 'status': (<class 'int'>,), 'trigger_download': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'file_status': <class 'pytan3.api_objects.soap_7_3_314_3641.PackageFileStatusList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of PackageFileList

API_LIST_API_NAME = 'package_files'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.PackageSpec(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'package_spec'

str – Name of object used in API calls.

API_NAME_SRC = 'package_spec'

str – Name of object in source file.

API_SIMPLE = {'available_time': (<class 'str'>,), 'cache_row_id': (<class 'int'>,), 'command': (<class 'str'>,), 'command_timeout': (<class 'int'>,), 'creation_time': (<class 'str'>,), 'deleted_flag': (<class 'int'>,), 'display_name': (<class 'str'>,), 'expire_seconds': (<class 'int'>,), 'hidden_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'last_modified_by': (<class 'str'>,), 'last_update': (<class 'str'>,), 'modification_time': (<class 'str'>,), 'name': (<class 'str'>,), 'parameter_definition': (<class 'str'>,), 'process_group_flag': (<class 'int'>,), 'signature': (<class 'str'>,), 'skip_lock_flag': (<class 'int'>,), 'source_hash': (<class 'str'>,), 'source_hash_changed_flag': (<class 'int'>,), 'source_id': (<class 'int'>,), 'source_name': (<class 'str'>,), 'verify_expire_seconds': (<class 'int'>,), 'verify_group_id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set': <class 'pytan3.api_objects.soap_7_3_314_3641.IdReference'>, 'file_templates': <class 'pytan3.api_objects.soap_7_3_314_3641.PackageFileTemplateList'>, 'files': <class 'pytan3.api_objects.soap_7_3_314_3641.PackageFileList'>, 'metadata': <class 'pytan3.api_objects.soap_7_3_314_3641.MetadataList'>, 'mod_user': <class 'pytan3.api_objects.soap_7_3_314_3641.User'>, 'parameters': <class 'pytan3.api_objects.soap_7_3_314_3641.ParameterList'>, 'sensors': <class 'pytan3.api_objects.soap_7_3_314_3641.SensorList'>, 'verify_group': <class 'pytan3.api_objects.soap_7_3_314_3641.Group'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of PackageSpecList

API_LIST_API_NAME = 'package_specs'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.ClientStatus(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'client_status'

str – Name of object used in API calls.

API_NAME_SRC = 'client_status'

str – Name of object in source file.

API_SIMPLE = {'cache_row_id': (<class 'int'>,), 'computer_id': (<class 'str'>,), 'full_version': (<class 'str'>,), 'host_name': (<class 'str'>,), 'ipaddress_client': (<class 'str'>,), 'ipaddress_server': (<class 'str'>,), 'last_registration': (<class 'str'>,), 'port_number': (<class 'int'>,), 'protocol_version': (<class 'int'>,), 'public_key_valid': (<class 'int'>,), 'receive_state': (<class 'str'>,), 'registered_with_tls': (<class 'int'>,), 'send_state': (<class 'str'>,), 'status': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SystemStatusList

API_LIST_API_NAME = 'system_status'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.SystemSetting(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'system_setting'

str – Name of object used in API calls.

API_NAME_SRC = 'system_setting'

str – Name of object in source file.

API_SIMPLE = {'cache_row_id': (<class 'int'>,), 'default_value': (<class 'str'>,), 'hidden_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'read_only_flag': (<class 'int'>,), 'setting_type': (<class 'str'>,), 'value': (<class 'str'>,), 'value_type': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'audit_data': <class 'pytan3.api_objects.soap_7_3_314_3641.AuditData'>, 'metadata': <class 'pytan3.api_objects.soap_7_3_314_3641.MetadataList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SystemSettingList

API_LIST_API_NAME = 'system_settings'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.SoapError(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'soap_error'

str – Name of object used in API calls.

API_NAME_SRC = 'soap_error'

str – Name of object in source file.

API_SIMPLE = {'context': (<class 'str'>,), 'exception_name': (<class 'str'>,), 'object_name': (<class 'str'>,), 'object_request': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.WhiteListedUrl(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'white_listed_url'

str – Name of object used in API calls.

API_NAME_SRC = 'white_listed_url'

str – Name of object in source file.

API_SIMPLE = {'chunk_id': (<class 'str'>,), 'download_seconds': (<class 'int'>,), 'expire_seconds': (<class 'int'>,), 'id': (<class 'int'>,), 'url_regex': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'metadata': <class 'pytan3.api_objects.soap_7_3_314_3641.MetadataList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of WhiteListedUrlList

API_LIST_API_NAME = 'white_listed_urls'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.VersionAggregate(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'version_aggregate'

str – Name of object used in API calls.

API_NAME_SRC = 'version_aggregate'

str – Name of object in source file.

API_SIMPLE = {'count': (<class 'int'>,), 'filtered': (<class 'int'>,), 'version_string': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of VersionAggregateList

API_LIST_API_NAME = 'version_aggregates'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.SystemStatusAggregate(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'system_status_aggregate'

str – Name of object used in API calls.

API_NAME_SRC = 'system_status_aggregate'

str – Name of object in source file.

API_SIMPLE = {'blocked_count': (<class 'int'>,), 'leader_count': (<class 'int'>,), 'normal_count': (<class 'int'>,), 'receive_backward_count': (<class 'int'>,), 'receive_forward_count': (<class 'int'>,), 'receive_none_count': (<class 'int'>,), 'receive_ok_count': (<class 'int'>,), 'registered_with_tls_count': (<class 'int'>,), 'send_backward_count': (<class 'int'>,), 'send_forward_count': (<class 'int'>,), 'send_none_count': (<class 'int'>,), 'send_ok_count': (<class 'int'>,), 'slowlink_count': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'versions': <class 'pytan3.api_objects.soap_7_3_314_3641.VersionAggregateList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.UserRole(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'user_role'

str – Name of object used in API calls.

API_NAME_SRC = 'user_role'

str – Name of object in source file.

API_SIMPLE = {'description': (<class 'str'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'permissions': <class 'pytan3.api_objects.soap_7_3_314_3641.PermissionList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of UserRoleList

API_LIST_API_NAME = 'roles'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.UserOwnedObjectIds(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'user_owned_object_ids'

str – Name of object used in API calls.

API_NAME_SRC = 'user_owned_object_ids'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'plugin_schedules': <class 'pytan3.api_objects.soap_7_3_314_3641.PluginScheduleList'>, 'saved_actions': <class 'pytan3.api_objects.soap_7_3_314_3641.SavedActionList'>, 'saved_questions': <class 'pytan3.api_objects.soap_7_3_314_3641.SavedQuestionList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.User(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'user'

str – Name of object used in API calls.

API_NAME_SRC = 'user'

str – Name of object in source file.

API_SIMPLE = {'active_session_count': (<class 'int'>,), 'deleted_flag': (<class 'int'>,), 'display_name': (<class 'str'>,), 'domain': (<class 'str'>,), 'effective_group_id': (<class 'int'>,), 'external_flag': (<class 'int'>,), 'group_id': (<class 'int'>,), 'id': (<class 'int'>,), 'last_login': (<class 'str'>,), 'local_admin_flag': (<class 'int'>,), 'locked_out': (<class 'int'>,), 'name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set_roles': <class 'pytan3.api_objects.soap_7_3_314_3641.ContentSetRoleList'>, 'effective_content_set_privileges': <class 'pytan3.api_objects.soap_7_3_314_3641.EffectiveContentSetPrivilegeList'>, 'metadata': <class 'pytan3.api_objects.soap_7_3_314_3641.MetadataList'>, 'owned_object_ids': <class 'pytan3.api_objects.soap_7_3_314_3641.UserOwnedObjectIds'>, 'permissions': <class 'pytan3.api_objects.soap_7_3_314_3641.PermissionList'>, 'roles': <class 'pytan3.api_objects.soap_7_3_314_3641.UserRoleList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of UserList

API_LIST_API_NAME = 'users'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.ActionListInfo(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'action_list_info'

str – Name of object used in API calls.

API_NAME_SRC = 'action_list_info'

str – Name of object in source file.

API_SIMPLE = {'highest_id': (<class 'int'>,), 'total_count': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.Action(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'action'

str – Name of object used in API calls.

API_NAME_SRC = 'action'

str – Name of object in source file.

API_SIMPLE = {'cache_row_id': (<class 'int'>,), 'comment': (<class 'str'>,), 'creation_time': (<class 'str'>,), 'distribute_seconds': (<class 'int'>,), 'expiration_time': (<class 'str'>,), 'expire_seconds': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'skip_lock_flag': (<class 'int'>,), 'start_time': (<class 'str'>,), 'status': (<class 'str'>,), 'stopped_flag': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'action_group': <class 'pytan3.api_objects.soap_7_3_314_3641.Group'>, 'approver': <class 'pytan3.api_objects.soap_7_3_314_3641.User'>, 'history_saved_question': <class 'pytan3.api_objects.soap_7_3_314_3641.SavedQuestion'>, 'metadata': <class 'pytan3.api_objects.soap_7_3_314_3641.MetadataList'>, 'package_spec': <class 'pytan3.api_objects.soap_7_3_314_3641.PackageSpec'>, 'saved_action': <class 'pytan3.api_objects.soap_7_3_314_3641.SavedAction'>, 'target_group': <class 'pytan3.api_objects.soap_7_3_314_3641.Group'>, 'user': <class 'pytan3.api_objects.soap_7_3_314_3641.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ActionList

API_LIST_API_NAME = 'actions'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.ActionStop(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'action_stop'

str – Name of object used in API calls.

API_NAME_SRC = 'action_stop'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'action': <class 'pytan3.api_objects.soap_7_3_314_3641.Action'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ActionStopList

API_LIST_API_NAME = 'action_stops'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.ArchivedQuestion(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'archived_question'

str – Name of object used in API calls.

API_NAME_SRC = 'archived_question'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ArchivedQuestionList

API_LIST_API_NAME = 'archived_questions'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.SavedQuestion(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'saved_question'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_question'

str – Name of object in source file.

API_SIMPLE = {'action_tracking_flag': (<class 'int'>,), 'archive_enabled_flag': (<class 'int'>,), 'cache_row_id': (<class 'int'>,), 'deleted_flag': (<class 'int'>,), 'expire_seconds': (<class 'int'>,), 'hidden_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'index': (<class 'int'>,), 'issue_seconds': (<class 'int'>,), 'issue_seconds_never_flag': (<class 'int'>,), 'keep_seconds': (<class 'int'>,), 'mod_time': (<class 'str'>,), 'most_recent_question_id': (<class 'int'>,), 'name': (<class 'str'>,), 'public_flag': (<class 'int'>,), 'query_text': (<class 'str'>,), 'row_count_flag': (<class 'int'>,), 'seeding_question_ids': (<class 'str'>,), 'skip_schedule_on_update_flag': (<class 'int'>,), 'sort_column': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'archive_owner': <class 'pytan3.api_objects.soap_7_3_314_3641.User'>, 'content_set': <class 'pytan3.api_objects.soap_7_3_314_3641.IdReference'>, 'metadata': <class 'pytan3.api_objects.soap_7_3_314_3641.MetadataList'>, 'mod_user': <class 'pytan3.api_objects.soap_7_3_314_3641.User'>, 'packages': <class 'pytan3.api_objects.soap_7_3_314_3641.PackageSpecList'>, 'question': <class 'pytan3.api_objects.soap_7_3_314_3641.Question'>, 'user': <class 'pytan3.api_objects.soap_7_3_314_3641.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SavedQuestionList

API_LIST_API_NAME = 'saved_questions'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.ParseJob(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'parse_job'

str – Name of object used in API calls.

API_NAME_SRC = 'parse_job'

str – Name of object in source file.

API_SIMPLE = {'parser_version': (<class 'int'>,), 'question_text': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ParseJobList

API_LIST_API_NAME = 'parse_jobs'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.Parameter(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'parameter'

str – Name of object used in API calls.

API_NAME_SRC = 'parameter'

str – Name of object in source file.

API_SIMPLE = {'key': (<class 'str'>,), 'type': (<class 'int'>,), 'value': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ParameterList

API_LIST_API_NAME = 'parameters'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.ParseResult(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'parse_result'

str – Name of object used in API calls.

API_NAME_SRC = 'parse_result'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,), 'parameter_definition': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'parameters': <class 'pytan3.api_objects.soap_7_3_314_3641.ParameterList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ParseResultList

API_LIST_API_NAME = 'parse_results'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.SensorReference(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'sensor_reference'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_reference'

str – Name of object in source file.

API_SIMPLE = {'name': (<class 'str'>,), 'real_ms_avg': (<class 'int'>,), 'start_char': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SensorReferenceList

API_LIST_API_NAME = 'sensor_references'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.ParseResultGroup(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'parse_result_group'

str – Name of object used in API calls.

API_NAME_SRC = 'parse_result_group'

str – Name of object in source file.

API_SIMPLE = {'question_text': (<class 'str'>,), 'score': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'parameter_values': <class 'pytan3.api_objects.soap_7_3_314_3641.ParameterValueList'>, 'parse_results': <class 'pytan3.api_objects.soap_7_3_314_3641.ParseResultList'>, 'question': <class 'pytan3.api_objects.soap_7_3_314_3641.Question'>, 'question_group_sensors': <class 'pytan3.api_objects.soap_7_3_314_3641.SensorList'>, 'sensor_references': <class 'pytan3.api_objects.soap_7_3_314_3641.SensorReferenceList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ParseResultGroupList

API_LIST_API_NAME = 'parse_result_groups'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.ClientCount(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'client_count'

str – Name of object used in API calls.

API_NAME_SRC = 'client_count'

str – Name of object in source file.

API_SIMPLE = {'count': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.PluginArgument(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'plugin_argument'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_argument'

str – Name of object in source file.

API_SIMPLE = {'name': (<class 'str'>,), 'type': (<class 'str'>,), 'value': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of PluginArgumentList

API_LIST_API_NAME = 'plugin_arguments'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.UploadFile(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'upload_file'

str – Name of object used in API calls.

API_NAME_SRC = 'upload_file'

str – Name of object in source file.

API_SIMPLE = {'bytes': (<class 'str'>,), 'destination_file': (<class 'str'>,), 'file_cached': (<class 'int'>,), 'file_size': (<class 'int'>,), 'force_overwrite': (<class 'int'>,), 'hash': (<class 'str'>,), 'id': (<class 'int'>,), 'key': (<class 'str'>,), 'part_size': (<class 'int'>,), 'percent_complete': (<class 'int'>,), 'start_pos': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of UploadFileList

API_LIST_API_NAME = 'upload_files'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.UploadFileStatus(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'upload_file_status'

str – Name of object used in API calls.

API_NAME_SRC = 'upload_file_status'

str – Name of object in source file.

API_SIMPLE = {'file_cached': (<class 'int'>,), 'hash': (<class 'str'>,), 'percent_complete': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'file_parts': <class 'pytan3.api_objects.soap_7_3_314_3641.UploadFileList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.Plugin(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'plugin'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin'

str – Name of object in source file.

API_SIMPLE = {'allow_rest': (<class 'int'>,), 'bundle': (<class 'str'>,), 'cache_row_id': (<class 'int'>,), 'execution_id': (<class 'int'>,), 'exit_code': (<class 'int'>,), 'filename': (<class 'str'>,), 'input': (<class 'str'>,), 'local_admin_flag': (<class 'int'>,), 'name': (<class 'str'>,), 'path': (<class 'str'>,), 'plugin_server': (<class 'str'>,), 'plugin_url': (<class 'str'>,), 'raw_http_request': (<class 'int'>,), 'raw_http_response': (<class 'int'>,), 'run_detached_flag': (<class 'int'>,), 'script_response': (<class 'str'>,), 'status': (<class 'str'>,), 'status_file_content': (<class 'str'>,), 'timeout_seconds': (<class 'int'>,), 'type': (<class 'str'>,), 'use_json_flag': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'arguments': <class 'pytan3.api_objects.soap_7_3_314_3641.PluginArgumentList'>, 'commands': <class 'pytan3.api_objects.soap_7_3_314_3641.PluginCommandList'>, 'content_set': <class 'pytan3.api_objects.soap_7_3_314_3641.ContentSet'>, 'metadata': <class 'pytan3.api_objects.soap_7_3_314_3641.MetadataList'>, 'permissions': <class 'pytan3.api_objects.soap_7_3_314_3641.PermissionList'>, 'sql_response': <class 'pytan3.api_objects.soap_7_3_314_3641.PluginSql'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {'SCRIPT': 'Script', 'SQL': 'SQL'}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of PluginList

API_LIST_API_NAME = 'plugins'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.PluginSchedule(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'plugin_schedule'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_schedule'

str – Name of object in source file.

API_SIMPLE = {'deleted_flag': (<class 'int'>,), 'enabled': (<class 'int'>,), 'end_date': (<class 'str'>,), 'end_hour': (<class 'int'>,), 'id': (<class 'int'>,), 'input': (<class 'str'>,), 'last_exit_code': (<class 'int'>,), 'last_run_text': (<class 'str'>,), 'last_run_time': (<class 'str'>,), 'modification_time': (<class 'str'>,), 'name': (<class 'str'>,), 'plugin_bundle': (<class 'str'>,), 'plugin_name': (<class 'str'>,), 'plugin_server': (<class 'str'>,), 'run_interval_seconds': (<class 'int'>,), 'run_on_days': (<class 'str'>,), 'start_date': (<class 'str'>,), 'start_hour': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'arguments': <class 'pytan3.api_objects.soap_7_3_314_3641.PluginArgumentList'>, 'last_run_sql': <class 'pytan3.api_objects.soap_7_3_314_3641.PluginSql'>, 'mod_user': <class 'pytan3.api_objects.soap_7_3_314_3641.User'>, 'user': <class 'pytan3.api_objects.soap_7_3_314_3641.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of PluginScheduleList

API_LIST_API_NAME = 'plugin_schedules'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.ComputerGroupSpec(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'computer_group_spec'

str – Name of object used in API calls.

API_NAME_SRC = 'computer_group_spec'

str – Name of object in source file.

API_SIMPLE = {'computer_name': (<class 'str'>,), 'id': (<class 'int'>,), 'ip_address': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ComputerSpecList

API_LIST_API_NAME = 'computer_specs'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.ComputerGroup(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'computer_group'

str – Name of object used in API calls.

API_NAME_SRC = 'computer_group'

str – Name of object in source file.

API_SIMPLE = {'deleted_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'computer_specs': <class 'pytan3.api_objects.soap_7_3_314_3641.ComputerSpecList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ComputerGroupList

API_LIST_API_NAME = 'computer_groups'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.VerifySignature(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'verify_signature'

str – Name of object used in API calls.

API_NAME_SRC = 'verify_signature'

str – Name of object in source file.

API_SIMPLE = {'bytes': (<class 'str'>,), 'id': (<class 'int'>,), 'type': (<class 'str'>,), 'verified': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.ObjectList(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'object_list'

str – Name of object used in API calls.

API_NAME_SRC = 'object_list'

str – Name of object in source file.

API_SIMPLE = {'export_id': (<class 'str'>,), 'export_version': (<class 'int'>,), 'import_content': (<class 'str'>,), 'server_info': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'action': <class 'pytan3.api_objects.soap_7_3_314_3641.Action'>, 'action_group': <class 'pytan3.api_objects.soap_7_3_314_3641.ActionGroup'>, 'action_groups': <class 'pytan3.api_objects.soap_7_3_314_3641.ActionGroupList'>, 'action_stop': <class 'pytan3.api_objects.soap_7_3_314_3641.ActionStop'>, 'action_stops': <class 'pytan3.api_objects.soap_7_3_314_3641.ActionStopList'>, 'actions': <class 'pytan3.api_objects.soap_7_3_314_3641.ActionList'>, 'archived_question': <class 'pytan3.api_objects.soap_7_3_314_3641.ArchivedQuestion'>, 'archived_questions': <class 'pytan3.api_objects.soap_7_3_314_3641.ArchivedQuestionList'>, 'audit_log': <class 'pytan3.api_objects.soap_7_3_314_3641.AuditLog'>, 'audit_logs': <class 'pytan3.api_objects.soap_7_3_314_3641.AuditLogList'>, 'client_count': <class 'pytan3.api_objects.soap_7_3_314_3641.ClientCount'>, 'client_status': <class 'pytan3.api_objects.soap_7_3_314_3641.ClientStatus'>, 'computer_group': <class 'pytan3.api_objects.soap_7_3_314_3641.ComputerGroup'>, 'computer_groups': <class 'pytan3.api_objects.soap_7_3_314_3641.ComputerGroupList'>, 'content_set': <class 'pytan3.api_objects.soap_7_3_314_3641.ContentSet'>, 'content_set_privilege': <class 'pytan3.api_objects.soap_7_3_314_3641.ContentSetPrivilege'>, 'content_set_privileges': <class 'pytan3.api_objects.soap_7_3_314_3641.ContentSetPrivilegeList'>, 'content_set_role': <class 'pytan3.api_objects.soap_7_3_314_3641.ContentSetRole'>, 'content_set_role_membership': <class 'pytan3.api_objects.soap_7_3_314_3641.ContentSetRoleMembership'>, 'content_set_role_memberships': <class 'pytan3.api_objects.soap_7_3_314_3641.ContentSetRoleMembershipList'>, 'content_set_role_privilege': <class 'pytan3.api_objects.soap_7_3_314_3641.ContentSetRolePrivilege'>, 'content_set_role_privileges': <class 'pytan3.api_objects.soap_7_3_314_3641.ContentSetRolePrivilegeList'>, 'content_set_roles': <class 'pytan3.api_objects.soap_7_3_314_3641.ContentSetRoleList'>, 'content_set_user_group_role_membership': <class 'pytan3.api_objects.soap_7_3_314_3641.ContentSetUserGroupRoleMembership'>, 'content_set_user_group_role_memberships': <class 'pytan3.api_objects.soap_7_3_314_3641.ContentSetUserGroupRoleMembershipList'>, 'content_sets': <class 'pytan3.api_objects.soap_7_3_314_3641.ContentSetList'>, 'effective_content_set_privileges': <class 'pytan3.api_objects.soap_7_3_314_3641.EffectiveContentSetPrivilegeRequest'>, 'group': <class 'pytan3.api_objects.soap_7_3_314_3641.Group'>, 'groups': <class 'pytan3.api_objects.soap_7_3_314_3641.GroupList'>, 'hashed_string': <class 'pytan3.api_objects.soap_7_3_314_3641.HashedString'>, 'hashed_strings': <class 'pytan3.api_objects.soap_7_3_314_3641.HashedStringList'>, 'import_conflict_details': <class 'pytan3.api_objects.soap_7_3_314_3641.ImportConflictDetailList'>, 'ldap_sync_connector': <class 'pytan3.api_objects.soap_7_3_314_3641.LdapSyncConnector'>, 'ldap_sync_connectors': <class 'pytan3.api_objects.soap_7_3_314_3641.LdapSyncConnectorList'>, 'package_file': <class 'pytan3.api_objects.soap_7_3_314_3641.PackageFile'>, 'package_files': <class 'pytan3.api_objects.soap_7_3_314_3641.PackageFileList'>, 'package_spec': <class 'pytan3.api_objects.soap_7_3_314_3641.PackageSpec'>, 'package_specs': <class 'pytan3.api_objects.soap_7_3_314_3641.PackageSpecList'>, 'parse_job': <class 'pytan3.api_objects.soap_7_3_314_3641.ParseJob'>, 'parse_jobs': <class 'pytan3.api_objects.soap_7_3_314_3641.ParseJobList'>, 'parse_result_group': <class 'pytan3.api_objects.soap_7_3_314_3641.ParseResultGroup'>, 'parse_result_groups': <class 'pytan3.api_objects.soap_7_3_314_3641.ParseResultGroupList'>, 'plugin': <class 'pytan3.api_objects.soap_7_3_314_3641.Plugin'>, 'plugin_schedule': <class 'pytan3.api_objects.soap_7_3_314_3641.PluginSchedule'>, 'plugin_schedules': <class 'pytan3.api_objects.soap_7_3_314_3641.PluginScheduleList'>, 'plugins': <class 'pytan3.api_objects.soap_7_3_314_3641.PluginList'>, 'question': <class 'pytan3.api_objects.soap_7_3_314_3641.Question'>, 'questions': <class 'pytan3.api_objects.soap_7_3_314_3641.QuestionList'>, 'roles': <class 'pytan3.api_objects.soap_7_3_314_3641.UserRoleList'>, 'saved_action': <class 'pytan3.api_objects.soap_7_3_314_3641.SavedAction'>, 'saved_action_approval': <class 'pytan3.api_objects.soap_7_3_314_3641.SavedActionApproval'>, 'saved_action_approvals': <class 'pytan3.api_objects.soap_7_3_314_3641.SavedActionApprovalList'>, 'saved_actions': <class 'pytan3.api_objects.soap_7_3_314_3641.SavedActionList'>, 'saved_question': <class 'pytan3.api_objects.soap_7_3_314_3641.SavedQuestion'>, 'saved_question_package_specs': <class 'pytan3.api_objects.soap_7_3_314_3641.SavedQuestionPackageSpecs'>, 'saved_question_question': <class 'pytan3.api_objects.soap_7_3_314_3641.SavedQuestionQuestion'>, 'saved_question_questions': <class 'pytan3.api_objects.soap_7_3_314_3641.SavedQuestionQuestionList'>, 'saved_questions': <class 'pytan3.api_objects.soap_7_3_314_3641.SavedQuestionList'>, 'sensor': <class 'pytan3.api_objects.soap_7_3_314_3641.Sensor'>, 'sensor_stat': <class 'pytan3.api_objects.soap_7_3_314_3641.SensorStat'>, 'sensor_stats': <class 'pytan3.api_objects.soap_7_3_314_3641.SensorStatList'>, 'sensors': <class 'pytan3.api_objects.soap_7_3_314_3641.SensorList'>, 'server_host': <class 'pytan3.api_objects.soap_7_3_314_3641.ServerHost'>, 'server_hosts': <class 'pytan3.api_objects.soap_7_3_314_3641.ServerHostList'>, 'server_throttle': <class 'pytan3.api_objects.soap_7_3_314_3641.ServerThrottle'>, 'server_throttle_status': <class 'pytan3.api_objects.soap_7_3_314_3641.ServerThrottleStatus'>, 'server_throttle_statuses': <class 'pytan3.api_objects.soap_7_3_314_3641.ServerThrottleStatusList'>, 'server_throttles': <class 'pytan3.api_objects.soap_7_3_314_3641.ServerThrottleList'>, 'site_throttle': <class 'pytan3.api_objects.soap_7_3_314_3641.SiteThrottle'>, 'site_throttle_status': <class 'pytan3.api_objects.soap_7_3_314_3641.SiteThrottleStatus'>, 'site_throttles': <class 'pytan3.api_objects.soap_7_3_314_3641.SiteThrottleList'>, 'site_throttles_statuses': <class 'pytan3.api_objects.soap_7_3_314_3641.SiteThrottleStatusList'>, 'soap_error': <class 'pytan3.api_objects.soap_7_3_314_3641.SoapError'>, 'solution': <class 'pytan3.api_objects.soap_7_3_314_3641.Solution'>, 'solutions': <class 'pytan3.api_objects.soap_7_3_314_3641.SolutionList'>, 'system_setting': <class 'pytan3.api_objects.soap_7_3_314_3641.SystemSetting'>, 'system_settings': <class 'pytan3.api_objects.soap_7_3_314_3641.SystemSettingList'>, 'system_status': <class 'pytan3.api_objects.soap_7_3_314_3641.SystemStatusList'>, 'upload_file': <class 'pytan3.api_objects.soap_7_3_314_3641.UploadFile'>, 'upload_file_status': <class 'pytan3.api_objects.soap_7_3_314_3641.UploadFileStatus'>, 'user': <class 'pytan3.api_objects.soap_7_3_314_3641.User'>, 'user_group': <class 'pytan3.api_objects.soap_7_3_314_3641.UserGroup'>, 'user_groups': <class 'pytan3.api_objects.soap_7_3_314_3641.UserGroupList'>, 'users': <class 'pytan3.api_objects.soap_7_3_314_3641.UserList'>, 'verify_signature': <class 'pytan3.api_objects.soap_7_3_314_3641.VerifySignature'>, 'white_listed_url': <class 'pytan3.api_objects.soap_7_3_314_3641.WhiteListedUrl'>, 'white_listed_urls': <class 'pytan3.api_objects.soap_7_3_314_3641.WhiteListedUrlList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.ImportConflictDetail(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'import_conflict_detail'

str – Name of object used in API calls.

API_NAME_SRC = 'import_conflict_detail'

str – Name of object in source file.

API_SIMPLE = {'diff': (<class 'str'>,), 'is_new': (<class 'int'>,), 'name': (<class 'str'>,), 'type': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ImportConflictDetailList

API_LIST_API_NAME = 'import_conflict_details'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.CacheFilter(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'cache_filter'

str – Name of object used in API calls.

API_NAME_SRC = 'cache_filter'

str – Name of object in source file.

API_SIMPLE = {'and_flag': (<class 'int'>,), 'field': (<class 'str'>,), 'not_flag': (<class 'int'>,), 'operator': (<class 'str'>,), 'type': (<class 'str'>,), 'value': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'sub_filters': <class 'pytan3.api_objects.soap_7_3_314_3641.CacheFilterList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of CacheFilterList

API_LIST_API_NAME = 'cache_filters'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.Options(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'options'

str – Name of object used in API calls.

API_NAME_SRC = 'options'

str – Name of object in source file.

API_SIMPLE = {'aggregate_by_value_flag': (<class 'int'>,), 'aggregate_over_time_flag': (<class 'int'>,), 'allow_cdata_base64_encode_flag': (<class 'int'>,), 'audit_history_size': (<class 'int'>,), 'cache_expiration': (<class 'int'>,), 'cache_id': (<class 'int'>,), 'cache_sort_fields': (<class 'str'>,), 'cdata_base64_encoded': (<class 'int'>,), 'context_id': (<class 'int'>,), 'disable_live_snapshots': (<class 'int'>,), 'export_dont_include_related': (<class 'int'>,), 'export_flag': (<class 'int'>,), 'export_format': (<class 'int'>,), 'export_hide_csv_header_flag': (<class 'int'>,), 'export_leading_text': (<class 'str'>,), 'export_omit_soap_envelope': (<class 'int'>,), 'export_trailing_text': (<class 'str'>,), 'filter_not_flag': (<class 'int'>,), 'filter_string': (<class 'str'>,), 'flags': (<class 'int'>,), 'hide_errors_flag': (<class 'int'>,), 'hide_no_results_flag': (<class 'int'>,), 'import_analyze_conflicts_only': (<class 'int'>,), 'import_existing_ignore_content_set': (<class 'int'>,), 'include_answer_times_flag': (<class 'int'>,), 'include_hashes_flag': (<class 'int'>,), 'include_hidden_flag': (<class 'int'>,), 'include_user_details': (<class 'int'>,), 'include_user_owned_object_ids_flag': (<class 'int'>,), 'json_pretty_print': (<class 'int'>,), 'live_snapshot_always_use_seconds': (<class 'int'>,), 'live_snapshot_expiration_seconds': (<class 'int'>,), 'live_snapshot_invalidate_report_count_percentage': (<class 'int'>,), 'live_snapshot_report_count_threshold': (<class 'int'>,), 'most_recent_flag': (<class 'int'>,), 'no_result_row_collation_flag': (<class 'int'>,), 'pct_done_limit': (<class 'int'>,), 'recent_result_buckets': (<class 'str'>,), 'return_cdata_flag': (<class 'int'>,), 'return_lists_flag': (<class 'int'>,), 'row_count': (<class 'int'>,), 'row_counts_only_flag': (<class 'int'>,), 'row_start': (<class 'int'>,), 'sample_count': (<class 'int'>,), 'sample_frequency': (<class 'int'>,), 'sample_start': (<class 'int'>,), 'saved_question_qids_allow_multiple_flag': (<class 'int'>,), 'saved_question_qids_ignore_mr_group_flag': (<class 'int'>,), 'saved_question_qids_include_expired_flag': (<class 'int'>,), 'saved_question_qids_reissue_flag': (<class 'int'>,), 'script_data': (<class 'str'>,), 'sort_order': (<class 'str'>,), 'suppress_object_list': (<class 'int'>,), 'suppress_scripts': (<class 'int'>,), 'use_error_objects': (<class 'int'>,), 'use_json': (<class 'int'>,), 'use_user_context_flag': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_filters': <class 'pytan3.api_objects.soap_7_3_314_3641.CacheFilterList'>, 'import_conflict_options': <class 'pytan3.api_objects.soap_7_3_314_3641.ImportConflictOptions'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.ContentSet(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'content_set'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set'

str – Name of object in source file.

API_SIMPLE = {'description': (<class 'str'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'reserved_name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'metadata': <class 'pytan3.api_objects.soap_7_3_314_3641.MetadataList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ContentSetList

API_LIST_API_NAME = 'content_sets'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.ContentSetRolePrivilegeOnRole(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'content_set_role_privilege_on_role'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role_privilege_on_role'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set': <class 'pytan3.api_objects.soap_7_3_314_3641.IdReference'>, 'content_set_privilege': <class 'pytan3.api_objects.soap_7_3_314_3641.IdReference'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ContentSetRolePrivilegeOnRoleList

API_LIST_API_NAME = 'content_set_role_privilege_on_roles'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.ContentSetRole(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'content_set_role'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role'

str – Name of object in source file.

API_SIMPLE = {'all_content_sets_flag': (<class 'int'>,), 'category': (<class 'str'>,), 'deny_flag': (<class 'int'>,), 'description': (<class 'str'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'reserved_name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set_role_privileges': <class 'pytan3.api_objects.soap_7_3_314_3641.ContentSetRolePrivilegeOnRoleList'>, 'metadata': <class 'pytan3.api_objects.soap_7_3_314_3641.MetadataList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ContentSetRoleList

API_LIST_API_NAME = 'content_set_roles'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.ContentSetRoleMembership(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'content_set_role_membership'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role_membership'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set_role': <class 'pytan3.api_objects.soap_7_3_314_3641.IdReference'>, 'user': <class 'pytan3.api_objects.soap_7_3_314_3641.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ContentSetRoleMembershipList

API_LIST_API_NAME = 'content_set_role_memberships'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.ContentSetUserGroupRoleMembership(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'content_set_user_group_role_membership'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_user_group_role_membership'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set_role': <class 'pytan3.api_objects.soap_7_3_314_3641.IdReference'>, 'user_group': <class 'pytan3.api_objects.soap_7_3_314_3641.IdReference'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ContentSetUserGroupRoleMembershipList

API_LIST_API_NAME = 'content_set_user_group_role_memberships'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.ContentSetPrivilege(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'content_set_privilege'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_privilege'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,), 'name': (<class 'str'>,), 'privilege_module': (<class 'str'>,), 'privilege_type': (<class 'str'>,), 'reserved_name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'metadata': <class 'pytan3.api_objects.soap_7_3_314_3641.MetadataList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ContentSetPrivilegeList

API_LIST_API_NAME = 'content_set_privileges'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.ContentSetRolePrivilege(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'content_set_role_privilege'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role_privilege'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set': <class 'pytan3.api_objects.soap_7_3_314_3641.IdReference'>, 'content_set_privilege': <class 'pytan3.api_objects.soap_7_3_314_3641.IdReference'>, 'content_set_role': <class 'pytan3.api_objects.soap_7_3_314_3641.IdReference'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ContentSetRolePrivilegeList

API_LIST_API_NAME = 'content_set_role_privileges'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.EffectiveContentSetPrivilege(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'effective_content_set_privilege'

str – Name of object used in API calls.

API_NAME_SRC = 'effective_content_set_privilege'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set': <class 'pytan3.api_objects.soap_7_3_314_3641.ContentSet'>, 'content_set_privilege_list': <class 'pytan3.api_objects.soap_7_3_314_3641.ContentSetPrivilegeList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of EffectiveContentSetPrivilegeList

API_LIST_API_NAME = 'effective_content_set_privileges'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.Dashboard(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'dashboard'

str – Name of object used in API calls.

API_NAME_SRC = 'dashboard'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,), 'name': (<class 'str'>,), 'public_flag': (<class 'int'>,), 'text': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set': <class 'pytan3.api_objects.soap_7_3_314_3641.ContentSet'>, 'group': <class 'pytan3.api_objects.soap_7_3_314_3641.Group'>, 'saved_question_list': <class 'pytan3.api_objects.soap_7_3_314_3641.SavedQuestionList'>, 'user': <class 'pytan3.api_objects.soap_7_3_314_3641.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of DashboardList

API_LIST_API_NAME = 'dashboards'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.DashboardGroup(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'dashboard_group'

str – Name of object used in API calls.

API_NAME_SRC = 'dashboard_group'

str – Name of object in source file.

API_SIMPLE = {'display_index': (<class 'int'>,), 'editable_flag': (<class 'int'>,), 'icon': (<class 'str'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'other_flag': (<class 'int'>,), 'public_flag': (<class 'int'>,), 'text': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set': <class 'pytan3.api_objects.soap_7_3_314_3641.ContentSet'>, 'dashboard_list': <class 'pytan3.api_objects.soap_7_3_314_3641.DashboardList'>, 'user': <class 'pytan3.api_objects.soap_7_3_314_3641.User'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.UserGroup(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'user_group'

str – Name of object used in API calls.

API_NAME_SRC = 'user_group'

str – Name of object in source file.

API_SIMPLE = {'deleted_flag': (<class 'int'>,), 'exclusive_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'content_set_roles': <class 'pytan3.api_objects.soap_7_3_314_3641.ContentSetRoleList'>, 'group': <class 'pytan3.api_objects.soap_7_3_314_3641.Group'>, 'metadata': <class 'pytan3.api_objects.soap_7_3_314_3641.MetadataList'>, 'user_list': <class 'pytan3.api_objects.soap_7_3_314_3641.UserList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of UserGroupList

API_LIST_API_NAME = 'user_groups'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.Solution(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'solution'

str – Name of object used in API calls.

API_NAME_SRC = 'solution'

str – Name of object in source file.

API_SIMPLE = {'category': (<class 'str'>,), 'delete_xml_url': (<class 'str'>,), 'deleted_flag': (<class 'int'>,), 'description': (<class 'str'>,), 'dup_resolve_type': (<class 'int'>,), 'id': (<class 'int'>,), 'imported_by': (<class 'str'>,), 'imported_version': (<class 'str'>,), 'installed_xml_url': (<class 'str'>,), 'last_update': (<class 'str'>,), 'name': (<class 'str'>,), 'signature': (<class 'str'>,), 'solution_id': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SolutionList

API_LIST_API_NAME = 'solutions'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.ActionGroup(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'action_group'

str – Name of object used in API calls.

API_NAME_SRC = 'action_group'

str – Name of object in source file.

API_SIMPLE = {'and_flag': (<class 'int'>,), 'deleted_flag': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'public_flag': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'groups': <class 'pytan3.api_objects.soap_7_3_314_3641.GroupList'>, 'user_groups': <class 'pytan3.api_objects.soap_7_3_314_3641.UserGroupList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ActionGroupList

API_LIST_API_NAME = 'action_groups'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.SavedQuestionPackageSpecs(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'saved_question_package_specs'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_question_package_specs'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'packages': <class 'pytan3.api_objects.soap_7_3_314_3641.PackageSpecList'>, 'saved_question': <class 'pytan3.api_objects.soap_7_3_314_3641.IdReference'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS = None

ApiList – List class that holds this item class.

API_LIST_API_NAME = ''

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.SavedQuestionQuestion(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'saved_question_question'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_question_question'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'questions': <class 'pytan3.api_objects.soap_7_3_314_3641.QuestionList'>, 'saved_question': <class 'pytan3.api_objects.soap_7_3_314_3641.IdReference'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SavedQuestionQuestionList

API_LIST_API_NAME = 'saved_question_questions'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.LdapSyncConnector(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'ldap_sync_connector'

str – Name of object used in API calls.

API_NAME_SRC = 'ldap_sync_connector'

str – Name of object in source file.

API_SIMPLE = {'base_groups': (<class 'str'>,), 'base_users': (<class 'str'>,), 'disable_ldap_auth': (<class 'int'>,), 'disable_referrals_flag': (<class 'int'>,), 'enable': (<class 'int'>,), 'filter_groups': (<class 'str'>,), 'filter_users': (<class 'str'>,), 'group_id': (<class 'str'>,), 'group_member': (<class 'str'>,), 'group_name': (<class 'str'>,), 'host': (<class 'str'>,), 'id': (<class 'int'>,), 'last_sync_result': (<class 'str'>,), 'last_sync_timestamp': (<class 'str'>,), 'ldap_password': (<class 'str'>,), 'ldap_user': (<class 'str'>,), 'members_only_flag': (<class 'int'>,), 'name': (<class 'str'>,), 'port': (<class 'int'>,), 'secure': (<class 'int'>,), 'sync_individual_members_flag': (<class 'int'>,), 'use_ntlm': (<class 'int'>,), 'user_display_name': (<class 'str'>,), 'user_domain': (<class 'str'>,), 'user_id': (<class 'str'>,), 'user_member_of': (<class 'str'>,), 'user_name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of LdapSyncConnectorList

API_LIST_API_NAME = 'ldap_sync_connectors'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.ServerThrottle(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'server_throttle'

str – Name of object used in API calls.

API_NAME_SRC = 'server_throttle'

str – Name of object in source file.

API_SIMPLE = {'bandwidth_bytes_limit': (<class 'int'>,), 'connection_limit': (<class 'int'>,), 'deleted_flag': (<class 'int'>,), 'download_bandwidth_bytes_limit': (<class 'int'>,), 'download_connection_limit': (<class 'int'>,), 'id': (<class 'int'>,), 'ip_address': (<class 'str'>,), 'name': (<class 'str'>,), 'sensor_bandwidth_bytes_limit': (<class 'int'>,), 'sensor_connection_limit': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ServerThrottleList

API_LIST_API_NAME = 'server_throttles'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.SiteThrottle(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'site_throttle'

str – Name of object used in API calls.

API_NAME_SRC = 'site_throttle'

str – Name of object in source file.

API_SIMPLE = {'all_subnets_flag': (<class 'int'>,), 'bandwidth_bytes_limit': (<class 'int'>,), 'deleted_flag': (<class 'int'>,), 'download_bandwidth_bytes_limit': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'sensor_bandwidth_bytes_limit': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'subnets': <class 'pytan3.api_objects.soap_7_3_314_3641.SiteThrottleSubnetList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SiteThrottleList

API_LIST_API_NAME = 'site_throttles'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.SiteThrottleSubnet(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'site_throttle_subnet'

str – Name of object used in API calls.

API_NAME_SRC = 'site_throttle_subnet'

str – Name of object in source file.

API_SIMPLE = {'range': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SiteThrottleSubnetList

API_LIST_API_NAME = 'site_throttle_subnets'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.ServerThrottleStatus(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'server_throttle_status'

str – Name of object used in API calls.

API_NAME_SRC = 'server_throttle_status'

str – Name of object in source file.

API_SIMPLE = {'download_queue_delay_milliseconds': (<class 'int'>,), 'id': (<class 'int'>,), 'name': (<class 'str'>,), 'queue_delay_milliseconds': (<class 'int'>,), 'sensor_queue_delay_milliseconds': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of ServerThrottleStatusList

API_LIST_API_NAME = 'server_throttle_statuses'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.SiteThrottleStatus(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'site_throttle_status'

str – Name of object used in API calls.

API_NAME_SRC = 'site_throttle_status'

str – Name of object in source file.

API_SIMPLE = {'id': (<class 'int'>,), 'name': (<class 'str'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'subnets': <class 'pytan3.api_objects.soap_7_3_314_3641.SiteThrottleSubnetStatusList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SiteThrottleStatusList

API_LIST_API_NAME = 'site_throttles_statuses'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.SiteThrottleSubnetStatus(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'site_throttle_subnet_status'

str – Name of object used in API calls.

API_NAME_SRC = 'site_throttle_subnet_status'

str – Name of object in source file.

API_SIMPLE = {'download_queue_delay_milliseconds': (<class 'int'>,), 'queue_delay_milliseconds': (<class 'int'>,), 'range': (<class 'str'>,), 'sensor_queue_delay_milliseconds': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of SiteThrottleSubnetStatusList

API_LIST_API_NAME = 'site_throttle_subnet_statuss'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.HashedString(**kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiItem

Automagically generated API object.

API_NAME = 'hashed_string'

str – Name of object used in API calls.

API_NAME_SRC = 'hashed_string'

str – Name of object in source file.

API_SIMPLE = {'collision_flag': (<class 'int'>,), 'error_flag': (<class 'int'>,), 'first_collision': (<class 'str'>,), 'second_collision': (<class 'str'>,), 'sensor_hash': (<class 'int'>,), 'value': (<class 'str'>,), 'value_hash': (<class 'int'>,), 'which_computer_id': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'first_computer_id': <class 'pytan3.api_objects.soap_7_3_314_3641.ComputerIdList'>, 'second_computer_id': <class 'pytan3.api_objects.soap_7_3_314_3641.ComputerIdList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_LIST_CLS

ApiList: List class that holds this item class.

alias of HashedStringList

API_LIST_API_NAME = 'hashed_strings'

str – Name of API_LIST_CLS used in API calls.

class pytan3.api_objects.soap_7_3_314_3641.SensorQueryList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'sensor_querys'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_query_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'query'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SensorQuery

class pytan3.api_objects.soap_7_3_314_3641.SensorSubcolumnList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'sensor_subcolumns'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_subcolumn_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'subcolumn'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SensorSubcolumn

class pytan3.api_objects.soap_7_3_314_3641.StringHintList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'string_hints'

str – Name of object used in API calls.

API_NAME_SRC = 'string_hint_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'string_hint'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'str'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.soap_7_3_314_3641.SensorList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'sensors'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_3_314_3641.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'sensor'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Sensor

class pytan3.api_objects.soap_7_3_314_3641.SensorStatList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'sensor_stats'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_stat_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'sensor_stat'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SensorStat

class pytan3.api_objects.soap_7_3_314_3641.SavedActionApprovalList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'saved_action_approvals'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_action_approval_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'saved_action_approval'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SavedActionApproval

class pytan3.api_objects.soap_7_3_314_3641.SavedActionRowIdList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'saved_action_row_ids'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_action_row_id_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'row_id'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'int'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.soap_7_3_314_3641.SavedActionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'saved_actions'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_action_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_3_314_3641.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'saved_action'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SavedAction

class pytan3.api_objects.soap_7_3_314_3641.AuditDataList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'audit_datas'

str – Name of object used in API calls.

API_NAME_SRC = 'audit_data_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_3_314_3641.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'entry'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of AuditData

class pytan3.api_objects.soap_7_3_314_3641.AuditLogList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'audit_logs'

str – Name of object used in API calls.

API_NAME_SRC = 'audit_log_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'audit_log'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of AuditLog

class pytan3.api_objects.soap_7_3_314_3641.ServerList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'servers'

str – Name of object used in API calls.

API_NAME_SRC = 'server_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'server'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Server

class pytan3.api_objects.soap_7_3_314_3641.ServerHost(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'server_host'

str – Name of object used in API calls.

API_NAME_SRC = 'server_host'

str – Name of object in source file.

API_SIMPLE = {'heart_beat_age_in_minute': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'servers'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ServerList

class pytan3.api_objects.soap_7_3_314_3641.ServerHostList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'server_hosts'

str – Name of object used in API calls.

API_NAME_SRC = 'server_host_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'server_host'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ServerHost

class pytan3.api_objects.soap_7_3_314_3641.MetadataList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'metadatas'

str – Name of object used in API calls.

API_NAME_SRC = 'metadata_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'item'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of MetadataItem

class pytan3.api_objects.soap_7_3_314_3641.GroupList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'groups'

str – Name of object used in API calls.

API_NAME_SRC = 'group_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_3_314_3641.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'group'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Group

class pytan3.api_objects.soap_7_3_314_3641.FilterList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'filters'

str – Name of object used in API calls.

API_NAME_SRC = 'filter_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'filter'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Filter

class pytan3.api_objects.soap_7_3_314_3641.SelectList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'selects'

str – Name of object used in API calls.

API_NAME_SRC = 'select_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'select'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Select

class pytan3.api_objects.soap_7_3_314_3641.ErrorList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'errors'

str – Name of object used in API calls.

API_NAME_SRC = 'error_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'error'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of XmlError

class pytan3.api_objects.soap_7_3_314_3641.QuestionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'questions'

str – Name of object used in API calls.

API_NAME_SRC = 'question_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_3_314_3641.CacheInfo'>, 'info': <class 'pytan3.api_objects.soap_7_3_314_3641.QuestionListInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'question'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Question

class pytan3.api_objects.soap_7_3_314_3641.PackageFileTemplateList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'package_file_templates'

str – Name of object used in API calls.

API_NAME_SRC = 'package_file_template_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'file_template'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of PackageFileTemplate

class pytan3.api_objects.soap_7_3_314_3641.PackageFileStatusList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'package_file_statuss'

str – Name of object used in API calls.

API_NAME_SRC = 'package_file_status_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'status'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of PackageFileStatus

class pytan3.api_objects.soap_7_3_314_3641.PackageFileList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'package_files'

str – Name of object used in API calls.

API_NAME_SRC = 'package_file_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'file'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of PackageFile

class pytan3.api_objects.soap_7_3_314_3641.PackageSpecList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'package_specs'

str – Name of object used in API calls.

API_NAME_SRC = 'package_spec_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_3_314_3641.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'package_spec'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of PackageSpec

class pytan3.api_objects.soap_7_3_314_3641.WhiteListedUrlList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'white_listed_urls'

str – Name of object used in API calls.

API_NAME_SRC = 'white_listed_url_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'white_listed_url'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of WhiteListedUrl

class pytan3.api_objects.soap_7_3_314_3641.VersionAggregateList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'version_aggregates'

str – Name of object used in API calls.

API_NAME_SRC = 'version_aggregate_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'version'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of VersionAggregate

class pytan3.api_objects.soap_7_3_314_3641.SystemStatusList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'system_status'

str – Name of object used in API calls.

API_NAME_SRC = 'system_status_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'aggregate': <class 'pytan3.api_objects.soap_7_3_314_3641.SystemStatusAggregate'>, 'cache_info': <class 'pytan3.api_objects.soap_7_3_314_3641.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'client_status'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ClientStatus

class pytan3.api_objects.soap_7_3_314_3641.SystemSettingList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'system_settings'

str – Name of object used in API calls.

API_NAME_SRC = 'system_setting_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_3_314_3641.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'system_setting'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SystemSetting

class pytan3.api_objects.soap_7_3_314_3641.UserList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'users'

str – Name of object used in API calls.

API_NAME_SRC = 'user_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'user'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of User

class pytan3.api_objects.soap_7_3_314_3641.PermissionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'permissions'

str – Name of object used in API calls.

API_NAME_SRC = 'permission_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {'ACTION_APPROVE': 'action_approval', 'ACTION_READ': 'action_read', 'ACTION_WRITE': 'action_write', 'ADMIN': 'admin', 'CLIENTS_READ': 'clients_read', 'CONTENT_ADMIN': 'content_admin', 'NOTIFICATION_WRITE': 'notification_write', 'QUESTION_LOG_READ': 'question_log_read', 'QUESTION_READ': 'question_read', 'QUESTION_WRITE': 'question_write', 'SENSOR_READ': 'sensor_read', 'SENSOR_WRITE': 'sensor_write'}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'permission'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'str'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.soap_7_3_314_3641.UserRoleList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'roles'

str – Name of object used in API calls.

API_NAME_SRC = 'user_role_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'role'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of UserRole

class pytan3.api_objects.soap_7_3_314_3641.ActionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'actions'

str – Name of object used in API calls.

API_NAME_SRC = 'action_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_3_314_3641.CacheInfo'>, 'info': <class 'pytan3.api_objects.soap_7_3_314_3641.ActionListInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'action'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Action

class pytan3.api_objects.soap_7_3_314_3641.ActionStopList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'action_stops'

str – Name of object used in API calls.

API_NAME_SRC = 'action_stop_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'action_stop'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ActionStop

class pytan3.api_objects.soap_7_3_314_3641.ArchivedQuestionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'archived_questions'

str – Name of object used in API calls.

API_NAME_SRC = 'archived_question_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'archived_question'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ArchivedQuestion

class pytan3.api_objects.soap_7_3_314_3641.SavedQuestionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'saved_questions'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_question_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_3_314_3641.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'saved_question'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SavedQuestion

class pytan3.api_objects.soap_7_3_314_3641.ParseJobList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'parse_jobs'

str – Name of object used in API calls.

API_NAME_SRC = 'parse_job_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'parse_job'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ParseJob

class pytan3.api_objects.soap_7_3_314_3641.ParseResultGroupList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'parse_result_groups'

str – Name of object used in API calls.

API_NAME_SRC = 'parse_result_group_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'parse_result_group'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ParseResultGroup

class pytan3.api_objects.soap_7_3_314_3641.ParseResultList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'parse_results'

str – Name of object used in API calls.

API_NAME_SRC = 'parse_result_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'parse_result'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ParseResult

class pytan3.api_objects.soap_7_3_314_3641.ParameterList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'parameters'

str – Name of object used in API calls.

API_NAME_SRC = 'parameter_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'parameter'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Parameter

class pytan3.api_objects.soap_7_3_314_3641.ParameterValueList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'parameter_values'

str – Name of object used in API calls.

API_NAME_SRC = 'parameter_value_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'value'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'str'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.soap_7_3_314_3641.SensorReferenceList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'sensor_references'

str – Name of object used in API calls.

API_NAME_SRC = 'sensor_reference_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'sensor_reference'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SensorReference

class pytan3.api_objects.soap_7_3_314_3641.PluginArgumentList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'plugin_arguments'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_argument_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'argument'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of PluginArgument

class pytan3.api_objects.soap_7_3_314_3641.PluginSqlResultList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'plugin_sql_results'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_sql_result_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'value'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'str'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.soap_7_3_314_3641.PluginSqlColumnList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'plugin_sql_columns'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_sql_column_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'name'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'str'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.soap_7_3_314_3641.PluginSql(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'plugin_sql'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_sql'

str – Name of object in source file.

API_SIMPLE = {'result_count': (<class 'int'>,), 'rows_affected': (<class 'int'>,)}

dict – Map of simple attributes to their types.

API_COMPLEX = {'columns': <class 'pytan3.api_objects.soap_7_3_314_3641.PluginSqlColumnList'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'result_row'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of PluginSqlResultList

class pytan3.api_objects.soap_7_3_314_3641.PluginCommandList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'plugin_commands'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_command_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'command'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'str'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.soap_7_3_314_3641.UploadFileList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'upload_files'

str – Name of object used in API calls.

API_NAME_SRC = 'upload_file_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'upload_file'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of UploadFile

class pytan3.api_objects.soap_7_3_314_3641.PluginList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'plugins'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_3_314_3641.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'plugin'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Plugin

class pytan3.api_objects.soap_7_3_314_3641.PluginScheduleList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'plugin_schedules'

str – Name of object used in API calls.

API_NAME_SRC = 'plugin_schedule_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_3_314_3641.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'plugin_schedule'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of PluginSchedule

class pytan3.api_objects.soap_7_3_314_3641.ComputerSpecList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'computer_specs'

str – Name of object used in API calls.

API_NAME_SRC = 'computer_spec_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_3_314_3641.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'computer_spec'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ComputerGroupSpec

class pytan3.api_objects.soap_7_3_314_3641.ComputerGroupList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'computer_groups'

str – Name of object used in API calls.

API_NAME_SRC = 'computer_group_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {'cache_info': <class 'pytan3.api_objects.soap_7_3_314_3641.CacheInfo'>}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'computer_group'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ComputerGroup

class pytan3.api_objects.soap_7_3_314_3641.ImportConflictDetailList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'import_conflict_details'

str – Name of object used in API calls.

API_NAME_SRC = 'import_conflict_detail_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'import_conflict_detail'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ImportConflictDetail

class pytan3.api_objects.soap_7_3_314_3641.CacheFilterList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'cache_filters'

str – Name of object used in API calls.

API_NAME_SRC = 'cache_filter_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'filter'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of CacheFilter

class pytan3.api_objects.soap_7_3_314_3641.ImportConflictOptions(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'import_conflict_options'

str – Name of object used in API calls.

API_NAME_SRC = 'import_conflict_options'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'import_conflict_option'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'int'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.soap_7_3_314_3641.ContentSetList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'content_sets'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'content_set'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ContentSet

class pytan3.api_objects.soap_7_3_314_3641.ContentSetRolePrivilegeOnRoleList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'content_set_role_privilege_on_roles'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role_privilege_on_role_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'content_set_role_privilege'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ContentSetRolePrivilegeOnRole

class pytan3.api_objects.soap_7_3_314_3641.ContentSetRoleList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'content_set_roles'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'content_set_role'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ContentSetRole

class pytan3.api_objects.soap_7_3_314_3641.ContentSetRoleMembershipList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'content_set_role_memberships'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role_membership_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'content_set_role_membership'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ContentSetRoleMembership

class pytan3.api_objects.soap_7_3_314_3641.ContentSetUserGroupRoleMembershipList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'content_set_user_group_role_memberships'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_user_group_role_membership_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'content_set_user_group_role_membership'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ContentSetUserGroupRoleMembership

class pytan3.api_objects.soap_7_3_314_3641.ContentSetPrivilegeList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'content_set_privileges'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_privilege_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'content_set_privilege'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ContentSetPrivilege

class pytan3.api_objects.soap_7_3_314_3641.ContentSetRolePrivilegeList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'content_set_role_privileges'

str – Name of object used in API calls.

API_NAME_SRC = 'content_set_role_privilege_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'content_set_role_privilege'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ContentSetRolePrivilege

class pytan3.api_objects.soap_7_3_314_3641.EffectiveContentSetPrivilegeRequest(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'effective_content_set_privilege_request'

str – Name of object used in API calls.

API_NAME_SRC = 'effective_content_set_privilege_request'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'user'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of User

class pytan3.api_objects.soap_7_3_314_3641.EffectiveContentSetPrivilegeList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'effective_content_set_privileges'

str – Name of object used in API calls.

API_NAME_SRC = 'effective_content_set_privilege_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'effective_content_set_privilege'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of EffectiveContentSetPrivilege

class pytan3.api_objects.soap_7_3_314_3641.DashboardList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'dashboards'

str – Name of object used in API calls.

API_NAME_SRC = 'dashboard_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'dashboard'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Dashboard

class pytan3.api_objects.soap_7_3_314_3641.UserGroupList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'user_groups'

str – Name of object used in API calls.

API_NAME_SRC = 'user_group_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'user_group'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of UserGroup

class pytan3.api_objects.soap_7_3_314_3641.SolutionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'solutions'

str – Name of object used in API calls.

API_NAME_SRC = 'solution_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'solution'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of Solution

class pytan3.api_objects.soap_7_3_314_3641.ActionGroupList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'action_groups'

str – Name of object used in API calls.

API_NAME_SRC = 'action_group_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'action_group'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ActionGroup

class pytan3.api_objects.soap_7_3_314_3641.SavedQuestionQuestionList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'saved_question_questions'

str – Name of object used in API calls.

API_NAME_SRC = 'saved_question_question_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'saved_question_question'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SavedQuestionQuestion

class pytan3.api_objects.soap_7_3_314_3641.LdapSyncConnectorList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'ldap_sync_connectors'

str – Name of object used in API calls.

API_NAME_SRC = 'ldap_sync_connector_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'ldap_sync_connector'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of LdapSyncConnector

class pytan3.api_objects.soap_7_3_314_3641.ServerThrottleList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'server_throttles'

str – Name of object used in API calls.

API_NAME_SRC = 'server_throttle_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'server_throttle'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ServerThrottle

class pytan3.api_objects.soap_7_3_314_3641.SiteThrottleList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'site_throttles'

str – Name of object used in API calls.

API_NAME_SRC = 'site_throttle_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'site_throttle'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SiteThrottle

class pytan3.api_objects.soap_7_3_314_3641.SiteThrottleSubnetList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'site_throttle_subnets'

str – Name of object used in API calls.

API_NAME_SRC = 'site_throttle_subnet_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'subnet'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SiteThrottleSubnet

class pytan3.api_objects.soap_7_3_314_3641.ServerThrottleStatusList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'server_throttle_statuses'

str – Name of object used in API calls.

API_NAME_SRC = 'server_throttle_status_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'server_throttle_status'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of ServerThrottleStatus

class pytan3.api_objects.soap_7_3_314_3641.SiteThrottleStatusList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'site_throttles_statuses'

str – Name of object used in API calls.

API_NAME_SRC = 'site_throttle_status_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'site_throttle_status'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SiteThrottleStatus

class pytan3.api_objects.soap_7_3_314_3641.SiteThrottleSubnetStatusList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'site_throttle_subnet_statuss'

str – Name of object used in API calls.

API_NAME_SRC = 'site_throttle_subnet_status_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'subnet'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of SiteThrottleSubnetStatus

class pytan3.api_objects.soap_7_3_314_3641.ComputerIdList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'computer_ids'

str – Name of object used in API calls.

API_NAME_SRC = 'computer_id_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'id'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = (<class 'int'>,)

ApiItem – Item class this list class holds.

class pytan3.api_objects.soap_7_3_314_3641.HashedStringList(*args, **kwargs)[source]

Bases: pytan3.api_objects.soap_7_3_314_3641.ApiList

Automagically generated API array object.

API_NAME = 'hashed_strings'

str – Name of object used in API calls.

API_NAME_SRC = 'hashed_string_list'

str – Name of object in source file.

API_SIMPLE = {}

dict – Map of simple attributes to their types.

API_COMPLEX = {}

dict – Map of complex attributes to their types.

API_CONSTANTS = {}

dict – Map of constants to their values.

API_STR_ADD = []

list or str – Attributes to add to str formatting.

API_ITEM_ATTR = 'hashed_string'

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS

ApiItem: Item class this list class holds.

alias of HashedString

pytan3.api_objects.soap_7_3_314_3641.BUILD_META = {'date': '2019-02-22 07:46:08.408656', 'script': 'build_objects_from_wsdl.py', 'script_platform': 'Darwin-18.2.0-x86_64-i386-64bit', 'script_python': '3.7.2 (default, Feb 20 2019, 14:09:01) ', 'script_version': '3.0.0', 'source_file': '/libraries/taniumjs/console.wsdl', 'source_file_date': '2019-02-22 07:29:24.912505'}

dict – How this module was built (date/time in UTC format).

pytan3.api_objects.soap_7_3_314_3641.COMMANDS = ['AddObject', 'GetObject', 'MoveObject', 'TransferObject', 'UpdateObject', 'DeleteObject', 'GetSavedQuestions', 'GetResultInfo', 'GetResultData', 'GetMergedResultData', 'UploadFile', 'RunPlugin', 'ExportObject', 'ImportObject', 'VerifySignature']

list of str – API commands.

pytan3.api_objects.soap_7_3_314_3641.VERSION = {'build': 3641, 'major': 7, 'minor': 3, 'protocol': 314, 'string': '7.3.314.3641'}

dict – Tanium API version these objects are intended to be used for.

Models for API Object Modules

Models for Python objects in Tanium’s API.

pytan3.api_models.float_types = (<class 'float'>,)

tuple of type – Float types.

pytan3.api_models.integer_types = (<class 'int'>,)

tuple of type – Integer types.

pytan3.api_models.simple_types = (<class 'int'>, <class 'str'>, <class 'float'>)

tuple of type – All types that should be considered simple types.

pytan3.api_models.string_types = (<class 'str'>,)

tuple of type – String types.

Base class for all API Objects

class pytan3.api_models.ApiModel[source]

Bases: object

Base class for all models in the API.

API_NAME = None

str – Name of object used in API calls.

API_NAME_SRC = None

str – Name of object in source file.

API_SIMPLE = None

dict – Map of simple attributes to their types.

API_COMPLEX = None

dict – Map of complex attributes to their types.

API_CONSTANTS = None

dict – Map of constants to their values.

API_STR_ADD = None

list or str – Added to API_STR in str.

T_ATTR_REPR = '{attr}={value!r}'

str – Template for simple attrs in str and all attr in repr.

T_ATTR_STR = '{attr}={value}'

str – Template for complex attrs in str.

T_ATTR_JOIN = ', '

str – String used to join attr vals in str and repr.

T_CLS_STR = '{obj.__class__.__name__}({attrs})'

str – Template for class name and attrs in str.

T_CLS_REPR = '{obj.__class__.__name__}({attrs})'

str – Template for class name and attrs in repr.

T_ATTR_DESC = ' - {api_type} attribute {attr!r} of type {attr_type!r}'

str – Template for attr line in api_attrs_desc().

T_DESC = 'Defined attributes:'

str – Template for first line in api_attrs_desc().

API_STR = ['id', 'name', 'display_name', 'value', 'type', 'public_flag', 'hidden_flag', 'question', 'query_text', 'question_text', 'expiration', 'saved_question']

list of str – Attrs to display in str or to put first in repr.

__copy__()[source]

Support shallow copy for self.

Returns:ApiItem
__deepcopy__(memo)[source]

Support deep copy for self.

Returns:ApiItem
__eq__(value)[source]

Support for self == value.

Parameters:value (dict or list or ApiModel or object) – Value for comparison.

Notes

  • If value is a dict, it will be turned into an ApiModel.
  • If this object is an ApiList and value is a list, it will be turned into an ApiList.
  • If value is turned into or already is an ApiModel, it will be serialized into a dict/list.
  • Finally, actual comparison of value is done against this object serialized into a dict/list.
Returns:bool
__ne__(value)[source]

Support for self != value.

Parameters:value (dict or list or ApiModel or object) – Value for comparison.
Returns:bool
classmethod api_attrs()[source]

Get simple and complex attributes combined.

Returns:dict
classmethod api_attrs_repr()[source]

Get attributes for repr formatting.

Notes

Will return attrs without dupes in order of priority to show on format string from API_STR, API_STR_ADD, and api_attrs().

Returns:list of str
classmethod api_attrs_str()[source]

Get attributes for str formatting.

Notes

Will return attrs without dupes in order of priority to show on format string from API_STR and API_STR_ADD.

If no attrs from API_STR and API_STR_ADD exist in api_attrs(), return all attrs from api_attrs().

Returns:list of str
classmethod api_attrs_desc()[source]

Get description of attrs from API_SIMPLE and API_COMPLEX.

Notes

Used by exceptions to add defined attributes to error messages.

Returns:list of str
classmethod api_coerce_int(value)[source]

Try to coerce value into int if possible.

Parameters:value (object) – Object to coerce into int.
Returns:int or object if unchanged.
classmethod api_coerce_float(value)[source]

Try to coerce value into float if possible.

Parameters:value (object) – Object to coerce into float.
Returns:float or object if unchanged.
classmethod api_coerce_list(value)[source]

Coerce value into list if it is not already.

Parameters:value (object) – Object to coerce into list. If value is None, will return empty list.
Returns:list or object if unchanged.
classmethod api_coerce_simple(value, be_type)[source]

Try to coerce a value into a simple type.

Parameters:
  • value (object) – Value that should be coerced.
  • be_type (object) – Type that value should be coerced to.
Returns:

float or int or str or object if unchanged.
classmethod api_coerce_complex(value, be_type)[source]

Try to coerce a value into a complex type.

Parameters:
  • value (object) – Value that should be coerced.
  • be_type (object) – Type that value should be coerced to.
Returns:

ApiItem or ApiList or object if unchanged.
api_coerce_value(attr, value)[source]

Perform type checking of value.

Will coerce value into expected type if needed and possible.

Parameters:
  • attr (str) – Attribute that is being set with value on obj.
  • value (object) – Value of attr being checked.
Raises:

Notes

No checking or coercion is done if:
  • value is None
  • attr starts with “_”
  • attr is all upper case
Returns:object

Base class for all API item objects

class pytan3.api_models.ApiItem(**kwargs)[source]

Bases: pytan3.api_models.ApiModel

Model for a complex item in the API.

API_LIST_API_NAME = None

str – Name of API_LIST_CLS used in API calls.

API_LIST_CLS = None

ApiList – List class that holds this item class.

__init__(**kwargs)[source]

Constructor.

Parameters:**kwargs – Set and checked using ApiModel.api_attrs().
__len__()[source]

Return number of ApiModel.api_attrs() that are not None.

Returns:int
__str__()[source]

Show object info using ApiModel.api_attrs_str().

Returns:str
__repr__()[source]

Show object info using ApiModel.api_attrs_repr().

Returns:str
__setattr__(attr, value)[source]

Enforce type using ApiModel.api_coerce_value().

serialize(empty=False, list_attrs=False, exclude_attrs=None, only_attrs=None, wrap_name=True, wrap_item_attr=True)[source]

Serialize this object into a dict.

Parameters:
  • empty (bool, optional) –

    Include attrs that have a value of None when serializing.

    Defaults to: False.

  • list_attrs (bool, optional) –

    Include simple attrs of ApiList when serializing.

    Defaults to: False.

  • exclude_attrs (list of str, optional) –

    Exclude these attrs when serializing.

    Defaults to: None.

  • only_attrs (list of str, optional) –

    Include only these attrs when serializing.

    Defaults to: None.

  • wrap_name (bool, optional) –

    Wrap return in a dict with key of ApiModel.API_NAME and value of return.

    Defaults to: True.

  • wrap_item_attr (bool, optional) –

    Wrap return in a dict with key of ApiList.API_ITEM_ATTR and value of return.

    Only used when serializing items of type ApiList.

    Defaults to: True.

Notes

All child objects will get wrap_name=False.

Returns:dict

Base class for all API array objects

class pytan3.api_models.ApiList(*args, **kwargs)[source]

Bases: pytan3.api_models.ApiModel

Model for an array in the API.

API_ITEM_ATTR = None

str – Name of API_ITEM_CLS used in API calls.

API_ITEM_CLS = None

ApiItem – Item class this list class holds.

T_CLS_STR = '{obj.__class__.__name__}({attrs}) with {count} {item_cls} objects'

str – Template for class name and attrs in str.

__init__(*args, **kwargs)[source]

Constructor.

Parameters:
LIST = None

list of API_ITEM_CLS – List container for this class.

__str__()[source]

Show object info using ApiModel.api_attrs_str().

Returns:str
__repr__()[source]

Show object info using ApiModel.api_attrs_repr().

Returns:str
__len__()[source]

Return length of list container LIST.

Returns:int
__contains__(value)[source]

Support in operand.

Parameters:value (object) – Check if this value in LIST.

Notes

Will call api_coerce_item() to check value is of type defined in API_ITEM_CLS, but will return False if value is of wrong type and can not be coerced.

Returns:
Return type:bool
__add__(value)[source]

Support + operand.

Parameters:value (ApiList or list or tuple) – ApiList of this same type or a python list type to combine with this object.

Notes

This will use api_coerce_items() to perform type checking on each item in value.

Returns:A new instance with list items from this object combined with list items from value.
Return type:ApiList
__iadd__(value)[source]

Support += operand.

Parameters:value (ApiList or list or tuple) – ApiList of this same type or a python list type to combine with this object.

Notes

This will use api_coerce_items() to perform type checking on each item in value.

Returns:This object with list items from value appended.
Return type:ApiList
__getitem__(value)[source]

Support indexing of list container.

Parameters:value (int) – Index of item to retrieve from LIST.
Returns:The type of object this list contains.
Return type:API_ITEM_CLS
__setattr__(attr, value)[source]

Enforce type checking for attr and value.

Parameters:

Notes

If attr is either “LIST” or API_ITEM_ATTR, will use api_coerce_items() to perform type checking on each item in value.

If attr is same as API_ITEM_ATTR, the attr will be changed to “LIST”.

api_coerce_items(attr, value, op)[source]

Check that value is a list type and that all items value are the proper type.

Parameters:
  • attr (str) – Attribute being set on this object.
  • value (ApiList or list or tuple) – The list object holding items that should have type checking.
  • op (str) –

    Operation being performed that called this method.

    Used in exception messages.
Raises:

pytan3.api_models.exceptions.ListTypeError – If value is not a list or tuple or an ApiList that is the same type as this objects class.

Notes

Will call api_coerce_items_hook() before checking each item in value, which can be overridden by subclasses to modify value.

Will call api_coerce_item() to check each item in value is of type defined in API_ITEM_CLS.

Returns:The list of items with their values checked and coerced.
Return type:list
api_coerce_items_hook(attr, value, op)[source]

Check hook that allows subclasses to modify list items.

Parameters:
  • attr (str) – Attribute being set on this object.
  • value (ApiList or list or tuple) – The list object holding items.
  • op (str) – Operation being performed that called this method.

Notes

By default, this does nothing but return value unchanged.

Returns:The list of items modified or as is.
Return type:list
api_coerce_item(item, items, attr, op)[source]

Perform type checking of a list item.

Parameters:
  • item (object) – Item that is being checked.
  • items (ApiList or list or tuple) – The list object that item came from.
  • op (str) –

    Operation being performed that called this method.

    Used in exception messages.

Notes

Will coerce item into expected type if needed and possible.

Raises:pytan3.api_models.exceptions.ListItemTypeError – If item does not match the type from API_ITEM_CLS and it can not be coerced into the expected type.
Returns:object
classmethod api_attrs_desc()[source]

Get simple and complex attributes of an ApiModel object in string format.

Notes

Used by exceptions to add defined attributes to error messages.

Returns:list of str
classmethod api_item_cls_str()[source]

Get str of API_ITEM_CLS.

Returns:str
classmethod api_item_cls_is_complex()[source]

Check if API_ITEM_CLS is an ApiModel sub class.

Returns:bool
append(value)[source]

Support appending an item to list container.

Parameters:value (object) – Item to append to LIST.

Notes

Will call api_coerce_item() to check value is of type defined in API_ITEM_CLS.

remove(value)[source]

Support removing an item from list container.

Parameters:value (object) – Item to remove from LIST.
pop(value=-1)[source]

Support pop of an item from list container.

Parameters:value (object, optional) –

Item to pop from LIST.

Defaults to: -1.
reverse()[source]

Support reverse on list container.

get_item_by_attr(value, attr='name', regex_value=False)[source]

Support getting an item from list container by attr value.

Parameters:
  • value (object) – Value to check against the attr value of each item in LIST.
  • attr (str, optional) –

    Attribute to check if value matches.

    Defaults to: “name”.

  • regex_value (bool, optional) –

    Treat value as a regex pattern instead of comparing equality of value to attr value.

    Defaults to: False.
Raises:

pytan3.api_models.exceptions.GetSingleItemError – If number of items in LIST whose attr value matches value is either 0 or more than 1.
Returns:

The object from LIST whose attr value matches value.
Return type:

object
get_items_by_attr(value, attr='name', regex_value=False, new_list=False)[source]

Support getting items from list container by attr value.

Parameters:
  • value (object) – Value to check against the attr value of each item in LIST.
  • attr (str, optional) –

    Attribute to check if value matches.

    Defaults to: “name”.

  • regex_value (bool, optional) –

    Treat value as a regex pattern instead of comparing equality of value to attr value.

    Defaults to: False.

  • new_list (bool, optional) –

    Return a new class of this objects type with matching items instead of a regular python list type.

    Defaults to: False.
Returns:

All objects from LIST whose attr value matches value.
Return type:

list of object
pop_item_by_attr(value, attr='name', regex_value=False)[source]

Support popping an item from list container by attr value.

Parameters:
  • value (object) – Value to check against the attr value of each item in LIST.
  • attr (str, optional) –

    Attribute to check if value matches.

    Defaults to: “name”.

  • regex_value (bool, optional) –

    Treat value as a regex pattern instead of comparing equality of value to attr value.

    Defaults to: False.
Raises:

pytan3.api_models.exceptions.GetSingleItemError – If number of items in LIST whose attr value matches value is either 0 or more than 1.
Returns:

The object popped from LIST whose attr value matches value.
Return type:

object
pop_items_by_attr(value, attr='name', regex_value=False, new_list=False)[source]

Support popping items from list container by attr value.

Parameters:
  • value (object) – Value to check against the attr value of each item in LIST.
  • attr (str, optional) –

    Attribute to check if value matches.

    Defaults to: “name”.

  • regex_value (bool, optional) –

    Treat value as a regex pattern instead of comparing equality of value to attr value.

    Defaults to: False.

  • new_list (bool, optional) –

    Return a new class of this objects type with matching items instead of a regular python list type.

    Defaults to: False.
Returns:

All objects popped from LIST whose attr value matches value.
Return type:

list of object
sort(key=operator.attrgetter('id'), reverse=False)[source]

Support sorting items in list container in place.

Parameters:
  • key (object, optional) –

    Key to sort items in LIST on.

    Defaults to: operator.attrgetter(“id”).

  • reverse (bool, optional) –

    Reverse the sort mechanism.

    Defaults to: False.
serialize(empty=False, list_attrs=False, exclude_attrs=None, only_attrs=None, wrap_name=True, wrap_item_attr=True)[source]

Serialize this object into a dict.

Parameters:
  • empty (bool, optional) –

    Include attrs that have a value of None when serializing.

    Defaults to: False.

  • list_attrs (bool, optional) –

    Include simple attrs of ApiList when serializing.

    Defaults to: False.

  • exclude_attrs (list of str, optional) –

    Exclude these attrs when serializing.

    Defaults to: None.

  • only_attrs (list of str, optional) –

    Include only these attrs when serializing.

    Defaults to: None.

  • wrap_name (bool, optional) –

    Wrap return in a dict with key of ApiModel.API_NAME and value of return.

    Defaults to: True.

  • wrap_item_attr (bool, optional) –

    Wrap return in a dict with key of ApiList.API_ITEM_ATTR and value of return.

    Only used when serializing items of type ApiList.

    Defaults to: True.

Notes

All child objects will get wrap_name=False.

If wrap_name and wrap_item_attr are both False, return will be list of dict, otherwise return will be a dict.

Returns:list of object or dict

Exceptions for API Models

Exceptions and warnings for pytan3.api_models.

exception pytan3.api_models.exceptions.ModuleError[source]

Bases: pytan3.exceptions.PyTanError

Parent of all exceptions for pytan3.api_models.

Thrown from:

exception pytan3.api_models.exceptions.ModuleWarning[source]

Bases: pytan3.exceptions.PyTanWarning

Parent of all warnings for pytan3.api_models.

Thrown from:

exception pytan3.api_models.exceptions.AttrUndefinedWarning(obj, attr, value)[source]

Bases: pytan3.api_models.exceptions.ModuleWarning

Warning handler for a simple value being set on an undefined attribute.

Thrown from:
__init__(obj, attr, value)[source]

Constructor.

Parameters:
obj = None

pytan3.api_models.ApiModel – Object that warning was thrown from.

attr = None

str – Simple attribute that was adhoc added.

value = None

int or str or bool – Value of attr.

error = None

str – Warning message that was thrown.

exception pytan3.api_models.exceptions.AttrUndefinedError(obj, attr, value)[source]

Bases: pytan3.api_models.exceptions.ModuleError

Exception handler for a complex value being set on an undefined attribute.

Thrown from:
__init__(obj, attr, value)[source]

Constructor.

Parameters:
obj = None

pytan3.api_models.ApiModel – Object that exception was thrown from.

attr = None

str – Complex attribute that was supplied.

value = None

dict or list – Value of attr.

error = None

str – Error message that was thrown.

exception pytan3.api_models.exceptions.AttrTypeError(obj, attr, value, be_type)[source]

Bases: pytan3.api_models.exceptions.ModuleError

Exception handler for type mismatch of a value being set on a defined attribute.

Thrown from:
__init__(obj, attr, value, be_type)[source]

Constructor.

Parameters:
  • obj (pytan3.api_models.ApiModel) – Object that exception was thrown from.
  • attr (str) – Attribute that had a type mismatch.
  • value (object) – Value of attr.
  • be_type (object) – Type that value should be, but is not.
obj = None

pytan3.api_models.ApiModel – Object that exception was thrown from.

attr = None

str – Attribute that had a type mismatch.

value = None

object – Value of attr.

be_type = None

object – Type that value should be, but is not.

error = None

str – Error message that was thrown.

exception pytan3.api_models.exceptions.ListTypeError(obj, attr, value, op)[source]

Bases: pytan3.api_models.exceptions.ModuleError

Exception handler for type mismatch on a list action.

Thrown from:
__init__(obj, attr, value, op)[source]

Constructor.

Parameters:
  • obj (pytan3.api_models.ApiList) – Object that exception was thrown from.
  • attr (str) – Attribute that had a type mismatch.
  • value (object) – Value of attr.
  • op (str) – Operation being performed with type mismatch.
obj = None

pytan3.api_models.ApiList – Object that exception was thrown from.

attr = None

str – Attribute that had a type mismatch.

value = None

object – Value of attr.

op = None

str – Operation being performed with type mismatch.

error = None

str – Error message that was thrown.

exception pytan3.api_models.exceptions.ListItemTypeError(obj, item, items, attr, op, be_type)[source]

Bases: pytan3.api_models.exceptions.ModuleError

Exception handler for type mismatch when adding an item to a list.

Thrown from:
__init__(obj, item, items, attr, op, be_type)[source]

Constructor.

Parameters:
  • obj (pytan3.api_models.ApiList) – Object that exception was thrown from.
  • item (object) – Item being added in items that is the wrong type.
  • items (list) – All items being added to list.
  • attr (str) – Attribute that had a type mismatch.
  • op (str) – Operation being performed with type mismatch.
  • be_type (object) – Type that item should be, but is not.
obj = None

pytan3.api_models.ApiList – Object that exception was thrown from.

item = None

object – Item being added in items that is the wrong type.

items = None

list – Full list of items containing item passed to op.

attr = None

str – Attribute that had a type mismatch.

op = None

str – Operation being performed with type mismatch.

be_type = None

object – Type that item should be, but is not.

error = None

str – Error message that was thrown.

exception pytan3.api_models.exceptions.GetSingleItemError(obj, attr, value, regex_value, items)[source]

Bases: pytan3.api_models.exceptions.ModuleError

Exception handler when no items found.

Thrown from:
__init__(obj, attr, value, regex_value, items)[source]

Constructor.

Parameters:
  • obj (pytan3.api_models.ApiList) – Object that exception was thrown from.
  • attr (str) – Attribute to search for value of in items.
  • value (object) – Value of attr that was being used to match against items.
  • regex_value (bool) – If regex matching was being used for value.
  • items (list) – All items in list object.
obj = None

pytan3.api_models.ApiList – Object that exception was thrown from.

attr = None

str – Attribute used to search for value of in items.

value = None

object – Value of attr that was being used to match against items.

regex_value = None

bool – If regex matching was being used for value.

items = None

list – All items found in list object.

error = None

str – Error message that was thrown.

Adapters

Adapter objects that serialize requests to the Tanium API.

pytan3.adapters.DEFAULT_TYPE = 'soap'

str – Default Adapter type to load in load_type().

pytan3.adapters.DEFAULT_NAME = 'soap'

str – Default Adapter name to load in load().

Abstract Base Class for all Adapters

class pytan3.adapters.Adapter[source]

Bases: object

Abstract base class for all Adapters.

api_objects

Get the API objects container.

Returns:pytan3.api_objects.ApiObjects
api_client

Get the API client.

Returns:pytan3.api_clients.ApiClient
http_client

Get the HTTP client.

Returns:pytan3.http_client.HttpClient
auth_method

Get the Auth Method.

Returns:pytan3.auth_methods.AuthMethod
classmethod get_name()[source]

Get the ref name of this class for use by load().

Returns:str
classmethod get_type()[source]

Get the ref type of this class for use by load_type().

Returns:str
classmethod get_version_req()[source]

Get the min, max, and eq version requirements of this class.

Notes

Dict can specify keys: “vmin”, “vmax”, “veq”.

This class method gets called by pytan3.utils.versions.version_check_obj_req() to perform version checks.

Returns:dict
result_cls

Get the result deserializer class.

Returns:pytan3.results.Result
api_get(obj, **kwargs)[source]

Send an API request to get an object.

Parameters:obj (pytan3.api_models.ApiModel) – API Object to use for request.
Returns:pytan3.results.Result
api_add(obj, **kwargs)[source]

Send an API request to add an object.

Parameters:obj (pytan3.api_models.ApiModel) – API Object to use for request.
Returns:pytan3.results.Result
api_delete(obj, **kwargs)[source]

Send an API request to delete an object.

Parameters:obj (pytan3.api_models.ApiModel) – API Object to use for request.
Returns:pytan3.results.Result
api_update(obj, **kwargs)[source]

Send an API request to update an object.

Parameters:obj (pytan3.api_models.ApiModel) – API Object to use for request.
Returns:pytan3.results.Result
api_get_audit_logs(type, target, **kwargs)[source]

Send an API request to get audit logs for an object.

Parameters:
  • type (str) – Type of object to get audit logs of.
  • target (int) – ID of object type to get audit logs for.
Returns:

pytan3.results.Result
api_get_client_count(**kwargs)[source]

Send an API request to get the client count.

Returns:pytan3.results.Result
api_parse_question(text, **kwargs)[source]

Send an API request to parse text.

Parameters:text (str) – Text to parse into question objects.
Returns:pytan3.results.Result
api_add_parsed_question(obj, **kwargs)[source]

Send an API request to add a parsed question object.

Parameters:obj (pytan3.api_models.ApiModel) – API Object to use for request.
Returns:pytan3.results.Result
api_get_result_info(obj, **kwargs)[source]

Send an API request to get result info for an object.

Parameters:obj (pytan3.api_models.ApiModel) – API Object to use for request.
Returns:pytan3.results.Result
api_get_result_data(obj, **kwargs)[source]

Send an API request to get result data for an object.

Parameters:obj (pytan3.api_models.ApiModel) – API Object to use for request.
Returns:pytan3.results.Result
api_get_merged_result_data(objlist, **kwargs)[source]

Send an API request to get merged result data for a list of objects.

Parameters:objlist (list) – List of API Objects to use for request.
Returns:pytan3.results.Result
_abc_impl = <_abc_data object>

All SOAP API Adapters

Soap Adapter
class pytan3.adapters.Soap(api_client, api_objects, ver_check=True, lvl='info')[source]

Bases: pytan3.adapters.Adapter

Tanium SOAP request adapter.

DEFAULT_OPTIONS = {'include_hashes_flag': True, 'json_pretty_print': True}

dict – Default options to use in build_options_from_kwargs().

AUDIT_LOG_TYPES = ['authentication', 'content_set', 'content_set_role', 'content_set_role_privilege', 'dashboard', 'dashboard_group', 'group', 'package_spec', 'plugin_schedule', 'saved_action', 'saved_question', 'sensor', 'system_setting', 'user', 'user_group', 'white_listed_url']

list of str – Valid types for api_get_audit_logs().

__init__(api_client, api_objects, ver_check=True, lvl='info')[source]

Constructor.

Parameters:
log = None

logging.Logger – Log.

__str__()[source]

Show object info.

Returns:str
__repr__()[source]

Show object info.

Returns:str
api_objects

Get the API objects container.

Returns:pytan3.api_objects.ApiObjects
api_client

Get the API client.

Returns:pytan3.api_clients.ApiClient
http_client

Get the HTTP client.

Returns:pytan3.http_client.HttpClient
auth_method

Get the Auth Method.

Returns:pytan3.auth_methods.AuthMethod
classmethod get_name()[source]

Get the ref name of this class for use by load().

Returns:str
classmethod get_type()[source]

Get the ref type of this class for use by load_type().

Returns:str
classmethod get_version_req()[source]

Get the min, max, and eq version requirements of this class.

Notes

Dict can specify keys: “vmin”, “vmax”, “veq”.

This class method gets called by pytan3.utils.versions.version_check_obj_req() to perform version checks.

Returns:dict
result_cls

Get the result deserializer class.

Returns:pytan3.results.Result
build_options_from_kwargs(**kwargs)[source]

Build an Options API object from kwargs and return the serialized form.

Parameters:**kwargs –
options_obj (pytan3.api_models.ApiItem):
A pre-established Options object.

Defaults to: new Options object from api_objects.

rest of kwargs:
Set on Options object if key is an attr on object and attrs value is None.

Notes

Will set DEFAULT_OPTIONS as defaults to kwargs before applying values to Options object attributes.

Returns:dict
send(obj, cmd, **kwargs)[source]

Build and send a SOAP API request.

Parameters:
  • obj (pytan3.api_models.ApiModel) – ApiModel to serialize and send as part of request.
  • cmd (str) – SOAP Command to use in request.
  • **kwargs –
    body_re_limit (int):
    Value to limit regex search of response body for <session> tag.

    Defaults to: 4000.

    empty (bool):
    Include attributes that have a value of None when serializing.

    Defaults to: False

    list_attrs (bool):
    Include simple attributes of pytan3.api_models.ApiList when serializing.

    Defaults to: False.

    exclude_attrs (list of str):
    Exclude these attributes when serializing.

    Defaults to: [].

    only_attrs (list of str):
    Include only these attributes when serializing.

    Defaults to: [].

    wrap_name (bool):
    Wrap the return in another dict whose key is set to the API name.

    Defaults to: True.

    wrap_item_attr (bool):
    Wrap list items in dict whose key is set to the API list item attribute.

    Defaults to: True.

    rest of kwargs:
    Passed to build_options_from_kwargs().
Raises:

exceptions.SessionNotFoundWarning – If the <session> tag can not be found in the response body.
Returns:

pytan3.results.Result
api_get(obj, **kwargs)[source]

Send an API request to get an object.

Parameters:
Returns:

pytan3.results.Result
api_add(obj, **kwargs)[source]

Send an API request to add an object.

Parameters:
Returns:

pytan3.results.Result
api_delete(obj, **kwargs)[source]

Send an API request to delete an object.

Parameters:
Returns:

pytan3.results.Result
api_update(obj, **kwargs)[source]

Send an API request to update an object.

Parameters:
Returns:

pytan3.results.Result
api_get_audit_logs(type, target, **kwargs)[source]

Send an API request to get audit logs for an object.

Parameters:
  • type (str) – Type of object to get audit logs of.
  • target (int) – ID of object type to get audit logs for. SOAP allows target of ‘None’ to get all objects of type.
  • **kwargs –
    count (int):
    Limit number of audit logs returned to this.

    Defaults to: 1.

    rest of kwargs:
    Passed to send().
Raises:

exceptions.InvalidTypeError – If type is not one of AUDIT_LOG_TYPES.
Returns:

pytan3.results.Result
api_get_client_count(**kwargs)[source]

Send an API request to get the client count.

Parameters:**kwargs –
count (int):
Number of days to get client count for.

Defaults to: 30.

rest of kwargs:
Passed to send().
Returns:pytan3.results.Result
api_parse_question(text, **kwargs)[source]

Send an API request to parse text.

Parameters:
  • text (str) – Text to parse into question objects.
  • **kwargs –
    rest of kwargs:
    Passed to send().
Returns:

pytan3.results.Result
api_add_parsed_question(obj, **kwargs)[source]

Send an API request to add a parsed question object.

Parameters:
  • obj (pytan3.api_models.ApiModel) – API Object to use for request.
  • **kwargs –
    for_merge (bool):
    Value for force_computer_id_flag attr on question object.

    Defaults to: True.

    rest of kwargs:
    Passed to send().
Returns:

pytan3.results.Result
api_get_result_info(obj, **kwargs)[source]

Send an API request to get result info for an object.

Parameters:
Returns:

pytan3.results.Result
api_get_result_data(obj, **kwargs)[source]

Send an API request to get result data for an object.

Parameters:
Returns:

pytan3.results.Result
api_get_merged_result_data(objlist, **kwargs)[source]

Send an API request to get merged result data for a list of objects.

Parameters:
  • objlist (list) – List of API Objects to use for request.
  • **kwargs –
    rest of kwargs:
    Passed to send().
Returns:

pytan3.results.Result
_abc_impl = <_abc_data object>

All REST API Adapters

Rest Adapter
class pytan3.adapters.Rest(api_client, api_objects, ver_check=True, lvl='info')[source]

Bases: pytan3.adapters.Adapter

Tanium REST API request adapter.

DEFAULT_OPTIONS = {'include_hashes_flag': True, 'json_pretty_print': True}

dict – Default options to use in build_options_from_kwargs().

AUDIT_LOG_TYPES = ['content_set', 'content_set_role', 'dashboard', 'dashboard_group', 'group', 'package', 'plugin_schedule', 'saved_action', 'saved_question', 'sensor', 'system_setting', 'user', 'user_group', 'white_listed_url']

list of str – Valid types for api_get_audit_logs().

__init__(api_client, api_objects, ver_check=True, lvl='info')[source]

Constructor.

Parameters:
log = None

logging.Logger – Log.

__str__()[source]

Show object info.

Returns:str
__repr__()[source]

Show object info.

Returns:str
api_objects

Get the API objects container.

Returns:pytan3.api_objects.ApiObjects
api_client

Get the API client.

Returns:pytan3.api_clients.ApiClient
http_client

Get the HTTP client.

Returns:pytan3.http_client.HttpClient
auth_method

Get the Auth Method.

Returns:pytan3.auth_methods.AuthMethod
classmethod get_name()[source]

Get the ref name of this class for use by load().

Returns:str
classmethod get_type()[source]

Get the ref type of this class for use by load_type().

Returns:str
classmethod get_version_req()[source]

Get the min, max, and eq version requirements of this class.

Notes

Dict can specify keys: “vmin”, “vmax”, “veq”.

This class method gets called by pytan3.utils.versions.version_check_obj_req() to perform version checks.

Returns:dict
result_cls

Get the result deserializer class.

Returns:pytan3.results.Result
build_options_from_kwargs(**kwargs)[source]

Build an Options API object from kwargs and return the serialized form.

Parameters:**kwargs –
options_obj (pytan3.api_models.ApiItem):
A pre-established Options object.

Defaults to: new Options object from api_objects.

rest of kwargs:
Set on Options object if key is an attr on object and attrs value is None.

Notes

Will set DEFAULT_OPTIONS as defaults to kwargs before applying values to Options object attributes.

Returns:dict
api_get(obj, **kwargs)[source]

Send an API request to get an object.

Parameters:
Returns:

pytan3.results.Result
api_add(obj, **kwargs)[source]

Send an API request to add an object.

Parameters:
Returns:

pytan3.results.Result
api_delete(obj, **kwargs)[source]

Send an API request to delete an object.

Parameters:
Returns:

pytan3.results.Result
api_update(obj, **kwargs)[source]

Send an API request to update an object.

Parameters:
Returns:

pytan3.results.Result
api_get_audit_logs(type, target, **kwargs)[source]

Send an API request to get audit logs for an object.

Parameters:
  • type (str) – Type of object to get audit logs of.
  • target (int) – ID of object type to get audit logs for.
  • **kwargs –
    count (int):
    Limit number of audit logs returned to this.

    Defaults to: 1.

    headers (dict):
    Headers to supply to request.

    Defaults to: {}.

    params (dict):
    Parameters to supply to request.

    Defaults to: {}.

    rest of kwargs:
    Passed to build_options_from_kwargs().
Raises:

exceptions.InvalidTypeError – If type is not one of AUDIT_LOG_TYPES.
Returns:

pytan3.results.Result
api_parse_question(text, **kwargs)[source]

Send an API request to parse text.

Parameters:
  • text (str) – Text to parse into question objects.
  • **kwargs –
    headers (dict):
    Headers to supply to request.

    Defaults to: {}.

    params (dict):
    Parameters to supply to request.

    Defaults to: {}.

    rest of kwargs:
    Passed to build_options_from_kwargs().
Returns:

pytan3.results.Result
api_get_client_count(**kwargs)[source]

Send an API request to get the client count.

Parameters:**kwargs –
headers (dict):
Headers to supply to request.

Defaults to: {}.

params (dict):
Parameters to supply to request.

Defaults to: {}.

rest of kwargs:
Passed to build_options_from_kwargs().

Notes

Unlike the SOAP API, “count” does not seem to be used by REST API.

Returns:pytan3.results.Result
api_add_parsed_question(obj, **kwargs)[source]

Send an API request to add a parsed question object.

Parameters:
  • obj (pytan3.api_models.ApiModel) – API Object to use for request.
  • **kwargs –
    for_merge (bool):
    Set option “force_computer_id_flag”.

    Defaults to: True.

    headers (dict):
    Headers to supply to request.

    Defaults to: {}.

    params (dict):
    Parameters to supply to request.

    Defaults to: {}.

    rest of kwargs:
    Passed to build_options_from_kwargs().
Returns:

pytan3.results.Result
api_get_result_info(obj, **kwargs)[source]

Send an API request to get result info for an object.

Parameters:
Returns:

pytan3.results.Result
api_get_result_data(obj, **kwargs)[source]

Send an API request to get result data for an object.

Parameters:
Returns:

pytan3.results.Result
api_get_merged_result_data(objlist, **kwargs)[source]

Send an API request to get merged result data for a list of objects.

Parameters:
  • objlist (list) – List of API Objects to use for request.
  • **kwargs –
    headers (dict):
    Headers to supply to request.

    Defaults to: {}.

    params (dict):
    Parameters to supply to request.

    Defaults to: {}.

    rest of kwargs:
    Passed to build_options_from_kwargs().
Returns:

pytan3.results.Result
_abc_impl = <_abc_data object>

Loaders for all Adapters

pytan3.adapters.load_type(obj='soap')[source]

Get a Adapter by type from Adapter.get_type().

Parameters:obj (str, optional) –

Type of Adapter.

Defaults to: DEFAULT_TYPE.
Raises:exceptions.ModuleError – Unable to find a valid Adapter with the supplied type.
Returns:Adapter
pytan3.adapters.load(obj='soap')[source]

Get a Adapter by name from Adapter.get_name().

Parameters:obj (str or Adapter or Adapter, optional) –

Adapter object, class, or name Adapter.

Defaults to: DEFAULT_NAME.
Raises:exceptions.ModuleError – Unable to find a valid Adapter with the supplied name.
Returns:Adapter

Utilities for all Adapters

pytan3.adapters.check_adapter_types(adapter)[source]

Check Adapter.get_type() against api_client and objects type.

Parameters:adapter (Adapter) – Adapter to perform type checking on.
Raises:exceptions.TypeMismatchError – If Adapter.get_type() is not equal to pytan3.api_objects.ApiObjects.module_type or pytan3.api_clients.ApiClient.get_type().
pytan3.adapters.check_adapter_version(adapter)[source]

Check Adapter.get_version_req() against api_client and objects version.

Parameters:adapter (Adapter) – Adapter to perform version checking on.
Raises:pytan3.utils.exceptions.VersionMismatchError – If the version requirements from Adapter.get_version_req() fail to match pytan3.api_clients.ApiClient.version or pytan3.api_objects.ApiObjects.module_version.
pytan3.adapters.check_object_attrs(obj, attrs)[source]

Check if any attributes of an obj are set.

Parameters:
Raises:

exceptions.EmptyAttributeError – If none of the attributes in attrs on obj are not set to None.
pytan3.adapters.check_object_type(obj, types)[source]

Check if an obj is an instance of types.

Parameters:
  • obj (object) – Object to check against types.
  • types (tuple of type) – Types to check against obj.
Raises:

exceptions.InvalidTypeError – If type of obj is not on of types.

Utilities for SOAP API Adapters

pytan3.adapters.soap_envelope(cmd, obj, opts=None)[source]

Construct a SOAP envelope with the request command, obj, and options.

Parameters:
  • cmd (str) – Command to use for request.
  • obj (dict) – Object(s) to use for request.
  • options (dict, optional) –

    Options to use for request.

    Defaults to: None.
Returns:

dict
pytan3.adapters.re_soap_tag(text, tag, limit=4000, pattern='<{t}>(.*?)</{t}>')[source]

Search for tag in text[:limit] using pattern.

Parameters:
  • text (str) – Text to search for pattern.
  • tag (str) – Tag name to use in pattern as ‘t’.
  • limit (int, optional) –

    Length to limit text to when searching for pattern.

    Defaults to: 4000.

  • pattern (str, optional) –

    Pattern to use when searching for tag.

    Defaults to: r’<{e}>(.*?)</{e}>’

Notes

Given text is 4 GB and pattern is expected at top of text:
  • if head is None and pattern not found: 131 seconds
  • if head is None and pattern found: 0 seconds
  • if head is 4000 and pattern not found: 0 seconds
  • if head is 4000 and pattern found: 0 seconds
Returns:str
pytan3.adapters.serialize_xml(obj, **kwargs)[source]

Encode python object into an XML string.

Parameters:
  • obj (object) – Python object to encode into a string.
  • **kwargs –
    full_document (bool):
    Include xml stanza at top.

    Defaults to: True.

    pretty (bool):
    Indent the output doc.

    Defaults to: True.

    rest of kwargs:
    Passed to xmltodict.unparse.
Returns:

str

Utilities for REST API Adapters

pytan3.adapters.magic_endpoint(obj, target=None, auto_target=True, needs_target=False)[source]

Build a REST API endpoint from an API object.

Parameters:
  • obj (pytan3.api_models.ApiModel) – API object to get route and target from in order to build endpoint.
  • target (str, optional) –

    Manually provided target.

    Defaults to: None.

  • auto_target (bool, optional) –

    Try to identify the target from obj by getting “id” or “name” attributes if their values are not None.

    Defaults to: True.

  • needs_target (bool, optional) –

    Throw an exception if a target is not automatically determined from obj.

    Defaults to: False.
Raises:

exceptions.ModuleError – If needs_target is True and resolved target is None.
Returns:

str
pytan3.adapters.build_endpoint(route, target=None)[source]

Build a REST endpoint string by joining route and target.

Parameters:
  • route (str) – Route part of endpoint.
  • target (str, optional) –

    Target part of endpoint.

    Defaults to None.
Returns:

str
pytan3.adapters.serialize_json(obj, **kwargs)[source]

Encode python object into a JSON string.

Parameters:
  • obj (object) – Python object to encode into a string.
  • **kwargs –
    indent (int):
    Indent spacing for prettifying.

    Defaults to: 2.

    rest of kwargs:
    Passed to json.dumps().
Returns:

str

Exceptions for all Adapters

Exceptions and warnings for pytan3.adapters.

exception pytan3.adapters.exceptions.ModuleError[source]

Bases: pytan3.exceptions.PyTanError

Parent of all exceptions for pytan3.adapters.

Thrown by:
exception pytan3.adapters.exceptions.ModuleWarning[source]

Bases: pytan3.exceptions.PyTanWarning

Parent of all warnings for pytan3.adapters.

Thrown by:

exception pytan3.adapters.exceptions.InvalidTypeError[source]

Bases: pytan3.adapters.exceptions.ModuleError

Thrown when an object of an invalid type is supplied.

Thrown by:
exception pytan3.adapters.exceptions.EmptyAttributeError[source]

Bases: pytan3.adapters.exceptions.ModuleError

Thrown when an object is supplied that does not have required attributes set.

Thrown by:
exception pytan3.adapters.exceptions.TypeMismatchError[source]

Bases: pytan3.adapters.exceptions.ModuleError

Thrown when an API module type does not match an adapters type.

Thrown by:
exception pytan3.adapters.exceptions.SessionNotFoundWarning[source]

Bases: pytan3.adapters.exceptions.ModuleWarning

Thrown when a session XML tag can not be found in a response body.

Thrown by:

Results

Result objects that deserialize responses from Tanium API.

Results Abstract Base Class

class pytan3.results.Result[source]

Bases: object

Deserialize API responses from Tanium API.

classmethod from_response(api_objects, response, lvl='info')[source]

Create Result from requests.Response.

Parameters:
Returns:

Result
error_check()[source]

Check for errors in response_body_str.

Raises:
error_text

Get the error text from response_body_str.

Returns:str
api_objects()[source]

Get the API objects container.

Returns:pytan3.api_objects.ApiObjects
url()[source]

Get the URL used in request.

Returns:str
status_code

Get the status code received in response.

Returns:int
method

Get the method used in request.

Returns:str
request_body_str

Get the full request body.

Returns:str
request_body_obj

Get request_body_str deserialized into a python object.

Returns:object
request_object_obj

Get the request objects from request_body_obj.

Returns:dict
response_body_str

Get the full response body.

Returns:str
response_body_obj

Get response_body_str deserialized into a python object.

Returns:object
data_obj

Get the response data from response_body_obj.

Returns:object
data_api(**kwargs)[source]

Get data_obj deserialized into an ApiModel object.

Returns:pytan3.api_models.ApiModel
object_obj

Get the response objects from response_body_obj.

Returns:dict
object_api(**kwargs)[source]

Get object_obj deserialized into an ApiModel object.

Returns:pytan3.api_models.ApiModel
str_to_obj(text, src, **kwargs)[source]

Deserialize string into a python object.

Parameters:
  • text (str) – String to decode into python object
  • src (str) – Where text came from, used in error text.
Raises:

exceptions.TextDeserializeError
Returns:

object
obj_to_api(obj, src)[source]

Deserialize a python object into pytan3.api_models.ApiModel.

Parameters:
  • obj (object) – Python object to deserialize into a PyTan API object.
  • src (str) – Where obj came from, used in error text.
Returns:

pytan3.api_models.ApiModel
_abc_impl = <_abc_data object>

Results Common Mixins

class pytan3.results.CommonMixin(api_objects, response_body, request_body, method, url, status_code, origin=None, lvl='info')[source]

Bases: object

Shared methods common amongst all Result.

__init__(api_objects, response_body, request_body, method, url, status_code, origin=None, lvl='info')[source]

Constructor.

Parameters:
  • api_objects (pytan3.api_objects.ApiObjects) – API Objects Container to use.
  • response_body (str) – Response body received from Tanium API.
  • request_body (str) – Request body sent to Tanium API.
  • method (str) – HTTP method used in request to Tanium API.
  • url (str) – URL used in request to Tanium API.
  • status_code (int) – Status code in response from Tanium API.
  • origin (requests.Response, optional) –

    Original response object received from Tanium API request.

    Defaults to: None.

  • lvl (str, optional) –

    Logging level.

    Defaults to: “info”.
log = None

logging.Logger – Log for this object.

origin = None

requests.Response – Original response object.

__str__()[source]

Show object info.

Returns:str
__repr__()[source]

Show object info.

Returns:str
classmethod from_response(api_objects, response, lvl='info')[source]

Create Result from a requests response object.

Parameters:
Returns:

Result
api_objects

Get the API objects container.

Returns:pytan3.api_objects.ApiObjects
url

Get the URL used in request.

Returns:str
status_code

Get the status code received in response.

Returns:int
method

Get the method used in request.

Returns:str
request_body_str

Get the full request body.

Returns:str
response_body_str

Get the full response body.

Returns:str
obj_to_api(api_name, obj, src)[source]

Deserialize a python object into pytan3.api_models.ApiModel.

Parameters:
  • api_name (str) – API name of obj.
  • obj (object) – Python object to deserialize into a PyTan API object.
  • src (str) – Where obj came from, used in error text.
Returns:

pytan3.api_models.ApiModel
get_dict_path(obj, path, src)[source]

Traverse a dict using a / seperated string.

Parameters:
  • obj (dict) – Dictionary to traverse using path.
  • path (str) – Nested dictionary keys seperated by / to traverse in obj.
  • src (str) – Where obj came from, used in error text.
Raises:

exceptions.DictionaryPathError – If any error occurs while traversing path in obj.
Returns:

object

Results for SOAP API

Soap Result
class pytan3.results.Soap(api_objects, response_body, request_body, method, url, status_code, origin=None, lvl='info')[source]

Bases: pytan3.results.CommonMixin, pytan3.results.Result

Deserialize SOAP API responses from Tanium API.

DATA_ROUTES = ['GetResultInfo', 'GetResultData', 'GetMergedResultData']
__call__(raw=False, **kwargs)[source]

Get data_api or object_api.

Parameters:
  • raw (bool, optional) –

    Return the serialized object instead of the object deserialized into an ApiModel.

    Defaults to: False.

  • **kwargs –
    rest of kwargs:
    passed to object_api() or data_api().

Notes

Will return object_api() or data_api() by determining if command_request is an object or data request.

Returns:pytan3.api_models.ApiModel or object
error_map

Map of status codes to regex patterns and exceptions.

Notes

Keys should be int of a status code to check patterns of.

Values should be list of [pattern, exc], where pattern is a regex pattern to search response body, and exc is exception to throw if pattern match is found.

Raises:
Returns:

dict
error_check()[source]

Check for errors in CommonMixin.response_body_str.

Raises:
error_check_response()[source]

Check Soap.command_response for errors.

Notes

For each key value pair in error_map, if key matches CommonMixin.status_code or key is None, the patterns in value are checked against response body, and if matched the patterns associated exception is thrown.

error_check_code()[source]

Check if CommonMixin.status_code is one of valid_codes.

Raises:exceptions.ResponseError
valid_codes

List of valid status codes.

Returns:list of int
error_text

Get the error text from CommonMixin.response_body_str.

Returns:str
command_request

Get the “command” element from request_body_obj.

Returns:str
command_response

Get the “command” element from response_body_obj.

Returns:str
request_body_obj

Deserialize CommonMixin.request_body_str into a python object.

Returns:dict
request_object_obj

Get the request objects from request_body_obj.

Returns:dict
response_body_obj

Get CommonMixin.response_body_str deserialized into a python object.

Returns:dict
data_xml

Get the “ResultXML” element from response_body_obj.

Returns:str
data_obj

Get the response data from data_xml.

Returns:object
data_api(**kwargs)[source]

Get data_obj deserialized into an ApiModel object.

Parameters:**kwargs –
rest of kwargs:
passed to CommonMixin.obj_to_api()
Returns:pytan3.api_models.ApiModel
object_obj

Get the response objects from response_body_obj.

Returns:dict
object_api(**kwargs)[source]

Get object_obj deserialized into an ApiModel object.

Parameters:**kwargs –
rest of kwargs:
passed to CommonMixin.obj_to_api()
Returns:pytan3.api_models.ApiModel
str_to_obj(text, src, use_dict=True, try_int=True, flat_attrs=True, **kwargs)[source]

Deserialize string into a python object.

Parameters:
  • text (str) – String to decode into python object
  • src (str) – Where text came from, used in error text.
  • use_dict (bool) –

    Use dict instead of collections.OrderedDict when deserializing.

    Defaults to: True.

  • try_int (bool) –

    Try to convert str into int when deserializing.

    Defaults to: True.

  • flat_attrs (bool) –

    Make attr_prefix “” and cdata_key “text”.

    Defaults to: True.

  • **kwargs –
    rest of kwargs:
    Passed to xmltodict.parse.
Raises:

exceptions.TextDeserializeError – If an exception is thrown from xmltodict.parse.
Returns:

dict
_abc_impl = <_abc_data object>

Results for REST API

Rest Result
class pytan3.results.Rest(api_objects, response_body, request_body, method, url, status_code, origin=None, lvl='info')[source]

Bases: pytan3.results.CommonMixin, pytan3.results.Result

Deserialize REST API responses from Tanium API.

MANUAL_OBJECT_ROUTES = {'audit_logs': 'audit_logs', 'parse_question': 'parse_question_results'}

dict – Manual route defs for object_api().

DATA_ROUTES = {'merged_result_data': 'merged_result_set', 'result_data': 'result_sets', 'result_info': 'result_infos'}

dict – Manual route defs for data_api().

__call__(raw=False, **kwargs)[source]

Get data_api or object_api.

Parameters:
  • raw (bool, optional) –

    Return the serialized object instead of the object deserialized into an ApiModel.

    Defaults to: False.

  • **kwargs –
    rest of kwargs:
    passed to object_api() or data_api().

Notes

Will return object_api() or data_api() by determining if RestUrlPath.route is an object or data request.

Returns:pytan3.api_models.ApiModel or object
error_map

Map of status codes to regex patterns and exceptions.

Notes

Keys should be int of a status code to check patterns of.

Values should be list of [pattern, exc], where pattern is a regex pattern to search response body, and exc is exception to throw if pattern match is found.

Raises:
Returns:

dict
error_check()[source]

Check for errors in CommonMixin.response_body_str.

Raises:
error_check_response()[source]

Check CommonMixin.response_body_str for errors.

Notes

For each key value pair in error_map, if key matches CommonMixin.status_code or key is None, the patterns in value are checked against response body, and if matched the patterns associated exception is thrown.

error_check_code()[source]

Check if CommonMixin.status_code is one of valid_codes.

Raises:exceptions.ResponseError
valid_codes

List of valid status codes.

Returns:list of int
error_text

Get the error text from CommonMixin.response_body_str.

Returns:str
url_path

Parse CommonMixin.url using RestUrlPath.

Returns:(RestUrlPath)
request_body_obj

Deserialize CommonMixin.request_body_str into a python object.

Returns:dict
request_object_obj

Get the request objects from request_body_obj.

Returns:dict
response_body_obj

Get CommonMixin.response_body_str deserialized into a python object.

Returns:dict
data_obj

Get the response data from response_body_obj.

Returns:dict
data_api(**kwargs)[source]

Get data_obj deserialized into an ApiModel object.

Parameters:**kwargs –
rest of kwargs:
passed to CommonMixin.obj_to_api()
Returns:pytan3.api_models.ApiModel
object_obj

Get the response objects from response_body_obj.

Returns:dict
object_api(**kwargs)[source]

Get object_obj deserialized into an ApiModel object.

Parameters:**kwargs –
rest of kwargs:
passed to CommonMixin.obj_to_api()
Returns:pytan3.api_models.ApiModel
str_to_obj(text, src, **kwargs)[source]

Deserialize string into a python object.

Parameters:
  • text (str) – String to decode into python object
  • src (str) – Where text came from, used in error text.
  • **kwargs –
    rest of kwargs:
    Passed to json.loads().
Raises:

exceptions.TextDeserializeError – If an exception is thrown from json.loads().
Returns:

object
_abc_impl = <_abc_data object>

Utilities for SOAP API Results

pytan3.results.try_int_xml(path, key, value)[source]

Parser hook for xmltodict.parse to try to convert str to int.

Parameters:
  • path (list) – Path from root of document to key.
  • key (str) – Element name being parsed.
  • value (object) – Element value of key being parsed.
Returns:

original key supplied and value as int if successfully converted.
Return type:

(str, object)

Utilities for REST API Results

class pytan3.results.RestUrlPath(url)[source]

Bases: object

Parser to get path parts from a REST API URL.

__init__(url)[source]

Constructor.

Parameters:url (str) – URL to parse.
Raises:exceptions.ModuleError – If version and route can not be parsed from path_parts.
url_original = None

str – Original URL supplied.

url = None

str – Percent decoded version of url_original.

url_path = None

urllib.parse.ParseResult – Parsed version of url.

path_parts = None

list of str – Parts of URL split on /.

version = None

int – REST API version from path_parts.

route = None

str – REST API route from path_parts.

by_name = None

bool – If target is doing targeting by name or by id.

target = None

str – If found, target supplied for route in url.

__str__()[source]

Show object info.

Returns:str
__repr__()[source]

Show object info.

Returns:str

Exceptions for Results

Exceptions and warnings for pytan3.results.

exception pytan3.results.exceptions.ModuleError[source]

Bases: pytan3.exceptions.PyTanError

Parent of all exceptions for pytan3.results.

Thrown by:
exception pytan3.results.exceptions.ModuleWarning[source]

Bases: pytan3.exceptions.PyTanWarning

Parent of all warnings for pytan3.results.

Thrown by:

exception pytan3.results.exceptions.ResponseError(result, error)[source]

Bases: pytan3.results.exceptions.ModuleError

Thrown when a response has an general/uncategorized error.

Thrown by:
__init__(result, error)[source]

Constructor.

Parameters:
result = None

pytan3.results.Result – Object exception was thrown from.

response_body = None

str – Trimmed response body.

request_object_obj = None

object – Pretty printed objects from request.

error = None

str – Error message that was thrown.

exception pytan3.results.exceptions.ObjectExistsError(result, error)[source]

Bases: pytan3.results.exceptions.ResponseError

Thrown when a response tells us the object already exists.

Thrown by:
exception pytan3.results.exceptions.ObjectNotFoundError(result, error)[source]

Bases: pytan3.results.exceptions.ResponseError

Thrown when a response tells us the object already exists.

Thrown by:
exception pytan3.results.exceptions.TextDeserializeError(result, text, src, exc)[source]

Bases: pytan3.results.exceptions.ModuleError

Thrown when deserializing a string into python object.

Thrown by:
__init__(result, text, src, exc)[source]

Constructor.

Parameters:
  • result (pytan3.results.Result) – Object exception was thrown from.
  • text (str) – Text that was being deserialized into python object.
  • src (str) – Description of where text came from.
  • exc (Exception) – Exception that occurred during deserialization.
result = None

pytan3.results.Result – Object exception was thrown from.

text = None

str – Text that was being deserialized into python object.

src = None

str – Description of where text came from.

exc = None

Exception – Exception that occurred during deserialization.

error = None

str – Error message that was thrown.

exception pytan3.results.exceptions.ApiWrongRequestType(result, error)[source]

Bases: pytan3.results.exceptions.ModuleError

Thrown when get result data/object API obj but request is not of that type.

Thrown by:
__init__(result, error)[source]

Constructor.

Parameters:result (pytan3.results.Result) – Object exception was thrown from.
result = None

pytan3.results.Result – Object exception was thrown from.

error = None

str – Error message that was thrown.

exception pytan3.results.exceptions.DictionaryPathError(result, obj, path, src, exc)[source]

Bases: pytan3.results.exceptions.ModuleError

Thrown when a response has an error when deserializing.

Thrown by:
__init__(result, obj, path, src, exc)[source]

Constructor.

Parameters:
  • result (pytan3.results.Result) – Object exception was thrown from.
  • obj (dict) – Dictionary to traverse using path.
  • path (str) – Nested dictionary keys seperated by / to traverse in obj.
  • src (str) – Where obj came from, used in error text.
  • exc (Exception) – Original exception thrown.
result = None

pytan3.results.Result – Object exception was thrown from.

obj = None

dict – Dictionary to traverse using path.

path = None

str – Nested dictionary keys seperated by / to traverse in obj.

src = None

str – Where obj came from.

exc = None

Exception – Original exception thrown.

error = None

str – Error message that was thrown.

Utilities

PyTan utilities module.

Crypt Utilities

PyTan encryption/decryption utilities module.

pytan3.utils.crypt.encrypt(data, key)[source]

Encrypt data with key using privy.

Parameters:
  • data (str) – Data to encrypt with key.
  • key (str) – Key to encrypt data with.
Returns:

str
pytan3.utils.crypt.decrypt(data, key)[source]

Decrypt data with key using privy.

Parameters:
  • data (str) – Data to decrypt with key.
  • key (str) – Key data was encrypted with.
Raises:

pytan3.utils.exceptions.ModuleError – On ValueError from privy when decryption fails.
Returns:

str

Logging Utilities

PyTan logging module.

pytan3.utils.logs.LOG = <Logger pytan3 (DEBUG)>

logging.Logger – Package logger.

pytan3.utils.logs.LOG_FILE = 'pytan3.log'

str – Log filename for add_file() and remove_file().

pytan3.utils.logs.LOG_CON_FMT = '%(levelname)-8s [%(name)s:%(funcName)s()] %(message)s'

str – Logging format for add_stderr() and add_stdout().

pytan3.utils.logs.LOG_PATH_FMT = '[%(asctime)s] PID:%(process)s %(levelname)-8s [%(name)s:%(funcName)s()] %(message)s'

str – Logging format for add_file().

pytan3.utils.logs.LVL_DICT = {'CRITICAL': 50, 'DEBUG': 10, 'ERROR': 40, 'FATAL': 50, 'INFO': 20, 'NOTSET': 0, 'WARN': 30, 'WARNING': 30}

dict – Logging level names to ints, python version dependent.

pytan3.utils.logs.LVL_STR = 'CRITICAL, FATAL, ERROR, WARN, WARNING, INFO, DEBUG, NOTSET, OFF'

str – CSV str of logging level names.

pytan3.utils.logs.is_enabled(lvl='debug', obj=<Logger pytan3 (DEBUG)>)[source]

Determine if a logger or handler is enabled for a log level.

Parameters:
  • lvl (str or int, optional) –

    Level to check if obj is enabled for.

    Defaults to: “debug”.

  • obj (logging.Logger or logging.Handler, optional) –

    Object to check if enabled for lvl.

    Defaults to: LOG.
Returns:

bool
pytan3.utils.logs.is_disabled(obj=<Logger pytan3 (DEBUG)>)[source]

Determine if a logger or handler is disabled.

Parameters:obj (logging.Logger or logging.Handler, optional) –

Object to check if disabled.

Defaults to: LOG.

Notes

Will traverse up the logger tree to see if any parents are disabled.

Returns:bool
pytan3.utils.logs.enable_capture_exc()[source]

Enable the exception hook to capture exceptions to the logging system.

pytan3.utils.logs.disable_capture_exc()[source]

Disable the exception hook to capture exceptions to the logging system.

pytan3.utils.logs.enable_capture_warn()[source]

Enable the warning hook to capture warnings to the logging system.

pytan3.utils.logs.disable_capture_warn()[source]

Disable the warning hook to capture warnings to the logging system.

pytan3.utils.logs.enable_format_warning()[source]

Replace warnings.formatwarning() with customformatwarning().

pytan3.utils.logs.disable_format_warning()[source]

Restore warnings.formatwarning() to the default.

pytan3.utils.logs.use_gmt()[source]

Set the logging system to use GMT for time strings.

pytan3.utils.logs.use_localtime()[source]

Set the logging system to use local time for time strings.

pytan3.utils.logs.exception_hook(type, value, tb)[source]

Exception hook to send exceptions to the logging system.

Notes

If the package logger has no logging output at “error” level, the default excepthook will be used to print the exception to STDERR.

pytan3.utils.logs.warning_hook(message, category, filename, lineno, file=None, line=None)[source]

Warning hook to send warnings to the logging system.

Notes

If the package logger has no logging output at “warning” level, the default warning will be used to print the warning to STDERR.

pytan3.utils.logs.customformatwarning(message, category, filename, lineno, file=None, line=None)[source]

Return a custom warning format.

pytan3.utils.logs.set_level(lvl='info', obj=<Logger pytan3 (DEBUG)>)[source]

Set a logger or handler to a log level.

Parameters:

Notes

If lvl is “OFF” the disabled attr on obj will be set to True.

Returns:bool
pytan3.utils.logs.get_obj_log(obj, lvl='debug')[source]

Get a logger object for an object.

Parameters:
  • obj (object) – Object to get a logger for using the objects class module and name.
  • lvl (str or int, optional) –

    Level to set logger created for obj to initially.

    Defaults to: “debug”.
Returns:

logging.Logger
pytan3.utils.logs.get_log(name, lvl='debug')[source]

Get a logger object.

Parameters:
  • name (str) – Path of logger to get/create.
  • lvl (str or int, optional) –

    Level to set logger created using name initially.

    Defaults to: “debug”.
Returns:

logging.Logger
pytan3.utils.logs.level_name(lvl)[source]

Get a logging level in str format.

Parameters:lvl (str or int) – Level to get str format of.
Raises:pytan3.utils.exceptions.ModuleError – If int is not in values of LVL_DICT or if str is not in keys of LVL_DICT.
Returns:str
pytan3.utils.logs.level_int(lvl)[source]

Get a logging level in int format.

Parameters:lvl (str or int) – Level to get int format of.
Raises:pytan3.utils.exceptions.ModuleError – If int is not in values of LVL_DICT or if str is not in keys of LVL_DICT.
Returns:int
pytan3.utils.logs.log_str(obj)[source]

Get a str format of a logger object showing level and attached handlers.

Parameters:obj (logging.Logger) – Logger object to get str format of.
Returns:str
pytan3.utils.logs.handler_str(obj)[source]

Get a str format of a handler object showing level.

Parameters:obj (logging.Handler) – Handler object to get str format of.
Returns:str
pytan3.utils.logs.add_stdout(lvl='info', fmt='%(levelname)-8s [%(name)s:%(funcName)s()] %(message)s', obj=<Logger pytan3 (DEBUG)>)[source]

Add a STDOUT handler to a logger object.

Parameters:
  • lvl (str or int, optional) –

    Level to set on handler.

    Defaults to: “info”.

  • fmt (str, optional) –

    Formatting string to use for logging.

    Defaults to: LOG_CON_FMT.

  • obj (logging.Logger, optional) –

    Logger object to add handler to.

    Defaults to: LOG.

Notes

Will remove handler from obj if exists before adding.

Returns:logging.StreamHandler
pytan3.utils.logs.add_stderr(lvl='info', fmt='%(levelname)-8s [%(name)s:%(funcName)s()] %(message)s', obj=<Logger pytan3 (DEBUG)>)[source]

Add a STDERR handler to a logger object.

Parameters:
  • lvl (str or int, optional) –

    Level to set on handler.

    Defaults to: “info”.

  • fmt (str, optional) –

    Formatting string to use for logging.

    Defaults to: LOG_CON_FMT.

  • obj (logging.Logger, optional) –

    Logger object to add handler to.

    Defaults to: LOG.

Notes

Will remove handler from obj if exists before adding.

Returns:logging.StreamHandler
pytan3.utils.logs.add_file(lvl='debug', path=None, path_sub='logs', path_file='pytan3.log', max_mb=10, max_num=5, fmt='[%(asctime)s] PID:%(process)s %(levelname)-8s [%(name)s:%(funcName)s()] %(message)s', obj=<Logger pytan3 (DEBUG)>)[source]

Add a rotating log file handler to a logger object.

Parameters:
  • lvl (str or int, optional) –

    Level to set on handler.

    Defaults to: “debug”.

  • path (str or pathlib.Path, optional) –

    Storage directory to use.

    If empty, resolve path via pytan3.utils.tools.get_storage_dir().

    Defaults to: None.

  • path_sub (str, optional) –

    Sub directory under path that should contain path_file.

    Defaults to: “logs”

  • path_file (str, optional) –

    Filename to write logs to under path / path_sub.

    Defaults to: LOG_FILE

  • max_mb (int, optional) –

    Rotate log file when it reaches this many MB.

    Defaults to: 10.

  • max_num (int, optional) –

    Only keep up to this number of rotated logs.

    Defaults to: 5.

  • fmt (str, optional) –

    Formatting string to use for logging.

    Defaults to: LOG_PATH_FMT.

  • obj (logging.Logger, optional) –

    Logger object to add handler to.

    Defaults to: LOG.

Notes

Will remove handler from obj if exists before adding.

Returns:logging.handlers.RotatingFileHandler
pytan3.utils.logs.remove_stdout(obj=<Logger pytan3 (DEBUG)>)[source]

Remove a STDOUT handler from a logger object.

Parameters:obj (logging.Logger, optional) –

Logger object to remove handler from.

Defaults to: LOG.
Returns:logging.Handler
pytan3.utils.logs.remove_stderr(obj=<Logger pytan3 (DEBUG)>)[source]

Remove a STDERR handler from a logger object.

Parameters:obj (logging.Logger, optional) –

Logger object to remove handler from.

Defaults to: LOG.
Returns:logging.Handler
pytan3.utils.logs.remove_file(path=None, path_sub='logs', path_file='pytan3.log', obj=<Logger pytan3 (DEBUG)>)[source]

Remove a STDERR handler from a logger object.

Parameters:
  • path (str or pathlib.Path, optional) –

    Storage directory to use.

    If empty, resolve path via pytan3.utils.tools.get_storage_dir().

    Defaults to: None.

  • path_sub (str, optional) –

    Sub directory under path that should contain path_file.

    Defaults to: “logs”

  • path_file (str, optional) –

    Filename to write logs to under path / path_sub.

    Defaults to: LOG_FILE

  • obj (logging.Logger, optional) –

    Logger object to remove handler from.

    Defaults to: LOG.
Returns:

logging.handlers.RotatingFileHandler
pytan3.utils.logs.add_null(obj=<Logger pytan3 (DEBUG)>)[source]

Add a Null handler to a logger object.

Parameters:obj (logging.Logger, optional) –

Logger object to add handler to.

Defaults to: LOG.
Returns:logging.NullHandler
pytan3.utils.logs.remove_null(obj=<Logger pytan3 (DEBUG)>)[source]

Remove a Null handler from a logger object.

Parameters:obj (logging.Logger, optional) –

Logger object to remove handler from.

Defaults to: LOG.
Returns:logging.NullHandler
pytan3.utils.logs.remove_handler(handler, obj=<Logger pytan3 (DEBUG)>)[source]

Remove a handler from a logger.

Parameters:
  • handler (logging.Handler) – Handler object to add to logger object.
  • obj (logging.Logger, optional) –

    Logger object to remove handler from.

    Defaults to: LOG.
Returns:

logging.Handler
pytan3.utils.logs.find_handler_by_name(name, obj=<Logger pytan3 (DEBUG)>)[source]

Find handler object that is attached to a logger.

Parameters:
  • name (str) – Name of handler object to find.
  • obj (logging.Logger, optional) –

    Logger object to find handler in.

    Defaults to: LOG.
Returns:

logging.Handler or None
pytan3.utils.logs.get_output_handlers(lvl=None, obj=<Logger pytan3 (DEBUG)>)[source]

Find handlers attached to a logger that show output at a given level.

Parameters:
  • lvl (str or int, optional) –

    Level to check if handler outputs at.

    Defaults to: None.

  • obj (logging.Logger, optional) –

    Logger object to find output handlers in.

    Defaults to: LOG.

Notes

If lvl is None logging levels of handlers will not be checked and the return will be handlers that are not logging.NullHandler.

Returns:list of logging.Handler
pytan3.utils.logs.will_print_at(lvl='debug', obj=<Logger pytan3 (DEBUG)>)[source]

Check if a logger will show output at a given level.

Parameters:
  • lvl (str or int, optional) –

    Level to check if obj has any handlers that will output logs at.

    Defaults to: “debug”.

  • obj (logging.Logger, optional) –

    Logger to check if disabled and for handlers that output at lvl.

    Defaults to: LOG.
Returns:

bool

Prompting Utilities

PyTan prompting module.

class pytan3.utils.prompts.ColorWrap(mode='')[source]

Bases: object

Wrapper for colorama.

MODE_MAP = {'BACK': <colorama.ansi.AnsiBack object at 0x7f07d8d885c0>, 'FORE': <colorama.ansi.AnsiFore object at 0x7f07d8d88550>, 'STYLE': <colorama.ansi.AnsiStyle object at 0x7f07d8d885f8>}

dict – Map of modes this wrapper can expose.

__init__(mode='')[source]

Constructor.

Parameters:mode (str, optional) –

One of keys in MODE_MAP.

Defaults to: “”.
MODE = ''

str – Mode to wrap around colorama.

__getattr__(attr)[source]

Get an attribute from colorama.

Parameters:attr (str) –

If MODE is in MODE_MAP, get uppercased attr from MODE.

Returns an empty string if MODE is not in MODE_MAP or attr is not available in MODE_CLS from MODE_MAP[MODE].
Returns:str
class pytan3.utils.prompts.Promptness(input_stream=<_io.TextIOWrapper name='<stdin>' mode='r' encoding='UTF-8'>, output_stream=<colorama.ansitowin32.StreamWrapper object>, lvl='info')[source]

Bases: object

Prompt utility class.

YES_VALUES = ['y.*', 'true', '1']

list of str – Valid regex values for truthy-ness.

NO_VALUES = ['n.*', 'false', '0']

list of str – Valid regex values for falsey-ness.

USE_COLOR = True

bool – Use color in prepare().

OVERRIDES = None

dict – Default overrides for Promptness.ask_dict().

TMPLS = {'env_value': '\n{{f.green}}OS Environment Variable {env!r} has value {env_value}, {{f.green}}{action} override default {default}{{s.reset}}.', 'option': '\n {{f.BLUE}}{opt}{{s.reset}}', 'options': '\nOptions:{options}\n', 'prompt': '\n{{f.cyan}}{text}{{s.reset}} [default: {default}]: ', 'secure_value': '{{s.reset}}{{f.red}}..HIDDEN..{{s.reset}}', 'value': "{{s.reset}}{{f.green}}'{value}'{{s.reset}}", 'warn_bool_invalid': '\n-- {{f.red}}Value must be one of {yes_values!r} or {no_values!r}{{s.reset}}', 'warn_int_invalid': '\n-- {{f.red}}Value must be a valid number{{s.reset}}', 'warn_nodefault': '\n-- {{f.red}}No default defined, value required!{{s.reset}}', 'warn_notty': '\n\n{{f.red}}No TTY on stream {stream}, using default {default!r} for {text!r}{{s.reset}}\n', 'warn_option_invalid': '\n-- {{f.red}}Value must be one of: {options!r}{{s.reset}}\n', 'warn_text_invalid': '\n-- {{f.red}}Value did not match {validate!r}{{s.reset}}'}

dict – String templates used throughout.

__init__(input_stream=<_io.TextIOWrapper name='<stdin>' mode='r' encoding='UTF-8'>, output_stream=<colorama.ansitowin32.StreamWrapper object>, lvl='info')[source]

Constructor.

Parameters:
  • input_stream (io.IOBase, optional) –

    Stream to get input from.

    Defaults to: sys.stdin.

  • output_stream (io.IOBase, optional) –

    Stream to send output to.

    Defaults to: sys.stderr.

  • lvl (str, optional) –

    Logging level for this object.

    Defaults to: “info”.
input_stream = None

io.IOBase – Stream to get input from.

output_stream = None

io.IOBase – Stream to send output to.

log = None

logging.Logger – Log for this object.

__str__()[source]

Show object info.

Returns:str
__repr__()[source]

Show object info.

Returns:str
spew(text, **kwargs)[source]

Print output to stream.

Parameters:
prepare(text, **kwargs)[source]

Format text with colors.

Parameters:
  • text (str) – String to format.
  • **kwargs –
    use_color (bool):
    True: Replace fore, back, and style with color codes.

    False: Replace fore, back, and style with empty vals.

    Defaults to: USE_COLOR.
get_prompter(secure=False)[source]

Get a prompt function.

Parameters:secure (bool, optional) –

Return getpass.getpass instead of input.

Defaults to: False.
Returns:object
prompt(text, default=None, **kwargs)[source]

Prompt for a value.

Parameters:
  • text (str) – Prompt text from parent for error/warning messages.
  • default (object, optional) –

    Default value to use if no value supplied.

    Defaults to: None.

  • **kwargs –
    secure (bool, optional):
    If value should have its input hidden or not.

    Defaults to: False.

    check_tty (bool):
    Skip TTY checks for input/output stream.

    Defaults to: False.

    env_var (str):
    Replace default with contents of this OS Env.

    Defaults to: “”.

    rest of kwargs:
    Passed to spew() and prepare().
Raises:

NoTtyError – If the input or output stream is not attached to a console and check_tty is False.
Returns:

str
ask_choice(text, choices, default=None, attempts=5, **kwargs)[source]

Prompt user to select from a list of choices.

Parameters:
  • text (str) – Text to use when prompting.
  • choices (list of str) – List of choices for user to pick from.
  • default (str, optional) –

    Default value to use if no value supplied.

    Defaults to: None.

  • attempts (int, optional) –

    Number of attempts to allow empty/invalid input.

    Defaults to: 5.

  • **kwargs – Passed to :meth`prepare` and spew().
Raises:
Returns:

str
ask_bool(text, default=None, attempts=5, **kwargs)[source]

Prompt user to provide yes or no.

Parameters:
  • text (str) – Text to use when prompting.
  • default (bool or str, optional) –

    Default value to use if no value supplied.

    Defaults to: None.

  • attempts (int, optional) –

    Number of attempts to allow empty/invalid input.

    Defaults to: 5.

  • **kwargs –
    rest of kwargs:
    Passed to prepare() and spew().
Raises:
Returns:

bool
ask_int(text, default=None, attempts=5, **kwargs)[source]

Prompt user to provide yes or no.

Parameters:
  • text (str) – Text to use when prompting.
  • default (int, optional) –

    Default value to use if no value supplied.

    Defaults to: None.

  • attempts (int, optional) –

    Number of attempts to allow empty/invalid input.

    Defaults to: 5.

  • **kwargs –
    rest of kwargs:
    Passed to prompt() and prepare().
Raises:
Returns:

int
ask_str(text, default=None, attempts=5, **kwargs)[source]

Prompt user to provide yes or no.

Parameters:
  • text (str) – Text to use when prompting.
  • default (str, optional) –

    Default value to use if no value supplied.

    Defaults to: “”.

  • attempts (int, optional) –

    Number of attempts to allow empty/invalid input.

    Defaults to: 5.

  • **kwargs –
    empty_ok (bool, optional):
    Empty input is allowed.

    Defaults to: False.

    validate (str, optional):
    Regex string to validate value.

    Defaults to: “”.

    rest of kwargs:
    Passed to prompt() and prepare().
Raises:

EmptyValueError – If no value supplied and no default and not empty_ok.
Returns:

str
ask_dict(asks, overrides=None)[source]

Prompt for input from a list of dict.

Parameters:
  • asks (list of dict) – List of dicts with valid kwargs for the various ask methods.
  • overrides –

    (dict, optional): Dictionary of key / value pairs to over ride the defaults of asks.

    Defaults to: None.

Notes

Keys for ask dict in asks:

“method”, required:
Ask method to use for this ask dict.
“key”, required:
Key to store value returned from ask method in return dict.
“text”, required:
String to use for prompting.
“choices”, required for ask_choice():
List of valid choices for user to pick.
“secure”, optional for ask_str():
Use prompt that hides user input while typing.
“default”, optional:
Default value to use if user does not provide one.
“attempts”, optional:
Number of attempts to allow empty/invalid input.
“check_tty”, optional:
Skip TTY checks for input/output stream.
Returns:dict
exception pytan3.utils.prompts.PromptError(text, attempts)[source]

Bases: Exception

Parent exception for any errors when prompting.

Thrown by:
Promptness.ask_dict()
msg = '{text}'
__init__(text, attempts)[source]

Constructor.

Parameters:
  • text (str) – Text to insert into exception message
  • attempts (int, optional) – Number of attempts tried before this exception
exception pytan3.utils.prompts.InvalidValueError(text, attempts)[source]

Bases: pytan3.utils.prompts.PromptError

Thrown when a user provides an invalid value.

Thrown by:
Promptness.ask_choice() Promptness.ask_bool() Promptness.ask_int()
msg = 'Invalid value supplied for prompt {text!r} after {attempts} attempts'
exception pytan3.utils.prompts.EmptyValueError(text, attempts)[source]

Bases: pytan3.utils.prompts.PromptError

Thrown when no default defined and user provides no value.

Thrown by:
Promptness.ask_choice() Promptness.ask_bool() Promptness.ask_int() Promptness.ask_str()
msg = 'No value supplied for prompt {text!r} after {attempts} attempts'
exception pytan3.utils.prompts.NoTtyError(stream, text)[source]

Bases: pytan3.utils.prompts.PromptError

Thrown when a TTY is not attached to a console.

Thrown by:
Promptness.prompt()
__init__(stream, text)[source]

Constructor.

Parameters:
  • stream (io.IOBase) – Stream that was not attached to a console.
  • text (str) – Text to insert into exception message
pytan3.utils.prompts.stream_name(stream)[source]

Get the name of a stream.

Parameters:stream (io.IOBase) – Stream to get name of.
Returns:str
pytan3.utils.prompts.isatty(stream)[source]

Check if a stream is attached to a console.

Parameters:stream (io.IOBase) – Stream to check.
Returns:bool
pytan3.utils.prompts.promptness = pytan3.utils.prompts.Promptness(input='<stdin>', output='<stderr>')

Promptness – Pre-established object for easy usage.

Tools

PyTan tools module.

pytan3.utils.tools.STORAGE_DIR = 'pytan3_local'

str – Default sub-directory to use for STORAGE_PATH.

pytan3.utils.tools.STORAGE_PATH = '~/pytan3_local'

str – Default path to use for get_storage_dir() if path is None.

Will use OS Environment variable “PYTAN_STORAGE_PATH” if set.

pytan3.utils.tools.get_env(key, default)[source]

Get an environment variables value.

Parameters:
  • key (str) – Name of OS environment variable value to get.
  • default (str) – Default value to return if key is not set or is empty.
Returns:

str
pytan3.utils.tools.get_storage_dir(path=None, path_sub='', mkdir=False)[source]

Get the directory for PyTan to use for storing local state.

Parameters:
  • path (str or pathlib.Path, optional) –

    Path to use as base storage directory.

    If None, will use OS environment variable “PYTAN_STORAGE_PATH” if set.

    If None and “PYTAN_STORAGE_PATH” is not set, will use STORAGE_PATH.

    Defaults to: None.

  • path_sub (str or pathlib.Path, optional) –

    Subdirectory to get under path.

    Defaults to: “”.

  • mkdir (bool, optional) –

    Create path and path / sub with perms 0700.

    Defaults to: False.
Returns:

pathlib.Path
pytan3.utils.tools.str_to_intfloat(s)[source]

Convert str to int or float.

Parameters:s (str) – String to convert to float if it has a period or int if not.
Returns:int or float
pytan3.utils.tools.secs_ago(secs)[source]

Get a datetime object from N seconds ago.

Parameters:secs (int or float) – Number of seconds ago to get datetime object of.
Returns:datetime.datetime
pytan3.utils.tools.secs_age(dt)[source]

Get the number of seconds ago of a datetime object.

Parameters:dt (datetime.datetime) – Datetime object to calculate age in seconds of.
Returns:int
pytan3.utils.tools.b64_encode(s)[source]

Encode s as base64 using base64.b64encode().

Parameters:s (str) – Text to base64 encode.
Returns:str
pytan3.utils.tools.b64_decode(s)[source]

Decode text as base64 using base64.b64decode().

Parameters:s (str) – Text to base64 decode.
Returns:str
pytan3.utils.tools.trim_txt(txt, limit=10000)[source]

Trim a str if it is over n characters.

Parameters:
  • txt (str) – String to trim.
  • limit (int, optional) –

    Number of characters to trim txt to.

    Defaults to: 10000.
Returns:

str
pytan3.utils.tools.get_dict_path(obj, path)[source]

Traverse a dict using a / seperated string.

Parameters:
  • obj (dict) – Dictionary to traverse using path.
  • path (str) – Nested dictionary keys seperated by / to traverse in obj.
Raises:

ValueError – If a part of a path can not be found.
Returns:

object
pytan3.utils.tools.human_size(size)[source]

Format a byte count as human readable using humanfriendly.format_size().

Parameters:size (int or str) – Size to format as an int or as a human readable str.

Notes

Given “13”, “13b”, “13 bytes”, or 13 will return: “13 bytes”.

Returns:str
pytan3.utils.tools.human_delta(delta, ms=False, short=True)[source]

Format a delta as human readable using humanfriendly.format_timespan().

Parameters:
  • delta (int or float or str or datetime.timedelta) – Number of seconds to format.
  • ms (bool, optional) –

    Represent milliseconds separately instead of as fractional seconds.

    Defaults to: False.

  • short (bool, optional) –

    Return shortened version of minutes, seconds, milliseconds.

    Defaults to: True.

Notes

Given 300.1 or “300.1” or datetime.timedelta(seconds=300, microseconds=100000), will return: “5 minutes and 100 milliseconds” or “5m100ms”.

Returns:str
class pytan3.utils.tools.Timer[source]

Bases: object

Context manager to get a human readable elapsed timespan.

__init__()[source]

Constructor.

start = None

datetime.datetime – Start of timespan.

end = None

datetime.datetime – End of timespan.

__call__()[source]

Return the current time.

Returns:datetime.datetime
__enter__()[source]

Set the start time.

Returns:datetime.datetime
__exit__(exc_type, exc_value, exc_traceback)[source]

Set end to now.

__str__()[source]

Get elapsed details.

Returns:str
__repr__()[source]

Get elapsed details.

Returns:str
elapsed_delta

Get elapsed time since start.

Returns:datetime.timedelta
elapsed_int

Get elapsed seconds since start.

Returns:int
elapsed

Get elapsed seconds since start in human readable format.

ms (bool, optional):

Represent milliseconds separately instead of as fractional seconds.

Defaults to: True.

short (bool, optional):

Return shortened version of minutes, seconds, millseconds.

Defaults to: True.

Returns:str

Versioning Utilities

PyTan versioning utilities module.

pytan3.utils.versions.version_recomp(v1, v2, vshrink=True)[source]

Recompile version strings into lists.

Parameters:
  • v1 (str or list) –

    Version that is being compared against v2.

    Will be shrunk down to the same dotted length as v2 if vshrink is True.

    Will be split into list using period.

  • v2 (str or list) –

    Version that v1 is being compared against.

    Will be split into list using period.

  • vshrink (bool or int, optional) –

    If True, shrink v1 down to match the same length as v2.

    If False, do not shrink v1 at all.

    If int, shrink both v1 and v2 down to this length.

    Defaults to: True.

Notes

If any non-integers found in v1 or v2, they will be returned as joined strings using periods.

Default python string comparison leads to a less-than-perfect comparison for ints mixed with strs.

Returns:(list of str, list of str) or (str, str)
pytan3.utils.versions.version_eq(v1, v2, vshrink=True)[source]

Check if v1 is equal to v2.

Parameters:
  • v1 (str or list) –

    Version that is being compared against v2.

    Will be shrunk down to the same dotted length as v2 if vshrink is True.

  • v2 (str or list) – Version that v1 is being compared against.
  • vshrink (bool or int, optional) –

    If True, shrink v1 down to match the same length as v2.

    If False, do not shrink v1 at all.

    If int, shrink both v1 and v2 down to this length.

    Defaults to: True.
Returns:

bool
pytan3.utils.versions.version_min(v1, v2, vshrink=True)[source]

Check if v1 is greater than or equal to v2.

Parameters:
  • v1 (str or list) –

    Version that is being compared against v2.

    Will be shrunk down to the same dotted length as v2 if vshrink is True.

  • v2 (str or list) – Version that v1 is being compared against.
  • vshrink (bool or int, optional) –

    If True, shrink v1 down to match the same length as v2.

    If False, do not shrink v1 at all.

    If int, shrink both v1 and v2 down to this length.

    Defaults to: True.
Returns:

bool
pytan3.utils.versions.version_max(v1, v2, vshrink=True)[source]

Check if v1 is less than or equal to v2.

Parameters:
  • v1 (str or list) –

    Version that is being compared against veq, vmax, and vmin.

    Will be be shrunk down to the same dotted length as veq, vmax, and vmin if vshrink is True.

  • v2 (str or list) – Version that v1 is being compared against.
  • vshrink (bool or int, optional) –

    If True, shrink v1 down to match the same length as v2.

    If False, do not shrink v1 at all.

    If int, shrink both v1 and v2 down to this length.

    Defaults to: True.
Returns:

bool
pytan3.utils.versions.version_check(version, veq='', vmax='', vmin='', vshrink=True)[source]

Check if version meets veq, vmax, and vmin.

Parameters:
  • version (str or list) –

    Version that is being compared against veq, vmax, and vmin.

    Will be be shrunk down to the same dotted length as veq, vmax, and vmin if vshrink is True.

  • veq (str, optional) –

    Exact version that version must match.

    No comparison performed if empty.

    Defaults to: “”.

  • vmin (str, optional) –

    Minimum version that version must match.

    No comparison performed if empty.

    Defaults to: “”.

  • vmax (str, optional) –

    Maximum version that version must match.

    No comparison performed if empty.

    Defaults to: “”.

  • vshrink (bool or int, optional) –

    If True, shrink version down to match the same length as veq, vmax, and vmin.

    If False, do not shrink version at all.

    If int, shrink version, veq, vmax, and vmin down to this length.

    Defaults to: True.
Returns:

bool
pytan3.utils.versions.version_check_obj_req(version, src, obj)[source]

Check if veq, vmax, and vmin from a classes get_version_req meets version.

Parameters:
  • version (str or list) –

    Version that is being compared against veq, vmax, and vmin keys in the dict returned from the get_version_req class of obj.

    Will be be shrunk down to the same dotted length as veq, vmax, and vmin if vshrink is True.

  • src (str) – Where version came from, used in exception message.
  • obj (object) – Object or class that has get_version_req class method.
Raises:

pytan3.utils.exceptions.VersionMismatchError – If any of veq, vmax, vmin keys in dict returned by get_version_req do not match version.
pytan3.utils.versions.split_ver(v)[source]

Split v into a list of integers.

Parameters:v (str or list of int or int) – Version string to split using periods.
Returns:list of int or str
pytan3.utils.versions.join_ver(v)[source]

Join v into a dot string.

Parameters:v (str or list of int or int) – Version string to join using periods.
Returns:str

Exceptions for Utilities

Exceptions and warnings for pytan3.utils.

exception pytan3.utils.exceptions.ModuleError[source]

Bases: pytan3.exceptions.PyTanError

Parent of all exceptions for pytan3.utils.

Thrown by:
exception pytan3.utils.exceptions.ModuleWarning[source]

Bases: pytan3.exceptions.PyTanWarning

Parent of all warnings for pytan3.utils.

Thrown by:

exception pytan3.utils.exceptions.VersionMismatchError[source]

Bases: pytan3.utils.exceptions.ModuleError

Exception handler when matching a version.

Thrown from:

Command Line Interfaces

Todo

No command line interfaces are shipped with PyTan as of yet. The workflows will need to be done first, and then the logic for how to wrap those workflows seamlessly into command line scripts will take some effort.

Planned for version: 3.2.0

Workflows

Todo

No workflows are shipped with PyTan as of yet. It will take time to convert all of the workflows from PyTan 2.x into the new architecture built for PyTan 3.x.

Planned for version: 3.1.0

Workflow encapsulation package for performing actions using the Tanium API.

Version Information

Version information for PyTan.

pytan3.version.__version__ = '3.0.0'

str – Version of package.

pytan3.version.__url__ = 'https://github.com/tanium/pytan3'

str – URL of package.

pytan3.version.__author__ = 'Jim Olsen'

str – Auth of package.

pytan3.version.__title__ = 'pytan3'

str – Title of package.

pytan3.version.__project__ = 'PyTan'

str – Name of package.

pytan3.version.__author_email__ = 'jim.olsen@tanium.com'

str – Author email of package.

pytan3.version.__description__ = 'Tanium API workflow encapsulation.'

str – Description of package.

pytan3.version.__license__ = 'MIT'

str – License of package.

pytan3.version.__copyright__ = 'Copyright Tanium Inc. 2019'

str – Copyright of package.

Exceptions for all of PyTan

Parent exceptions and warnings for the PyTan package.

exception pytan3.exceptions.PyTanError[source]

Parent exception for all pytan3 errors.

exception pytan3.exceptions.PyTanWarning[source]

Parent warning for all pytan3 warnings.

Dependencies

Changelog

Current Major release

3.0.0 (2019-02-21)

  • rewrite: Fourth rewrite and redesign (started 2018-09-01)
  • todo: No workflows done as of yet, planned for 3.1.0
  • todo: No command line interfaces done as of yet, planned for 3.2.0
  • enhancement: Support REST and SOAP API types
  • enhancement: Uses pip for all dependencies, no more bundled libraries
  • enhancement: Package listed on pypi to allow for pip install
  • enhancement: Docs now hosted on readthedocs
  • enhancement: Support for Python v2.7.x and Python v3.7.x
  • enhancement: Modularity everywhere - no more tightly bundled objects that do everything
  • enhancement: SSL Certification validation now built-in and required
  • enhancement: Specialized prompting module for getting user input from console
  • enhancement: Specialized SSL cert module for getting SSL Certs in PEM format and displaying their contents in a human friendly way (like a browser)

Commit history

  • add vuln badge by Jim Olsen at 2019-02-22 21:56:30
  • typo fix by Jim Olsen at 2019-02-22 21:03:07
  • First push to public repo of 3.0.0 by Jim Olsen at 2019-02-22 20:56:15
  • First push to public repo of 3.0.0 by Jim Olsen at 2019-02-22 20:56:02
  • First push to public repo of 3.0.0 by Jim Olsen at 2019-02-22 20:54:53
  • Initial commit by Jim Olsen at 2019-02-22 20:49:33

Older Major releases

2.0.0 (2015-08-07)

  • rewrite: Third rewrite and redesign
  • Added Tanium Platform v6.2 and v6.5 support
  • Automated API workflow capture
  • Automated API examples
  • Much more

1.0.0 (2014-12-01)

  • rewrite: Second rewrite and redesign
  • Added more and better workflows
  • Re-worked command line interface
  • More and better docs

0.0.5 (2014-11-05)

  • rewrite: First rewrite and redesign
  • Initial testing framework added

0.0.1 (2014-10-10)

  • initial: Birth of PyTan!
  • Only Tanium Platform v6.0 supported

Indices and tables