github.com/ouraigua/jenkins-library@v0.0.0-20231028010029-fbeaf2f3aa9b/resources/metadata/ansSendEvent.yaml (about)

     1  metadata:
     2    name: ansSendEvent
     3    description: Send Event to the SAP Alert Notification Service
     4    longDescription: |
     5      With this step one can send an Event to the SAP Alert Notification Service.
     6  
     7  spec:
     8    inputs:
     9      secrets:
    10        - name: ansServiceKeyCredentialsId
    11          description: Jenkins secret text credential ID containing the service key to access the SAP Alert Notification Service
    12          type: jenkins
    13      params:
    14        - name: ansServiceKey
    15          type: string
    16          description: Service key JSON string to access the SAP Alert Notification Service
    17          scope:
    18            - PARAMETERS
    19          mandatory: true
    20          secret: true
    21          resourceRef:
    22            - name: ansServiceKeyCredentialsId
    23              type: secret
    24              param: ansServiceKey
    25        - name: eventType
    26          type: string
    27          description: Type of the event
    28          default: "Piper"
    29          scope:
    30            - PARAMETERS
    31            - STAGES
    32            - STEPS
    33        - name: severity
    34          type: string
    35          description: Event severity
    36          default: "INFO"
    37          scope:
    38            - PARAMETERS
    39            - STAGES
    40            - STEPS
    41          possibleValues:
    42            - INFO
    43            - NOTICE
    44            - WARNING
    45            - ERROR
    46            - FATAL
    47        - name: category
    48          type: string
    49          description: Event category
    50          default: "NOTIFICATION"
    51          scope:
    52            - PARAMETERS
    53            - STAGES
    54            - STEPS
    55          possibleValues:
    56            - NOTIFICATION
    57            - ALERT
    58            - EXCEPTION
    59        - name: subject
    60          type: string
    61          description: Short description of the event
    62          default: "ansSendEvent"
    63          scope:
    64            - PARAMETERS
    65            - STAGES
    66            - STEPS
    67        - name: body
    68          type: string
    69          description: Detailed description of the event
    70          default: "Call from Piper step ansSendEvent"
    71          scope:
    72            - PARAMETERS
    73            - STAGES
    74            - STEPS
    75        - name: priority
    76          type: int
    77          description: Event priority in the range of 1 to 1000
    78          scope:
    79            - PARAMETERS
    80            - STAGES
    81            - STEPS
    82        - name: tags
    83          type: "map[string]interface{}"
    84          description: Optional key-value pairs describing the event in details
    85          scope:
    86            - PARAMETERS
    87            - STAGES
    88            - STEPS
    89        - name: resourceName
    90          type: string
    91          description: Unique resource name
    92          default: "Pipeline"
    93          scope:
    94            - PARAMETERS
    95            - STAGES
    96            - STEPS
    97        - name: resourceType
    98          type: string
    99          description: Resource type identifier
   100          default: "Pipeline"
   101          scope:
   102            - PARAMETERS
   103            - STAGES
   104            - STEPS
   105        - name: resourceInstance
   106          type: string
   107          description: Optional resource instance identifier
   108          scope:
   109            - PARAMETERS
   110            - STAGES
   111            - STEPS
   112        - name: resourceTags
   113          type: "map[string]interface{}"
   114          description: Optional key-value pairs describing the resource in details
   115          scope:
   116            - PARAMETERS
   117            - STAGES
   118            - STEPS