java.lang.Object
- com.cloudera.cdp.client.CdpClient
- - com.cloudera.cdp.environments.api.EnvironmentsClient

@Generated(value="com.cloudera.cdp.client.codegen.CdpSDKJavaCodegen",
           date="2023-09-14T10:47:18.529-07:00")
public class EnvironmentsClient
extends CdpClient

Field Summary

Fields
Modifier and Type Field Description

static String SERVICE_NAME
- Fields inherited from class com.cloudera.cdp.client.CdpClient
  NO_EXTENSION

Constructor Summary

Constructors
Constructor	Description
`EnvironmentsClient(CdpCredentials credentials, String endPoint, CdpClientConfiguration clientConfiguration)`
`EnvironmentsClient(CdpRequestContext<?> context)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`AttachFreeIpaRecipesResponse`	`attachFreeIpaRecipes(AttachFreeIpaRecipesRequest input)`	Attach recipes to FreeIPA.
`CancelFreeipaDiagnosticsResponse`	`cancelFreeipaDiagnostics(CancelFreeipaDiagnosticsRequest input)`	Cancel running FreeIPA diagnostics collections
`ChangeEnvironmentCredentialResponse`	`changeEnvironmentCredential(ChangeEnvironmentCredentialRequest input)`	Changes the credential for an environment.
`CheckDatabaseConnectivityResponse`	`checkDatabaseConnectivity(CheckDatabaseConnectivityRequest input)`	Checks Database connectivity based on the input parameters.
`CheckEnvironmentConnectivityResponse`	`checkEnvironmentConnectivity(CheckEnvironmentConnectivityRequest input)`	Checks connectivity to a new Private Cloud environment by trying to access the Cloudera Manager address with provided credentials.
`CheckKubernetesConnectivityResponse`	`checkKubernetesConnectivity(CheckKubernetesConnectivityRequest input)`	Checks connectivity to a Kubernetes address with provided kubeconfig files.
`CollectFreeipaDiagnosticsResponse`	`collectFreeipaDiagnostics(CollectFreeipaDiagnosticsRequest input)`	Start FreeIPA diagnostics collection
`CreateAWSCredentialResponse`	`createAWSCredential(CreateAWSCredentialRequest input)`	Creates a new AWS credential that can be attatched to an environment.
`CreateAWSEnvironmentResponse`	`createAWSEnvironment(CreateAWSEnvironmentRequest input)`	Creates a new AWS environment by providing the cloud provider access and network information.
`CreateAWSGovCloudCredentialResponse`	`createAWSGovCloudCredential(CreateAWSGovCloudCredentialRequest input)`	Creates a new AWS credential for GovCloud that can be attatched to an environment.
`CreateAWSGovCloudEnvironmentResponse`	`createAWSGovCloudEnvironment(CreateAWSGovCloudEnvironmentRequest input)`	Creates a new AWS GovCloud environment by providing the cloud provider access and network information.
`CreateAzureCredentialResponse`	`createAzureCredential(CreateAzureCredentialRequest input)`	Creates a new Azure credential that can be attached to an environment.
`CreateAzureEnvironmentResponse`	`createAzureEnvironment(CreateAzureEnvironmentRequest input)`	Creates a new Azure environment by providing the cloud provider access and network information.
`CreateGCPCredentialResponse`	`createGCPCredential(CreateGCPCredentialRequest input)`	Creates a new GCP credential that can be attatched to an environment.
`CreateGCPEnvironmentResponse`	`createGCPEnvironment(CreateGCPEnvironmentRequest input)`	Creates a new GCP environment by providing the cloud provider access and network information.
`CreatePrivateEnvironmentResponse`	`createPrivateEnvironment(CreatePrivateEnvironmentRequest input)`	Creates a new Private Cloud environment by providing the Cloudera Manager address and credentials.
`CreateProxyConfigResponse`	`createProxyConfig(CreateProxyConfigRequest input)`	Creates a new proxy config that can be attatched to an environment.
`DeleteAuditCredentialResponse`	`deleteAuditCredential(DeleteAuditCredentialRequest input)`	Deletes an audit credential.
`DeleteCredentialResponse`	`deleteCredential(DeleteCredentialRequest input)`	Deletes a credential.
`DeleteEnvironmentResponse`	`deleteEnvironment(DeleteEnvironmentRequest input)`	Deletes an environment.
`DeleteProxyConfigResponse`	`deleteProxyConfig(DeleteProxyConfigRequest input)`	Deletes a proxy config.
`DescribeEnvironmentResponse`	`describeEnvironment(DescribeEnvironmentRequest input)`	Describes an environment.
`DetachFreeIpaRecipesResponse`	`detachFreeIpaRecipes(DetachFreeIpaRecipesRequest input)`	Detach recipes from FreeIPA.
`DownscaleFreeipaResponse`	`downscaleFreeipa(DownscaleFreeipaRequest input)`	Downscales FreeIPA instances.
`GetAccountTelemetryResponse`	`getAccountTelemetry(GetAccountTelemetryRequest input)`	Get account level telemetry settings.
`GetAccountTelemetryDefaultResponse`	`getAccountTelemetryDefault(GetAccountTelemetryDefaultRequest input)`	Get default account level telemetry settings.
`GetAuditCredentialPrerequisitesResponse`	`getAuditCredentialPrerequisites(GetAuditCredentialPrerequisitesRequest input)`	This API provides the audit credential prerequisites for the given cloud provider.
`GetCredentialPrerequisitesResponse`	`getCredentialPrerequisites(GetCredentialPrerequisitesRequest input)`	This API provides the credential prerequisites for the given cloud provider.
`GetEnvironmentSettingResponse`	`getEnvironmentSetting(GetEnvironmentSettingRequest input)`	Read a configuration setting from the environment service.
`GetEnvironmentUserSyncStateResponse`	`getEnvironmentUserSyncState(GetEnvironmentUserSyncStateRequest input)`	Returns the user synchronization state for an environment.
`GetFreeipaLogDescriptorsResponse`	`getFreeipaLogDescriptors(GetFreeipaLogDescriptorsRequest input)`	Gather log descriptors that are used for diagnostics collection.
`GetFreeipaStatusResponse`	`getFreeipaStatus(GetFreeipaStatusRequest input)`	Get the status of the FreeIPA services
`GetGovCloudAuditCredentialPrerequisitesResponse`	`getGovCloudAuditCredentialPrerequisites(GetGovCloudAuditCredentialPrerequisitesRequest input)`	This API provides the audit credential prerequisites for GovCloud for the enabled providers.
`GetGovCloudCredentialPrerequisitesResponse`	`getGovCloudCredentialPrerequisites(GetGovCloudCredentialPrerequisitesRequest input)`	This API provides the credential prerequisites for GovCloud for the enabled providers.
`GetIdBrokerMappingsResponse`	`getIdBrokerMappings(GetIdBrokerMappingsRequest input)`	Gets all ID Broker mappings for an environment.
`GetIdBrokerMappingsSyncStatusResponse`	`getIdBrokerMappingsSyncStatus(GetIdBrokerMappingsSyncStatusRequest input)`	Gets ID Broker mappings sync status.
`GetKeytabResponse`	`getKeytab(GetKeytabRequest input)`	Retrieves a keytab for a user or machine user.
`GetOperationResponse`	`getOperation(GetOperationRequest input)`	Get the latest (in progress or finished) operation for the environment resource.
`GetRepairFreeipaStatusResponse`	`getRepairFreeipaStatus(GetRepairFreeipaStatusRequest input)`	Returns status of the repair operation for the operation id.
`protected String`	`getRequestContentType()`	Gets the request Content-Type, used by 'Conent-Type' request header.
`protected String`	`getResponseContentType()`	Gets the expected response Content-Type, used by 'Accept' request header.
`GetRootCertificateResponse`	`getRootCertificate(GetRootCertificateRequest input)`	This API provides contents of public certificate for an environment.
`protected String`	`getServiceName()`	Gets the service name.
`ListAuditCredentialsResponse`	`listAuditCredentials(ListAuditCredentialsRequest input)`	Lists audit credentials.
`ListConnectedDataServicesResponse`	`listConnectedDataServices(ListConnectedDataServicesRequest input)`	Returns the list of Data Services and their cluster names that are attached the given environment.
`ListCredentialsResponse`	`listCredentials(ListCredentialsRequest input)`	Lists credentials.
`ListEnvironmentsResponse`	`listEnvironments(ListEnvironmentsRequest input)`	Lists environments.
`ListFreeipaDiagnosticsResponse`	`listFreeipaDiagnostics(ListFreeipaDiagnosticsRequest input)`	List recent FreeIPA diagnostics collections
`ListProxyConfigsResponse`	`listProxyConfigs(ListProxyConfigsRequest input)`	Lists proxy configs.
`RepairFreeipaResponse`	`repairFreeipa(RepairFreeipaRequest input)`	Repairs the FreeIPA nodes.
`RetryFreeipaResponse`	`retryFreeipa(RetryFreeipaRequest input)`	Retries the last failed operation on a FreeIPA.
`RotateSaltPasswordResponse`	`rotateSaltPassword(RotateSaltPasswordRequest input)`	Rotate SaltStack user password on FreeIPA instances.
`SetAccountTelemetryResponse`	`setAccountTelemetry(SetAccountTelemetryRequest input)`	Set account level telemetry settings.
`SetAWSAuditCredentialResponse`	`setAWSAuditCredential(SetAWSAuditCredentialRequest input)`	Creates or updates the AWS audit credential for the account.
`SetAWSGovCloudAuditCredentialResponse`	`setAWSGovCloudAuditCredential(SetAWSGovCloudAuditCredentialRequest input)`	Creates or updates the AWS GovCloud audit credential for the account.
`SetAzureAuditCredentialResponse`	`setAzureAuditCredential(SetAzureAuditCredentialRequest input)`	Creates or updates the Azure audit credential for the account.
`SetCatalogResponse`	`setCatalog(SetCatalogRequest input)`	Sets a catalog for a FreeIPA installation.
`SetEndpointAccessGatewayResponse`	`setEndpointAccessGateway(SetEndpointAccessGatewayRequest input)`	Sets endpoint access gateway settings for the environment.
`SetEnvironmentSettingResponse`	`setEnvironmentSetting(SetEnvironmentSettingRequest input)`	Read a configuration setting from the environment service.
`SetGCPAuditCredentialResponse`	`setGCPAuditCredential(SetGCPAuditCredentialRequest input)`	Creates or updates the GCP audit credential for the account.
`SetIdBrokerMappingsResponse`	`setIdBrokerMappings(SetIdBrokerMappingsRequest input)`	Sets all ID Broker mappings for an environment.
`SetPasswordResponse`	`setPassword(SetPasswordRequest input)`	Deprecated.
`SetTelemetryFeaturesResponse`	`setTelemetryFeatures(SetTelemetryFeaturesRequest input)`	Configure environment level telemetry feature setting.
`StartEnvironmentResponse`	`startEnvironment(StartEnvironmentRequest input)`	Start an environment.
`StartFreeIpaVerticalScalingResponse`	`startFreeIpaVerticalScaling(StartFreeIpaVerticalScalingRequest input)`	Initiates the vertical scaling on FreeIPA.
`StopEnvironmentResponse`	`stopEnvironment(StopEnvironmentRequest input)`	Stop an environment.
`SyncAllUsersResponse`	`syncAllUsers(SyncAllUsersRequest input)`	Synchronizes environments with all users and groups state with CDP.
`SyncIdBrokerMappingsResponse`	`syncIdBrokerMappings(SyncIdBrokerMappingsRequest input)`	Syncs all ID Broker mappings for an environment.
`SyncStatusResponse`	`syncStatus(SyncStatusRequest input)`	Returns status of the sync operation for the operation id.
`SyncUserResponse`	`syncUser(SyncUserRequest input)`	Synchronizes environments with single user to the FreeIPA servers.
`TestAccountTelemetryRulesResponse`	`testAccountTelemetryRules(TestAccountTelemetryRulesRequest input)`	Test anonymization rules (for account telemetry) against text input.
`UpdateAwsDiskEncryptionParametersResponse`	`updateAwsDiskEncryptionParameters(UpdateAwsDiskEncryptionParametersRequest input)`	Update the AWS encryption key ARN for the environment.
`UpdateAzureCredentialResponse`	`updateAzureCredential(UpdateAzureCredentialRequest input)`	Updates a new certificate based Azure credential that can be attached to an environment.
`UpdateAzureEncryptionResourcesResponse`	`updateAzureEncryptionResources(UpdateAzureEncryptionResourcesRequest input)`	Update the Azure encryption resources for the environment.
`UpdateOrchestratorStateResponse`	`updateOrchestratorState(UpdateOrchestratorStateRequest input)`	Run orchestrator engine state update on the FreeIPA cluster.
`UpdateProxyConfigResponse`	`updateProxyConfig(UpdateProxyConfigRequest input)`	Updates the proxy config of the given environment.
`UpdateSecurityAccessResponse`	`updateSecurityAccess(UpdateSecurityAccessRequest input)`	Updates the security access settings of the given environment.
`UpdateSshKeyResponse`	`updateSshKey(UpdateSshKeyRequest input)`	Updates the designated SSH key for the given environment.
`UpdateSubnetResponse`	`updateSubnet(UpdateSubnetRequest input)`	Updates the subnet(s) of the given environment.
`UpgradeCcmResponse`	`upgradeCcm(UpgradeCcmRequest input)`	Upgrades Cluster Connectivity Manager on the environment to the latest available version.
`UpgradeFreeipaResponse`	`upgradeFreeipa(UpgradeFreeipaRequest input)`	Upgrades FreeIPA to the latest or defined image.
`UpscaleFreeipaResponse`	`upscaleFreeipa(UpscaleFreeipaRequest input)`	Upscales FreeIPA instances.
`ValidateAwsCloudStorageResponse`	`validateAwsCloudStorage(ValidateAwsCloudStorageRequest input)`	Validates AWS cloud storage settings of the given environment.
`ValidateAzureCloudStorageResponse`	`validateAzureCloudStorage(ValidateAzureCloudStorageRequest input)`	Validates Azure cloud storage settings of the given environment.

Methods inherited from class com.cloudera.cdp.client.CdpClient
invokeAPI, invokeAPI, invokeAPI, invokeAPI, parameterToPair, parameterToPairs, parameterToString, shutdown

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SERVICE_NAME
```
public static final String SERVICE_NAME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - EnvironmentsClient
```
public EnvironmentsClient(CdpCredentials credentials,
                          String endPoint,
                          CdpClientConfiguration clientConfiguration)
```
  - EnvironmentsClient
