superwise_api.entities.integration

class IntegrationApi(superwise_api.entities.base.BaseApi):

This class provides methods to interact with the Integration API.

Attributes:

api_client (ApiClient): An instance of the ApiClient to make requests.
_model_name (str): The name of the model.
_resource_path (str): The path of the resource.
_model_class (Integration): The model class.

def get_by_id( self, integration_id: str, **kwargs) -> superwise_api.models.integration.integration.Integration:

Gets an integration by id.

Arguments:

integration_id (str): The id of the integration.
**kwargs: Arbitrary keyword arguments.

Returns:

Integration: The integration.

def delete( self, integration_id: str, delete_destinations: bool = False, **kwargs):

Deletes an integration.

Arguments:

integration_id (str): The id of the integration.
delete_destinations (bool): Whether to delete the destinations associated with the integration.
**kwargs: Arbitrary keyword arguments.

def get( self, name: Optional[str] = None, integration_type: Optional[superwise_api.models.integration.integration.IntegrationType] = None, created_by: Optional[str] = None, page: Optional[int] = None, size: Optional[int] = None) -> superwise_api.client.models.page.Page:

Gets all integrations.

Arguments:

name (str, optional): The name of the integration.
integration_type (IntegrationType, optional): The type of the integration.
created_by (str, optional): The user who created the integration.
page (int, optional): The page number.
size (int, optional): The size of the page.

Returns:

Page: A page of integrations.

Inherited Members

superwise_api.entities.base.BaseApi: BaseApi; api_client; wrap_api_calls; raise_exception