Networking

These dataclasses are used in the SDK to represent API requests and responses for services in the databricks.sdk.service.networking module.

class databricks.sdk.service.networking.AwsVpcEndpointInfo(aws_vpc_endpoint_id: 'str', aws_account_id: 'Optional[str]' = None, aws_endpoint_service_id: 'Optional[str]' = None)
aws_vpc_endpoint_id: str

The ID of the underlying VPC endpoint in AWS. Provided by the customer when registering an existing AWS VPC endpoint.

aws_account_id: str | None = None

The AWS account ID in which this VPC endpoint lives.

aws_endpoint_service_id: str | None = None

The ID of the Databricks VPC endpoint service that this endpoint connects to.

as_dict() → dict

Serializes the AwsVpcEndpointInfo into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the AwsVpcEndpointInfo into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AwsVpcEndpointInfo

Deserializes the AwsVpcEndpointInfo from a dictionary.

class databricks.sdk.service.networking.AzurePrivateEndpointInfo(private_endpoint_name: 'str', private_endpoint_resource_guid: 'str', private_endpoint_resource_id: 'Optional[str]' = None, private_link_service_id: 'Optional[str]' = None)
private_endpoint_name: str

The name of the Private Endpoint in the Azure subscription.

private_endpoint_resource_guid: str

The GUID of the Private Endpoint resource in the Azure subscription. This is assigned by Azure when the user sets up the Private Endpoint.

private_endpoint_resource_id: str | None = None

The full resource ID of the Private Endpoint.

The resource ID of the Databricks Private Link Service that this Private Endpoint connects to.

as_dict() → dict

Serializes the AzurePrivateEndpointInfo into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the AzurePrivateEndpointInfo into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → AzurePrivateEndpointInfo

Deserializes the AzurePrivateEndpointInfo from a dictionary.

class databricks.sdk.service.networking.Endpoint(display_name: str, region: str, account_id: str | None = None, aws_vpc_endpoint_info: AwsVpcEndpointInfo | None = None, azure_private_endpoint_info: AzurePrivateEndpointInfo | None = None, create_time: Timestamp | None = None, endpoint_id: str | None = None, gcp_psc_endpoint_info: GcpPscEndpointInfo | None = None, name: str | None = None, state: EndpointState | None = None, use_case: EndpointUseCase | None = None)

Endpoint represents a cloud networking resource in a user’s cloud account and binds it to the Databricks account.

display_name: str

The human-readable display name of this endpoint. The input should conform to RFC-1034, which restricts to letters, numbers, and hyphens, with the first character a letter, the last a letter or a number, and a 63 character maximum.

region: str

The cloud provider region where this endpoint is located.

account_id: str | None = None

The Databricks Account in which the endpoint object exists.

aws_vpc_endpoint_info: AwsVpcEndpointInfo | None = None

Info for an AWS VPC endpoint.

azure_private_endpoint_info: AzurePrivateEndpointInfo | None = None

Info for an Azure private endpoint.

create_time: Timestamp | None = None

The timestamp when the endpoint was created. The timestamp is in RFC 3339 format in UTC timezone.

endpoint_id: str | None = None

The unique identifier for this endpoint under the account. This field is a UUID generated by Databricks.

gcp_psc_endpoint_info: GcpPscEndpointInfo | None = None

Info for a GCP Private Service Connect endpoint.

name: str | None = None

The resource name of the endpoint, which uniquely identifies the endpoint.

state: EndpointState | None = None

The state of the endpoint. The endpoint can only be used if the state is APPROVED.

use_case: EndpointUseCase | None = None

The use case that determines the type of network connectivity this endpoint provides. This field is automatically determined based on the endpoint configuration and cloud-specific settings.

as_dict() → dict

Serializes the Endpoint into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the Endpoint into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → Endpoint

Deserializes the Endpoint from a dictionary.

class databricks.sdk.service.networking.EndpointState
APPROVED = "APPROVED"
DISCONNECTED = "DISCONNECTED"
FAILED = "FAILED"
PENDING = "PENDING"
class databricks.sdk.service.networking.EndpointUseCase
SERVICE_DIRECT = "SERVICE_DIRECT"
class databricks.sdk.service.networking.GcpPscEndpointInfo(project_id: 'str', psc_endpoint: 'str', endpoint_region: 'str', psc_connection_id: 'Optional[str]' = None, service_attachment_id: 'Optional[str]' = None)
project_id: str

The GCP consumer project ID in which this PSC endpoint is created. Provided by the customer when registering an existing PSC endpoint.

psc_endpoint: str

The name of this PSC connection in the GCP consumer project. Provided by the customer when registering an existing PSC endpoint.

endpoint_region: str

The GCP region of the PSC connection endpoint. Provided by the customer when registering an existing PSC endpoint. GCP supports only same-region PSC, so this must match the workspace region.

psc_connection_id: str | None = None

The ID of the underlying Private Service Connect connection in the GCP consumer project, assigned by GCP when the PSC connection is created.

service_attachment_id: str | None = None

The ID of the Databricks service attachment this PSC endpoint connects to.

as_dict() → dict

Serializes the GcpPscEndpointInfo into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the GcpPscEndpointInfo into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → GcpPscEndpointInfo

Deserializes the GcpPscEndpointInfo from a dictionary.

class databricks.sdk.service.networking.ListEndpointsResponse(items: 'Optional[List[Endpoint]]' = None, next_page_token: 'Optional[str]' = None)
items: List[Endpoint] | None = None
next_page_token: str | None = None
as_dict() → dict

Serializes the ListEndpointsResponse into a dictionary suitable for use as a JSON request body.

as_shallow_dict() → dict

Serializes the ListEndpointsResponse into a shallow dictionary of its immediate attributes.

classmethod from_dict(d: Dict[str, Any]) → ListEndpointsResponse

Deserializes the ListEndpointsResponse from a dictionary.