azure-docs-sdk-java/docs-ref-autogen/com.microsoft.azure.eventgr...

300 строки
21 KiB
YAML

### YamlMime:JavaType
uid: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo"
fullName: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo"
name: "DeviceTwinInfo"
nameWithType: "DeviceTwinInfo"
summary: "Information about the device twin, which is the cloud representation of application device metadata."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
syntax: "public class **DeviceTwinInfo**"
constructors:
- uid: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.DeviceTwinInfo()"
fullName: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.DeviceTwinInfo()"
name: "DeviceTwinInfo()"
nameWithType: "DeviceTwinInfo.DeviceTwinInfo()"
syntax: "public DeviceTwinInfo()"
methods:
- uid: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.authenticationType()"
fullName: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.authenticationType()"
name: "authenticationType()"
nameWithType: "DeviceTwinInfo.authenticationType()"
summary: "Get authentication type used for this device: either SAS, Self<wbr>Signed, or Certificate<wbr>Authority."
syntax: "public String authenticationType()"
desc: "Get authentication type used for this device: either SAS, SelfSigned, or CertificateAuthority."
returns:
description: "the authenticationType value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.cloudToDeviceMessageCount()"
fullName: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.cloudToDeviceMessageCount()"
name: "cloudToDeviceMessageCount()"
nameWithType: "DeviceTwinInfo.cloudToDeviceMessageCount()"
summary: "Get count of cloud to device messages sent to this device."
syntax: "public Double cloudToDeviceMessageCount()"
desc: "Get count of cloud to device messages sent to this device."
returns:
description: "the cloudToDeviceMessageCount value"
type: "<xref href=\"java.lang.Double?alt=java.lang.Double&text=Double\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.connectionState()"
fullName: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.connectionState()"
name: "connectionState()"
nameWithType: "DeviceTwinInfo.connectionState()"
summary: "Get whether the device is connected or disconnected."
syntax: "public String connectionState()"
desc: "Get whether the device is connected or disconnected."
returns:
description: "the connectionState value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.deviceId()"
fullName: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.deviceId()"
name: "deviceId()"
nameWithType: "DeviceTwinInfo.deviceId()"
summary: "Get the unique identifier of the device twin."
syntax: "public String deviceId()"
desc: "Get the unique identifier of the device twin."
returns:
description: "the deviceId value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.etag()"
fullName: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.etag()"
name: "etag()"
nameWithType: "DeviceTwinInfo.etag()"
summary: "Get a piece of information that describes the content of the device twin."
syntax: "public String etag()"
desc: "Get a piece of information that describes the content of the device twin. Each etag is guaranteed to be unique per device twin."
returns:
description: "the etag value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.lastActivityTime()"
fullName: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.lastActivityTime()"
name: "lastActivityTime()"
nameWithType: "DeviceTwinInfo.lastActivityTime()"
summary: "Get the ISO8601 timestamp of the last activity."
syntax: "public String lastActivityTime()"
desc: "Get the ISO8601 timestamp of the last activity."
returns:
description: "the lastActivityTime value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.properties()"
fullName: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.properties()"
name: "properties()"
nameWithType: "DeviceTwinInfo.properties()"
summary: "Get properties JSON element."
syntax: "public DeviceTwinInfoProperties properties()"
desc: "Get properties JSON element."
returns:
description: "the properties value"
type: "<xref href=\"com.microsoft.azure.eventgrid.models.DeviceTwinInfoProperties?alt=com.microsoft.azure.eventgrid.models.DeviceTwinInfoProperties&text=DeviceTwinInfoProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.status()"
fullName: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.status()"
name: "status()"
nameWithType: "DeviceTwinInfo.status()"
summary: "Get whether the device twin is enabled or disabled."
syntax: "public String status()"
desc: "Get whether the device twin is enabled or disabled."
returns:
description: "the status value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.statusUpdateTime()"
fullName: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.statusUpdateTime()"
name: "statusUpdateTime()"
nameWithType: "DeviceTwinInfo.statusUpdateTime()"
summary: "Get the ISO8601 timestamp of the last device twin status update."
syntax: "public String statusUpdateTime()"
desc: "Get the ISO8601 timestamp of the last device twin status update."
returns:
description: "the statusUpdateTime value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.version()"
fullName: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.version()"
name: "version()"
nameWithType: "DeviceTwinInfo.version()"
summary: "Get an integer that is incremented by one each time the device twin is updated."
syntax: "public Double version()"
desc: "Get an integer that is incremented by one each time the device twin is updated."
returns:
description: "the version value"
type: "<xref href=\"java.lang.Double?alt=java.lang.Double&text=Double\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.withAuthenticationType(java.lang.String)"
fullName: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.withAuthenticationType(String authenticationType)"
name: "withAuthenticationType(String authenticationType)"
nameWithType: "DeviceTwinInfo.withAuthenticationType(String authenticationType)"
summary: "Set authentication type used for this device: either SAS, Self<wbr>Signed, or Certificate<wbr>Authority."
parameters:
- description: "the authenticationType value to set"
name: "authenticationType"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DeviceTwinInfo withAuthenticationType(String authenticationType)"
desc: "Set authentication type used for this device: either SAS, SelfSigned, or CertificateAuthority."
returns:
description: "the DeviceTwinInfo object itself."
type: "<xref href=\"com.microsoft.azure.eventgrid.models.DeviceTwinInfo?alt=com.microsoft.azure.eventgrid.models.DeviceTwinInfo&text=DeviceTwinInfo\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.withCloudToDeviceMessageCount(java.lang.Double)"
fullName: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.withCloudToDeviceMessageCount(Double cloudToDeviceMessageCount)"
name: "withCloudToDeviceMessageCount(Double cloudToDeviceMessageCount)"
nameWithType: "DeviceTwinInfo.withCloudToDeviceMessageCount(Double cloudToDeviceMessageCount)"
summary: "Set count of cloud to device messages sent to this device."
parameters:
- description: "the cloudToDeviceMessageCount value to set"
name: "cloudToDeviceMessageCount"
type: "<xref href=\"java.lang.Double?alt=java.lang.Double&text=Double\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DeviceTwinInfo withCloudToDeviceMessageCount(Double cloudToDeviceMessageCount)"
desc: "Set count of cloud to device messages sent to this device."
returns:
description: "the DeviceTwinInfo object itself."
type: "<xref href=\"com.microsoft.azure.eventgrid.models.DeviceTwinInfo?alt=com.microsoft.azure.eventgrid.models.DeviceTwinInfo&text=DeviceTwinInfo\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.withConnectionState(java.lang.String)"
fullName: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.withConnectionState(String connectionState)"
name: "withConnectionState(String connectionState)"
nameWithType: "DeviceTwinInfo.withConnectionState(String connectionState)"
summary: "Set whether the device is connected or disconnected."
parameters:
- description: "the connectionState value to set"
name: "connectionState"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DeviceTwinInfo withConnectionState(String connectionState)"
desc: "Set whether the device is connected or disconnected."
returns:
description: "the DeviceTwinInfo object itself."
type: "<xref href=\"com.microsoft.azure.eventgrid.models.DeviceTwinInfo?alt=com.microsoft.azure.eventgrid.models.DeviceTwinInfo&text=DeviceTwinInfo\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.withDeviceId(java.lang.String)"
fullName: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.withDeviceId(String deviceId)"
name: "withDeviceId(String deviceId)"
nameWithType: "DeviceTwinInfo.withDeviceId(String deviceId)"
summary: "Set the unique identifier of the device twin."
parameters:
- description: "the deviceId value to set"
name: "deviceId"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DeviceTwinInfo withDeviceId(String deviceId)"
desc: "Set the unique identifier of the device twin."
returns:
description: "the DeviceTwinInfo object itself."
type: "<xref href=\"com.microsoft.azure.eventgrid.models.DeviceTwinInfo?alt=com.microsoft.azure.eventgrid.models.DeviceTwinInfo&text=DeviceTwinInfo\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.withEtag(java.lang.String)"
fullName: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.withEtag(String etag)"
name: "withEtag(String etag)"
nameWithType: "DeviceTwinInfo.withEtag(String etag)"
summary: "Set a piece of information that describes the content of the device twin."
parameters:
- description: "the etag value to set"
name: "etag"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DeviceTwinInfo withEtag(String etag)"
desc: "Set a piece of information that describes the content of the device twin. Each etag is guaranteed to be unique per device twin."
returns:
description: "the DeviceTwinInfo object itself."
type: "<xref href=\"com.microsoft.azure.eventgrid.models.DeviceTwinInfo?alt=com.microsoft.azure.eventgrid.models.DeviceTwinInfo&text=DeviceTwinInfo\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.withLastActivityTime(java.lang.String)"
fullName: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.withLastActivityTime(String lastActivityTime)"
name: "withLastActivityTime(String lastActivityTime)"
nameWithType: "DeviceTwinInfo.withLastActivityTime(String lastActivityTime)"
summary: "Set the ISO8601 timestamp of the last activity."
parameters:
- description: "the lastActivityTime value to set"
name: "lastActivityTime"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DeviceTwinInfo withLastActivityTime(String lastActivityTime)"
desc: "Set the ISO8601 timestamp of the last activity."
returns:
description: "the DeviceTwinInfo object itself."
type: "<xref href=\"com.microsoft.azure.eventgrid.models.DeviceTwinInfo?alt=com.microsoft.azure.eventgrid.models.DeviceTwinInfo&text=DeviceTwinInfo\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.withProperties(com.microsoft.azure.eventgrid.models.DeviceTwinInfoProperties)"
fullName: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.withProperties(DeviceTwinInfoProperties properties)"
name: "withProperties(DeviceTwinInfoProperties properties)"
nameWithType: "DeviceTwinInfo.withProperties(DeviceTwinInfoProperties properties)"
summary: "Set properties JSON element."
parameters:
- description: "the properties value to set"
name: "properties"
type: "<xref href=\"com.microsoft.azure.eventgrid.models.DeviceTwinInfoProperties?alt=com.microsoft.azure.eventgrid.models.DeviceTwinInfoProperties&text=DeviceTwinInfoProperties\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DeviceTwinInfo withProperties(DeviceTwinInfoProperties properties)"
desc: "Set properties JSON element."
returns:
description: "the DeviceTwinInfo object itself."
type: "<xref href=\"com.microsoft.azure.eventgrid.models.DeviceTwinInfo?alt=com.microsoft.azure.eventgrid.models.DeviceTwinInfo&text=DeviceTwinInfo\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.withStatus(java.lang.String)"
fullName: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.withStatus(String status)"
name: "withStatus(String status)"
nameWithType: "DeviceTwinInfo.withStatus(String status)"
summary: "Set whether the device twin is enabled or disabled."
parameters:
- description: "the status value to set"
name: "status"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DeviceTwinInfo withStatus(String status)"
desc: "Set whether the device twin is enabled or disabled."
returns:
description: "the DeviceTwinInfo object itself."
type: "<xref href=\"com.microsoft.azure.eventgrid.models.DeviceTwinInfo?alt=com.microsoft.azure.eventgrid.models.DeviceTwinInfo&text=DeviceTwinInfo\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.withStatusUpdateTime(java.lang.String)"
fullName: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.withStatusUpdateTime(String statusUpdateTime)"
name: "withStatusUpdateTime(String statusUpdateTime)"
nameWithType: "DeviceTwinInfo.withStatusUpdateTime(String statusUpdateTime)"
summary: "Set the ISO8601 timestamp of the last device twin status update."
parameters:
- description: "the statusUpdateTime value to set"
name: "statusUpdateTime"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DeviceTwinInfo withStatusUpdateTime(String statusUpdateTime)"
desc: "Set the ISO8601 timestamp of the last device twin status update."
returns:
description: "the DeviceTwinInfo object itself."
type: "<xref href=\"com.microsoft.azure.eventgrid.models.DeviceTwinInfo?alt=com.microsoft.azure.eventgrid.models.DeviceTwinInfo&text=DeviceTwinInfo\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.withVersion(java.lang.Double)"
fullName: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.withVersion(Double version)"
name: "withVersion(Double version)"
nameWithType: "DeviceTwinInfo.withVersion(Double version)"
summary: "Set an integer that is incremented by one each time the device twin is updated."
parameters:
- description: "the version value to set"
name: "version"
type: "<xref href=\"java.lang.Double?alt=java.lang.Double&text=Double\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DeviceTwinInfo withVersion(Double version)"
desc: "Set an integer that is incremented by one each time the device twin is updated."
returns:
description: "the DeviceTwinInfo object itself."
type: "<xref href=\"com.microsoft.azure.eventgrid.models.DeviceTwinInfo?alt=com.microsoft.azure.eventgrid.models.DeviceTwinInfo&text=DeviceTwinInfo\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.withX509Thumbprint(com.microsoft.azure.eventgrid.models.DeviceTwinInfoX509Thumbprint)"
fullName: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.withX509Thumbprint(DeviceTwinInfoX509Thumbprint x509Thumbprint)"
name: "withX509Thumbprint(DeviceTwinInfoX509Thumbprint x509Thumbprint)"
nameWithType: "DeviceTwinInfo.withX509Thumbprint(DeviceTwinInfoX509Thumbprint x509Thumbprint)"
summary: "Set the thumbprint is a unique value for the x509 certificate, commonly used to find a particular certificate in a certificate store."
parameters:
- description: "the x509Thumbprint value to set"
name: "x509Thumbprint"
type: "<xref href=\"com.microsoft.azure.eventgrid.models.DeviceTwinInfoX509Thumbprint?alt=com.microsoft.azure.eventgrid.models.DeviceTwinInfoX509Thumbprint&text=DeviceTwinInfoX509Thumbprint\" data-throw-if-not-resolved=\"False\" />"
syntax: "public DeviceTwinInfo withX509Thumbprint(DeviceTwinInfoX509Thumbprint x509Thumbprint)"
desc: "Set the thumbprint is a unique value for the x509 certificate, commonly used to find a particular certificate in a certificate store. The thumbprint is dynamically generated using the SHA1 algorithm, and does not physically exist in the certificate."
returns:
description: "the DeviceTwinInfo object itself."
type: "<xref href=\"com.microsoft.azure.eventgrid.models.DeviceTwinInfo?alt=com.microsoft.azure.eventgrid.models.DeviceTwinInfo&text=DeviceTwinInfo\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.x509Thumbprint()"
fullName: "com.microsoft.azure.eventgrid.models.DeviceTwinInfo.x509Thumbprint()"
name: "x509Thumbprint()"
nameWithType: "DeviceTwinInfo.x509Thumbprint()"
summary: "Get the thumbprint is a unique value for the x509 certificate, commonly used to find a particular certificate in a certificate store."
syntax: "public DeviceTwinInfoX509Thumbprint x509Thumbprint()"
desc: "Get the thumbprint is a unique value for the x509 certificate, commonly used to find a particular certificate in a certificate store. The thumbprint is dynamically generated using the SHA1 algorithm, and does not physically exist in the certificate."
returns:
description: "the x509Thumbprint value"
type: "<xref href=\"com.microsoft.azure.eventgrid.models.DeviceTwinInfoX509Thumbprint?alt=com.microsoft.azure.eventgrid.models.DeviceTwinInfoX509Thumbprint&text=DeviceTwinInfoX509Thumbprint\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Information about the device twin, which is the cloud representation of application device metadata."
metadata: {}
package: "com.microsoft.azure.eventgrid.models"
artifact: com.microsoft.azure:azure-eventgrid:1.3.0