garage-admin-sdk-generator/python/garage_admin_sdk/api/key_api.py

976 lines
36 KiB
Python
Raw Normal View History

2022-09-12 15:02:35 +00:00
"""
Garage Administration API v0+garage-v0.7.3
Administrate your Garage cluster programatically, including status, layout, keys, buckets, and maintainance tasks. *Disclaimer: The API is not stable yet, hence its v0 tag. The API can change at any time, and changes can include breaking backward compatibility. Read the changelog and upgrade your scripts before upgrading. Additionnaly, this specification is very early stage and can contain bugs, especially on error return codes/types that are not tested yet. Do not expect a well finished and polished product!* # noqa: E501
The version of the OpenAPI document: v0.7.3
Generated by: https://openapi-generator.tech
"""
import re # noqa: F401
import sys # noqa: F401
2022-09-13 14:00:03 +00:00
from garage_admin_sdk.api_client import ApiClient, Endpoint as _Endpoint
from garage_admin_sdk.model_utils import ( # noqa: F401
2022-09-12 15:02:35 +00:00
check_allowed_values,
check_validations,
date,
datetime,
file_type,
none_type,
validate_and_convert_types
)
from garage_admin_sdk.model.add_key_request import AddKeyRequest
from garage_admin_sdk.model.import_key_request import ImportKeyRequest
2022-09-13 14:00:03 +00:00
from garage_admin_sdk.model.key_info import KeyInfo
from garage_admin_sdk.model.list_keys200_response_inner import ListKeys200ResponseInner
from garage_admin_sdk.model.update_key_request import UpdateKeyRequest
2022-09-12 15:02:35 +00:00
class KeyApi(object):
"""NOTE: This class is auto generated by OpenAPI Generator
Ref: https://openapi-generator.tech
Do not edit the class manually.
"""
def __init__(self, api_client=None):
if api_client is None:
api_client = ApiClient()
self.api_client = api_client
self.add_key_endpoint = _Endpoint(
2022-09-12 15:02:35 +00:00
settings={
'response_type': (KeyInfo,),
2022-09-12 15:13:43 +00:00
'auth': [
'bearerAuth'
],
'endpoint_path': '/key',
'operation_id': 'add_key',
2022-09-12 15:02:35 +00:00
'http_method': 'POST',
'servers': None,
},
params_map={
'all': [
'add_key_request',
2022-09-12 15:02:35 +00:00
],
2022-09-14 13:45:21 +00:00
'required': [
'add_key_request',
],
2022-09-12 15:02:35 +00:00
'nullable': [
],
'enum': [
],
'validation': [
]
},
root_map={
'validations': {
},
'allowed_values': {
},
'openapi_types': {
'add_key_request':
(AddKeyRequest,),
2022-09-12 15:02:35 +00:00
},
'attribute_map': {
},
'location_map': {
'add_key_request': 'body',
2022-09-12 15:02:35 +00:00
},
'collection_format_map': {
}
},
headers_map={
'accept': [
'application/json'
],
'content_type': [
'application/json'
]
},
api_client=api_client
)
self.delete_key_endpoint = _Endpoint(
2022-09-12 15:02:35 +00:00
settings={
'response_type': None,
2022-09-12 15:13:43 +00:00
'auth': [
'bearerAuth'
],
'endpoint_path': '/key?id={access_key}',
'operation_id': 'delete_key',
'http_method': 'DELETE',
2022-09-12 15:02:35 +00:00
'servers': None,
},
params_map={
'all': [
'access_key',
],
'required': [
'access_key',
2022-09-12 15:02:35 +00:00
],
'nullable': [
],
'enum': [
],
'validation': [
]
},
root_map={
'validations': {
},
'allowed_values': {
},
'openapi_types': {
'access_key':
(str,),
2022-09-12 15:02:35 +00:00
},
'attribute_map': {
'access_key': 'access_key',
2022-09-12 15:02:35 +00:00
},
'location_map': {
'access_key': 'path',
2022-09-12 15:02:35 +00:00
},
'collection_format_map': {
}
},
headers_map={
'accept': [],
'content_type': [],
2022-09-12 15:02:35 +00:00
},
api_client=api_client
)
self.get_key_endpoint = _Endpoint(
2022-09-12 15:02:35 +00:00
settings={
'response_type': (KeyInfo,),
2022-09-12 15:13:43 +00:00
'auth': [
'bearerAuth'
],
2022-09-12 15:02:35 +00:00
'endpoint_path': '/key?id={access_key}',
'operation_id': 'get_key',
'http_method': 'GET',
2022-09-12 15:02:35 +00:00
'servers': None,
},
params_map={
'all': [
'access_key',
],
'required': [
'access_key',
],
'nullable': [
],
'enum': [
],
'validation': [
]
},
root_map={
'validations': {
},
'allowed_values': {
},
'openapi_types': {
'access_key':
(str,),
},
'attribute_map': {
'access_key': 'access_key',
},
'location_map': {
'access_key': 'path',
},
'collection_format_map': {
}
},
headers_map={
'accept': [
'application/json'
],
2022-09-12 15:02:35 +00:00
'content_type': [],
},
api_client=api_client
)
self.import_key_endpoint = _Endpoint(
2022-09-12 15:02:35 +00:00
settings={
'response_type': (KeyInfo,),
2022-09-12 15:13:43 +00:00
'auth': [
'bearerAuth'
],
'endpoint_path': '/key/import',
'operation_id': 'import_key',
'http_method': 'POST',
2022-09-12 15:02:35 +00:00
'servers': None,
},
params_map={
'all': [
'import_key_request',
2022-09-12 15:02:35 +00:00
],
2022-09-14 13:45:21 +00:00
'required': [
'import_key_request',
],
2022-09-12 15:02:35 +00:00
'nullable': [
],
'enum': [
],
'validation': [
]
},
root_map={
'validations': {
},
'allowed_values': {
},
'openapi_types': {
'import_key_request':
(ImportKeyRequest,),
2022-09-12 15:02:35 +00:00
},
'attribute_map': {
},
'location_map': {
'import_key_request': 'body',
2022-09-12 15:02:35 +00:00
},
'collection_format_map': {
}
},
headers_map={
'accept': [
'application/json'
],
'content_type': [
'application/json'
]
2022-09-12 15:02:35 +00:00
},
api_client=api_client
)
self.list_keys_endpoint = _Endpoint(
2022-09-12 15:02:35 +00:00
settings={
'response_type': ([ListKeys200ResponseInner],),
2022-09-12 15:13:43 +00:00
'auth': [
'bearerAuth'
],
'endpoint_path': '/key',
'operation_id': 'list_keys',
'http_method': 'GET',
2022-09-12 15:02:35 +00:00
'servers': None,
},
params_map={
'all': [
],
'required': [],
2022-09-12 15:02:35 +00:00
'nullable': [
],
'enum': [
],
'validation': [
]
},
root_map={
'validations': {
},
'allowed_values': {
},
'openapi_types': {
},
'attribute_map': {
},
'location_map': {
},
'collection_format_map': {
}
},
headers_map={
'accept': [
'application/json'
],
'content_type': [],
2022-09-12 15:02:35 +00:00
},
api_client=api_client
)
self.search_key_endpoint = _Endpoint(
2022-09-12 15:02:35 +00:00
settings={
'response_type': (KeyInfo,),
2022-09-12 15:13:43 +00:00
'auth': [
'bearerAuth'
],
2022-09-12 15:02:35 +00:00
'endpoint_path': '/key?search={pattern}',
'operation_id': 'search_key',
2022-09-12 15:02:35 +00:00
'http_method': 'GET',
'servers': None,
},
params_map={
'all': [
'pattern',
],
'required': [
'pattern',
],
'nullable': [
],
'enum': [
],
'validation': [
]
},
root_map={
'validations': {
},
'allowed_values': {
},
'openapi_types': {
'pattern':
(str,),
},
'attribute_map': {
'pattern': 'pattern',
},
'location_map': {
'pattern': 'path',
},
'collection_format_map': {
}
},
headers_map={
'accept': [
'application/json'
],
'content_type': [],
},
api_client=api_client
)
self.update_key_endpoint = _Endpoint(
2022-09-12 15:02:35 +00:00
settings={
'response_type': (KeyInfo,),
2022-09-12 15:13:43 +00:00
'auth': [
'bearerAuth'
],
'endpoint_path': '/key?id={access_key}',
'operation_id': 'update_key',
'http_method': 'POST',
2022-09-12 15:02:35 +00:00
'servers': None,
},
params_map={
'all': [
'access_key',
'update_key_request',
],
'required': [
'access_key',
2022-09-12 15:02:35 +00:00
],
'nullable': [
],
'enum': [
],
'validation': [
]
},
root_map={
'validations': {
},
'allowed_values': {
},
'openapi_types': {
'access_key':
(str,),
'update_key_request':
(UpdateKeyRequest,),
2022-09-12 15:02:35 +00:00
},
'attribute_map': {
'access_key': 'access_key',
2022-09-12 15:02:35 +00:00
},
'location_map': {
'access_key': 'path',
'update_key_request': 'body',
2022-09-12 15:02:35 +00:00
},
'collection_format_map': {
}
},
headers_map={
'accept': [
'application/json'
],
'content_type': [
'application/json'
]
2022-09-12 15:02:35 +00:00
},
api_client=api_client
)
def add_key(
2022-09-12 15:02:35 +00:00
self,
2022-09-14 13:45:21 +00:00
add_key_request,
2022-09-12 15:02:35 +00:00
**kwargs
):
"""Create a new API key # noqa: E501
2022-09-12 15:02:35 +00:00
Creates a new API access key. # noqa: E501
2022-09-12 15:02:35 +00:00
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
2022-09-14 13:45:21 +00:00
>>> thread = api.add_key(add_key_request, async_req=True)
2022-09-12 15:02:35 +00:00
>>> result = thread.get()
2022-09-14 13:45:21 +00:00
Args:
add_key_request (AddKeyRequest): \"You can set a friendly name for this key, send an empty string instead\"
2022-09-12 15:02:35 +00:00
Keyword Args:
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
will be returned without reading/decoding response data.
Default is True.
_request_timeout (int/float/tuple): 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.
Default is None.
_check_input_type (bool): specifies if type checking
should be done one the data sent to the server.
Default is True.
_check_return_type (bool): specifies if type checking
should be done one the data received from the server.
Default is True.
_spec_property_naming (bool): True if the variable names in the input data
are serialized names, as specified in the OpenAPI document.
False if the variable names in the input data
are pythonic names, e.g. snake case (default)
_content_type (str/None): force body content-type.
Default is None and content-type will be predicted by allowed
content-types and body.
_host_index (int/None): specifies the index of the server
that we want to use.
Default is read from the configuration.
_request_auths (list): set to override the auth_settings for an a single
request; this effectively ignores the authentication
in the spec for a single request.
Default is None
async_req (bool): execute request asynchronously
Returns:
KeyInfo
If the method is called asynchronously, returns the request
thread.
"""
kwargs['async_req'] = kwargs.get(
'async_req', False
)
kwargs['_return_http_data_only'] = kwargs.get(
'_return_http_data_only', True
)
kwargs['_preload_content'] = kwargs.get(
'_preload_content', True
)
kwargs['_request_timeout'] = kwargs.get(
'_request_timeout', None
)
kwargs['_check_input_type'] = kwargs.get(
'_check_input_type', True
)
kwargs['_check_return_type'] = kwargs.get(
'_check_return_type', True
)
kwargs['_spec_property_naming'] = kwargs.get(
'_spec_property_naming', False
)
kwargs['_content_type'] = kwargs.get(
'_content_type')
kwargs['_host_index'] = kwargs.get('_host_index')
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
2022-09-14 13:45:21 +00:00
kwargs['add_key_request'] = \
add_key_request
return self.add_key_endpoint.call_with_http_info(**kwargs)
2022-09-12 15:02:35 +00:00
def delete_key(
2022-09-12 15:02:35 +00:00
self,
access_key,
2022-09-12 15:02:35 +00:00
**kwargs
):
"""Delete a key # noqa: E501
2022-09-12 15:02:35 +00:00
Delete a key from the cluster. Its access will be removed from all the buckets. Buckets are not automatically deleted and can be dangling. You should manually delete them before. # noqa: E501
2022-09-12 15:02:35 +00:00
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_key(access_key, async_req=True)
2022-09-12 15:02:35 +00:00
>>> result = thread.get()
Args:
access_key (str): The exact API access key generated by Garage
2022-09-12 15:02:35 +00:00
Keyword Args:
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
will be returned without reading/decoding response data.
Default is True.
_request_timeout (int/float/tuple): 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.
Default is None.
_check_input_type (bool): specifies if type checking
should be done one the data sent to the server.
Default is True.
_check_return_type (bool): specifies if type checking
should be done one the data received from the server.
Default is True.
_spec_property_naming (bool): True if the variable names in the input data
are serialized names, as specified in the OpenAPI document.
False if the variable names in the input data
are pythonic names, e.g. snake case (default)
_content_type (str/None): force body content-type.
Default is None and content-type will be predicted by allowed
content-types and body.
_host_index (int/None): specifies the index of the server
that we want to use.
Default is read from the configuration.
_request_auths (list): set to override the auth_settings for an a single
request; this effectively ignores the authentication
in the spec for a single request.
Default is None
async_req (bool): execute request asynchronously
Returns:
None
2022-09-12 15:02:35 +00:00
If the method is called asynchronously, returns the request
thread.
"""
kwargs['async_req'] = kwargs.get(
'async_req', False
)
kwargs['_return_http_data_only'] = kwargs.get(
'_return_http_data_only', True
)
kwargs['_preload_content'] = kwargs.get(
'_preload_content', True
)
kwargs['_request_timeout'] = kwargs.get(
'_request_timeout', None
)
kwargs['_check_input_type'] = kwargs.get(
'_check_input_type', True
)
kwargs['_check_return_type'] = kwargs.get(
'_check_return_type', True
)
kwargs['_spec_property_naming'] = kwargs.get(
'_spec_property_naming', False
)
kwargs['_content_type'] = kwargs.get(
'_content_type')
kwargs['_host_index'] = kwargs.get('_host_index')
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
kwargs['access_key'] = \
access_key
return self.delete_key_endpoint.call_with_http_info(**kwargs)
2022-09-12 15:02:35 +00:00
def get_key(
2022-09-12 15:02:35 +00:00
self,
access_key,
**kwargs
):
"""Get key information # noqa: E501
2022-09-12 15:02:35 +00:00
Return information about a specific key and return its information # noqa: E501
2022-09-12 15:02:35 +00:00
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.get_key(access_key, async_req=True)
2022-09-12 15:02:35 +00:00
>>> result = thread.get()
Args:
access_key (str): The exact API access key generated by Garage
Keyword Args:
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
will be returned without reading/decoding response data.
Default is True.
_request_timeout (int/float/tuple): 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.
Default is None.
_check_input_type (bool): specifies if type checking
should be done one the data sent to the server.
Default is True.
_check_return_type (bool): specifies if type checking
should be done one the data received from the server.
Default is True.
_spec_property_naming (bool): True if the variable names in the input data
are serialized names, as specified in the OpenAPI document.
False if the variable names in the input data
are pythonic names, e.g. snake case (default)
_content_type (str/None): force body content-type.
Default is None and content-type will be predicted by allowed
content-types and body.
_host_index (int/None): specifies the index of the server
that we want to use.
Default is read from the configuration.
_request_auths (list): set to override the auth_settings for an a single
request; this effectively ignores the authentication
in the spec for a single request.
Default is None
async_req (bool): execute request asynchronously
Returns:
KeyInfo
2022-09-12 15:02:35 +00:00
If the method is called asynchronously, returns the request
thread.
"""
kwargs['async_req'] = kwargs.get(
'async_req', False
)
kwargs['_return_http_data_only'] = kwargs.get(
'_return_http_data_only', True
)
kwargs['_preload_content'] = kwargs.get(
'_preload_content', True
)
kwargs['_request_timeout'] = kwargs.get(
'_request_timeout', None
)
kwargs['_check_input_type'] = kwargs.get(
'_check_input_type', True
)
kwargs['_check_return_type'] = kwargs.get(
'_check_return_type', True
)
kwargs['_spec_property_naming'] = kwargs.get(
'_spec_property_naming', False
)
kwargs['_content_type'] = kwargs.get(
'_content_type')
kwargs['_host_index'] = kwargs.get('_host_index')
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
kwargs['access_key'] = \
access_key
return self.get_key_endpoint.call_with_http_info(**kwargs)
2022-09-12 15:02:35 +00:00
def import_key(
2022-09-12 15:02:35 +00:00
self,
2022-09-14 13:45:21 +00:00
import_key_request,
2022-09-12 15:02:35 +00:00
**kwargs
):
"""Import an existing key # noqa: E501
2022-09-12 15:02:35 +00:00
Imports an existing API key. This feature must only be used for migrations and backup restore. **Do not use it to generate custom key identifiers or you will break your Garage cluster.** # noqa: E501
2022-09-12 15:02:35 +00:00
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
2022-09-14 13:45:21 +00:00
>>> thread = api.import_key(import_key_request, async_req=True)
2022-09-12 15:02:35 +00:00
>>> result = thread.get()
2022-09-14 13:45:21 +00:00
Args:
import_key_request (ImportKeyRequest): Information on the key to import
2022-09-12 15:02:35 +00:00
Keyword Args:
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
will be returned without reading/decoding response data.
Default is True.
_request_timeout (int/float/tuple): 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.
Default is None.
_check_input_type (bool): specifies if type checking
should be done one the data sent to the server.
Default is True.
_check_return_type (bool): specifies if type checking
should be done one the data received from the server.
Default is True.
_spec_property_naming (bool): True if the variable names in the input data
are serialized names, as specified in the OpenAPI document.
False if the variable names in the input data
are pythonic names, e.g. snake case (default)
_content_type (str/None): force body content-type.
Default is None and content-type will be predicted by allowed
content-types and body.
_host_index (int/None): specifies the index of the server
that we want to use.
Default is read from the configuration.
_request_auths (list): set to override the auth_settings for an a single
request; this effectively ignores the authentication
in the spec for a single request.
Default is None
async_req (bool): execute request asynchronously
Returns:
KeyInfo
If the method is called asynchronously, returns the request
thread.
"""
kwargs['async_req'] = kwargs.get(
'async_req', False
)
kwargs['_return_http_data_only'] = kwargs.get(
'_return_http_data_only', True
)
kwargs['_preload_content'] = kwargs.get(
'_preload_content', True
)
kwargs['_request_timeout'] = kwargs.get(
'_request_timeout', None
)
kwargs['_check_input_type'] = kwargs.get(
'_check_input_type', True
)
kwargs['_check_return_type'] = kwargs.get(
'_check_return_type', True
)
kwargs['_spec_property_naming'] = kwargs.get(
'_spec_property_naming', False
)
kwargs['_content_type'] = kwargs.get(
'_content_type')
kwargs['_host_index'] = kwargs.get('_host_index')
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
2022-09-14 13:45:21 +00:00
kwargs['import_key_request'] = \
import_key_request
return self.import_key_endpoint.call_with_http_info(**kwargs)
2022-09-12 15:02:35 +00:00
def list_keys(
2022-09-12 15:02:35 +00:00
self,
**kwargs
):
"""List all keys # noqa: E501
2022-09-12 15:02:35 +00:00
Returns all API access keys in the cluster. # noqa: E501
2022-09-12 15:02:35 +00:00
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_keys(async_req=True)
2022-09-12 15:02:35 +00:00
>>> result = thread.get()
Keyword Args:
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
will be returned without reading/decoding response data.
Default is True.
_request_timeout (int/float/tuple): 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.
Default is None.
_check_input_type (bool): specifies if type checking
should be done one the data sent to the server.
Default is True.
_check_return_type (bool): specifies if type checking
should be done one the data received from the server.
Default is True.
_spec_property_naming (bool): True if the variable names in the input data
are serialized names, as specified in the OpenAPI document.
False if the variable names in the input data
are pythonic names, e.g. snake case (default)
_content_type (str/None): force body content-type.
Default is None and content-type will be predicted by allowed
content-types and body.
_host_index (int/None): specifies the index of the server
that we want to use.
Default is read from the configuration.
_request_auths (list): set to override the auth_settings for an a single
request; this effectively ignores the authentication
in the spec for a single request.
Default is None
async_req (bool): execute request asynchronously
Returns:
[ListKeys200ResponseInner]
2022-09-12 15:02:35 +00:00
If the method is called asynchronously, returns the request
thread.
"""
kwargs['async_req'] = kwargs.get(
'async_req', False
)
kwargs['_return_http_data_only'] = kwargs.get(
'_return_http_data_only', True
)
kwargs['_preload_content'] = kwargs.get(
'_preload_content', True
)
kwargs['_request_timeout'] = kwargs.get(
'_request_timeout', None
)
kwargs['_check_input_type'] = kwargs.get(
'_check_input_type', True
)
kwargs['_check_return_type'] = kwargs.get(
'_check_return_type', True
)
kwargs['_spec_property_naming'] = kwargs.get(
'_spec_property_naming', False
)
kwargs['_content_type'] = kwargs.get(
'_content_type')
kwargs['_host_index'] = kwargs.get('_host_index')
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
return self.list_keys_endpoint.call_with_http_info(**kwargs)
2022-09-12 15:02:35 +00:00
def search_key(
2022-09-12 15:02:35 +00:00
self,
pattern,
**kwargs
):
"""Select key by pattern # noqa: E501
Find the first key matching the given pattern based on its identifier aor friendly name and return its information. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.search_key(pattern, async_req=True)
2022-09-12 15:02:35 +00:00
>>> result = thread.get()
Args:
pattern (str): A pattern (beginning or full string) corresponding to a key identifier or friendly name
Keyword Args:
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
will be returned without reading/decoding response data.
Default is True.
_request_timeout (int/float/tuple): 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.
Default is None.
_check_input_type (bool): specifies if type checking
should be done one the data sent to the server.
Default is True.
_check_return_type (bool): specifies if type checking
should be done one the data received from the server.
Default is True.
_spec_property_naming (bool): True if the variable names in the input data
are serialized names, as specified in the OpenAPI document.
False if the variable names in the input data
are pythonic names, e.g. snake case (default)
_content_type (str/None): force body content-type.
Default is None and content-type will be predicted by allowed
content-types and body.
_host_index (int/None): specifies the index of the server
that we want to use.
Default is read from the configuration.
_request_auths (list): set to override the auth_settings for an a single
request; this effectively ignores the authentication
in the spec for a single request.
Default is None
async_req (bool): execute request asynchronously
Returns:
KeyInfo
If the method is called asynchronously, returns the request
thread.
"""
kwargs['async_req'] = kwargs.get(
'async_req', False
)
kwargs['_return_http_data_only'] = kwargs.get(
'_return_http_data_only', True
)
kwargs['_preload_content'] = kwargs.get(
'_preload_content', True
)
kwargs['_request_timeout'] = kwargs.get(
'_request_timeout', None
)
kwargs['_check_input_type'] = kwargs.get(
'_check_input_type', True
)
kwargs['_check_return_type'] = kwargs.get(
'_check_return_type', True
)
kwargs['_spec_property_naming'] = kwargs.get(
'_spec_property_naming', False
)
kwargs['_content_type'] = kwargs.get(
'_content_type')
kwargs['_host_index'] = kwargs.get('_host_index')
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
kwargs['pattern'] = \
pattern
return self.search_key_endpoint.call_with_http_info(**kwargs)
2022-09-12 15:02:35 +00:00
def update_key(
2022-09-12 15:02:35 +00:00
self,
access_key,
2022-09-12 15:02:35 +00:00
**kwargs
):
"""Update a key # noqa: E501
2022-09-12 15:02:35 +00:00
Updates information about the specified API access key. # noqa: E501
2022-09-12 15:02:35 +00:00
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.update_key(access_key, async_req=True)
2022-09-12 15:02:35 +00:00
>>> result = thread.get()
Args:
access_key (str): The exact API access key generated by Garage
2022-09-12 15:02:35 +00:00
Keyword Args:
update_key_request (UpdateKeyRequest): For a given key, provide a first set with the permissions to grant, and a second set with the permissions to remove . [optional]
2022-09-12 15:02:35 +00:00
_return_http_data_only (bool): response data without head status
code and headers. Default is True.
_preload_content (bool): if False, the urllib3.HTTPResponse object
will be returned without reading/decoding response data.
Default is True.
_request_timeout (int/float/tuple): 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.
Default is None.
_check_input_type (bool): specifies if type checking
should be done one the data sent to the server.
Default is True.
_check_return_type (bool): specifies if type checking
should be done one the data received from the server.
Default is True.
_spec_property_naming (bool): True if the variable names in the input data
are serialized names, as specified in the OpenAPI document.
False if the variable names in the input data
are pythonic names, e.g. snake case (default)
_content_type (str/None): force body content-type.
Default is None and content-type will be predicted by allowed
content-types and body.
_host_index (int/None): specifies the index of the server
that we want to use.
Default is read from the configuration.
_request_auths (list): set to override the auth_settings for an a single
request; this effectively ignores the authentication
in the spec for a single request.
Default is None
async_req (bool): execute request asynchronously
Returns:
KeyInfo
2022-09-12 15:02:35 +00:00
If the method is called asynchronously, returns the request
thread.
"""
kwargs['async_req'] = kwargs.get(
'async_req', False
)
kwargs['_return_http_data_only'] = kwargs.get(
'_return_http_data_only', True
)
kwargs['_preload_content'] = kwargs.get(
'_preload_content', True
)
kwargs['_request_timeout'] = kwargs.get(
'_request_timeout', None
)
kwargs['_check_input_type'] = kwargs.get(
'_check_input_type', True
)
kwargs['_check_return_type'] = kwargs.get(
'_check_return_type', True
)
kwargs['_spec_property_naming'] = kwargs.get(
'_spec_property_naming', False
)
kwargs['_content_type'] = kwargs.get(
'_content_type')
kwargs['_host_index'] = kwargs.get('_host_index')
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
kwargs['access_key'] = \
access_key
return self.update_key_endpoint.call_with_http_info(**kwargs)
2022-09-12 15:02:35 +00:00