1711 lines
65 KiB
Python
1711 lines
65 KiB
Python
"""
|
|
Garage Administration API v0+garage-v0.8.0
|
|
|
|
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.8.0
|
|
Generated by: https://openapi-generator.tech
|
|
"""
|
|
|
|
|
|
import re # noqa: F401
|
|
import sys # noqa: F401
|
|
|
|
from garage_admin_sdk.api_client import ApiClient, Endpoint as _Endpoint
|
|
from garage_admin_sdk.model_utils import ( # noqa: F401
|
|
check_allowed_values,
|
|
check_validations,
|
|
date,
|
|
datetime,
|
|
file_type,
|
|
none_type,
|
|
validate_and_convert_types
|
|
)
|
|
from garage_admin_sdk.model.allow_bucket_key_request import AllowBucketKeyRequest
|
|
from garage_admin_sdk.model.bucket_info import BucketInfo
|
|
from garage_admin_sdk.model.create_bucket_request import CreateBucketRequest
|
|
from garage_admin_sdk.model.list_buckets200_response_inner import ListBuckets200ResponseInner
|
|
from garage_admin_sdk.model.update_bucket_request import UpdateBucketRequest
|
|
|
|
|
|
class BucketApi(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.allow_bucket_key_endpoint = _Endpoint(
|
|
settings={
|
|
'response_type': (BucketInfo,),
|
|
'auth': [
|
|
'bearerAuth'
|
|
],
|
|
'endpoint_path': '/bucket/allow',
|
|
'operation_id': 'allow_bucket_key',
|
|
'http_method': 'POST',
|
|
'servers': None,
|
|
},
|
|
params_map={
|
|
'all': [
|
|
'allow_bucket_key_request',
|
|
],
|
|
'required': [
|
|
'allow_bucket_key_request',
|
|
],
|
|
'nullable': [
|
|
],
|
|
'enum': [
|
|
],
|
|
'validation': [
|
|
]
|
|
},
|
|
root_map={
|
|
'validations': {
|
|
},
|
|
'allowed_values': {
|
|
},
|
|
'openapi_types': {
|
|
'allow_bucket_key_request':
|
|
(AllowBucketKeyRequest,),
|
|
},
|
|
'attribute_map': {
|
|
},
|
|
'location_map': {
|
|
'allow_bucket_key_request': 'body',
|
|
},
|
|
'collection_format_map': {
|
|
}
|
|
},
|
|
headers_map={
|
|
'accept': [
|
|
'application/json'
|
|
],
|
|
'content_type': [
|
|
'application/json'
|
|
]
|
|
},
|
|
api_client=api_client
|
|
)
|
|
self.create_bucket_endpoint = _Endpoint(
|
|
settings={
|
|
'response_type': (BucketInfo,),
|
|
'auth': [
|
|
'bearerAuth'
|
|
],
|
|
'endpoint_path': '/bucket',
|
|
'operation_id': 'create_bucket',
|
|
'http_method': 'POST',
|
|
'servers': None,
|
|
},
|
|
params_map={
|
|
'all': [
|
|
'create_bucket_request',
|
|
],
|
|
'required': [
|
|
'create_bucket_request',
|
|
],
|
|
'nullable': [
|
|
],
|
|
'enum': [
|
|
],
|
|
'validation': [
|
|
]
|
|
},
|
|
root_map={
|
|
'validations': {
|
|
},
|
|
'allowed_values': {
|
|
},
|
|
'openapi_types': {
|
|
'create_bucket_request':
|
|
(CreateBucketRequest,),
|
|
},
|
|
'attribute_map': {
|
|
},
|
|
'location_map': {
|
|
'create_bucket_request': 'body',
|
|
},
|
|
'collection_format_map': {
|
|
}
|
|
},
|
|
headers_map={
|
|
'accept': [
|
|
'application/json'
|
|
],
|
|
'content_type': [
|
|
'application/json'
|
|
]
|
|
},
|
|
api_client=api_client
|
|
)
|
|
self.delete_bucket_endpoint = _Endpoint(
|
|
settings={
|
|
'response_type': None,
|
|
'auth': [
|
|
'bearerAuth'
|
|
],
|
|
'endpoint_path': '/bucket?id={bucket_id}',
|
|
'operation_id': 'delete_bucket',
|
|
'http_method': 'DELETE',
|
|
'servers': None,
|
|
},
|
|
params_map={
|
|
'all': [
|
|
'bucket_id',
|
|
],
|
|
'required': [
|
|
'bucket_id',
|
|
],
|
|
'nullable': [
|
|
],
|
|
'enum': [
|
|
],
|
|
'validation': [
|
|
]
|
|
},
|
|
root_map={
|
|
'validations': {
|
|
},
|
|
'allowed_values': {
|
|
},
|
|
'openapi_types': {
|
|
'bucket_id':
|
|
(str,),
|
|
},
|
|
'attribute_map': {
|
|
'bucket_id': 'bucket_id',
|
|
},
|
|
'location_map': {
|
|
'bucket_id': 'path',
|
|
},
|
|
'collection_format_map': {
|
|
}
|
|
},
|
|
headers_map={
|
|
'accept': [],
|
|
'content_type': [],
|
|
},
|
|
api_client=api_client
|
|
)
|
|
self.delete_bucket_global_alias_endpoint = _Endpoint(
|
|
settings={
|
|
'response_type': (BucketInfo,),
|
|
'auth': [
|
|
'bearerAuth'
|
|
],
|
|
'endpoint_path': '/bucket/alias/global',
|
|
'operation_id': 'delete_bucket_global_alias',
|
|
'http_method': 'DELETE',
|
|
'servers': None,
|
|
},
|
|
params_map={
|
|
'all': [
|
|
'id',
|
|
'alias',
|
|
],
|
|
'required': [
|
|
'id',
|
|
'alias',
|
|
],
|
|
'nullable': [
|
|
],
|
|
'enum': [
|
|
],
|
|
'validation': [
|
|
]
|
|
},
|
|
root_map={
|
|
'validations': {
|
|
},
|
|
'allowed_values': {
|
|
},
|
|
'openapi_types': {
|
|
'id':
|
|
(str,),
|
|
'alias':
|
|
(str,),
|
|
},
|
|
'attribute_map': {
|
|
'id': 'id',
|
|
'alias': 'alias',
|
|
},
|
|
'location_map': {
|
|
'id': 'query',
|
|
'alias': 'query',
|
|
},
|
|
'collection_format_map': {
|
|
}
|
|
},
|
|
headers_map={
|
|
'accept': [
|
|
'application/json'
|
|
],
|
|
'content_type': [],
|
|
},
|
|
api_client=api_client
|
|
)
|
|
self.delete_bucket_local_alias_endpoint = _Endpoint(
|
|
settings={
|
|
'response_type': (BucketInfo,),
|
|
'auth': [
|
|
'bearerAuth'
|
|
],
|
|
'endpoint_path': '/bucket/alias/local',
|
|
'operation_id': 'delete_bucket_local_alias',
|
|
'http_method': 'DELETE',
|
|
'servers': None,
|
|
},
|
|
params_map={
|
|
'all': [
|
|
'id',
|
|
'access_key_id',
|
|
'alias',
|
|
],
|
|
'required': [
|
|
'id',
|
|
'access_key_id',
|
|
'alias',
|
|
],
|
|
'nullable': [
|
|
],
|
|
'enum': [
|
|
],
|
|
'validation': [
|
|
]
|
|
},
|
|
root_map={
|
|
'validations': {
|
|
},
|
|
'allowed_values': {
|
|
},
|
|
'openapi_types': {
|
|
'id':
|
|
(str,),
|
|
'access_key_id':
|
|
(str,),
|
|
'alias':
|
|
(str,),
|
|
},
|
|
'attribute_map': {
|
|
'id': 'id',
|
|
'access_key_id': 'accessKeyId',
|
|
'alias': 'alias',
|
|
},
|
|
'location_map': {
|
|
'id': 'query',
|
|
'access_key_id': 'query',
|
|
'alias': 'query',
|
|
},
|
|
'collection_format_map': {
|
|
}
|
|
},
|
|
headers_map={
|
|
'accept': [
|
|
'application/json'
|
|
],
|
|
'content_type': [],
|
|
},
|
|
api_client=api_client
|
|
)
|
|
self.deny_bucket_key_endpoint = _Endpoint(
|
|
settings={
|
|
'response_type': (BucketInfo,),
|
|
'auth': [
|
|
'bearerAuth'
|
|
],
|
|
'endpoint_path': '/bucket/deny',
|
|
'operation_id': 'deny_bucket_key',
|
|
'http_method': 'POST',
|
|
'servers': None,
|
|
},
|
|
params_map={
|
|
'all': [
|
|
'allow_bucket_key_request',
|
|
],
|
|
'required': [
|
|
'allow_bucket_key_request',
|
|
],
|
|
'nullable': [
|
|
],
|
|
'enum': [
|
|
],
|
|
'validation': [
|
|
]
|
|
},
|
|
root_map={
|
|
'validations': {
|
|
},
|
|
'allowed_values': {
|
|
},
|
|
'openapi_types': {
|
|
'allow_bucket_key_request':
|
|
(AllowBucketKeyRequest,),
|
|
},
|
|
'attribute_map': {
|
|
},
|
|
'location_map': {
|
|
'allow_bucket_key_request': 'body',
|
|
},
|
|
'collection_format_map': {
|
|
}
|
|
},
|
|
headers_map={
|
|
'accept': [
|
|
'application/json'
|
|
],
|
|
'content_type': [
|
|
'application/json'
|
|
]
|
|
},
|
|
api_client=api_client
|
|
)
|
|
self.find_bucket_info_endpoint = _Endpoint(
|
|
settings={
|
|
'response_type': (BucketInfo,),
|
|
'auth': [
|
|
'bearerAuth'
|
|
],
|
|
'endpoint_path': '/bucket?globalAlias={alias}',
|
|
'operation_id': 'find_bucket_info',
|
|
'http_method': 'GET',
|
|
'servers': None,
|
|
},
|
|
params_map={
|
|
'all': [
|
|
'alias',
|
|
],
|
|
'required': [
|
|
'alias',
|
|
],
|
|
'nullable': [
|
|
],
|
|
'enum': [
|
|
],
|
|
'validation': [
|
|
]
|
|
},
|
|
root_map={
|
|
'validations': {
|
|
},
|
|
'allowed_values': {
|
|
},
|
|
'openapi_types': {
|
|
'alias':
|
|
(str,),
|
|
},
|
|
'attribute_map': {
|
|
'alias': 'alias',
|
|
},
|
|
'location_map': {
|
|
'alias': 'path',
|
|
},
|
|
'collection_format_map': {
|
|
}
|
|
},
|
|
headers_map={
|
|
'accept': [
|
|
'application/json'
|
|
],
|
|
'content_type': [],
|
|
},
|
|
api_client=api_client
|
|
)
|
|
self.get_bucket_info_endpoint = _Endpoint(
|
|
settings={
|
|
'response_type': (BucketInfo,),
|
|
'auth': [
|
|
'bearerAuth'
|
|
],
|
|
'endpoint_path': '/bucket?id={bucket_id}',
|
|
'operation_id': 'get_bucket_info',
|
|
'http_method': 'GET',
|
|
'servers': None,
|
|
},
|
|
params_map={
|
|
'all': [
|
|
'bucket_id',
|
|
],
|
|
'required': [
|
|
'bucket_id',
|
|
],
|
|
'nullable': [
|
|
],
|
|
'enum': [
|
|
],
|
|
'validation': [
|
|
]
|
|
},
|
|
root_map={
|
|
'validations': {
|
|
},
|
|
'allowed_values': {
|
|
},
|
|
'openapi_types': {
|
|
'bucket_id':
|
|
(str,),
|
|
},
|
|
'attribute_map': {
|
|
'bucket_id': 'bucket_id',
|
|
},
|
|
'location_map': {
|
|
'bucket_id': 'path',
|
|
},
|
|
'collection_format_map': {
|
|
}
|
|
},
|
|
headers_map={
|
|
'accept': [
|
|
'application/json'
|
|
],
|
|
'content_type': [],
|
|
},
|
|
api_client=api_client
|
|
)
|
|
self.list_buckets_endpoint = _Endpoint(
|
|
settings={
|
|
'response_type': ([ListBuckets200ResponseInner],),
|
|
'auth': [
|
|
'bearerAuth'
|
|
],
|
|
'endpoint_path': '/bucket',
|
|
'operation_id': 'list_buckets',
|
|
'http_method': 'GET',
|
|
'servers': None,
|
|
},
|
|
params_map={
|
|
'all': [
|
|
],
|
|
'required': [],
|
|
'nullable': [
|
|
],
|
|
'enum': [
|
|
],
|
|
'validation': [
|
|
]
|
|
},
|
|
root_map={
|
|
'validations': {
|
|
},
|
|
'allowed_values': {
|
|
},
|
|
'openapi_types': {
|
|
},
|
|
'attribute_map': {
|
|
},
|
|
'location_map': {
|
|
},
|
|
'collection_format_map': {
|
|
}
|
|
},
|
|
headers_map={
|
|
'accept': [
|
|
'application/json'
|
|
],
|
|
'content_type': [],
|
|
},
|
|
api_client=api_client
|
|
)
|
|
self.put_bucket_global_alias_endpoint = _Endpoint(
|
|
settings={
|
|
'response_type': (BucketInfo,),
|
|
'auth': [
|
|
'bearerAuth'
|
|
],
|
|
'endpoint_path': '/bucket/alias/global',
|
|
'operation_id': 'put_bucket_global_alias',
|
|
'http_method': 'PUT',
|
|
'servers': None,
|
|
},
|
|
params_map={
|
|
'all': [
|
|
'id',
|
|
'alias',
|
|
],
|
|
'required': [
|
|
'id',
|
|
'alias',
|
|
],
|
|
'nullable': [
|
|
],
|
|
'enum': [
|
|
],
|
|
'validation': [
|
|
]
|
|
},
|
|
root_map={
|
|
'validations': {
|
|
},
|
|
'allowed_values': {
|
|
},
|
|
'openapi_types': {
|
|
'id':
|
|
(str,),
|
|
'alias':
|
|
(str,),
|
|
},
|
|
'attribute_map': {
|
|
'id': 'id',
|
|
'alias': 'alias',
|
|
},
|
|
'location_map': {
|
|
'id': 'query',
|
|
'alias': 'query',
|
|
},
|
|
'collection_format_map': {
|
|
}
|
|
},
|
|
headers_map={
|
|
'accept': [
|
|
'application/json'
|
|
],
|
|
'content_type': [],
|
|
},
|
|
api_client=api_client
|
|
)
|
|
self.put_bucket_local_alias_endpoint = _Endpoint(
|
|
settings={
|
|
'response_type': (BucketInfo,),
|
|
'auth': [
|
|
'bearerAuth'
|
|
],
|
|
'endpoint_path': '/bucket/alias/local',
|
|
'operation_id': 'put_bucket_local_alias',
|
|
'http_method': 'PUT',
|
|
'servers': None,
|
|
},
|
|
params_map={
|
|
'all': [
|
|
'id',
|
|
'access_key_id',
|
|
'alias',
|
|
],
|
|
'required': [
|
|
'id',
|
|
'access_key_id',
|
|
'alias',
|
|
],
|
|
'nullable': [
|
|
],
|
|
'enum': [
|
|
],
|
|
'validation': [
|
|
]
|
|
},
|
|
root_map={
|
|
'validations': {
|
|
},
|
|
'allowed_values': {
|
|
},
|
|
'openapi_types': {
|
|
'id':
|
|
(str,),
|
|
'access_key_id':
|
|
(str,),
|
|
'alias':
|
|
(str,),
|
|
},
|
|
'attribute_map': {
|
|
'id': 'id',
|
|
'access_key_id': 'accessKeyId',
|
|
'alias': 'alias',
|
|
},
|
|
'location_map': {
|
|
'id': 'query',
|
|
'access_key_id': 'query',
|
|
'alias': 'query',
|
|
},
|
|
'collection_format_map': {
|
|
}
|
|
},
|
|
headers_map={
|
|
'accept': [
|
|
'application/json'
|
|
],
|
|
'content_type': [],
|
|
},
|
|
api_client=api_client
|
|
)
|
|
self.update_bucket_endpoint = _Endpoint(
|
|
settings={
|
|
'response_type': (BucketInfo,),
|
|
'auth': [
|
|
'bearerAuth'
|
|
],
|
|
'endpoint_path': '/bucket?id={bucket_id}',
|
|
'operation_id': 'update_bucket',
|
|
'http_method': 'PUT',
|
|
'servers': None,
|
|
},
|
|
params_map={
|
|
'all': [
|
|
'bucket_id',
|
|
'update_bucket_request',
|
|
],
|
|
'required': [
|
|
'bucket_id',
|
|
'update_bucket_request',
|
|
],
|
|
'nullable': [
|
|
],
|
|
'enum': [
|
|
],
|
|
'validation': [
|
|
]
|
|
},
|
|
root_map={
|
|
'validations': {
|
|
},
|
|
'allowed_values': {
|
|
},
|
|
'openapi_types': {
|
|
'bucket_id':
|
|
(str,),
|
|
'update_bucket_request':
|
|
(UpdateBucketRequest,),
|
|
},
|
|
'attribute_map': {
|
|
'bucket_id': 'bucket_id',
|
|
},
|
|
'location_map': {
|
|
'bucket_id': 'path',
|
|
'update_bucket_request': 'body',
|
|
},
|
|
'collection_format_map': {
|
|
}
|
|
},
|
|
headers_map={
|
|
'accept': [
|
|
'application/json'
|
|
],
|
|
'content_type': [
|
|
'application/json'
|
|
]
|
|
},
|
|
api_client=api_client
|
|
)
|
|
|
|
def allow_bucket_key(
|
|
self,
|
|
allow_bucket_key_request,
|
|
**kwargs
|
|
):
|
|
"""Allow key # noqa: E501
|
|
|
|
⚠️ **DISCLAIMER**: Garage's developers are aware that this endpoint has an unconventional semantic. Be extra careful when implementing it, its behavior is not obvious. Allows a key to do read/write/owner operations on a bucket. Flags in permissions which have the value true will be activated. Other flags will remain unchanged (ie. they will keep their internal value). For example, if you set read to true, the key will be allowed to read the bucket. If you set it to false, the key will keeps its previous read permission. If you want to disallow read for the key, check the DenyBucketKey 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.allow_bucket_key(allow_bucket_key_request, async_req=True)
|
|
>>> result = thread.get()
|
|
|
|
Args:
|
|
allow_bucket_key_request (AllowBucketKeyRequest): Aliases to put on the new bucket
|
|
|
|
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:
|
|
BucketInfo
|
|
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['allow_bucket_key_request'] = \
|
|
allow_bucket_key_request
|
|
return self.allow_bucket_key_endpoint.call_with_http_info(**kwargs)
|
|
|
|
def create_bucket(
|
|
self,
|
|
create_bucket_request,
|
|
**kwargs
|
|
):
|
|
"""Create a bucket # noqa: E501
|
|
|
|
Creates a new bucket, either with a global alias, a local one, or no alias at all. Technically, you can also specify both `globalAlias` and `localAlias` and that would create two aliases. # 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_bucket(create_bucket_request, async_req=True)
|
|
>>> result = thread.get()
|
|
|
|
Args:
|
|
create_bucket_request (CreateBucketRequest): Aliases to put on the new bucket
|
|
|
|
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:
|
|
BucketInfo
|
|
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['create_bucket_request'] = \
|
|
create_bucket_request
|
|
return self.create_bucket_endpoint.call_with_http_info(**kwargs)
|
|
|
|
def delete_bucket(
|
|
self,
|
|
bucket_id,
|
|
**kwargs
|
|
):
|
|
"""Delete a bucket # noqa: E501
|
|
|
|
Delete a bucket.Deletes a storage bucket. A bucket cannot be deleted if it is not empty. **Warning:** this will delete all aliases associated with the bucket! # 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_bucket(bucket_id, async_req=True)
|
|
>>> result = thread.get()
|
|
|
|
Args:
|
|
bucket_id (str): The exact bucket identifier, a 32 bytes hexadecimal string
|
|
|
|
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
|
|
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['bucket_id'] = \
|
|
bucket_id
|
|
return self.delete_bucket_endpoint.call_with_http_info(**kwargs)
|
|
|
|
def delete_bucket_global_alias(
|
|
self,
|
|
id,
|
|
alias,
|
|
**kwargs
|
|
):
|
|
"""Delete a global alias # noqa: E501
|
|
|
|
Delete a global alias from the target bucket # 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_bucket_global_alias(id, alias, async_req=True)
|
|
>>> result = thread.get()
|
|
|
|
Args:
|
|
id (str):
|
|
alias (str):
|
|
|
|
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:
|
|
BucketInfo
|
|
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['id'] = \
|
|
id
|
|
kwargs['alias'] = \
|
|
alias
|
|
return self.delete_bucket_global_alias_endpoint.call_with_http_info(**kwargs)
|
|
|
|
def delete_bucket_local_alias(
|
|
self,
|
|
id,
|
|
access_key_id,
|
|
alias,
|
|
**kwargs
|
|
):
|
|
"""Delete a local alias # noqa: E501
|
|
|
|
Delete a local alias, bound to specified account, from the target bucket # 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_bucket_local_alias(id, access_key_id, alias, async_req=True)
|
|
>>> result = thread.get()
|
|
|
|
Args:
|
|
id (str):
|
|
access_key_id (str):
|
|
alias (str):
|
|
|
|
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:
|
|
BucketInfo
|
|
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['id'] = \
|
|
id
|
|
kwargs['access_key_id'] = \
|
|
access_key_id
|
|
kwargs['alias'] = \
|
|
alias
|
|
return self.delete_bucket_local_alias_endpoint.call_with_http_info(**kwargs)
|
|
|
|
def deny_bucket_key(
|
|
self,
|
|
allow_bucket_key_request,
|
|
**kwargs
|
|
):
|
|
"""Deny key # noqa: E501
|
|
|
|
⚠️ **DISCLAIMER**: Garage's developers are aware that this endpoint has an unconventional semantic. Be extra careful when implementing it, its behavior is not obvious. Denies a key from doing read/write/owner operations on a bucket. Flags in permissions which have the value true will be deactivated. Other flags will remain unchanged. For example, if you set read to true, the key will be denied from reading. If you set read to false, the key will keep its previous permissions. If you want the key to have the reading permission, check the AllowBucketKey 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.deny_bucket_key(allow_bucket_key_request, async_req=True)
|
|
>>> result = thread.get()
|
|
|
|
Args:
|
|
allow_bucket_key_request (AllowBucketKeyRequest): Aliases to put on the new bucket
|
|
|
|
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:
|
|
BucketInfo
|
|
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['allow_bucket_key_request'] = \
|
|
allow_bucket_key_request
|
|
return self.deny_bucket_key_endpoint.call_with_http_info(**kwargs)
|
|
|
|
def find_bucket_info(
|
|
self,
|
|
alias,
|
|
**kwargs
|
|
):
|
|
"""Find a bucket # noqa: E501
|
|
|
|
Find a bucket by its global alias # 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_bucket_info(alias, async_req=True)
|
|
>>> result = thread.get()
|
|
|
|
Args:
|
|
alias (str): The exact global alias of one of the existing buckets
|
|
|
|
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:
|
|
BucketInfo
|
|
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['alias'] = \
|
|
alias
|
|
return self.find_bucket_info_endpoint.call_with_http_info(**kwargs)
|
|
|
|
def get_bucket_info(
|
|
self,
|
|
bucket_id,
|
|
**kwargs
|
|
):
|
|
"""Get a bucket # noqa: E501
|
|
|
|
Given a bucket identifier, get its information. It includes its aliases, its web configuration, keys that have some permissions on it, some statistics (number of objects, size), number of dangling multipart uploads, and its quotas (if any). # 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_bucket_info(bucket_id, async_req=True)
|
|
>>> result = thread.get()
|
|
|
|
Args:
|
|
bucket_id (str): The exact bucket identifier, a 32 bytes hexadecimal string
|
|
|
|
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:
|
|
BucketInfo
|
|
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['bucket_id'] = \
|
|
bucket_id
|
|
return self.get_bucket_info_endpoint.call_with_http_info(**kwargs)
|
|
|
|
def list_buckets(
|
|
self,
|
|
**kwargs
|
|
):
|
|
"""List all buckets # noqa: E501
|
|
|
|
List all the buckets on the cluster with their UUID and their global and local aliases. # noqa: E501
|
|
This method makes a synchronous HTTP request by default. To make an
|
|
asynchronous HTTP request, please pass async_req=True
|
|
|
|
>>> thread = api.list_buckets(async_req=True)
|
|
>>> 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:
|
|
[ListBuckets200ResponseInner]
|
|
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_buckets_endpoint.call_with_http_info(**kwargs)
|
|
|
|
def put_bucket_global_alias(
|
|
self,
|
|
id,
|
|
alias,
|
|
**kwargs
|
|
):
|
|
"""Add a global alias # noqa: E501
|
|
|
|
Add a global alias to the target bucket # noqa: E501
|
|
This method makes a synchronous HTTP request by default. To make an
|
|
asynchronous HTTP request, please pass async_req=True
|
|
|
|
>>> thread = api.put_bucket_global_alias(id, alias, async_req=True)
|
|
>>> result = thread.get()
|
|
|
|
Args:
|
|
id (str):
|
|
alias (str):
|
|
|
|
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:
|
|
BucketInfo
|
|
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['id'] = \
|
|
id
|
|
kwargs['alias'] = \
|
|
alias
|
|
return self.put_bucket_global_alias_endpoint.call_with_http_info(**kwargs)
|
|
|
|
def put_bucket_local_alias(
|
|
self,
|
|
id,
|
|
access_key_id,
|
|
alias,
|
|
**kwargs
|
|
):
|
|
"""Add a local alias # noqa: E501
|
|
|
|
Add a local alias, bound to specified account, to the target bucket # noqa: E501
|
|
This method makes a synchronous HTTP request by default. To make an
|
|
asynchronous HTTP request, please pass async_req=True
|
|
|
|
>>> thread = api.put_bucket_local_alias(id, access_key_id, alias, async_req=True)
|
|
>>> result = thread.get()
|
|
|
|
Args:
|
|
id (str):
|
|
access_key_id (str):
|
|
alias (str):
|
|
|
|
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:
|
|
BucketInfo
|
|
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['id'] = \
|
|
id
|
|
kwargs['access_key_id'] = \
|
|
access_key_id
|
|
kwargs['alias'] = \
|
|
alias
|
|
return self.put_bucket_local_alias_endpoint.call_with_http_info(**kwargs)
|
|
|
|
def update_bucket(
|
|
self,
|
|
bucket_id,
|
|
update_bucket_request,
|
|
**kwargs
|
|
):
|
|
"""Update a bucket # noqa: E501
|
|
|
|
All fields (`websiteAccess` and `quotas`) are optionnal. If they are present, the corresponding modifications are applied to the bucket, otherwise nothing is changed. In `websiteAccess`: if `enabled` is `true`, `indexDocument` must be specified. The field `errorDocument` is optional, if no error document is set a generic error message is displayed when errors happen. Conversely, if `enabled` is `false`, neither `indexDocument` nor `errorDocument` must be specified. In `quotas`: new values of `maxSize` and `maxObjects` must both be specified, or set to `null` to remove the quotas. An absent value will be considered the same as a `null`. It is not possible to change only one of the two quotas. # 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_bucket(bucket_id, update_bucket_request, async_req=True)
|
|
>>> result = thread.get()
|
|
|
|
Args:
|
|
bucket_id (str): The exact bucket identifier, a 32 bytes hexadecimal string
|
|
update_bucket_request (UpdateBucketRequest): Requested changes on the bucket. Both root fields are optionals.
|
|
|
|
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:
|
|
BucketInfo
|
|
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['bucket_id'] = \
|
|
bucket_id
|
|
kwargs['update_bucket_request'] = \
|
|
update_bucket_request
|
|
return self.update_bucket_endpoint.call_with_http_info(**kwargs)
|
|
|