com.microsoft.azure.eventgrid.models.DeviceLifeCycleEventProperties Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-eventgrid Show documentation
This package contains Microsoft Azure EventGrid SDK.
There is a newer version: 1.4.0
/**
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License. See License.txt in the project root for
 * license information.
 *
 * Code generated by Microsoft (R) AutoRest Code Generator.
 */

package com.microsoft.azure.eventgrid.models;

import com.fasterxml.jackson.annotation.JsonProperty;

/**
 * Schema of the Data property of an EventGridEvent for a device life cycle
 * event (DeviceCreated, DeviceDeleted).
 */
public class DeviceLifeCycleEventProperties {
    /**
     * The unique identifier of the device. This case-sensitive string can be
     * up to 128 characters long, and supports ASCII 7-bit alphanumeric
     * characters plus the following special characters: - : . + % _ &#35;
     * * ? ! ( ) , = @ ; $ '.
     */
    @JsonProperty(value = "deviceId")
    private String deviceId;

    /**
     * Name of the IoT Hub where the device was created or deleted.
     */
    @JsonProperty(value = "hubName")
    private String hubName;

    /**
     * Information about the device twin, which is the cloud representation of
     * application device metadata.
     */
    @JsonProperty(value = "twin")
    private DeviceTwinInfo twin;

    /**
     * Get the unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ &#35; * ? ! ( ) , = @ ; $ '.
     *
     * @return the deviceId value
     */
    public String deviceId() {
        return this.deviceId;
    }

    /**
     * Set the unique identifier of the device. This case-sensitive string can be up to 128 characters long, and supports ASCII 7-bit alphanumeric characters plus the following special characters: - : . + % _ &#35; * ? ! ( ) , = @ ; $ '.
     *
     * @param deviceId the deviceId value to set
     * @return the DeviceLifeCycleEventProperties object itself.
     */
    public DeviceLifeCycleEventProperties withDeviceId(String deviceId) {
        this.deviceId = deviceId;
        return this;
    }

    /**
     * Get name of the IoT Hub where the device was created or deleted.
     *
     * @return the hubName value
     */
    public String hubName() {
        return this.hubName;
    }

    /**
     * Set name of the IoT Hub where the device was created or deleted.
     *
     * @param hubName the hubName value to set
     * @return the DeviceLifeCycleEventProperties object itself.
     */
    public DeviceLifeCycleEventProperties withHubName(String hubName) {
        this.hubName = hubName;
        return this;
    }

    /**
     * Get information about the device twin, which is the cloud representation of application device metadata.
     *
     * @return the twin value
     */
    public DeviceTwinInfo twin() {
        return this.twin;
    }

    /**
     * Set information about the device twin, which is the cloud representation of application device metadata.
     *
     * @param twin the twin value to set
     * @return the DeviceLifeCycleEventProperties object itself.
     */
    public DeviceLifeCycleEventProperties withTwin(DeviceTwinInfo twin) {
        this.twin = twin;
        return this;
    }

}