• Home
• com.azure
• azure-storage-blob
• 12.28.0
• source code
• UserDelegationKey.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.azure.storage.blob.models.UserDelegationKey Maven / Gradle / Ivy

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.

package com.azure.storage.blob.models;

import com.azure.core.annotation.Fluent;
import com.azure.core.util.CoreUtils;
import com.azure.xml.XmlReader;
import com.azure.xml.XmlSerializable;
import com.azure.xml.XmlToken;
import com.azure.xml.XmlWriter;
import java.time.OffsetDateTime;
import java.time.format.DateTimeFormatter;
import javax.xml.namespace.QName;
import javax.xml.stream.XMLStreamException;

/**
 * A user delegation key.
 */
@Fluent
public final class UserDelegationKey implements XmlSerializable {
    /*
     * The Azure Active Directory object ID in GUID format.
     */
    private String signedObjectId;

    /*
     * The Azure Active Directory tenant ID in GUID format
     */
    private String signedTenantId;

    /*
     * The date-time the key is active
     */
    private OffsetDateTime signedStart;

    /*
     * The date-time the key expires
     */
    private OffsetDateTime signedExpiry;

    /*
     * Abbreviation of the Azure Storage service that accepts the key
     */
    private String signedService;

    /*
     * The service version that created the key
     */
    private String signedVersion;

    /*
     * The key as a base64 string
     */
    private String value;

    /**
     * Creates an instance of UserDelegationKey class.
     */
    public UserDelegationKey() {
    }

    /**
     * Get the signedObjectId property: The Azure Active Directory object ID in GUID format.
     * 
     * @return the signedObjectId value.
     */
    public String getSignedObjectId() {
        return this.signedObjectId;
    }

    /**
     * Set the signedObjectId property: The Azure Active Directory object ID in GUID format.
     * 
     * @param signedObjectId the signedObjectId value to set.
     * @return the UserDelegationKey object itself.
     */
    public UserDelegationKey setSignedObjectId(String signedObjectId) {
        this.signedObjectId = signedObjectId;
        return this;
    }

    /**
     * Get the signedTenantId property: The Azure Active Directory tenant ID in GUID format.
     * 
     * @return the signedTenantId value.
     */
    public String getSignedTenantId() {
        return this.signedTenantId;
    }

    /**
     * Set the signedTenantId property: The Azure Active Directory tenant ID in GUID format.
     * 
     * @param signedTenantId the signedTenantId value to set.
     * @return the UserDelegationKey object itself.
     */
    public UserDelegationKey setSignedTenantId(String signedTenantId) {
        this.signedTenantId = signedTenantId;
        return this;
    }

    /**
     * Get the signedStart property: The date-time the key is active.
     * 
     * @return the signedStart value.
     */
    public OffsetDateTime getSignedStart() {
        return this.signedStart;
    }

    /**
     * Set the signedStart property: The date-time the key is active.
     * 
     * @param signedStart the signedStart value to set.
     * @return the UserDelegationKey object itself.
     */
    public UserDelegationKey setSignedStart(OffsetDateTime signedStart) {
        this.signedStart = signedStart;
        return this;
    }

    /**
     * Get the signedExpiry property: The date-time the key expires.
     * 
     * @return the signedExpiry value.
     */
    public OffsetDateTime getSignedExpiry() {
        return this.signedExpiry;
    }

    /**
     * Set the signedExpiry property: The date-time the key expires.
     * 
     * @param signedExpiry the signedExpiry value to set.
     * @return the UserDelegationKey object itself.
     */
    public UserDelegationKey setSignedExpiry(OffsetDateTime signedExpiry) {
        this.signedExpiry = signedExpiry;
        return this;
    }

    /**
     * Get the signedService property: Abbreviation of the Azure Storage service that accepts the key.
     * 
     * @return the signedService value.
     */
    public String getSignedService() {
        return this.signedService;
    }

    /**
     * Set the signedService property: Abbreviation of the Azure Storage service that accepts the key.
     * 
     * @param signedService the signedService value to set.
     * @return the UserDelegationKey object itself.
     */
    public UserDelegationKey setSignedService(String signedService) {
        this.signedService = signedService;
        return this;
    }

    /**
     * Get the signedVersion property: The service version that created the key.
     * 
     * @return the signedVersion value.
     */
    public String getSignedVersion() {
        return this.signedVersion;
    }

    /**
     * Set the signedVersion property: The service version that created the key.
     * 
     * @param signedVersion the signedVersion value to set.
     * @return the UserDelegationKey object itself.
     */
    public UserDelegationKey setSignedVersion(String signedVersion) {
        this.signedVersion = signedVersion;
        return this;
    }

