Publish

This tasks publishes one or more messages to Google PubSub service.

Task version: 2.0.0

Required Frends version: 5.7+

Required .NET version: 8.0

Compatible Agents: Crossplatform

Task Parameters

Input

Name	Description
ProjectID : String	The project ID. Default: - Example: my-project-123456
TopicID : String	The topic ID. Default: - Example: my-topic
🗝ServiceAccountKeyJSON : String	The JSON service account key that one can generate in the Google Cloud portal. Default: - Example: { "type": "service_account", "project_id": "something", "private_key_id": "fdsafdsafdsalmnop12345678909876543212344", "private_key": "-----BEGIN PRIVATE KEY-----\nMIIE.......Hw==\n-----END PRIVATE KEY-----\n", "client_email": "[e-mail]", "client_id": "123456789012345678900", "auth_uri": "https://accounts.google.com/o/oauth2/auth", "token_uri": "https://oauth2.googleapis.com/token", "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs", "client_x509_cert_url": "https://www....nt.com" }
EnableMessageOrdering : Boolean	Whether to enable or disable message ordering using an ordering key. Default: False Example: true
Messages : Message[]	One or more messages to publish to the topic. Default: - Example: [ [ { "attr1", "value1" }, { "attr2", "value2" } ], "foo", "bar" ]

Options

Name	Description
ThrowErrorOnFailure : Boolean	Throw an exception on failure. Default: True Example: true
ErrorMessageOnFailure : String	Custom error message to use when throwing an exception. Default: - Example: Publishing failed

Task Result

Name	Description
Success : Boolean	Indicates whether the overall publish operation completed successfully. True when the batch operation completes and results are returned, even if some individual messages fail. False only when a failure prevents the overall operation from completing. Example: true
Error : Error	Error information when the overall operation fails (ThrowErrorOnFailure is false). Null when Success is true. Example: { "Message": "An error occurred.", "AdditionalInfo": {} }
Error.Message : String	Error message. Example: An error occurred.
Error.AdditionalInfo : Exception	Additional exception information. Example: System.Exception: An error occurred.
MessageIDs : List<String>	IDs of successfully sent messages. Example: { "12345", "54321" }
MessageErrors : List<MessagePublishingError>	Errors that occurred during sending of messages, if any. Example: { 'Message that was not sent', 'Error that happened during message sending' }, { { "Attrubutes" = [ { "Key": "attr1", "Value": "val1" }, { "Key": "attr2", "Value": "val2" } ] "Data" = "My message", "OrderingKey" = "Key1", }, "An error occurred while sending error to topic..." }

Task Changelog

Changelog is not available for this Task.