```
public EnvironmentsClient(CdpRequestContext<?> context)
```
- Method Detail
  - getServiceName
```
protected String getServiceName()
```
    Description copied from class: CdpClient
    
    Gets the service name.
    
    Specified by:
    
    getServiceName in class CdpClient
    
    Returns:
    
    the service name
  - getRequestContentType
```
protected String getRequestContentType()
```
    Description copied from class: CdpClient
    
    Gets the request Content-Type, used by 'Conent-Type' request header.
    
    Overrides:
    
    getRequestContentType in class CdpClient
    
    Returns:
    
    the request Content-Type
  - getResponseContentType
```
protected String getResponseContentType()
```
    Description copied from class: CdpClient
    
    Gets the expected response Content-Type, used by 'Accept' request header.
    
    Overrides:
    
    getResponseContentType in class CdpClient
    
    Returns:
    
    the response Content-Type
  - attachFreeIpaRecipes
```
public AttachFreeIpaRecipesResponse attachFreeIpaRecipes(AttachFreeIpaRecipesRequest input)
```
    Attach recipes to FreeIPA.
    
    Parameters:
    
    input -
    
    Returns:
    
    AttachFreeIpaRecipesResponse
  - cancelFreeipaDiagnostics
```
public CancelFreeipaDiagnosticsResponse cancelFreeipaDiagnostics(CancelFreeipaDiagnosticsRequest input)
```
    Cancel running FreeIPA diagnostics collections
    
    Parameters:
    
    input -
    
    Returns:
    
    CancelFreeipaDiagnosticsResponse
  - changeEnvironmentCredential
