geonode.geoserver.acl.gsauth_client.api.rules_api

GeoServer ACL

GeoServer Access Control List API # noqa: E501

The version of the OpenAPI document: 1.0.0 Generated by: https://openapi-generator.tech

Classes

RulesApi

NOTE: This class is auto generated by OpenAPI Generator

Module Contents

class geonode.geoserver.acl.gsauth_client.api.rules_api.RulesApi(api_client=None)[source]

Bases: object

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

api_client[source]
count_all_rules(**kwargs)[source]

count_all_rules # noqa: E501

Returns the total number of rules # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.count_all_rules(async_req=True)
>>> result = thread.get()
Parameters:

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _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.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

int

count_all_rules_with_http_info(**kwargs)[source]

count_all_rules # noqa: E501

Returns the total number of rules # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.count_all_rules_with_http_info(async_req=True)
>>> result = thread.get()
Parameters:

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _return_http_data_only (bool, optional) – response data without head status code and headers

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _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.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(int, status_code(int), headers(HTTPHeaderDict))

count_rules(rule_filter, **kwargs)[source]

count_rules # noqa: E501

Returns the number of rules that matches the search criteria # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.count_rules(rule_filter, async_req=True)
>>> result = thread.get()
Parameters:

  • rule_filter (RuleFilter) – (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _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.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

int

count_rules_with_http_info(rule_filter, **kwargs)[source]

count_rules # noqa: E501

Returns the number of rules that matches the search criteria # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.count_rules_with_http_info(rule_filter, async_req=True)
>>> result = thread.get()
Parameters:

  • rule_filter (RuleFilter) – (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _return_http_data_only (bool, optional) – response data without head status code and headers

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _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.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(int, status_code(int), headers(HTTPHeaderDict))

create_rule(rule, **kwargs)[source]

create_rule # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.create_rule(rule, async_req=True)
>>> result = thread.get()
Parameters:

  • rule (Rule) – (required)

  • position (InsertPosition) – Displacement option related to how to interpret the Rule’s priority

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _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.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

Rule

create_rule_with_http_info(rule, **kwargs)[source]

create_rule # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.create_rule_with_http_info(rule, async_req=True)
>>> result = thread.get()
Parameters:

  • rule (Rule) – (required)

  • position (InsertPosition) – Displacement option related to how to interpret the Rule’s priority

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _return_http_data_only (bool, optional) – response data without head status code and headers

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _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.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(Rule, status_code(int), headers(HTTPHeaderDict))

delete_rule_by_id(id, **kwargs)[source]

delete_rule_by_id # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.delete_rule_by_id(id, async_req=True)
>>> result = thread.get()
Parameters:

  • id (str) – The rule identifier (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _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.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

None

delete_rule_by_id_with_http_info(id, **kwargs)[source]

delete_rule_by_id # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.delete_rule_by_id_with_http_info(id, async_req=True)
>>> result = thread.get()
Parameters:

  • id (str) – The rule identifier (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _return_http_data_only (bool, optional) – response data without head status code and headers

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _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.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

None

find_one_rule_by_priority(priority, **kwargs)[source]

find_one_rule_by_priority # noqa: E501

Finds the Rule with the given priority # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.find_one_rule_by_priority(priority, async_req=True)
>>> result = thread.get()
Parameters:

  • priority (int) – The rule priority to search for (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _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.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

Rule

find_one_rule_by_priority_with_http_info(priority, **kwargs)[source]

find_one_rule_by_priority # noqa: E501

Finds the Rule with the given priority # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.find_one_rule_by_priority_with_http_info(priority, async_req=True)
>>> result = thread.get()
Parameters:

  • priority (int) – The rule priority to search for (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _return_http_data_only (bool, optional) – response data without head status code and headers

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _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.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(Rule, status_code(int), headers(HTTPHeaderDict))

get_layer_details_by_rule_id(id, **kwargs)[source]

get_layer_details_by_rule_id # noqa: E501

Returns the LayerDetails for the Rule with the given identifier # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_layer_details_by_rule_id(id, async_req=True)
>>> result = thread.get()
Parameters:

  • id (str) – The rule identifier (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _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.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

LayerDetails

get_layer_details_by_rule_id_with_http_info(id, **kwargs)[source]

get_layer_details_by_rule_id # noqa: E501

Returns the LayerDetails for the Rule with the given identifier # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_layer_details_by_rule_id_with_http_info(id, async_req=True)
>>> result = thread.get()
Parameters:

  • id (str) – The rule identifier (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _return_http_data_only (bool, optional) – response data without head status code and headers

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _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.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(LayerDetails, status_code(int), headers(HTTPHeaderDict))

get_rule_by_id(id, **kwargs)[source]

get_rule_by_id # noqa: E501

Returns the Rule with the given identifier # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_rule_by_id(id, async_req=True)
>>> result = thread.get()
Parameters:

  • id (str) – The rule identifier (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _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.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

Rule

get_rule_by_id_with_http_info(id, **kwargs)[source]

get_rule_by_id # noqa: E501

Returns the Rule with the given identifier # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_rule_by_id_with_http_info(id, async_req=True)
>>> result = thread.get()
Parameters:

  • id (str) – The rule identifier (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _return_http_data_only (bool, optional) – response data without head status code and headers

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _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.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(Rule, status_code(int), headers(HTTPHeaderDict))

get_rules(**kwargs)[source]

get_rules # noqa: E501

Returns an (optionally) paginated list of rules. See also the count operation. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_rules(async_req=True)
>>> result = thread.get()
Parameters:

  • limit (int) – Maximum number of rules to return from the query. If there are more rules, the response will return an X-ACL-NEXTCURSOR header with a value that can be used for the nextCursor parameter on a subsequent request, until X-ACL-NEXTCURSOR is null

  • next_cursor (str) – The next cursor identifier when doing cursor paging, as returned by the X-ACL-NEXTCURSOR response header

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _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.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

list[Rule]

get_rules_with_http_info(**kwargs)[source]

get_rules # noqa: E501

Returns an (optionally) paginated list of rules. See also the count operation. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_rules_with_http_info(async_req=True)
>>> result = thread.get()
Parameters:

  • limit (int) – Maximum number of rules to return from the query. If there are more rules, the response will return an X-ACL-NEXTCURSOR header with a value that can be used for the nextCursor parameter on a subsequent request, until X-ACL-NEXTCURSOR is null

  • next_cursor (str) – The next cursor identifier when doing cursor paging, as returned by the X-ACL-NEXTCURSOR response header

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _return_http_data_only (bool, optional) – response data without head status code and headers

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _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.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(list[Rule], status_code(int), headers(HTTPHeaderDict))

query_rules(**kwargs)[source]

query_rules # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.query_rules(async_req=True)
>>> result = thread.get()
Parameters:

  • limit (int) – Maximum number of rules to return from the query. If there are more rules, the response will return an X-ACL-NEXTCURSOR header with a value that can be used for the nextCursor parameter on a subsequent request, until X-ACL-NEXTCURSOR is null

  • next_cursor (str) – The next cursor identifier when doing cursor paging, as returned by the X-ACL-NEXTCURSOR response header

  • rule_filter (RuleFilter)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _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.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

list[Rule]

query_rules_with_http_info(**kwargs)[source]

query_rules # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.query_rules_with_http_info(async_req=True)
>>> result = thread.get()
Parameters:

  • limit (int) – Maximum number of rules to return from the query. If there are more rules, the response will return an X-ACL-NEXTCURSOR header with a value that can be used for the nextCursor parameter on a subsequent request, until X-ACL-NEXTCURSOR is null

  • next_cursor (str) – The next cursor identifier when doing cursor paging, as returned by the X-ACL-NEXTCURSOR response header

  • rule_filter (RuleFilter)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _return_http_data_only (bool, optional) – response data without head status code and headers

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _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.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(list[Rule], status_code(int), headers(HTTPHeaderDict))

rule_exists_by_id(id, **kwargs)[source]

rule_exists_by_id # noqa: E501

Returns the Rule with the given identifier # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.rule_exists_by_id(id, async_req=True)
>>> result = thread.get()
Parameters:

  • id (str) – The rule identifier (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _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.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

bool

rule_exists_by_id_with_http_info(id, **kwargs)[source]

rule_exists_by_id # noqa: E501

Returns the Rule with the given identifier # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.rule_exists_by_id_with_http_info(id, async_req=True)
>>> result = thread.get()
Parameters:

  • id (str) – The rule identifier (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _return_http_data_only (bool, optional) – response data without head status code and headers

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _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.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(bool, status_code(int), headers(HTTPHeaderDict))

set_rule_allowed_styles(id, **kwargs)[source]

set_rule_allowed_styles # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.set_rule_allowed_styles(id, async_req=True)
>>> result = thread.get()
Parameters:

  • id (str) – The rule identifier (required)

  • request_body (list[str])

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _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.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

None

set_rule_allowed_styles_with_http_info(id, **kwargs)[source]

set_rule_allowed_styles # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.set_rule_allowed_styles_with_http_info(id, async_req=True)
>>> result = thread.get()
Parameters:

  • id (str) – The rule identifier (required)

  • request_body (list[str])

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _return_http_data_only (bool, optional) – response data without head status code and headers

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _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.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

None

set_rule_layer_details(id, **kwargs)[source]

set_rule_layer_details # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.set_rule_layer_details(id, async_req=True)
>>> result = thread.get()
Parameters:

  • id (str) – The rule identifier (required)

  • layer_details (LayerDetails)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _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.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

None

set_rule_layer_details_with_http_info(id, **kwargs)[source]

set_rule_layer_details # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.set_rule_layer_details_with_http_info(id, async_req=True)
>>> result = thread.get()
Parameters:

  • id (str) – The rule identifier (required)

  • layer_details (LayerDetails)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _return_http_data_only (bool, optional) – response data without head status code and headers

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _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.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

None

set_rule_limits(id, **kwargs)[source]

set_rule_limits # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.set_rule_limits(id, async_req=True)
>>> result = thread.get()
Parameters:

  • id (str) – The rule identifier (required)

  • rule_limits (RuleLimits)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _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.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

None

set_rule_limits_with_http_info(id, **kwargs)[source]

set_rule_limits # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.set_rule_limits_with_http_info(id, async_req=True)
>>> result = thread.get()
Parameters:

  • id (str) – The rule identifier (required)

  • rule_limits (RuleLimits)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _return_http_data_only (bool, optional) – response data without head status code and headers

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _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.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

None

shift_rules_by_priority(priority_start, offset, **kwargs)[source]

shift_rules_by_priority # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.shift_rules_by_priority(priority_start, offset, async_req=True)
>>> result = thread.get()
Parameters:

  • priority_start (int) – The minimum priority to start shifting at (inclusive) (required)

  • offset (int) – The priority offset to apply to all rules from priorityStart onwards (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _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.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

int

shift_rules_by_priority_with_http_info(priority_start, offset, **kwargs)[source]

shift_rules_by_priority # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.shift_rules_by_priority_with_http_info(priority_start, offset, async_req=True)
>>> result = thread.get()
Parameters:

  • priority_start (int) – The minimum priority to start shifting at (inclusive) (required)

  • offset (int) – The priority offset to apply to all rules from priorityStart onwards (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _return_http_data_only (bool, optional) – response data without head status code and headers

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _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.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(int, status_code(int), headers(HTTPHeaderDict))

swap_rules(id, id2, **kwargs)[source]

swap_rules # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.swap_rules(id, id2, async_req=True)
>>> result = thread.get()
Parameters:

  • id (str) – The rule identifier (required)

  • id2 (str) – The rule identifier to swap priorities with (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _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.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

None

swap_rules_with_http_info(id, id2, **kwargs)[source]

swap_rules # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.swap_rules_with_http_info(id, id2, async_req=True)
>>> result = thread.get()
Parameters:

  • id (str) – The rule identifier (required)

  • id2 (str) – The rule identifier to swap priorities with (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _return_http_data_only (bool, optional) – response data without head status code and headers

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _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.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

None

update_rule_by_id(id, rule, **kwargs)[source]

update_rule_by_id # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.update_rule_by_id(id, rule, async_req=True)
>>> result = thread.get()
Parameters:

  • id (str) – The rule identifier (required)

  • rule (Rule) – (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _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.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

Rule

update_rule_by_id_with_http_info(id, rule, **kwargs)[source]

update_rule_by_id # noqa: E501

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.update_rule_by_id_with_http_info(id, rule, async_req=True)
>>> result = thread.get()
Parameters:

  • id (str) – The rule identifier (required)

  • rule (Rule) – (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _return_http_data_only (bool, optional) – response data without head status code and headers

  • _preload_content (bool, optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _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.

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(Rule, status_code(int), headers(HTTPHeaderDict))