halo_client.GroupV1alpha1Api

All URIs are relative to http://localhost:8091

Method	HTTP request	Description
create_group	POST /apis/storage.halo.run/v1alpha1/groups
delete_group	DELETE /apis/storage.halo.run/v1alpha1/groups/{name}
get_group	GET /apis/storage.halo.run/v1alpha1/groups/{name}
list_group	GET /apis/storage.halo.run/v1alpha1/groups
patch_group	PATCH /apis/storage.halo.run/v1alpha1/groups/{name}
update_group	PUT /apis/storage.halo.run/v1alpha1/groups/{name}

create_group

Group create_group(group=group)

Create Group

Example

Basic Authentication (basicAuth):
Bearer (JWT) Authentication (bearerAuth):

import halo_client
from halo_client.models.group import Group
from halo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8091
# See configuration.py for a list of all supported configuration parameters.
configuration = halo_client.Configuration(
    host = "http://localhost:8091"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = halo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): bearerAuth
configuration = halo_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with halo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = halo_client.GroupV1alpha1Api(api_client)
    group = halo_client.Group() # Group | Fresh group (optional)

    try:
        api_response = api_instance.create_group(group=group)
        print("The response of GroupV1alpha1Api->create_group:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling GroupV1alpha1Api->create_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
group	Group	Fresh group	[optional]

Return type

Group

Authorization

basicAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: /

HTTP response details

Status code	Description	Response headers
200	Response groups created just now	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_group

delete_group(name)

Delete Group

Example

Basic Authentication (basicAuth):
Bearer (JWT) Authentication (bearerAuth):

import halo_client
from halo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8091
# See configuration.py for a list of all supported configuration parameters.
configuration = halo_client.Configuration(
    host = "http://localhost:8091"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = halo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): bearerAuth
configuration = halo_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with halo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = halo_client.GroupV1alpha1Api(api_client)
    name = 'name_example' # str | Name of group

    try:
        api_instance.delete_group(name)
    except Exception as e:
        print("Exception when calling GroupV1alpha1Api->delete_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str	Name of group

Return type

void (empty response body)

Authorization

basicAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Response group deleted just now	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_group

Group get_group(name)

Get Group

Example

Basic Authentication (basicAuth):
Bearer (JWT) Authentication (bearerAuth):

import halo_client
from halo_client.models.group import Group
from halo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8091
# See configuration.py for a list of all supported configuration parameters.
configuration = halo_client.Configuration(
    host = "http://localhost:8091"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = halo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): bearerAuth
configuration = halo_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with halo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = halo_client.GroupV1alpha1Api(api_client)
    name = 'name_example' # str | Name of group

    try:
        api_response = api_instance.get_group(name)
        print("The response of GroupV1alpha1Api->get_group:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling GroupV1alpha1Api->get_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str	Name of group

Return type

Group

Authorization

basicAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: /

HTTP response details

Status code	Description	Response headers
200	Response single group	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_group

GroupList list_group(page=page, size=size, label_selector=label_selector, field_selector=field_selector, sort=sort)

List Group

Example

Basic Authentication (basicAuth):
Bearer (JWT) Authentication (bearerAuth):

import halo_client
from halo_client.models.group_list import GroupList
from halo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8091
# See configuration.py for a list of all supported configuration parameters.
configuration = halo_client.Configuration(
    host = "http://localhost:8091"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = halo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): bearerAuth
configuration = halo_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with halo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = halo_client.GroupV1alpha1Api(api_client)
    page = 56 # int | Page number. Default is 0. (optional)
    size = 56 # int | Size number. Default is 0. (optional)
    label_selector = ['label_selector_example'] # List[str] | Label selector. e.g.: hidden!=true (optional)
    field_selector = ['field_selector_example'] # List[str] | Field selector. e.g.: metadata.name==halo (optional)
    sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional)

    try:
        api_response = api_instance.list_group(page=page, size=size, label_selector=label_selector, field_selector=field_selector, sort=sort)
        print("The response of GroupV1alpha1Api->list_group:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling GroupV1alpha1Api->list_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
page	int	Page number. Default is 0.	[optional]
size	int	Size number. Default is 0.	[optional]
label_selector	List[str]	Label selector. e.g.: hidden!=true	[optional]
field_selector	List[str]	Field selector. e.g.: metadata.name==halo	[optional]
sort	List[str]	Sorting criteria in the format: property,(asc	desc). Default sort order is ascending. Multiple sort criteria are supported.

Return type

GroupList

Authorization

basicAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: /

HTTP response details

Status code	Description	Response headers
200	Response groups	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patch_group

Group patch_group(name, json_patch_inner=json_patch_inner)

Patch Group

Example

Basic Authentication (basicAuth):
Bearer (JWT) Authentication (bearerAuth):

import halo_client
from halo_client.models.group import Group
from halo_client.models.json_patch_inner import JsonPatchInner
from halo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8091
# See configuration.py for a list of all supported configuration parameters.
configuration = halo_client.Configuration(
    host = "http://localhost:8091"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = halo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): bearerAuth
configuration = halo_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with halo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = halo_client.GroupV1alpha1Api(api_client)
    name = 'name_example' # str | Name of group
    json_patch_inner = [halo_client.JsonPatchInner()] # List[JsonPatchInner] |  (optional)

    try:
        api_response = api_instance.patch_group(name, json_patch_inner=json_patch_inner)
        print("The response of GroupV1alpha1Api->patch_group:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling GroupV1alpha1Api->patch_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str	Name of group
json_patch_inner	List[JsonPatchInner]		[optional]

Return type

Group

Authorization

basicAuth, bearerAuth

HTTP request headers

Content-Type: application/json-patch+json
Accept: /

HTTP response details

Status code	Description	Response headers
200	Response group patched just now	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_group

Group update_group(name, group=group)

Update Group

Example

Basic Authentication (basicAuth):
Bearer (JWT) Authentication (bearerAuth):

import halo_client
from halo_client.models.group import Group
from halo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8091
# See configuration.py for a list of all supported configuration parameters.
configuration = halo_client.Configuration(
    host = "http://localhost:8091"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = halo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): bearerAuth
configuration = halo_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with halo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = halo_client.GroupV1alpha1Api(api_client)
    name = 'name_example' # str | Name of group
    group = halo_client.Group() # Group | Updated group (optional)

    try:
        api_response = api_instance.update_group(name, group=group)
        print("The response of GroupV1alpha1Api->update_group:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling GroupV1alpha1Api->update_group: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str	Name of group
group	Group	Updated group	[optional]

Return type

Group

Authorization

basicAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: /

HTTP response details

Status code	Description	Response headers
200	Response groups updated just now	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

GroupV1alpha1Api.md

Latest commit

History

GroupV1alpha1Api.md

File metadata and controls

halo_client.GroupV1alpha1Api

create_group

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_group

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_group

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_group

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

patch_group

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_group

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details