geonode.geoserver.acl.gsauth_client

GeoServer ACL

GeoServer Access Control List API # noqa: E501

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

Subpackages

Submodules

Attributes

__version__

Exceptions

`OpenApiException`	The base exception class for all OpenAPIExceptions
`ApiTypeError`	The base exception class for all OpenAPIExceptions
`ApiValueError`	The base exception class for all OpenAPIExceptions
`ApiKeyError`	The base exception class for all OpenAPIExceptions
`ApiAttributeError`	The base exception class for all OpenAPIExceptions
`ApiException`	The base exception class for all OpenAPIExceptions

Classes

`AdminRulesApi`	NOTE: This class is auto generated by OpenAPI Generator
`AuthorizationApi`	NOTE: This class is auto generated by OpenAPI Generator
`RulesApi`	NOTE: This class is auto generated by OpenAPI Generator
`ApiClient`	Generic API client for OpenAPI client library builds.
`Configuration`	NOTE: This class is auto generated by OpenAPI Generator
`AccessInfo`	NOTE: This class is auto generated by OpenAPI Generator.
`AccessRequest`	NOTE: This class is auto generated by OpenAPI Generator.
`AddressRangeFilter`	NOTE: This class is auto generated by OpenAPI Generator.
`AdminAccessInfo`	NOTE: This class is auto generated by OpenAPI Generator.
`AdminAccessRequest`	NOTE: This class is auto generated by OpenAPI Generator.
`AdminGrantType`	NOTE: This class is auto generated by OpenAPI Generator.
`AdminRule`	NOTE: This class is auto generated by OpenAPI Generator.
`AdminRuleFilter`	NOTE: This class is auto generated by OpenAPI Generator.
`CatalogMode`	NOTE: This class is auto generated by OpenAPI Generator.
`Geom`	NOTE: This class is auto generated by OpenAPI Generator.
`GrantType`	NOTE: This class is auto generated by OpenAPI Generator.
`InsertPosition`	NOTE: This class is auto generated by OpenAPI Generator.
`LayerAttribute`	NOTE: This class is auto generated by OpenAPI Generator.
`LayerDetails`	NOTE: This class is auto generated by OpenAPI Generator.
`Rule`	NOTE: This class is auto generated by OpenAPI Generator.
`RuleFilter`	NOTE: This class is auto generated by OpenAPI Generator.
`RuleLimits`	NOTE: This class is auto generated by OpenAPI Generator.
`SetFilter`	NOTE: This class is auto generated by OpenAPI Generator.
`SpatialFilterType`	NOTE: This class is auto generated by OpenAPI Generator.
`TextFilter`	NOTE: This class is auto generated by OpenAPI Generator.
`Wkb`	NOTE: This class is auto generated by OpenAPI Generator.
`Wkt`	NOTE: This class is auto generated by OpenAPI Generator.

Package Contents

geonode.geoserver.acl.gsauth_client.__version__ = '1.0.0'[source]

class geonode.geoserver.acl.gsauth_client.AdminRulesApi(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

admin_rule_exists_by_id(id, **kwargs)[source]

admin_rule_exists_by_id # noqa: E501

Returns whether the AdminRule with the given identifier exists # noqa: E501

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

>>> thread = api.admin_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

admin_rule_exists_by_id_with_http_info(id, **kwargs)[source]

admin_rule_exists_by_id # noqa: E501

Returns whether the AdminRule with the given identifier exists # noqa: E501

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

>>> thread = api.admin_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))

count_admin_rules(admin_rule_filter, **kwargs)[source]

count_admin_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_admin_rules(admin_rule_filter, async_req=True)
>>> result = thread.get()

Parameters:

admin_rule_filter (AdminRuleFilter) – (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_admin_rules_with_http_info(admin_rule_filter, **kwargs)[source]

count_admin_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_admin_rules_with_http_info(admin_rule_filter, async_req=True)
>>> result = thread.get()

Parameters:

admin_rule_filter (AdminRuleFilter) – (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))

count_all_admin_rules(**kwargs)[source]

count_all_admin_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_admin_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_admin_rules_with_http_info(**kwargs)[source]

count_all_admin_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_admin_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))

create_admin_rule(admin_rule, **kwargs)[source]

create_admin_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_admin_rule(admin_rule, async_req=True)
>>> result = thread.get()

Parameters:

admin_rule (AdminRule) – (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:

AdminRule

create_admin_rule_with_http_info(admin_rule, **kwargs)[source]

create_admin_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_admin_rule_with_http_info(admin_rule, async_req=True)
>>> result = thread.get()

Parameters:

admin_rule (AdminRule) – (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(AdminRule, status_code(int), headers(HTTPHeaderDict))

delete_admin_rule_by_id(id, **kwargs)[source]

delete_admin_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_admin_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_admin_rule_by_id_with_http_info(id, **kwargs)[source]

delete_admin_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_admin_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_admin_rules(**kwargs)[source]

find_admin_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.find_admin_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
admin_rule_filter (AdminRuleFilter)
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[AdminRule]

find_admin_rules_with_http_info(**kwargs)[source]

find_admin_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.find_admin_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
admin_rule_filter (AdminRuleFilter)
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[AdminRule], status_code(int), headers(HTTPHeaderDict))

find_all_admin_rules(**kwargs)[source]

find_all_admin_rules # noqa: E501

Returns an (optionally) paginated list of admin 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.find_all_admin_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[AdminRule]

find_all_admin_rules_with_http_info(**kwargs)[source]

find_all_admin_rules # noqa: E501

Returns an (optionally) paginated list of admin 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.find_all_admin_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[AdminRule], status_code(int), headers(HTTPHeaderDict))

find_first_admin_rule(admin_rule_filter, **kwargs)[source]

find_first_admin_rule # noqa: E501

Finds the first rule that satisfies the query 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.find_first_admin_rule(admin_rule_filter, async_req=True)
>>> result = thread.get()

Parameters:

