Package com.cloudera.cdp.environments.model

Class CreateAzureEnvironmentRequest

  • @Generated(value="com.cloudera.cdp.client.codegen.CdpSDKJavaCodegen",
           date="2024-06-05T15:30:58.948-07:00")
public class CreateAzureEnvironmentRequest
extends Object
    Request object for a create Azure environment request.

    • Constructor Detail

      • CreateAzureEnvironmentRequest

        public CreateAzureEnvironmentRequest()

    • Method Detail

      • getEnvironmentName

        public String getEnvironmentName()
        Getter for environmentName. The name of the environment. Must contain only lowercase letters, numbers and hyphens.

      • setEnvironmentName

        public void setEnvironmentName​(String environmentName)
        Setter for environmentName. The name of the environment. Must contain only lowercase letters, numbers and hyphens.

      • getCredentialName

        public String getCredentialName()
        Getter for credentialName. Name of the credential to use for the environment.

      • setCredentialName

        public void setCredentialName​(String credentialName)
        Setter for credentialName. Name of the credential to use for the environment.

      • getRegion

        public String getRegion()
        Getter for region. The region of the environment.

      • setRegion

        public void setRegion​(String region)
        Setter for region. The region of the environment.

      • getPublicKey

        public String getPublicKey()
        Getter for publicKey. Public SSH key string. The associated private key can be used to get root-level access to the Data Lake instance and Data Hub cluster instances.

      • setPublicKey

        public void setPublicKey​(String publicKey)
        Setter for publicKey. Public SSH key string. The associated private key can be used to get root-level access to the Data Lake instance and Data Hub cluster instances.

      • getSecurityAccess

        public SecurityAccessRequest getSecurityAccess()
        Getter for securityAccess. Security control for FreeIPA and Data Lake deployment.

      • setSecurityAccess

        public void setSecurityAccess​(SecurityAccessRequest securityAccess)
        Setter for securityAccess. Security control for FreeIPA and Data Lake deployment.

      • getUsePublicIp

        public Boolean getUsePublicIp()
        Getter for usePublicIp. Whether to associate public ip's to the resources within the network.

      • setUsePublicIp

        public void setUsePublicIp​(Boolean usePublicIp)
        Setter for usePublicIp. Whether to associate public ip's to the resources within the network.

      • getLogStorage

        public AzureLogStorageRequest getLogStorage()
        Getter for logStorage. Azure storage configuration for cluster and audit logs.

      • setLogStorage

        public void setLogStorage​(AzureLogStorageRequest logStorage)
        Setter for logStorage. Azure storage configuration for cluster and audit logs.

      • getExistingNetworkParams

        public ExistingAzureNetworkRequest getExistingNetworkParams()
        Getter for existingNetworkParams. Parameters needed to use an existing VNet and Subnets.

      • setExistingNetworkParams

        public void setExistingNetworkParams​(ExistingAzureNetworkRequest existingNetworkParams)
        Setter for existingNetworkParams. Parameters needed to use an existing VNet and Subnets.

      • getDescription

        public String getDescription()
        Getter for description. An description of the environment.

      • setDescription

        public void setDescription​(String description)
        Setter for description. An description of the environment.

      • getEnableTunnel

        public Boolean getEnableTunnel()
        Getter for enableTunnel. Whether to enable SSH tunneling for the environment.

      • setEnableTunnel

        public void setEnableTunnel​(Boolean enableTunnel)
        Setter for enableTunnel. Whether to enable SSH tunneling for the environment.

      • getWorkloadAnalytics

        public Boolean getWorkloadAnalytics()
        Getter for workloadAnalytics. When this is enabled, diagnostic information about job and query execution is sent to Workload Manager for Data Hub clusters created within this environment.

      • setWorkloadAnalytics

        public void setWorkloadAnalytics​(Boolean workloadAnalytics)
        Setter for workloadAnalytics. When this is enabled, diagnostic information about job and query execution is sent to Workload Manager for Data Hub clusters created within this environment.

      • getReportDeploymentLogs

        public Boolean getReportDeploymentLogs()
        Getter for reportDeploymentLogs. When true, this will report additional diagnostic information back to Cloudera.

      • setReportDeploymentLogs

        public void setReportDeploymentLogs​(Boolean reportDeploymentLogs)
        Setter for reportDeploymentLogs. When true, this will report additional diagnostic information back to Cloudera.

      • setFreeIpa

        public void setFreeIpa​(AzureFreeIpaCreationRequest freeIpa)
        Setter for freeIpa. The FreeIPA creation request for the environment

      • getImage

        public FreeIpaImageRequest getImage()
        Getter for image. The FreeIPA image request for the environment

      • setImage

        public void setImage​(FreeIpaImageRequest image)
        Setter for image. The FreeIPA image request for the environment

      • getTags

        public List<TagRequest> getTags()
        Getter for tags. Tags associated with the resources.

      • setTags

        public void setTags​(List<TagRequest> tags)
        Setter for tags. Tags associated with the resources.

      • getProxyConfigName

        public String getProxyConfigName()
        Getter for proxyConfigName. Name of the proxy config to use for the environment.

      • setProxyConfigName

        public void setProxyConfigName​(String proxyConfigName)
        Setter for proxyConfigName. Name of the proxy config to use for the environment.

      • getResourceGroupName

        public String getResourceGroupName()
        Getter for resourceGroupName. Name of an existing Azure resource group to be used for the environment. If it is not specified then new resource groups will be generated.

      • setResourceGroupName

        public void setResourceGroupName​(String resourceGroupName)
        Setter for resourceGroupName. Name of an existing Azure resource group to be used for the environment. If it is not specified then new resource groups will be generated.

      • getCreatePrivateEndpoints

        public Boolean getCreatePrivateEndpoints()
        Getter for createPrivateEndpoints. When this is enabled, then Azure Postgres will be configured with Private Endpoint and a Private DNS Zone. When this is disabled, then Azure Service Endpoints will be created. The default value is disabled.

      • setCreatePrivateEndpoints

        public void setCreatePrivateEndpoints​(Boolean createPrivateEndpoints)
        Setter for createPrivateEndpoints. When this is enabled, then Azure Postgres will be configured with Private Endpoint and a Private DNS Zone. When this is disabled, then Azure Service Endpoints will be created. The default value is disabled.

      • getEndpointAccessGatewayScheme

        public String getEndpointAccessGatewayScheme()
        Getter for endpointAccessGatewayScheme. The scheme for the endpoint gateway. PUBLIC creates an external endpoint that can be accessed over the Internet. Defaults to PRIVATE which restricts the traffic to be internal to the VNet.

      • setEndpointAccessGatewayScheme

        public void setEndpointAccessGatewayScheme​(String endpointAccessGatewayScheme)
        Setter for endpointAccessGatewayScheme. The scheme for the endpoint gateway. PUBLIC creates an external endpoint that can be accessed over the Internet. Defaults to PRIVATE which restricts the traffic to be internal to the VNet.

      • getEndpointAccessGatewaySubnetIds

        public List<String> getEndpointAccessGatewaySubnetIds()
        Getter for endpointAccessGatewaySubnetIds. The subnets to use for endpoint access gateway.

      • setEndpointAccessGatewaySubnetIds

        public void setEndpointAccessGatewaySubnetIds​(List<String> endpointAccessGatewaySubnetIds)
        Setter for endpointAccessGatewaySubnetIds. The subnets to use for endpoint access gateway.

      • getEncryptionAtHost

        public Boolean getEncryptionAtHost()
        Getter for encryptionAtHost. When this is enabled, we will provision resources with host encrypted true flag.

      • setEncryptionAtHost

        public void setEncryptionAtHost​(Boolean encryptionAtHost)
        Setter for encryptionAtHost. When this is enabled, we will provision resources with host encrypted true flag.

      • getUserManagedIdentity

        @Deprecated