```
public ChangeEnvironmentCredentialResponse changeEnvironmentCredential(ChangeEnvironmentCredentialRequest input)
```
    Changes the credential for an environment.
    
    Parameters:
    
    input -
    
    Returns:
    
    ChangeEnvironmentCredentialResponse
  - checkDatabaseConnectivity
```
public CheckDatabaseConnectivityResponse checkDatabaseConnectivity(CheckDatabaseConnectivityRequest input)
```
    Checks Database connectivity based on the input parameters.
    
    Parameters:
    
    input -
    
    Returns:
    
    CheckDatabaseConnectivityResponse
  - checkEnvironmentConnectivity
```
public CheckEnvironmentConnectivityResponse checkEnvironmentConnectivity(CheckEnvironmentConnectivityRequest input)
```
    Checks connectivity to a new Private Cloud environment by trying to access the Cloudera Manager address with provided credentials.
    
    Parameters:
    
    input -
    
    Returns:
    
    CheckEnvironmentConnectivityResponse
  - checkKubernetesConnectivity
```
public CheckKubernetesConnectivityResponse checkKubernetesConnectivity(CheckKubernetesConnectivityRequest input)
```
    Checks connectivity to a Kubernetes address with provided kubeconfig files.
    
    Parameters:
    
    input -
    
    Returns:
    
    CheckKubernetesConnectivityResponse
  - collectFreeipaDiagnostics
