• Home
• com.azure.resourcemanager
• azure-resourcemanager-desktopvirtualization
• 1.2.0
• source code
• HostPoolPatchProperties.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.resourcemanager.desktopvirtualization.fluent.models.HostPoolPatchProperties 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.resourcemanager.desktopvirtualization.fluent.models;

import com.azure.core.annotation.Fluent;
import com.azure.json.JsonReader;
import com.azure.json.JsonSerializable;
import com.azure.json.JsonToken;
import com.azure.json.JsonWriter;
import com.azure.resourcemanager.desktopvirtualization.models.AgentUpdatePatchProperties;
import com.azure.resourcemanager.desktopvirtualization.models.HostpoolPublicNetworkAccess;
import com.azure.resourcemanager.desktopvirtualization.models.LoadBalancerType;
import com.azure.resourcemanager.desktopvirtualization.models.PersonalDesktopAssignmentType;
import com.azure.resourcemanager.desktopvirtualization.models.PreferredAppGroupType;
import com.azure.resourcemanager.desktopvirtualization.models.RegistrationInfoPatch;
import com.azure.resourcemanager.desktopvirtualization.models.SsoSecretType;
import java.io.IOException;

/**
 * Properties of HostPool.
 */
@Fluent
public final class HostPoolPatchProperties implements JsonSerializable {
    /*
     * Friendly name of HostPool.
     */
    private String friendlyName;

    /*
     * Description of HostPool.
     */
    private String description;

    /*
     * Custom rdp property of HostPool.
     */
    private String customRdpProperty;

    /*
     * The max session limit of HostPool.
     */
    private Integer maxSessionLimit;

    /*
     * PersonalDesktopAssignment type for HostPool.
     */
    private PersonalDesktopAssignmentType personalDesktopAssignmentType;

    /*
     * The type of the load balancer.
     */
    private LoadBalancerType loadBalancerType;

    /*
     * The ring number of HostPool.
     */
    private Integer ring;

    /*
     * Is validation environment.
     */
    private Boolean validationEnvironment;

    /*
     * The registration info of HostPool.
     */
    private RegistrationInfoPatch registrationInfo;

    /*
     * VM template for sessionhosts configuration within hostpool.
     */
    private String vmTemplate;

    /*
     * URL to customer ADFS server for signing WVD SSO certificates.
     */
    private String ssoadfsAuthority;

    /*
     * ClientId for the registered Relying Party used to issue WVD SSO certificates.
     */
    private String ssoClientId;

    /*
     * Path to Azure KeyVault storing the secret used for communication to ADFS.
     */
    private String ssoClientSecretKeyVaultPath;

    /*
     * The type of single sign on Secret Type.
     */
    private SsoSecretType ssoSecretType;

    /*
     * The type of preferred application group type, default to Desktop Application Group
     */
    private PreferredAppGroupType preferredAppGroupType;

    /*
     * The flag to turn on/off StartVMOnConnect feature.
     */
    private Boolean startVMOnConnect;

    /*
     * Enabled to allow this resource to be access from the public network
     */
    private HostpoolPublicNetworkAccess publicNetworkAccess;

    /*
     * The session host configuration for updating agent, monitoring agent, and stack component.
     */
    private AgentUpdatePatchProperties agentUpdate;

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

    /**
     * Get the friendlyName property: Friendly name of HostPool.
     * 
     * @return the friendlyName value.
     */
    public String friendlyName() {
        return this.friendlyName;
    }

    /**
     * Set the friendlyName property: Friendly name of HostPool.
     * 
     * @param friendlyName the friendlyName value to set.
     * @return the HostPoolPatchProperties object itself.
     */
    public HostPoolPatchProperties withFriendlyName(String friendlyName) {
        this.friendlyName = friendlyName;
        return this;
    }

    /**
     * Get the description property: Description of HostPool.
     * 
     * @return the description value.
     */
    public String description() {
        return this.description;
    }

    /**
     * Set the description property: Description of HostPool.
     * 
     * @param description the description value to set.
     * @return the HostPoolPatchProperties object itself.
     */
    public HostPoolPatchProperties withDescription(String description) {
        this.description = description;
        return this;
    }

