All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • com.pulumi.azurenative.datafactory.outputs.RestServiceLinkedServiceResponse Maven / Gradle / Ivy

    There is a newer version: 2.72.0
    Show newest version
    // *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***

package com.pulumi.azurenative.datafactory.outputs;

import com.pulumi.azurenative.datafactory.outputs.AzureKeyVaultSecretReferenceResponse;
import com.pulumi.azurenative.datafactory.outputs.CredentialReferenceResponse;
import com.pulumi.azurenative.datafactory.outputs.IntegrationRuntimeReferenceResponse;
import com.pulumi.azurenative.datafactory.outputs.ParameterSpecificationResponse;
import com.pulumi.azurenative.datafactory.outputs.SecureStringResponse;
import com.pulumi.core.Either;
import com.pulumi.core.annotations.CustomType;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.Object;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;

@CustomType
public final class RestServiceLinkedServiceResponse {
    /**
     * @return The resource you are requesting authorization to use. Type: string (or Expression with resultType string).
     * 
     */
    private @Nullable Object aadResourceId;
    /**
     * @return List of tags that can be used for describing the linked service.
     * 
     */
    private @Nullable List annotations;
    /**
     * @return The additional HTTP headers in the request to RESTful API used for authorization. Type: object (or Expression with resultType object).
     * 
     */
    private @Nullable Object authHeaders;
    /**
     * @return Type of authentication used to connect to the REST service.
     * 
     */
    private String authenticationType;
    /**
     * @return Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).
     * 
     */
    private @Nullable Object azureCloudType;
    /**
     * @return The client ID associated with your application. Type: string (or Expression with resultType string).
     * 
     */
    private @Nullable Object clientId;
    /**
     * @return The client secret associated with your application.
     * 
     */
    private @Nullable Either clientSecret;
    /**
     * @return The integration runtime reference.
     * 
     */
    private @Nullable IntegrationRuntimeReferenceResponse connectVia;
    /**
     * @return The credential reference containing authentication information.
     * 
     */
    private @Nullable CredentialReferenceResponse credential;
    /**
     * @return Linked service description.
     * 
     */
    private @Nullable String description;
    /**
     * @return Whether to validate server side SSL certificate when connecting to the endpoint.The default value is true. Type: boolean (or Expression with resultType boolean).
     * 
     */
    private @Nullable Object enableServerCertificateValidation;
    /**
     * @return The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
     * 
     */
    private @Nullable String encryptedCredential;
    /**
     * @return Parameters for linked service.
     * 
     */
    private @Nullable Map parameters;
    /**
     * @return The password used in Basic authentication type.
     * 
     */
    private @Nullable Either password;
    /**
     * @return The target service or resource to which the access will be requested. Type: string (or Expression with resultType string).
     * 
     */
    private @Nullable Object resource;
    /**
     * @return The scope of the access required. It describes what kind of access will be requested. Type: string (or Expression with resultType string).
     * 
     */
    private @Nullable Object scope;
    /**
     * @return The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).
     * 
     */
    private @Nullable Object servicePrincipalCredentialType;
    /**
     * @return Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).
     * 
     */
    private @Nullable Either servicePrincipalEmbeddedCert;
    /**
     * @return Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string).
     * 
     */
    private @Nullable Either servicePrincipalEmbeddedCertPassword;
    /**
     * @return The application's client ID used in AadServicePrincipal authentication type. Type: string (or Expression with resultType string).
     * 
     */
    private @Nullable Object servicePrincipalId;
    /**
     * @return The application's key used in AadServicePrincipal authentication type.
     * 
     */
    private @Nullable Either servicePrincipalKey;
    /**
     * @return The tenant information (domain name or tenant ID) used in AadServicePrincipal authentication type under which your application resides. Type: string (or Expression with resultType string).
     * 
     */
    private @Nullable Object tenant;
    /**
     * @return The token endpoint of the authorization server to acquire access token. Type: string (or Expression with resultType string).
     * 
     */
    private @Nullable Object tokenEndpoint;
    /**
     * @return Type of linked service.
     * Expected value is 'RestService'.
     * 
     */
    private String type;
    /**
     * @return The base URL of the REST service. Type: string (or Expression with resultType string).
     * 
     */
    private Object url;
    /**
     * @return The user name used in Basic authentication type. Type: string (or Expression with resultType string).
     * 
     */
    private @Nullable Object userName;
    /**
     * @return Version of the linked service.
     * 
     */
    private @Nullable String version;