```
public CollectFreeipaDiagnosticsResponse collectFreeipaDiagnostics(CollectFreeipaDiagnosticsRequest input)
```
    Start FreeIPA diagnostics collection
    
    Parameters:
    
    input -
    
    Returns:
    
    CollectFreeipaDiagnosticsResponse
  - createAWSCredential
```
public CreateAWSCredentialResponse createAWSCredential(CreateAWSCredentialRequest input)
```
    Creates a new AWS credential that can be attatched to an environment. The credential is used for authorization to provision resources such as compute instances within your cloud provider account.
    
    Parameters:
    
    input -
    
    Returns:
    
    CreateAWSCredentialResponse
  - createAWSEnvironment
```
public CreateAWSEnvironmentResponse createAWSEnvironment(CreateAWSEnvironmentRequest input)
```
    Creates a new AWS environment by providing the cloud provider access and network information. A FreeIPA server will be automatically provisioned when an environment is created.
    
    Parameters:
    
    input -
    
    Returns:
    
    CreateAWSEnvironmentResponse
  - createAWSGovCloudCredential
```
public CreateAWSGovCloudCredentialResponse createAWSGovCloudCredential(CreateAWSGovCloudCredentialRequest input)
```
    Creates a new AWS credential for GovCloud that can be attatched to an environment. The credential is used for authorization to provision resources such as compute instances within your cloud provider account.
    
    Parameters:
    
    input -
    
    Returns:
    
    CreateAWSGovCloudCredentialResponse
  - createAWSGovCloudEnvironment
```
public CreateAWSGovCloudEnvironmentResponse createAWSGovCloudEnvironment(CreateAWSGovCloudEnvironmentRequest input)
```
    Creates a new AWS GovCloud environment by providing the cloud provider access and network information. A FreeIPA server will be automatically provisioned when an environment is created.
    
    Parameters:
    
    input -
    
    Returns:
    
    CreateAWSGovCloudEnvironmentResponse
  - createAzureCredential
```
public CreateAzureCredentialResponse createAzureCredential(CreateAzureCredentialRequest input)
```
    Creates a new Azure credential that can be attached to an environment. The credential is used for authorization to provision resources such as compute instances within your cloud provider account.
    
    Parameters:
    
    input -
    
    Returns:
    
    CreateAzureCredentialResponse
  - createAzureEnvironment
```
public CreateAzureEnvironmentResponse createAzureEnvironment(CreateAzureEnvironmentRequest input)
```
    Creates a new Azure environment by providing the cloud provider access and network information. A FreeIPA server will be automatically provisioned when an environment is created.
    
    Parameters:
    
    input -
    
    Returns:
    
    CreateAzureEnvironmentResponse
  - createGCPCredential
```
public CreateGCPCredentialResponse createGCPCredential(CreateGCPCredentialRequest input)
```
    Creates a new GCP credential that can be attatched to an environment. The credential is used for authorization to provision resources such as compute instances within your cloud provider account.
    
    Parameters:
    
    input -
    
    Returns:
    
    CreateGCPCredentialResponse
  - createGCPEnvironment
```
public CreateGCPEnvironmentResponse createGCPEnvironment(CreateGCPEnvironmentRequest input)
```
    Creates a new GCP environment by providing the cloud provider access and network information. A FreeIPA server will be automatically provisioned when an environment is created.
    
    Parameters:
    
    input -
    
    Returns:
    
    CreateGCPEnvironmentResponse
  - createPrivateEnvironment
```
public CreatePrivateEnvironmentResponse createPrivateEnvironment(CreatePrivateEnvironmentRequest input)
```
    Creates a new Private Cloud environment by providing the Cloudera Manager address and credentials.
    
    Parameters:
    
    input -
    
    Returns:
    
    CreatePrivateEnvironmentResponse
  - createProxyConfig
