com.databricks.sdk.service.settings.NetworkConnectivityAPI Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of databricks-sdk-java Show documentation
There is a newer version: 0.38.0
// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
package com.databricks.sdk.service.settings;

import com.databricks.sdk.core.ApiClient;
import com.databricks.sdk.support.Generated;
import com.databricks.sdk.support.Paginator;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * These APIs provide configurations for the network connectivity of your workspaces for serverless
 * compute resources.
 */
@Generated
public class NetworkConnectivityAPI {
  private static final Logger LOG = LoggerFactory.getLogger(NetworkConnectivityAPI.class);

  private final NetworkConnectivityService impl;

  /** Regular-use constructor */
  public NetworkConnectivityAPI(ApiClient apiClient) {
    impl = new NetworkConnectivityImpl(apiClient);
  }

  /** Constructor for mocks */
  public NetworkConnectivityAPI(NetworkConnectivityService mock) {
    impl = mock;
  }

  public NetworkConnectivityConfiguration createNetworkConnectivityConfiguration(
      String name, String region) {
    return createNetworkConnectivityConfiguration(
        new CreateNetworkConnectivityConfigRequest().setName(name).setRegion(region));
  }

  /** Create a network connectivity configuration. */
  public NetworkConnectivityConfiguration createNetworkConnectivityConfiguration(
      CreateNetworkConnectivityConfigRequest request) {
    return impl.createNetworkConnectivityConfiguration(request);
  }

  public NccAzurePrivateEndpointRule createPrivateEndpointRule(
      String networkConnectivityConfigId,
      String resourceId,
      CreatePrivateEndpointRuleRequestGroupId groupId) {
    return createPrivateEndpointRule(
        new CreatePrivateEndpointRuleRequest()
            .setNetworkConnectivityConfigId(networkConnectivityConfigId)
            .setResourceId(resourceId)
            .setGroupId(groupId));
  }

  /**
   * Create a private endpoint rule.
   *
   * Create a private endpoint rule for the specified network connectivity config object. Once
   * the object is created, Databricks asynchronously provisions a new Azure private endpoint to
   * your specified Azure resource.
   *
   * 
**IMPORTANT**: You must use Azure portal or other Azure tools to approve the private
   * endpoint to complete the connection. To get the information of the private endpoint created,
   * make a `GET` request on the new private endpoint rule. See [serverless private link].
   *
   * 
[serverless private link]:
   * https://learn.microsoft.com/azure/databricks/security/network/serverless-network-security/serverless-private-link
   */
  public NccAzurePrivateEndpointRule createPrivateEndpointRule(
      CreatePrivateEndpointRuleRequest request) {
    return impl.createPrivateEndpointRule(request);
  }

  public void deleteNetworkConnectivityConfiguration(String networkConnectivityConfigId) {
    deleteNetworkConnectivityConfiguration(
        new DeleteNetworkConnectivityConfigurationRequest()
            .setNetworkConnectivityConfigId(networkConnectivityConfigId));
  }

  /**
   * Delete a network connectivity configuration.
   *
   * 
Deletes a network connectivity configuration.
   */
  public void deleteNetworkConnectivityConfiguration(
      DeleteNetworkConnectivityConfigurationRequest request) {
    impl.deleteNetworkConnectivityConfiguration(request);
  }

  public NccAzurePrivateEndpointRule deletePrivateEndpointRule(
      String networkConnectivityConfigId, String privateEndpointRuleId) {
    return deletePrivateEndpointRule(
        new DeletePrivateEndpointRuleRequest()
            .setNetworkConnectivityConfigId(networkConnectivityConfigId)
            .setPrivateEndpointRuleId(privateEndpointRuleId));
  }

  /**
   * Delete a private endpoint rule.
   *
   * 
Initiates deleting a private endpoint rule. If the connection state is PENDING or EXPIRED,
   * the private endpoint is immediately deleted. Otherwise, the private endpoint is deactivated and
   * will be deleted after seven days of deactivation. When a private endpoint is deactivated, the
   * `deactivated` field is set to `true` and the private endpoint is not available to your
   * serverless compute resources.
   */
  public NccAzurePrivateEndpointRule deletePrivateEndpointRule(
      DeletePrivateEndpointRuleRequest request) {
    return impl.deletePrivateEndpointRule(request);
  }

  public NetworkConnectivityConfiguration getNetworkConnectivityConfiguration(
      String networkConnectivityConfigId) {
    return getNetworkConnectivityConfiguration(
        new GetNetworkConnectivityConfigurationRequest()
            .setNetworkConnectivityConfigId(networkConnectivityConfigId));
  }

  /**
   * Get a network connectivity configuration.
   *
   * 
Gets a network connectivity configuration.
   */
  public NetworkConnectivityConfiguration getNetworkConnectivityConfiguration(
      GetNetworkConnectivityConfigurationRequest request) {
    return impl.getNetworkConnectivityConfiguration(request);
  }

  public NccAzurePrivateEndpointRule getPrivateEndpointRule(
      String networkConnectivityConfigId, String privateEndpointRuleId) {
    return getPrivateEndpointRule(
        new GetPrivateEndpointRuleRequest()
            .setNetworkConnectivityConfigId(networkConnectivityConfigId)
            .setPrivateEndpointRuleId(privateEndpointRuleId));
  }

  /**
   * Get a private endpoint rule.
   *
   * 
Gets the private endpoint rule.
   */
  public NccAzurePrivateEndpointRule getPrivateEndpointRule(GetPrivateEndpointRuleRequest request) {
    return impl.getPrivateEndpointRule(request);
  }

  /**
   * List network connectivity configurations.
   *
   * 
Gets an array of network connectivity configurations.
   */
  public Iterable listNetworkConnectivityConfigurations(
      ListNetworkConnectivityConfigurationsRequest request) {
    return new Paginator<>(
        request,
        impl::listNetworkConnectivityConfigurations,
        ListNetworkConnectivityConfigurationsResponse::getItems,
        response -> {
          String token = response.getNextPageToken();
          if (token == null || token.isEmpty()) {
            return null;
          }
          return request.setPageToken(token);
        });
  }

  public Iterable listPrivateEndpointRules(
      String networkConnectivityConfigId) {
    return listPrivateEndpointRules(
        new ListPrivateEndpointRulesRequest()
            .setNetworkConnectivityConfigId(networkConnectivityConfigId));
  }

  /**
   * List private endpoint rules.
   *
   * Gets an array of private endpoint rules.
   */
  public Iterable listPrivateEndpointRules(
      ListPrivateEndpointRulesRequest request) {
    return new Paginator<>(
        request,
        impl::listPrivateEndpointRules,
        ListNccAzurePrivateEndpointRulesResponse::getItems,
        response -> {
          String token = response.getNextPageToken();
          if (token == null || token.isEmpty()) {
            return null;
          }
          return request.setPageToken(token);
        });
  }

  public NetworkConnectivityService impl() {
    return impl;
  }
}