    /**
     * Get the customRdpProperty property: Custom rdp property of HostPool.
     * 
     * @return the customRdpProperty value.
     */
    public String customRdpProperty() {
        return this.customRdpProperty;
    }

    /**
     * Set the customRdpProperty property: Custom rdp property of HostPool.
     * 
     * @param customRdpProperty the customRdpProperty value to set.
     * @return the HostPoolPatchProperties object itself.
     */
    public HostPoolPatchProperties withCustomRdpProperty(String customRdpProperty) {
        this.customRdpProperty = customRdpProperty;
        return this;
    }

    /**
     * Get the maxSessionLimit property: The max session limit of HostPool.
     * 
     * @return the maxSessionLimit value.
     */
    public Integer maxSessionLimit() {
        return this.maxSessionLimit;
    }

    /**
     * Set the maxSessionLimit property: The max session limit of HostPool.
     * 
     * @param maxSessionLimit the maxSessionLimit value to set.
     * @return the HostPoolPatchProperties object itself.
     */
    public HostPoolPatchProperties withMaxSessionLimit(Integer maxSessionLimit) {
        this.maxSessionLimit = maxSessionLimit;
        return this;
    }

    /**
     * Get the personalDesktopAssignmentType property: PersonalDesktopAssignment type for HostPool.
     * 
     * @return the personalDesktopAssignmentType value.
     */
    public PersonalDesktopAssignmentType personalDesktopAssignmentType() {
        return this.personalDesktopAssignmentType;
    }

    /**
     * Set the personalDesktopAssignmentType property: PersonalDesktopAssignment type for HostPool.
     * 
     * @param personalDesktopAssignmentType the personalDesktopAssignmentType value to set.
     * @return the HostPoolPatchProperties object itself.
     */
    public HostPoolPatchProperties
        withPersonalDesktopAssignmentType(PersonalDesktopAssignmentType personalDesktopAssignmentType) {
        this.personalDesktopAssignmentType = personalDesktopAssignmentType;
        return this;
    }

    /**
     * Get the loadBalancerType property: The type of the load balancer.
     * 
     * @return the loadBalancerType value.
     */
    public LoadBalancerType loadBalancerType() {
        return this.loadBalancerType;
    }

    /**
     * Set the loadBalancerType property: The type of the load balancer.
     * 
     * @param loadBalancerType the loadBalancerType value to set.
     * @return the HostPoolPatchProperties object itself.
     */
    public HostPoolPatchProperties withLoadBalancerType(LoadBalancerType loadBalancerType) {
        this.loadBalancerType = loadBalancerType;
        return this;
    }

    /**
     * Get the ring property: The ring number of HostPool.
     * 
     * @return the ring value.
     */
    public Integer ring() {
        return this.ring;
    }

    /**
     * Set the ring property: The ring number of HostPool.
     * 
     * @param ring the ring value to set.
     * @return the HostPoolPatchProperties object itself.
     */
    public HostPoolPatchProperties withRing(Integer ring) {
        this.ring = ring;
        return this;
    }

    /**
     * Get the validationEnvironment property: Is validation environment.
     * 
     * @return the validationEnvironment value.
     */
    public Boolean validationEnvironment() {
        return this.validationEnvironment;
    }

    /**
     * Set the validationEnvironment property: Is validation environment.
     * 
     * @param validationEnvironment the validationEnvironment value to set.
     * @return the HostPoolPatchProperties object itself.
     */
    public HostPoolPatchProperties withValidationEnvironment(Boolean validationEnvironment) {
        this.validationEnvironment = validationEnvironment;
        return this;
    }

    /**
     * Get the registrationInfo property: The registration info of HostPool.
     * 
     * @return the registrationInfo value.
     */
    public RegistrationInfoPatch registrationInfo() {
        return this.registrationInfo;
    }

    /**
     * Set the registrationInfo property: The registration info of HostPool.
     * 
     * @param registrationInfo the registrationInfo value to set.
     * @return the HostPoolPatchProperties object itself.
     */
    public HostPoolPatchProperties withRegistrationInfo(RegistrationInfoPatch registrationInfo) {
        this.registrationInfo = registrationInfo;
        return this;
    }