```
public CreateProxyConfigResponse createProxyConfig(CreateProxyConfigRequest input)
```
    Creates a new proxy config that can be attatched to an environment.
    
    Parameters:
    
    input -
    
    Returns:
    
    CreateProxyConfigResponse
  - deleteAuditCredential
```
public DeleteAuditCredentialResponse deleteAuditCredential(DeleteAuditCredentialRequest input)
```
    Deletes an audit credential.
    
    Parameters:
    
    input -
    
    Returns:
    
    DeleteAuditCredentialResponse
  - deleteCredential
```
public DeleteCredentialResponse deleteCredential(DeleteCredentialRequest input)
```
    Deletes a credential.
    
    Parameters:
    
    input -
    
    Returns:
    
    DeleteCredentialResponse
  - deleteEnvironment
```
public DeleteEnvironmentResponse deleteEnvironment(DeleteEnvironmentRequest input)
```
    Deletes an environment.
    
    Parameters:
    
    input -
    
    Returns:
    
    DeleteEnvironmentResponse
  - deleteProxyConfig
```
public DeleteProxyConfigResponse deleteProxyConfig(DeleteProxyConfigRequest input)
```
    Deletes a proxy config.
    
    Parameters:
    
    input -
    
    Returns:
    
    DeleteProxyConfigResponse
  - describeEnvironment
```
public DescribeEnvironmentResponse describeEnvironment(DescribeEnvironmentRequest input)
```
    Describes an environment.
    
    Parameters:
    
    input -
    
    Returns:
    
    DescribeEnvironmentResponse
  - detachFreeIpaRecipes
```
public DetachFreeIpaRecipesResponse detachFreeIpaRecipes(DetachFreeIpaRecipesRequest input)
```
    Detach recipes from FreeIPA.
    
    Parameters:
    
    input -
    
    Returns:
    
    DetachFreeIpaRecipesResponse
  - downscaleFreeipa
```
public DownscaleFreeipaResponse downscaleFreeipa(DownscaleFreeipaRequest input)
```
    Downscales FreeIPA instances.
    
    Parameters:
    
    input -
    
    Returns:
    
    DownscaleFreeipaResponse
  - getAccountTelemetry
```
public GetAccountTelemetryResponse getAccountTelemetry(GetAccountTelemetryRequest input)
```
    Get account level telemetry settings. (telemetry features and anonymization rules)
    
    Parameters:
    
    input -
    
    Returns:
    
    GetAccountTelemetryResponse
  - getAccountTelemetryDefault
```
public GetAccountTelemetryDefaultResponse getAccountTelemetryDefault(GetAccountTelemetryDefaultRequest input)
```
    Get default account level telemetry settings. Helps to set back the default values.
    
    Parameters:
    
    input -
    
    Returns:
    
    GetAccountTelemetryDefaultResponse
  - getAuditCredentialPrerequisites
```
public GetAuditCredentialPrerequisitesResponse getAuditCredentialPrerequisites(GetAuditCredentialPrerequisitesRequest input)
```
    This API provides the audit credential prerequisites for the given cloud provider.
    
    Parameters:
    
    input -
    
    Returns:
    
    GetAuditCredentialPrerequisitesResponse
  - getCredentialPrerequisites
```
public GetCredentialPrerequisitesResponse getCredentialPrerequisites(GetCredentialPrerequisitesRequest input)
```
    This API provides the credential prerequisites for the given cloud provider.
    
    Parameters:
    
    input -
    
    Returns:
    
    GetCredentialPrerequisitesResponse
  - getEnvironmentSetting
```
public GetEnvironmentSettingResponse getEnvironmentSetting(GetEnvironmentSettingRequest input)
```
    Read a configuration setting from the environment service.
    
    Parameters:
    
    input -
    
    Returns:
    
    GetEnvironmentSettingResponse
  - getEnvironmentUserSyncState
```
public GetEnvironmentUserSyncStateResponse getEnvironmentUserSyncState(GetEnvironmentUserSyncStateRequest input)
```
    Returns the user synchronization state for an environment.
    
    Parameters:
    
    input -
    
    Returns:
    
    GetEnvironmentUserSyncStateResponse
  - getFreeipaLogDescriptors
```
public GetFreeipaLogDescriptorsResponse getFreeipaLogDescriptors(GetFreeipaLogDescriptorsRequest input)
```
    Gather log descriptors that are used for diagnostics collection.
    
    Parameters:
    
    input -
    
    Returns:
    
    GetFreeipaLogDescriptorsResponse
  - getFreeipaStatus
```
public GetFreeipaStatusResponse getFreeipaStatus(GetFreeipaStatusRequest input)
```
    Get the status of the FreeIPA services
    
    Parameters:
    
    input -
    
    Returns:
    
    GetFreeipaStatusResponse
  - getGovCloudAuditCredentialPrerequisites
```
public GetGovCloudAuditCredentialPrerequisitesResponse getGovCloudAuditCredentialPrerequisites(GetGovCloudAuditCredentialPrerequisitesRequest input)
```
    This API provides the audit credential prerequisites for GovCloud for the enabled providers.
    
    Parameters:
    
    input -
    
    Returns:
    
    GetGovCloudAuditCredentialPrerequisitesResponse
  - getGovCloudCredentialPrerequisites
```
public GetGovCloudCredentialPrerequisitesResponse getGovCloudCredentialPrerequisites(GetGovCloudCredentialPrerequisitesRequest input)
```
    This API provides the credential prerequisites for GovCloud for the enabled providers.
    
    Parameters:
    
    input -
    
    Returns:
    
    GetGovCloudCredentialPrerequisitesResponse
  - getIdBrokerMappings
