networking

type AwsVpcEndpointInfo struct {
	// The AWS account ID in which this VPC endpoint lives.
	AwsAccountId string `json:"aws_account_id,omitempty"`
	// The ID of the Databricks VPC endpoint service that this endpoint connects
	// to.
	AwsEndpointServiceId string `json:"aws_endpoint_service_id,omitempty"`
	// The ID of the underlying VPC endpoint in AWS. Provided by the customer
	// when registering an existing AWS VPC endpoint.
	AwsVpcEndpointId string `json:"aws_vpc_endpoint_id"`

	ForceSendFields []string `json:"-" url:"-"`
}

type AzurePrivateEndpointInfo struct {
	// The name of the Private Endpoint in the Azure subscription.
	PrivateEndpointName string `json:"private_endpoint_name"`
	// The GUID of the Private Endpoint resource in the Azure subscription. This
	// is assigned by Azure when the user sets up the Private Endpoint.
	PrivateEndpointResourceGuid string `json:"private_endpoint_resource_guid"`
	// The full resource ID of the Private Endpoint.
	PrivateEndpointResourceId string `json:"private_endpoint_resource_id,omitempty"`
	// The resource ID of the Databricks Private Link Service that this Private
	// Endpoint connects to.
	PrivateLinkServiceId string `json:"private_link_service_id,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type CreateEndpointRequest struct {
	Endpoint Endpoint `json:"endpoint"`
	// The parent resource name of the account under which the endpoint is
	// created. Format: `accounts/{account_id}`.
	Parent string `json:"-" url:"-"`
}

type CreatePrivateNetworkGatewayOperationInterface interface {

	// Wait blocks until the long-running operation is completed. If no timeout is
	// specified, this will poll indefinitely. If a timeout is provided and the operation
	// didn't finish within the timeout, this function will return an error, otherwise
	// returns successful response and any errors encountered.
	Wait(ctx context.Context, opts ...api.Option) (*PrivateNetworkGateway, error)

	// Name returns the name of the long-running operation. The name is assigned
	// by the server and is unique within the service from which the operation is created.
	Name() string

	// Metadata returns metadata associated with the long-running operation.
	// If the metadata is not available, the returned metadata and error are both nil.
	Metadata() (*PrivateNetworkGatewayOperationMetadata, error)

	// Done reports whether the long-running operation has completed.
	Done() (bool, error)
}

type CreatePrivateNetworkGatewayRequest struct {
	// The network connectivity configuration that will contain the gateway.
	Parent string `json:"-" url:"-"`
	// The gateway to create.
	PrivateNetworkGateway PrivateNetworkGateway `json:"private_network_gateway"`
	// A unique identifier for this request. The request is idempotent when this
	// is provided.
	RequestId string `json:"-" url:"request_id,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type DatabricksServiceExceptionWithDetailsProto struct {
	Details []json.RawMessage `json:"details,omitempty"`

	ErrorCode ErrorCode `json:"error_code,omitempty"`

	Message string `json:"message,omitempty"`

	StackTrace string `json:"stack_trace,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type DeleteEndpointRequest struct {
	Name string `json:"-" url:"-"`
}

type DeletePrivateNetworkGatewayRequest struct {
	// The canonical resource name of the gateway.
	Name string `json:"-" url:"-"`
}

type Endpoint struct {
	// The Databricks Account in which the endpoint object exists.
	AccountId string `json:"account_id,omitempty"`
	// Info for an AWS VPC endpoint.
	AwsVpcEndpointInfo *AwsVpcEndpointInfo `json:"aws_vpc_endpoint_info,omitempty"`
	// Info for an Azure private endpoint.
	AzurePrivateEndpointInfo *AzurePrivateEndpointInfo `json:"azure_private_endpoint_info,omitempty"`
	// The timestamp when the endpoint was created. The timestamp is in RFC 3339
	// format in UTC timezone.
	CreateTime *time.Time `json:"create_time,omitempty"`
	// 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.
	DisplayName string `json:"display_name"`
	// The unique identifier for this endpoint under the account. This field is
	// a UUID generated by Databricks.
	EndpointId string `json:"endpoint_id,omitempty"`
	// Info for a GCP Private Service Connect endpoint.
	GcpPscEndpointInfo *GcpPscEndpointInfo `json:"gcp_psc_endpoint_info,omitempty"`
	// The resource name of the endpoint, which uniquely identifies the
	// endpoint.
	Name string `json:"name,omitempty"`
	// The cloud provider region where this endpoint is located.
	Region string `json:"region"`
	// The state of the endpoint. The endpoint can only be used if the state is
	// `APPROVED`.
	State EndpointState `json:"state,omitempty"`
	// 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.
	UseCase EndpointUseCase `json:"use_case,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type EndpointState string

type EndpointUseCase string

type EndpointsAPI struct {
	// contains filtered or unexported fields
}

type EndpointsInterface interface {

	// Creates a new network connectivity endpoint that enables private connectivity
	// between your network resources and Databricks services.
	//
	// After creation, the endpoint is initially in the PENDING state. The
	// Databricks endpoint service automatically reviews and approves the endpoint
	// within a few minutes. Use the GET method to retrieve the latest endpoint
	// state.
	//
	// An endpoint can be used only after it reaches the APPROVED state.
	CreateEndpoint(ctx context.Context, request CreateEndpointRequest) (*Endpoint, error)

	// Deletes a network endpoint. This will remove the endpoint configuration from
	// Databricks. Depending on the endpoint type and use case, you may also need to
	// delete corresponding network resources in your cloud provider account.
	DeleteEndpoint(ctx context.Context, request DeleteEndpointRequest) error

	// Gets details of a specific network endpoint.
	GetEndpoint(ctx context.Context, request GetEndpointRequest) (*Endpoint, error)

	// Lists all network connectivity endpoints for the account.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListEndpoints(ctx context.Context, request ListEndpointsRequest) listing.Iterator[Endpoint]

	// Lists all network connectivity endpoints for the account.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListEndpointsAll(ctx context.Context, request ListEndpointsRequest) ([]Endpoint, error)
}

type ErrorCode string

type GcpPscEndpointInfo struct {
	// 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.
	EndpointRegion string `json:"endpoint_region"`
	// The GCP consumer project ID in which this PSC endpoint is created.
	// Provided by the customer when registering an existing PSC endpoint.
	ProjectId string `json:"project_id"`
	// The ID of the underlying Private Service Connect connection in the GCP
	// consumer project, assigned by GCP when the PSC connection is created.
	PscConnectionId string `json:"psc_connection_id,omitempty"`
	// The name of this PSC connection in the GCP consumer project. Provided by
	// the customer when registering an existing PSC endpoint.
	PscEndpoint string `json:"psc_endpoint"`
	// The ID of the Databricks service attachment this PSC endpoint connects
	// to.
	ServiceAttachmentId string `json:"service_attachment_id,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type GetEndpointRequest struct {
	Name string `json:"-" url:"-"`
}

type GetOperationRequest struct {
	// The name of the operation resource.
	Name string `json:"-" url:"-"`
}

type GetPrivateNetworkGatewayRequest struct {
	// The canonical resource name of the gateway.
	Name string `json:"-" url:"-"`
}

type ListEndpointsRequest struct {
	PageSize int `json:"-" url:"page_size,omitempty"`

	PageToken string `json:"-" url:"page_token,omitempty"`
	// The parent resource name of the account to list endpoints for. Format:
	// `accounts/{account_id}`.
	Parent string `json:"-" url:"-"`

	ForceSendFields []string `json:"-" url:"-"`
}

type ListEndpointsResponse struct {
	Items []Endpoint `json:"items,omitempty"`

	NextPageToken string `json:"next_page_token,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type ListPrivateNetworkGatewaysRequest struct {
	// An opaque token returned by a previous list request.
	PageToken string `json:"-" url:"page_token,omitempty"`
	// The network connectivity configuration containing the gateways.
	Parent string `json:"-" url:"-"`

	ForceSendFields []string `json:"-" url:"-"`
}

type ListPrivateNetworkGatewaysResponse struct {
	// An opaque token for the next page, or empty when there are no more
	// results.
	NextPageToken string `json:"next_page_token,omitempty"`

	PrivateNetworkGateways []PrivateNetworkGateway `json:"private_network_gateways,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type Operation struct {
	// If the value is `false`, it means the operation is still in progress. If
	// `true`, the operation is completed, and either `error` or `response` is
	// available.
	Done bool `json:"done,omitempty"`
	// The error result of the operation in case of failure or cancellation.
	Error *DatabricksServiceExceptionWithDetailsProto `json:"error,omitempty"`
	// Service-specific metadata associated with the operation. It typically
	// contains progress information and common metadata such as create time.
	// Some services might not provide such metadata.
	Metadata json.RawMessage `json:"metadata,omitempty"`
	// The server-assigned name, which is only unique within the same service
	// that originally returns it. If you use the default HTTP mapping, the
	// `name` should be a resource name ending with `operations/{unique_id}`.
	Name string `json:"name,omitempty"`
	// The normal, successful response of the operation.
	Response json.RawMessage `json:"response,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type PrivateNetworkGateway struct {
	// The AWS connection used by the gateway.
	AwsCloudConnection *PrivateNetworkGatewayAwsCloudConnection `json:"aws_cloud_connection,omitempty"`
	// The Azure connection used by the gateway.
	AzureCloudConnection *PrivateNetworkGatewayAzureCloudConnection `json:"azure_cloud_connection,omitempty"`
	// The provisioned bandwidth tier for an Azure gateway, in gigabits per
	// second. Required when creating an Azure gateway.
	BandwidthTierGigabitsPerSecond int `json:"bandwidth_tier_gigabits_per_second,omitempty"`
	// The time when the gateway was created.
	CreateTime *time.Time `json:"create_time,omitempty"`
	// The destinations routed through this gateway.
	Destinations []PrivateNetworkGatewayDestination `json:"destinations,omitempty"`
	// The human-readable name of the gateway.
	DisplayName string `json:"display_name"`
	// The failure reason when the gateway is in the FAILED state.
	ErrorMessage string `json:"error_message,omitempty"`
	// The canonical resource name of the gateway, in the form
	// `accounts/{account_id}/network-connectivity-configs/{ncc_id}/private-network-gateways/{gateway_id}`.
	Name string `json:"name,omitempty"`
	// The DNS resolvers used for private name resolution.
	PrivateDnsResolvers []PrivateNetworkGatewayPrivateDnsResolver `json:"private_dns_resolvers,omitempty"`
	// The current lifecycle state of the gateway.
	State PrivateNetworkGatewayGatewayState `json:"state,omitempty"`
	// The traffic routed through this gateway.
	TrafficMode PrivateNetworkGatewayTrafficMode `json:"traffic_mode"`
	// The time when the gateway was last updated.
	UpdateTime *time.Time `json:"update_time,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type PrivateNetworkGatewayAwsCloudConnection struct {
	// The IAM role that Databricks assumes to manage gateway resources.
	CrossAccountRole PrivateNetworkGatewayAwsCloudConnectionCrossAccountRole `json:"cross_account_role"`
	// The subnets where the gateway establishes connectivity.
	GatewaySubnets []PrivateNetworkGatewayAwsCloudConnectionAwsGatewaySubnet `json:"gateway_subnets"`
	// The security groups attached to the gateway network interface.
	SecurityGroupIds []string `json:"security_group_ids"`
}

type PrivateNetworkGatewayAwsCloudConnectionAwsGatewaySubnet struct {
	// The AWS subnet ID.
	SubnetId string `json:"subnet_id"`
}

type PrivateNetworkGatewayAwsCloudConnectionCrossAccountRole struct {
	// The ARN of the IAM role.
	RoleArn string `json:"role_arn"`
}

type PrivateNetworkGatewayAzureCloudConnection struct {
	// The subnet where the gateway establishes connectivity.
	GatewaySubnet PrivateNetworkGatewayAzureCloudConnectionAzureGatewaySubnet `json:"gateway_subnet"`
}

type PrivateNetworkGatewayAzureCloudConnectionAzureGatewaySubnet struct {
	// The full Azure resource ID of the subnet.
	ResourceId string `json:"resource_id"`
}

type PrivateNetworkGatewayDestination struct {
	// The destination type.
	DestinationType PrivateNetworkGatewayDestinationDestinationType `json:"destination_type"`
	// The destination value.
	Value string `json:"value"`
}

type PrivateNetworkGatewayDestinationDestinationType string

type PrivateNetworkGatewayGatewayState string

type PrivateNetworkGatewayOperationMetadata struct {
	// The operation performed on the gateway.
	OperationType PrivateNetworkGatewayOperationMetadataOperationType `json:"operation_type,omitempty"`
}

type PrivateNetworkGatewayOperationMetadataOperationType string

type PrivateNetworkGatewayPrivateDnsResolver struct {
	// The resolver type.
	ResolverType PrivateNetworkGatewayPrivateDnsResolverResolverType `json:"resolver_type"`
	// The resolver value.
	Value string `json:"value"`
}

type PrivateNetworkGatewayPrivateDnsResolverResolverType string

type PrivateNetworkGatewayTrafficMode string

type PrivateNetworkGatewaysAPI struct {
	// contains filtered or unexported fields
}

type PrivateNetworkGatewaysInterface interface {
	CreatePrivateNetworkGateway(ctx context.Context, request CreatePrivateNetworkGatewayRequest) (CreatePrivateNetworkGatewayOperationInterface, error)

	// Permanently deletes a private network gateway.
	DeletePrivateNetworkGateway(ctx context.Context, request DeletePrivateNetworkGatewayRequest) error

	// Gets a private network gateway.
	GetPrivateNetworkGateway(ctx context.Context, request GetPrivateNetworkGatewayRequest) (*PrivateNetworkGateway, error)

	// Gets the status of a private network gateway create operation.
	GetPrivateNetworkGatewayOperation(ctx context.Context, request GetOperationRequest) (*Operation, error)

	// Lists private network gateways under a network connectivity configuration.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListPrivateNetworkGateways(ctx context.Context, request ListPrivateNetworkGatewaysRequest) listing.Iterator[PrivateNetworkGateway]

	// Lists private network gateways under a network connectivity configuration.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListPrivateNetworkGatewaysAll(ctx context.Context, request ListPrivateNetworkGatewaysRequest) ([]PrivateNetworkGateway, error)

	// Updates a private network gateway.
	UpdatePrivateNetworkGateway(ctx context.Context, request UpdatePrivateNetworkGatewayRequest) (*PrivateNetworkGateway, error)
}

type UpdatePrivateNetworkGatewayRequest struct {
	// The canonical resource name of the gateway, in the form
	// `accounts/{account_id}/network-connectivity-configs/{ncc_id}/private-network-gateways/{gateway_id}`.
	Name string `json:"-" url:"-"`
	// The gateway containing the desired mutable field values.
	PrivateNetworkGateway PrivateNetworkGateway `json:"private_network_gateway"`
	// The fields to update.
	UpdateMask fieldmask.FieldMask `json:"-" url:"update_mask"`
}