    private RestServiceLinkedServiceResponse() {}
    /**
     * @return The resource you are requesting authorization to use. Type: string (or Expression with resultType string).
     * 
     */
    public Optional aadResourceId() {
        return Optional.ofNullable(this.aadResourceId);
    }
    /**
     * @return List of tags that can be used for describing the linked service.
     * 
     */
    public List annotations() {
        return this.annotations == null ? List.of() : this.annotations;
    }
    /**
     * @return The additional HTTP headers in the request to RESTful API used for authorization. Type: object (or Expression with resultType object).
     * 
     */
    public Optional authHeaders() {
        return Optional.ofNullable(this.authHeaders);
    }
    /**
     * @return Type of authentication used to connect to the REST service.
     * 
     */
    public String authenticationType() {
        return this.authenticationType;
    }
    /**
     * @return Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string).
     * 
     */
    public Optional azureCloudType() {
        return Optional.ofNullable(this.azureCloudType);
    }
    /**
     * @return The client ID associated with your application. Type: string (or Expression with resultType string).
     * 
     */
    public Optional clientId() {
        return Optional.ofNullable(this.clientId);
    }
    /**
     * @return The client secret associated with your application.
     * 
     */
    public Optional> clientSecret() {
        return Optional.ofNullable(this.clientSecret);
    }
    /**
     * @return The integration runtime reference.
     * 
     */
    public Optional connectVia() {
        return Optional.ofNullable(this.connectVia);
    }
    /**
     * @return The credential reference containing authentication information.
     * 
     */
    public Optional credential() {
        return Optional.ofNullable(this.credential);
    }
    /**
     * @return Linked service description.
     * 
     */
    public Optional description() {
        return Optional.ofNullable(this.description);
    }
    /**
     * @return Whether to validate server side SSL certificate when connecting to the endpoint.The default value is true. Type: boolean (or Expression with resultType boolean).
     * 
     */
    public Optional enableServerCertificateValidation() {
        return Optional.ofNullable(this.enableServerCertificateValidation);
    }
    /**
     * @return The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.
     * 
     */
    public Optional encryptedCredential() {
        return Optional.ofNullable(this.encryptedCredential);
    }
    /**
     * @return Parameters for linked service.
     * 
     */
    public Map parameters() {
        return this.parameters == null ? Map.of() : this.parameters;
    }
    /**
     * @return The password used in Basic authentication type.
     * 
     */
    public Optional> password() {
        return Optional.ofNullable(this.password);
    }
    /**
     * @return The target service or resource to which the access will be requested. Type: string (or Expression with resultType string).
     * 
     */
    public Optional resource() {
        return Optional.ofNullable(this.resource);
    }
    /**
     * @return The scope of the access required. It describes what kind of access will be requested. Type: string (or Expression with resultType string).
     * 
     */
    public Optional scope() {
        return Optional.ofNullable(this.scope);
    }
    /**
     * @return The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string).
     * 
     */
    public Optional servicePrincipalCredentialType() {
        return Optional.ofNullable(this.servicePrincipalCredentialType);
    }
    /**
     * @return Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).
     * 
     */
    public Optional> servicePrincipalEmbeddedCert() {
        return Optional.ofNullable(this.servicePrincipalEmbeddedCert);
    }
    /**
     * @return Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string).
     * 
     */
    public Optional> servicePrincipalEmbeddedCertPassword() {
        return Optional.ofNullable(this.servicePrincipalEmbeddedCertPassword);
    }
    /**
     * @return The application's client ID used in AadServicePrincipal authentication type. Type: string (or Expression with resultType string).
     * 
     */
    public Optional servicePrincipalId() {
        return Optional.ofNullable(this.servicePrincipalId);
    }
    /**
     * @return The application's key used in AadServicePrincipal authentication type.
     * 
     */
    public Optional> servicePrincipalKey() {
        return Optional.ofNullable(this.servicePrincipalKey);
    }
    /**
     * @return The tenant information (domain name or tenant ID) used in AadServicePrincipal authentication type under which your application resides. Type: string (or Expression with resultType string).
     * 
     */
    public Optional tenant() {
        return Optional.ofNullable(this.tenant);
    }
    /**
     * @return The token endpoint of the authorization server to acquire access token. Type: string (or Expression with resultType string).
     * 
     */
    public Optional tokenEndpoint() {
        return Optional.ofNullable(this.tokenEndpoint);
    }
    /**
     * @return Type of linked service.
     * Expected value is 'RestService'.
     * 
     */
    public String type() {
        return this.type;
    }
    /**
     * @return The base URL of the REST service. Type: string (or Expression with resultType string).
     * 
     */
    public Object url() {
        return this.url;
    }
    /**
     * @return The user name used in Basic authentication type. Type: string (or Expression with resultType string).
     * 
     */
    public Optional userName() {
        return Optional.ofNullable(this.userName);
    }
    /**
     * @return Version of the linked service.
     * 
     */
    public Optional version() {
        return Optional.ofNullable(this.version);
    }

