PowerShell 7.0 SDK for CloudEvents

Go to file

Dimitar Milov aac584afb8 Enable process exit in build.ps1 Signed-off-by: Dimitar Milov <dmilov@vmware.com>		2021-04-22 09:48:13 +03:00
src/CloudEventsPowerShell	Renames Add-CloudEventData to Set-CloudEventData (#12 )	2021-04-13 18:41:40 +03:00
test	Enable process exit in build.ps1	2021-04-22 09:48:13 +03:00
.gitignore	Initial commit	2021-04-07 09:40:42 -07:00
CONTRIBUTING.md	Create CONTRIBUTING.md (#15 )	2021-04-19 08:55:35 +03:00
LICENSE	Initial commit	2021-04-07 09:40:42 -07:00
README.md	Create CONTRIBUTING.md (#15 )	2021-04-19 08:55:35 +03:00
build.ps1	Enable process exit in build.ps1	2021-04-22 09:48:13 +03:00

README.md

PowerShell 7.0 SDK for CloudEvents based on .NET SDK for CloudEvents

Status

Supported CloudEvents versions:

v1.0

Supported Protocols:

HTTP

CloudEvents.Sdk Module

The module contains functions to

Create CloudEvent objects
Add data to a CloudEvent object
Read data from a CloudEvent object
Convert a CloudEvent object to an HTTP Message
Convert an HTTP Message to a CloudEvent object

Producer

Create a CloudEvent object

$cloudEvent = New-CloudEvent -Type 'com.example.object.deleted.v2' -Source 'mailto:cncf-wg-serverless@lists.cncf.io' -Id '6e8bc430-9c3a-11d9-9669-0800200c9a66' -Time (Get-Date)

Add JSON Data to a CloudEvent object

$cloudEvent | Add-CloudEventJsonData -Data @{
   'key1' = 'value1'
   'key2' = @{
      'key3' = 'value3'
   }
}

Add XML Data to a CloudEvent object

$cloudEvent | Add-CloudEventXmlData -Data @{
   'key1' = @{
      'key2' = 'value'
   }
} `
-AttributesKeysInElementAttributes $true

AttributesKeysInElementAttributes specifies how to format the XML. If true and the input Data hashtable has pairs of 'Attributes', 'Value' keys creates XML element with attributes, otherwise each key is formatted as XML element.
If true

   @{'root' = @{'Attributes' = @{'att1' = 'true'}; 'Value' = 'val-1'}}

is formatted as

<root att1="true">val-1</root>

If false

@{'root' = @{'Attributes' = @{'att1' = 'true'}; 'Value' = 'val-1'}}

is formatted as

<root><Attributes><att1>true</att1></Attributes><Value>val-1</Value></root>

Add Custom Format Data to a CloudEvent object

$cloudEvent | Add-CloudEventData -DataContentType 'application/text' -Data 'wow'

Convert a CloudEvent object to an HTTP message in Binary or Structured content mode

$cloudEventBinaryHttpMessage = $cloudEvent | ConvertTo-HttpMessage -ContentMode Binary
$cloudEventStructuredHttpMessage = $cloudEvent | ConvertTo-HttpMessage -ContentMode Structured

Send CloudEvent object to HTTP server

Invoke-WebRequest -Method POST -Uri 'http://my.cloudevents.server/' -Headers $cloudEventBinaryHttpMessage.Headers -Body $cloudEventBinaryHttpMessage.Body

Consumer

Convert an HTTP message to a CloudEvent object

$cloudEvent = ConvertFrom-HttpMessage -Headers <headers> -Body <body>

Read CloudEvent JSON Data as a PowerShell Hashtable

$hashtableData = Read-CloudEventJsonData -CloudEvent $cloudEvent

Read CloudEvent XML Data as a PowerShell Hashtable

$hashtableData = Read-CloudEventXmlData -CloudEvent $cloudEvent -ConvertMode SkipAttributes

The ConvertMode parameter specifies how the XML to be represented in the result hashtable
SkipAttributes - Skips attributes of the XML elements. XmlElement is a Key-Value pair where Key is the Xml element name, and the value is the Xml element inner text
Example:

<key att='true'>value1</key>

is converted to

@{'key' = 'value-1'}

AlwaysAttrValue - Each element is a HashTable with two keys
'Attributes' - key-value pair of the Xml element attributes if any, otherwise null
'Value' - string value represinting the xml element inner text
Example:

value1value2 is converted to

@{
   'key1' = @{
      'Attributes' = @{
         'att' = 'true'
      }
      'Value' = 'value1'
   }
   'key2' = @{
      'Attributes' = $null
      'Value' = 'value2'
   }
}

AttrValueWhenAttributes - Uses SkipAttributes for xml elements without attributes and AlwaysAttrValue for xml elements with attributes
Example:

<key1 att='true'>value1</key1><key2>value2</key2>

is converted to

@{
   'key1' = @{
      'Attributes' = @{
         'att' = 'true'
      }
      'Value' = 'value1'
   }
   'key2' = 'value2'
}

Read CloudEvent Custom Format Data as a byte[]

$bytes = Read-CloudEventData -CloudEvent $cloudEvent