```
public GetIdBrokerMappingsResponse getIdBrokerMappings(GetIdBrokerMappingsRequest input)
```
    Gets all ID Broker mappings for an environment.
    
    Parameters:
    
    input -
    
    Returns:
    
    GetIdBrokerMappingsResponse
  - getIdBrokerMappingsSyncStatus
```
public GetIdBrokerMappingsSyncStatusResponse getIdBrokerMappingsSyncStatus(GetIdBrokerMappingsSyncStatusRequest input)
```
    Gets ID Broker mappings sync status.
    
    Parameters:
    
    input -
    
    Returns:
    
    GetIdBrokerMappingsSyncStatusResponse
  - getKeytab
```
public GetKeytabResponse getKeytab(GetKeytabRequest input)
```
    Retrieves a keytab for a user or machine user.
    
    Parameters:
    
    input -
    
    Returns:
    
    GetKeytabResponse
  - getOperation
```
public GetOperationResponse getOperation(GetOperationRequest input)
```
    Get the latest (in progress or finished) operation for the environment resource.
    
    Parameters:
    
    input -
    
    Returns:
    
    GetOperationResponse
  - getRepairFreeipaStatus
```
public GetRepairFreeipaStatusResponse getRepairFreeipaStatus(GetRepairFreeipaStatusRequest input)
```
    Returns status of the repair operation for the operation id.
    
    Parameters:
    
    input -
    
    Returns:
    
    GetRepairFreeipaStatusResponse
  - getRootCertificate
```
public GetRootCertificateResponse getRootCertificate(GetRootCertificateRequest input)
```
    This API provides contents of public certificate for an environment.
    
    Parameters:
    
    input -
    
    Returns:
    
    GetRootCertificateResponse
  - listAuditCredentials
```
public ListAuditCredentialsResponse listAuditCredentials(ListAuditCredentialsRequest input)
```
    Lists audit credentials.
    
    Parameters:
    
    input -
    
    Returns:
    
    ListAuditCredentialsResponse
  - listConnectedDataServices
```
public ListConnectedDataServicesResponse listConnectedDataServices(ListConnectedDataServicesRequest input)
```
    Returns the list of Data Services and their cluster names that are attached the given environment.
    
    Parameters:
    
    input -
    
    Returns:
    
    ListConnectedDataServicesResponse
  - listCredentials
```
public ListCredentialsResponse listCredentials(ListCredentialsRequest input)
```
    Lists credentials.
    
    Parameters:
    
    input -
    
    Returns:
    
    ListCredentialsResponse
  - listEnvironments
```
public ListEnvironmentsResponse listEnvironments(ListEnvironmentsRequest input)
```
    Lists environments.
    
    Parameters:
    
    input -
    
    Returns:
    
    ListEnvironmentsResponse
  - listFreeipaDiagnostics
```
public ListFreeipaDiagnosticsResponse listFreeipaDiagnostics(ListFreeipaDiagnosticsRequest input)
```
    List recent FreeIPA diagnostics collections
    
    Parameters:
    
    input -
    
    Returns:
    
    ListFreeipaDiagnosticsResponse
  - listProxyConfigs
```
public ListProxyConfigsResponse listProxyConfigs(ListProxyConfigsRequest input)
```
    Lists proxy configs.
    
    Parameters:
    
    input -
    
    Returns:
    
    ListProxyConfigsResponse
  - repairFreeipa
```
public RepairFreeipaResponse repairFreeipa(RepairFreeipaRequest input)
```
    Repairs the FreeIPA nodes.
    
    Parameters:
    
    input -
    
    Returns:
    
    RepairFreeipaResponse
  - retryFreeipa
```
public RetryFreeipaResponse retryFreeipa(RetryFreeipaRequest input)
```
    Retries the last failed operation on a FreeIPA.
    
    Parameters:
    
    input -
    
    Returns:
    
    RetryFreeipaResponse
  - rotateSaltPassword
```
public RotateSaltPasswordResponse rotateSaltPassword(RotateSaltPasswordRequest input)
```
    Rotate SaltStack user password on FreeIPA instances.
    
    Parameters:
    
    input -
    
    Returns:
    
    RotateSaltPasswordResponse
  - setAWSAuditCredential
```
public SetAWSAuditCredentialResponse setAWSAuditCredential(SetAWSAuditCredentialRequest input)
```
    Creates or updates the AWS audit credential for the account. The credential is used for authorization to archive audit events to your cloud storage.
    
    Parameters:
    
    input -
    
    Returns:
    
    SetAWSAuditCredentialResponse
  - setAWSGovCloudAuditCredential
```
public SetAWSGovCloudAuditCredentialResponse setAWSGovCloudAuditCredential(SetAWSGovCloudAuditCredentialRequest input)
```
    Creates or updates the AWS GovCloud audit credential for the account. The credential is used for authorization to archive audit events to your cloud storage.
    
    Parameters:
    
    input -
    
    Returns:
    
    SetAWSGovCloudAuditCredentialResponse
  - setAccountTelemetry
```
public SetAccountTelemetryResponse setAccountTelemetry(SetAccountTelemetryRequest input)
```
    Set account level telemetry settings. (telemetry features and anonymization rules)
    
    Parameters:
    
    input -
    
    Returns:
    
    SetAccountTelemetryResponse
  - setAzureAuditCredential
