flightctl.ResourcesyncApi

All URIs are relative to http://localhost

Method	HTTP request	Description
create_resource_sync	POST /api/v1/resourcesyncs
delete_resource_sync	DELETE /api/v1/resourcesyncs/{name}
delete_resource_syncs	DELETE /api/v1/resourcesyncs
list_resource_sync	GET /api/v1/resourcesyncs
patch_resource_sync	PATCH /api/v1/resourcesyncs/{name}
read_resource_sync	GET /api/v1/resourcesyncs/{name}
replace_resource_sync	PUT /api/v1/resourcesyncs/{name}

create_resource_sync

ResourceSync create_resource_sync(resource_sync)

create a resourcesync

Example

import flightctl
from flightctl.models.resource_sync import ResourceSync
from flightctl.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with flightctl.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = flightctl.ResourcesyncApi(api_client)
    resource_sync = flightctl.ResourceSync() # ResourceSync | 

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

Parameters

Name	Type	Description	Notes
resource_sync	ResourceSync

Return type

ResourceSync

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Created	-
400	Bad Request	-
401	Unauthorized	-
409	StatusConflict	-

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

delete_resource_sync

ResourceSync delete_resource_sync(name)

delete a resourcesync

Example

import flightctl
from flightctl.models.resource_sync import ResourceSync
from flightctl.rest import ApiException
from pprint import pprint

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


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

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

Parameters

Name	Type	Description	Notes
name	str	name of the resourcesync

Return type

ResourceSync

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
404	NotFound	-

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

delete_resource_syncs

Status delete_resource_syncs()

delete a collection of ResourceSync

Example

import flightctl
from flightctl.models.status import Status
from flightctl.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with flightctl.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = flightctl.ResourcesyncApi(api_client)

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

Parameters

This endpoint does not need any parameter.

Return type

Status

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-

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

list_resource_sync

ResourceSyncList list_resource_sync(var_continue=var_continue, label_selector=label_selector, field_selector=field_selector, limit=limit, repository=repository, sort_by=sort_by, sort_order=sort_order)

list resourcesync

Example

import flightctl
from flightctl.models.resource_sync_list import ResourceSyncList
from flightctl.models.sort_order import SortOrder
from flightctl.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with flightctl.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = flightctl.ResourcesyncApi(api_client)
    var_continue = 'var_continue_example' # str | An optional parameter to query more results from the server. The value of the paramter must match the value of the 'continue' field in the previous list response. (optional)
    label_selector = 'label_selector_example' # str | A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
    field_selector = 'field_selector_example' # str | A selector to restrict the list of returned objects by their fields, supporting operators like '=', '==', and '!=' (e.g., \"key1=value1,key2!=value2\"). For a full list of operators and examples, refer to the documentation. (optional)
    limit = 56 # int | The maximum number of results returned in the list response. The server will set the 'continue' field in the list response if more results exist. The continue value may then be specified as parameter in a subsequent query. (optional)
    repository = 'repository_example' # str | The name of the repository to filter results by. (optional)
    sort_by = 'metadata.name' # str | Specifies the field to sort by. (optional)
    sort_order = Asc # SortOrder | Specifies the sort order. (optional) (default to Asc)

    try:
        api_response = api_instance.list_resource_sync(var_continue=var_continue, label_selector=label_selector, field_selector=field_selector, limit=limit, repository=repository, sort_by=sort_by, sort_order=sort_order)
        print("The response of ResourcesyncApi->list_resource_sync:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ResourcesyncApi->list_resource_sync: %s\n" % e)

Parameters

Name	Type	Description	Notes
var_continue	str	An optional parameter to query more results from the server. The value of the paramter must match the value of the 'continue' field in the previous list response.	[optional]
label_selector	str	A selector to restrict the list of returned objects by their labels. Defaults to everything.	[optional]
field_selector	str	A selector to restrict the list of returned objects by their fields, supporting operators like '=', '==', and '!=' (e.g., "key1=value1,key2!=value2"). For a full list of operators and examples, refer to the documentation.	[optional]
limit	int	The maximum number of results returned in the list response. The server will set the 'continue' field in the list response if more results exist. The continue value may then be specified as parameter in a subsequent query.	[optional]
repository	str	The name of the repository to filter results by.	[optional]
sort_by	str	Specifies the field to sort by.	[optional]
sort_order	SortOrder	Specifies the sort order.	[optional] [default to Asc]

Return type

ResourceSyncList

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-

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

patch_resource_sync

ResourceSync patch_resource_sync(name, patch_request_inner=patch_request_inner)

Patches the specified resourcesync

Example

import flightctl
from flightctl.models.patch_request_inner import PatchRequestInner
from flightctl.models.resource_sync import ResourceSync
from flightctl.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with flightctl.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = flightctl.ResourcesyncApi(api_client)
    name = 'name_example' # str | name of the resourcesync
    patch_request_inner = [flightctl.PatchRequestInner()] # List[PatchRequestInner] |  (optional)

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

Parameters

Name	Type	Description	Notes
name	str	name of the resourcesync
patch_request_inner	List[PatchRequestInner]		[optional]

Return type

ResourceSync

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
404	NotFound	-
409	Conflict	-

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

read_resource_sync

ResourceSync read_resource_sync(name)

read the specified resourcesync

Example

import flightctl
from flightctl.models.resource_sync import ResourceSync
from flightctl.rest import ApiException
from pprint import pprint

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


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

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

Parameters

Name	Type	Description	Notes
name	str	name of the resourcesync

Return type

ResourceSync

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
404	NotFound	-

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

replace_resource_sync

ResourceSync replace_resource_sync(name, resource_sync)

replace the specified resourcesync

Example

import flightctl
from flightctl.models.resource_sync import ResourceSync
from flightctl.rest import ApiException
from pprint import pprint

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


# Enter a context with an instance of the API client
with flightctl.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = flightctl.ResourcesyncApi(api_client)
    name = 'name_example' # str | name of the resourcesync
    resource_sync = flightctl.ResourceSync() # ResourceSync | 

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

Parameters

Name	Type	Description	Notes
name	str	name of the resourcesync
resource_sync	ResourceSync

Return type

ResourceSync

Authorization

No authorization required

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
201	Created	-
400	Bad Request	-
401	Unauthorized	-
404	NotFound	-
409	Conflict	-

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

Files

ResourcesyncApi.md

Latest commit

History

ResourcesyncApi.md

File metadata and controls

flightctl.ResourcesyncApi

create_resource_sync

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_resource_sync

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_resource_syncs

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_resource_sync

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

patch_resource_sync

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

read_resource_sync

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

replace_resource_sync

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details