public String getUserManagedIdentity()
        Deprecated.
        Getter for userManagedIdentity. User managed identity for encryption. (deprecated)

      • setUserManagedIdentity

        @Deprecated
public void setUserManagedIdentity​(String userManagedIdentity)
        Deprecated.
        Setter for userManagedIdentity. User managed identity for encryption. (deprecated)

      • getEncryptionUserManagedIdentity

        public String getEncryptionUserManagedIdentity()
        Getter for encryptionUserManagedIdentity. User managed identity for encryption.

      • setEncryptionUserManagedIdentity

        public void setEncryptionUserManagedIdentity​(String encryptionUserManagedIdentity)
        Setter for encryptionUserManagedIdentity. User managed identity for encryption.

      • getEncryptionKeyUrl

        public String getEncryptionKeyUrl()
        Getter for encryptionKeyUrl. URL of the key which will be used to encrypt the Azure Managed Disks, if entitlement has been granted.

      • setEncryptionKeyUrl

        public void setEncryptionKeyUrl​(String encryptionKeyUrl)
        Setter for encryptionKeyUrl. URL of the key which will be used to encrypt the Azure Managed Disks, if entitlement has been granted.

      • getEncryptionKeyResourceGroupName

        public String getEncryptionKeyResourceGroupName()
        Getter for encryptionKeyResourceGroupName. Name of the existing Azure resource group hosting the Azure Key Vault containing customer managed key which will be used to encrypt the Azure Managed Disks. It is required only when the entitlement is granted and the resource group of the key vault is different from the resource group in which the environment is to be created. Omitting it implies that, the key vault containing the encryption key is present in the same resource group where the environment would be created.

      • setEncryptionKeyResourceGroupName

        public void setEncryptionKeyResourceGroupName​(String encryptionKeyResourceGroupName)
        Setter for encryptionKeyResourceGroupName. Name of the existing Azure resource group hosting the Azure Key Vault containing customer managed key which will be used to encrypt the Azure Managed Disks. It is required only when the entitlement is granted and the resource group of the key vault is different from the resource group in which the environment is to be created. Omitting it implies that, the key vault containing the encryption key is present in the same resource group where the environment would be created.

      • getEnableOutboundLoadBalancer

        public Boolean getEnableOutboundLoadBalancer()
        Getter for enableOutboundLoadBalancer. Whether or not outbound load balancers should be created for Azure environments. The default behavior is to not create the outbound load balancer.

      • setEnableOutboundLoadBalancer

        public void setEnableOutboundLoadBalancer​(Boolean enableOutboundLoadBalancer)
        Setter for enableOutboundLoadBalancer. Whether or not outbound load balancers should be created for Azure environments. The default behavior is to not create the outbound load balancer.

      • getAvailabilityZones

        public List<String> getAvailabilityZones()
        Getter for availabilityZones. The zones of the environment in the given region.

      • setAvailabilityZones

        public void setAvailabilityZones​(List<String> availabilityZones)
        Setter for availabilityZones. The zones of the environment in the given region.

      • getFlexibleServerSubnetIds

        public List<String> getFlexibleServerSubnetIds()
        Getter for flexibleServerSubnetIds. The subnets delegated for Flexible Server database. Accepts either the name or the full resource id.

      • setFlexibleServerSubnetIds

        public void setFlexibleServerSubnetIds​(List<String> flexibleServerSubnetIds)
        Setter for flexibleServerSubnetIds. The subnets delegated for Flexible Server database. Accepts either the name or the full resource id.

      • getDataServices

        public DataServicesRequest getDataServices()
        Getter for dataServices. Data Services parameters of the environment.

      • setDataServices

        public void setDataServices​(DataServicesRequest dataServices)
        Setter for dataServices. Data Services parameters of the environment.

      • getCustomDockerRegistry

        public CustomDockerRegistryRequest getCustomDockerRegistry()
        Getter for customDockerRegistry. Configures the desired custom docker registry for data services.

      • setCustomDockerRegistry

        public void setCustomDockerRegistry​(CustomDockerRegistryRequest customDockerRegistry)
        Setter for customDockerRegistry. Configures the desired custom docker registry for data services.

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object