```
public SetAzureAuditCredentialResponse setAzureAuditCredential(SetAzureAuditCredentialRequest input)
```
    Creates or updates the Azure audit credential for the account. The credential is used for authorization to archive audit events to your cloud storage.
    
    Parameters:
    
    input -
    
    Returns:
    
    SetAzureAuditCredentialResponse
  - setCatalog
```
public SetCatalogResponse setCatalog(SetCatalogRequest input)
```
    Sets a catalog for a FreeIPA installation.
    
    Parameters:
    
    input -
    
    Returns:
    
    SetCatalogResponse
  - setEndpointAccessGateway
```
public SetEndpointAccessGatewayResponse setEndpointAccessGateway(SetEndpointAccessGatewayRequest input)
```
    Sets endpoint access gateway settings for the environment.
    
    Parameters:
    
    input -
    
    Returns:
    
    SetEndpointAccessGatewayResponse
  - setEnvironmentSetting
```
public SetEnvironmentSettingResponse setEnvironmentSetting(SetEnvironmentSettingRequest input)
```
    Read a configuration setting from the environment service.
    
    Parameters:
    
    input -
    
    Returns:
    
    SetEnvironmentSettingResponse
  - setGCPAuditCredential
```
public SetGCPAuditCredentialResponse setGCPAuditCredential(SetGCPAuditCredentialRequest input)
```
    Creates or updates the GCP audit credential for the account. The credential is used for authorization to archive audit events to your cloud storage.
    
    Parameters:
    
    input -
    
    Returns:
    
    SetGCPAuditCredentialResponse
  - setIdBrokerMappings
```
public SetIdBrokerMappingsResponse setIdBrokerMappings(SetIdBrokerMappingsRequest input)
```
    Sets all ID Broker mappings for an environment.
    
    Parameters:
    
    input -
    
    Returns:
    
    SetIdBrokerMappingsResponse
  - setPassword
```
@Deprecated
public SetPasswordResponse setPassword(SetPasswordRequest input)
```
    Deprecated.
    
    Sets workload user's password and updates into all environments.
    
    Parameters:
    
    input -
    
    Returns:
    
    SetPasswordResponse
  - setTelemetryFeatures
```
public SetTelemetryFeaturesResponse setTelemetryFeatures(SetTelemetryFeaturesRequest input)
```
    Configure environment level telemetry feature setting.
    
    Parameters:
    
    input -
    
    Returns:
    
    SetTelemetryFeaturesResponse
  - startEnvironment
```
public StartEnvironmentResponse startEnvironment(StartEnvironmentRequest input)
```
    Start an environment.
    
    Parameters:
    
    input -
    
    Returns:
    
    StartEnvironmentResponse
  - startFreeIpaVerticalScaling
```
public StartFreeIpaVerticalScalingResponse startFreeIpaVerticalScaling(StartFreeIpaVerticalScalingRequest input)
```
    Initiates the vertical scaling on FreeIPA.
    
    Parameters:
    
    input -
    
    Returns:
    
    StartFreeIpaVerticalScalingResponse
  - stopEnvironment
```
public StopEnvironmentResponse stopEnvironment(StopEnvironmentRequest input)
```
    Stop an environment.
    
    Parameters:
    
    input -
    
    Returns:
    
    StopEnvironmentResponse
  - syncAllUsers
```
public SyncAllUsersResponse syncAllUsers(SyncAllUsersRequest input)
```
    Synchronizes environments with all users and groups state with CDP.
    
    Parameters:
    
    input -
    
    Returns:
    
    SyncAllUsersResponse
  - syncIdBrokerMappings
```
public SyncIdBrokerMappingsResponse syncIdBrokerMappings(SyncIdBrokerMappingsRequest input)
```
    Syncs all ID Broker mappings for an environment.
    
    Parameters:
    
    input -
    
    Returns:
    
    SyncIdBrokerMappingsResponse
  - syncStatus
```
public SyncStatusResponse syncStatus(SyncStatusRequest input)
```
    Returns status of the sync operation for the operation id.
    
    Parameters:
    
    input -
    
    Returns:
    
    SyncStatusResponse
  - syncUser
```
public SyncUserResponse syncUser(SyncUserRequest input)
```
    Synchronizes environments with single user to the FreeIPA servers.
    
    Parameters:
    
    input -
    
    Returns:
    
    SyncUserResponse
  - testAccountTelemetryRules
```
public TestAccountTelemetryRulesResponse testAccountTelemetryRules(TestAccountTelemetryRulesRequest input)
```
    Test anonymization rules (for account telemetry) against text input.
    
    Parameters:
    
    input -
    
    Returns:
    
    TestAccountTelemetryRulesResponse
  - updateAwsDiskEncryptionParameters
```
public UpdateAwsDiskEncryptionParametersResponse updateAwsDiskEncryptionParameters(UpdateAwsDiskEncryptionParametersRequest input)
```
    Update the AWS encryption key ARN for the environment.
    
    Parameters:
    
    input -
    
    Returns:
    
    UpdateAwsDiskEncryptionParametersResponse
  - updateAzureCredential
```
public UpdateAzureCredentialResponse updateAzureCredential(UpdateAzureCredentialRequest input)
```
    Updates a new certificate based Azure credential that can be attached to an environment. The credential is used for authorization to provision resources such as compute instances within your cloud provider account.
    
    Parameters:
    
    input -
    
    Returns:
    
    UpdateAzureCredentialResponse
  - updateAzureEncryptionResources
