tags

type CreateTagAssignmentRequest struct {
	TagAssignment TagAssignment `json:"tag_assignment"`
}

type CreateTagPolicyRequest struct {
	TagPolicy TagPolicy `json:"tag_policy"`
}

type DeleteTagAssignmentRequest struct {
	// The identifier of the entity to which the tag is assigned
	EntityId string `json:"-" url:"-"`
	// The type of entity to which the tag is assigned. Allowed values are
	// dashboards, geniespaces
	EntityType string `json:"-" url:"-"`
	// The key of the tag. The characters , . : / - = and leading/trailing
	// spaces are not allowed
	TagKey string `json:"-" url:"-"`
}

type DeleteTagPolicyRequest struct {
	TagKey string `json:"-" url:"-"`
}

type GetTagAssignmentRequest struct {
	// The identifier of the entity to which the tag is assigned
	EntityId string `json:"-" url:"-"`
	// The type of entity to which the tag is assigned. Allowed values are
	// dashboards, geniespaces
	EntityType string `json:"-" url:"-"`
	// The key of the tag. The characters , . : / - = and leading/trailing
	// spaces are not allowed
	TagKey string `json:"-" url:"-"`
}

type GetTagPolicyRequest struct {
	TagKey string `json:"-" url:"-"`
}

type ListTagAssignmentsRequest struct {
	// The identifier of the entity to which the tag is assigned
	EntityId string `json:"-" url:"-"`
	// The type of entity to which the tag is assigned. Allowed values are
	// dashboards, geniespaces
	EntityType string `json:"-" url:"-"`
	// Optional. Maximum number of tag assignments to return in a single page
	PageSize int `json:"-" url:"page_size,omitempty"`
	// Pagination token to go to the next page of tag assignments. Requests
	// first page if absent.
	PageToken string `json:"-" url:"page_token,omitempty"`

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

type ListTagAssignmentsResponse struct {
	// Pagination token to request the next page of tag assignments
	NextPageToken string `json:"next_page_token,omitempty"`

	TagAssignments []TagAssignment `json:"tag_assignments,omitempty"`

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

type ListTagPoliciesRequest struct {
	// The maximum number of results to return in this request. Fewer results
	// may be returned than requested. If unspecified or set to 0, this defaults
	// to 1000. The maximum value is 1000; values above 1000 will be coerced
	// down to 1000.
	PageSize int `json:"-" url:"page_size,omitempty"`
	// An optional page token received from a previous list tag policies call.
	PageToken string `json:"-" url:"page_token,omitempty"`

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

type ListTagPoliciesResponse struct {
	NextPageToken string `json:"next_page_token,omitempty"`

	TagPolicies []TagPolicy `json:"tag_policies,omitempty"`

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

type TagAssignment struct {
	// The identifier of the entity to which the tag is assigned
	EntityId string `json:"entity_id"`
	// The type of entity to which the tag is assigned. Allowed values are
	// dashboards, geniespaces
	EntityType string `json:"entity_type"`
	// The key of the tag. The characters , . : / - = and leading/trailing
	// spaces are not allowed
	TagKey string `json:"tag_key"`
	// The value of the tag
	TagValue string `json:"tag_value,omitempty"`

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

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

type TagPoliciesInterface interface {

	// Creates a new tag policy, making the associated tag key governed. For
	// Terraform usage, see the [Tag Policy Terraform documentation]. To manage
	// permissions for tag policies, use the [Account Access Control Proxy API].
	//
	// [Account Access Control Proxy API]: https://docs.databricks.com/api/workspace/accountaccesscontrolproxy
	// [Tag Policy Terraform documentation]: https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/tag_policy
	CreateTagPolicy(ctx context.Context, request CreateTagPolicyRequest) (*TagPolicy, error)

	// Deletes a tag policy by its associated governed tag's key, leaving that tag
	// key ungoverned. For Terraform usage, see the [Tag Policy Terraform
	// documentation].
	//
	// [Tag Policy Terraform documentation]: https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/tag_policy
	DeleteTagPolicy(ctx context.Context, request DeleteTagPolicyRequest) error

	// Gets a single tag policy by its associated governed tag's key. For Terraform
	// usage, see the [Tag Policy Terraform documentation]. To list granted
	// permissions for tag policies, use the [Account Access Control Proxy API].
	//
	// [Account Access Control Proxy API]: https://docs.databricks.com/api/workspace/accountaccesscontrolproxy
	// [Tag Policy Terraform documentation]: https://registry.terraform.io/providers/databricks/databricks/latest/docs/data-sources/tag_policy
	GetTagPolicy(ctx context.Context, request GetTagPolicyRequest) (*TagPolicy, error)

	// Lists the tag policies for all governed tags in the account. For Terraform
	// usage, see the [Tag Policy Terraform documentation]. To list granted
	// permissions for tag policies, use the [Account Access Control Proxy API].
	//
	// [Account Access Control Proxy API]: https://docs.databricks.com/api/workspace/accountaccesscontrolproxy
	// [Tag Policy Terraform documentation]: https://registry.terraform.io/providers/databricks/databricks/latest/docs/data-sources/tag_policies
	//
	// This method is generated by Databricks SDK Code Generator.
	ListTagPolicies(ctx context.Context, request ListTagPoliciesRequest) listing.Iterator[TagPolicy]

	// Lists the tag policies for all governed tags in the account. For Terraform
	// usage, see the [Tag Policy Terraform documentation]. To list granted
	// permissions for tag policies, use the [Account Access Control Proxy API].
	//
	// [Account Access Control Proxy API]: https://docs.databricks.com/api/workspace/accountaccesscontrolproxy
	// [Tag Policy Terraform documentation]: https://registry.terraform.io/providers/databricks/databricks/latest/docs/data-sources/tag_policies
	//
	// This method is generated by Databricks SDK Code Generator.
	ListTagPoliciesAll(ctx context.Context, request ListTagPoliciesRequest) ([]TagPolicy, error)

	// Updates an existing tag policy for a single governed tag. For Terraform
	// usage, see the [Tag Policy Terraform documentation]. To manage permissions
	// for tag policies, use the [Account Access Control Proxy API].
	//
	// [Account Access Control Proxy API]: https://docs.databricks.com/api/workspace/accountaccesscontrolproxy
	// [Tag Policy Terraform documentation]: https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/tag_policy
	UpdateTagPolicy(ctx context.Context, request UpdateTagPolicyRequest) (*TagPolicy, error)
}

type TagPolicy struct {
	// Timestamp when the tag policy was created
	CreateTime string `json:"create_time,omitempty"`

	Description string `json:"description,omitempty"`

	Id string `json:"id,omitempty"`

	TagKey string `json:"tag_key"`
	// Timestamp when the tag policy was last updated
	UpdateTime string `json:"update_time,omitempty"`

	Values []Value `json:"values,omitempty"`

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

type UpdateTagAssignmentRequest struct {
	// The identifier of the entity to which the tag is assigned
	EntityId string `json:"-" url:"-"`
	// The type of entity to which the tag is assigned. Allowed values are
	// dashboards, geniespaces
	EntityType string `json:"-" url:"-"`

	TagAssignment TagAssignment `json:"tag_assignment"`
	// The key of the tag. The characters , . : / - = and leading/trailing
	// spaces are not allowed
	TagKey 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 string `json:"-" url:"update_mask"`
}

type UpdateTagPolicyRequest struct {
	TagKey string `json:"-" url:"-"`

	TagPolicy TagPolicy `json:"tag_policy"`
	// 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 string `json:"-" url:"update_mask"`
}

type Value struct {
	Name string `json:"name"`
}

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

type WorkspaceEntityTagAssignmentsInterface interface {

	// Create a tag assignment
	CreateTagAssignment(ctx context.Context, request CreateTagAssignmentRequest) (*TagAssignment, error)

	// Delete a tag assignment
	DeleteTagAssignment(ctx context.Context, request DeleteTagAssignmentRequest) error

	// Get a tag assignment
	GetTagAssignment(ctx context.Context, request GetTagAssignmentRequest) (*TagAssignment, error)

	// List the tag assignments for an entity
	//
	// This method is generated by Databricks SDK Code Generator.
	ListTagAssignments(ctx context.Context, request ListTagAssignmentsRequest) listing.Iterator[TagAssignment]

	// List the tag assignments for an entity
	//
	// This method is generated by Databricks SDK Code Generator.
	ListTagAssignmentsAll(ctx context.Context, request ListTagAssignmentsRequest) ([]TagAssignment, error)

	// Update a tag assignment
	UpdateTagAssignment(ctx context.Context, request UpdateTagAssignmentRequest) (*TagAssignment, error)
}