com.azure.ai.metricsadvisor.administration.models.DataSourceServicePrincipalInKeyVault Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-ai-metricsadvisor Show documentation
This package contains the Microsoft Azure Cognitive Services Metrics Advisor SDK.
The newest version!
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.azure.ai.metricsadvisor.administration.models;

import com.azure.ai.metricsadvisor.implementation.util.DataSourceServicePrincipalInKeyVaultAccessor;
import com.azure.core.annotation.Fluent;

/**
 * The service principal stored in a key vault representing the credential entity for a data source.
 */
@Fluent
public final class DataSourceServicePrincipalInKeyVault extends DataSourceCredentialEntity {
    private String id;
    private String name;
    private String description;
    private String keyVaultEndpoint;
    private String keyVaultClientId;
    private String keyVaultClientSecret;
    private String clientIdSecretName;
    private String clientSecretName;
    private String tenantId;

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

    static {
        DataSourceServicePrincipalInKeyVaultAccessor
            .setAccessor(new DataSourceServicePrincipalInKeyVaultAccessor.Accessor() {
                @Override
                public void setId(DataSourceServicePrincipalInKeyVault entity, String id) {
                    entity.setId(id);
                }

                @Override
                public String getKeyVaultClientSecret(DataSourceServicePrincipalInKeyVault entity) {
                    return entity.getKeyVaultClientSecret();
                }
            });
    }

    @Override
    public String getId() {
        return this.id;
    }

    @Override
    public String getName() {
        return this.name;
    }

    @Override
    public String getDescription() {
        return this.description;
    }

    /**
     * Gets the endpoint to the KeyVault storing service principal.
     *
     * @return The KeyVault endpoint.
     */
    public String getKeyVaultEndpoint() {
        return this.keyVaultEndpoint;
    }

    /**
     * Gets the client id to access the KeyVault storing service principal.
     *
     * @return The client id to access the KeyVault.
     */
    public String getKeyVaultClientId() {
        return this.keyVaultClientId;
    }

    /**
     * Gets the tenant id of the service principal.
     *
     * @return The tenant id.
     */
    public String getTenantId() {
        return this.tenantId;
    }

    /**
     * Gets the name of the KeyVault secret holding client secret.
     *
     * @return The name of the KeyVault secret holding client secret
     */
    public String getSecretNameForDataSourceClientId() {
        return this.clientIdSecretName;
    }

    /**
     * Gets the name of the KeyVault secret holding client secret.
     *
     * @return The name of the KeyVault secret holding client secret
     */
    public String getSecretNameForDataSourceClientSecret() {
        return this.clientSecretName;
    }

    /**
     * Sets the name.
     *
     * @param name The name
     * @return an updated object with name set
     */
    public DataSourceServicePrincipalInKeyVault setName(String name) {
        this.name = name;
        return this;
    }

    /**
     * Sets the keyVault containing the data source secrets.
     *
     * @param keyVaultEndpoint The keyVault endpoint
     * @param keyVaultClientId The client  id to access the keyVault
     * @param keyVaultClientSecret The client secret to access the keyVault
     * @return an updated object
     */
    public DataSourceServicePrincipalInKeyVault setKeyVaultForDataSourceSecrets(String keyVaultEndpoint,
        String keyVaultClientId, String keyVaultClientSecret) {
        this.keyVaultEndpoint = keyVaultEndpoint;
        this.keyVaultClientId = keyVaultClientId;
        this.keyVaultClientSecret = keyVaultClientSecret;
        return this;
    }

    /**
     * Sets the name of the keyvault secret holding client id.
     *
     * @param clientIdSecretName The secret name
     * @return an updated object with client id secret name set
     */
    public DataSourceServicePrincipalInKeyVault setSecretNameForDataSourceClientId(String clientIdSecretName) {
        this.clientIdSecretName = clientIdSecretName;
        return this;
    }

    /**
     * Sets the name of the keyvault secret holding client secret.
     *
     * @param clientSecretName The secret name
     * @return an updated object with client secret name set
     */
    public DataSourceServicePrincipalInKeyVault setSecretNameForDataSourceClientSecret(String clientSecretName) {
        this.clientSecretName = clientSecretName;
        return this;
    }

    /**
     * Sets the tenant id.
     *
     * @param tenantId The tenant id
     * @return an updated object with client tenant id set
     */
    public DataSourceServicePrincipalInKeyVault setTenantId(String tenantId) {
        this.tenantId = tenantId;
        return this;
    }

    /**
     * Sets the description.
     *
     * @param description The description
     * @return an updated object with description set
     */
    public DataSourceServicePrincipalInKeyVault setDescription(String description) {
        this.description = description;
        return this;
    }

    private void setId(String id) {
        this.id = id;
    }

    private String getKeyVaultClientSecret() {
        return this.keyVaultClientSecret;
    }
}