admin_rule_filter (AdminRuleFilter) – (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:

AdminRule

find_first_admin_rule_with_http_info(admin_rule_filter, **kwargs)[source]

find_first_admin_rule # noqa: E501

Finds the first rule that satisfies the query 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.find_first_admin_rule_with_http_info(admin_rule_filter, async_req=True)
>>> result = thread.get()

Parameters:

admin_rule_filter (AdminRuleFilter) – (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(AdminRule, status_code(int), headers(HTTPHeaderDict))

find_one_admin_rule_by_priority(priority, **kwargs)[source]

find_one_admin_rule_by_priority # noqa: E501

Finds the AdminRule 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_admin_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:

AdminRule

find_one_admin_rule_by_priority_with_http_info(priority, **kwargs)[source]

find_one_admin_rule_by_priority # noqa: E501

Finds the AdminRule 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_admin_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(AdminRule, status_code(int), headers(HTTPHeaderDict))

get_admin_rule_by_id(id, **kwargs)[source]

get_admin_rule_by_id # noqa: E501

Returns the AdminRule 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_admin_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:

AdminRule

get_admin_rule_by_id_with_http_info(id, **kwargs)[source]

get_admin_rule_by_id # noqa: E501

Returns the AdminRule 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_admin_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(AdminRule, status_code(int), headers(HTTPHeaderDict))

shift_admin_rules_by_piority(priority_start, offset, **kwargs)[source]

shift_admin_rules_by_piority # 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_admin_rules_by_piority(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_admin_rules_by_piority_with_http_info(priority_start, offset, **kwargs)[source]

shift_admin_rules_by_piority # 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_admin_rules_by_piority_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_admin_rules(id, id2, **kwargs)[source]

swap_admin_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_admin_rules(id, id2, async_req=True)
>>> result = thread.get()

Parameters:

id (str) – The rule identifier (required)
id2 (str) – The admin 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_admin_rules_with_http_info(id, id2, **kwargs)[source]

swap_admin_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_admin_rules_with_http_info(id, id2, async_req=True)
>>> result = thread.get()

Parameters:

id (str) – The rule identifier (required)
id2 (str) – The admin 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_admin_rule(id, admin_rule, **kwargs)[source]

update_admin_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.update_admin_rule(id, admin_rule, async_req=True)
>>> result = thread.get()

Parameters:

id (str) – The rule identifier (required)
admin_rule (AdminRule) – (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:

AdminRule

update_admin_rule_with_http_info(id, admin_rule, **kwargs)[source]

update_admin_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.update_admin_rule_with_http_info(id, admin_rule, async_req=True)
>>> result = thread.get()

Parameters:

id (str) – The rule identifier (required)
admin_rule (AdminRule) – (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(AdminRule, status_code(int), headers(HTTPHeaderDict))

class geonode.geoserver.acl.gsauth_client.AuthorizationApi(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

get_access_info(access_request, **kwargs)[source]

get_access_info # noqa: E501

Computes the grant access info for the given request # 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_access_info(access_request, async_req=True)
>>> result = thread.get()

Parameters:

access_request (AccessRequest) – (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:

AccessInfo

get_access_info_with_http_info(access_request, **kwargs)[source]

get_access_info # noqa: E501

Computes the grant access info for the given request # 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_access_info_with_http_info(access_request, async_req=True)
>>> result = thread.get()

Parameters:

access_request (AccessRequest) – (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(AccessInfo, status_code(int), headers(HTTPHeaderDict))

get_admin_authorization(admin_access_request, **kwargs)[source]

get_admin_authorization # noqa: E501

Computes info about admin authorization on a given workspace. Returned AccessInfo will always be ALLOW, with the computed adminRights. # 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_admin_authorization(admin_access_request, async_req=True)
>>> result = thread.get()

Parameters:

admin_access_request (AdminAccessRequest) – (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:

AdminAccessInfo

get_admin_authorization_with_http_info(admin_access_request, **kwargs)[source]

get_admin_authorization # noqa: E501

Computes info about admin authorization on a given workspace. Returned AccessInfo will always be ALLOW, with the computed adminRights. # 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_admin_authorization_with_http_info(admin_access_request, async_req=True)
>>> result = thread.get()

Parameters:

admin_access_request (AdminAccessRequest) – (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(AdminAccessInfo, status_code(int), headers(HTTPHeaderDict))

get_matching_rules(access_request, **kwargs)[source]

get_matching_rules # noqa: E501

Obtains the plain list of matching rules that are applied to the given AccessRequest when computing the AccessInfo # 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_matching_rules(access_request, async_req=True)
>>> result = thread.get()

Parameters:

access_request (AccessRequest) – (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:

list[Rule]

get_matching_rules_with_http_info(access_request, **kwargs)[source]

get_matching_rules # noqa: E501

Obtains the plain list of matching rules that are applied to the given AccessRequest when computing the AccessInfo # 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_matching_rules_with_http_info(access_request, async_req=True)
>>> result = thread.get()

Parameters:

access_request (AccessRequest) – (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(list[Rule], status_code(int), headers(HTTPHeaderDict))

class geonode.geoserver.acl.gsauth_client.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

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))

class geonode.geoserver.acl.gsauth_client.ApiClient(configuration=None, header_name=None, header_value=None, cookie=None, pool_threads=1)[source]

Bases: object

Generic API client for OpenAPI client library builds.

OpenAPI generic API client. This client handles the client- server communication, and is invariant across implementations. Specifics of the methods and models for each application are generated from the OpenAPI templates.

Note

This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech Do not edit the class manually.

Parameters:

configuration – .Configuration object for this client
header_name – a header to pass when making calls to the API.
header_value – a header value to pass when making calls to the API.
cookie – a cookie to include in the header when making calls to the API
pool_threads – The number of threads to use for async requests to the API. More threads means more concurrent API requests.

PRIMITIVE_TYPES

NATIVE_TYPES_MAPPING

_pool = None

configuration

pool_threads

rest_client

default_headers

cookie

property user_agent
User agent for this API client

client_side_validation

__enter__()[source]

__exit__(exc_type, exc_value, traceback)[source]

close()[source]

property pool
Create thread pool on first request
avoids instantiating unused threadpool for blocking clients.

set_default_header(header_name, header_value)[source]

__call_api(resource_path, method, path_params=None, query_params=None, header_params=None, body=None, post_params=None, files=None, response_types_map=None, auth_settings=None, _return_http_data_only=None, collection_formats=None, _preload_content=True, _request_timeout=None, _host=None, _request_auth=None)[source]

sanitize_for_serialization(obj)[source]

Builds a JSON POST object.

If obj is None, return None. If obj is str, int, long, float, bool, return directly. If obj is datetime.datetime, datetime.date convert to string in iso8601 format. If obj is list, sanitize each element in the list. If obj is dict, return the dict. If obj is OpenAPI model, return the properties dict.

Parameters:: obj – The data to serialize.
Returns:: The serialized form of data.

deserialize(response, response_type)[source]

Deserializes response into an object.

Parameters:

response – RESTResponse object to be deserialized.
response_type – class literal for deserialized object, or string of class name.

Returns:

deserialized object.

__deserialize(data, klass)[source]

Deserializes dict, list, str into an object.

Parameters:

data – dict, list or str.
klass – class literal, or string of class name.

Returns:

object.

call_api(resource_path, method, path_params=None, query_params=None, header_params=None, body=None, post_params=None, files=None, response_types_map=None, auth_settings=None, async_req=None, _return_http_data_only=None, collection_formats=None, _preload_content=True, _request_timeout=None, _host=None, _request_auth=None)[source]

Makes the HTTP request (synchronous) and returns deserialized data.

To make an async_req request, set the async_req parameter.

Parameters:

resource_path – Path to method endpoint.
method – Method to call.
path_params – Path parameters in the url.
query_params – Query parameters in the url.
header_params – Header parameters to be placed in the request header.
body – Request body.
dict (files) – Request post form parameters, for application/x-www-form-urlencoded, multipart/form-data.
list (auth_settings) – Auth Settings names for the request.
response – Response data type.
dict – key -> filename, value -> filepath, for multipart/form-data.
bool (async_req) – execute request asynchronously
_return_http_data_only – response data without head status code and headers
collection_formats – dict of collection formats for path, query, header, and post parameters.
_preload_content – 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 – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

If async_req parameter is True, the request will be called asynchronously. The method will return the request thread. If parameter async_req is False or missing, then the method will return the response directly.

request(method, url, query_params=None, headers=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)[source]: Makes the HTTP request using RESTClient.

parameters_to_tuples(params, collection_formats)[source]

Get parameters as list of tuples, formatting collections.

Parameters:

params – Parameters as dict or list of two-tuples
collection_formats (dict) – Parameter collection formats

Returns:

Parameters as list of tuples, collections formatted

files_parameters(files=None)[source]

Builds form parameters.

Parameters:: files – File parameters.
Returns:: Form parameters with files.

select_header_accept(accepts)[source]

Returns Accept based on an array of accepts provided.

Parameters:: accepts – List of headers.
Returns:: Accept (e.g. application/json).

select_header_content_type(content_types, method=None, body=None)[source]

Returns Content-Type based on an array of content_types provided.

Parameters:

content_types – List of content-types.
method – http method (e.g. POST, PATCH).
body – http body to send.

Returns:

Content-Type (e.g. application/json).

update_params_for_auth(headers, queries, auth_settings, request_auth=None)[source]

Updates header and query params based on authentication setting.

Parameters:

headers – Header parameters dict to be updated.
queries – Query parameters tuple list to be updated.
auth_settings – Authentication setting identifiers list.
request_auth – if set, the provided settings will override the token in the configuration.

_apply_auth_params(headers, queries, auth_setting)[source]

Updates the request parameters based on a single auth_setting

Parameters:

headers – Header parameters dict to be updated.
queries – Query parameters tuple list to be updated.
auth_setting – auth settings for the endpoint

__deserialize_file(response)[source]

Deserializes body to file

Saves response body into a file in a temporary folder, using the filename from the Content-Disposition header if provided.

Parameters:: response – RESTResponse.
Returns:: file path.

__deserialize_primitive(data, klass)[source]

Deserializes string to primitive type.

Parameters:

data – str.
klass – class literal.

Returns:

int, long, float, str, bool.

__deserialize_object(value)[source]

Return an original value.

Returns:: object.

__deserialize_date(string)[source]

Deserializes string to date.

Parameters:: string – str.
Returns:: date.

__deserialize_datetime(string)[source]

Deserializes string to datetime.

The string should be in iso8601 datetime format.

Parameters:: string – str.
Returns:: datetime.

__deserialize_model(data, klass)[source]

Deserializes list or dict to model.

Parameters:

data – dict, list.
klass – class literal.

Returns:

model object.

class geonode.geoserver.acl.gsauth_client.Configuration(host=None, api_key=None, api_key_prefix=None, username=None, password=None, discard_unknown_keys=False, disabled_client_side_validations='', server_index=None, server_variables=None, server_operation_index=None, server_operation_variables=None, ssl_ca_cert=None)[source]

Bases: object

NOTE: This class is auto generated by OpenAPI Generator

Ref: https://openapi-generator.tech Do not edit the class manually.

Parameters:

host – Base url
api_key – Dict to store API key(s). Each entry in the dict specifies an API key. The dict key is the name of the security scheme in the OAS specification. The dict value is the API key secret.
api_key_prefix – Dict to store API prefix (e.g. Bearer) The dict key is the name of the security scheme in the OAS specification. The dict value is an API key prefix when generating the auth data.
username – Username for HTTP basic authentication
password – Password for HTTP basic authentication
discard_unknown_keys –
Boolean value indicating whether to discard unknown properties. A server may send a response that includes additional properties that are not known by the client in the following scenarios:
1. The OpenAPI document is incomplete, i.e. it does not match the server implementation.
2. The client was generated using an older version of the OpenAPI document and the server has been upgraded since then.

If a schema in the OpenAPI document defines the additionalProperties attribute, then all undeclared properties received by the server are injected into the additional properties map. In that case, there are undeclared properties, and nothing to discard.

Parameters:

(string) (disabled_client_side_validations) – Comma-separated list of JSON schema validation keywords to disable JSON schema structural validation rules. The following keywords may be specified: multipleOf, maximum, exclusiveMaximum, minimum, exclusiveMinimum, maxLength, minLength, pattern, maxItems, minItems. By default, the validation is performed for data generated locally by the client and data received from the server, independent of any validation performed by the server side. If the input data does not satisfy the JSON schema validation rules specified in the OpenAPI document, an exception is raised. If disabled_client_side_validations is set, structural validation is disabled. This can be useful to troubleshoot data validation problem, such as when the OpenAPI document validation rules do not match the actual API data received by the server.
server_index – Index to servers configuration.
server_variables – Mapping with string values to replace variables in templated server configuration. The validation of enums is performed for variables with defined enum values before.
server_operation_index – Mapping from operation ID to an index to server configuration.
server_operation_variables – Mapping from operation ID to a mapping with string values to replace variables in templated server configuration. The validation of enums is performed for variables with defined enum values before.
ssl_ca_cert – str - the path to a file of concatenated CA certificates in PEM format

Example:

HTTP Basic Authentication Example.

Given the following security scheme in the OpenAPI specification:: components: securitySchemes: http_basic_auth: type: http scheme: basic

Configure API client with HTTP basic authentication:

conf = gsauth_client.Configuration(: username=’the-user’, password=’the-password’, )

_default = None

_base_path: Default Base url

server_index

server_operation_index: Default server index

server_variables

server_operation_variables: Default server variables

temp_folder_path = None: Temp file folder for downloading files

api_key

api_key_prefix

refresh_api_key_hook = None: function hook to refresh API key if expired

username: Username for HTTP basic authentication

password: Password for HTTP basic authentication

discard_unknown_keys

disabled_client_side_validations

logger: Logging Settings

property logger_format

The logger format.

The logger_formatter will be updated when sets logger_format.

Parameters:: value – The format string.
Type:: str

logger_stream_handler = None: Log stream handler

logger_file_handler = None: Log file handler

property logger_file

The logger file.

If the logger_file is None, then add stream handler and remove file handler. Otherwise, add file handler and remove stream handler.

Parameters:: value – The logger_file path.
Type:: str

property debug

Debug status

Parameters:: value – The debug status, True or False.
Type:: bool

verify_ssl = True: SSL/TLS verification Set this to false to skip verifying SSL certificate when calling API from https server.

ssl_ca_cert: Set this to customize the certificate file to verify the peer.

cert_file = None: client certificate file

key_file = None: client key file

assert_hostname = None: Set this to True/False to enable/disable SSL hostname verification.

connection_pool_maxsize: urllib3 connection pool’s maximum number of connections saved per pool. urllib3 uses 1 connection as default value, but this is not the best value when you are making a lot of possibly parallel requests to the same host, which is often the case here. cpu_count * 5 is used as default value to increase performance.

proxy = None: Proxy URL

proxy_headers = None: Proxy headers

safe_chars_for_path_param = '': Safe chars for path_param

retries = None: Adding retries to override urllib3 default value 3

client_side_validation = True

socket_options = None: Options to pass down to the underlying urllib3 socket

__deepcopy__(memo)[source]

__setattr__(name, value)[source]

classmethod set_default(default)[source]

Set default instance of configuration.

It stores default configuration, which can be returned by get_default_copy method.

Parameters:: default – object of Configuration

classmethod get_default_copy()[source]

Return new instance of configuration.

This method returns newly created, based on default constructor, object of Configuration class or returns a copy of default configuration passed by the set_default method.

Returns:: The configuration object.

get_api_key_with_prefix(identifier, alias=None)[source]

Gets API key (with prefix if set).

Parameters:

identifier – The identifier of apiKey.
alias – The alternative identifier of apiKey.

Returns:

The token for api key authentication.

get_basic_auth_token()[source]

Gets HTTP basic authentication header (string).

Returns:: The token for basic HTTP authentication.

auth_settings()[source]

Gets Auth Settings dict for api client.

Returns:: The Auth Settings information dict.

to_debug_report()[source]

Gets the essential information for debugging.

Returns:: The report for debugging.

get_host_settings()[source]

Gets an array of host settings

Returns:: An array of host settings

get_host_from_settings(index, variables=None, servers=None)[source]: Gets host URL based on the index and variables :param index: array index of the host settings :param variables: hash of variable and the corresponding value :param servers: an array of host settings or None :return: URL based on host settings

property host
Return generated host.

exception geonode.geoserver.acl.gsauth_client.OpenApiException[source]

Bases: Exception

The base exception class for all OpenAPIExceptions

exception geonode.geoserver.acl.gsauth_client.ApiTypeError(msg, path_to_item=None, valid_classes=None, key_type=None)[source]

Bases: OpenApiException, TypeError

The base exception class for all OpenAPIExceptions

path_to_item

valid_classes

key_type

full_msg

exception geonode.geoserver.acl.gsauth_client.ApiValueError(msg, path_to_item=None)[source]

Bases: OpenApiException, ValueError

The base exception class for all OpenAPIExceptions

path_to_item

full_msg

exception geonode.geoserver.acl.gsauth_client.ApiKeyError(msg, path_to_item=None)[source]

Bases: OpenApiException, KeyError

The base exception class for all OpenAPIExceptions

path_to_item

full_msg

exception geonode.geoserver.acl.gsauth_client.ApiAttributeError(msg, path_to_item=None)[source]

Bases: OpenApiException, AttributeError

The base exception class for all OpenAPIExceptions

path_to_item

full_msg

exception geonode.geoserver.acl.gsauth_client.ApiException(status=None, reason=None, http_resp=None)[source]

Bases: OpenApiException

The base exception class for all OpenAPIExceptions

__str__()[source]: Custom error messages for exception

class geonode.geoserver.acl.gsauth_client.AccessInfo(grant=None, area=None, clip_area=None, catalog_mode=None, default_style=None, allowed_styles=None, cql_filter_read=None, cql_filter_write=None, attributes=None, matching_rules=None, local_vars_configuration=None)[source]

Bases: object

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

Do not edit the class manually.

openapi_types

attribute_map

local_vars_configuration

_grant = None

_area = None

_clip_area = None

_catalog_mode = None

_default_style = None

_allowed_styles = None

_cql_filter_read = None

_cql_filter_write = None

_attributes = None

_matching_rules = None

discriminator = None

property grant

property E501

Returns:: The grant of this AccessInfo. # noqa: E501
Return type:: GrantType
Type:: Gets the grant of this AccessInfo. # noqa

property catalog_mode

property E501

Returns:: The catalog_mode of this AccessInfo. # noqa: E501
Return type:: CatalogMode
Type:: Gets the catalog_mode of this AccessInfo. # noqa

property attributes

property E501

Returns:: The attributes of this AccessInfo. # noqa: E501
Return type:: list[LayerAttribute]
Type:: Gets the attributes of this AccessInfo. # noqa

property area

property E501

Returns:: The area of this AccessInfo. # noqa: E501
Return type:: Geom
Type:: Gets the area of this AccessInfo. # noqa

property clip_area

property E501

Returns:: The clip_area of this AccessInfo. # noqa: E501
Return type:: Geom
Type:: Gets the clip_area of this AccessInfo. # noqa

property default_style

property E501

Returns:: The default_style of this AccessInfo. # noqa: E501
Return type:: str
Type:: Gets the default_style of this AccessInfo. # noqa

property allowed_styles

property E501

Returns:: The allowed_styles of this AccessInfo. # noqa: E501
Return type:: list[str]
Type:: Gets the allowed_styles of this AccessInfo. # noqa

property cql_filter_read

property E501

Returns:: The cql_filter_read of this AccessInfo. # noqa: E501
Return type:: str
Type:: Gets the cql_filter_read of this AccessInfo. # noqa

property cql_filter_write

property E501

Returns:: The cql_filter_write of this AccessInfo. # noqa: E501
Return type:: str
Type:: Gets the cql_filter_write of this AccessInfo. # noqa

property matching_rules

property E501

Returns:: The matching_rules of this AccessInfo. # noqa: E501
Return type:: list[str]
Type:: Gets the matching_rules of this AccessInfo. # noqa

to_dict(serialize=False)[source]: Returns the model properties as a dict

to_str()[source]: Returns the string representation of the model

__repr__()[source]: For print and pprint

__eq__(other)[source]: Returns true if both objects are equal

__ne__(other)[source]: Returns true if both objects are not equal

class geonode.geoserver.acl.gsauth_client.AccessRequest(user=None, roles=None, instance='*', source_address='*', service='*', request='*', subfield='*', workspace='*', layer='*', local_vars_configuration=None)[source]

Bases: object

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

Do not edit the class manually.

openapi_types

attribute_map

local_vars_configuration

_user = None

_roles = None

_instance = None

_source_address = None

_service = None

_request = None

_subfield = None

_workspace = None

_layer = None

discriminator = None

property roles

property E501

The roles the requesting user belongs to # noqa: E501

Returns:: The roles of this AccessRequest. # noqa: E501
Return type:: list[str]
Type:: Gets the roles of this AccessRequest. # noqa

property user

property E501

the authentication user name performing the request for which the authorization is being requested # noqa: E501

Returns:: The user of this AccessRequest. # noqa: E501
Return type:: str
Type:: Gets the user of this AccessRequest. # noqa

property instance

property E501

Returns:: The instance of this AccessRequest. # noqa: E501
Return type:: str
Type:: Gets the instance of this AccessRequest. # noqa

property source_address

property E501

Returns:: The source_address of this AccessRequest. # noqa: E501
Return type:: str
Type:: Gets the source_address of this AccessRequest. # noqa

property service

property E501

Returns:: The service of this AccessRequest. # noqa: E501
Return type:: str
Type:: Gets the service of this AccessRequest. # noqa

property request

property E501

Returns:: The request of this AccessRequest. # noqa: E501
Return type:: str
Type:: Gets the request of this AccessRequest. # noqa

property subfield

property E501

Returns:: The subfield of this AccessRequest. # noqa: E501
Return type:: str
Type:: Gets the subfield of this AccessRequest. # noqa

property workspace

property E501

Returns:: The workspace of this AccessRequest. # noqa: E501
Return type:: str
Type:: Gets the workspace of this AccessRequest. # noqa

property layer

property E501

Returns:: The layer of this AccessRequest. # noqa: E501
Return type:: str
Type:: Gets the layer of this AccessRequest. # noqa

to_dict(serialize=False)[source]: Returns the model properties as a dict

to_str()[source]: Returns the string representation of the model

__repr__()[source]: For print and pprint

__eq__(other)[source]: Returns true if both objects are equal

__ne__(other)[source]: Returns true if both objects are not equal

class geonode.geoserver.acl.gsauth_client.AddressRangeFilter(include_default=None, value=None, local_vars_configuration=None)[source]

Bases: object

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

Do not edit the class manually.

openapi_types

attribute_map

local_vars_configuration

_include_default = None

_value = None

discriminator = None

property include_default

property E501

Returns:: The include_default of this AddressRangeFilter. # noqa: E501
Return type:: bool
Type:: Gets the include_default of this AddressRangeFilter. # noqa

property value

property E501

IPv4 address with optional /nn on the end with values from 0 - 32 # noqa: E501

Returns:: The value of this AddressRangeFilter. # noqa: E501
Return type:: str
Type:: Gets the value of this AddressRangeFilter. # noqa

to_dict(serialize=False)[source]: Returns the model properties as a dict

to_str()[source]: Returns the string representation of the model

__repr__()[source]: For print and pprint

__eq__(other)[source]: Returns true if both objects are equal

__ne__(other)[source]: Returns true if both objects are not equal

class geonode.geoserver.acl.gsauth_client.AdminAccessInfo(admin=None, workspace=None, matching_admin_rule=None, local_vars_configuration=None)[source]

Bases: object

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

Do not edit the class manually.

openapi_types

attribute_map

local_vars_configuration

_admin = None

_workspace = None

_matching_admin_rule = None

discriminator = None

property admin

property E501

Returns:: The admin of this AdminAccessInfo. # noqa: E501
Return type:: bool
Type:: Gets the admin of this AdminAccessInfo. # noqa

property workspace

property E501

Returns:: The workspace of this AdminAccessInfo. # noqa: E501
Return type:: str
Type:: Gets the workspace of this AdminAccessInfo. # noqa

property matching_admin_rule

property E501

Returns:: The matching_admin_rule of this AdminAccessInfo. # noqa: E501
Return type:: str
Type:: Gets the matching_admin_rule of this AdminAccessInfo. # noqa

to_dict(serialize=False)[source]: Returns the model properties as a dict

to_str()[source]: Returns the string representation of the model

__repr__()[source]: For print and pprint

__eq__(other)[source]: Returns true if both objects are equal

__ne__(other)[source]: Returns true if both objects are not equal

class geonode.geoserver.acl.gsauth_client.AdminAccessRequest(user=None, roles=None, instance='*', source_address='*', workspace='*', local_vars_configuration=None)[source]

Bases: object

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

Do not edit the class manually.

openapi_types

attribute_map

local_vars_configuration

_user = None

_roles = None

_instance = None

_source_address = None

_workspace = None

discriminator = None

property roles

property E501

The roles the requesting user belongs to # noqa: E501

Returns:: The roles of this AdminAccessRequest. # noqa: E501
Return type:: list[str]
Type:: Gets the roles of this AdminAccessRequest. # noqa

property user

property E501

the authentication user name performing the request for which the authorization is being requested # noqa: E501

Returns:: The user of this AdminAccessRequest. # noqa: E501
Return type:: str
Type:: Gets the user of this AdminAccessRequest. # noqa

property instance

property E501

Returns:: The instance of this AdminAccessRequest. # noqa: E501
Return type:: str
Type:: Gets the instance of this AdminAccessRequest. # noqa

property source_address

property E501

Returns:: The source_address of this AdminAccessRequest. # noqa: E501
Return type:: str
Type:: Gets the source_address of this AdminAccessRequest. # noqa

property workspace

property E501

Returns:: The workspace of this AdminAccessRequest. # noqa: E501
Return type:: str
Type:: Gets the workspace of this AdminAccessRequest. # noqa

to_dict(serialize=False)[source]: Returns the model properties as a dict

to_str()[source]: Returns the string representation of the model

__repr__()[source]: For print and pprint

__eq__(other)[source]: Returns true if both objects are equal

__ne__(other)[source]: Returns true if both objects are not equal

class geonode.geoserver.acl.gsauth_client.AdminGrantType(local_vars_configuration=None)[source]

Bases: object

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

Do not edit the class manually.

ADMIN = 'ADMIN'

USER = 'USER'

allowable_values: Attributes: openapi_types (dict): The key is attribute name and the value is attribute type. attribute_map (dict): The key is attribute name and the value is json key in definition.

openapi_types

attribute_map

local_vars_configuration

discriminator = None

to_dict(serialize=False)[source]: Returns the model properties as a dict

to_str()[source]: Returns the string representation of the model

__repr__()[source]: For print and pprint

__eq__(other)[source]: Returns true if both objects are equal

__ne__(other)[source]: Returns true if both objects are not equal

class geonode.geoserver.acl.gsauth_client.AdminRule(id=None, priority=None, access=None, ext_id=None, name=None, description=None, instance=None, role=None, user=None, workspace=None, address_range=None, local_vars_configuration=None)[source]

Bases: object

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

Do not edit the class manually.

openapi_types

attribute_map

local_vars_configuration

_id = None

_priority = None

_access = None

_ext_id = None

_name = None

_description = None

_instance = None

_role = None

_user = None

_workspace = None

_address_range = None

discriminator = None

property id

property E501

Returns:: The id of this AdminRule. # noqa: E501
Return type:: str
Type:: Gets the id of this AdminRule. # noqa

property priority

property E501

Returns:: The priority of this AdminRule. # noqa: E501
Return type:: int
Type:: Gets the priority of this AdminRule. # noqa

property access

property E501

Returns:: The access of this AdminRule. # noqa: E501
Return type:: AdminGrantType
Type:: Gets the access of this AdminRule. # noqa

property ext_id

property E501

Returns:: The ext_id of this AdminRule. # noqa: E501
Return type:: str
Type:: Gets the ext_id of this AdminRule. # noqa

property name

property E501

Returns:: The name of this AdminRule. # noqa: E501
Return type:: str
Type:: Gets the name of this AdminRule. # noqa

property description

property E501

Returns:: The description of this AdminRule. # noqa: E501
Return type:: str
Type:: Gets the description of this AdminRule. # noqa

property instance

property E501

Returns:: The instance of this AdminRule. # noqa: E501
Return type:: str
Type:: Gets the instance of this AdminRule. # noqa

property role

property E501

Returns:: The role of this AdminRule. # noqa: E501
Return type:: str
Type:: Gets the role of this AdminRule. # noqa

property user

property E501

Returns:: The user of this AdminRule. # noqa: E501
Return type:: str
Type:: Gets the user of this AdminRule. # noqa

property workspace

property E501

Returns:: The workspace of this AdminRule. # noqa: E501
Return type:: str
Type:: Gets the workspace of this AdminRule. # noqa

property address_range

property E501

IPv4 address with optional /nn on the end with values from 0 - 32 # noqa: E501

Returns:: The address_range of this AdminRule. # noqa: E501
Return type:: str
Type:: Gets the address_range of this AdminRule. # noqa

to_dict(serialize=False)[source]: Returns the model properties as a dict

to_str()[source]: Returns the string representation of the model

__repr__()[source]: For print and pprint

__eq__(other)[source]: Returns true if both objects are equal

__ne__(other)[source]: Returns true if both objects are not equal

class geonode.geoserver.acl.gsauth_client.AdminRuleFilter(instance=None, grant_type=None, user=None, roles=None, workspace=None, source_address=None, local_vars_configuration=None)[source]

Bases: object

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

Do not edit the class manually.

openapi_types

attribute_map

local_vars_configuration

_instance = None

_grant_type = None

_user = None

_roles = None

_workspace = None

_source_address = None

discriminator = None

property instance

property E501

Returns:: The instance of this AdminRuleFilter. # noqa: E501
Return type:: TextFilter
Type:: Gets the instance of this AdminRuleFilter. # noqa

property grant_type

property E501

Returns:: The grant_type of this AdminRuleFilter. # noqa: E501
Return type:: AdminGrantType
Type:: Gets the grant_type of this AdminRuleFilter. # noqa

property user

property E501

Returns:: The user of this AdminRuleFilter. # noqa: E501
Return type:: TextFilter
Type:: Gets the user of this AdminRuleFilter. # noqa

property roles

property E501

Returns:: The roles of this AdminRuleFilter. # noqa: E501
Return type:: SetFilter
Type:: Gets the roles of this AdminRuleFilter. # noqa

property workspace

property E501

Returns:: The workspace of this AdminRuleFilter. # noqa: E501
Return type:: TextFilter
Type:: Gets the workspace of this AdminRuleFilter. # noqa

property source_address

property E501

Returns:: The source_address of this AdminRuleFilter. # noqa: E501
Return type:: AddressRangeFilter
Type:: Gets the source_address of this AdminRuleFilter. # noqa

to_dict(serialize=False)[source]: Returns the model properties as a dict

to_str()[source]: Returns the string representation of the model

__repr__()[source]: For print and pprint

__eq__(other)[source]: Returns true if both objects are equal

__ne__(other)[source]: Returns true if both objects are not equal

class geonode.geoserver.acl.gsauth_client.CatalogMode(local_vars_configuration=None)[source]

Bases: object

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

Do not edit the class manually.

HIDE = 'HIDE'

CHALLENGE = 'CHALLENGE'

MIXED = 'MIXED'

allowable_values: Attributes: openapi_types (dict): The key is attribute name and the value is attribute type. attribute_map (dict): The key is attribute name and the value is json key in definition.

openapi_types

attribute_map

local_vars_configuration

discriminator = None

to_dict(serialize=False)[source]: Returns the model properties as a dict

to_str()[source]: Returns the string representation of the model

__repr__()[source]: For print and pprint

__eq__(other)[source]: Returns true if both objects are equal

__ne__(other)[source]: Returns true if both objects are not equal

class geonode.geoserver.acl.gsauth_client.Geom(wkt=None, wkb=None, local_vars_configuration=None)[source]

Bases: object

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

Do not edit the class manually.

openapi_types

attribute_map

local_vars_configuration

_wkt = None

_wkb = None

discriminator = None

property wkt

property E501

Returns:: The wkt of this Geom. # noqa: E501
Return type:: str
Type:: Gets the wkt of this Geom. # noqa

property wkb

property E501

Returns:: The wkb of this Geom. # noqa: E501
Return type:: str
Type:: Gets the wkb of this Geom. # noqa

to_dict(serialize=False)[source]: Returns the model properties as a dict

to_str()[source]: Returns the string representation of the model

__repr__()[source]: For print and pprint

__eq__(other)[source]: Returns true if both objects are equal

__ne__(other)[source]: Returns true if both objects are not equal

class geonode.geoserver.acl.gsauth_client.GrantType(local_vars_configuration=None)[source]

Bases: object

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

Do not edit the class manually.

ALLOW = 'ALLOW'

DENY = 'DENY'

LIMIT = 'LIMIT'

allowable_values: Attributes: openapi_types (dict): The key is attribute name and the value is attribute type. attribute_map (dict): The key is attribute name and the value is json key in definition.

openapi_types

attribute_map

local_vars_configuration

discriminator = None

to_dict(serialize=False)[source]: Returns the model properties as a dict

to_str()[source]: Returns the string representation of the model

__repr__()[source]: For print and pprint

__eq__(other)[source]: Returns true if both objects are equal

__ne__(other)[source]: Returns true if both objects are not equal

class geonode.geoserver.acl.gsauth_client.InsertPosition(local_vars_configuration=None)[source]

Bases: object

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

Do not edit the class manually.

FIXED = 'FIXED'

FROM_START = 'FROM_START'

FROM_END = 'FROM_END'

allowable_values: Attributes: openapi_types (dict): The key is attribute name and the value is attribute type. attribute_map (dict): The key is attribute name and the value is json key in definition.

openapi_types

attribute_map

local_vars_configuration

discriminator = None

to_dict(serialize=False)[source]: Returns the model properties as a dict

to_str()[source]: Returns the string representation of the model

__repr__()[source]: For print and pprint

__eq__(other)[source]: Returns true if both objects are equal

__ne__(other)[source]: Returns true if both objects are not equal

class geonode.geoserver.acl.gsauth_client.LayerAttribute(name=None, data_type=None, access=None, local_vars_configuration=None)[source]

Bases: object

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

Do not edit the class manually.

openapi_types

attribute_map

local_vars_configuration

_name = None

_data_type = None

_access = None

discriminator = None

property name

property E501

Returns:: The name of this LayerAttribute. # noqa: E501
Return type:: str
Type:: Gets the name of this LayerAttribute. # noqa

property data_type

property E501

Returns:: The data_type of this LayerAttribute. # noqa: E501
Return type:: str
Type:: Gets the data_type of this LayerAttribute. # noqa

property access

property E501

Returns:: The access of this LayerAttribute. # noqa: E501
Return type:: str
Type:: Gets the access of this LayerAttribute. # noqa

to_dict(serialize=False)[source]: Returns the model properties as a dict

to_str()[source]: Returns the string representation of the model

__repr__()[source]: For print and pprint

__eq__(other)[source]: Returns true if both objects are equal

__ne__(other)[source]: Returns true if both objects are not equal

class geonode.geoserver.acl.gsauth_client.LayerDetails(type=None, default_style=None, cql_filter_read=None, cql_filter_write=None, allowed_area=None, spatial_filter_type=None, catalog_mode=None, allowed_styles=None, layer_attributes=None, local_vars_configuration=None)[source]

Bases: object

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

Do not edit the class manually.

openapi_types

attribute_map

local_vars_configuration

_type = None

_default_style = None

_cql_filter_read = None

_cql_filter_write = None

_allowed_area = None

_spatial_filter_type = None

_catalog_mode = None

_allowed_styles = None

_layer_attributes = None

discriminator = None

property type

property E501

Returns:: The type of this LayerDetails. # noqa: E501
Return type:: str
Type:: Gets the type of this LayerDetails. # noqa

property default_style

property E501

Returns:: The default_style of this LayerDetails. # noqa: E501
Return type:: str
Type:: Gets the default_style of this LayerDetails. # noqa

property cql_filter_read

property E501

Returns:: The cql_filter_read of this LayerDetails. # noqa: E501
Return type:: str
Type:: Gets the cql_filter_read of this LayerDetails. # noqa

property cql_filter_write

property E501

Returns:: The cql_filter_write of this LayerDetails. # noqa: E501
Return type:: str
Type:: Gets the cql_filter_write of this LayerDetails. # noqa

property spatial_filter_type

property E501

Returns:: The spatial_filter_type of this LayerDetails. # noqa: E501
Return type:: SpatialFilterType
Type:: Gets the spatial_filter_type of this LayerDetails. # noqa

property catalog_mode

property E501

Returns:: The catalog_mode of this LayerDetails. # noqa: E501
Return type:: CatalogMode
Type:: Gets the catalog_mode of this LayerDetails. # noqa

property allowed_styles

property E501

Returns:: The allowed_styles of this LayerDetails. # noqa: E501
Return type:: list[str]
Type:: Gets the allowed_styles of this LayerDetails. # noqa

property layer_attributes

property E501

Returns:: The layer_attributes of this LayerDetails. # noqa: E501
Return type:: list[LayerAttribute]
Type:: Gets the layer_attributes of this LayerDetails. # noqa

property allowed_area

property E501

Returns:: The allowed_area of this LayerDetails. # noqa: E501
Return type:: Geom
Type:: Gets the allowed_area of this LayerDetails. # noqa

to_dict(serialize=False)[source]: Returns the model properties as a dict

to_str()[source]: Returns the string representation of the model

__repr__()[source]: For print and pprint

__eq__(other)[source]: Returns true if both objects are equal

__ne__(other)[source]: Returns true if both objects are not equal

class geonode.geoserver.acl.gsauth_client.Rule(id=None, priority=None, ext_id=None, name=None, description=None, instance=None, access=None, limits=None, role=None, user=None, address_range=None, service=None, request=None, subfield=None, workspace=None, layer=None, local_vars_configuration=None)[source]

Bases: object

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

Do not edit the class manually.

openapi_types

attribute_map

local_vars_configuration

_id = None

_priority = None

_ext_id = None

_name = None

_description = None

_instance = None

_access = None

_limits = None

_role = None

_user = None

_address_range = None

_service = None

_request = None

_subfield = None

_workspace = None

_layer = None

discriminator = None

property id

property E501

Returns:: The id of this Rule. # noqa: E501
Return type:: str
Type:: Gets the id of this Rule. # noqa

property priority

property E501

Returns:: The priority of this Rule. # noqa: E501
Return type:: int
Type:: Gets the priority of this Rule. # noqa

property ext_id

property E501

Returns:: The ext_id of this Rule. # noqa: E501
Return type:: str
Type:: Gets the ext_id of this Rule. # noqa

property name

property E501

Returns:: The name of this Rule. # noqa: E501
Return type:: str
Type:: Gets the name of this Rule. # noqa

property description

property E501

Returns:: The description of this Rule. # noqa: E501
Return type:: str
Type:: Gets the description of this Rule. # noqa

property instance

property E501

Returns:: The instance of this Rule. # noqa: E501
Return type:: str
Type:: Gets the instance of this Rule. # noqa

property access

property E501

Returns:: The access of this Rule. # noqa: E501
Return type:: GrantType
Type:: Gets the access of this Rule. # noqa

property limits

property E501

Returns:: The limits of this Rule. # noqa: E501
Return type:: RuleLimits
Type:: Gets the limits of this Rule. # noqa

property role

property E501

Returns:: The role of this Rule. # noqa: E501
Return type:: str
Type:: Gets the role of this Rule. # noqa

property user

property E501

Returns:: The user of this Rule. # noqa: E501
Return type:: str
Type:: Gets the user of this Rule. # noqa

property address_range

property E501

IPv4 address with optional /nn on the end with values from 0 - 32 # noqa: E501

Returns:: The address_range of this Rule. # noqa: E501
Return type:: str
Type:: Gets the address_range of this Rule. # noqa

property service

property E501

Returns:: The service of this Rule. # noqa: E501
Return type:: str
Type:: Gets the service of this Rule. # noqa

property request

property E501

Returns:: The request of this Rule. # noqa: E501
Return type:: str
Type:: Gets the request of this Rule. # noqa

property subfield

property E501

Returns:: The subfield of this Rule. # noqa: E501
Return type:: str
Type:: Gets the subfield of this Rule. # noqa

property workspace

property E501

Returns:: The workspace of this Rule. # noqa: E501
Return type:: str
Type:: Gets the workspace of this Rule. # noqa

property layer

property E501

Returns:: The layer of this Rule. # noqa: E501
Return type:: str
Type:: Gets the layer of this Rule. # noqa

to_dict(serialize=False)[source]: Returns the model properties as a dict

to_str()[source]: Returns the string representation of the model

__repr__()[source]: For print and pprint

__eq__(other)[source]: Returns true if both objects are equal

__ne__(other)[source]: Returns true if both objects are not equal

class geonode.geoserver.acl.gsauth_client.RuleFilter(instance=None, user=None, roles=None, service=None, request=None, subfield=None, workspace=None, layer=None, source_address=None, local_vars_configuration=None)[source]

Bases: object

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

Do not edit the class manually.

openapi_types

attribute_map

local_vars_configuration

_instance = None

_user = None

_roles = None

_service = None

_request = None

_subfield = None

_workspace = None

_layer = None

_source_address = None

discriminator = None

property instance

property E501

Returns:: The instance of this RuleFilter. # noqa: E501
Return type:: TextFilter
Type:: Gets the instance of this RuleFilter. # noqa

property user

property E501

Returns:: The user of this RuleFilter. # noqa: E501
Return type:: TextFilter
Type:: Gets the user of this RuleFilter. # noqa

property roles

property E501

Returns:: The roles of this RuleFilter. # noqa: E501
Return type:: SetFilter
Type:: Gets the roles of this RuleFilter. # noqa

property service

property E501

Returns:: The service of this RuleFilter. # noqa: E501
Return type:: TextFilter
Type:: Gets the service of this RuleFilter. # noqa

property request

property E501

Returns:: The request of this RuleFilter. # noqa: E501
Return type:: TextFilter
Type:: Gets the request of this RuleFilter. # noqa

property subfield

property E501

Returns:: The subfield of this RuleFilter. # noqa: E501
Return type:: TextFilter
Type:: Gets the subfield of this RuleFilter. # noqa

property workspace

property E501

Returns:: The workspace of this RuleFilter. # noqa: E501
Return type:: TextFilter
Type:: Gets the workspace of this RuleFilter. # noqa

property layer

property E501

Returns:: The layer of this RuleFilter. # noqa: E501
Return type:: TextFilter
Type:: Gets the layer of this RuleFilter. # noqa

property source_address

property E501

Returns:: The source_address of this RuleFilter. # noqa: E501
Return type:: AddressRangeFilter
Type:: Gets the source_address of this RuleFilter. # noqa

to_dict(serialize=False)[source]: Returns the model properties as a dict

to_str()[source]: Returns the string representation of the model

__repr__()[source]: For print and pprint

__eq__(other)[source]: Returns true if both objects are equal

__ne__(other)[source]: Returns true if both objects are not equal

class geonode.geoserver.acl.gsauth_client.RuleLimits(allowed_area=None, spatial_filter_type=None, catalog_mode=None, local_vars_configuration=None)[source]

Bases: object

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

Do not edit the class manually.

openapi_types

attribute_map

local_vars_configuration

_allowed_area = None

_spatial_filter_type = None

_catalog_mode = None

discriminator = None

property spatial_filter_type

property E501

Returns:: The spatial_filter_type of this RuleLimits. # noqa: E501
Return type:: SpatialFilterType
Type:: Gets the spatial_filter_type of this RuleLimits. # noqa

property catalog_mode

property E501

Returns:: The catalog_mode of this RuleLimits. # noqa: E501
Return type:: CatalogMode
Type:: Gets the catalog_mode of this RuleLimits. # noqa

property allowed_area

property E501

Returns:: The allowed_area of this RuleLimits. # noqa: E501
Return type:: Geom
Type:: Gets the allowed_area of this RuleLimits. # noqa

to_dict(serialize=False)[source]: Returns the model properties as a dict

to_str()[source]: Returns the string representation of the model

__repr__()[source]: For print and pprint

__eq__(other)[source]: Returns true if both objects are equal

__ne__(other)[source]: Returns true if both objects are not equal

class geonode.geoserver.acl.gsauth_client.SetFilter(include_default=None, values=None, local_vars_configuration=None)[source]

Bases: object

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

Do not edit the class manually.

openapi_types

attribute_map

local_vars_configuration

_include_default = None

_values = None

discriminator = None

property include_default

property E501

Returns:: The include_default of this SetFilter. # noqa: E501
Return type:: bool
Type:: Gets the include_default of this SetFilter. # noqa

property values

property E501

Returns:: The values of this SetFilter. # noqa: E501
Return type:: list[str]
Type:: Gets the values of this SetFilter. # noqa

to_dict(serialize=False)[source]: Returns the model properties as a dict

to_str()[source]: Returns the string representation of the model

__repr__()[source]: For print and pprint

__eq__(other)[source]: Returns true if both objects are equal

__ne__(other)[source]: Returns true if both objects are not equal

class geonode.geoserver.acl.gsauth_client.SpatialFilterType(local_vars_configuration=None)[source]

Bases: object

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

Do not edit the class manually.

INTERSECT = 'INTERSECT'

CLIP = 'CLIP'

allowable_values: Attributes: openapi_types (dict): The key is attribute name and the value is attribute type. attribute_map (dict): The key is attribute name and the value is json key in definition.

openapi_types

attribute_map

local_vars_configuration

discriminator = None

to_dict(serialize=False)[source]: Returns the model properties as a dict

to_str()[source]: Returns the string representation of the model

__repr__()[source]: For print and pprint

__eq__(other)[source]: Returns true if both objects are equal

__ne__(other)[source]: Returns true if both objects are not equal

class geonode.geoserver.acl.gsauth_client.TextFilter(include_default=None, value=None, local_vars_configuration=None)[source]

Bases: object

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

Do not edit the class manually.

openapi_types

attribute_map

local_vars_configuration

_include_default = None

_value = None

discriminator = None

property include_default

property E501

Returns:: The include_default of this TextFilter. # noqa: E501
Return type:: bool
Type:: Gets the include_default of this TextFilter. # noqa

property value

property E501

An absent value will match both set and default values for the property, a value with only the character literal ‘*’ will match only the default values for the property, any other specific value will match properties with that value # noqa: E501

Returns:: The value of this TextFilter. # noqa: E501
Return type:: str
Type:: Gets the value of this TextFilter. # noqa

to_dict(serialize=False)[source]: Returns the model properties as a dict

to_str()[source]: Returns the string representation of the model

__repr__()[source]: For print and pprint

__eq__(other)[source]: Returns true if both objects are equal

__ne__(other)[source]: Returns true if both objects are not equal

class geonode.geoserver.acl.gsauth_client.Wkb(wkb=None, local_vars_configuration=None)[source]

Bases: object

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

Do not edit the class manually.

openapi_types

attribute_map

local_vars_configuration

_wkb = None

discriminator = None

property wkb

property E501

Returns:: The wkb of this Wkb. # noqa: E501
Return type:: str
Type:: Gets the wkb of this Wkb. # noqa

to_dict(serialize=False)[source]: Returns the model properties as a dict

to_str()[source]: Returns the string representation of the model

__repr__()[source]: For print and pprint

__eq__(other)[source]: Returns true if both objects are equal

__ne__(other)[source]: Returns true if both objects are not equal

class geonode.geoserver.acl.gsauth_client.Wkt(wkt=None, local_vars_configuration=None)[source]

Bases: object

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

Do not edit the class manually.

openapi_types

attribute_map

local_vars_configuration

_wkt = None

discriminator = None

property wkt

property E501

Returns:: The wkt of this Wkt. # noqa: E501
Return type:: str
Type:: Gets the wkt of this Wkt. # noqa

to_dict(serialize=False)[source]: Returns the model properties as a dict

to_str()[source]: Returns the string representation of the model

__repr__()[source]: For print and pprint

__eq__(other)[source]: Returns true if both objects are equal

__ne__(other)[source]: Returns true if both objects are not equal