    /**
     * Get the value property: The key as a base64 string.
     * 
     * @return the value value.
     */
    public String getValue() {
        return this.value;
    }

    /**
     * Set the value property: The key as a base64 string.
     * 
     * @param value the value value to set.
     * @return the UserDelegationKey object itself.
     */
    public UserDelegationKey setValue(String value) {
        this.value = value;
        return this;
    }

    @Override
    public XmlWriter toXml(XmlWriter xmlWriter) throws XMLStreamException {
        return toXml(xmlWriter, null);
    }

    @Override
    public XmlWriter toXml(XmlWriter xmlWriter, String rootElementName) throws XMLStreamException {
        rootElementName = CoreUtils.isNullOrEmpty(rootElementName) ? "UserDelegationKey" : rootElementName;
        xmlWriter.writeStartElement(rootElementName);
        xmlWriter.writeStringElement("SignedOid", this.signedObjectId);
        xmlWriter.writeStringElement("SignedTid", this.signedTenantId);
        xmlWriter.writeStringElement("SignedStart",
            this.signedStart == null ? null : DateTimeFormatter.ISO_OFFSET_DATE_TIME.format(this.signedStart));
        xmlWriter.writeStringElement("SignedExpiry",
            this.signedExpiry == null ? null : DateTimeFormatter.ISO_OFFSET_DATE_TIME.format(this.signedExpiry));
        xmlWriter.writeStringElement("SignedService", this.signedService);
        xmlWriter.writeStringElement("SignedVersion", this.signedVersion);
        xmlWriter.writeStringElement("Value", this.value);
        return xmlWriter.writeEndElement();
    }

    /**
     * Reads an instance of UserDelegationKey from the XmlReader.
     * 
     * @param xmlReader The XmlReader being read.
     * @return An instance of UserDelegationKey if the XmlReader was pointing to an instance of it, or null if it was
     * pointing to XML null.
     * @throws IllegalStateException If the deserialized XML object was missing any required properties.
     * @throws XMLStreamException If an error occurs while reading the UserDelegationKey.
     */
    public static UserDelegationKey fromXml(XmlReader xmlReader) throws XMLStreamException {
        return fromXml(xmlReader, null);
    }

    /**
     * Reads an instance of UserDelegationKey from the XmlReader.
     * 
     * @param xmlReader The XmlReader being read.
     * @param rootElementName Optional root element name to override the default defined by the model. Used to support
     * cases where the model can deserialize from different root element names.
     * @return An instance of UserDelegationKey if the XmlReader was pointing to an instance of it, or null if it was
     * pointing to XML null.
     * @throws IllegalStateException If the deserialized XML object was missing any required properties.
     * @throws XMLStreamException If an error occurs while reading the UserDelegationKey.
     */
    public static UserDelegationKey fromXml(XmlReader xmlReader, String rootElementName) throws XMLStreamException {
        String finalRootElementName = CoreUtils.isNullOrEmpty(rootElementName) ? "UserDelegationKey" : rootElementName;
        return xmlReader.readObject(finalRootElementName, reader -> {
            UserDelegationKey deserializedUserDelegationKey = new UserDelegationKey();
            while (reader.nextElement() != XmlToken.END_ELEMENT) {
                QName elementName = reader.getElementName();

                if ("SignedOid".equals(elementName.getLocalPart())) {
                    deserializedUserDelegationKey.signedObjectId = reader.getStringElement();
                } else if ("SignedTid".equals(elementName.getLocalPart())) {
                    deserializedUserDelegationKey.signedTenantId = reader.getStringElement();
                } else if ("SignedStart".equals(elementName.getLocalPart())) {
                    deserializedUserDelegationKey.signedStart
                        = reader.getNullableElement(dateString -> OffsetDateTime.parse(dateString));
                } else if ("SignedExpiry".equals(elementName.getLocalPart())) {
                    deserializedUserDelegationKey.signedExpiry
                        = reader.getNullableElement(dateString -> OffsetDateTime.parse(dateString));
                } else if ("SignedService".equals(elementName.getLocalPart())) {
                    deserializedUserDelegationKey.signedService = reader.getStringElement();
                } else if ("SignedVersion".equals(elementName.getLocalPart())) {
                    deserializedUserDelegationKey.signedVersion = reader.getStringElement();
                } else if ("Value".equals(elementName.getLocalPart())) {
                    deserializedUserDelegationKey.value = reader.getStringElement();
                } else {
                    reader.skipElement();
                }
            }

            return deserializedUserDelegationKey;
        });
    }
}