    /**
     * Get the vmTemplate property: VM template for sessionhosts configuration within hostpool.
     * 
     * @return the vmTemplate value.
     */
    public String vmTemplate() {
        return this.vmTemplate;
    }

    /**
     * Set the vmTemplate property: VM template for sessionhosts configuration within hostpool.
     * 
     * @param vmTemplate the vmTemplate value to set.
     * @return the HostPoolPatchProperties object itself.
     */
    public HostPoolPatchProperties withVmTemplate(String vmTemplate) {
        this.vmTemplate = vmTemplate;
        return this;
    }

    /**
     * Get the ssoadfsAuthority property: URL to customer ADFS server for signing WVD SSO certificates.
     * 
     * @return the ssoadfsAuthority value.
     */
    public String ssoadfsAuthority() {
        return this.ssoadfsAuthority;
    }

    /**
     * Set the ssoadfsAuthority property: URL to customer ADFS server for signing WVD SSO certificates.
     * 
     * @param ssoadfsAuthority the ssoadfsAuthority value to set.
     * @return the HostPoolPatchProperties object itself.
     */
    public HostPoolPatchProperties withSsoadfsAuthority(String ssoadfsAuthority) {
        this.ssoadfsAuthority = ssoadfsAuthority;
        return this;
    }

    /**
     * Get the ssoClientId property: ClientId for the registered Relying Party used to issue WVD SSO certificates.
     * 
     * @return the ssoClientId value.
     */
    public String ssoClientId() {
        return this.ssoClientId;
    }

    /**
     * Set the ssoClientId property: ClientId for the registered Relying Party used to issue WVD SSO certificates.
     * 
     * @param ssoClientId the ssoClientId value to set.
     * @return the HostPoolPatchProperties object itself.
     */
    public HostPoolPatchProperties withSsoClientId(String ssoClientId) {
        this.ssoClientId = ssoClientId;
        return this;
    }

    /**
     * Get the ssoClientSecretKeyVaultPath property: Path to Azure KeyVault storing the secret used for communication to
     * ADFS.
     * 
     * @return the ssoClientSecretKeyVaultPath value.
     */
    public String ssoClientSecretKeyVaultPath() {
        return this.ssoClientSecretKeyVaultPath;
    }

    /**
     * Set the ssoClientSecretKeyVaultPath property: Path to Azure KeyVault storing the secret used for communication to
     * ADFS.
     * 
     * @param ssoClientSecretKeyVaultPath the ssoClientSecretKeyVaultPath value to set.
     * @return the HostPoolPatchProperties object itself.
     */
    public HostPoolPatchProperties withSsoClientSecretKeyVaultPath(String ssoClientSecretKeyVaultPath) {
        this.ssoClientSecretKeyVaultPath = ssoClientSecretKeyVaultPath;
        return this;
    }

    /**
     * Get the ssoSecretType property: The type of single sign on Secret Type.
     * 
     * @return the ssoSecretType value.
     */
    public SsoSecretType ssoSecretType() {
        return this.ssoSecretType;
    }

    /**
     * Set the ssoSecretType property: The type of single sign on Secret Type.
     * 
     * @param ssoSecretType the ssoSecretType value to set.
     * @return the HostPoolPatchProperties object itself.
     */
    public HostPoolPatchProperties withSsoSecretType(SsoSecretType ssoSecretType) {
        this.ssoSecretType = ssoSecretType;
        return this;
    }

    /**
     * Get the preferredAppGroupType property: The type of preferred application group type, default to Desktop
     * Application Group.
     * 
     * @return the preferredAppGroupType value.
     */
    public PreferredAppGroupType preferredAppGroupType() {
        return this.preferredAppGroupType;
    }

    /**
     * Set the preferredAppGroupType property: The type of preferred application group type, default to Desktop
     * Application Group.
     * 
     * @param preferredAppGroupType the preferredAppGroupType value to set.
     * @return the HostPoolPatchProperties object itself.
     */
    public HostPoolPatchProperties withPreferredAppGroupType(PreferredAppGroupType preferredAppGroupType) {
        this.preferredAppGroupType = preferredAppGroupType;
        return this;
    }

