com.microsoft.azure.sdk.iot.service.digitaltwin.models.DigitalTwinUpdateRequestOptions Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of iot-service-client Show documentation

The Microsoft Azure IoT Service SDK for Java

The newest version!

// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.

package com.microsoft.azure.sdk.iot.service.digitaltwin.models;

public final class DigitalTwinUpdateRequestOptions {
    private String ifMatch;

    /**
     * Gets a string representing a weak ETag for the entity that this request performs an operation against, as per RFC7232.
     * @return A string representing a weak ETag for the entity that this request performs an operation against, as per RFC7232.
     */
    public String getIfMatch() {
        return ifMatch;
    }

    /**
     * Sets a string representing a weak ETag for the entity that this request performs an operation against, as per RFC7232.
     *
     *  The request's operation is performed only if this ETag matches the value maintained by the server,
     * indicating that the entity has not been modified since it was last retrieved.
     * To force the operation to execute only if the entity exists, set the ETag to the wildcard character '*'.
     * To force the operation to execute unconditionally, leave this value null.
     * If this value is not set, it defaults to null, and the ifMatch header will not be sent with the request.
     * This means that update will be unconditional and the operation will execute regardless of the existence of the resource. 
     *
     * @param ifMatch A string representing a weak ETag for the entity that this request performs an operation against, as per RFC7232.
     * @return The UpdateDigitalTwinRequestOptions object itself.
     */
    public DigitalTwinUpdateRequestOptions setIfMatch(String ifMatch) {
        this.ifMatch = ifMatch;
        return this;
    }
}