# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
"""DolphinScheduler Tenant object."""
from typing import Optional
from pydolphinscheduler import configuration
from pydolphinscheduler.java_gateway import gateway
from pydolphinscheduler.models import BaseSide
[docs]
class Tenant(BaseSide):
"""DolphinScheduler Tenant object."""
def __init__(
self,
name: str = configuration.USER_TENANT,
queue: str = configuration.WORKFLOW_QUEUE,
description: Optional[str] = None,
tenant_id: Optional[int] = None,
code: Optional[str] = None,
user_name: Optional[str] = None,
):
super().__init__(name, description)
self.tenant_id = tenant_id
self.queue = queue
self.code = code
self.user_name = user_name
[docs]
def create_if_not_exists(
self, queue_name: str, user=configuration.USER_NAME
) -> None:
"""Create Tenant if not exists."""
tenant = gateway.create_tenant(self.name, queue_name, self.description)
self.tenant_id = tenant.getId()
self.code = tenant.getTenantCode()
# gateway_result_checker(result, None)
[docs]
@classmethod
def get_tenant(cls, code: str) -> "Tenant":
"""Get Tenant list."""
tenant = gateway.query_tenant(code)
if tenant is None:
return cls()
return cls(
description=tenant.getDescription(),
tenant_id=tenant.getId(),
code=tenant.getTenantCode(),
queue=tenant.getQueueId(),
)
[docs]
def update(
self, user=configuration.USER_NAME, code=None, queue_id=None, description=None
) -> None:
"""Update Tenant."""
gateway.update_tenant(user, self.tenant_id, code, queue_id, description)
# TODO: check queue_id and queue_name
self.queue = str(queue_id)
self.code = code
self.description = description
[docs]
def delete(self) -> None:
"""Delete Tenant."""
gateway.delete_tenant(self.user_name, self.tenant_id)
self.delete_all()