227 строки
16 KiB
YAML
227 строки
16 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.storage.queue.models.SendMessageResult"
|
|
fullName: "com.azure.storage.queue.models.SendMessageResult"
|
|
name: "SendMessageResult"
|
|
nameWithType: "SendMessageResult"
|
|
summary: "The object returned in the Queue<wbr>Message<wbr>List array when calling Put Message on a Queue."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **SendMessageResult**</br> implements <xref href=\"com.azure.xml.XmlSerializable?alt=com.azure.xml.XmlSerializable&text=XmlSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.storage.queue.models.SendMessageResult?alt=com.azure.storage.queue.models.SendMessageResult&text=SendMessageResult\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.storage.queue.models.SendMessageResult.SendMessageResult()"
|
|
fullName: "com.azure.storage.queue.models.SendMessageResult.SendMessageResult()"
|
|
name: "SendMessageResult()"
|
|
nameWithType: "SendMessageResult.SendMessageResult()"
|
|
summary: "Creates an instance of Send<wbr>Message<wbr>Result class."
|
|
syntax: "public SendMessageResult()"
|
|
desc: "Creates an instance of SendMessageResult class."
|
|
methods:
|
|
- uid: "com.azure.storage.queue.models.SendMessageResult.fromXml(com.azure.xml.XmlReader)"
|
|
fullName: "com.azure.storage.queue.models.SendMessageResult.fromXml(XmlReader xmlReader)"
|
|
name: "fromXml(XmlReader xmlReader)"
|
|
nameWithType: "SendMessageResult.fromXml(XmlReader xmlReader)"
|
|
summary: "Reads an instance of Send<wbr>Message<wbr>Result from the Xml<wbr>Reader."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "The XmlReader being read."
|
|
name: "xmlReader"
|
|
type: "<xref href=\"com.azure.xml.XmlReader?alt=com.azure.xml.XmlReader&text=XmlReader\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static SendMessageResult fromXml(XmlReader xmlReader)"
|
|
exceptions:
|
|
- description: "If the deserialized XML object was missing any required properties."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLStreamException.html\">XMLStreamException</a>"
|
|
desc: "Reads an instance of SendMessageResult from the XmlReader."
|
|
returns:
|
|
description: "An instance of SendMessageResult if the XmlReader was pointing to an instance of it, or null if it was\n pointing to XML null."
|
|
type: "<xref href=\"com.azure.storage.queue.models.SendMessageResult?alt=com.azure.storage.queue.models.SendMessageResult&text=SendMessageResult\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.queue.models.SendMessageResult.fromXml(com.azure.xml.XmlReader,java.lang.String)"
|
|
fullName: "com.azure.storage.queue.models.SendMessageResult.fromXml(XmlReader xmlReader, String rootElementName)"
|
|
name: "fromXml(XmlReader xmlReader, String rootElementName)"
|
|
nameWithType: "SendMessageResult.fromXml(XmlReader xmlReader, String rootElementName)"
|
|
summary: "Reads an instance of Send<wbr>Message<wbr>Result from the Xml<wbr>Reader."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "The XmlReader being read."
|
|
name: "xmlReader"
|
|
type: "<xref href=\"com.azure.xml.XmlReader?alt=com.azure.xml.XmlReader&text=XmlReader\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Optional root element name to override the default defined by the model. Used to support\n cases where the model can deserialize from different root element names."
|
|
name: "rootElementName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public static SendMessageResult fromXml(XmlReader xmlReader, String rootElementName)"
|
|
exceptions:
|
|
- description: "If the deserialized XML object was missing any required properties."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLStreamException.html\">XMLStreamException</a>"
|
|
desc: "Reads an instance of SendMessageResult from the XmlReader."
|
|
returns:
|
|
description: "An instance of SendMessageResult if the XmlReader was pointing to an instance of it, or null if it was\n pointing to XML null."
|
|
type: "<xref href=\"com.azure.storage.queue.models.SendMessageResult?alt=com.azure.storage.queue.models.SendMessageResult&text=SendMessageResult\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.queue.models.SendMessageResult.getExpirationTime()"
|
|
fullName: "com.azure.storage.queue.models.SendMessageResult.getExpirationTime()"
|
|
name: "getExpirationTime()"
|
|
nameWithType: "SendMessageResult.getExpirationTime()"
|
|
summary: "Get the expiration<wbr>Time property: The time that the Message will expire and be automatically deleted."
|
|
syntax: "public OffsetDateTime getExpirationTime()"
|
|
desc: "Get the expirationTime property: The time that the Message will expire and be automatically deleted."
|
|
returns:
|
|
description: "the expirationTime value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
- uid: "com.azure.storage.queue.models.SendMessageResult.getInsertionTime()"
|
|
fullName: "com.azure.storage.queue.models.SendMessageResult.getInsertionTime()"
|
|
name: "getInsertionTime()"
|
|
nameWithType: "SendMessageResult.getInsertionTime()"
|
|
summary: "Get the insertion<wbr>Time property: The time the Message was inserted into the Queue."
|
|
syntax: "public OffsetDateTime getInsertionTime()"
|
|
desc: "Get the insertionTime property: The time the Message was inserted into the Queue."
|
|
returns:
|
|
description: "the insertionTime value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
- uid: "com.azure.storage.queue.models.SendMessageResult.getMessageId()"
|
|
fullName: "com.azure.storage.queue.models.SendMessageResult.getMessageId()"
|
|
name: "getMessageId()"
|
|
nameWithType: "SendMessageResult.getMessageId()"
|
|
summary: "Get the message<wbr>Id property: The Id of the Message."
|
|
syntax: "public String getMessageId()"
|
|
desc: "Get the messageId property: The Id of the Message."
|
|
returns:
|
|
description: "the messageId value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.storage.queue.models.SendMessageResult.getPopReceipt()"
|
|
fullName: "com.azure.storage.queue.models.SendMessageResult.getPopReceipt()"
|
|
name: "getPopReceipt()"
|
|
nameWithType: "SendMessageResult.getPopReceipt()"
|
|
summary: "Get the pop<wbr>Receipt property: This value is required to delete the Message."
|
|
syntax: "public String getPopReceipt()"
|
|
desc: "Get the popReceipt property: This value is required to delete the Message. If deletion fails using this popreceipt then the message has been dequeued by another client."
|
|
returns:
|
|
description: "the popReceipt value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.storage.queue.models.SendMessageResult.getTimeNextVisible()"
|
|
fullName: "com.azure.storage.queue.models.SendMessageResult.getTimeNextVisible()"
|
|
name: "getTimeNextVisible()"
|
|
nameWithType: "SendMessageResult.getTimeNextVisible()"
|
|
summary: "Get the time<wbr>Next<wbr>Visible property: The time that the message will again become visible in the Queue."
|
|
syntax: "public OffsetDateTime getTimeNextVisible()"
|
|
desc: "Get the timeNextVisible property: The time that the message will again become visible in the Queue."
|
|
returns:
|
|
description: "the timeNextVisible value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
- uid: "com.azure.storage.queue.models.SendMessageResult.setExpirationTime(java.time.OffsetDateTime)"
|
|
fullName: "com.azure.storage.queue.models.SendMessageResult.setExpirationTime(OffsetDateTime expirationTime)"
|
|
name: "setExpirationTime(OffsetDateTime expirationTime)"
|
|
nameWithType: "SendMessageResult.setExpirationTime(OffsetDateTime expirationTime)"
|
|
summary: "Set the expiration<wbr>Time property: The time that the Message will expire and be automatically deleted."
|
|
parameters:
|
|
- description: "the expirationTime value to set."
|
|
name: "expirationTime"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
syntax: "public SendMessageResult setExpirationTime(OffsetDateTime expirationTime)"
|
|
desc: "Set the expirationTime property: The time that the Message will expire and be automatically deleted."
|
|
returns:
|
|
description: "the SendMessageResult object itself."
|
|
type: "<xref href=\"com.azure.storage.queue.models.SendMessageResult?alt=com.azure.storage.queue.models.SendMessageResult&text=SendMessageResult\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.queue.models.SendMessageResult.setInsertionTime(java.time.OffsetDateTime)"
|
|
fullName: "com.azure.storage.queue.models.SendMessageResult.setInsertionTime(OffsetDateTime insertionTime)"
|
|
name: "setInsertionTime(OffsetDateTime insertionTime)"
|
|
nameWithType: "SendMessageResult.setInsertionTime(OffsetDateTime insertionTime)"
|
|
summary: "Set the insertion<wbr>Time property: The time the Message was inserted into the Queue."
|
|
parameters:
|
|
- description: "the insertionTime value to set."
|
|
name: "insertionTime"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
syntax: "public SendMessageResult setInsertionTime(OffsetDateTime insertionTime)"
|
|
desc: "Set the insertionTime property: The time the Message was inserted into the Queue."
|
|
returns:
|
|
description: "the SendMessageResult object itself."
|
|
type: "<xref href=\"com.azure.storage.queue.models.SendMessageResult?alt=com.azure.storage.queue.models.SendMessageResult&text=SendMessageResult\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.queue.models.SendMessageResult.setMessageId(java.lang.String)"
|
|
fullName: "com.azure.storage.queue.models.SendMessageResult.setMessageId(String messageId)"
|
|
name: "setMessageId(String messageId)"
|
|
nameWithType: "SendMessageResult.setMessageId(String messageId)"
|
|
summary: "Set the message<wbr>Id property: The Id of the Message."
|
|
parameters:
|
|
- description: "the messageId value to set."
|
|
name: "messageId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public SendMessageResult setMessageId(String messageId)"
|
|
desc: "Set the messageId property: The Id of the Message."
|
|
returns:
|
|
description: "the SendMessageResult object itself."
|
|
type: "<xref href=\"com.azure.storage.queue.models.SendMessageResult?alt=com.azure.storage.queue.models.SendMessageResult&text=SendMessageResult\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.queue.models.SendMessageResult.setPopReceipt(java.lang.String)"
|
|
fullName: "com.azure.storage.queue.models.SendMessageResult.setPopReceipt(String popReceipt)"
|
|
name: "setPopReceipt(String popReceipt)"
|
|
nameWithType: "SendMessageResult.setPopReceipt(String popReceipt)"
|
|
summary: "Set the pop<wbr>Receipt property: This value is required to delete the Message."
|
|
parameters:
|
|
- description: "the popReceipt value to set."
|
|
name: "popReceipt"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public SendMessageResult setPopReceipt(String popReceipt)"
|
|
desc: "Set the popReceipt property: This value is required to delete the Message. If deletion fails using this popreceipt then the message has been dequeued by another client."
|
|
returns:
|
|
description: "the SendMessageResult object itself."
|
|
type: "<xref href=\"com.azure.storage.queue.models.SendMessageResult?alt=com.azure.storage.queue.models.SendMessageResult&text=SendMessageResult\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.queue.models.SendMessageResult.setTimeNextVisible(java.time.OffsetDateTime)"
|
|
fullName: "com.azure.storage.queue.models.SendMessageResult.setTimeNextVisible(OffsetDateTime timeNextVisible)"
|
|
name: "setTimeNextVisible(OffsetDateTime timeNextVisible)"
|
|
nameWithType: "SendMessageResult.setTimeNextVisible(OffsetDateTime timeNextVisible)"
|
|
summary: "Set the time<wbr>Next<wbr>Visible property: The time that the message will again become visible in the Queue."
|
|
parameters:
|
|
- description: "the timeNextVisible value to set."
|
|
name: "timeNextVisible"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
syntax: "public SendMessageResult setTimeNextVisible(OffsetDateTime timeNextVisible)"
|
|
desc: "Set the timeNextVisible property: The time that the message will again become visible in the Queue."
|
|
returns:
|
|
description: "the SendMessageResult object itself."
|
|
type: "<xref href=\"com.azure.storage.queue.models.SendMessageResult?alt=com.azure.storage.queue.models.SendMessageResult&text=SendMessageResult\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.queue.models.SendMessageResult.toXml(com.azure.xml.XmlWriter)"
|
|
fullName: "com.azure.storage.queue.models.SendMessageResult.toXml(XmlWriter xmlWriter)"
|
|
name: "toXml(XmlWriter xmlWriter)"
|
|
nameWithType: "SendMessageResult.toXml(XmlWriter xmlWriter)"
|
|
parameters:
|
|
- name: "xmlWriter"
|
|
type: "<xref href=\"com.azure.xml.XmlWriter?alt=com.azure.xml.XmlWriter&text=XmlWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public XmlWriter toXml(XmlWriter xmlWriter)"
|
|
exceptions:
|
|
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLStreamException.html\">XMLStreamException</a>"
|
|
returns:
|
|
type: "<xref href=\"com.azure.xml.XmlWriter?alt=com.azure.xml.XmlWriter&text=XmlWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.queue.models.SendMessageResult.toXml(com.azure.xml.XmlWriter,java.lang.String)"
|
|
fullName: "com.azure.storage.queue.models.SendMessageResult.toXml(XmlWriter xmlWriter, String rootElementName)"
|
|
name: "toXml(XmlWriter xmlWriter, String rootElementName)"
|
|
nameWithType: "SendMessageResult.toXml(XmlWriter xmlWriter, String rootElementName)"
|
|
parameters:
|
|
- name: "xmlWriter"
|
|
type: "<xref href=\"com.azure.xml.XmlWriter?alt=com.azure.xml.XmlWriter&text=XmlWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
- name: "rootElementName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public XmlWriter toXml(XmlWriter xmlWriter, String rootElementName)"
|
|
exceptions:
|
|
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLStreamException.html\">XMLStreamException</a>"
|
|
returns:
|
|
type: "<xref href=\"com.azure.xml.XmlWriter?alt=com.azure.xml.XmlWriter&text=XmlWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "The object returned in the QueueMessageList array when calling Put Message on a Queue."
|
|
implements:
|
|
- "<xref href=\"com.azure.xml.XmlSerializable?alt=com.azure.xml.XmlSerializable&text=XmlSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.storage.queue.models.SendMessageResult?alt=com.azure.storage.queue.models.SendMessageResult&text=SendMessageResult\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.storage.queue.models"
|
|
artifact: com.azure:azure-storage-queue:12.22.1
|