Source code for pydolphinscheduler.side.queue

# 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 User object."""

from typing import Optional

from pydolphinscheduler.constants import ProcessDefinitionDefault
from pydolphinscheduler.core.base_side import BaseSide
from pydolphinscheduler.java_gateway import gateway_result_checker, launch_gateway


[docs] class Queue(BaseSide): """DolphinScheduler Queue object.""" def __init__( self, name: str = ProcessDefinitionDefault.QUEUE, description: Optional[str] = "", ): super().__init__(name, description)
[docs] def create_if_not_exists(self, user=ProcessDefinitionDefault.USER) -> None: """Create Queue if not exists.""" gateway = launch_gateway() # Here we set Queue.name and Queue.queueName same as self.name result = gateway.entry_point.createProject(user, self.name, self.name) gateway_result_checker(result, None)