domains

type CreateDomainRequest struct {
	Domain Domain `json:"domain"`
	// Client-supplied resource ID for the new domain. If omitted, the server
	// generates one.
	DomainId string `json:"-" url:"domain_id,omitempty"`

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

type DeleteDomainRequest struct {
	// When false (default), DeleteDomain is rejected with FAILED_PRECONDITION
	// if the domain still has Glossary pages. When true, those pages are
	// deleted first and then the domain is removed.
	Force bool `json:"-" url:"force,omitempty"`
	// Full resource name of the domain to delete. Format: `domains/{domain_id}`
	Name string `json:"-" url:"-"`

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

type Domain struct {
	// Principal IDs of the business owners (users, groups, or service
	// principals).
	BusinessOwnerIds []int64 `json:"business_owner_ids,omitempty"`
	// Timestamp when the domain was created.
	CreateTime *time.Time `json:"create_time,omitempty"`
	// Full description (max 4096 chars)
	Description string `json:"description,omitempty"`
	// Unique identifier for the domain. If omitted at Create, the server
	// generates one.
	DomainId string `json:"domain_id,omitempty"`
	// Whether to mark the domain as a draft. If omitted on Create, the server
	// applies a default; the resolved value is returned in `effective_draft`.
	Draft bool `json:"draft,omitempty"`
	// Resolved draft state of the domain.
	EffectiveDraft bool `json:"effective_draft,omitempty"`
	// Icon to display for the domain.
	Icon *DomainIcon `json:"icon,omitempty"`
	// Full resource name of the domain. The primary identifier for this
	// resource. Format: `domains/{domain_id}` Identifies the domain on get,
	// update, and delete. Not an input on create — to choose the id, set
	// `CreateDomainRequest.domain_id`.
	Name string `json:"name,omitempty"`
	// Domain ID of the parent. If absent, this is a top-level domain. If
	// present, this domain is a subdomain of the specified parent.
	ParentDomainId string `json:"parent_domain_id,omitempty"`
	// Short description (max 280 chars)
	Subtitle string `json:"subtitle,omitempty"`
	// Governed tag key associated with this domain.
	TagKey string `json:"tag_key"`
	// Principal IDs of the technical owners (users, groups, or service
	// principals).
	TechnicalOwnerIds []int64 `json:"technical_owner_ids,omitempty"`
	// Timestamp when the domain was last updated.
	UpdateTime *time.Time `json:"update_time,omitempty"`

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

type DomainIcon struct {
	// Hex color code with # prefix (e.g., "#FF5733").
	Color string `json:"color,omitempty"`

	Name DomainIconName `json:"name,omitempty"`

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

type DomainIconName string

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

type DomainsInterface interface {

	// Create a domain. If `domain_id` is omitted, the server generates one.
	CreateDomain(ctx context.Context, request CreateDomainRequest) (*Domain, error)

	// Delete a domain. By default the request fails if the domain still has
	// Glossary pages; set `force` to delete those pages along with the domain.
	DeleteDomain(ctx context.Context, request DeleteDomainRequest) error

	// Get a domain by resource name.
	//
	// Authorization: external callers must have the `MANAGE DISCOVERY` permission.
	GetDomain(ctx context.Context, request GetDomainRequest) (*Domain, error)

	// List domains in the account. Set `parent_domain_id` to return only the direct
	// subdomains of a given domain.
	//
	// Authorization: external callers must have the `MANAGE DISCOVERY` permission;
	// only domains the caller is authorized to read are returned.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListDomains(ctx context.Context, request ListDomainsRequest) listing.Iterator[Domain]

	// List domains in the account. Set `parent_domain_id` to return only the direct
	// subdomains of a given domain.
	//
	// Authorization: external callers must have the `MANAGE DISCOVERY` permission;
	// only domains the caller is authorized to read are returned.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListDomainsAll(ctx context.Context, request ListDomainsRequest) ([]Domain, error)

	// Update a domain. `update_mask` selects which fields to modify; the domain is
	// identified by its resource `name`.
	UpdateDomain(ctx context.Context, request UpdateDomainRequest) (*Domain, error)
}

type GetDomainRequest struct {
	// Full resource name of the domain to retrieve. Format:
	// `domains/{domain_id}`
	Name string `json:"-" url:"-"`
}

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

	PageToken string `json:"-" url:"page_token,omitempty"`
	// Filter by parent domain. - Absent: return all domains regardless of
	// hierarchy. - Present: return only direct children of the specified
	// domain.
	ParentDomainId string `json:"-" url:"parent_domain_id,omitempty"`

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

type ListDomainsResponse struct {
	Domains []Domain `json:"domains,omitempty"`

	NextPageToken string `json:"next_page_token,omitempty"`

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

type UpdateDomainRequest struct {
	Domain Domain `json:"domain"`
	// Full resource name of the domain. The primary identifier for this
	// resource. Format: `domains/{domain_id}` Identifies the domain on get,
	// update, and delete. Not an input on create — to choose the id, set
	// `CreateDomainRequest.domain_id`.
	Name string `json:"-" url:"-"`
	// The field mask must be a single string, with multiple fields separated by
	// commas (no spaces). The field path is relative to the resource object,
	// using a dot (`.`) to navigate sub-fields (e.g., `author.given_name`).
	// Specification of elements in sequence or map fields is not allowed, as
	// only the entire collection field can be specified. Field names must
	// exactly match the resource field names.
	//
	// A field mask of `*` indicates full replacement. It’s recommended to
	// always explicitly list the fields being updated and avoid using `*`
	// wildcards, as it can lead to unintended results if the API changes in the
	// future.
	UpdateMask fieldmask.FieldMask `json:"-" url:"update_mask"`
}