buildkite_sdk.command_step

  1from typing import Optional, List, Union, Dict, Any, TypedDict
  2from buildkite_sdk.types import (
  3    Cache,
  4    ConcurrencyMethod,
  5    DependsOn,
  6    MatrixAdvanced,
  7    NotifyEnum,
  8    Retry,
  9    Signature,
 10    SoftFail,
 11    StepNotify,
 12)
 13from buildkite_sdk.schema import CommandStep as _command_step
 14
 15
 16class CommandStepArgs(TypedDict, total=False):
 17    commands: Union[List[str], str]
 18    agents: Optional[Union[Dict[str, Any], List[str]]]
 19    allow_dependency_failure: Optional[bool]
 20    artifact_paths: Optional[Union[List[str], str]]
 21    branches: Optional[Union[List[str], str]]
 22    cache: Optional[Union[List[str], Cache, str]]
 23    cancel_on_build_failing: Optional[bool]
 24    concurrency: Optional[int]
 25    concurrency_group: Optional[str]
 26    concurrency_method: Optional[ConcurrencyMethod]
 27    depends_on: Optional[Union[List[Union[DependsOn, str]], str]]
 28    env: Optional[Dict[str, Any]]
 29    id: Optional[str]
 30    identifier: Optional[str]
 31    command_step_if: Optional[str]
 32    key: Optional[str]
 33    label: Optional[str]
 34    matrix: Optional[Union[List[Union[int, bool, str]], MatrixAdvanced]]
 35    name: Optional[str]
 36    notify: Optional[List[Union[StepNotify, NotifyEnum]]]
 37    parallelism: Optional[int]
 38    plugins: Optional[Union[List[Union[Dict[str, Any], str]], Dict[str, Any]]]
 39    priority: Optional[int]
 40    retry: Optional[Retry]
 41    signature: Optional[Signature]
 42    skip: Optional[Union[bool, str]]
 43    soft_fail: Optional[Union[bool, List[SoftFail]]]
 44    timeout_in_minutes: Optional[int]
 45
 46
 47def CommandStep(
 48    commands: Union[List[str], str],
 49    agents: Optional[Union[Dict[str, Any], List[str]]] = None,
 50    allow_dependency_failure: Optional[bool] = None,
 51    artifact_paths: Optional[Union[List[str], str]] = None,
 52    branches: Optional[Union[List[str], str]] = None,
 53    cache: Optional[Union[List[str], Cache, str]] = None,
 54    cancel_on_build_failing: Optional[bool] = None,
 55    concurrency: Optional[int] = None,
 56    concurrency_group: Optional[str] = None,
 57    concurrency_method: Optional[ConcurrencyMethod] = None,
 58    depends_on: Optional[Union[List[Union[DependsOn, str]], str]] = None,
 59    env: Optional[Dict[str, Any]] = None,
 60    id: Optional[str] = None,
 61    identifier: Optional[str] = None,
 62    command_step_if: Optional[str] = None,
 63    key: Optional[str] = None,
 64    label: Optional[str] = None,
 65    matrix: Optional[Union[List[Union[int, bool, str]], MatrixAdvanced]] = None,
 66    name: Optional[str] = None,
 67    notify: Optional[List[Union[StepNotify, NotifyEnum]]] = None,
 68    parallelism: Optional[int] = None,
 69    plugins: Optional[Union[List[Union[Dict[str, Any], str]], Dict[str, Any]]] = None,
 70    priority: Optional[int] = None,
 71    retry: Optional[Retry] = None,
 72    signature: Optional[Signature] = None,
 73    skip: Optional[Union[bool, str]] = None,
 74    soft_fail: Optional[Union[bool, List[SoftFail]]] = None,
 75    timeout_in_minutes: Optional[int] = None,
 76) -> _command_step:
 77    return _command_step(
 78        agents=agents,
 79        allow_dependency_failure=allow_dependency_failure,
 80        artifact_paths=artifact_paths,
 81        branches=branches,
 82        cache=cache,
 83        cancel_on_build_failing=cancel_on_build_failing,
 84        commands=commands,
 85        concurrency=concurrency,
 86        concurrency_group=concurrency_group,
 87        concurrency_method=concurrency_method,
 88        depends_on=depends_on,
 89        env=env,
 90        id=id,
 91        identifier=identifier,
 92        command_step_if=command_step_if,
 93        key=key,
 94        label=label,
 95        matrix=matrix,
 96        name=name,
 97        notify=notify,
 98        parallelism=parallelism,
 99        plugins=plugins,
100        priority=priority,
101        retry=retry,
102        signature=signature,
103        skip=skip,
104        soft_fail=soft_fail,
105        timeout_in_minutes=timeout_in_minutes,
106        type=None,
107        command=None,
108    )