Delete Message

Operation Name

Delete Message

Function Overview

Delete messages in Azure Queue Storage.

Data Model

XML type.
For more details on input/output schema, refer to “Schema”.

Properties

For details on use of variables, refer to "Variables".
Basic settings
Item name Required/Optional Use of variables Description Remarks
Name Required Not available Enter the name to show on the script canvas.  
Input data Required Not available Select a component on the script canvas.  
Required settings
Item name Required/Optional Use of variables Description Remarks
Destination Required Not available Select a global resource.
  • [Add]:
    Add a new global resource.
  • [Edit list]:
    Global resource settings can be edited in “Edit resource list” screen.
  
Queue name Required Available Specify a queue to delete messages of.
  • Enter directly or select from the list.
  
Property actions
Item name Description Remarks
Get queue names Get queue names from Azure Queue Storage.
  • Disabled when [Destination] is not specified.
Comment
Item name Required/Optional Use of variables Description Remarks
Comment Optional Not available You can write a short description of this adapter.
The description will be reflected in the specifications.		  

Schema

Input schema

<?xml version="1.0"?>
<queue>
  <message id="" pop_receipt="" >
  </message>
</queue>
Element name Attribute name Description Remarks
queue -    
message - Appears for each message which is subject to delete. One DeleteMessage request is sent per element.
id Specify the identifier (Message Id) got when receiving a message from Azure Queue Storage.  
pop_receipt Specify the POPReceipt value got when receiving a message from Azure Queue Storage.  
The output schema of Receive Message operation can be specified as the input schema of this operation.

Output schema

<?xml version="1.0"?>
<results client_request_id="" >
  <result service_request_id="" status_code="" status_message="" request_date="" target_location="" >
  </result>
</results>
Element name Attribute name Description Remarks
results -    
client_request_id The ID issued in the client side of Azure Queue Storage.  
result - Appears for each message which is subject to delete. One DeleteMessage request is sent per element.
service_request_id The delete request ID issued in the server side of Azure Queue Storage. The value of "x-ms-request-id" header included in a response from Azure Queue Storage.
status_code The result of message deletion.
  • 204: Success
 The status code value included in a response from Azure Queue Storage.
status_message The result of message deletion.
  • No Content: Success
 The status code message included in a response from Azure Queue Storage.
request_date The date and time when the delete request was made. The "Date" header value included in a response from Azure Queue Storage.
target_location The target of storage.
  • PRIMARY: Primary storage
  • SECONDARY: Secondary storage
  

Loading schema in Mapper

Schema is loaded automatically.
For more details, refer to “Edit Schema”.

Transaction

Transaction is not supported.

PSP Usage

PSP is not supported.

Available Component Variables

Component variable name Description Remarks
count The number of messages deleted successfully is stored.
  • Default value is null.
error_count The number of messages failed to delete is stored.
  • Default value is null.
message_category When an error occurs, category of the corresponding message code is stored.
  • Default value is null.
message_code When an error occurs, code of the corresponding message code is stored.
  • Default value is null.
message_level When an error occurs, severity of the corresponding message code is stored.
  • Default value is null.
error_type When an error occurs, the error type is stored.
  • Default value is null.
  • The error type would be in the following format.
    Example: “java.io.FileNotFoundException”
  • The contents that will be stored may vary depending on DataSpider Servista versions.
error_message When an error occurs, the error message is stored.
  • Default value is null.
  • The contents that will be stored may vary depending on DataSpider Servista versions.
error_trace When an error occurs, trace information of the error is stored.
  • Default value is null.
  • The contents that will be stored may vary depending on DataSpider Servista versions and client applications.

Specification Limits

Major Exceptions

Exception name Cause Solution
ResourceNotFoundException
Resource definition is not found. Name: []		 [Destination] is not specified. Specify [Destination].
ResourceNotFoundException
Resource definition is not found. Name: [<global resource name>]		 The resource definition selected in [Destination] is not found. Check the global resource specified in [Destination].
java.security.InvalidKeyException
Storage Key is not a valid base64 encoded string.
 There is something wrong with [Access key] of the global resource specified in [Destination]. Check the [Access key] settings of the global resource specified in [Destination].
com.microsoft.azure.storage.StorageException
Empty key 		There is something wrong with [Access key] of the global resource specified in [Destination]. Check the [Access key] settings of the global resource specified in [Destination].
com.microsoft.azure.storage.StorageException
Server failed to authenticate the request. Make sure the value of Authorization header is formed correctly including the signature. 		There is something wrong with [Account] or [Access key] of the global resource specified in [Destination]. Check the [Account] or [Access key] settings of the global resource specified in [Destination].
com.microsoft.azure.storage.StorageException
The server encountered an unknown failure: 		Failed to request delete message. Check [Queue name] or the [Account] and [Access key] settings of the global resource specified in [Destination].

Notes