```
public UpdateAzureEncryptionResourcesResponse updateAzureEncryptionResources(UpdateAzureEncryptionResourcesRequest input)
```
    Update the Azure encryption resources for the environment.
    
    Parameters:
    
    input -
    
    Returns:
    
    UpdateAzureEncryptionResourcesResponse
  - updateOrchestratorState
```
public UpdateOrchestratorStateResponse updateOrchestratorState(UpdateOrchestratorStateRequest input)
```
    Run orchestrator engine state update on the FreeIPA cluster.
    
    Parameters:
    
    input -
    
    Returns:
    
    UpdateOrchestratorStateResponse
  - updateProxyConfig
```
public UpdateProxyConfigResponse updateProxyConfig(UpdateProxyConfigRequest input)
```
    Updates the proxy config of the given environment.
    
    Parameters:
    
    input -
    
    Returns:
    
    UpdateProxyConfigResponse
  - updateSecurityAccess
```
public UpdateSecurityAccessResponse updateSecurityAccess(UpdateSecurityAccessRequest input)
```
    Updates the security access settings of the given environment.
    
    Parameters:
    
    input -
    
    Returns:
    
    UpdateSecurityAccessResponse
  - updateSshKey
```
public UpdateSshKeyResponse updateSshKey(UpdateSshKeyRequest input)
```
    Updates the designated SSH key for the given environment.
    
    Parameters:
    
    input -
    
    Returns:
    
    UpdateSshKeyResponse
  - updateSubnet
```
public UpdateSubnetResponse updateSubnet(UpdateSubnetRequest input)
```
    Updates the subnet(s) of the given environment.
    
    Parameters:
    
    input -
    
    Returns:
    
    UpdateSubnetResponse
  - upgradeCcm
```
public UpgradeCcmResponse upgradeCcm(UpgradeCcmRequest input)
```
    Upgrades Cluster Connectivity Manager on the environment to the latest available version.
    
    Parameters:
    
    input -
    
    Returns:
    
    UpgradeCcmResponse
  - upgradeFreeipa
```
public UpgradeFreeipaResponse upgradeFreeipa(UpgradeFreeipaRequest input)
```
    Upgrades FreeIPA to the latest or defined image.
    
    Parameters:
    
    input -
    
    Returns:
    
    UpgradeFreeipaResponse
  - upscaleFreeipa
```
public UpscaleFreeipaResponse upscaleFreeipa(UpscaleFreeipaRequest input)
```
    Upscales FreeIPA instances.
    
    Parameters:
    
    input -
    
    Returns:
    
    UpscaleFreeipaResponse
  - validateAwsCloudStorage
```
public ValidateAwsCloudStorageResponse validateAwsCloudStorage(ValidateAwsCloudStorageRequest input)
```
    Validates AWS cloud storage settings of the given environment.
    
    Parameters:
    
    input -
    
    Returns:
    
    ValidateAwsCloudStorageResponse
  - validateAzureCloudStorage
```
public ValidateAzureCloudStorageResponse validateAzureCloudStorage(ValidateAzureCloudStorageRequest input)
```
    Validates Azure cloud storage settings of the given environment.
    
    Parameters:
    
    input -
    
    Returns:
    
    ValidateAzureCloudStorageResponse

Class EnvironmentsClient

Field Summary

Fields inherited from class com.cloudera.cdp.client.CdpClient

Constructor Summary

Method Summary

Methods inherited from class com.cloudera.cdp.client.CdpClient

Methods inherited from class java.lang.Object

Field Detail

SERVICE_NAME

Constructor Detail

EnvironmentsClient

EnvironmentsClient

Method Detail

getServiceName

getRequestContentType

getResponseContentType

attachFreeIpaRecipes

cancelFreeipaDiagnostics

changeEnvironmentCredential

checkDatabaseConnectivity

checkEnvironmentConnectivity

checkKubernetesConnectivity

collectFreeipaDiagnostics

createAWSCredential

createAWSEnvironment

createAWSGovCloudCredential

createAWSGovCloudEnvironment

createAzureCredential

createAzureEnvironment

createGCPCredential

createGCPEnvironment

createPrivateEnvironment

createProxyConfig

deleteAuditCredential

deleteCredential

deleteEnvironment

deleteProxyConfig

describeEnvironment

detachFreeIpaRecipes

downscaleFreeipa

getAccountTelemetry

getAccountTelemetryDefault

getAuditCredentialPrerequisites

getCredentialPrerequisites

getEnvironmentSetting

getEnvironmentUserSyncState

getFreeipaLogDescriptors

getFreeipaStatus

getGovCloudAuditCredentialPrerequisites

getGovCloudCredentialPrerequisites

getIdBrokerMappings

getIdBrokerMappingsSyncStatus

getKeytab

getOperation

getRepairFreeipaStatus

getRootCertificate

listAuditCredentials

listConnectedDataServices

listCredentials

listEnvironments

listFreeipaDiagnostics

listProxyConfigs

repairFreeipa

retryFreeipa

rotateSaltPassword

setAWSAuditCredential

setAWSGovCloudAuditCredential

setAccountTelemetry

setAzureAuditCredential

setCatalog

setEndpointAccessGateway

setEnvironmentSetting

setGCPAuditCredential

setIdBrokerMappings

setPassword

setTelemetryFeatures

startEnvironment

startFreeIpaVerticalScaling

stopEnvironment

syncAllUsers