Documentation
¶
Overview ¶
These APIs manage endpoint configurations for this account.
Index ¶
- type AzurePrivateEndpointInfo
- type CreateEndpointRequest
- type DeleteEndpointRequest
- type Endpoint
- type EndpointState
- type EndpointUseCase
- type EndpointsAPI
- func (a *EndpointsAPI) CreateEndpoint(ctx context.Context, request CreateEndpointRequest) (*Endpoint, error)
- func (a *EndpointsAPI) DeleteEndpoint(ctx context.Context, request DeleteEndpointRequest) error
- func (a *EndpointsAPI) GetEndpoint(ctx context.Context, request GetEndpointRequest) (*Endpoint, error)
- func (a *EndpointsAPI) ListEndpoints(ctx context.Context, request ListEndpointsRequest) listing.Iterator[Endpoint]
- func (a *EndpointsAPI) ListEndpointsAll(ctx context.Context, request ListEndpointsRequest) ([]Endpoint, error)
- type EndpointsInterface
- type EndpointsServicedeprecated
- type GetEndpointRequest
- type ListEndpointsRequest
- type ListEndpointsResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AzurePrivateEndpointInfo ¶
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:"-"`
}
func (AzurePrivateEndpointInfo) MarshalJSON ¶
func (s AzurePrivateEndpointInfo) MarshalJSON() ([]byte, error)
func (*AzurePrivateEndpointInfo) UnmarshalJSON ¶
func (s *AzurePrivateEndpointInfo) UnmarshalJSON(b []byte) error
type CreateEndpointRequest ¶
type DeleteEndpointRequest ¶
type DeleteEndpointRequest struct {
Name string `json:"-" url:"-"`
}
type Endpoint ¶
type Endpoint struct {
// The Databricks Account in which the endpoint object exists.
AccountId string `json:"account_id,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"`
// 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:"-"`
}
Endpoint represents a cloud networking resource in a user's cloud account and binds it to the Databricks account.
func (Endpoint) MarshalJSON ¶
func (*Endpoint) UnmarshalJSON ¶
type EndpointState ¶
type EndpointState string
const EndpointStateApproved EndpointState = `APPROVED`
const EndpointStateDisconnected EndpointState = `DISCONNECTED`
const EndpointStateFailed EndpointState = `FAILED`
const EndpointStatePending EndpointState = `PENDING`
func (*EndpointState) Set ¶
func (f *EndpointState) Set(v string) error
Set raw string value and validate it against allowed values
func (*EndpointState) String ¶
func (f *EndpointState) String() string
String representation for fmt.Print
func (*EndpointState) Type ¶
func (f *EndpointState) Type() string
Type always returns EndpointState to satisfy [pflag.Value] interface
func (*EndpointState) Values ¶
func (f *EndpointState) Values() []EndpointState
Values returns all possible values for EndpointState.
There is no guarantee on the order of the values in the slice.
type EndpointUseCase ¶
type EndpointUseCase string
const EndpointUseCaseServiceDirect EndpointUseCase = `SERVICE_DIRECT`
func (*EndpointUseCase) Set ¶
func (f *EndpointUseCase) Set(v string) error
Set raw string value and validate it against allowed values
func (*EndpointUseCase) String ¶
func (f *EndpointUseCase) String() string
String representation for fmt.Print
func (*EndpointUseCase) Type ¶
func (f *EndpointUseCase) Type() string
Type always returns EndpointUseCase to satisfy [pflag.Value] interface
func (*EndpointUseCase) Values ¶
func (f *EndpointUseCase) Values() []EndpointUseCase
Values returns all possible values for EndpointUseCase.
There is no guarantee on the order of the values in the slice.
type EndpointsAPI ¶
type EndpointsAPI struct {
// contains filtered or unexported fields
}
These APIs manage endpoint configurations for this account.
func NewEndpoints ¶
func NewEndpoints(client *client.DatabricksClient) *EndpointsAPI
func (*EndpointsAPI) CreateEndpoint ¶
func (a *EndpointsAPI) CreateEndpoint(ctx context.Context, request CreateEndpointRequest) (*Endpoint, error)
func (*EndpointsAPI) DeleteEndpoint ¶
func (a *EndpointsAPI) DeleteEndpoint(ctx context.Context, request DeleteEndpointRequest) error
func (*EndpointsAPI) GetEndpoint ¶
func (a *EndpointsAPI) GetEndpoint(ctx context.Context, request GetEndpointRequest) (*Endpoint, error)
func (*EndpointsAPI) ListEndpoints ¶
func (a *EndpointsAPI) ListEndpoints(ctx context.Context, request ListEndpointsRequest) listing.Iterator[Endpoint]
Lists all network connectivity endpoints for the account.
func (*EndpointsAPI) ListEndpointsAll ¶
func (a *EndpointsAPI) ListEndpointsAll(ctx context.Context, request ListEndpointsRequest) ([]Endpoint, error)
Lists all network connectivity endpoints for the account.
type EndpointsInterface ¶
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 EndpointsService
deprecated
type EndpointsService 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.
ListEndpoints(ctx context.Context, request ListEndpointsRequest) (*ListEndpointsResponse, error)
}
These APIs manage endpoint configurations for this account.
Deprecated: Do not use this interface, it will be removed in a future version of the SDK.
type GetEndpointRequest ¶
type GetEndpointRequest struct {
Name string `json:"-" url:"-"`
}
type ListEndpointsRequest ¶
type ListEndpointsRequest struct {
PageSize int `json:"-" url:"page_size,omitempty"`
PageToken string `json:"-" url:"page_token,omitempty"`
Parent string `json:"-" url:"-"`
ForceSendFields []string `json:"-" url:"-"`
}
func (ListEndpointsRequest) MarshalJSON ¶
func (s ListEndpointsRequest) MarshalJSON() ([]byte, error)
func (*ListEndpointsRequest) UnmarshalJSON ¶
func (s *ListEndpointsRequest) UnmarshalJSON(b []byte) error
type ListEndpointsResponse ¶
type ListEndpointsResponse struct {
Items []Endpoint `json:"items,omitempty"`
NextPageToken string `json:"next_page_token,omitempty"`
ForceSendFields []string `json:"-" url:"-"`
}
func (ListEndpointsResponse) MarshalJSON ¶
func (s ListEndpointsResponse) MarshalJSON() ([]byte, error)
func (*ListEndpointsResponse) UnmarshalJSON ¶
func (s *ListEndpointsResponse) UnmarshalJSON(b []byte) error