    /**
     * Get the startVMOnConnect property: The flag to turn on/off StartVMOnConnect feature.
     * 
     * @return the startVMOnConnect value.
     */
    public Boolean startVMOnConnect() {
        return this.startVMOnConnect;
    }

    /**
     * Set the startVMOnConnect property: The flag to turn on/off StartVMOnConnect feature.
     * 
     * @param startVMOnConnect the startVMOnConnect value to set.
     * @return the HostPoolPatchProperties object itself.
     */
    public HostPoolPatchProperties withStartVMOnConnect(Boolean startVMOnConnect) {
        this.startVMOnConnect = startVMOnConnect;
        return this;
    }

    /**
     * Get the publicNetworkAccess property: Enabled to allow this resource to be access from the public network.
     * 
     * @return the publicNetworkAccess value.
     */
    public HostpoolPublicNetworkAccess publicNetworkAccess() {
        return this.publicNetworkAccess;
    }

    /**
     * Set the publicNetworkAccess property: Enabled to allow this resource to be access from the public network.
     * 
     * @param publicNetworkAccess the publicNetworkAccess value to set.
     * @return the HostPoolPatchProperties object itself.
     */
    public HostPoolPatchProperties withPublicNetworkAccess(HostpoolPublicNetworkAccess publicNetworkAccess) {
        this.publicNetworkAccess = publicNetworkAccess;
        return this;
    }

    /**
     * Get the agentUpdate property: The session host configuration for updating agent, monitoring agent, and stack
     * component.
     * 
     * @return the agentUpdate value.
     */
    public AgentUpdatePatchProperties agentUpdate() {
        return this.agentUpdate;
    }

    /**
     * Set the agentUpdate property: The session host configuration for updating agent, monitoring agent, and stack
     * component.
     * 
     * @param agentUpdate the agentUpdate value to set.
     * @return the HostPoolPatchProperties object itself.
     */
    public HostPoolPatchProperties withAgentUpdate(AgentUpdatePatchProperties agentUpdate) {
        this.agentUpdate = agentUpdate;
        return this;
    }

