halo_client.PolicyV1alpha1Api

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

Method	HTTP request	Description
create_policy	POST /apis/storage.halo.run/v1alpha1/policies
delete_policy	DELETE /apis/storage.halo.run/v1alpha1/policies/{name}
get_policy	GET /apis/storage.halo.run/v1alpha1/policies/{name}
list_policy	GET /apis/storage.halo.run/v1alpha1/policies
patch_policy	PATCH /apis/storage.halo.run/v1alpha1/policies/{name}
update_policy	PUT /apis/storage.halo.run/v1alpha1/policies/{name}

create_policy

Policy create_policy(policy=policy)

Create Policy

Example

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

import halo_client
from halo_client.models.policy import Policy
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.PolicyV1alpha1Api(api_client)
    policy = halo_client.Policy() # Policy | Fresh policy (optional)

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

Parameters

Name	Type	Description	Notes
policy	Policy	Fresh policy	[optional]

Return type

Policy

Authorization

basicAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: /

HTTP response details

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

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

delete_policy

delete_policy(name)

Delete Policy

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.PolicyV1alpha1Api(api_client)
    name = 'name_example' # str | Name of policy

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

Parameters

Name	Type	Description	Notes
name	str	Name of policy

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 policy deleted just now	-

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

get_policy

Policy get_policy(name)

Get Policy

Example

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

import halo_client
from halo_client.models.policy import Policy
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.PolicyV1alpha1Api(api_client)
    name = 'name_example' # str | Name of policy

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

Parameters

Name	Type	Description	Notes
name	str	Name of policy

Return type

Policy

Authorization

basicAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: /

HTTP response details

Status code	Description	Response headers
200	Response single policy	-

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

list_policy

PolicyList list_policy(page=page, size=size, label_selector=label_selector, field_selector=field_selector, sort=sort)

List Policy

Example

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

import halo_client
from halo_client.models.policy_list import PolicyList
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.PolicyV1alpha1Api(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_policy(page=page, size=size, label_selector=label_selector, field_selector=field_selector, sort=sort)
        print("The response of PolicyV1alpha1Api->list_policy:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PolicyV1alpha1Api->list_policy: %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

PolicyList

Authorization

basicAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: /

HTTP response details

Status code	Description	Response headers
200	Response policies	-

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

patch_policy

Policy patch_policy(name, json_patch_inner=json_patch_inner)

Patch Policy

Example

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

import halo_client
from halo_client.models.json_patch_inner import JsonPatchInner
from halo_client.models.policy import Policy
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.PolicyV1alpha1Api(api_client)
    name = 'name_example' # str | Name of policy
    json_patch_inner = [halo_client.JsonPatchInner()] # List[JsonPatchInner] |  (optional)

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

Parameters

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

Return type

Policy

Authorization

basicAuth, bearerAuth

HTTP request headers

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

HTTP response details

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

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

update_policy

Policy update_policy(name, policy=policy)

Update Policy

Example

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

import halo_client
from halo_client.models.policy import Policy
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.PolicyV1alpha1Api(api_client)
    name = 'name_example' # str | Name of policy
    policy = halo_client.Policy() # Policy | Updated policy (optional)

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

Parameters

Name	Type	Description	Notes
name	str	Name of policy
policy	Policy	Updated policy	[optional]

Return type

Policy

Authorization

basicAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: /

HTTP response details

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

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

FilesExpand file tree

PolicyV1alpha1Api.md

Latest commit

History

PolicyV1alpha1Api.md

File metadata and controls

halo_client.PolicyV1alpha1Api

create_policy

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_policy

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_policy

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_policy

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

patch_policy

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_policy

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details