    public static Builder builder() {
        return new Builder();
    }

    public static Builder builder(RestServiceLinkedServiceResponse defaults) {
        return new Builder(defaults);
    }
    @CustomType.Builder
    public static final class Builder {
        private @Nullable Object aadResourceId;
        private @Nullable List annotations;
        private @Nullable Object authHeaders;
        private String authenticationType;
        private @Nullable Object azureCloudType;
        private @Nullable Object clientId;
        private @Nullable Either clientSecret;
        private @Nullable IntegrationRuntimeReferenceResponse connectVia;
        private @Nullable CredentialReferenceResponse credential;
        private @Nullable String description;
        private @Nullable Object enableServerCertificateValidation;
        private @Nullable String encryptedCredential;
        private @Nullable Map parameters;
        private @Nullable Either password;
        private @Nullable Object resource;
        private @Nullable Object scope;
        private @Nullable Object servicePrincipalCredentialType;
        private @Nullable Either servicePrincipalEmbeddedCert;
        private @Nullable Either servicePrincipalEmbeddedCertPassword;
        private @Nullable Object servicePrincipalId;
        private @Nullable Either servicePrincipalKey;
        private @Nullable Object tenant;
        private @Nullable Object tokenEndpoint;
        private String type;
        private Object url;
        private @Nullable Object userName;
        private @Nullable String version;
        public Builder() {}
        public Builder(RestServiceLinkedServiceResponse defaults) {
    	      Objects.requireNonNull(defaults);
    	      this.aadResourceId = defaults.aadResourceId;
    	      this.annotations = defaults.annotations;
    	      this.authHeaders = defaults.authHeaders;
    	      this.authenticationType = defaults.authenticationType;
    	      this.azureCloudType = defaults.azureCloudType;
    	      this.clientId = defaults.clientId;
    	      this.clientSecret = defaults.clientSecret;
    	      this.connectVia = defaults.connectVia;
    	      this.credential = defaults.credential;
    	      this.description = defaults.description;
    	      this.enableServerCertificateValidation = defaults.enableServerCertificateValidation;
    	      this.encryptedCredential = defaults.encryptedCredential;
    	      this.parameters = defaults.parameters;
    	      this.password = defaults.password;
    	      this.resource = defaults.resource;
    	      this.scope = defaults.scope;
    	      this.servicePrincipalCredentialType = defaults.servicePrincipalCredentialType;
    	      this.servicePrincipalEmbeddedCert = defaults.servicePrincipalEmbeddedCert;
    	      this.servicePrincipalEmbeddedCertPassword = defaults.servicePrincipalEmbeddedCertPassword;
    	      this.servicePrincipalId = defaults.servicePrincipalId;
    	      this.servicePrincipalKey = defaults.servicePrincipalKey;
    	      this.tenant = defaults.tenant;
    	      this.tokenEndpoint = defaults.tokenEndpoint;
    	      this.type = defaults.type;
    	      this.url = defaults.url;
    	      this.userName = defaults.userName;
    	      this.version = defaults.version;
        }