    /**
     * Validates the instance.
     * 
     * @throws IllegalArgumentException thrown if the instance is not valid.
     */
    public void validate() {
        if (registrationInfo() != null) {
            registrationInfo().validate();
        }
        if (agentUpdate() != null) {
            agentUpdate().validate();
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public JsonWriter toJson(JsonWriter jsonWriter) throws IOException {
        jsonWriter.writeStartObject();
        jsonWriter.writeStringField("friendlyName", this.friendlyName);
        jsonWriter.writeStringField("description", this.description);
        jsonWriter.writeStringField("customRdpProperty", this.customRdpProperty);
        jsonWriter.writeNumberField("maxSessionLimit", this.maxSessionLimit);
        jsonWriter.writeStringField("personalDesktopAssignmentType",
            this.personalDesktopAssignmentType == null ? null : this.personalDesktopAssignmentType.toString());
        jsonWriter.writeStringField("loadBalancerType",
            this.loadBalancerType == null ? null : this.loadBalancerType.toString());
        jsonWriter.writeNumberField("ring", this.ring);
        jsonWriter.writeBooleanField("validationEnvironment", this.validationEnvironment);
        jsonWriter.writeJsonField("registrationInfo", this.registrationInfo);
        jsonWriter.writeStringField("vmTemplate", this.vmTemplate);
        jsonWriter.writeStringField("ssoadfsAuthority", this.ssoadfsAuthority);
        jsonWriter.writeStringField("ssoClientId", this.ssoClientId);
        jsonWriter.writeStringField("ssoClientSecretKeyVaultPath", this.ssoClientSecretKeyVaultPath);
        jsonWriter.writeStringField("ssoSecretType", this.ssoSecretType == null ? null : this.ssoSecretType.toString());
        jsonWriter.writeStringField("preferredAppGroupType",
            this.preferredAppGroupType == null ? null : this.preferredAppGroupType.toString());
        jsonWriter.writeBooleanField("startVMOnConnect", this.startVMOnConnect);
        jsonWriter.writeStringField("publicNetworkAccess",
            this.publicNetworkAccess == null ? null : this.publicNetworkAccess.toString());
        jsonWriter.writeJsonField("agentUpdate", this.agentUpdate);
        return jsonWriter.writeEndObject();
    }

    /**
     * Reads an instance of HostPoolPatchProperties from the JsonReader.
     * 
     * @param jsonReader The JsonReader being read.
     * @return An instance of HostPoolPatchProperties if the JsonReader was pointing to an instance of it, or null if it
     * was pointing to JSON null.
     * @throws IOException If an error occurs while reading the HostPoolPatchProperties.
     */
    public static HostPoolPatchProperties fromJson(JsonReader jsonReader) throws IOException {
        return jsonReader.readObject(reader -> {
            HostPoolPatchProperties deserializedHostPoolPatchProperties = new HostPoolPatchProperties();
            while (reader.nextToken() != JsonToken.END_OBJECT) {
                String fieldName = reader.getFieldName();
                reader.nextToken();

                if ("friendlyName".equals(fieldName)) {
                    deserializedHostPoolPatchProperties.friendlyName = reader.getString();
                } else if ("description".equals(fieldName)) {
                    deserializedHostPoolPatchProperties.description = reader.getString();
                } else if ("customRdpProperty".equals(fieldName)) {
                    deserializedHostPoolPatchProperties.customRdpProperty = reader.getString();
                } else if ("maxSessionLimit".equals(fieldName)) {
                    deserializedHostPoolPatchProperties.maxSessionLimit = reader.getNullable(JsonReader::getInt);
                } else if ("personalDesktopAssignmentType".equals(fieldName)) {
                    deserializedHostPoolPatchProperties.personalDesktopAssignmentType
                        = PersonalDesktopAssignmentType.fromString(reader.getString());
                } else if ("loadBalancerType".equals(fieldName)) {
                    deserializedHostPoolPatchProperties.loadBalancerType
                        = LoadBalancerType.fromString(reader.getString());
                } else if ("ring".equals(fieldName)) {
                    deserializedHostPoolPatchProperties.ring = reader.getNullable(JsonReader::getInt);
                } else if ("validationEnvironment".equals(fieldName)) {
                    deserializedHostPoolPatchProperties.validationEnvironment
                        = reader.getNullable(JsonReader::getBoolean);
                } else if ("registrationInfo".equals(fieldName)) {
                    deserializedHostPoolPatchProperties.registrationInfo = RegistrationInfoPatch.fromJson(reader);
                } else if ("vmTemplate".equals(fieldName)) {
                    deserializedHostPoolPatchProperties.vmTemplate = reader.getString();
                } else if ("ssoadfsAuthority".equals(fieldName)) {
                    deserializedHostPoolPatchProperties.ssoadfsAuthority = reader.getString();
                } else if ("ssoClientId".equals(fieldName)) {
                    deserializedHostPoolPatchProperties.ssoClientId = reader.getString();
                } else if ("ssoClientSecretKeyVaultPath".equals(fieldName)) {
                    deserializedHostPoolPatchProperties.ssoClientSecretKeyVaultPath = reader.getString();
                } else if ("ssoSecretType".equals(fieldName)) {
                    deserializedHostPoolPatchProperties.ssoSecretType = SsoSecretType.fromString(reader.getString());
                } else if ("preferredAppGroupType".equals(fieldName)) {
                    deserializedHostPoolPatchProperties.preferredAppGroupType
                        = PreferredAppGroupType.fromString(reader.getString());
                } else if ("startVMOnConnect".equals(fieldName)) {
                    deserializedHostPoolPatchProperties.startVMOnConnect = reader.getNullable(JsonReader::getBoolean);
                } else if ("publicNetworkAccess".equals(fieldName)) {
                    deserializedHostPoolPatchProperties.publicNetworkAccess
                        = HostpoolPublicNetworkAccess.fromString(reader.getString());
                } else if ("agentUpdate".equals(fieldName)) {
                    deserializedHostPoolPatchProperties.agentUpdate = AgentUpdatePatchProperties.fromJson(reader);
                } else {
                    reader.skipChildren();
                }
            }

            return deserializedHostPoolPatchProperties;
        });
    }
}