Class DbPrivateLinksClient

java.lang.Object
com.dtsx.astra.sdk.AbstractApiClient
com.dtsx.astra.sdk.db.DbPrivateLinksClient

public class DbPrivateLinksClient extends AbstractApiClient
Delegate private link operations.
  • Constructor Details

    • DbPrivateLinksClient

      public DbPrivateLinksClient(String token, String databaseId)
      As immutable object use builder to initiate the object.
      Parameters:
      token - authenticated token
      databaseId - database identifier
    • DbPrivateLinksClient

      public DbPrivateLinksClient(String token, ApiLocator.AstraEnvironment env, String databaseId)
      As immutable object use builder to initiate the object.
      Parameters:
      env - define target environment to be used
      token - authenticated token
      databaseId - database identifier
  • Method Details

    • findAll

      public void findAll()
      TODO Get info about all private endpoint connections for a specific database

      https://docs.datastax.com/en/astra/docs/_attachments/devopsv2.html#operation/ListPrivateLinksForOrg

    • findAll

      public void findAll(String region)
      TODO Get info about private endpoints in a region.
      Parameters:
      region - current region where add the private link

      https://docs.datastax.com/en/astra/docs/_attachments/devopsv2.html#operation/GetPrivateLinksForDatacenter

    • createPrincipal

      public void createPrincipal(String region)
      TODO Add an allowed principal to the service.
      Parameters:
      region - region where add the principal Configure a private endpoint connection by providing the allowed principal to connect with
    • create

      public void create(String region)
      TODO Accept a private endpoint connection.
      Parameters:
      region - region where add the private endpoint

      https://docs.datastax.com/en/astra/docs/_attachments/devopsv2.html#operation/AcceptEndpointToService

    • findById

      public Optional<Object> findById(String region, String endpointId)
      TODO Get a specific endpoint.

      https://docs.datastax.com/en/astra/docs/_attachments/devopsv2.html#operation/GetPrivateLinkEndpoint

      Parameters:
      region - current region
      endpointId - endpoint id fo the region
      Returns:
      the private endpoint of exist
    • update

      public void update(String region, String endpointId, Object endpoint)
      TODO Update private endpoint description.
      Parameters:
      region - current region
      endpointId - endpoint id fo the region
      endpoint - new value for the endpoint

      https://docs.datastax.com/en/astra/docs/_attachments/devopsv2.html#operation/UpdateEndpoint

    • delete

      public void delete(String region, String endpointId)
      TODO Delete private endpoint connection.
      Parameters:
      region - current region
      endpointId - endpoint id fo the region

      https://docs.datastax.com/en/astra/docs/_attachments/devopsv2.html#operation/DeleteEndpoint