diff --git a/src/dtc/README.md b/src/dtc/README.md index 217dbb7..a5109b0 100644 --- a/src/dtc/README.md +++ b/src/dtc/README.md @@ -1,5 +1,5 @@ # dtc -The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. +The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The `dtc` package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: @@ -78,6 +78,16 @@ Class | Method | HTTP request | Description *HealthCheckIcmpApi* | [**list**](dtc/docs/HealthCheckIcmpApi.md#list) | **GET** /dtc/health_check_icmp | Retrieve ICMPHealthCheck objects. *HealthCheckIcmpApi* | [**read**](dtc/docs/HealthCheckIcmpApi.md#read) | **GET** /dtc/health_check_icmp/{id} | Retrieve the ICMPHealthCheck object. *HealthCheckIcmpApi* | [**update**](dtc/docs/HealthCheckIcmpApi.md#update) | **PATCH** /dtc/health_check_icmp/{id} | Update the ICMPHealthCheck object. +*HealthCheckPdpApi* | [**create**](dtc/docs/HealthCheckPdpApi.md#create) | **POST** /dtc/health_check_pdp | Create the PDPHealthCheck object. +*HealthCheckPdpApi* | [**delete**](dtc/docs/HealthCheckPdpApi.md#delete) | **DELETE** /dtc/health_check_pdp/{id} | Delete the PDPHealthCheck object. +*HealthCheckPdpApi* | [**list**](dtc/docs/HealthCheckPdpApi.md#list) | **GET** /dtc/health_check_pdp | Retrieve PDPHealthCheck objects. +*HealthCheckPdpApi* | [**read**](dtc/docs/HealthCheckPdpApi.md#read) | **GET** /dtc/health_check_pdp/{id} | Retrieve the PDPHealthCheck object. +*HealthCheckPdpApi* | [**update**](dtc/docs/HealthCheckPdpApi.md#update) | **PATCH** /dtc/health_check_pdp/{id} | Update the PDPHealthCheck object. +*HealthCheckSipApi* | [**create**](dtc/docs/HealthCheckSipApi.md#create) | **POST** /dtc/health_check_sip | Create the SIPHealthCheck object. +*HealthCheckSipApi* | [**delete**](dtc/docs/HealthCheckSipApi.md#delete) | **DELETE** /dtc/health_check_sip/{id} | Delete the SIPHealthCheck object. +*HealthCheckSipApi* | [**list**](dtc/docs/HealthCheckSipApi.md#list) | **GET** /dtc/health_check_sip | Retrieve SIPHealthCheck objects. +*HealthCheckSipApi* | [**read**](dtc/docs/HealthCheckSipApi.md#read) | **GET** /dtc/health_check_sip/{id} | Retrieve the SIPHealthCheck object. +*HealthCheckSipApi* | [**update**](dtc/docs/HealthCheckSipApi.md#update) | **PATCH** /dtc/health_check_sip/{id} | Update the SIPHealthCheck object. *HealthCheckSnmpApi* | [**create**](dtc/docs/HealthCheckSnmpApi.md#create) | **POST** /dtc/health_check_snmp | Create the SNMPHealthCheck object. *HealthCheckSnmpApi* | [**delete**](dtc/docs/HealthCheckSnmpApi.md#delete) | **DELETE** /dtc/health_check_snmp/{id} | Delete the SNMPHealthCheck object. *HealthCheckSnmpApi* | [**list**](dtc/docs/HealthCheckSnmpApi.md#list) | **GET** /dtc/health_check_snmp | Retrieve SNMPHealthCheck objects. @@ -108,61 +118,87 @@ Class | Method | HTTP request | Description *SnmpUserSecurityApi* | [**list**](dtc/docs/SnmpUserSecurityApi.md#list) | **GET** /dtc/snmp_user_security_model | Retrieve SNMPUserSecurityModel objects. Use this method to retrieve __SNMPUserSecurityModel__ objects. *SnmpUserSecurityApi* | [**read**](dtc/docs/SnmpUserSecurityApi.md#read) | **GET** /dtc/snmp_user_security_model/{id} | Retrieve the SNMPUserSecurityModel object. Use this method to retrieve a __SNMPUserSecurityModel__ object. *SnmpUserSecurityApi* | [**update**](dtc/docs/SnmpUserSecurityApi.md#update) | **PATCH** /dtc/snmp_user_security_model/{id} | Update the SNMPUserSecurityModel object. Use this method to update a __SNMPUserSecurityModel__ object. +*TopologyApi* | [**create**](dtc/docs/TopologyApi.md#create) | **POST** /dtc/topology | Create the Topology object. +*TopologyApi* | [**delete**](dtc/docs/TopologyApi.md#delete) | **DELETE** /dtc/topology/{id} | Delete the Topology object. +*TopologyApi* | [**list**](dtc/docs/TopologyApi.md#list) | **GET** /dtc/topology | Retrieve Topology objects. +*TopologyApi* | [**read**](dtc/docs/TopologyApi.md#read) | **GET** /dtc/topology/{id} | Retrieve the Topology object. +*TopologyApi* | [**update**](dtc/docs/TopologyApi.md#update) | **PATCH** /dtc/topology/{id} | Update the Topology object. ## Documentation For Models + - [ConsolidatedHealthCheck](dtc/docs/ConsolidatedHealthCheck.md) - [CreateHTTPHealthCheckResponse](dtc/docs/CreateHTTPHealthCheckResponse.md) - [CreateICMPHealthCheckResponse](dtc/docs/CreateICMPHealthCheckResponse.md) + - [CreatePDPHealthCheckResponse](dtc/docs/CreatePDPHealthCheckResponse.md) - [CreatePolicyResponse](dtc/docs/CreatePolicyResponse.md) - [CreatePoolResponse](dtc/docs/CreatePoolResponse.md) + - [CreateSIPHealthCheckResponse](dtc/docs/CreateSIPHealthCheckResponse.md) - [CreateSNMPHealthCheckResponse](dtc/docs/CreateSNMPHealthCheckResponse.md) - [CreateSNMPUserSecurityResponse](dtc/docs/CreateSNMPUserSecurityResponse.md) - [CreateServerResponse](dtc/docs/CreateServerResponse.md) - [CreateTCPHealthCheckResponse](dtc/docs/CreateTCPHealthCheckResponse.md) + - [CreateTopologyResponse](dtc/docs/CreateTopologyResponse.md) + - [DesignatorService](dtc/docs/DesignatorService.md) - [HTTPHealthCheck](dtc/docs/HTTPHealthCheck.md) - [HeaderRegex](dtc/docs/HeaderRegex.md) - [ICMPHealthCheck](dtc/docs/ICMPHealthCheck.md) - [Inheritance2InheritedUInt32](dtc/docs/Inheritance2InheritedUInt32.md) - [ListHTTPHealthCheckResponse](dtc/docs/ListHTTPHealthCheckResponse.md) - [ListICMPHealthCheckResponse](dtc/docs/ListICMPHealthCheckResponse.md) + - [ListPDPHealthCheckResponse](dtc/docs/ListPDPHealthCheckResponse.md) - [ListPolicyResponse](dtc/docs/ListPolicyResponse.md) - [ListPoolResponse](dtc/docs/ListPoolResponse.md) + - [ListSIPHealthCheckResponse](dtc/docs/ListSIPHealthCheckResponse.md) - [ListSNMPHealthCheckResponse](dtc/docs/ListSNMPHealthCheckResponse.md) - [ListSNMPUserSecurityResponse](dtc/docs/ListSNMPUserSecurityResponse.md) - [ListServerResponse](dtc/docs/ListServerResponse.md) - [ListTCPHealthCheckResponse](dtc/docs/ListTCPHealthCheckResponse.md) + - [ListTopologyResponse](dtc/docs/ListTopologyResponse.md) - [Metadata](dtc/docs/Metadata.md) - [MetadataResourceMeta](dtc/docs/MetadataResourceMeta.md) + - [PDPHealthCheck](dtc/docs/PDPHealthCheck.md) - [Policy](dtc/docs/Policy.md) - [PolicyPool](dtc/docs/PolicyPool.md) + - [PolicyTopology](dtc/docs/PolicyTopology.md) + - [PolicyTopologyRuleBinding](dtc/docs/PolicyTopologyRuleBinding.md) - [Pool](dtc/docs/Pool.md) - [PoolHealthCheck](dtc/docs/PoolHealthCheck.md) - [PoolServer](dtc/docs/PoolServer.md) - [ReadHTTPHealthCheckResponse](dtc/docs/ReadHTTPHealthCheckResponse.md) - [ReadICMPHealthCheckResponse](dtc/docs/ReadICMPHealthCheckResponse.md) + - [ReadPDPHealthCheckResponse](dtc/docs/ReadPDPHealthCheckResponse.md) - [ReadPolicyResponse](dtc/docs/ReadPolicyResponse.md) - [ReadPoolResponse](dtc/docs/ReadPoolResponse.md) + - [ReadSIPHealthCheckResponse](dtc/docs/ReadSIPHealthCheckResponse.md) - [ReadSNMPHealthCheckResponse](dtc/docs/ReadSNMPHealthCheckResponse.md) - [ReadSNMPUserSecurityResponse](dtc/docs/ReadSNMPUserSecurityResponse.md) - [ReadServerResponse](dtc/docs/ReadServerResponse.md) - [ReadTCPHealthCheckResponse](dtc/docs/ReadTCPHealthCheckResponse.md) + - [ReadTopologyResponse](dtc/docs/ReadTopologyResponse.md) - [Record](dtc/docs/Record.md) + - [SIPHealthCheck](dtc/docs/SIPHealthCheck.md) - [SNMPHealthCheck](dtc/docs/SNMPHealthCheck.md) - [SNMPHealthCheckEntryCheck](dtc/docs/SNMPHealthCheckEntryCheck.md) - [SNMPUserSecurityModel](dtc/docs/SNMPUserSecurityModel.md) - [Server](dtc/docs/Server.md) - [TCPHealthCheck](dtc/docs/TCPHealthCheck.md) - [TTLInheritance](dtc/docs/TTLInheritance.md) + - [TagRule](dtc/docs/TagRule.md) + - [Topology](dtc/docs/Topology.md) - [TopologyRule](dtc/docs/TopologyRule.md) + - [TopologyRulePreset](dtc/docs/TopologyRulePreset.md) - [UpdateHTTPHealthCheckResponse](dtc/docs/UpdateHTTPHealthCheckResponse.md) - [UpdateICMPHealthCheckResponse](dtc/docs/UpdateICMPHealthCheckResponse.md) + - [UpdatePDPHealthCheckResponse](dtc/docs/UpdatePDPHealthCheckResponse.md) - [UpdatePolicyResponse](dtc/docs/UpdatePolicyResponse.md) - [UpdatePoolResponse](dtc/docs/UpdatePoolResponse.md) + - [UpdateSIPHealthCheckResponse](dtc/docs/UpdateSIPHealthCheckResponse.md) - [UpdateSNMPHealthCheckResponse](dtc/docs/UpdateSNMPHealthCheckResponse.md) - [UpdateSNMPUserSecurityResponse](dtc/docs/UpdateSNMPUserSecurityResponse.md) - [UpdateServerResponse](dtc/docs/UpdateServerResponse.md) - [UpdateTCPHealthCheckResponse](dtc/docs/UpdateTCPHealthCheckResponse.md) + - [UpdateTopologyResponse](dtc/docs/UpdateTopologyResponse.md) diff --git a/src/dtc/__init__.py b/src/dtc/__init__.py index 6d591e2..9512029 100644 --- a/src/dtc/__init__.py +++ b/src/dtc/__init__.py @@ -5,7 +5,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -18,62 +18,86 @@ # import apis into sdk package from dtc.api.health_check_http_api import HealthCheckHttpApi from dtc.api.health_check_icmp_api import HealthCheckIcmpApi +from dtc.api.health_check_pdp_api import HealthCheckPdpApi +from dtc.api.health_check_sip_api import HealthCheckSipApi from dtc.api.health_check_snmp_api import HealthCheckSnmpApi from dtc.api.health_check_tcp_api import HealthCheckTcpApi from dtc.api.policy_api import PolicyApi from dtc.api.pool_api import PoolApi from dtc.api.server_api import ServerApi from dtc.api.snmp_user_security_api import SnmpUserSecurityApi +from dtc.api.topology_api import TopologyApi # import models into sdk package +from dtc.models.consolidated_health_check import ConsolidatedHealthCheck from dtc.models.create_http_health_check_response import CreateHTTPHealthCheckResponse from dtc.models.create_icmp_health_check_response import CreateICMPHealthCheckResponse +from dtc.models.create_pdp_health_check_response import CreatePDPHealthCheckResponse from dtc.models.create_policy_response import CreatePolicyResponse from dtc.models.create_pool_response import CreatePoolResponse +from dtc.models.create_sip_health_check_response import CreateSIPHealthCheckResponse from dtc.models.create_snmp_health_check_response import CreateSNMPHealthCheckResponse from dtc.models.create_snmp_user_security_response import CreateSNMPUserSecurityResponse from dtc.models.create_server_response import CreateServerResponse from dtc.models.create_tcp_health_check_response import CreateTCPHealthCheckResponse +from dtc.models.create_topology_response import CreateTopologyResponse +from dtc.models.designator_service import DesignatorService from dtc.models.http_health_check import HTTPHealthCheck from dtc.models.header_regex import HeaderRegex from dtc.models.icmp_health_check import ICMPHealthCheck from dtc.models.inheritance2_inherited_u_int32 import Inheritance2InheritedUInt32 from dtc.models.list_http_health_check_response import ListHTTPHealthCheckResponse from dtc.models.list_icmp_health_check_response import ListICMPHealthCheckResponse +from dtc.models.list_pdp_health_check_response import ListPDPHealthCheckResponse from dtc.models.list_policy_response import ListPolicyResponse from dtc.models.list_pool_response import ListPoolResponse +from dtc.models.list_sip_health_check_response import ListSIPHealthCheckResponse from dtc.models.list_snmp_health_check_response import ListSNMPHealthCheckResponse from dtc.models.list_snmp_user_security_response import ListSNMPUserSecurityResponse from dtc.models.list_server_response import ListServerResponse from dtc.models.list_tcp_health_check_response import ListTCPHealthCheckResponse +from dtc.models.list_topology_response import ListTopologyResponse from dtc.models.metadata import Metadata from dtc.models.metadata_resource_meta import MetadataResourceMeta +from dtc.models.pdp_health_check import PDPHealthCheck from dtc.models.policy import Policy from dtc.models.policy_pool import PolicyPool +from dtc.models.policy_topology import PolicyTopology +from dtc.models.policy_topology_rule_binding import PolicyTopologyRuleBinding from dtc.models.pool import Pool from dtc.models.pool_health_check import PoolHealthCheck from dtc.models.pool_server import PoolServer from dtc.models.read_http_health_check_response import ReadHTTPHealthCheckResponse from dtc.models.read_icmp_health_check_response import ReadICMPHealthCheckResponse +from dtc.models.read_pdp_health_check_response import ReadPDPHealthCheckResponse from dtc.models.read_policy_response import ReadPolicyResponse from dtc.models.read_pool_response import ReadPoolResponse +from dtc.models.read_sip_health_check_response import ReadSIPHealthCheckResponse from dtc.models.read_snmp_health_check_response import ReadSNMPHealthCheckResponse from dtc.models.read_snmp_user_security_response import ReadSNMPUserSecurityResponse from dtc.models.read_server_response import ReadServerResponse from dtc.models.read_tcp_health_check_response import ReadTCPHealthCheckResponse +from dtc.models.read_topology_response import ReadTopologyResponse from dtc.models.record import Record +from dtc.models.sip_health_check import SIPHealthCheck from dtc.models.snmp_health_check import SNMPHealthCheck from dtc.models.snmp_health_check_entry_check import SNMPHealthCheckEntryCheck from dtc.models.snmp_user_security_model import SNMPUserSecurityModel from dtc.models.server import Server from dtc.models.tcp_health_check import TCPHealthCheck from dtc.models.ttl_inheritance import TTLInheritance +from dtc.models.tag_rule import TagRule +from dtc.models.topology import Topology from dtc.models.topology_rule import TopologyRule +from dtc.models.topology_rule_preset import TopologyRulePreset from dtc.models.update_http_health_check_response import UpdateHTTPHealthCheckResponse from dtc.models.update_icmp_health_check_response import UpdateICMPHealthCheckResponse +from dtc.models.update_pdp_health_check_response import UpdatePDPHealthCheckResponse from dtc.models.update_policy_response import UpdatePolicyResponse from dtc.models.update_pool_response import UpdatePoolResponse +from dtc.models.update_sip_health_check_response import UpdateSIPHealthCheckResponse from dtc.models.update_snmp_health_check_response import UpdateSNMPHealthCheckResponse from dtc.models.update_snmp_user_security_response import UpdateSNMPUserSecurityResponse from dtc.models.update_server_response import UpdateServerResponse from dtc.models.update_tcp_health_check_response import UpdateTCPHealthCheckResponse +from dtc.models.update_topology_response import UpdateTopologyResponse diff --git a/src/dtc/api/__init__.py b/src/dtc/api/__init__.py index 2756c26..53986b3 100644 --- a/src/dtc/api/__init__.py +++ b/src/dtc/api/__init__.py @@ -3,9 +3,12 @@ # import apis into api package from dtc.api.health_check_http_api import HealthCheckHttpApi from dtc.api.health_check_icmp_api import HealthCheckIcmpApi +from dtc.api.health_check_pdp_api import HealthCheckPdpApi +from dtc.api.health_check_sip_api import HealthCheckSipApi from dtc.api.health_check_snmp_api import HealthCheckSnmpApi from dtc.api.health_check_tcp_api import HealthCheckTcpApi from dtc.api.policy_api import PolicyApi from dtc.api.pool_api import PoolApi from dtc.api.server_api import ServerApi from dtc.api.snmp_user_security_api import SnmpUserSecurityApi +from dtc.api.topology_api import TopologyApi diff --git a/src/dtc/api/health_check_http_api.py b/src/dtc/api/health_check_http_api.py index 226d76a..e8d8165 100644 --- a/src/dtc/api/health_check_http_api.py +++ b/src/dtc/api/health_check_http_api.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -527,7 +527,7 @@ def list( Optional[StrictStr], Field( description= - " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | " + " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | " )] = None, offset: Annotated[ Optional[StrictInt], @@ -578,7 +578,7 @@ def list( :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. :type fields: str - :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | + :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | :type filter: str :param offset: The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. :type offset: int @@ -652,7 +652,7 @@ def list_with_http_info( Optional[StrictStr], Field( description= - " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | " + " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | " )] = None, offset: Annotated[ Optional[StrictInt], @@ -703,7 +703,7 @@ def list_with_http_info( :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. :type fields: str - :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | + :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | :type filter: str :param offset: The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. :type offset: int @@ -777,7 +777,7 @@ def list_without_preload_content( Optional[StrictStr], Field( description= - " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | " + " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | " )] = None, offset: Annotated[ Optional[StrictInt], @@ -828,7 +828,7 @@ def list_without_preload_content( :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. :type fields: str - :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | + :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | :type filter: str :param offset: The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. :type offset: int diff --git a/src/dtc/api/health_check_icmp_api.py b/src/dtc/api/health_check_icmp_api.py index 77aa95b..eaad215 100644 --- a/src/dtc/api/health_check_icmp_api.py +++ b/src/dtc/api/health_check_icmp_api.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -527,7 +527,7 @@ def list( Optional[StrictStr], Field( description= - " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | " + " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | " )] = None, offset: Annotated[ Optional[StrictInt], @@ -578,7 +578,7 @@ def list( :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. :type fields: str - :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | + :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | :type filter: str :param offset: The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. :type offset: int @@ -652,7 +652,7 @@ def list_with_http_info( Optional[StrictStr], Field( description= - " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | " + " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | " )] = None, offset: Annotated[ Optional[StrictInt], @@ -703,7 +703,7 @@ def list_with_http_info( :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. :type fields: str - :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | + :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | :type filter: str :param offset: The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. :type offset: int @@ -777,7 +777,7 @@ def list_without_preload_content( Optional[StrictStr], Field( description= - " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | " + " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | " )] = None, offset: Annotated[ Optional[StrictInt], @@ -828,7 +828,7 @@ def list_without_preload_content( :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. :type fields: str - :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | + :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | :type filter: str :param offset: The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. :type offset: int diff --git a/src/dtc/api/health_check_pdp_api.py b/src/dtc/api/health_check_pdp_api.py new file mode 100644 index 0000000..97e574f --- /dev/null +++ b/src/dtc/api/health_check_pdp_api.py @@ -0,0 +1,1503 @@ +# coding: utf-8 + +""" + DNS DTC API + + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. + + The version of the OpenAPI document: v1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictInt, StrictStr +from typing import Optional +from typing_extensions import Annotated +from dtc.models.create_pdp_health_check_response import CreatePDPHealthCheckResponse +from dtc.models.list_pdp_health_check_response import ListPDPHealthCheckResponse +from dtc.models.pdp_health_check import PDPHealthCheck +from dtc.models.read_pdp_health_check_response import ReadPDPHealthCheckResponse +from dtc.models.update_pdp_health_check_response import UpdatePDPHealthCheckResponse +from dtc import models + +from universal_ddi_client.api_client import ApiClient, RequestSerialized +from universal_ddi_client.api_response import ApiResponse +from universal_ddi_client.rest import RESTResponseType + + +class HealthCheckPdpApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + @validate_call + def create( + self, + body: PDPHealthCheck, + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> CreatePDPHealthCheckResponse: + """Create the PDPHealthCheck object. + + Use this method to create a __PDPHealthCheck__ object. + + :param body: (required) + :type body: PDPHealthCheck + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_serialize(body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CreatePDPHealthCheckResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + response_data.read() + return self.api_client.response_deserialize( + models=models, + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def create_with_http_info( + self, + body: PDPHealthCheck, + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[CreatePDPHealthCheckResponse]: + """Create the PDPHealthCheck object. + + Use this method to create a __PDPHealthCheck__ object. + + :param body: (required) + :type body: PDPHealthCheck + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_serialize(body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CreatePDPHealthCheckResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + response_data.read() + return self.api_client.response_deserialize( + models=models, + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def create_without_preload_content( + self, + body: PDPHealthCheck, + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create the PDPHealthCheck object. + + Use this method to create a __PDPHealthCheck__ object. + + :param body: (required) + :type body: PDPHealthCheck + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_serialize(body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CreatePDPHealthCheckResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + return response_data.response + + def _create_serialize( + self, + body, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = {} + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if body is not None: + _body_params = body + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + ['application/json'])) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = ['ApiKeyAuth'] + + return self.api_client.param_serialize( + method='POST', + base_path='/api/ddi/v1', + resource_path='/dtc/health_check_pdp', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth) + + @validate_call + def delete( + self, + id: Annotated[ + StrictStr, + Field(description= + "An application specific resource identity of a resource")], + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete the PDPHealthCheck object. + + Use this method to delete a __PDPHealthCheck__ object. + + :param id: An application specific resource identity of a resource (required) + :type id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_serialize(id=id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + response_data.read() + return self.api_client.response_deserialize( + models=models, + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def delete_with_http_info( + self, + id: Annotated[ + StrictStr, + Field(description= + "An application specific resource identity of a resource")], + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete the PDPHealthCheck object. + + Use this method to delete a __PDPHealthCheck__ object. + + :param id: An application specific resource identity of a resource (required) + :type id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_serialize(id=id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + response_data.read() + return self.api_client.response_deserialize( + models=models, + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def delete_without_preload_content( + self, + id: Annotated[ + StrictStr, + Field(description= + "An application specific resource identity of a resource")], + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete the PDPHealthCheck object. + + Use this method to delete a __PDPHealthCheck__ object. + + :param id: An application specific resource identity of a resource (required) + :type id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_serialize(id=id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + return response_data.response + + def _delete_serialize( + self, + id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = {} + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = self.api_client.path_param_value('id', id) + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + # authentication setting + _auth_settings: List[str] = ['ApiKeyAuth'] + + return self.api_client.param_serialize( + method='DELETE', + base_path='/api/ddi/v1', + resource_path='/dtc/health_check_pdp/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth) + + @validate_call + def list( + self, + fields: Annotated[ + Optional[StrictStr], + Field( + description= + " A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. " + )] = None, + filter: Annotated[ + Optional[StrictStr], + Field( + description= + " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | " + )] = None, + offset: Annotated[ + Optional[StrictInt], + Field( + description= + " The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. " + )] = None, + limit: Annotated[ + Optional[StrictInt], + Field( + description= + " The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. " + )] = None, + page_token: Annotated[ + Optional[StrictStr], + Field( + description= + " The service-defined string used to identify a page of resources. A null value indicates the first page. " + )] = None, + order_by: Annotated[ + Optional[StrictStr], + Field( + description= + " A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. " + )] = None, + tfilter: Annotated[ + Optional[StrictStr], + Field(description="This parameter is used for filtering by tags." + )] = None, + torder_by: Annotated[ + Optional[StrictStr], + Field(description="This parameter is used for sorting by tags." + )] = None, + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ListPDPHealthCheckResponse: + """Retrieve PDPHealthCheck objects. + + Use this method to retrieve __PDPHealthCheck__ objects. + + :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. + :type fields: str + :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | + :type filter: str + :param offset: The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. + :type offset: int + :param limit: The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. + :type limit: int + :param page_token: The service-defined string used to identify a page of resources. A null value indicates the first page. + :type page_token: str + :param order_by: A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. + :type order_by: str + :param tfilter: This parameter is used for filtering by tags. + :type tfilter: str + :param torder_by: This parameter is used for sorting by tags. + :type torder_by: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_serialize(fields=fields, + filter=filter, + offset=offset, + limit=limit, + page_token=page_token, + order_by=order_by, + tfilter=tfilter, + torder_by=torder_by, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ListPDPHealthCheckResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + response_data.read() + return self.api_client.response_deserialize( + models=models, + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def list_with_http_info( + self, + fields: Annotated[ + Optional[StrictStr], + Field( + description= + " A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. " + )] = None, + filter: Annotated[ + Optional[StrictStr], + Field( + description= + " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | " + )] = None, + offset: Annotated[ + Optional[StrictInt], + Field( + description= + " The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. " + )] = None, + limit: Annotated[ + Optional[StrictInt], + Field( + description= + " The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. " + )] = None, + page_token: Annotated[ + Optional[StrictStr], + Field( + description= + " The service-defined string used to identify a page of resources. A null value indicates the first page. " + )] = None, + order_by: Annotated[ + Optional[StrictStr], + Field( + description= + " A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. " + )] = None, + tfilter: Annotated[ + Optional[StrictStr], + Field(description="This parameter is used for filtering by tags." + )] = None, + torder_by: Annotated[ + Optional[StrictStr], + Field(description="This parameter is used for sorting by tags." + )] = None, + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ListPDPHealthCheckResponse]: + """Retrieve PDPHealthCheck objects. + + Use this method to retrieve __PDPHealthCheck__ objects. + + :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. + :type fields: str + :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | + :type filter: str + :param offset: The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. + :type offset: int + :param limit: The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. + :type limit: int + :param page_token: The service-defined string used to identify a page of resources. A null value indicates the first page. + :type page_token: str + :param order_by: A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. + :type order_by: str + :param tfilter: This parameter is used for filtering by tags. + :type tfilter: str + :param torder_by: This parameter is used for sorting by tags. + :type torder_by: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_serialize(fields=fields, + filter=filter, + offset=offset, + limit=limit, + page_token=page_token, + order_by=order_by, + tfilter=tfilter, + torder_by=torder_by, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ListPDPHealthCheckResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + response_data.read() + return self.api_client.response_deserialize( + models=models, + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def list_without_preload_content( + self, + fields: Annotated[ + Optional[StrictStr], + Field( + description= + " A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. " + )] = None, + filter: Annotated[ + Optional[StrictStr], + Field( + description= + " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | " + )] = None, + offset: Annotated[ + Optional[StrictInt], + Field( + description= + " The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. " + )] = None, + limit: Annotated[ + Optional[StrictInt], + Field( + description= + " The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. " + )] = None, + page_token: Annotated[ + Optional[StrictStr], + Field( + description= + " The service-defined string used to identify a page of resources. A null value indicates the first page. " + )] = None, + order_by: Annotated[ + Optional[StrictStr], + Field( + description= + " A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. " + )] = None, + tfilter: Annotated[ + Optional[StrictStr], + Field(description="This parameter is used for filtering by tags." + )] = None, + torder_by: Annotated[ + Optional[StrictStr], + Field(description="This parameter is used for sorting by tags." + )] = None, + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve PDPHealthCheck objects. + + Use this method to retrieve __PDPHealthCheck__ objects. + + :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. + :type fields: str + :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | + :type filter: str + :param offset: The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. + :type offset: int + :param limit: The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. + :type limit: int + :param page_token: The service-defined string used to identify a page of resources. A null value indicates the first page. + :type page_token: str + :param order_by: A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. + :type order_by: str + :param tfilter: This parameter is used for filtering by tags. + :type tfilter: str + :param torder_by: This parameter is used for sorting by tags. + :type torder_by: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_serialize(fields=fields, + filter=filter, + offset=offset, + limit=limit, + page_token=page_token, + order_by=order_by, + tfilter=tfilter, + torder_by=torder_by, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ListPDPHealthCheckResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + return response_data.response + + def _list_serialize( + self, + fields, + filter, + offset, + limit, + page_token, + order_by, + tfilter, + torder_by, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = {} + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if fields is not None: + + _query_params.append(('_fields', fields)) + + if filter is not None: + + _query_params.append(('_filter', filter)) + + if offset is not None: + + _query_params.append(('_offset', offset)) + + if limit is not None: + + _query_params.append(('_limit', limit)) + + if page_token is not None: + + _query_params.append(('_page_token', page_token)) + + if order_by is not None: + + _query_params.append(('_order_by', order_by)) + + if tfilter is not None: + + _query_params.append(('_tfilter', tfilter)) + + if torder_by is not None: + + _query_params.append(('_torder_by', torder_by)) + + # process the header parameters + # process the form parameters + # process the body parameter + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) + + # authentication setting + _auth_settings: List[str] = ['ApiKeyAuth'] + + return self.api_client.param_serialize( + method='GET', + base_path='/api/ddi/v1', + resource_path='/dtc/health_check_pdp', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth) + + @validate_call + def read( + self, + id: Annotated[ + StrictStr, + Field(description= + "An application specific resource identity of a resource")], + fields: Annotated[ + Optional[StrictStr], + Field( + description= + " A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. " + )] = None, + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ReadPDPHealthCheckResponse: + """Retrieve the PDPHealthCheck object. + + Use this method to retrieve a __PDPHealthCheck__ object. + + :param id: An application specific resource identity of a resource (required) + :type id: str + :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. + :type fields: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._read_serialize(id=id, + fields=fields, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ReadPDPHealthCheckResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + response_data.read() + return self.api_client.response_deserialize( + models=models, + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def read_with_http_info( + self, + id: Annotated[ + StrictStr, + Field(description= + "An application specific resource identity of a resource")], + fields: Annotated[ + Optional[StrictStr], + Field( + description= + " A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. " + )] = None, + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ReadPDPHealthCheckResponse]: + """Retrieve the PDPHealthCheck object. + + Use this method to retrieve a __PDPHealthCheck__ object. + + :param id: An application specific resource identity of a resource (required) + :type id: str + :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. + :type fields: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._read_serialize(id=id, + fields=fields, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ReadPDPHealthCheckResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + response_data.read() + return self.api_client.response_deserialize( + models=models, + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def read_without_preload_content( + self, + id: Annotated[ + StrictStr, + Field(description= + "An application specific resource identity of a resource")], + fields: Annotated[ + Optional[StrictStr], + Field( + description= + " A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. " + )] = None, + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve the PDPHealthCheck object. + + Use this method to retrieve a __PDPHealthCheck__ object. + + :param id: An application specific resource identity of a resource (required) + :type id: str + :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. + :type fields: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._read_serialize(id=id, + fields=fields, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ReadPDPHealthCheckResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + return response_data.response + + def _read_serialize( + self, + id, + fields, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = {} + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = self.api_client.path_param_value('id', id) + # process the query parameters + if fields is not None: + + _query_params.append(('_fields', fields)) + + # process the header parameters + # process the form parameters + # process the body parameter + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) + + # authentication setting + _auth_settings: List[str] = ['ApiKeyAuth'] + + return self.api_client.param_serialize( + method='GET', + base_path='/api/ddi/v1', + resource_path='/dtc/health_check_pdp/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth) + + @validate_call + def update( + self, + id: Annotated[ + StrictStr, + Field(description= + "An application specific resource identity of a resource")], + body: PDPHealthCheck, + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UpdatePDPHealthCheckResponse: + """Update the PDPHealthCheck object. + + Use this method to update a __PDPHealthCheck__ object. + + :param id: An application specific resource identity of a resource (required) + :type id: str + :param body: (required) + :type body: PDPHealthCheck + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_serialize(id=id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UpdatePDPHealthCheckResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + response_data.read() + return self.api_client.response_deserialize( + models=models, + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def update_with_http_info( + self, + id: Annotated[ + StrictStr, + Field(description= + "An application specific resource identity of a resource")], + body: PDPHealthCheck, + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UpdatePDPHealthCheckResponse]: + """Update the PDPHealthCheck object. + + Use this method to update a __PDPHealthCheck__ object. + + :param id: An application specific resource identity of a resource (required) + :type id: str + :param body: (required) + :type body: PDPHealthCheck + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_serialize(id=id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UpdatePDPHealthCheckResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + response_data.read() + return self.api_client.response_deserialize( + models=models, + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def update_without_preload_content( + self, + id: Annotated[ + StrictStr, + Field(description= + "An application specific resource identity of a resource")], + body: PDPHealthCheck, + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Update the PDPHealthCheck object. + + Use this method to update a __PDPHealthCheck__ object. + + :param id: An application specific resource identity of a resource (required) + :type id: str + :param body: (required) + :type body: PDPHealthCheck + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_serialize(id=id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UpdatePDPHealthCheckResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + return response_data.response + + def _update_serialize( + self, + id, + body, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = {} + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = self.api_client.path_param_value('id', id) + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if body is not None: + _body_params = body + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + ['application/json'])) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = ['ApiKeyAuth'] + + return self.api_client.param_serialize( + method='PATCH', + base_path='/api/ddi/v1', + resource_path='/dtc/health_check_pdp/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth) diff --git a/src/dtc/api/health_check_sip_api.py b/src/dtc/api/health_check_sip_api.py new file mode 100644 index 0000000..00d99d9 --- /dev/null +++ b/src/dtc/api/health_check_sip_api.py @@ -0,0 +1,1503 @@ +# coding: utf-8 + +""" + DNS DTC API + + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. + + The version of the OpenAPI document: v1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictInt, StrictStr +from typing import Optional +from typing_extensions import Annotated +from dtc.models.create_sip_health_check_response import CreateSIPHealthCheckResponse +from dtc.models.list_sip_health_check_response import ListSIPHealthCheckResponse +from dtc.models.read_sip_health_check_response import ReadSIPHealthCheckResponse +from dtc.models.sip_health_check import SIPHealthCheck +from dtc.models.update_sip_health_check_response import UpdateSIPHealthCheckResponse +from dtc import models + +from universal_ddi_client.api_client import ApiClient, RequestSerialized +from universal_ddi_client.api_response import ApiResponse +from universal_ddi_client.rest import RESTResponseType + + +class HealthCheckSipApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + @validate_call + def create( + self, + body: SIPHealthCheck, + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> CreateSIPHealthCheckResponse: + """Create the SIPHealthCheck object. + + Use this method to create a __SIPHealthCheck__ object. + + :param body: (required) + :type body: SIPHealthCheck + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_serialize(body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CreateSIPHealthCheckResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + response_data.read() + return self.api_client.response_deserialize( + models=models, + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def create_with_http_info( + self, + body: SIPHealthCheck, + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[CreateSIPHealthCheckResponse]: + """Create the SIPHealthCheck object. + + Use this method to create a __SIPHealthCheck__ object. + + :param body: (required) + :type body: SIPHealthCheck + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_serialize(body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CreateSIPHealthCheckResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + response_data.read() + return self.api_client.response_deserialize( + models=models, + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def create_without_preload_content( + self, + body: SIPHealthCheck, + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create the SIPHealthCheck object. + + Use this method to create a __SIPHealthCheck__ object. + + :param body: (required) + :type body: SIPHealthCheck + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_serialize(body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CreateSIPHealthCheckResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + return response_data.response + + def _create_serialize( + self, + body, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = {} + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if body is not None: + _body_params = body + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + ['application/json'])) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = ['ApiKeyAuth'] + + return self.api_client.param_serialize( + method='POST', + base_path='/api/ddi/v1', + resource_path='/dtc/health_check_sip', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth) + + @validate_call + def delete( + self, + id: Annotated[ + StrictStr, + Field(description= + "An application specific resource identity of a resource")], + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete the SIPHealthCheck object. + + Use this method to delete a __SIPHealthCheck__ object. + + :param id: An application specific resource identity of a resource (required) + :type id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_serialize(id=id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + response_data.read() + return self.api_client.response_deserialize( + models=models, + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def delete_with_http_info( + self, + id: Annotated[ + StrictStr, + Field(description= + "An application specific resource identity of a resource")], + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete the SIPHealthCheck object. + + Use this method to delete a __SIPHealthCheck__ object. + + :param id: An application specific resource identity of a resource (required) + :type id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_serialize(id=id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + response_data.read() + return self.api_client.response_deserialize( + models=models, + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def delete_without_preload_content( + self, + id: Annotated[ + StrictStr, + Field(description= + "An application specific resource identity of a resource")], + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete the SIPHealthCheck object. + + Use this method to delete a __SIPHealthCheck__ object. + + :param id: An application specific resource identity of a resource (required) + :type id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_serialize(id=id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + return response_data.response + + def _delete_serialize( + self, + id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = {} + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = self.api_client.path_param_value('id', id) + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + # authentication setting + _auth_settings: List[str] = ['ApiKeyAuth'] + + return self.api_client.param_serialize( + method='DELETE', + base_path='/api/ddi/v1', + resource_path='/dtc/health_check_sip/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth) + + @validate_call + def list( + self, + fields: Annotated[ + Optional[StrictStr], + Field( + description= + " A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. " + )] = None, + filter: Annotated[ + Optional[StrictStr], + Field( + description= + " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | " + )] = None, + offset: Annotated[ + Optional[StrictInt], + Field( + description= + " The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. " + )] = None, + limit: Annotated[ + Optional[StrictInt], + Field( + description= + " The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. " + )] = None, + page_token: Annotated[ + Optional[StrictStr], + Field( + description= + " The service-defined string used to identify a page of resources. A null value indicates the first page. " + )] = None, + order_by: Annotated[ + Optional[StrictStr], + Field( + description= + " A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. " + )] = None, + tfilter: Annotated[ + Optional[StrictStr], + Field(description="This parameter is used for filtering by tags." + )] = None, + torder_by: Annotated[ + Optional[StrictStr], + Field(description="This parameter is used for sorting by tags." + )] = None, + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ListSIPHealthCheckResponse: + """Retrieve SIPHealthCheck objects. + + Use this method to retrieve __SIPHealthCheck__ objects. + + :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. + :type fields: str + :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | + :type filter: str + :param offset: The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. + :type offset: int + :param limit: The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. + :type limit: int + :param page_token: The service-defined string used to identify a page of resources. A null value indicates the first page. + :type page_token: str + :param order_by: A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. + :type order_by: str + :param tfilter: This parameter is used for filtering by tags. + :type tfilter: str + :param torder_by: This parameter is used for sorting by tags. + :type torder_by: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_serialize(fields=fields, + filter=filter, + offset=offset, + limit=limit, + page_token=page_token, + order_by=order_by, + tfilter=tfilter, + torder_by=torder_by, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ListSIPHealthCheckResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + response_data.read() + return self.api_client.response_deserialize( + models=models, + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def list_with_http_info( + self, + fields: Annotated[ + Optional[StrictStr], + Field( + description= + " A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. " + )] = None, + filter: Annotated[ + Optional[StrictStr], + Field( + description= + " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | " + )] = None, + offset: Annotated[ + Optional[StrictInt], + Field( + description= + " The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. " + )] = None, + limit: Annotated[ + Optional[StrictInt], + Field( + description= + " The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. " + )] = None, + page_token: Annotated[ + Optional[StrictStr], + Field( + description= + " The service-defined string used to identify a page of resources. A null value indicates the first page. " + )] = None, + order_by: Annotated[ + Optional[StrictStr], + Field( + description= + " A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. " + )] = None, + tfilter: Annotated[ + Optional[StrictStr], + Field(description="This parameter is used for filtering by tags." + )] = None, + torder_by: Annotated[ + Optional[StrictStr], + Field(description="This parameter is used for sorting by tags." + )] = None, + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ListSIPHealthCheckResponse]: + """Retrieve SIPHealthCheck objects. + + Use this method to retrieve __SIPHealthCheck__ objects. + + :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. + :type fields: str + :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | + :type filter: str + :param offset: The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. + :type offset: int + :param limit: The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. + :type limit: int + :param page_token: The service-defined string used to identify a page of resources. A null value indicates the first page. + :type page_token: str + :param order_by: A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. + :type order_by: str + :param tfilter: This parameter is used for filtering by tags. + :type tfilter: str + :param torder_by: This parameter is used for sorting by tags. + :type torder_by: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_serialize(fields=fields, + filter=filter, + offset=offset, + limit=limit, + page_token=page_token, + order_by=order_by, + tfilter=tfilter, + torder_by=torder_by, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ListSIPHealthCheckResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + response_data.read() + return self.api_client.response_deserialize( + models=models, + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def list_without_preload_content( + self, + fields: Annotated[ + Optional[StrictStr], + Field( + description= + " A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. " + )] = None, + filter: Annotated[ + Optional[StrictStr], + Field( + description= + " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | " + )] = None, + offset: Annotated[ + Optional[StrictInt], + Field( + description= + " The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. " + )] = None, + limit: Annotated[ + Optional[StrictInt], + Field( + description= + " The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. " + )] = None, + page_token: Annotated[ + Optional[StrictStr], + Field( + description= + " The service-defined string used to identify a page of resources. A null value indicates the first page. " + )] = None, + order_by: Annotated[ + Optional[StrictStr], + Field( + description= + " A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. " + )] = None, + tfilter: Annotated[ + Optional[StrictStr], + Field(description="This parameter is used for filtering by tags." + )] = None, + torder_by: Annotated[ + Optional[StrictStr], + Field(description="This parameter is used for sorting by tags." + )] = None, + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve SIPHealthCheck objects. + + Use this method to retrieve __SIPHealthCheck__ objects. + + :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. + :type fields: str + :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | + :type filter: str + :param offset: The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. + :type offset: int + :param limit: The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. + :type limit: int + :param page_token: The service-defined string used to identify a page of resources. A null value indicates the first page. + :type page_token: str + :param order_by: A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. + :type order_by: str + :param tfilter: This parameter is used for filtering by tags. + :type tfilter: str + :param torder_by: This parameter is used for sorting by tags. + :type torder_by: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_serialize(fields=fields, + filter=filter, + offset=offset, + limit=limit, + page_token=page_token, + order_by=order_by, + tfilter=tfilter, + torder_by=torder_by, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ListSIPHealthCheckResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + return response_data.response + + def _list_serialize( + self, + fields, + filter, + offset, + limit, + page_token, + order_by, + tfilter, + torder_by, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = {} + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if fields is not None: + + _query_params.append(('_fields', fields)) + + if filter is not None: + + _query_params.append(('_filter', filter)) + + if offset is not None: + + _query_params.append(('_offset', offset)) + + if limit is not None: + + _query_params.append(('_limit', limit)) + + if page_token is not None: + + _query_params.append(('_page_token', page_token)) + + if order_by is not None: + + _query_params.append(('_order_by', order_by)) + + if tfilter is not None: + + _query_params.append(('_tfilter', tfilter)) + + if torder_by is not None: + + _query_params.append(('_torder_by', torder_by)) + + # process the header parameters + # process the form parameters + # process the body parameter + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) + + # authentication setting + _auth_settings: List[str] = ['ApiKeyAuth'] + + return self.api_client.param_serialize( + method='GET', + base_path='/api/ddi/v1', + resource_path='/dtc/health_check_sip', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth) + + @validate_call + def read( + self, + id: Annotated[ + StrictStr, + Field(description= + "An application specific resource identity of a resource")], + fields: Annotated[ + Optional[StrictStr], + Field( + description= + " A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. " + )] = None, + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ReadSIPHealthCheckResponse: + """Retrieve the SIPHealthCheck object. + + Use this method to retrieve a __SIPHealthCheck__ object. + + :param id: An application specific resource identity of a resource (required) + :type id: str + :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. + :type fields: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._read_serialize(id=id, + fields=fields, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ReadSIPHealthCheckResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + response_data.read() + return self.api_client.response_deserialize( + models=models, + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def read_with_http_info( + self, + id: Annotated[ + StrictStr, + Field(description= + "An application specific resource identity of a resource")], + fields: Annotated[ + Optional[StrictStr], + Field( + description= + " A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. " + )] = None, + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ReadSIPHealthCheckResponse]: + """Retrieve the SIPHealthCheck object. + + Use this method to retrieve a __SIPHealthCheck__ object. + + :param id: An application specific resource identity of a resource (required) + :type id: str + :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. + :type fields: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._read_serialize(id=id, + fields=fields, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ReadSIPHealthCheckResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + response_data.read() + return self.api_client.response_deserialize( + models=models, + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def read_without_preload_content( + self, + id: Annotated[ + StrictStr, + Field(description= + "An application specific resource identity of a resource")], + fields: Annotated[ + Optional[StrictStr], + Field( + description= + " A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. " + )] = None, + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve the SIPHealthCheck object. + + Use this method to retrieve a __SIPHealthCheck__ object. + + :param id: An application specific resource identity of a resource (required) + :type id: str + :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. + :type fields: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._read_serialize(id=id, + fields=fields, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ReadSIPHealthCheckResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + return response_data.response + + def _read_serialize( + self, + id, + fields, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = {} + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = self.api_client.path_param_value('id', id) + # process the query parameters + if fields is not None: + + _query_params.append(('_fields', fields)) + + # process the header parameters + # process the form parameters + # process the body parameter + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) + + # authentication setting + _auth_settings: List[str] = ['ApiKeyAuth'] + + return self.api_client.param_serialize( + method='GET', + base_path='/api/ddi/v1', + resource_path='/dtc/health_check_sip/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth) + + @validate_call + def update( + self, + id: Annotated[ + StrictStr, + Field(description= + "An application specific resource identity of a resource")], + body: SIPHealthCheck, + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UpdateSIPHealthCheckResponse: + """Update the SIPHealthCheck object. + + Use this method to update a __SIPHealthCheck__ object. + + :param id: An application specific resource identity of a resource (required) + :type id: str + :param body: (required) + :type body: SIPHealthCheck + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_serialize(id=id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UpdateSIPHealthCheckResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + response_data.read() + return self.api_client.response_deserialize( + models=models, + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def update_with_http_info( + self, + id: Annotated[ + StrictStr, + Field(description= + "An application specific resource identity of a resource")], + body: SIPHealthCheck, + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UpdateSIPHealthCheckResponse]: + """Update the SIPHealthCheck object. + + Use this method to update a __SIPHealthCheck__ object. + + :param id: An application specific resource identity of a resource (required) + :type id: str + :param body: (required) + :type body: SIPHealthCheck + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_serialize(id=id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UpdateSIPHealthCheckResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + response_data.read() + return self.api_client.response_deserialize( + models=models, + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def update_without_preload_content( + self, + id: Annotated[ + StrictStr, + Field(description= + "An application specific resource identity of a resource")], + body: SIPHealthCheck, + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Update the SIPHealthCheck object. + + Use this method to update a __SIPHealthCheck__ object. + + :param id: An application specific resource identity of a resource (required) + :type id: str + :param body: (required) + :type body: SIPHealthCheck + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_serialize(id=id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UpdateSIPHealthCheckResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + return response_data.response + + def _update_serialize( + self, + id, + body, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = {} + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = self.api_client.path_param_value('id', id) + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if body is not None: + _body_params = body + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + ['application/json'])) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = ['ApiKeyAuth'] + + return self.api_client.param_serialize( + method='PATCH', + base_path='/api/ddi/v1', + resource_path='/dtc/health_check_sip/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth) diff --git a/src/dtc/api/health_check_snmp_api.py b/src/dtc/api/health_check_snmp_api.py index e9ab91c..31461ff 100644 --- a/src/dtc/api/health_check_snmp_api.py +++ b/src/dtc/api/health_check_snmp_api.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -527,7 +527,7 @@ def list( Optional[StrictStr], Field( description= - " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | " + " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | " )] = None, offset: Annotated[ Optional[StrictInt], @@ -578,7 +578,7 @@ def list( :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. :type fields: str - :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | + :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | :type filter: str :param offset: The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. :type offset: int @@ -652,7 +652,7 @@ def list_with_http_info( Optional[StrictStr], Field( description= - " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | " + " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | " )] = None, offset: Annotated[ Optional[StrictInt], @@ -703,7 +703,7 @@ def list_with_http_info( :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. :type fields: str - :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | + :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | :type filter: str :param offset: The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. :type offset: int @@ -777,7 +777,7 @@ def list_without_preload_content( Optional[StrictStr], Field( description= - " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | " + " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | " )] = None, offset: Annotated[ Optional[StrictInt], @@ -828,7 +828,7 @@ def list_without_preload_content( :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. :type fields: str - :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | + :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | :type filter: str :param offset: The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. :type offset: int diff --git a/src/dtc/api/health_check_tcp_api.py b/src/dtc/api/health_check_tcp_api.py index 3ed1002..70804fc 100644 --- a/src/dtc/api/health_check_tcp_api.py +++ b/src/dtc/api/health_check_tcp_api.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -527,7 +527,7 @@ def list( Optional[StrictStr], Field( description= - " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | " + " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | " )] = None, offset: Annotated[ Optional[StrictInt], @@ -578,7 +578,7 @@ def list( :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. :type fields: str - :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | + :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | :type filter: str :param offset: The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. :type offset: int @@ -652,7 +652,7 @@ def list_with_http_info( Optional[StrictStr], Field( description= - " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | " + " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | " )] = None, offset: Annotated[ Optional[StrictInt], @@ -703,7 +703,7 @@ def list_with_http_info( :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. :type fields: str - :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | + :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | :type filter: str :param offset: The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. :type offset: int @@ -777,7 +777,7 @@ def list_without_preload_content( Optional[StrictStr], Field( description= - " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | " + " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | " )] = None, offset: Annotated[ Optional[StrictInt], @@ -828,7 +828,7 @@ def list_without_preload_content( :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. :type fields: str - :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | + :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | :type filter: str :param offset: The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. :type offset: int diff --git a/src/dtc/api/policy_api.py b/src/dtc/api/policy_api.py index 1fb3a1d..939bd27 100644 --- a/src/dtc/api/policy_api.py +++ b/src/dtc/api/policy_api.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -559,7 +559,7 @@ def list( Optional[StrictStr], Field( description= - " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | " + " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | " )] = None, offset: Annotated[ Optional[StrictInt], @@ -616,7 +616,7 @@ def list( :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. :type fields: str - :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | + :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | :type filter: str :param offset: The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. :type offset: int @@ -693,7 +693,7 @@ def list_with_http_info( Optional[StrictStr], Field( description= - " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | " + " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | " )] = None, offset: Annotated[ Optional[StrictInt], @@ -750,7 +750,7 @@ def list_with_http_info( :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. :type fields: str - :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | + :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | :type filter: str :param offset: The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. :type offset: int @@ -827,7 +827,7 @@ def list_without_preload_content( Optional[StrictStr], Field( description= - " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | " + " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | " )] = None, offset: Annotated[ Optional[StrictInt], @@ -884,7 +884,7 @@ def list_without_preload_content( :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. :type fields: str - :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | + :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | :type filter: str :param offset: The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. :type offset: int diff --git a/src/dtc/api/pool_api.py b/src/dtc/api/pool_api.py index 0fba72a..97b027f 100644 --- a/src/dtc/api/pool_api.py +++ b/src/dtc/api/pool_api.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -559,7 +559,7 @@ def list( Optional[StrictStr], Field( description= - " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | " + " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | " )] = None, offset: Annotated[ Optional[StrictInt], @@ -616,7 +616,7 @@ def list( :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. :type fields: str - :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | + :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | :type filter: str :param offset: The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. :type offset: int @@ -693,7 +693,7 @@ def list_with_http_info( Optional[StrictStr], Field( description= - " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | " + " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | " )] = None, offset: Annotated[ Optional[StrictInt], @@ -750,7 +750,7 @@ def list_with_http_info( :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. :type fields: str - :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | + :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | :type filter: str :param offset: The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. :type offset: int @@ -827,7 +827,7 @@ def list_without_preload_content( Optional[StrictStr], Field( description= - " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | " + " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | " )] = None, offset: Annotated[ Optional[StrictInt], @@ -884,7 +884,7 @@ def list_without_preload_content( :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. :type fields: str - :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | + :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | :type filter: str :param offset: The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. :type offset: int diff --git a/src/dtc/api/server_api.py b/src/dtc/api/server_api.py index 0fc5e76..6559c6d 100644 --- a/src/dtc/api/server_api.py +++ b/src/dtc/api/server_api.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -527,7 +527,7 @@ def list( Optional[StrictStr], Field( description= - " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | " + " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | " )] = None, offset: Annotated[ Optional[StrictInt], @@ -578,7 +578,7 @@ def list( :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. :type fields: str - :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | + :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | :type filter: str :param offset: The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. :type offset: int @@ -652,7 +652,7 @@ def list_with_http_info( Optional[StrictStr], Field( description= - " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | " + " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | " )] = None, offset: Annotated[ Optional[StrictInt], @@ -703,7 +703,7 @@ def list_with_http_info( :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. :type fields: str - :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | + :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | :type filter: str :param offset: The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. :type offset: int @@ -777,7 +777,7 @@ def list_without_preload_content( Optional[StrictStr], Field( description= - " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | " + " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | " )] = None, offset: Annotated[ Optional[StrictInt], @@ -828,7 +828,7 @@ def list_without_preload_content( :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. :type fields: str - :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | + :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | :type filter: str :param offset: The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. :type offset: int diff --git a/src/dtc/api/snmp_user_security_api.py b/src/dtc/api/snmp_user_security_api.py index 7b121dc..889e14a 100644 --- a/src/dtc/api/snmp_user_security_api.py +++ b/src/dtc/api/snmp_user_security_api.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -521,7 +521,7 @@ def list( Optional[StrictStr], Field( description= - " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | " + " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | " )] = None, offset: Annotated[ Optional[StrictInt], @@ -563,7 +563,7 @@ def list( :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. :type fields: str - :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | + :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | :type filter: str :param offset: The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. :type offset: int @@ -631,7 +631,7 @@ def list_with_http_info( Optional[StrictStr], Field( description= - " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | " + " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | " )] = None, offset: Annotated[ Optional[StrictInt], @@ -673,7 +673,7 @@ def list_with_http_info( :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. :type fields: str - :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | + :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | :type filter: str :param offset: The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. :type offset: int @@ -741,7 +741,7 @@ def list_without_preload_content( Optional[StrictStr], Field( description= - " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | " + " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | " )] = None, offset: Annotated[ Optional[StrictInt], @@ -783,7 +783,7 @@ def list_without_preload_content( :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. :type fields: str - :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | + :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | :type filter: str :param offset: The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. :type offset: int diff --git a/src/dtc/api/topology_api.py b/src/dtc/api/topology_api.py new file mode 100644 index 0000000..f3fc9fa --- /dev/null +++ b/src/dtc/api/topology_api.py @@ -0,0 +1,1503 @@ +# coding: utf-8 + +""" + DNS DTC API + + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. + + The version of the OpenAPI document: v1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import warnings +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt +from typing import Any, Dict, List, Optional, Tuple, Union +from typing_extensions import Annotated + +from pydantic import Field, StrictInt, StrictStr +from typing import Optional +from typing_extensions import Annotated +from dtc.models.create_topology_response import CreateTopologyResponse +from dtc.models.list_topology_response import ListTopologyResponse +from dtc.models.read_topology_response import ReadTopologyResponse +from dtc.models.topology import Topology +from dtc.models.update_topology_response import UpdateTopologyResponse +from dtc import models + +from universal_ddi_client.api_client import ApiClient, RequestSerialized +from universal_ddi_client.api_response import ApiResponse +from universal_ddi_client.rest import RESTResponseType + + +class TopologyApi: + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None) -> None: + if api_client is None: + api_client = ApiClient.get_default() + self.api_client = api_client + + @validate_call + def create( + self, + body: Topology, + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> CreateTopologyResponse: + """Create the Topology object. + + Use this method to create a __Topology__ object. + + :param body: (required) + :type body: Topology + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_serialize(body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CreateTopologyResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + response_data.read() + return self.api_client.response_deserialize( + models=models, + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def create_with_http_info( + self, + body: Topology, + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[CreateTopologyResponse]: + """Create the Topology object. + + Use this method to create a __Topology__ object. + + :param body: (required) + :type body: Topology + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_serialize(body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CreateTopologyResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + response_data.read() + return self.api_client.response_deserialize( + models=models, + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def create_without_preload_content( + self, + body: Topology, + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Create the Topology object. + + Use this method to create a __Topology__ object. + + :param body: (required) + :type body: Topology + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._create_serialize(body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "CreateTopologyResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + return response_data.response + + def _create_serialize( + self, + body, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = {} + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if body is not None: + _body_params = body + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + ['application/json'])) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = ['ApiKeyAuth'] + + return self.api_client.param_serialize( + method='POST', + base_path='/api/ddi/v1', + resource_path='/dtc/topology', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth) + + @validate_call + def delete( + self, + id: Annotated[ + StrictStr, + Field(description= + "An application specific resource identity of a resource")], + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> None: + """Delete the Topology object. + + Use this method to delete a __Topology__ object. + + :param id: An application specific resource identity of a resource (required) + :type id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_serialize(id=id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + response_data.read() + return self.api_client.response_deserialize( + models=models, + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def delete_with_http_info( + self, + id: Annotated[ + StrictStr, + Field(description= + "An application specific resource identity of a resource")], + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[None]: + """Delete the Topology object. + + Use this method to delete a __Topology__ object. + + :param id: An application specific resource identity of a resource (required) + :type id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_serialize(id=id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + response_data.read() + return self.api_client.response_deserialize( + models=models, + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def delete_without_preload_content( + self, + id: Annotated[ + StrictStr, + Field(description= + "An application specific resource identity of a resource")], + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Delete the Topology object. + + Use this method to delete a __Topology__ object. + + :param id: An application specific resource identity of a resource (required) + :type id: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._delete_serialize(id=id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': None, + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + return response_data.response + + def _delete_serialize( + self, + id, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = {} + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = self.api_client.path_param_value('id', id) + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + + # authentication setting + _auth_settings: List[str] = ['ApiKeyAuth'] + + return self.api_client.param_serialize( + method='DELETE', + base_path='/api/ddi/v1', + resource_path='/dtc/topology/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth) + + @validate_call + def list( + self, + fields: Annotated[ + Optional[StrictStr], + Field( + description= + " A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. " + )] = None, + filter: Annotated[ + Optional[StrictStr], + Field( + description= + " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | " + )] = None, + offset: Annotated[ + Optional[StrictInt], + Field( + description= + " The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. " + )] = None, + limit: Annotated[ + Optional[StrictInt], + Field( + description= + " The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. " + )] = None, + page_token: Annotated[ + Optional[StrictStr], + Field( + description= + " The service-defined string used to identify a page of resources. A null value indicates the first page. " + )] = None, + order_by: Annotated[ + Optional[StrictStr], + Field( + description= + " A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. " + )] = None, + tfilter: Annotated[ + Optional[StrictStr], + Field(description="This parameter is used for filtering by tags." + )] = None, + torder_by: Annotated[ + Optional[StrictStr], + Field(description="This parameter is used for sorting by tags." + )] = None, + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ListTopologyResponse: + """Retrieve Topology objects. + + Use this method to retrieve __Topology__ objects. + + :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. + :type fields: str + :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | + :type filter: str + :param offset: The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. + :type offset: int + :param limit: The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. + :type limit: int + :param page_token: The service-defined string used to identify a page of resources. A null value indicates the first page. + :type page_token: str + :param order_by: A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. + :type order_by: str + :param tfilter: This parameter is used for filtering by tags. + :type tfilter: str + :param torder_by: This parameter is used for sorting by tags. + :type torder_by: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_serialize(fields=fields, + filter=filter, + offset=offset, + limit=limit, + page_token=page_token, + order_by=order_by, + tfilter=tfilter, + torder_by=torder_by, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ListTopologyResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + response_data.read() + return self.api_client.response_deserialize( + models=models, + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def list_with_http_info( + self, + fields: Annotated[ + Optional[StrictStr], + Field( + description= + " A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. " + )] = None, + filter: Annotated[ + Optional[StrictStr], + Field( + description= + " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | " + )] = None, + offset: Annotated[ + Optional[StrictInt], + Field( + description= + " The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. " + )] = None, + limit: Annotated[ + Optional[StrictInt], + Field( + description= + " The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. " + )] = None, + page_token: Annotated[ + Optional[StrictStr], + Field( + description= + " The service-defined string used to identify a page of resources. A null value indicates the first page. " + )] = None, + order_by: Annotated[ + Optional[StrictStr], + Field( + description= + " A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. " + )] = None, + tfilter: Annotated[ + Optional[StrictStr], + Field(description="This parameter is used for filtering by tags." + )] = None, + torder_by: Annotated[ + Optional[StrictStr], + Field(description="This parameter is used for sorting by tags." + )] = None, + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ListTopologyResponse]: + """Retrieve Topology objects. + + Use this method to retrieve __Topology__ objects. + + :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. + :type fields: str + :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | + :type filter: str + :param offset: The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. + :type offset: int + :param limit: The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. + :type limit: int + :param page_token: The service-defined string used to identify a page of resources. A null value indicates the first page. + :type page_token: str + :param order_by: A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. + :type order_by: str + :param tfilter: This parameter is used for filtering by tags. + :type tfilter: str + :param torder_by: This parameter is used for sorting by tags. + :type torder_by: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_serialize(fields=fields, + filter=filter, + offset=offset, + limit=limit, + page_token=page_token, + order_by=order_by, + tfilter=tfilter, + torder_by=torder_by, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ListTopologyResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + response_data.read() + return self.api_client.response_deserialize( + models=models, + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def list_without_preload_content( + self, + fields: Annotated[ + Optional[StrictStr], + Field( + description= + " A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. " + )] = None, + filter: Annotated[ + Optional[StrictStr], + Field( + description= + " A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | " + )] = None, + offset: Annotated[ + Optional[StrictInt], + Field( + description= + " The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. " + )] = None, + limit: Annotated[ + Optional[StrictInt], + Field( + description= + " The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. " + )] = None, + page_token: Annotated[ + Optional[StrictStr], + Field( + description= + " The service-defined string used to identify a page of resources. A null value indicates the first page. " + )] = None, + order_by: Annotated[ + Optional[StrictStr], + Field( + description= + " A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. " + )] = None, + tfilter: Annotated[ + Optional[StrictStr], + Field(description="This parameter is used for filtering by tags." + )] = None, + torder_by: Annotated[ + Optional[StrictStr], + Field(description="This parameter is used for sorting by tags." + )] = None, + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve Topology objects. + + Use this method to retrieve __Topology__ objects. + + :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. + :type fields: str + :param filter: A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | + :type filter: str + :param offset: The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. + :type offset: int + :param limit: The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. + :type limit: int + :param page_token: The service-defined string used to identify a page of resources. A null value indicates the first page. + :type page_token: str + :param order_by: A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. + :type order_by: str + :param tfilter: This parameter is used for filtering by tags. + :type tfilter: str + :param torder_by: This parameter is used for sorting by tags. + :type torder_by: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._list_serialize(fields=fields, + filter=filter, + offset=offset, + limit=limit, + page_token=page_token, + order_by=order_by, + tfilter=tfilter, + torder_by=torder_by, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ListTopologyResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + return response_data.response + + def _list_serialize( + self, + fields, + filter, + offset, + limit, + page_token, + order_by, + tfilter, + torder_by, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = {} + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + # process the query parameters + if fields is not None: + + _query_params.append(('_fields', fields)) + + if filter is not None: + + _query_params.append(('_filter', filter)) + + if offset is not None: + + _query_params.append(('_offset', offset)) + + if limit is not None: + + _query_params.append(('_limit', limit)) + + if page_token is not None: + + _query_params.append(('_page_token', page_token)) + + if order_by is not None: + + _query_params.append(('_order_by', order_by)) + + if tfilter is not None: + + _query_params.append(('_tfilter', tfilter)) + + if torder_by is not None: + + _query_params.append(('_torder_by', torder_by)) + + # process the header parameters + # process the form parameters + # process the body parameter + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) + + # authentication setting + _auth_settings: List[str] = ['ApiKeyAuth'] + + return self.api_client.param_serialize( + method='GET', + base_path='/api/ddi/v1', + resource_path='/dtc/topology', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth) + + @validate_call + def read( + self, + id: Annotated[ + StrictStr, + Field(description= + "An application specific resource identity of a resource")], + fields: Annotated[ + Optional[StrictStr], + Field( + description= + " A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. " + )] = None, + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ReadTopologyResponse: + """Retrieve the Topology object. + + Use this method to retrieve a __Topology__ object. + + :param id: An application specific resource identity of a resource (required) + :type id: str + :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. + :type fields: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._read_serialize(id=id, + fields=fields, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ReadTopologyResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + response_data.read() + return self.api_client.response_deserialize( + models=models, + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def read_with_http_info( + self, + id: Annotated[ + StrictStr, + Field(description= + "An application specific resource identity of a resource")], + fields: Annotated[ + Optional[StrictStr], + Field( + description= + " A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. " + )] = None, + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[ReadTopologyResponse]: + """Retrieve the Topology object. + + Use this method to retrieve a __Topology__ object. + + :param id: An application specific resource identity of a resource (required) + :type id: str + :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. + :type fields: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._read_serialize(id=id, + fields=fields, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ReadTopologyResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + response_data.read() + return self.api_client.response_deserialize( + models=models, + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def read_without_preload_content( + self, + id: Annotated[ + StrictStr, + Field(description= + "An application specific resource identity of a resource")], + fields: Annotated[ + Optional[StrictStr], + Field( + description= + " A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. " + )] = None, + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Retrieve the Topology object. + + Use this method to retrieve a __Topology__ object. + + :param id: An application specific resource identity of a resource (required) + :type id: str + :param fields: A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. + :type fields: str + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._read_serialize(id=id, + fields=fields, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "ReadTopologyResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + return response_data.response + + def _read_serialize( + self, + id, + fields, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = {} + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = self.api_client.path_param_value('id', id) + # process the query parameters + if fields is not None: + + _query_params.append(('_fields', fields)) + + # process the header parameters + # process the form parameters + # process the body parameter + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) + + # authentication setting + _auth_settings: List[str] = ['ApiKeyAuth'] + + return self.api_client.param_serialize( + method='GET', + base_path='/api/ddi/v1', + resource_path='/dtc/topology/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth) + + @validate_call + def update( + self, + id: Annotated[ + StrictStr, + Field(description= + "An application specific resource identity of a resource")], + body: Topology, + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> UpdateTopologyResponse: + """Update the Topology object. + + Use this method to update a __Topology__ object. + + :param id: An application specific resource identity of a resource (required) + :type id: str + :param body: (required) + :type body: Topology + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_serialize(id=id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UpdateTopologyResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + response_data.read() + return self.api_client.response_deserialize( + models=models, + response_data=response_data, + response_types_map=_response_types_map, + ).data + + @validate_call + def update_with_http_info( + self, + id: Annotated[ + StrictStr, + Field(description= + "An application specific resource identity of a resource")], + body: Topology, + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[UpdateTopologyResponse]: + """Update the Topology object. + + Use this method to update a __Topology__ object. + + :param id: An application specific resource identity of a resource (required) + :type id: str + :param body: (required) + :type body: Topology + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_serialize(id=id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UpdateTopologyResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + response_data.read() + return self.api_client.response_deserialize( + models=models, + response_data=response_data, + response_types_map=_response_types_map, + ) + + @validate_call + def update_without_preload_content( + self, + id: Annotated[ + StrictStr, + Field(description= + "An application specific resource identity of a resource")], + body: Topology, + _request_timeout: Union[None, Annotated[StrictFloat, + Field(gt=0)], + Tuple[Annotated[StrictFloat, + Field(gt=0)], + Annotated[StrictFloat, + Field(gt=0)]]] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Update the Topology object. + + Use this method to update a __Topology__ object. + + :param id: An application specific resource identity of a resource (required) + :type id: str + :param body: (required) + :type body: Topology + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._update_serialize(id=id, + body=body, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "UpdateTopologyResponse", + } + response_data = self.api_client.call_api( + *_param, _request_timeout=_request_timeout) + return response_data.response + + def _update_serialize( + self, + id, + body, + _request_auth, + _content_type, + _headers, + _host_index, + ) -> RequestSerialized: + + _host = None + + _collection_formats: Dict[str, str] = {} + + _path_params: Dict[str, str] = {} + _query_params: List[Tuple[str, str]] = [] + _header_params: Dict[str, Optional[str]] = _headers or {} + _form_params: List[Tuple[str, str]] = [] + _files: Dict[str, Union[str, bytes]] = {} + _body_params: Optional[bytes] = None + + # process the path parameters + if id is not None: + _path_params['id'] = self.api_client.path_param_value('id', id) + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if body is not None: + _body_params = body + + # set the HTTP header `Accept` + _header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) + + # set the HTTP header `Content-Type` + if _content_type: + _header_params['Content-Type'] = _content_type + else: + _default_content_type = ( + self.api_client.select_header_content_type( + ['application/json'])) + if _default_content_type is not None: + _header_params['Content-Type'] = _default_content_type + + # authentication setting + _auth_settings: List[str] = ['ApiKeyAuth'] + + return self.api_client.param_serialize( + method='PATCH', + base_path='/api/ddi/v1', + resource_path='/dtc/topology/{id}', + path_params=_path_params, + query_params=_query_params, + header_params=_header_params, + body=_body_params, + post_params=_form_params, + files=_files, + auth_settings=_auth_settings, + collection_formats=_collection_formats, + _host=_host, + _request_auth=_request_auth) diff --git a/src/dtc/docs/ConsolidatedHealthCheck.md b/src/dtc/docs/ConsolidatedHealthCheck.md new file mode 100644 index 0000000..18a5106 --- /dev/null +++ b/src/dtc/docs/ConsolidatedHealthCheck.md @@ -0,0 +1,30 @@ +# ConsolidatedHealthCheck + +When set, the DNS server running the named designator __DNS Service__ performs the health check on behalf of the __Pool__, and the result is shared with other DNS servers linked to the __Pool__ via __LBDN__ association. When unset, each DNS server performs the health check independently and no health status is shared. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**designators** | [**List[DesignatorService]**](DesignatorService.md) | Designator __DNS Service__ references where the corresponding health checks will be associated to. Must contain at least one entry when set. On request: only _dns_service_id_ is honoured. On response: _dns_service_name_ is echoed alongside, resolved from inventory. | [optional] + +## Example + +```python +from dtc.models.consolidated_health_check import ConsolidatedHealthCheck + +# TODO update the JSON string below +json = "{}" +# create an instance of ConsolidatedHealthCheck from a JSON string +consolidated_health_check_instance = ConsolidatedHealthCheck.from_json(json) +# print the JSON string representation of the object +print(ConsolidatedHealthCheck.to_json()) + +# convert the object into a dict +consolidated_health_check_dict = consolidated_health_check_instance.to_dict() +# create an instance of ConsolidatedHealthCheck from a dict +consolidated_health_check_from_dict = ConsolidatedHealthCheck.from_dict(consolidated_health_check_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/src/dtc/docs/CreatePDPHealthCheckResponse.md b/src/dtc/docs/CreatePDPHealthCheckResponse.md new file mode 100644 index 0000000..476810c --- /dev/null +++ b/src/dtc/docs/CreatePDPHealthCheckResponse.md @@ -0,0 +1,30 @@ +# CreatePDPHealthCheckResponse + +The __PDPHealthCheck__ object create response format. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**result** | [**PDPHealthCheck**](PDPHealthCheck.md) | The created __PDPHealthCheck__ object. | [optional] + +## Example + +```python +from dtc.models.create_pdp_health_check_response import CreatePDPHealthCheckResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of CreatePDPHealthCheckResponse from a JSON string +create_pdp_health_check_response_instance = CreatePDPHealthCheckResponse.from_json(json) +# print the JSON string representation of the object +print(CreatePDPHealthCheckResponse.to_json()) + +# convert the object into a dict +create_pdp_health_check_response_dict = create_pdp_health_check_response_instance.to_dict() +# create an instance of CreatePDPHealthCheckResponse from a dict +create_pdp_health_check_response_from_dict = CreatePDPHealthCheckResponse.from_dict(create_pdp_health_check_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/src/dtc/docs/CreateSIPHealthCheckResponse.md b/src/dtc/docs/CreateSIPHealthCheckResponse.md new file mode 100644 index 0000000..fdfd22c --- /dev/null +++ b/src/dtc/docs/CreateSIPHealthCheckResponse.md @@ -0,0 +1,30 @@ +# CreateSIPHealthCheckResponse + +The __SIPHealthCheck__ object create response format. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**result** | [**SIPHealthCheck**](SIPHealthCheck.md) | The created __SIPHealthCheck__ object. | [optional] + +## Example + +```python +from dtc.models.create_sip_health_check_response import CreateSIPHealthCheckResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of CreateSIPHealthCheckResponse from a JSON string +create_sip_health_check_response_instance = CreateSIPHealthCheckResponse.from_json(json) +# print the JSON string representation of the object +print(CreateSIPHealthCheckResponse.to_json()) + +# convert the object into a dict +create_sip_health_check_response_dict = create_sip_health_check_response_instance.to_dict() +# create an instance of CreateSIPHealthCheckResponse from a dict +create_sip_health_check_response_from_dict = CreateSIPHealthCheckResponse.from_dict(create_sip_health_check_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/src/dtc/docs/CreateTopologyResponse.md b/src/dtc/docs/CreateTopologyResponse.md new file mode 100644 index 0000000..e026e20 --- /dev/null +++ b/src/dtc/docs/CreateTopologyResponse.md @@ -0,0 +1,30 @@ +# CreateTopologyResponse + +The __Topology__ object create response format. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**result** | [**Topology**](Topology.md) | The created __Topology__ object. | [optional] + +## Example + +```python +from dtc.models.create_topology_response import CreateTopologyResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of CreateTopologyResponse from a JSON string +create_topology_response_instance = CreateTopologyResponse.from_json(json) +# print the JSON string representation of the object +print(CreateTopologyResponse.to_json()) + +# convert the object into a dict +create_topology_response_dict = create_topology_response_instance.to_dict() +# create an instance of CreateTopologyResponse from a dict +create_topology_response_from_dict = CreateTopologyResponse.from_dict(create_topology_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/src/dtc/docs/DesignatorService.md b/src/dtc/docs/DesignatorService.md new file mode 100644 index 0000000..14932bd --- /dev/null +++ b/src/dtc/docs/DesignatorService.md @@ -0,0 +1,31 @@ +# DesignatorService + +Reference to a __DNS Service__ that acts as a designator for a __ConsolidatedHealthCheck__. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**dns_service_id** | **str** | The resource identifier. | +**dns_service_name** | **str** | Display name of the __DNS Service__. Response-only; ignored on request. | [optional] [readonly] + +## Example + +```python +from dtc.models.designator_service import DesignatorService + +# TODO update the JSON string below +json = "{}" +# create an instance of DesignatorService from a JSON string +designator_service_instance = DesignatorService.from_json(json) +# print the JSON string representation of the object +print(DesignatorService.to_json()) + +# convert the object into a dict +designator_service_dict = designator_service_instance.to_dict() +# create an instance of DesignatorService from a dict +designator_service_from_dict = DesignatorService.from_dict(designator_service_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/src/dtc/docs/HealthCheckHttpApi.md b/src/dtc/docs/HealthCheckHttpApi.md index 7adff13..adf102f 100644 --- a/src/dtc/docs/HealthCheckHttpApi.md +++ b/src/dtc/docs/HealthCheckHttpApi.md @@ -214,7 +214,7 @@ with ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **fields** | **str**| A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | [optional] - **filter** | **str**| A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | [optional] + **filter** | **str**| A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | | [optional] **offset** | **int**| The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | [optional] **limit** | **int**| The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | [optional] **page_token** | **str**| The service-defined string used to identify a page of resources. A null value indicates the first page. | [optional] diff --git a/src/dtc/docs/HealthCheckIcmpApi.md b/src/dtc/docs/HealthCheckIcmpApi.md index 3318007..b5a54a4 100644 --- a/src/dtc/docs/HealthCheckIcmpApi.md +++ b/src/dtc/docs/HealthCheckIcmpApi.md @@ -214,7 +214,7 @@ with ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **fields** | **str**| A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | [optional] - **filter** | **str**| A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | [optional] + **filter** | **str**| A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | | [optional] **offset** | **int**| The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | [optional] **limit** | **int**| The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | [optional] **page_token** | **str**| The service-defined string used to identify a page of resources. A null value indicates the first page. | [optional] diff --git a/src/dtc/docs/HealthCheckPdpApi.md b/src/dtc/docs/HealthCheckPdpApi.md new file mode 100644 index 0000000..66815ff --- /dev/null +++ b/src/dtc/docs/HealthCheckPdpApi.md @@ -0,0 +1,400 @@ +# dtc.HealthCheckPdpApi + +All URIs are relative to *http://localhost/api/ddi/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create**](HealthCheckPdpApi.md#create) | **POST** /dtc/health_check_pdp | Create the PDPHealthCheck object. +[**delete**](HealthCheckPdpApi.md#delete) | **DELETE** /dtc/health_check_pdp/{id} | Delete the PDPHealthCheck object. +[**list**](HealthCheckPdpApi.md#list) | **GET** /dtc/health_check_pdp | Retrieve PDPHealthCheck objects. +[**read**](HealthCheckPdpApi.md#read) | **GET** /dtc/health_check_pdp/{id} | Retrieve the PDPHealthCheck object. +[**update**](HealthCheckPdpApi.md#update) | **PATCH** /dtc/health_check_pdp/{id} | Update the PDPHealthCheck object. + + +# **create** +> CreatePDPHealthCheckResponse create(body) + +Create the PDPHealthCheck object. + +Use this method to create a __PDPHealthCheck__ object. + +### Example + +* Api Key Authentication (ApiKeyAuth): +```python +import os +from pprint import pprint + +import dtc + +from universal_ddi_client.api_client import ApiClient +from universal_ddi_client.configuration import Configuration + +# Defining the Portal URL is optional and defaults to "https://csp.infoblox.com" +# See configuration.py for a list of all supported configuration parameters. +configuration = Configuration( + portal_url = os.getenv('INFOBLOX_PORTAL_URL'), +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. + +# Configure Portal key authorization: ApiKeyAuth +configuration.portal_key = os.getenv("INFOBLOX_PORTAL_KEY") + +# Enter a context with an instance of the API client +with ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = dtc.HealthCheckPdpApi(api_client) + body = dtc.PDPHealthCheck() # PDPHealthCheck | + + try: + # Create the PDPHealthCheck object. + api_response = api_instance.create(body) + pprint("The response of HealthCheckPdpApi->create:\n") + pprint(api_response) + except Exception as e: + pprint("Exception when calling HealthCheckPdpApi->create: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**PDPHealthCheck**](PDPHealthCheck.md)| | + +### Return type + +[**CreatePDPHealthCheckResponse**](CreatePDPHealthCheckResponse.md) + +### Authorization + +[ApiKeyAuth](../README.md#ApiKeyAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | POST operation response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete** +> delete(id) + +Delete the PDPHealthCheck object. + +Use this method to delete a __PDPHealthCheck__ object. + +### Example + +* Api Key Authentication (ApiKeyAuth): +```python +import os +from pprint import pprint + +import dtc + +from universal_ddi_client.api_client import ApiClient +from universal_ddi_client.configuration import Configuration + +# Defining the Portal URL is optional and defaults to "https://csp.infoblox.com" +# See configuration.py for a list of all supported configuration parameters. +configuration = Configuration( + portal_url = os.getenv('INFOBLOX_PORTAL_URL'), +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. + +# Configure Portal key authorization: ApiKeyAuth +configuration.portal_key = os.getenv("INFOBLOX_PORTAL_KEY") + +# Enter a context with an instance of the API client +with ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = dtc.HealthCheckPdpApi(api_client) + id = 'id_example' # str | An application specific resource identity of a resource + + try: + # Delete the PDPHealthCheck object. + api_instance.delete(id) + except Exception as e: + pprint("Exception when calling HealthCheckPdpApi->delete: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| An application specific resource identity of a resource | + +### Return type + +void (empty response body) + +### Authorization + +[ApiKeyAuth](../README.md#ApiKeyAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list** +> ListPDPHealthCheckResponse list(fields=fields, filter=filter, offset=offset, limit=limit, page_token=page_token, order_by=order_by, tfilter=tfilter, torder_by=torder_by) + +Retrieve PDPHealthCheck objects. + +Use this method to retrieve __PDPHealthCheck__ objects. + +### Example + +* Api Key Authentication (ApiKeyAuth): +```python +import os +from pprint import pprint + +import dtc + +from universal_ddi_client.api_client import ApiClient +from universal_ddi_client.configuration import Configuration + +# Defining the Portal URL is optional and defaults to "https://csp.infoblox.com" +# See configuration.py for a list of all supported configuration parameters. +configuration = Configuration( + portal_url = os.getenv('INFOBLOX_PORTAL_URL'), +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. + +# Configure Portal key authorization: ApiKeyAuth +configuration.portal_key = os.getenv("INFOBLOX_PORTAL_KEY") + +# Enter a context with an instance of the API client +with ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = dtc.HealthCheckPdpApi(api_client) + + try: + # Retrieve PDPHealthCheck objects. + api_response = api_instance.list() + pprint("The response of HealthCheckPdpApi->list:\n") + pprint(api_response) + except Exception as e: + pprint("Exception when calling HealthCheckPdpApi->list: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **fields** | **str**| A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | [optional] + **filter** | **str**| A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | | [optional] + **offset** | **int**| The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | [optional] + **limit** | **int**| The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | [optional] + **page_token** | **str**| The service-defined string used to identify a page of resources. A null value indicates the first page. | [optional] + **order_by** | **str**| A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | [optional] + **tfilter** | **str**| This parameter is used for filtering by tags. | [optional] + **torder_by** | **str**| This parameter is used for sorting by tags. | [optional] + +### Return type + +[**ListPDPHealthCheckResponse**](ListPDPHealthCheckResponse.md) + +### Authorization + +[ApiKeyAuth](../README.md#ApiKeyAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | GET operation response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **read** +> ReadPDPHealthCheckResponse read(id, fields=fields) + +Retrieve the PDPHealthCheck object. + +Use this method to retrieve a __PDPHealthCheck__ object. + +### Example + +* Api Key Authentication (ApiKeyAuth): +```python +import os +from pprint import pprint + +import dtc + +from universal_ddi_client.api_client import ApiClient +from universal_ddi_client.configuration import Configuration + +# Defining the Portal URL is optional and defaults to "https://csp.infoblox.com" +# See configuration.py for a list of all supported configuration parameters. +configuration = Configuration( + portal_url = os.getenv('INFOBLOX_PORTAL_URL'), +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. + +# Configure Portal key authorization: ApiKeyAuth +configuration.portal_key = os.getenv("INFOBLOX_PORTAL_KEY") + +# Enter a context with an instance of the API client +with ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = dtc.HealthCheckPdpApi(api_client) + id = 'id_example' # str | An application specific resource identity of a resource + + try: + # Retrieve the PDPHealthCheck object. + api_response = api_instance.read(id) + pprint("The response of HealthCheckPdpApi->read:\n") + pprint(api_response) + except Exception as e: + pprint("Exception when calling HealthCheckPdpApi->read: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| An application specific resource identity of a resource | + **fields** | **str**| A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | [optional] + +### Return type + +[**ReadPDPHealthCheckResponse**](ReadPDPHealthCheckResponse.md) + +### Authorization + +[ApiKeyAuth](../README.md#ApiKeyAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | GET operation response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update** +> UpdatePDPHealthCheckResponse update(id, body) + +Update the PDPHealthCheck object. + +Use this method to update a __PDPHealthCheck__ object. + +### Example + +* Api Key Authentication (ApiKeyAuth): +```python +import os +from pprint import pprint + +import dtc + +from universal_ddi_client.api_client import ApiClient +from universal_ddi_client.configuration import Configuration + +# Defining the Portal URL is optional and defaults to "https://csp.infoblox.com" +# See configuration.py for a list of all supported configuration parameters. +configuration = Configuration( + portal_url = os.getenv('INFOBLOX_PORTAL_URL'), +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. + +# Configure Portal key authorization: ApiKeyAuth +configuration.portal_key = os.getenv("INFOBLOX_PORTAL_KEY") + +# Enter a context with an instance of the API client +with ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = dtc.HealthCheckPdpApi(api_client) + id = 'id_example' # str | An application specific resource identity of a resource + body = dtc.PDPHealthCheck() # PDPHealthCheck | + + try: + # Update the PDPHealthCheck object. + api_response = api_instance.update(id, body) + pprint("The response of HealthCheckPdpApi->update:\n") + pprint(api_response) + except Exception as e: + pprint("Exception when calling HealthCheckPdpApi->update: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| An application specific resource identity of a resource | + **body** | [**PDPHealthCheck**](PDPHealthCheck.md)| | + +### Return type + +[**UpdatePDPHealthCheckResponse**](UpdatePDPHealthCheckResponse.md) + +### Authorization + +[ApiKeyAuth](../README.md#ApiKeyAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | PATCH operation response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/src/dtc/docs/HealthCheckSipApi.md b/src/dtc/docs/HealthCheckSipApi.md new file mode 100644 index 0000000..a749b61 --- /dev/null +++ b/src/dtc/docs/HealthCheckSipApi.md @@ -0,0 +1,400 @@ +# dtc.HealthCheckSipApi + +All URIs are relative to *http://localhost/api/ddi/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create**](HealthCheckSipApi.md#create) | **POST** /dtc/health_check_sip | Create the SIPHealthCheck object. +[**delete**](HealthCheckSipApi.md#delete) | **DELETE** /dtc/health_check_sip/{id} | Delete the SIPHealthCheck object. +[**list**](HealthCheckSipApi.md#list) | **GET** /dtc/health_check_sip | Retrieve SIPHealthCheck objects. +[**read**](HealthCheckSipApi.md#read) | **GET** /dtc/health_check_sip/{id} | Retrieve the SIPHealthCheck object. +[**update**](HealthCheckSipApi.md#update) | **PATCH** /dtc/health_check_sip/{id} | Update the SIPHealthCheck object. + + +# **create** +> CreateSIPHealthCheckResponse create(body) + +Create the SIPHealthCheck object. + +Use this method to create a __SIPHealthCheck__ object. + +### Example + +* Api Key Authentication (ApiKeyAuth): +```python +import os +from pprint import pprint + +import dtc + +from universal_ddi_client.api_client import ApiClient +from universal_ddi_client.configuration import Configuration + +# Defining the Portal URL is optional and defaults to "https://csp.infoblox.com" +# See configuration.py for a list of all supported configuration parameters. +configuration = Configuration( + portal_url = os.getenv('INFOBLOX_PORTAL_URL'), +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. + +# Configure Portal key authorization: ApiKeyAuth +configuration.portal_key = os.getenv("INFOBLOX_PORTAL_KEY") + +# Enter a context with an instance of the API client +with ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = dtc.HealthCheckSipApi(api_client) + body = dtc.SIPHealthCheck() # SIPHealthCheck | + + try: + # Create the SIPHealthCheck object. + api_response = api_instance.create(body) + pprint("The response of HealthCheckSipApi->create:\n") + pprint(api_response) + except Exception as e: + pprint("Exception when calling HealthCheckSipApi->create: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**SIPHealthCheck**](SIPHealthCheck.md)| | + +### Return type + +[**CreateSIPHealthCheckResponse**](CreateSIPHealthCheckResponse.md) + +### Authorization + +[ApiKeyAuth](../README.md#ApiKeyAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | POST operation response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete** +> delete(id) + +Delete the SIPHealthCheck object. + +Use this method to delete a __SIPHealthCheck__ object. + +### Example + +* Api Key Authentication (ApiKeyAuth): +```python +import os +from pprint import pprint + +import dtc + +from universal_ddi_client.api_client import ApiClient +from universal_ddi_client.configuration import Configuration + +# Defining the Portal URL is optional and defaults to "https://csp.infoblox.com" +# See configuration.py for a list of all supported configuration parameters. +configuration = Configuration( + portal_url = os.getenv('INFOBLOX_PORTAL_URL'), +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. + +# Configure Portal key authorization: ApiKeyAuth +configuration.portal_key = os.getenv("INFOBLOX_PORTAL_KEY") + +# Enter a context with an instance of the API client +with ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = dtc.HealthCheckSipApi(api_client) + id = 'id_example' # str | An application specific resource identity of a resource + + try: + # Delete the SIPHealthCheck object. + api_instance.delete(id) + except Exception as e: + pprint("Exception when calling HealthCheckSipApi->delete: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| An application specific resource identity of a resource | + +### Return type + +void (empty response body) + +### Authorization + +[ApiKeyAuth](../README.md#ApiKeyAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list** +> ListSIPHealthCheckResponse list(fields=fields, filter=filter, offset=offset, limit=limit, page_token=page_token, order_by=order_by, tfilter=tfilter, torder_by=torder_by) + +Retrieve SIPHealthCheck objects. + +Use this method to retrieve __SIPHealthCheck__ objects. + +### Example + +* Api Key Authentication (ApiKeyAuth): +```python +import os +from pprint import pprint + +import dtc + +from universal_ddi_client.api_client import ApiClient +from universal_ddi_client.configuration import Configuration + +# Defining the Portal URL is optional and defaults to "https://csp.infoblox.com" +# See configuration.py for a list of all supported configuration parameters. +configuration = Configuration( + portal_url = os.getenv('INFOBLOX_PORTAL_URL'), +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. + +# Configure Portal key authorization: ApiKeyAuth +configuration.portal_key = os.getenv("INFOBLOX_PORTAL_KEY") + +# Enter a context with an instance of the API client +with ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = dtc.HealthCheckSipApi(api_client) + + try: + # Retrieve SIPHealthCheck objects. + api_response = api_instance.list() + pprint("The response of HealthCheckSipApi->list:\n") + pprint(api_response) + except Exception as e: + pprint("Exception when calling HealthCheckSipApi->list: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **fields** | **str**| A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | [optional] + **filter** | **str**| A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | | [optional] + **offset** | **int**| The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | [optional] + **limit** | **int**| The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | [optional] + **page_token** | **str**| The service-defined string used to identify a page of resources. A null value indicates the first page. | [optional] + **order_by** | **str**| A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | [optional] + **tfilter** | **str**| This parameter is used for filtering by tags. | [optional] + **torder_by** | **str**| This parameter is used for sorting by tags. | [optional] + +### Return type + +[**ListSIPHealthCheckResponse**](ListSIPHealthCheckResponse.md) + +### Authorization + +[ApiKeyAuth](../README.md#ApiKeyAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | GET operation response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **read** +> ReadSIPHealthCheckResponse read(id, fields=fields) + +Retrieve the SIPHealthCheck object. + +Use this method to retrieve a __SIPHealthCheck__ object. + +### Example + +* Api Key Authentication (ApiKeyAuth): +```python +import os +from pprint import pprint + +import dtc + +from universal_ddi_client.api_client import ApiClient +from universal_ddi_client.configuration import Configuration + +# Defining the Portal URL is optional and defaults to "https://csp.infoblox.com" +# See configuration.py for a list of all supported configuration parameters. +configuration = Configuration( + portal_url = os.getenv('INFOBLOX_PORTAL_URL'), +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. + +# Configure Portal key authorization: ApiKeyAuth +configuration.portal_key = os.getenv("INFOBLOX_PORTAL_KEY") + +# Enter a context with an instance of the API client +with ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = dtc.HealthCheckSipApi(api_client) + id = 'id_example' # str | An application specific resource identity of a resource + + try: + # Retrieve the SIPHealthCheck object. + api_response = api_instance.read(id) + pprint("The response of HealthCheckSipApi->read:\n") + pprint(api_response) + except Exception as e: + pprint("Exception when calling HealthCheckSipApi->read: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| An application specific resource identity of a resource | + **fields** | **str**| A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | [optional] + +### Return type + +[**ReadSIPHealthCheckResponse**](ReadSIPHealthCheckResponse.md) + +### Authorization + +[ApiKeyAuth](../README.md#ApiKeyAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | GET operation response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update** +> UpdateSIPHealthCheckResponse update(id, body) + +Update the SIPHealthCheck object. + +Use this method to update a __SIPHealthCheck__ object. + +### Example + +* Api Key Authentication (ApiKeyAuth): +```python +import os +from pprint import pprint + +import dtc + +from universal_ddi_client.api_client import ApiClient +from universal_ddi_client.configuration import Configuration + +# Defining the Portal URL is optional and defaults to "https://csp.infoblox.com" +# See configuration.py for a list of all supported configuration parameters. +configuration = Configuration( + portal_url = os.getenv('INFOBLOX_PORTAL_URL'), +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. + +# Configure Portal key authorization: ApiKeyAuth +configuration.portal_key = os.getenv("INFOBLOX_PORTAL_KEY") + +# Enter a context with an instance of the API client +with ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = dtc.HealthCheckSipApi(api_client) + id = 'id_example' # str | An application specific resource identity of a resource + body = dtc.SIPHealthCheck() # SIPHealthCheck | + + try: + # Update the SIPHealthCheck object. + api_response = api_instance.update(id, body) + pprint("The response of HealthCheckSipApi->update:\n") + pprint(api_response) + except Exception as e: + pprint("Exception when calling HealthCheckSipApi->update: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| An application specific resource identity of a resource | + **body** | [**SIPHealthCheck**](SIPHealthCheck.md)| | + +### Return type + +[**UpdateSIPHealthCheckResponse**](UpdateSIPHealthCheckResponse.md) + +### Authorization + +[ApiKeyAuth](../README.md#ApiKeyAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | PATCH operation response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/src/dtc/docs/HealthCheckSnmpApi.md b/src/dtc/docs/HealthCheckSnmpApi.md index 955aaff..10f1aea 100644 --- a/src/dtc/docs/HealthCheckSnmpApi.md +++ b/src/dtc/docs/HealthCheckSnmpApi.md @@ -214,7 +214,7 @@ with ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **fields** | **str**| A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | [optional] - **filter** | **str**| A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | [optional] + **filter** | **str**| A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | | [optional] **offset** | **int**| The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | [optional] **limit** | **int**| The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | [optional] **page_token** | **str**| The service-defined string used to identify a page of resources. A null value indicates the first page. | [optional] diff --git a/src/dtc/docs/HealthCheckTcpApi.md b/src/dtc/docs/HealthCheckTcpApi.md index 427bbc8..0387930 100644 --- a/src/dtc/docs/HealthCheckTcpApi.md +++ b/src/dtc/docs/HealthCheckTcpApi.md @@ -214,7 +214,7 @@ with ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **fields** | **str**| A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | [optional] - **filter** | **str**| A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | [optional] + **filter** | **str**| A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | | [optional] **offset** | **int**| The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | [optional] **limit** | **int**| The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | [optional] **page_token** | **str**| The service-defined string used to identify a page of resources. A null value indicates the first page. | [optional] diff --git a/src/dtc/docs/ListPDPHealthCheckResponse.md b/src/dtc/docs/ListPDPHealthCheckResponse.md new file mode 100644 index 0000000..1dde972 --- /dev/null +++ b/src/dtc/docs/ListPDPHealthCheckResponse.md @@ -0,0 +1,30 @@ +# ListPDPHealthCheckResponse + +The __PDPHealthCheck__ object list response format. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**results** | [**List[PDPHealthCheck]**](PDPHealthCheck.md) | List of __PDPHealthCheck__ objects. | [optional] + +## Example + +```python +from dtc.models.list_pdp_health_check_response import ListPDPHealthCheckResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of ListPDPHealthCheckResponse from a JSON string +list_pdp_health_check_response_instance = ListPDPHealthCheckResponse.from_json(json) +# print the JSON string representation of the object +print(ListPDPHealthCheckResponse.to_json()) + +# convert the object into a dict +list_pdp_health_check_response_dict = list_pdp_health_check_response_instance.to_dict() +# create an instance of ListPDPHealthCheckResponse from a dict +list_pdp_health_check_response_from_dict = ListPDPHealthCheckResponse.from_dict(list_pdp_health_check_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/src/dtc/docs/ListSIPHealthCheckResponse.md b/src/dtc/docs/ListSIPHealthCheckResponse.md new file mode 100644 index 0000000..a08d201 --- /dev/null +++ b/src/dtc/docs/ListSIPHealthCheckResponse.md @@ -0,0 +1,30 @@ +# ListSIPHealthCheckResponse + +The __SIPHealthCheck__ object list response format. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**results** | [**List[SIPHealthCheck]**](SIPHealthCheck.md) | List of __SIPHealthCheck__ objects. | [optional] + +## Example + +```python +from dtc.models.list_sip_health_check_response import ListSIPHealthCheckResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of ListSIPHealthCheckResponse from a JSON string +list_sip_health_check_response_instance = ListSIPHealthCheckResponse.from_json(json) +# print the JSON string representation of the object +print(ListSIPHealthCheckResponse.to_json()) + +# convert the object into a dict +list_sip_health_check_response_dict = list_sip_health_check_response_instance.to_dict() +# create an instance of ListSIPHealthCheckResponse from a dict +list_sip_health_check_response_from_dict = ListSIPHealthCheckResponse.from_dict(list_sip_health_check_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/src/dtc/docs/ListTopologyResponse.md b/src/dtc/docs/ListTopologyResponse.md new file mode 100644 index 0000000..4fb0ad9 --- /dev/null +++ b/src/dtc/docs/ListTopologyResponse.md @@ -0,0 +1,30 @@ +# ListTopologyResponse + +The __Topology__ object list response format. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**results** | [**List[Topology]**](Topology.md) | List of __Topology__ objects. | [optional] + +## Example + +```python +from dtc.models.list_topology_response import ListTopologyResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of ListTopologyResponse from a JSON string +list_topology_response_instance = ListTopologyResponse.from_json(json) +# print the JSON string representation of the object +print(ListTopologyResponse.to_json()) + +# convert the object into a dict +list_topology_response_dict = list_topology_response_instance.to_dict() +# create an instance of ListTopologyResponse from a dict +list_topology_response_from_dict = ListTopologyResponse.from_dict(list_topology_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/src/dtc/docs/PDPHealthCheck.md b/src/dtc/docs/PDPHealthCheck.md new file mode 100644 index 0000000..609522c --- /dev/null +++ b/src/dtc/docs/PDPHealthCheck.md @@ -0,0 +1,40 @@ +# PDPHealthCheck + +A __PDPHealthCheck__ (_dtc/health_check_pdp_) represents a DTC __Server__ health check that probes a Packet Data Protocol (PDP) endpoint by exchanging a GTPv1 Echo Request/Response over UDP. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **str** | Optional. Comment for __PDPHealthCheck__. | [optional] +**disabled** | **bool** | Optional. Flag which enables/disables __PDPHealthCheck__. Defaults to _false_. | [optional] +**id** | **str** | The resource identifier. | [optional] [readonly] +**interval** | **int** | Optional. Interval value in seconds. The health check runs only for the specified interval and it is measured from the beginning of the previous check cycle. Defaults to _15_. | [optional] +**metadata** | [**Metadata**](Metadata.md) | Output only. __PDPHealthCheck__ metadata. Defaults to empty object and should be explicitly requested using field selection. | [optional] +**name** | **str** | Display name of __PDPHealthCheck__. | +**port** | **int** | Optional. Destination UDP port of __PDPHealthCheck__ for the GTP Echo Request. Defaults to _2123_. | [optional] +**retry_down** | **int** | Optional. Retry down count. The value determines how many bad health checks in a row must be received by the onprem host from the DTC Server for treating the health check as failed. Defaults to _1_. | [optional] +**retry_up** | **int** | Optional. Retry up count. The value determines how many good health checks in a row must be received by the onprem host from the DTC Server for treating the health check as successful. Defaults to _1_. | [optional] +**tags** | **object** | Optional. The tags for __PDPHealthCheck__ in JSON format. | [optional] +**timeout** | **int** | Optional. Timeout value in seconds. The health check waits for the specified number of seconds after sending a request. If it does not receive a response within the number of seconds, then the health check is considered as failed. Defaults to _10_. | [optional] + +## Example + +```python +from dtc.models.pdp_health_check import PDPHealthCheck + +# TODO update the JSON string below +json = "{}" +# create an instance of PDPHealthCheck from a JSON string +pdp_health_check_instance = PDPHealthCheck.from_json(json) +# print the JSON string representation of the object +print(PDPHealthCheck.to_json()) + +# convert the object into a dict +pdp_health_check_dict = pdp_health_check_instance.to_dict() +# create an instance of PDPHealthCheck from a dict +pdp_health_check_from_dict = PDPHealthCheck.from_dict(pdp_health_check_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/src/dtc/docs/Policy.md b/src/dtc/docs/Policy.md index 5945ab7..eaca084 100644 --- a/src/dtc/docs/Policy.md +++ b/src/dtc/docs/Policy.md @@ -11,11 +11,12 @@ Name | Type | Description | Notes **id** | **str** | The resource identifier. | [optional] [readonly] **inheritance_sources** | [**TTLInheritance**](TTLInheritance.md) | Optional. The inheritance configuration. | [optional] **metadata** | [**Metadata**](Metadata.md) | Output only. __Policy__ metadata. Defaults to empty object and should be explicitly requested using field selection. | [optional] -**method** | **str** | Load balancing method used for selecting __Pool__ assigned to __Policy__. Valid values are: * _round_robin_ If the _round_robin_ load balancing method is selected, BloxOne DDI adjusts the response to a query in a sequential and circular manner, directing clients to pools. * _ratio_ If _ratio_ load balancing method is selected, BloxOne DDI adjusts the response to a query so that clients are directed to pool using weighted round robin, a load-balancing pattern in which requests are distributed among several resources based on weight assigned to each resource. The distribution of responses over time will be equal for all available pools but the sequence of the responses won't be guaranteed. When equal weights are assigned for resources (pools) it effectively leads to basic round robin configuration which directs clients to pools in a sequential and circular manner. * _topology_ If _topology_ load balancing method is selected the pools configured for the policy are ignored and topology rules are used instead. * _global_availability_ If _global_availability_ load balancing method is selected clients are directed to the first pool that is up in the _pools_ list. Defaults to _round_robin_. | +**method** | **str** | Load balancing method used for selecting __Pool__ assigned to __Policy__. Valid values are: * _round_robin_ If the _round_robin_ load balancing method is selected, Universal DDI adjusts the response to a query in a sequential and circular manner, directing clients to pools. * _ratio_ If _ratio_ load balancing method is selected, Universal DDI adjusts the response to a query so that clients are directed to pool using weighted round robin, a load-balancing pattern in which requests are distributed among several resources based on weight assigned to each resource. The distribution of responses over time will be equal for all available pools but the sequence of the responses won't be guaranteed. When equal weights are assigned for resources (pools) it effectively leads to basic round robin configuration which directs clients to pools in a sequential and circular manner. * _topology_ If _topology_ load balancing method is selected the pools configured for the policy are ignored and topology rules are used instead. * _global_availability_ If _global_availability_ load balancing method is selected clients are directed to the first pool that is up in the _pools_ list. Defaults to _round_robin_. | **name** | **str** | Display name of __Policy__. | **pools** | [**List[PolicyPool]**](PolicyPool.md) | Optional. List of __Pool__ objects assigned to __Policy__. Defaults to _empty_. | [optional] -**rules** | [**List[TopologyRule]**](TopologyRule.md) | Optional. List of __TopologyRule__ objects defining the resolving strategy for __Policy__. Defaults to a list of single, default __TopologyRule__. | [optional] +**rules** | [**List[TopologyRule]**](TopologyRule.md) | Optional. List of inline __TopologyRule__ objects defining the resolving strategy for __Policy__. Mutually exclusive with _topology_: if _topology_ is set, _rules_ must be empty. Defaults to a list of single, default __TopologyRule__. | [optional] **tags** | **object** | Optional. The tags for __Policy__ in JSON format. | [optional] +**topology** | [**PolicyTopology**](PolicyTopology.md) | Optional. __Topology__ binding for this __Policy__. When set, resolution uses the referenced __Topology__'s __TopologyRulePreset__ entries together with the destinations configured in __PolicyTopology.RuleBinding__. Mutually exclusive with _rules_: if _rules_ is non-empty, _topology_ must be unset. | [optional] **ttl** | **int** | Optional. Time to live value (in seconds) to be used for records in DTC response. Unsigned integer, min: 0, max 2147483647 (31-bits per RFC-2181). | [optional] ## Example diff --git a/src/dtc/docs/PolicyApi.md b/src/dtc/docs/PolicyApi.md index 63ff7a2..d63a690 100644 --- a/src/dtc/docs/PolicyApi.md +++ b/src/dtc/docs/PolicyApi.md @@ -215,7 +215,7 @@ with ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **fields** | **str**| A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | [optional] - **filter** | **str**| A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | [optional] + **filter** | **str**| A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | | [optional] **offset** | **int**| The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | [optional] **limit** | **int**| The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | [optional] **page_token** | **str**| The service-defined string used to identify a page of resources. A null value indicates the first page. | [optional] diff --git a/src/dtc/docs/PolicyTopology.md b/src/dtc/docs/PolicyTopology.md new file mode 100644 index 0000000..413596b --- /dev/null +++ b/src/dtc/docs/PolicyTopology.md @@ -0,0 +1,31 @@ +# PolicyTopology + +A __PolicyTopology__ binds a __Topology__ to a __Policy__ by mapping each __TopologyRulePreset__ (by _name_) to the destination (DNS code or __Pool__) to use when that preset matches. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**rules** | [**List[PolicyTopologyRuleBinding]**](PolicyTopologyRuleBinding.md) | Ordered list of destination bindings, one per __TopologyRulePreset__ in the referenced __Topology__. Each binding maps a preset _name_ to the destination to use when that preset matches. | [optional] +**topology_id** | **str** | The resource identifier. | + +## Example + +```python +from dtc.models.policy_topology import PolicyTopology + +# TODO update the JSON string below +json = "{}" +# create an instance of PolicyTopology from a JSON string +policy_topology_instance = PolicyTopology.from_json(json) +# print the JSON string representation of the object +print(PolicyTopology.to_json()) + +# convert the object into a dict +policy_topology_dict = policy_topology_instance.to_dict() +# create an instance of PolicyTopology from a dict +policy_topology_from_dict = PolicyTopology.from_dict(policy_topology_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/src/dtc/docs/PolicyTopologyRuleBinding.md b/src/dtc/docs/PolicyTopologyRuleBinding.md new file mode 100644 index 0000000..60a17ba --- /dev/null +++ b/src/dtc/docs/PolicyTopologyRuleBinding.md @@ -0,0 +1,33 @@ +# PolicyTopologyRuleBinding + +A __RuleBinding__ maps one __TopologyRulePreset__ (by _name_) to the destination to use when that preset matches. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **str** | Optional. DNS code to return if the referenced preset matches. Must be set if _destination_ is _code_. Allowed values: - nodata - nxdomain Defaults to _nodata_. | [optional] +**destination** | **str** | Destination of the matched __TopologyRulePreset__. Allowed values: - code - pool Defaults to _code_. | [optional] +**name** | **str** | Required. Name of the __TopologyRulePreset__ from the referenced __Topology__. | +**pool_id** | **str** | The resource identifier. | [optional] + +## Example + +```python +from dtc.models.policy_topology_rule_binding import PolicyTopologyRuleBinding + +# TODO update the JSON string below +json = "{}" +# create an instance of PolicyTopologyRuleBinding from a JSON string +policy_topology_rule_binding_instance = PolicyTopologyRuleBinding.from_json(json) +# print the JSON string representation of the object +print(PolicyTopologyRuleBinding.to_json()) + +# convert the object into a dict +policy_topology_rule_binding_dict = policy_topology_rule_binding_instance.to_dict() +# create an instance of PolicyTopologyRuleBinding from a dict +policy_topology_rule_binding_from_dict = PolicyTopologyRuleBinding.from_dict(policy_topology_rule_binding_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/src/dtc/docs/Pool.md b/src/dtc/docs/Pool.md index e8eef37..1d07694 100644 --- a/src/dtc/docs/Pool.md +++ b/src/dtc/docs/Pool.md @@ -7,12 +7,13 @@ A __Pool__ (_dtc/pool_) represents a collection of servers, it is associated wit Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **comment** | **str** | Optional. Comment for __Pool__. | [optional] +**consolidated_health_enabled** | **bool** | Optional. Pool-level switch that enables consolidated health probing for this __Pool__. Defaults to _false_ (consolidated health disabled). Set to _true_ to enable consolidated probing on this __Pool__. When _false_, any per-__PoolHealthCheck__ consolidation configuration is preserved in storage but suppressed at runtime. | [optional] **disabled** | **bool** | Optional. Flag which enables/disables __Pool__. Defaults to _false_. | [optional] **health_checks** | [**List[PoolHealthCheck]**](PoolHealthCheck.md) | Optional. List of __HealthCheck__ objects IDs assigned to __Pool__. Defaults to _empty_. | [optional] **id** | **str** | The resource identifier. | [optional] [readonly] **inheritance_sources** | [**TTLInheritance**](TTLInheritance.md) | Optional. The inheritance configuration. | [optional] **metadata** | [**Metadata**](Metadata.md) | Output only. __Pool__ metadata. Defaults to empty object and should be explicitly requested using field selection. | [optional] -**method** | **str** | Load balancing method used for selecting __Server__ assigned to __Pool__. Valid values are: * _round_robin_ If the _round_robin_ load balancing method is selected, BloxOne DDI adjusts the response to a query in a sequential and circular manner, directing clients to pools. * _ratio_ If _ratio_ load balancing method is selected, BloxOne DDI adjusts the response to a query so that clients are directed to pool using weighted round robin, a load-balancing pattern in which requests are distributed among several resources based on weight assigned to each resource. The distribution of responses over time will be equal for all available pools but the sequence of the responses won't be guaranteed. When equal weights are assigned for resources (pools) it effectively leads to basic round robin which directs clients to pools in sequential and circular manner. * _global_availability_ If _global_availability_ load balancing method is selected clients are directed to the first server that is up in the _servers_ list. Defaults to _round_robin_. | +**method** | **str** | Load balancing method used for selecting __Server__ assigned to __Pool__. Valid values are: * _round_robin_ If the _round_robin_ load balancing method is selected, Universal DDI adjusts the response to a query in a sequential and circular manner, directing clients to pools. * _ratio_ If _ratio_ load balancing method is selected, Universal DDI adjusts the response to a query so that clients are directed to pool using weighted round robin, a load-balancing pattern in which requests are distributed among several resources based on weight assigned to each resource. The distribution of responses over time will be equal for all available pools but the sequence of the responses won't be guaranteed. When equal weights are assigned for resources (pools) it effectively leads to basic round robin which directs clients to pools in sequential and circular manner. * _global_availability_ If _global_availability_ load balancing method is selected clients are directed to the first server that is up in the _servers_ list. Defaults to _round_robin_. | **name** | **str** | Display name of __Pool__. | **pool_availability** | **str** | Optional. Pool Availability setting defines how __Pool__ health is calculated. Valid values are: * _all_ If _all_ availability selected then __Pool__ is treated healthy when all pool's servers are healthy. * _quorum_ If _quorum_ availability selected then __Pool__ is treated healthy when at least N pool's servers are healthy. N is configurable via the value from _pool_servers_quorum_ setting. * _any_ If _any_ availability selected then __Pool__ is treated healthy when at least one pool's server is healthy. Defaults to _any_. | [optional] **pool_servers_quorum** | **int** | Pool Servers Quorum defines a minimal number of pool's healthy servers required for treating __Pool__ as healthy when Pool Availability is set to _quorum_. | [optional] diff --git a/src/dtc/docs/PoolApi.md b/src/dtc/docs/PoolApi.md index f1c164b..7e47467 100644 --- a/src/dtc/docs/PoolApi.md +++ b/src/dtc/docs/PoolApi.md @@ -215,7 +215,7 @@ with ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **fields** | **str**| A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | [optional] - **filter** | **str**| A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | [optional] + **filter** | **str**| A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | | [optional] **offset** | **int**| The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | [optional] **limit** | **int**| The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | [optional] **page_token** | **str**| The service-defined string used to identify a page of resources. A null value indicates the first page. | [optional] diff --git a/src/dtc/docs/PoolHealthCheck.md b/src/dtc/docs/PoolHealthCheck.md index 4767270..5640896 100644 --- a/src/dtc/docs/PoolHealthCheck.md +++ b/src/dtc/docs/PoolHealthCheck.md @@ -6,6 +6,7 @@ A __PoolHealthCheck__ represents a link between __Pool__ and __HealthCheck__. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**consolidated_health_check** | [**ConsolidatedHealthCheck**](ConsolidatedHealthCheck.md) | Optional. Consolidated health check configuration. When set, the DNS server running the named designator __DNS Service__ performs the health check on behalf of the __Pool__, and the result is shared with other DNS servers linked to the __Pool__ via __LBDN__ association. When unset, each DNS server performs the health check independently and no health status is shared. | [optional] **health_check_id** | **str** | The resource identifier. | **name** | **str** | Display name of __HealthCheck__. | [optional] [readonly] diff --git a/src/dtc/docs/ReadPDPHealthCheckResponse.md b/src/dtc/docs/ReadPDPHealthCheckResponse.md new file mode 100644 index 0000000..cd92559 --- /dev/null +++ b/src/dtc/docs/ReadPDPHealthCheckResponse.md @@ -0,0 +1,30 @@ +# ReadPDPHealthCheckResponse + +The __PDPHealthCheck__ object read response format. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**result** | [**PDPHealthCheck**](PDPHealthCheck.md) | The __PDPHealthCheck__ object. | [optional] + +## Example + +```python +from dtc.models.read_pdp_health_check_response import ReadPDPHealthCheckResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of ReadPDPHealthCheckResponse from a JSON string +read_pdp_health_check_response_instance = ReadPDPHealthCheckResponse.from_json(json) +# print the JSON string representation of the object +print(ReadPDPHealthCheckResponse.to_json()) + +# convert the object into a dict +read_pdp_health_check_response_dict = read_pdp_health_check_response_instance.to_dict() +# create an instance of ReadPDPHealthCheckResponse from a dict +read_pdp_health_check_response_from_dict = ReadPDPHealthCheckResponse.from_dict(read_pdp_health_check_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/src/dtc/docs/ReadSIPHealthCheckResponse.md b/src/dtc/docs/ReadSIPHealthCheckResponse.md new file mode 100644 index 0000000..48f5e7f --- /dev/null +++ b/src/dtc/docs/ReadSIPHealthCheckResponse.md @@ -0,0 +1,30 @@ +# ReadSIPHealthCheckResponse + +The __SIPHealthCheck__ object read response format. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**result** | [**SIPHealthCheck**](SIPHealthCheck.md) | The __SIPHealthCheck__ object. | [optional] + +## Example + +```python +from dtc.models.read_sip_health_check_response import ReadSIPHealthCheckResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of ReadSIPHealthCheckResponse from a JSON string +read_sip_health_check_response_instance = ReadSIPHealthCheckResponse.from_json(json) +# print the JSON string representation of the object +print(ReadSIPHealthCheckResponse.to_json()) + +# convert the object into a dict +read_sip_health_check_response_dict = read_sip_health_check_response_instance.to_dict() +# create an instance of ReadSIPHealthCheckResponse from a dict +read_sip_health_check_response_from_dict = ReadSIPHealthCheckResponse.from_dict(read_sip_health_check_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/src/dtc/docs/ReadTopologyResponse.md b/src/dtc/docs/ReadTopologyResponse.md new file mode 100644 index 0000000..a24b8b3 --- /dev/null +++ b/src/dtc/docs/ReadTopologyResponse.md @@ -0,0 +1,30 @@ +# ReadTopologyResponse + +The __Topology__ object read response format. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**result** | [**Topology**](Topology.md) | The __Topology__ object. | [optional] + +## Example + +```python +from dtc.models.read_topology_response import ReadTopologyResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of ReadTopologyResponse from a JSON string +read_topology_response_instance = ReadTopologyResponse.from_json(json) +# print the JSON string representation of the object +print(ReadTopologyResponse.to_json()) + +# convert the object into a dict +read_topology_response_dict = read_topology_response_instance.to_dict() +# create an instance of ReadTopologyResponse from a dict +read_topology_response_from_dict = ReadTopologyResponse.from_dict(read_topology_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/src/dtc/docs/SIPHealthCheck.md b/src/dtc/docs/SIPHealthCheck.md new file mode 100644 index 0000000..89391c1 --- /dev/null +++ b/src/dtc/docs/SIPHealthCheck.md @@ -0,0 +1,43 @@ +# SIPHealthCheck + +A __SIPHealthCheck__ (_dtc/health_check_sip_) represents a DTC __Server__ health check that probes a Session Initiation Protocol (SIP) endpoint by sending a SIP OPTIONS request over TCP or UDP. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **str** | Optional. Comment for __SIPHealthCheck__. | [optional] +**disabled** | **bool** | Optional. Flag which enables/disables __SIPHealthCheck__. Defaults to _false_. | [optional] +**id** | **str** | The resource identifier. | [optional] [readonly] +**interval** | **int** | Optional. Interval value in seconds. The health check runs only for the specified interval and it is measured from the beginning of the previous check cycle. Defaults to _15_. | [optional] +**metadata** | [**Metadata**](Metadata.md) | Output only. __SIPHealthCheck__ metadata. Defaults to empty object and should be explicitly requested using field selection. | [optional] +**name** | **str** | Display name of __SIPHealthCheck__. | +**port** | **int** | Optional. Destination port for the SIP OPTIONS request. Defaults to _5060_ for both TCP and UDP transport. | [optional] +**result_code** | **int** | Optional. Expected SIP response code, used with _CODE_IS_ and _CODE_IS_NOT_ result modes. Defaults to _200_. | [optional] +**result_mode** | **str** | Optional. Defines how the SIP response code is evaluated. Supported values: _ANY_, _CODE_IS_, _CODE_IS_NOT_. Defaults to _CODE_IS_. | [optional] +**retry_down** | **int** | Optional. Retry down count. The value determines how many bad health checks in a row must be received by the onprem host from the DTC Server for treating the health check as failed. Defaults to _1_. | [optional] +**retry_up** | **int** | Optional. Retry up count. The value determines how many good health checks in a row must be received by the onprem host from the DTC Server for treating the health check as successful. Defaults to _1_. | [optional] +**tags** | **object** | Optional. The tags for __SIPHealthCheck__ in JSON format. | [optional] +**timeout** | **int** | Optional. Timeout value in seconds. The health check waits for the specified number of seconds after sending a request. If it does not receive a response within the number of seconds, then the health check is considered as failed. Defaults to _10_. | [optional] +**transport** | **str** | Optional. Transport protocol for the SIP OPTIONS request. Supported values: _TCP_, _UDP_. Defaults to _TCP_. | [optional] + +## Example + +```python +from dtc.models.sip_health_check import SIPHealthCheck + +# TODO update the JSON string below +json = "{}" +# create an instance of SIPHealthCheck from a JSON string +sip_health_check_instance = SIPHealthCheck.from_json(json) +# print the JSON string representation of the object +print(SIPHealthCheck.to_json()) + +# convert the object into a dict +sip_health_check_dict = sip_health_check_instance.to_dict() +# create an instance of SIPHealthCheck from a dict +sip_health_check_from_dict = SIPHealthCheck.from_dict(sip_health_check_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/src/dtc/docs/ServerApi.md b/src/dtc/docs/ServerApi.md index c504190..3be588a 100644 --- a/src/dtc/docs/ServerApi.md +++ b/src/dtc/docs/ServerApi.md @@ -214,7 +214,7 @@ with ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **fields** | **str**| A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | [optional] - **filter** | **str**| A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | [optional] + **filter** | **str**| A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | | [optional] **offset** | **int**| The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | [optional] **limit** | **int**| The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | [optional] **page_token** | **str**| The service-defined string used to identify a page of resources. A null value indicates the first page. | [optional] diff --git a/src/dtc/docs/SnmpUserSecurityApi.md b/src/dtc/docs/SnmpUserSecurityApi.md index 6eeaca6..2a5d6a2 100644 --- a/src/dtc/docs/SnmpUserSecurityApi.md +++ b/src/dtc/docs/SnmpUserSecurityApi.md @@ -208,7 +208,7 @@ with ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **fields** | **str**| A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | [optional] - **filter** | **str**| A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Groupping Operators | | [optional] + **filter** | **str**| A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | | [optional] **offset** | **int**| The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | [optional] **limit** | **int**| The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | [optional] **page_token** | **str**| The service-defined string used to identify a page of resources. A null value indicates the first page. | [optional] diff --git a/src/dtc/docs/TagRule.md b/src/dtc/docs/TagRule.md new file mode 100644 index 0000000..35f48cc --- /dev/null +++ b/src/dtc/docs/TagRule.md @@ -0,0 +1,32 @@ +# TagRule + +A __TagRule__ is a single match criterion used by a tags-based topology rule source. Each rule carries a _key_, _value_, and an optional match _op_. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | Required. Tag key to match against a source object's effective tags. | +**op** | **str** | Optional. Match operator. Supported values: - EQUALS: matches when the key exists and its value equals the configured value. - NOT_EQUALS: matches when the key exists and all values for that key differ from the configured value. A missing key does not satisfy either operator. Defaults to _EQUALS_. | [optional] +**value** | **str** | Required. Tag value to match against a source object's effective tags. | + +## Example + +```python +from dtc.models.tag_rule import TagRule + +# TODO update the JSON string below +json = "{}" +# create an instance of TagRule from a JSON string +tag_rule_instance = TagRule.from_json(json) +# print the JSON string representation of the object +print(TagRule.to_json()) + +# convert the object into a dict +tag_rule_dict = tag_rule_instance.to_dict() +# create an instance of TagRule from a dict +tag_rule_from_dict = TagRule.from_dict(tag_rule_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/src/dtc/docs/Topology.md b/src/dtc/docs/Topology.md new file mode 100644 index 0000000..e4d815b --- /dev/null +++ b/src/dtc/docs/Topology.md @@ -0,0 +1,36 @@ +# Topology + +A __Topology__ (_dtc/topology_) is a reusable, named set of __TopologyRulePreset__ objects that provide deterministic infrastructure classification for DTC __Policy__ evaluation using infrastructure source object tags. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**comment** | **str** | Optional. Comment for __Topology__. | [optional] +**disabled** | **bool** | Optional. Flag which enables/disables __Topology__. Defaults to _false_. | [optional] +**id** | **str** | The resource identifier. | [optional] [readonly] +**metadata** | [**Metadata**](Metadata.md) | Output only. __Topology__ metadata. Defaults to empty object and should be explicitly requested using field selection. | [optional] +**name** | **str** | Display name of __Topology__. | +**rules** | [**List[TopologyRulePreset]**](TopologyRulePreset.md) | List of __TopologyRulePreset__ objects defining the resolving strategy for __Policy__. Preset names must be unique within __Topology__. Defaults to a list with a single, default __TopologyRulePreset__. | [optional] +**tags** | **object** | Optional. The tags for __Topology__ in JSON format. | [optional] + +## Example + +```python +from dtc.models.topology import Topology + +# TODO update the JSON string below +json = "{}" +# create an instance of Topology from a JSON string +topology_instance = Topology.from_json(json) +# print the JSON string representation of the object +print(Topology.to_json()) + +# convert the object into a dict +topology_dict = topology_instance.to_dict() +# create an instance of Topology from a dict +topology_from_dict = Topology.from_dict(topology_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/src/dtc/docs/TopologyApi.md b/src/dtc/docs/TopologyApi.md new file mode 100644 index 0000000..8c58f6d --- /dev/null +++ b/src/dtc/docs/TopologyApi.md @@ -0,0 +1,400 @@ +# dtc.TopologyApi + +All URIs are relative to *http://localhost/api/ddi/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create**](TopologyApi.md#create) | **POST** /dtc/topology | Create the Topology object. +[**delete**](TopologyApi.md#delete) | **DELETE** /dtc/topology/{id} | Delete the Topology object. +[**list**](TopologyApi.md#list) | **GET** /dtc/topology | Retrieve Topology objects. +[**read**](TopologyApi.md#read) | **GET** /dtc/topology/{id} | Retrieve the Topology object. +[**update**](TopologyApi.md#update) | **PATCH** /dtc/topology/{id} | Update the Topology object. + + +# **create** +> CreateTopologyResponse create(body) + +Create the Topology object. + +Use this method to create a __Topology__ object. + +### Example + +* Api Key Authentication (ApiKeyAuth): +```python +import os +from pprint import pprint + +import dtc + +from universal_ddi_client.api_client import ApiClient +from universal_ddi_client.configuration import Configuration + +# Defining the Portal URL is optional and defaults to "https://csp.infoblox.com" +# See configuration.py for a list of all supported configuration parameters. +configuration = Configuration( + portal_url = os.getenv('INFOBLOX_PORTAL_URL'), +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. + +# Configure Portal key authorization: ApiKeyAuth +configuration.portal_key = os.getenv("INFOBLOX_PORTAL_KEY") + +# Enter a context with an instance of the API client +with ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = dtc.TopologyApi(api_client) + body = dtc.Topology() # Topology | + + try: + # Create the Topology object. + api_response = api_instance.create(body) + pprint("The response of TopologyApi->create:\n") + pprint(api_response) + except Exception as e: + pprint("Exception when calling TopologyApi->create: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**Topology**](Topology.md)| | + +### Return type + +[**CreateTopologyResponse**](CreateTopologyResponse.md) + +### Authorization + +[ApiKeyAuth](../README.md#ApiKeyAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | POST operation response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **delete** +> delete(id) + +Delete the Topology object. + +Use this method to delete a __Topology__ object. + +### Example + +* Api Key Authentication (ApiKeyAuth): +```python +import os +from pprint import pprint + +import dtc + +from universal_ddi_client.api_client import ApiClient +from universal_ddi_client.configuration import Configuration + +# Defining the Portal URL is optional and defaults to "https://csp.infoblox.com" +# See configuration.py for a list of all supported configuration parameters. +configuration = Configuration( + portal_url = os.getenv('INFOBLOX_PORTAL_URL'), +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. + +# Configure Portal key authorization: ApiKeyAuth +configuration.portal_key = os.getenv("INFOBLOX_PORTAL_KEY") + +# Enter a context with an instance of the API client +with ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = dtc.TopologyApi(api_client) + id = 'id_example' # str | An application specific resource identity of a resource + + try: + # Delete the Topology object. + api_instance.delete(id) + except Exception as e: + pprint("Exception when calling TopologyApi->delete: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| An application specific resource identity of a resource | + +### Return type + +void (empty response body) + +### Authorization + +[ApiKeyAuth](../README.md#ApiKeyAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list** +> ListTopologyResponse list(fields=fields, filter=filter, offset=offset, limit=limit, page_token=page_token, order_by=order_by, tfilter=tfilter, torder_by=torder_by) + +Retrieve Topology objects. + +Use this method to retrieve __Topology__ objects. + +### Example + +* Api Key Authentication (ApiKeyAuth): +```python +import os +from pprint import pprint + +import dtc + +from universal_ddi_client.api_client import ApiClient +from universal_ddi_client.configuration import Configuration + +# Defining the Portal URL is optional and defaults to "https://csp.infoblox.com" +# See configuration.py for a list of all supported configuration parameters. +configuration = Configuration( + portal_url = os.getenv('INFOBLOX_PORTAL_URL'), +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. + +# Configure Portal key authorization: ApiKeyAuth +configuration.portal_key = os.getenv("INFOBLOX_PORTAL_KEY") + +# Enter a context with an instance of the API client +with ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = dtc.TopologyApi(api_client) + + try: + # Retrieve Topology objects. + api_response = api_instance.list() + pprint("The response of TopologyApi->list:\n") + pprint(api_response) + except Exception as e: + pprint("Exception when calling TopologyApi->list: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **fields** | **str**| A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | [optional] + **filter** | **str**| A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op | Description | | -- | ----------- | | == | Equal | | != | Not Equal | | > | Greater Than | | >= | Greater Than or Equal To | | < | Less Than | | <= | Less Than or Equal To | | and | Logical AND | | ~ | Matches Regex | | !~ | Does Not Match Regex | | or | Logical OR | | not | Logical NOT | | () | Grouping Operators | | [optional] + **offset** | **int**| The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | [optional] + **limit** | **int**| The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | [optional] + **page_token** | **str**| The service-defined string used to identify a page of resources. A null value indicates the first page. | [optional] + **order_by** | **str**| A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | [optional] + **tfilter** | **str**| This parameter is used for filtering by tags. | [optional] + **torder_by** | **str**| This parameter is used for sorting by tags. | [optional] + +### Return type + +[**ListTopologyResponse**](ListTopologyResponse.md) + +### Authorization + +[ApiKeyAuth](../README.md#ApiKeyAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | GET operation response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **read** +> ReadTopologyResponse read(id, fields=fields) + +Retrieve the Topology object. + +Use this method to retrieve a __Topology__ object. + +### Example + +* Api Key Authentication (ApiKeyAuth): +```python +import os +from pprint import pprint + +import dtc + +from universal_ddi_client.api_client import ApiClient +from universal_ddi_client.configuration import Configuration + +# Defining the Portal URL is optional and defaults to "https://csp.infoblox.com" +# See configuration.py for a list of all supported configuration parameters. +configuration = Configuration( + portal_url = os.getenv('INFOBLOX_PORTAL_URL'), +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. + +# Configure Portal key authorization: ApiKeyAuth +configuration.portal_key = os.getenv("INFOBLOX_PORTAL_KEY") + +# Enter a context with an instance of the API client +with ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = dtc.TopologyApi(api_client) + id = 'id_example' # str | An application specific resource identity of a resource + + try: + # Retrieve the Topology object. + api_response = api_instance.read(id) + pprint("The response of TopologyApi->read:\n") + pprint(api_response) + except Exception as e: + pprint("Exception when calling TopologyApi->read: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| An application specific resource identity of a resource | + **fields** | **str**| A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | [optional] + +### Return type + +[**ReadTopologyResponse**](ReadTopologyResponse.md) + +### Authorization + +[ApiKeyAuth](../README.md#ApiKeyAuth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | GET operation response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update** +> UpdateTopologyResponse update(id, body) + +Update the Topology object. + +Use this method to update a __Topology__ object. + +### Example + +* Api Key Authentication (ApiKeyAuth): +```python +import os +from pprint import pprint + +import dtc + +from universal_ddi_client.api_client import ApiClient +from universal_ddi_client.configuration import Configuration + +# Defining the Portal URL is optional and defaults to "https://csp.infoblox.com" +# See configuration.py for a list of all supported configuration parameters. +configuration = Configuration( + portal_url = os.getenv('INFOBLOX_PORTAL_URL'), +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. + +# Configure Portal key authorization: ApiKeyAuth +configuration.portal_key = os.getenv("INFOBLOX_PORTAL_KEY") + +# Enter a context with an instance of the API client +with ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = dtc.TopologyApi(api_client) + id = 'id_example' # str | An application specific resource identity of a resource + body = dtc.Topology() # Topology | + + try: + # Update the Topology object. + api_response = api_instance.update(id, body) + pprint("The response of TopologyApi->update:\n") + pprint(api_response) + except Exception as e: + pprint("Exception when calling TopologyApi->update: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| An application specific resource identity of a resource | + **body** | [**Topology**](Topology.md)| | + +### Return type + +[**UpdateTopologyResponse**](UpdateTopologyResponse.md) + +### Authorization + +[ApiKeyAuth](../README.md#ApiKeyAuth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | PATCH operation response | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/src/dtc/docs/TopologyRule.md b/src/dtc/docs/TopologyRule.md index ad4c885..4e76acd 100644 --- a/src/dtc/docs/TopologyRule.md +++ b/src/dtc/docs/TopologyRule.md @@ -10,8 +10,9 @@ Name | Type | Description | Notes **destination** | **str** | Destination of __TopologyRule__. Allowed values: - code - pool Defaults to _code_. | [optional] **name** | **str** | Display name of __TopologyRule__. | **pool_id** | **str** | The resource identifier. | [optional] -**source** | **str** | Type of source. Allowed values: - subnet - default Defaults to _default_. | [optional] +**source** | **str** | Type of source. Allowed values: - subnet - tags - default Defaults to _default_. | [optional] **subnets** | **List[str]** | Optional. List of subnets in CIDR format. Must be set if _source_ is _subnet_, otherwise must be empty. | [optional] +**tags** | [**List[TagRule]**](TagRule.md) | Optional. List of tag rules to match against a source object's effective tags. Effective tags = direct tags plus tags inherited from the IPAM parent chain (IPSpace → Address Block → Subnet); the closer level wins on key conflicts. All rules use AND semantics: an object must satisfy every __TagRule__ to match. Must be set if _source_ is _tags_, otherwise must be empty. | [optional] ## Example diff --git a/src/dtc/docs/TopologyRulePreset.md b/src/dtc/docs/TopologyRulePreset.md new file mode 100644 index 0000000..0344fa0 --- /dev/null +++ b/src/dtc/docs/TopologyRulePreset.md @@ -0,0 +1,33 @@ +# TopologyRulePreset + +A __TopologyRulePreset__ is a named set of match criteria for classifying infrastructure source objects. A __Topology__ holds an ordered list of __TopologyRulePreset__ objects evaluated top to bottom; the first preset whose criteria all match wins. Destination (DNS code or __Pool__) is configured separately per __Policy__ in __PolicyTopology.RuleBinding__, not on the preset itself. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | Required. Display name of __TopologyRulePreset__. Must be unique within __Topology__. | +**source** | **str** | Type of source. Allowed values: - subnet - tags - default Defaults to _default_. | [optional] +**subnets** | **List[str]** | Optional. List of subnets in CIDR format. Must be set if _source_ is _subnet_, otherwise must be empty. | [optional] +**tags** | [**List[TagRule]**](TagRule.md) | Optional. List of tag rules to match against a source object's effective tags. Effective tags = direct tags plus tags inherited from the IPAM parent chain (IPSpace → Address Block → Subnet); the closer level wins on key conflicts. All rules use AND semantics: an object must satisfy every __TagRule__ to match. Must be set if _source_ is _tags_, otherwise must be empty. | [optional] + +## Example + +```python +from dtc.models.topology_rule_preset import TopologyRulePreset + +# TODO update the JSON string below +json = "{}" +# create an instance of TopologyRulePreset from a JSON string +topology_rule_preset_instance = TopologyRulePreset.from_json(json) +# print the JSON string representation of the object +print(TopologyRulePreset.to_json()) + +# convert the object into a dict +topology_rule_preset_dict = topology_rule_preset_instance.to_dict() +# create an instance of TopologyRulePreset from a dict +topology_rule_preset_from_dict = TopologyRulePreset.from_dict(topology_rule_preset_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/src/dtc/docs/UpdatePDPHealthCheckResponse.md b/src/dtc/docs/UpdatePDPHealthCheckResponse.md new file mode 100644 index 0000000..117cf19 --- /dev/null +++ b/src/dtc/docs/UpdatePDPHealthCheckResponse.md @@ -0,0 +1,30 @@ +# UpdatePDPHealthCheckResponse + +The __PDPHealthCheck__ object update response format. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**result** | [**PDPHealthCheck**](PDPHealthCheck.md) | The __PDPHealthCheck__ object. | [optional] + +## Example + +```python +from dtc.models.update_pdp_health_check_response import UpdatePDPHealthCheckResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of UpdatePDPHealthCheckResponse from a JSON string +update_pdp_health_check_response_instance = UpdatePDPHealthCheckResponse.from_json(json) +# print the JSON string representation of the object +print(UpdatePDPHealthCheckResponse.to_json()) + +# convert the object into a dict +update_pdp_health_check_response_dict = update_pdp_health_check_response_instance.to_dict() +# create an instance of UpdatePDPHealthCheckResponse from a dict +update_pdp_health_check_response_from_dict = UpdatePDPHealthCheckResponse.from_dict(update_pdp_health_check_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/src/dtc/docs/UpdateSIPHealthCheckResponse.md b/src/dtc/docs/UpdateSIPHealthCheckResponse.md new file mode 100644 index 0000000..c76393f --- /dev/null +++ b/src/dtc/docs/UpdateSIPHealthCheckResponse.md @@ -0,0 +1,30 @@ +# UpdateSIPHealthCheckResponse + +The __SIPHealthCheck__ object update response format. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**result** | [**SIPHealthCheck**](SIPHealthCheck.md) | The __SIPHealthCheck__ object. | [optional] + +## Example + +```python +from dtc.models.update_sip_health_check_response import UpdateSIPHealthCheckResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of UpdateSIPHealthCheckResponse from a JSON string +update_sip_health_check_response_instance = UpdateSIPHealthCheckResponse.from_json(json) +# print the JSON string representation of the object +print(UpdateSIPHealthCheckResponse.to_json()) + +# convert the object into a dict +update_sip_health_check_response_dict = update_sip_health_check_response_instance.to_dict() +# create an instance of UpdateSIPHealthCheckResponse from a dict +update_sip_health_check_response_from_dict = UpdateSIPHealthCheckResponse.from_dict(update_sip_health_check_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/src/dtc/docs/UpdateTopologyResponse.md b/src/dtc/docs/UpdateTopologyResponse.md new file mode 100644 index 0000000..c7b95be --- /dev/null +++ b/src/dtc/docs/UpdateTopologyResponse.md @@ -0,0 +1,30 @@ +# UpdateTopologyResponse + +The __Topology__ object update response format. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**result** | [**Topology**](Topology.md) | The __Topology__ object. | [optional] + +## Example + +```python +from dtc.models.update_topology_response import UpdateTopologyResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of UpdateTopologyResponse from a JSON string +update_topology_response_instance = UpdateTopologyResponse.from_json(json) +# print the JSON string representation of the object +print(UpdateTopologyResponse.to_json()) + +# convert the object into a dict +update_topology_response_dict = update_topology_response_instance.to_dict() +# create an instance of UpdateTopologyResponse from a dict +update_topology_response_from_dict = UpdateTopologyResponse.from_dict(update_topology_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/src/dtc/models/__init__.py b/src/dtc/models/__init__.py index 5bd62ab..7a26724 100644 --- a/src/dtc/models/__init__.py +++ b/src/dtc/models/__init__.py @@ -4,7 +4,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -13,54 +13,75 @@ """ # noqa: E501 # import models into model package +from dtc.models.consolidated_health_check import ConsolidatedHealthCheck from dtc.models.create_http_health_check_response import CreateHTTPHealthCheckResponse from dtc.models.create_icmp_health_check_response import CreateICMPHealthCheckResponse +from dtc.models.create_pdp_health_check_response import CreatePDPHealthCheckResponse from dtc.models.create_policy_response import CreatePolicyResponse from dtc.models.create_pool_response import CreatePoolResponse +from dtc.models.create_sip_health_check_response import CreateSIPHealthCheckResponse from dtc.models.create_snmp_health_check_response import CreateSNMPHealthCheckResponse from dtc.models.create_snmp_user_security_response import CreateSNMPUserSecurityResponse from dtc.models.create_server_response import CreateServerResponse from dtc.models.create_tcp_health_check_response import CreateTCPHealthCheckResponse +from dtc.models.create_topology_response import CreateTopologyResponse +from dtc.models.designator_service import DesignatorService from dtc.models.http_health_check import HTTPHealthCheck from dtc.models.header_regex import HeaderRegex from dtc.models.icmp_health_check import ICMPHealthCheck from dtc.models.inheritance2_inherited_u_int32 import Inheritance2InheritedUInt32 from dtc.models.list_http_health_check_response import ListHTTPHealthCheckResponse from dtc.models.list_icmp_health_check_response import ListICMPHealthCheckResponse +from dtc.models.list_pdp_health_check_response import ListPDPHealthCheckResponse from dtc.models.list_policy_response import ListPolicyResponse from dtc.models.list_pool_response import ListPoolResponse +from dtc.models.list_sip_health_check_response import ListSIPHealthCheckResponse from dtc.models.list_snmp_health_check_response import ListSNMPHealthCheckResponse from dtc.models.list_snmp_user_security_response import ListSNMPUserSecurityResponse from dtc.models.list_server_response import ListServerResponse from dtc.models.list_tcp_health_check_response import ListTCPHealthCheckResponse +from dtc.models.list_topology_response import ListTopologyResponse from dtc.models.metadata import Metadata from dtc.models.metadata_resource_meta import MetadataResourceMeta +from dtc.models.pdp_health_check import PDPHealthCheck from dtc.models.policy import Policy from dtc.models.policy_pool import PolicyPool +from dtc.models.policy_topology import PolicyTopology +from dtc.models.policy_topology_rule_binding import PolicyTopologyRuleBinding from dtc.models.pool import Pool from dtc.models.pool_health_check import PoolHealthCheck from dtc.models.pool_server import PoolServer from dtc.models.read_http_health_check_response import ReadHTTPHealthCheckResponse from dtc.models.read_icmp_health_check_response import ReadICMPHealthCheckResponse +from dtc.models.read_pdp_health_check_response import ReadPDPHealthCheckResponse from dtc.models.read_policy_response import ReadPolicyResponse from dtc.models.read_pool_response import ReadPoolResponse +from dtc.models.read_sip_health_check_response import ReadSIPHealthCheckResponse from dtc.models.read_snmp_health_check_response import ReadSNMPHealthCheckResponse from dtc.models.read_snmp_user_security_response import ReadSNMPUserSecurityResponse from dtc.models.read_server_response import ReadServerResponse from dtc.models.read_tcp_health_check_response import ReadTCPHealthCheckResponse +from dtc.models.read_topology_response import ReadTopologyResponse from dtc.models.record import Record +from dtc.models.sip_health_check import SIPHealthCheck from dtc.models.snmp_health_check import SNMPHealthCheck from dtc.models.snmp_health_check_entry_check import SNMPHealthCheckEntryCheck from dtc.models.snmp_user_security_model import SNMPUserSecurityModel from dtc.models.server import Server from dtc.models.tcp_health_check import TCPHealthCheck from dtc.models.ttl_inheritance import TTLInheritance +from dtc.models.tag_rule import TagRule +from dtc.models.topology import Topology from dtc.models.topology_rule import TopologyRule +from dtc.models.topology_rule_preset import TopologyRulePreset from dtc.models.update_http_health_check_response import UpdateHTTPHealthCheckResponse from dtc.models.update_icmp_health_check_response import UpdateICMPHealthCheckResponse +from dtc.models.update_pdp_health_check_response import UpdatePDPHealthCheckResponse from dtc.models.update_policy_response import UpdatePolicyResponse from dtc.models.update_pool_response import UpdatePoolResponse +from dtc.models.update_sip_health_check_response import UpdateSIPHealthCheckResponse from dtc.models.update_snmp_health_check_response import UpdateSNMPHealthCheckResponse from dtc.models.update_snmp_user_security_response import UpdateSNMPUserSecurityResponse from dtc.models.update_server_response import UpdateServerResponse from dtc.models.update_tcp_health_check_response import UpdateTCPHealthCheckResponse +from dtc.models.update_topology_response import UpdateTopologyResponse diff --git a/src/dtc/models/consolidated_health_check.py b/src/dtc/models/consolidated_health_check.py new file mode 100644 index 0000000..23617a9 --- /dev/null +++ b/src/dtc/models/consolidated_health_check.py @@ -0,0 +1,112 @@ +# coding: utf-8 + +""" + DNS DTC API + + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. + + The version of the OpenAPI document: v1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from dtc.models.designator_service import DesignatorService +from typing import Optional, Set +from typing_extensions import Self + + +class ConsolidatedHealthCheck(BaseModel): + """ + When set, the DNS server running the named designator __DNS Service__ performs the health check on behalf of the __Pool__, and the result is shared with other DNS servers linked to the __Pool__ via __LBDN__ association. When unset, each DNS server performs the health check independently and no health status is shared. + """ # noqa: E501 + designators: Optional[List[DesignatorService]] = Field( + default=None, + description= + "Designator __DNS Service__ references where the corresponding health checks will be associated to. Must contain at least one entry when set. On request: only _dns_service_id_ is honoured. On response: _dns_service_name_ is echoed alongside, resolved from inventory." + ) + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["designators"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ConsolidatedHealthCheck from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in designators (list) + _items = [] + if self.designators: + for _item in self.designators: + if _item: + _items.append(_item.to_dict()) + _dict['designators'] = _items + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ConsolidatedHealthCheck from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "designators": [ + DesignatorService.from_dict(_item) + for _item in obj["designators"] + ] if obj.get("designators") is not None else None + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj diff --git a/src/dtc/models/create_http_health_check_response.py b/src/dtc/models/create_http_health_check_response.py index a9b1ecb..55a075a 100644 --- a/src/dtc/models/create_http_health_check_response.py +++ b/src/dtc/models/create_http_health_check_response.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/create_icmp_health_check_response.py b/src/dtc/models/create_icmp_health_check_response.py index 220fdaa..52faab8 100644 --- a/src/dtc/models/create_icmp_health_check_response.py +++ b/src/dtc/models/create_icmp_health_check_response.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/create_pdp_health_check_response.py b/src/dtc/models/create_pdp_health_check_response.py new file mode 100644 index 0000000..b7d3ef8 --- /dev/null +++ b/src/dtc/models/create_pdp_health_check_response.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + DNS DTC API + + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. + + The version of the OpenAPI document: v1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from dtc.models.pdp_health_check import PDPHealthCheck +from typing import Optional, Set +from typing_extensions import Self + + +class CreatePDPHealthCheckResponse(BaseModel): + """ + The __PDPHealthCheck__ object create response format. + """ # noqa: E501 + result: Optional[PDPHealthCheck] = Field( + default=None, description="The created __PDPHealthCheck__ object.") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["result"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CreatePDPHealthCheckResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of result + if self.result: + _dict['result'] = self.result.to_dict() + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CreatePDPHealthCheckResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "result": + PDPHealthCheck.from_dict(obj["result"]) + if obj.get("result") is not None else None + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj diff --git a/src/dtc/models/create_policy_response.py b/src/dtc/models/create_policy_response.py index f8f2dd5..5609e6a 100644 --- a/src/dtc/models/create_policy_response.py +++ b/src/dtc/models/create_policy_response.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/create_pool_response.py b/src/dtc/models/create_pool_response.py index 2754130..0a099c5 100644 --- a/src/dtc/models/create_pool_response.py +++ b/src/dtc/models/create_pool_response.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/create_server_response.py b/src/dtc/models/create_server_response.py index 228ebe2..4716464 100644 --- a/src/dtc/models/create_server_response.py +++ b/src/dtc/models/create_server_response.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/create_sip_health_check_response.py b/src/dtc/models/create_sip_health_check_response.py new file mode 100644 index 0000000..9473bc6 --- /dev/null +++ b/src/dtc/models/create_sip_health_check_response.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + DNS DTC API + + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. + + The version of the OpenAPI document: v1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from dtc.models.sip_health_check import SIPHealthCheck +from typing import Optional, Set +from typing_extensions import Self + + +class CreateSIPHealthCheckResponse(BaseModel): + """ + The __SIPHealthCheck__ object create response format. + """ # noqa: E501 + result: Optional[SIPHealthCheck] = Field( + default=None, description="The created __SIPHealthCheck__ object.") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["result"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CreateSIPHealthCheckResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of result + if self.result: + _dict['result'] = self.result.to_dict() + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CreateSIPHealthCheckResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "result": + SIPHealthCheck.from_dict(obj["result"]) + if obj.get("result") is not None else None + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj diff --git a/src/dtc/models/create_snmp_health_check_response.py b/src/dtc/models/create_snmp_health_check_response.py index ecb6cc8..87272d4 100644 --- a/src/dtc/models/create_snmp_health_check_response.py +++ b/src/dtc/models/create_snmp_health_check_response.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/create_snmp_user_security_response.py b/src/dtc/models/create_snmp_user_security_response.py index c9c2166..b1eb7e4 100644 --- a/src/dtc/models/create_snmp_user_security_response.py +++ b/src/dtc/models/create_snmp_user_security_response.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/create_tcp_health_check_response.py b/src/dtc/models/create_tcp_health_check_response.py index 57d2cd0..4e51dad 100644 --- a/src/dtc/models/create_tcp_health_check_response.py +++ b/src/dtc/models/create_tcp_health_check_response.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/create_topology_response.py b/src/dtc/models/create_topology_response.py new file mode 100644 index 0000000..307a000 --- /dev/null +++ b/src/dtc/models/create_topology_response.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + DNS DTC API + + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. + + The version of the OpenAPI document: v1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from dtc.models.topology import Topology +from typing import Optional, Set +from typing_extensions import Self + + +class CreateTopologyResponse(BaseModel): + """ + The __Topology__ object create response format. + """ # noqa: E501 + result: Optional[Topology] = Field( + default=None, description="The created __Topology__ object.") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["result"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of CreateTopologyResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of result + if self.result: + _dict['result'] = self.result.to_dict() + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of CreateTopologyResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "result": + Topology.from_dict(obj["result"]) + if obj.get("result") is not None else None + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj diff --git a/src/dtc/models/designator_service.py b/src/dtc/models/designator_service.py new file mode 100644 index 0000000..23f8621 --- /dev/null +++ b/src/dtc/models/designator_service.py @@ -0,0 +1,107 @@ +# coding: utf-8 + +""" + DNS DTC API + + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. + + The version of the OpenAPI document: v1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + + +class DesignatorService(BaseModel): + """ + Reference to a __DNS Service__ that acts as a designator for a __ConsolidatedHealthCheck__. + """ # noqa: E501 + dns_service_id: StrictStr = Field(description="The resource identifier.") + dns_service_name: Optional[StrictStr] = Field( + default=None, + description= + "Display name of the __DNS Service__. Response-only; ignored on request." + ) + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["dns_service_id", "dns_service_name"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of DesignatorService from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "dns_service_name", + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of DesignatorService from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dns_service_id": + obj.get("dns_service_id"), + "dns_service_name": + obj.get("dns_service_name") + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj diff --git a/src/dtc/models/header_regex.py b/src/dtc/models/header_regex.py index 92d1612..25ccd7e 100644 --- a/src/dtc/models/header_regex.py +++ b/src/dtc/models/header_regex.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/http_health_check.py b/src/dtc/models/http_health_check.py index 84f7c22..80ad5b5 100644 --- a/src/dtc/models/http_health_check.py +++ b/src/dtc/models/http_health_check.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/icmp_health_check.py b/src/dtc/models/icmp_health_check.py index 63e87ea..c54217d 100644 --- a/src/dtc/models/icmp_health_check.py +++ b/src/dtc/models/icmp_health_check.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/inheritance2_inherited_u_int32.py b/src/dtc/models/inheritance2_inherited_u_int32.py index dd6ffba..83638f6 100644 --- a/src/dtc/models/inheritance2_inherited_u_int32.py +++ b/src/dtc/models/inheritance2_inherited_u_int32.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/list_http_health_check_response.py b/src/dtc/models/list_http_health_check_response.py index d6564b2..ddc255c 100644 --- a/src/dtc/models/list_http_health_check_response.py +++ b/src/dtc/models/list_http_health_check_response.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/list_icmp_health_check_response.py b/src/dtc/models/list_icmp_health_check_response.py index bb2253b..09332d8 100644 --- a/src/dtc/models/list_icmp_health_check_response.py +++ b/src/dtc/models/list_icmp_health_check_response.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/list_pdp_health_check_response.py b/src/dtc/models/list_pdp_health_check_response.py new file mode 100644 index 0000000..c0d0b7d --- /dev/null +++ b/src/dtc/models/list_pdp_health_check_response.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + DNS DTC API + + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. + + The version of the OpenAPI document: v1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from dtc.models.pdp_health_check import PDPHealthCheck +from typing import Optional, Set +from typing_extensions import Self + + +class ListPDPHealthCheckResponse(BaseModel): + """ + The __PDPHealthCheck__ object list response format. + """ # noqa: E501 + results: Optional[List[PDPHealthCheck]] = Field( + default=None, description="List of __PDPHealthCheck__ objects.") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["results"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ListPDPHealthCheckResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in results (list) + _items = [] + if self.results: + for _item in self.results: + if _item: + _items.append(_item.to_dict()) + _dict['results'] = _items + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ListPDPHealthCheckResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "results": + [PDPHealthCheck.from_dict(_item) for _item in obj["results"]] + if obj.get("results") is not None else None + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj diff --git a/src/dtc/models/list_policy_response.py b/src/dtc/models/list_policy_response.py index 60b32d6..62736ba 100644 --- a/src/dtc/models/list_policy_response.py +++ b/src/dtc/models/list_policy_response.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/list_pool_response.py b/src/dtc/models/list_pool_response.py index f999b52..8f006bb 100644 --- a/src/dtc/models/list_pool_response.py +++ b/src/dtc/models/list_pool_response.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/list_server_response.py b/src/dtc/models/list_server_response.py index dde10cc..dff23d3 100644 --- a/src/dtc/models/list_server_response.py +++ b/src/dtc/models/list_server_response.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/list_sip_health_check_response.py b/src/dtc/models/list_sip_health_check_response.py new file mode 100644 index 0000000..252fa9a --- /dev/null +++ b/src/dtc/models/list_sip_health_check_response.py @@ -0,0 +1,108 @@ +# coding: utf-8 + +""" + DNS DTC API + + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. + + The version of the OpenAPI document: v1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from dtc.models.sip_health_check import SIPHealthCheck +from typing import Optional, Set +from typing_extensions import Self + + +class ListSIPHealthCheckResponse(BaseModel): + """ + The __SIPHealthCheck__ object list response format. + """ # noqa: E501 + results: Optional[List[SIPHealthCheck]] = Field( + default=None, description="List of __SIPHealthCheck__ objects.") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["results"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ListSIPHealthCheckResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in results (list) + _items = [] + if self.results: + for _item in self.results: + if _item: + _items.append(_item.to_dict()) + _dict['results'] = _items + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ListSIPHealthCheckResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "results": + [SIPHealthCheck.from_dict(_item) for _item in obj["results"]] + if obj.get("results") is not None else None + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj diff --git a/src/dtc/models/list_snmp_health_check_response.py b/src/dtc/models/list_snmp_health_check_response.py index bf58734..33b321f 100644 --- a/src/dtc/models/list_snmp_health_check_response.py +++ b/src/dtc/models/list_snmp_health_check_response.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/list_snmp_user_security_response.py b/src/dtc/models/list_snmp_user_security_response.py index 3492619..d885b70 100644 --- a/src/dtc/models/list_snmp_user_security_response.py +++ b/src/dtc/models/list_snmp_user_security_response.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/list_tcp_health_check_response.py b/src/dtc/models/list_tcp_health_check_response.py index de971c0..42c93b3 100644 --- a/src/dtc/models/list_tcp_health_check_response.py +++ b/src/dtc/models/list_tcp_health_check_response.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/list_topology_response.py b/src/dtc/models/list_topology_response.py new file mode 100644 index 0000000..1908e7f --- /dev/null +++ b/src/dtc/models/list_topology_response.py @@ -0,0 +1,109 @@ +# coding: utf-8 + +""" + DNS DTC API + + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. + + The version of the OpenAPI document: v1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from dtc.models.topology import Topology +from typing import Optional, Set +from typing_extensions import Self + + +class ListTopologyResponse(BaseModel): + """ + The __Topology__ object list response format. + """ + + # noqa: E501 + results: Optional[List[Topology]] = Field( + default=None, description="List of __Topology__ objects.") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["results"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ListTopologyResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in results (list) + _items = [] + if self.results: + for _item in self.results: + if _item: + _items.append(_item.to_dict()) + _dict['results'] = _items + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ListTopologyResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "results": [Topology.from_dict(_item) for _item in obj["results"]] + if obj.get("results") is not None else None + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj diff --git a/src/dtc/models/metadata.py b/src/dtc/models/metadata.py index 47cd495..7df89ec 100644 --- a/src/dtc/models/metadata.py +++ b/src/dtc/models/metadata.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/metadata_resource_meta.py b/src/dtc/models/metadata_resource_meta.py index 4eb9165..76f58cd 100644 --- a/src/dtc/models/metadata_resource_meta.py +++ b/src/dtc/models/metadata_resource_meta.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/pdp_health_check.py b/src/dtc/models/pdp_health_check.py new file mode 100644 index 0000000..91f8a50 --- /dev/null +++ b/src/dtc/models/pdp_health_check.py @@ -0,0 +1,171 @@ +# coding: utf-8 + +""" + DNS DTC API + + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. + + The version of the OpenAPI document: v1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from dtc.models.metadata import Metadata +from typing import Optional, Set +from typing_extensions import Self + + +class PDPHealthCheck(BaseModel): + """ + A __PDPHealthCheck__ (_dtc/health_check_pdp_) represents a DTC __Server__ health check that probes a Packet Data Protocol (PDP) endpoint by exchanging a GTPv1 Echo Request/Response over UDP. + """ # noqa: E501 + comment: Optional[StrictStr] = Field( + default=None, description="Optional. Comment for __PDPHealthCheck__.") + disabled: Optional[StrictBool] = Field( + default=None, + description= + "Optional. Flag which enables/disables __PDPHealthCheck__. Defaults to _false_." + ) + id: Optional[StrictStr] = Field(default=None, + description="The resource identifier.") + interval: Optional[StrictInt] = Field( + default=None, + description= + "Optional. Interval value in seconds. The health check runs only for the specified interval and it is measured from the beginning of the previous check cycle. Defaults to _15_." + ) + metadata: Optional[Metadata] = Field( + default=None, + description= + "Output only. __PDPHealthCheck__ metadata. Defaults to empty object and should be explicitly requested using field selection." + ) + name: StrictStr = Field(description="Display name of __PDPHealthCheck__.") + port: Optional[StrictInt] = Field( + default=None, + description= + "Optional. Destination UDP port of __PDPHealthCheck__ for the GTP Echo Request. Defaults to _2123_." + ) + retry_down: Optional[StrictInt] = Field( + default=None, + description= + "Optional. Retry down count. The value determines how many bad health checks in a row must be received by the onprem host from the DTC Server for treating the health check as failed. Defaults to _1_." + ) + retry_up: Optional[StrictInt] = Field( + default=None, + description= + "Optional. Retry up count. The value determines how many good health checks in a row must be received by the onprem host from the DTC Server for treating the health check as successful. Defaults to _1_." + ) + tags: Optional[Dict[str, Any]] = Field( + default=None, + description="Optional. The tags for __PDPHealthCheck__ in JSON format." + ) + timeout: Optional[StrictInt] = Field( + default=None, + description= + "Optional. Timeout value in seconds. The health check waits for the specified number of seconds after sending a request. If it does not receive a response within the number of seconds, then the health check is considered as failed. Defaults to _10_." + ) + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = [ + "comment", "disabled", "id", "interval", "metadata", "name", "port", + "retry_down", "retry_up", "tags", "timeout" + ] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PDPHealthCheck from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "id", + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of metadata + if self.metadata: + _dict['metadata'] = self.metadata.to_dict() + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PDPHealthCheck from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "comment": + obj.get("comment"), + "disabled": + obj.get("disabled"), + "id": + obj.get("id"), + "interval": + obj.get("interval"), + "metadata": + Metadata.from_dict(obj["metadata"]) + if obj.get("metadata") is not None else None, + "name": + obj.get("name"), + "port": + obj.get("port"), + "retry_down": + obj.get("retry_down"), + "retry_up": + obj.get("retry_up"), + "tags": + obj.get("tags"), + "timeout": + obj.get("timeout") + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj diff --git a/src/dtc/models/policy.py b/src/dtc/models/policy.py index a2554ed..5061505 100644 --- a/src/dtc/models/policy.py +++ b/src/dtc/models/policy.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -20,6 +20,7 @@ from typing import Any, ClassVar, Dict, List, Optional from dtc.models.metadata import Metadata from dtc.models.policy_pool import PolicyPool +from dtc.models.policy_topology import PolicyTopology from dtc.models.topology_rule import TopologyRule from dtc.models.ttl_inheritance import TTLInheritance from typing import Optional, Set @@ -48,7 +49,7 @@ class Policy(BaseModel): ) method: StrictStr = Field( description= - "Load balancing method used for selecting __Pool__ assigned to __Policy__. Valid values are: * _round_robin_ If the _round_robin_ load balancing method is selected, BloxOne DDI adjusts the response to a query in a sequential and circular manner, directing clients to pools. * _ratio_ If _ratio_ load balancing method is selected, BloxOne DDI adjusts the response to a query so that clients are directed to pool using weighted round robin, a load-balancing pattern in which requests are distributed among several resources based on weight assigned to each resource. The distribution of responses over time will be equal for all available pools but the sequence of the responses won't be guaranteed. When equal weights are assigned for resources (pools) it effectively leads to basic round robin configuration which directs clients to pools in a sequential and circular manner. * _topology_ If _topology_ load balancing method is selected the pools configured for the policy are ignored and topology rules are used instead. * _global_availability_ If _global_availability_ load balancing method is selected clients are directed to the first pool that is up in the _pools_ list. Defaults to _round_robin_." + "Load balancing method used for selecting __Pool__ assigned to __Policy__. Valid values are: * _round_robin_ If the _round_robin_ load balancing method is selected, Universal DDI adjusts the response to a query in a sequential and circular manner, directing clients to pools. * _ratio_ If _ratio_ load balancing method is selected, Universal DDI adjusts the response to a query so that clients are directed to pool using weighted round robin, a load-balancing pattern in which requests are distributed among several resources based on weight assigned to each resource. The distribution of responses over time will be equal for all available pools but the sequence of the responses won't be guaranteed. When equal weights are assigned for resources (pools) it effectively leads to basic round robin configuration which directs clients to pools in a sequential and circular manner. * _topology_ If _topology_ load balancing method is selected the pools configured for the policy are ignored and topology rules are used instead. * _global_availability_ If _global_availability_ load balancing method is selected clients are directed to the first pool that is up in the _pools_ list. Defaults to _round_robin_." ) name: StrictStr = Field(description="Display name of __Policy__.") pools: Optional[List[PolicyPool]] = Field( @@ -59,11 +60,16 @@ class Policy(BaseModel): rules: Optional[List[TopologyRule]] = Field( default=None, description= - "Optional. List of __TopologyRule__ objects defining the resolving strategy for __Policy__. Defaults to a list of single, default __TopologyRule__." + "Optional. List of inline __TopologyRule__ objects defining the resolving strategy for __Policy__. Mutually exclusive with _topology_: if _topology_ is set, _rules_ must be empty. Defaults to a list of single, default __TopologyRule__." ) tags: Optional[Dict[str, Any]] = Field( default=None, description="Optional. The tags for __Policy__ in JSON format.") + topology: Optional[PolicyTopology] = Field( + default=None, + description= + "Optional. __Topology__ binding for this __Policy__. When set, resolution uses the referenced __Topology__'s __TopologyRulePreset__ entries together with the destinations configured in __PolicyTopology.RuleBinding__. Mutually exclusive with _rules_: if _rules_ is non-empty, _topology_ must be unset." + ) ttl: Optional[StrictInt] = Field( default=None, description= @@ -72,7 +78,7 @@ class Policy(BaseModel): additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = [ "comment", "disabled", "id", "inheritance_sources", "metadata", - "method", "name", "pools", "rules", "tags", "ttl" + "method", "name", "pools", "rules", "tags", "topology", "ttl" ] model_config = ConfigDict( @@ -137,6 +143,9 @@ def to_dict(self) -> Dict[str, Any]: if _item: _items.append(_item.to_dict()) _dict['rules'] = _items + # override the default output from pydantic by calling `to_dict()` of topology + if self.topology: + _dict['topology'] = self.topology.to_dict() # puts key-value pairs in additional_properties in the top level if self.additional_properties is not None: for _key, _value in self.additional_properties.items(): @@ -176,6 +185,9 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: if obj.get("rules") is not None else None, "tags": obj.get("tags"), + "topology": + PolicyTopology.from_dict(obj["topology"]) + if obj.get("topology") is not None else None, "ttl": obj.get("ttl") }) diff --git a/src/dtc/models/policy_pool.py b/src/dtc/models/policy_pool.py index 79146cd..7932123 100644 --- a/src/dtc/models/policy_pool.py +++ b/src/dtc/models/policy_pool.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/policy_topology.py b/src/dtc/models/policy_topology.py new file mode 100644 index 0000000..53cb7a0 --- /dev/null +++ b/src/dtc/models/policy_topology.py @@ -0,0 +1,115 @@ +# coding: utf-8 + +""" + DNS DTC API + + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. + + The version of the OpenAPI document: v1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from dtc.models.policy_topology_rule_binding import PolicyTopologyRuleBinding +from typing import Optional, Set +from typing_extensions import Self + + +class PolicyTopology(BaseModel): + """ + A __PolicyTopology__ binds a __Topology__ to a __Policy__ by mapping each __TopologyRulePreset__ (by _name_) to the destination (DNS code or __Pool__) to use when that preset matches. + """ # noqa: E501 + rules: Optional[List[PolicyTopologyRuleBinding]] = Field( + default=None, + description= + "Ordered list of destination bindings, one per __TopologyRulePreset__ in the referenced __Topology__. Each binding maps a preset _name_ to the destination to use when that preset matches." + ) + topology_id: StrictStr = Field(description="The resource identifier.") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["rules", "topology_id"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PolicyTopology from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in rules (list) + _items = [] + if self.rules: + for _item in self.rules: + if _item: + _items.append(_item.to_dict()) + _dict['rules'] = _items + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PolicyTopology from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "rules": [ + PolicyTopologyRuleBinding.from_dict(_item) + for _item in obj["rules"] + ] if obj.get("rules") is not None else None, + "topology_id": + obj.get("topology_id") + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj diff --git a/src/dtc/models/policy_topology_rule_binding.py b/src/dtc/models/policy_topology_rule_binding.py new file mode 100644 index 0000000..f943560 --- /dev/null +++ b/src/dtc/models/policy_topology_rule_binding.py @@ -0,0 +1,117 @@ +# coding: utf-8 + +""" + DNS DTC API + + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. + + The version of the OpenAPI document: v1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + + +class PolicyTopologyRuleBinding(BaseModel): + """ + A __RuleBinding__ maps one __TopologyRulePreset__ (by _name_) to the destination to use when that preset matches. + """ # noqa: E501 + code: Optional[StrictStr] = Field( + default=None, + description= + "Optional. DNS code to return if the referenced preset matches. Must be set if _destination_ is _code_. Allowed values: - nodata - nxdomain Defaults to _nodata_." + ) + destination: Optional[StrictStr] = Field( + default=None, + description= + "Destination of the matched __TopologyRulePreset__. Allowed values: - code - pool Defaults to _code_." + ) + name: StrictStr = Field( + description= + "Required. Name of the __TopologyRulePreset__ from the referenced __Topology__." + ) + pool_id: Optional[StrictStr] = Field( + default=None, description="The resource identifier.") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = [ + "code", "destination", "name", "pool_id" + ] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of PolicyTopologyRuleBinding from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of PolicyTopologyRuleBinding from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "code": obj.get("code"), + "destination": obj.get("destination"), + "name": obj.get("name"), + "pool_id": obj.get("pool_id") + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj diff --git a/src/dtc/models/pool.py b/src/dtc/models/pool.py index ccdb425..cafa097 100644 --- a/src/dtc/models/pool.py +++ b/src/dtc/models/pool.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -32,6 +32,11 @@ class Pool(BaseModel): """ # noqa: E501 comment: Optional[StrictStr] = Field( default=None, description="Optional. Comment for __Pool__.") + consolidated_health_enabled: Optional[StrictBool] = Field( + default=None, + description= + "Optional. Pool-level switch that enables consolidated health probing for this __Pool__. Defaults to _false_ (consolidated health disabled). Set to _true_ to enable consolidated probing on this __Pool__. When _false_, any per-__PoolHealthCheck__ consolidation configuration is preserved in storage but suppressed at runtime." + ) disabled: Optional[StrictBool] = Field( default=None, description= @@ -53,7 +58,7 @@ class Pool(BaseModel): ) method: StrictStr = Field( description= - "Load balancing method used for selecting __Server__ assigned to __Pool__. Valid values are: * _round_robin_ If the _round_robin_ load balancing method is selected, BloxOne DDI adjusts the response to a query in a sequential and circular manner, directing clients to pools. * _ratio_ If _ratio_ load balancing method is selected, BloxOne DDI adjusts the response to a query so that clients are directed to pool using weighted round robin, a load-balancing pattern in which requests are distributed among several resources based on weight assigned to each resource. The distribution of responses over time will be equal for all available pools but the sequence of the responses won't be guaranteed. When equal weights are assigned for resources (pools) it effectively leads to basic round robin which directs clients to pools in sequential and circular manner. * _global_availability_ If _global_availability_ load balancing method is selected clients are directed to the first server that is up in the _servers_ list. Defaults to _round_robin_." + "Load balancing method used for selecting __Server__ assigned to __Pool__. Valid values are: * _round_robin_ If the _round_robin_ load balancing method is selected, Universal DDI adjusts the response to a query in a sequential and circular manner, directing clients to pools. * _ratio_ If _ratio_ load balancing method is selected, Universal DDI adjusts the response to a query so that clients are directed to pool using weighted round robin, a load-balancing pattern in which requests are distributed among several resources based on weight assigned to each resource. The distribution of responses over time will be equal for all available pools but the sequence of the responses won't be guaranteed. When equal weights are assigned for resources (pools) it effectively leads to basic round robin which directs clients to pools in sequential and circular manner. * _global_availability_ If _global_availability_ load balancing method is selected clients are directed to the first server that is up in the _servers_ list. Defaults to _round_robin_." ) name: StrictStr = Field(description="Display name of __Pool__.") pool_availability: Optional[StrictStr] = Field( @@ -91,9 +96,9 @@ class Pool(BaseModel): ) additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = [ - "comment", "disabled", "health_checks", "id", "inheritance_sources", - "metadata", "method", "name", "pool_availability", - "pool_servers_quorum", "server_availability", + "comment", "consolidated_health_enabled", "disabled", "health_checks", + "id", "inheritance_sources", "metadata", "method", "name", + "pool_availability", "pool_servers_quorum", "server_availability", "server_health_checks_quorum", "servers", "tags", "ttl" ] @@ -178,6 +183,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: _obj = cls.model_validate({ "comment": obj.get("comment"), + "consolidated_health_enabled": + obj.get("consolidated_health_enabled"), "disabled": obj.get("disabled"), "health_checks": [ diff --git a/src/dtc/models/pool_health_check.py b/src/dtc/models/pool_health_check.py index dbf9d2f..8d79d85 100644 --- a/src/dtc/models/pool_health_check.py +++ b/src/dtc/models/pool_health_check.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -18,6 +18,7 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional +from dtc.models.consolidated_health_check import ConsolidatedHealthCheck from typing import Optional, Set from typing_extensions import Self @@ -26,11 +27,18 @@ class PoolHealthCheck(BaseModel): """ A __PoolHealthCheck__ represents a link between __Pool__ and __HealthCheck__. """ # noqa: E501 + consolidated_health_check: Optional[ConsolidatedHealthCheck] = Field( + default=None, + description= + "Optional. Consolidated health check configuration. When set, the DNS server running the named designator __DNS Service__ performs the health check on behalf of the __Pool__, and the result is shared with other DNS servers linked to the __Pool__ via __LBDN__ association. When unset, each DNS server performs the health check independently and no health status is shared." + ) health_check_id: StrictStr = Field(description="The resource identifier.") name: Optional[StrictStr] = Field( default=None, description="Display name of __HealthCheck__.") additional_properties: Dict[str, Any] = {} - __properties: ClassVar[List[str]] = ["health_check_id", "name"] + __properties: ClassVar[List[str]] = [ + "consolidated_health_check", "health_check_id", "name" + ] model_config = ConfigDict( populate_by_name=True, @@ -74,6 +82,11 @@ def to_dict(self) -> Dict[str, Any]: exclude=excluded_fields, exclude_none=True, ) + # override the default output from pydantic by calling `to_dict()` of consolidated_health_check + if self.consolidated_health_check: + _dict[ + 'consolidated_health_check'] = self.consolidated_health_check.to_dict( + ) # puts key-value pairs in additional_properties in the top level if self.additional_properties is not None: for _key, _value in self.additional_properties.items(): @@ -91,8 +104,13 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: return cls.model_validate(obj) _obj = cls.model_validate({ - "health_check_id": obj.get("health_check_id"), - "name": obj.get("name") + "consolidated_health_check": + ConsolidatedHealthCheck.from_dict(obj["consolidated_health_check"]) + if obj.get("consolidated_health_check") is not None else None, + "health_check_id": + obj.get("health_check_id"), + "name": + obj.get("name") }) # store additional fields in additional_properties for _key in obj.keys(): diff --git a/src/dtc/models/pool_server.py b/src/dtc/models/pool_server.py index dd46a7f..a25e133 100644 --- a/src/dtc/models/pool_server.py +++ b/src/dtc/models/pool_server.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/read_http_health_check_response.py b/src/dtc/models/read_http_health_check_response.py index 40ac975..f948caa 100644 --- a/src/dtc/models/read_http_health_check_response.py +++ b/src/dtc/models/read_http_health_check_response.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/read_icmp_health_check_response.py b/src/dtc/models/read_icmp_health_check_response.py index f3a3b22..83080c6 100644 --- a/src/dtc/models/read_icmp_health_check_response.py +++ b/src/dtc/models/read_icmp_health_check_response.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/read_pdp_health_check_response.py b/src/dtc/models/read_pdp_health_check_response.py new file mode 100644 index 0000000..fd17e63 --- /dev/null +++ b/src/dtc/models/read_pdp_health_check_response.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + DNS DTC API + + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. + + The version of the OpenAPI document: v1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from dtc.models.pdp_health_check import PDPHealthCheck +from typing import Optional, Set +from typing_extensions import Self + + +class ReadPDPHealthCheckResponse(BaseModel): + """ + The __PDPHealthCheck__ object read response format. + """ # noqa: E501 + result: Optional[PDPHealthCheck] = Field( + default=None, description="The __PDPHealthCheck__ object.") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["result"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ReadPDPHealthCheckResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of result + if self.result: + _dict['result'] = self.result.to_dict() + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ReadPDPHealthCheckResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "result": + PDPHealthCheck.from_dict(obj["result"]) + if obj.get("result") is not None else None + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj diff --git a/src/dtc/models/read_policy_response.py b/src/dtc/models/read_policy_response.py index 9c52ba5..f7eafdc 100644 --- a/src/dtc/models/read_policy_response.py +++ b/src/dtc/models/read_policy_response.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/read_pool_response.py b/src/dtc/models/read_pool_response.py index a4d044e..ba9c5ca 100644 --- a/src/dtc/models/read_pool_response.py +++ b/src/dtc/models/read_pool_response.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/read_server_response.py b/src/dtc/models/read_server_response.py index 3b06f4b..1842d68 100644 --- a/src/dtc/models/read_server_response.py +++ b/src/dtc/models/read_server_response.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/read_sip_health_check_response.py b/src/dtc/models/read_sip_health_check_response.py new file mode 100644 index 0000000..19fe1f2 --- /dev/null +++ b/src/dtc/models/read_sip_health_check_response.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + DNS DTC API + + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. + + The version of the OpenAPI document: v1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from dtc.models.sip_health_check import SIPHealthCheck +from typing import Optional, Set +from typing_extensions import Self + + +class ReadSIPHealthCheckResponse(BaseModel): + """ + The __SIPHealthCheck__ object read response format. + """ # noqa: E501 + result: Optional[SIPHealthCheck] = Field( + default=None, description="The __SIPHealthCheck__ object.") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["result"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ReadSIPHealthCheckResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of result + if self.result: + _dict['result'] = self.result.to_dict() + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ReadSIPHealthCheckResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "result": + SIPHealthCheck.from_dict(obj["result"]) + if obj.get("result") is not None else None + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj diff --git a/src/dtc/models/read_snmp_health_check_response.py b/src/dtc/models/read_snmp_health_check_response.py index 6a88d73..919deb6 100644 --- a/src/dtc/models/read_snmp_health_check_response.py +++ b/src/dtc/models/read_snmp_health_check_response.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/read_snmp_user_security_response.py b/src/dtc/models/read_snmp_user_security_response.py index 9e61c97..dba41b8 100644 --- a/src/dtc/models/read_snmp_user_security_response.py +++ b/src/dtc/models/read_snmp_user_security_response.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/read_tcp_health_check_response.py b/src/dtc/models/read_tcp_health_check_response.py index 7cb893f..bea8e1b 100644 --- a/src/dtc/models/read_tcp_health_check_response.py +++ b/src/dtc/models/read_tcp_health_check_response.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/read_topology_response.py b/src/dtc/models/read_topology_response.py new file mode 100644 index 0000000..67911e7 --- /dev/null +++ b/src/dtc/models/read_topology_response.py @@ -0,0 +1,106 @@ +# coding: utf-8 + +""" + DNS DTC API + + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. + + The version of the OpenAPI document: v1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from dtc.models.topology import Topology +from typing import Optional, Set +from typing_extensions import Self + + +class ReadTopologyResponse(BaseModel): + """ + The __Topology__ object read response format. + """ + + # noqa: E501 + result: Optional[Topology] = Field(default=None, + description="The __Topology__ object.") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["result"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of ReadTopologyResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of result + if self.result: + _dict['result'] = self.result.to_dict() + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of ReadTopologyResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "result": + Topology.from_dict(obj["result"]) + if obj.get("result") is not None else None + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj diff --git a/src/dtc/models/record.py b/src/dtc/models/record.py index 72a30b5..051edc7 100644 --- a/src/dtc/models/record.py +++ b/src/dtc/models/record.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/server.py b/src/dtc/models/server.py index 638614a..e3ad86a 100644 --- a/src/dtc/models/server.py +++ b/src/dtc/models/server.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/sip_health_check.py b/src/dtc/models/sip_health_check.py new file mode 100644 index 0000000..9cbfd38 --- /dev/null +++ b/src/dtc/models/sip_health_check.py @@ -0,0 +1,193 @@ +# coding: utf-8 + +""" + DNS DTC API + + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. + + The version of the OpenAPI document: v1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from dtc.models.metadata import Metadata +from typing import Optional, Set +from typing_extensions import Self + + +class SIPHealthCheck(BaseModel): + """ + A __SIPHealthCheck__ (_dtc/health_check_sip_) represents a DTC __Server__ health check that probes a Session Initiation Protocol (SIP) endpoint by sending a SIP OPTIONS request over TCP or UDP. + """ # noqa: E501 + comment: Optional[StrictStr] = Field( + default=None, description="Optional. Comment for __SIPHealthCheck__.") + disabled: Optional[StrictBool] = Field( + default=None, + description= + "Optional. Flag which enables/disables __SIPHealthCheck__. Defaults to _false_." + ) + id: Optional[StrictStr] = Field(default=None, + description="The resource identifier.") + interval: Optional[StrictInt] = Field( + default=None, + description= + "Optional. Interval value in seconds. The health check runs only for the specified interval and it is measured from the beginning of the previous check cycle. Defaults to _15_." + ) + metadata: Optional[Metadata] = Field( + default=None, + description= + "Output only. __SIPHealthCheck__ metadata. Defaults to empty object and should be explicitly requested using field selection." + ) + name: StrictStr = Field(description="Display name of __SIPHealthCheck__.") + port: Optional[StrictInt] = Field( + default=None, + description= + "Optional. Destination port for the SIP OPTIONS request. Defaults to _5060_ for both TCP and UDP transport." + ) + result_code: Optional[StrictInt] = Field( + default=None, + description= + "Optional. Expected SIP response code, used with _CODE_IS_ and _CODE_IS_NOT_ result modes. Defaults to _200_." + ) + result_mode: Optional[StrictStr] = Field( + default=None, + description= + "Optional. Defines how the SIP response code is evaluated. Supported values: _ANY_, _CODE_IS_, _CODE_IS_NOT_. Defaults to _CODE_IS_." + ) + retry_down: Optional[StrictInt] = Field( + default=None, + description= + "Optional. Retry down count. The value determines how many bad health checks in a row must be received by the onprem host from the DTC Server for treating the health check as failed. Defaults to _1_." + ) + retry_up: Optional[StrictInt] = Field( + default=None, + description= + "Optional. Retry up count. The value determines how many good health checks in a row must be received by the onprem host from the DTC Server for treating the health check as successful. Defaults to _1_." + ) + tags: Optional[Dict[str, Any]] = Field( + default=None, + description="Optional. The tags for __SIPHealthCheck__ in JSON format." + ) + timeout: Optional[StrictInt] = Field( + default=None, + description= + "Optional. Timeout value in seconds. The health check waits for the specified number of seconds after sending a request. If it does not receive a response within the number of seconds, then the health check is considered as failed. Defaults to _10_." + ) + transport: Optional[StrictStr] = Field( + default=None, + description= + "Optional. Transport protocol for the SIP OPTIONS request. Supported values: _TCP_, _UDP_. Defaults to _TCP_." + ) + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = [ + "comment", "disabled", "id", "interval", "metadata", "name", "port", + "result_code", "result_mode", "retry_down", "retry_up", "tags", + "timeout", "transport" + ] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of SIPHealthCheck from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "id", + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of metadata + if self.metadata: + _dict['metadata'] = self.metadata.to_dict() + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of SIPHealthCheck from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "comment": + obj.get("comment"), + "disabled": + obj.get("disabled"), + "id": + obj.get("id"), + "interval": + obj.get("interval"), + "metadata": + Metadata.from_dict(obj["metadata"]) + if obj.get("metadata") is not None else None, + "name": + obj.get("name"), + "port": + obj.get("port"), + "result_code": + obj.get("result_code"), + "result_mode": + obj.get("result_mode"), + "retry_down": + obj.get("retry_down"), + "retry_up": + obj.get("retry_up"), + "tags": + obj.get("tags"), + "timeout": + obj.get("timeout"), + "transport": + obj.get("transport") + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj diff --git a/src/dtc/models/snmp_health_check.py b/src/dtc/models/snmp_health_check.py index 88db4f1..a080c88 100644 --- a/src/dtc/models/snmp_health_check.py +++ b/src/dtc/models/snmp_health_check.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/snmp_health_check_entry_check.py b/src/dtc/models/snmp_health_check_entry_check.py index 99a64e3..c5b66c5 100644 --- a/src/dtc/models/snmp_health_check_entry_check.py +++ b/src/dtc/models/snmp_health_check_entry_check.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/snmp_user_security_model.py b/src/dtc/models/snmp_user_security_model.py index 0b56660..d592f7f 100644 --- a/src/dtc/models/snmp_user_security_model.py +++ b/src/dtc/models/snmp_user_security_model.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/tag_rule.py b/src/dtc/models/tag_rule.py new file mode 100644 index 0000000..cb02a40 --- /dev/null +++ b/src/dtc/models/tag_rule.py @@ -0,0 +1,110 @@ +# coding: utf-8 + +""" + DNS DTC API + + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. + + The version of the OpenAPI document: v1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from typing import Optional, Set +from typing_extensions import Self + + +class TagRule(BaseModel): + """ + A __TagRule__ is a single match criterion used by a tags-based topology rule source. Each rule carries a _key_, _value_, and an optional match _op_. + """ # noqa: E501 + key: StrictStr = Field( + description= + "Required. Tag key to match against a source object's effective tags.") + op: Optional[StrictStr] = Field( + default=None, + description= + "Optional. Match operator. Supported values: - EQUALS: matches when the key exists and its value equals the configured value. - NOT_EQUALS: matches when the key exists and all values for that key differ from the configured value. A missing key does not satisfy either operator. Defaults to _EQUALS_." + ) + value: StrictStr = Field( + description= + "Required. Tag value to match against a source object's effective tags." + ) + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["key", "op", "value"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of TagRule from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of TagRule from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "key": obj.get("key"), + "op": obj.get("op"), + "value": obj.get("value") + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj diff --git a/src/dtc/models/tcp_health_check.py b/src/dtc/models/tcp_health_check.py index d385169..fe04623 100644 --- a/src/dtc/models/tcp_health_check.py +++ b/src/dtc/models/tcp_health_check.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/topology.py b/src/dtc/models/topology.py new file mode 100644 index 0000000..85858d4 --- /dev/null +++ b/src/dtc/models/topology.py @@ -0,0 +1,150 @@ +# coding: utf-8 + +""" + DNS DTC API + + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. + + The version of the OpenAPI document: v1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from dtc.models.metadata import Metadata +from dtc.models.topology_rule_preset import TopologyRulePreset +from typing import Optional, Set +from typing_extensions import Self + + +class Topology(BaseModel): + """ + A __Topology__ (_dtc/topology_) is a reusable, named set of __TopologyRulePreset__ objects that provide deterministic infrastructure classification for DTC __Policy__ evaluation using infrastructure source object tags. + """ # noqa: E501 + comment: Optional[StrictStr] = Field( + default=None, description="Optional. Comment for __Topology__.") + disabled: Optional[StrictBool] = Field( + default=None, + description= + "Optional. Flag which enables/disables __Topology__. Defaults to _false_." + ) + id: Optional[StrictStr] = Field(default=None, + description="The resource identifier.") + metadata: Optional[Metadata] = Field( + default=None, + description= + "Output only. __Topology__ metadata. Defaults to empty object and should be explicitly requested using field selection." + ) + name: StrictStr = Field(description="Display name of __Topology__.") + rules: Optional[List[TopologyRulePreset]] = Field( + default=None, + description= + "List of __TopologyRulePreset__ objects defining the resolving strategy for __Policy__. Preset names must be unique within __Topology__. Defaults to a list with a single, default __TopologyRulePreset__." + ) + tags: Optional[Dict[str, Any]] = Field( + default=None, + description="Optional. The tags for __Topology__ in JSON format.") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = [ + "comment", "disabled", "id", "metadata", "name", "rules", "tags" + ] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of Topology from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * OpenAPI `readOnly` fields are excluded. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "id", + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of metadata + if self.metadata: + _dict['metadata'] = self.metadata.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in rules (list) + _items = [] + if self.rules: + for _item in self.rules: + if _item: + _items.append(_item.to_dict()) + _dict['rules'] = _items + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of Topology from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "comment": + obj.get("comment"), + "disabled": + obj.get("disabled"), + "id": + obj.get("id"), + "metadata": + Metadata.from_dict(obj["metadata"]) + if obj.get("metadata") is not None else None, + "name": + obj.get("name"), + "rules": + [TopologyRulePreset.from_dict(_item) for _item in obj["rules"]] + if obj.get("rules") is not None else None, + "tags": + obj.get("tags") + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj diff --git a/src/dtc/models/topology_rule.py b/src/dtc/models/topology_rule.py index 2fe7c77..a306631 100644 --- a/src/dtc/models/topology_rule.py +++ b/src/dtc/models/topology_rule.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) @@ -18,6 +18,7 @@ from pydantic import BaseModel, ConfigDict, Field, StrictStr from typing import Any, ClassVar, Dict, List, Optional +from dtc.models.tag_rule import TagRule from typing import Optional, Set from typing_extensions import Self @@ -42,16 +43,21 @@ class TopologyRule(BaseModel): source: Optional[StrictStr] = Field( default=None, description= - "Type of source. Allowed values: - subnet - default Defaults to _default_." + "Type of source. Allowed values: - subnet - tags - default Defaults to _default_." ) subnets: Optional[List[StrictStr]] = Field( default=None, description= "Optional. List of subnets in CIDR format. Must be set if _source_ is _subnet_, otherwise must be empty." ) + tags: Optional[List[TagRule]] = Field( + default=None, + description= + "Optional. List of tag rules to match against a source object's effective tags. Effective tags = direct tags plus tags inherited from the IPAM parent chain (IPSpace → Address Block → Subnet); the closer level wins on key conflicts. All rules use AND semantics: an object must satisfy every __TagRule__ to match. Must be set if _source_ is _tags_, otherwise must be empty." + ) additional_properties: Dict[str, Any] = {} __properties: ClassVar[List[str]] = [ - "code", "destination", "name", "pool_id", "source", "subnets" + "code", "destination", "name", "pool_id", "source", "subnets", "tags" ] model_config = ConfigDict( @@ -94,6 +100,13 @@ def to_dict(self) -> Dict[str, Any]: exclude=excluded_fields, exclude_none=True, ) + # override the default output from pydantic by calling `to_dict()` of each item in tags (list) + _items = [] + if self.tags: + for _item in self.tags: + if _item: + _items.append(_item.to_dict()) + _dict['tags'] = _items # puts key-value pairs in additional_properties in the top level if self.additional_properties is not None: for _key, _value in self.additional_properties.items(): @@ -111,12 +124,21 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: return cls.model_validate(obj) _obj = cls.model_validate({ - "code": obj.get("code"), - "destination": obj.get("destination"), - "name": obj.get("name"), - "pool_id": obj.get("pool_id"), - "source": obj.get("source"), - "subnets": obj.get("subnets") + "code": + obj.get("code"), + "destination": + obj.get("destination"), + "name": + obj.get("name"), + "pool_id": + obj.get("pool_id"), + "source": + obj.get("source"), + "subnets": + obj.get("subnets"), + "tags": + [TagRule.from_dict(_item) + for _item in obj["tags"]] if obj.get("tags") is not None else None }) # store additional fields in additional_properties for _key in obj.keys(): diff --git a/src/dtc/models/topology_rule_preset.py b/src/dtc/models/topology_rule_preset.py new file mode 100644 index 0000000..2478e9f --- /dev/null +++ b/src/dtc/models/topology_rule_preset.py @@ -0,0 +1,131 @@ +# coding: utf-8 + +""" + DNS DTC API + + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. + + The version of the OpenAPI document: v1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field, StrictStr +from typing import Any, ClassVar, Dict, List, Optional +from dtc.models.tag_rule import TagRule +from typing import Optional, Set +from typing_extensions import Self + + +class TopologyRulePreset(BaseModel): + """ + A __TopologyRulePreset__ is a named set of match criteria for classifying infrastructure source objects. A __Topology__ holds an ordered list of __TopologyRulePreset__ objects evaluated top to bottom; the first preset whose criteria all match wins. Destination (DNS code or __Pool__) is configured separately per __Policy__ in __PolicyTopology.RuleBinding__, not on the preset itself. + """ # noqa: E501 + name: StrictStr = Field( + description= + "Required. Display name of __TopologyRulePreset__. Must be unique within __Topology__." + ) + source: Optional[StrictStr] = Field( + default=None, + description= + "Type of source. Allowed values: - subnet - tags - default Defaults to _default_." + ) + subnets: Optional[List[StrictStr]] = Field( + default=None, + description= + "Optional. List of subnets in CIDR format. Must be set if _source_ is _subnet_, otherwise must be empty." + ) + tags: Optional[List[TagRule]] = Field( + default=None, + description= + "Optional. List of tag rules to match against a source object's effective tags. Effective tags = direct tags plus tags inherited from the IPAM parent chain (IPSpace → Address Block → Subnet); the closer level wins on key conflicts. All rules use AND semantics: an object must satisfy every __TagRule__ to match. Must be set if _source_ is _tags_, otherwise must be empty." + ) + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["name", "source", "subnets", "tags"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of TopologyRulePreset from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of each item in tags (list) + _items = [] + if self.tags: + for _item in self.tags: + if _item: + _items.append(_item.to_dict()) + _dict['tags'] = _items + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of TopologyRulePreset from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "name": + obj.get("name"), + "source": + obj.get("source"), + "subnets": + obj.get("subnets"), + "tags": + [TagRule.from_dict(_item) + for _item in obj["tags"]] if obj.get("tags") is not None else None + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj diff --git a/src/dtc/models/ttl_inheritance.py b/src/dtc/models/ttl_inheritance.py index 0d6fb1f..aa44f1d 100644 --- a/src/dtc/models/ttl_inheritance.py +++ b/src/dtc/models/ttl_inheritance.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/update_http_health_check_response.py b/src/dtc/models/update_http_health_check_response.py index 8999ec6..2863804 100644 --- a/src/dtc/models/update_http_health_check_response.py +++ b/src/dtc/models/update_http_health_check_response.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/update_icmp_health_check_response.py b/src/dtc/models/update_icmp_health_check_response.py index 611fa68..5e167ca 100644 --- a/src/dtc/models/update_icmp_health_check_response.py +++ b/src/dtc/models/update_icmp_health_check_response.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/update_pdp_health_check_response.py b/src/dtc/models/update_pdp_health_check_response.py new file mode 100644 index 0000000..ce98c8e --- /dev/null +++ b/src/dtc/models/update_pdp_health_check_response.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + DNS DTC API + + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. + + The version of the OpenAPI document: v1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from dtc.models.pdp_health_check import PDPHealthCheck +from typing import Optional, Set +from typing_extensions import Self + + +class UpdatePDPHealthCheckResponse(BaseModel): + """ + The __PDPHealthCheck__ object update response format. + """ # noqa: E501 + result: Optional[PDPHealthCheck] = Field( + default=None, description="The __PDPHealthCheck__ object.") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["result"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of UpdatePDPHealthCheckResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of result + if self.result: + _dict['result'] = self.result.to_dict() + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of UpdatePDPHealthCheckResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "result": + PDPHealthCheck.from_dict(obj["result"]) + if obj.get("result") is not None else None + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj diff --git a/src/dtc/models/update_policy_response.py b/src/dtc/models/update_policy_response.py index 2843eb5..054e8a2 100644 --- a/src/dtc/models/update_policy_response.py +++ b/src/dtc/models/update_policy_response.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/update_pool_response.py b/src/dtc/models/update_pool_response.py index b42afb4..feaafe9 100644 --- a/src/dtc/models/update_pool_response.py +++ b/src/dtc/models/update_pool_response.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/update_server_response.py b/src/dtc/models/update_server_response.py index 8017de5..73e1426 100644 --- a/src/dtc/models/update_server_response.py +++ b/src/dtc/models/update_server_response.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/update_sip_health_check_response.py b/src/dtc/models/update_sip_health_check_response.py new file mode 100644 index 0000000..db0c220 --- /dev/null +++ b/src/dtc/models/update_sip_health_check_response.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + DNS DTC API + + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. + + The version of the OpenAPI document: v1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from dtc.models.sip_health_check import SIPHealthCheck +from typing import Optional, Set +from typing_extensions import Self + + +class UpdateSIPHealthCheckResponse(BaseModel): + """ + The __SIPHealthCheck__ object update response format. + """ # noqa: E501 + result: Optional[SIPHealthCheck] = Field( + default=None, description="The __SIPHealthCheck__ object.") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["result"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of UpdateSIPHealthCheckResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of result + if self.result: + _dict['result'] = self.result.to_dict() + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of UpdateSIPHealthCheckResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "result": + SIPHealthCheck.from_dict(obj["result"]) + if obj.get("result") is not None else None + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj diff --git a/src/dtc/models/update_snmp_health_check_response.py b/src/dtc/models/update_snmp_health_check_response.py index a432b49..2743857 100644 --- a/src/dtc/models/update_snmp_health_check_response.py +++ b/src/dtc/models/update_snmp_health_check_response.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/update_snmp_user_security_response.py b/src/dtc/models/update_snmp_user_security_response.py index 059a327..9ecd77d 100644 --- a/src/dtc/models/update_snmp_user_security_response.py +++ b/src/dtc/models/update_snmp_user_security_response.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/update_tcp_health_check_response.py b/src/dtc/models/update_tcp_health_check_response.py index e0fc317..a8de7ae 100644 --- a/src/dtc/models/update_tcp_health_check_response.py +++ b/src/dtc/models/update_tcp_health_check_response.py @@ -3,7 +3,7 @@ """ DNS DTC API - The DNS DTC is a BloxOne DDI service providing load balanced DNS resolution. + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. The version of the OpenAPI document: v1 Generated by OpenAPI Generator (https://openapi-generator.tech) diff --git a/src/dtc/models/update_topology_response.py b/src/dtc/models/update_topology_response.py new file mode 100644 index 0000000..3d94995 --- /dev/null +++ b/src/dtc/models/update_topology_response.py @@ -0,0 +1,104 @@ +# coding: utf-8 + +""" + DNS DTC API + + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. + + The version of the OpenAPI document: v1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +from __future__ import annotations +import pprint +import re # noqa: F401 +import json + +from pydantic import BaseModel, ConfigDict, Field +from typing import Any, ClassVar, Dict, List, Optional +from dtc.models.topology import Topology +from typing import Optional, Set +from typing_extensions import Self + + +class UpdateTopologyResponse(BaseModel): + """ + The __Topology__ object update response format. + """ # noqa: E501 + result: Optional[Topology] = Field(default=None, + description="The __Topology__ object.") + additional_properties: Dict[str, Any] = {} + __properties: ClassVar[List[str]] = ["result"] + + model_config = ConfigDict( + populate_by_name=True, + validate_assignment=True, + protected_namespaces=(), + ) + + def to_str(self) -> str: + """Returns the string representation of the model using alias""" + return pprint.pformat(self.model_dump(by_alias=True)) + + def to_json(self) -> str: + """Returns the JSON representation of the model using alias""" + # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead + return json.dumps(self.to_dict()) + + @classmethod + def from_json(cls, json_str: str) -> Optional[Self]: + """Create an instance of UpdateTopologyResponse from a JSON string""" + return cls.from_dict(json.loads(json_str)) + + def to_dict(self) -> Dict[str, Any]: + """Return the dictionary representation of the model using alias. + + This has the following differences from calling pydantic's + `self.model_dump(by_alias=True)`: + + * `None` is only added to the output dict for nullable fields that + were set at model initialization. Other fields with value `None` + are ignored. + * Fields in `self.additional_properties` are added to the output dict. + """ + excluded_fields: Set[str] = set([ + "additional_properties", + ]) + + _dict = self.model_dump( + by_alias=True, + exclude=excluded_fields, + exclude_none=True, + ) + # override the default output from pydantic by calling `to_dict()` of result + if self.result: + _dict['result'] = self.result.to_dict() + # puts key-value pairs in additional_properties in the top level + if self.additional_properties is not None: + for _key, _value in self.additional_properties.items(): + _dict[_key] = _value + + return _dict + + @classmethod + def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: + """Create an instance of UpdateTopologyResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "result": + Topology.from_dict(obj["result"]) + if obj.get("result") is not None else None + }) + # store additional fields in additional_properties + for _key in obj.keys(): + if _key not in cls.__properties: + _obj.additional_properties[_key] = obj.get(_key) + + return _obj diff --git a/src/dtc/test/test_health_check_pdp_api.py b/src/dtc/test/test_health_check_pdp_api.py new file mode 100644 index 0000000..2e7f161 --- /dev/null +++ b/src/dtc/test/test_health_check_pdp_api.py @@ -0,0 +1,68 @@ +# coding: utf-8 + +""" + DNS DTC API + + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. + + The version of the OpenAPI document: v1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import unittest + +from dtc.api.health_check_pdp_api import HealthCheckPdpApi + +from universal_ddi_client.api_client import ApiClient + + +class TestHealthCheckPdpApi(unittest.TestCase): + """HealthCheckPdpApi unit test stubs""" + + def setUp(self) -> None: + api_instance = ApiClient() + self.api = HealthCheckPdpApi(api_instance) + + def tearDown(self) -> None: + pass + + def test_create(self) -> None: + """Test case for create + + Create the PDPHealthCheck object. + """ + pass + + def test_delete(self) -> None: + """Test case for delete + + Delete the PDPHealthCheck object. + """ + pass + + def test_list(self) -> None: + """Test case for list + + Retrieve PDPHealthCheck objects. + """ + pass + + def test_read(self) -> None: + """Test case for read + + Retrieve the PDPHealthCheck object. + """ + pass + + def test_update(self) -> None: + """Test case for update + + Update the PDPHealthCheck object. + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/dtc/test/test_health_check_sip_api.py b/src/dtc/test/test_health_check_sip_api.py new file mode 100644 index 0000000..2a4c611 --- /dev/null +++ b/src/dtc/test/test_health_check_sip_api.py @@ -0,0 +1,68 @@ +# coding: utf-8 + +""" + DNS DTC API + + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. + + The version of the OpenAPI document: v1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import unittest + +from dtc.api.health_check_sip_api import HealthCheckSipApi + +from universal_ddi_client.api_client import ApiClient + + +class TestHealthCheckSipApi(unittest.TestCase): + """HealthCheckSipApi unit test stubs""" + + def setUp(self) -> None: + api_instance = ApiClient() + self.api = HealthCheckSipApi(api_instance) + + def tearDown(self) -> None: + pass + + def test_create(self) -> None: + """Test case for create + + Create the SIPHealthCheck object. + """ + pass + + def test_delete(self) -> None: + """Test case for delete + + Delete the SIPHealthCheck object. + """ + pass + + def test_list(self) -> None: + """Test case for list + + Retrieve SIPHealthCheck objects. + """ + pass + + def test_read(self) -> None: + """Test case for read + + Retrieve the SIPHealthCheck object. + """ + pass + + def test_update(self) -> None: + """Test case for update + + Update the SIPHealthCheck object. + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/src/dtc/test/test_topology_api.py b/src/dtc/test/test_topology_api.py new file mode 100644 index 0000000..e9a98bc --- /dev/null +++ b/src/dtc/test/test_topology_api.py @@ -0,0 +1,68 @@ +# coding: utf-8 + +""" + DNS DTC API + + The DNS DTC is a Universal DDI service providing load balanced DNS resolution. + + The version of the OpenAPI document: v1 + Generated by OpenAPI Generator (https://openapi-generator.tech) + + Do not edit the class manually. +""" # noqa: E501 + +import unittest + +from dtc.api.topology_api import TopologyApi + +from universal_ddi_client.api_client import ApiClient + + +class TestTopologyApi(unittest.TestCase): + """TopologyApi unit test stubs""" + + def setUp(self) -> None: + api_instance = ApiClient() + self.api = TopologyApi(api_instance) + + def tearDown(self) -> None: + pass + + def test_create(self) -> None: + """Test case for create + + Create the Topology object. + """ + pass + + def test_delete(self) -> None: + """Test case for delete + + Delete the Topology object. + """ + pass + + def test_list(self) -> None: + """Test case for list + + Retrieve Topology objects. + """ + pass + + def test_read(self) -> None: + """Test case for read + + Retrieve the Topology object. + """ + pass + + def test_update(self) -> None: + """Test case for update + + Update the Topology object. + """ + pass + + +if __name__ == '__main__': + unittest.main()