        @CustomType.Setter
        public Builder aadResourceId(@Nullable Object aadResourceId) {

            this.aadResourceId = aadResourceId;
            return this;
        }
        @CustomType.Setter
        public Builder annotations(@Nullable List annotations) {

            this.annotations = annotations;
            return this;
        }
        public Builder annotations(Object... annotations) {
            return annotations(List.of(annotations));
        }
        @CustomType.Setter
        public Builder authHeaders(@Nullable Object authHeaders) {

            this.authHeaders = authHeaders;
            return this;
        }
        @CustomType.Setter
        public Builder authenticationType(String authenticationType) {
            if (authenticationType == null) {
              throw new MissingRequiredPropertyException("RestServiceLinkedServiceResponse", "authenticationType");
            }
            this.authenticationType = authenticationType;
            return this;
        }
        @CustomType.Setter
        public Builder azureCloudType(@Nullable Object azureCloudType) {

            this.azureCloudType = azureCloudType;
            return this;
        }
        @CustomType.Setter
        public Builder clientId(@Nullable Object clientId) {

            this.clientId = clientId;
            return this;
        }
        @CustomType.Setter
        public Builder clientSecret(@Nullable Either clientSecret) {

            this.clientSecret = clientSecret;
            return this;
        }
        @CustomType.Setter
        public Builder connectVia(@Nullable IntegrationRuntimeReferenceResponse connectVia) {

            this.connectVia = connectVia;
            return this;
        }
        @CustomType.Setter
        public Builder credential(@Nullable CredentialReferenceResponse credential) {

            this.credential = credential;
            return this;
        }
        @CustomType.Setter
        public Builder description(@Nullable String description) {

            this.description = description;
            return this;
        }
        @CustomType.Setter
        public Builder enableServerCertificateValidation(@Nullable Object enableServerCertificateValidation) {

            this.enableServerCertificateValidation = enableServerCertificateValidation;
            return this;
        }
        @CustomType.Setter
        public Builder encryptedCredential(@Nullable String encryptedCredential) {

            this.encryptedCredential = encryptedCredential;
            return this;
        }
        @CustomType.Setter
        public Builder parameters(@Nullable Map parameters) {

            this.parameters = parameters;
            return this;
        }
        @CustomType.Setter
        public Builder password(@Nullable Either password) {

            this.password = password;
            return this;
        }
        @CustomType.Setter
        public Builder resource(@Nullable Object resource) {

            this.resource = resource;
            return this;
        }
        @CustomType.Setter
        public Builder scope(@Nullable Object scope) {

            this.scope = scope;
            return this;
        }
        @CustomType.Setter
        public Builder servicePrincipalCredentialType(@Nullable Object servicePrincipalCredentialType) {

            this.servicePrincipalCredentialType = servicePrincipalCredentialType;
            return this;
        }
        @CustomType.Setter
        public Builder servicePrincipalEmbeddedCert(@Nullable Either servicePrincipalEmbeddedCert) {

            this.servicePrincipalEmbeddedCert = servicePrincipalEmbeddedCert;
            return this;
        }
        @CustomType.Setter
        public Builder servicePrincipalEmbeddedCertPassword(@Nullable Either servicePrincipalEmbeddedCertPassword) {

            this.servicePrincipalEmbeddedCertPassword = servicePrincipalEmbeddedCertPassword;
            return this;
        }
        @CustomType.Setter
        public Builder servicePrincipalId(@Nullable Object servicePrincipalId) {

            this.servicePrincipalId = servicePrincipalId;
            return this;
        }
        @CustomType.Setter
        public Builder servicePrincipalKey(@Nullable Either servicePrincipalKey) {

            this.servicePrincipalKey = servicePrincipalKey;
            return this;
        }
        @CustomType.Setter
        public Builder tenant(@Nullable Object tenant) {

            this.tenant = tenant;
            return this;
        }
        @CustomType.Setter
        public Builder tokenEndpoint(@Nullable Object tokenEndpoint) {

            this.tokenEndpoint = tokenEndpoint;
            return this;
        }
        @CustomType.Setter
        public Builder type(String type) {
            if (type == null) {
              throw new MissingRequiredPropertyException("RestServiceLinkedServiceResponse", "type");
            }
            this.type = type;
            return this;
        }
        @CustomType.Setter
        public Builder url(Object url) {
            if (url == null) {
              throw new MissingRequiredPropertyException("RestServiceLinkedServiceResponse", "url");
            }
            this.url = url;
            return this;
        }
        @CustomType.Setter
        public Builder userName(@Nullable Object userName) {

            this.userName = userName;
            return this;
        }
        @CustomType.Setter
        public Builder version(@Nullable String version) {

            this.version = version;
            return this;
        }
        public RestServiceLinkedServiceResponse build() {
            final var _resultValue = new RestServiceLinkedServiceResponse();
            _resultValue.aadResourceId = aadResourceId;
            _resultValue.annotations = annotations;
            _resultValue.authHeaders = authHeaders;
            _resultValue.authenticationType = authenticationType;
            _resultValue.azureCloudType = azureCloudType;
            _resultValue.clientId = clientId;
            _resultValue.clientSecret = clientSecret;
            _resultValue.connectVia = connectVia;
            _resultValue.credential = credential;
            _resultValue.description = description;
            _resultValue.enableServerCertificateValidation = enableServerCertificateValidation;
            _resultValue.encryptedCredential = encryptedCredential;
            _resultValue.parameters = parameters;
            _resultValue.password = password;
            _resultValue.resource = resource;
            _resultValue.scope = scope;
            _resultValue.servicePrincipalCredentialType = servicePrincipalCredentialType;
            _resultValue.servicePrincipalEmbeddedCert = servicePrincipalEmbeddedCert;
            _resultValue.servicePrincipalEmbeddedCertPassword = servicePrincipalEmbeddedCertPassword;
            _resultValue.servicePrincipalId = servicePrincipalId;
            _resultValue.servicePrincipalKey = servicePrincipalKey;
            _resultValue.tenant = tenant;
            _resultValue.tokenEndpoint = tokenEndpoint;
            _resultValue.type = type;
            _resultValue.url = url;
            _resultValue.userName = userName;
            _resultValue.version = version;
            return _resultValue;
        }
    }
}
    
    
    
    

    




    
    
    © 2015 - 2024 Weber Informatics LLC | Privacy Policy