Documentation
¶
Overview ¶
The Tag Policy API allows you to manage policies for governed tags in Databricks. Permissions for tag policies can be managed using the Account Access Control Proxy API.
Index ¶
- type CreateTagPolicyRequest
- type DeleteTagPolicyRequest
- type GetTagPolicyRequest
- type ListTagPoliciesRequest
- type ListTagPoliciesResponse
- type TagPoliciesAPI
- func (a *TagPoliciesAPI) CreateTagPolicy(ctx context.Context, request CreateTagPolicyRequest) (*TagPolicy, error)
- func (a *TagPoliciesAPI) DeleteTagPolicy(ctx context.Context, request DeleteTagPolicyRequest) error
- func (a *TagPoliciesAPI) GetTagPolicy(ctx context.Context, request GetTagPolicyRequest) (*TagPolicy, error)
- func (a *TagPoliciesAPI) ListTagPolicies(ctx context.Context, request ListTagPoliciesRequest) listing.Iterator[TagPolicy]
- func (a *TagPoliciesAPI) ListTagPoliciesAll(ctx context.Context, request ListTagPoliciesRequest) ([]TagPolicy, error)
- func (a *TagPoliciesAPI) UpdateTagPolicy(ctx context.Context, request UpdateTagPolicyRequest) (*TagPolicy, error)
- type TagPoliciesInterface
- type TagPoliciesServicedeprecated
- type TagPolicy
- type UpdateTagPolicyRequest
- type Value
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CreateTagPolicyRequest ¶
type CreateTagPolicyRequest struct {
TagPolicy TagPolicy `json:"tag_policy"`
}
type DeleteTagPolicyRequest ¶
type DeleteTagPolicyRequest struct {
TagKey string `json:"-" url:"-"`
}
type GetTagPolicyRequest ¶
type GetTagPolicyRequest struct {
TagKey string `json:"-" url:"-"`
}
type ListTagPoliciesRequest ¶
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:"-"`
}
func (ListTagPoliciesRequest) MarshalJSON ¶
func (s ListTagPoliciesRequest) MarshalJSON() ([]byte, error)
func (*ListTagPoliciesRequest) UnmarshalJSON ¶
func (s *ListTagPoliciesRequest) UnmarshalJSON(b []byte) error
type ListTagPoliciesResponse ¶
type ListTagPoliciesResponse struct {
NextPageToken string `json:"next_page_token,omitempty"`
TagPolicies []TagPolicy `json:"tag_policies,omitempty"`
ForceSendFields []string `json:"-" url:"-"`
}
func (ListTagPoliciesResponse) MarshalJSON ¶
func (s ListTagPoliciesResponse) MarshalJSON() ([]byte, error)
func (*ListTagPoliciesResponse) UnmarshalJSON ¶
func (s *ListTagPoliciesResponse) UnmarshalJSON(b []byte) error
type TagPoliciesAPI ¶
type TagPoliciesAPI struct {
// contains filtered or unexported fields
}
The Tag Policy API allows you to manage policies for governed tags in Databricks. Permissions for tag policies can be managed using the Account Access Control Proxy API.
func NewTagPolicies ¶
func NewTagPolicies(client *client.DatabricksClient) *TagPoliciesAPI
func (*TagPoliciesAPI) CreateTagPolicy ¶
func (a *TagPoliciesAPI) CreateTagPolicy(ctx context.Context, request CreateTagPolicyRequest) (*TagPolicy, error)
func (*TagPoliciesAPI) DeleteTagPolicy ¶
func (a *TagPoliciesAPI) DeleteTagPolicy(ctx context.Context, request DeleteTagPolicyRequest) error
func (*TagPoliciesAPI) GetTagPolicy ¶
func (a *TagPoliciesAPI) GetTagPolicy(ctx context.Context, request GetTagPolicyRequest) (*TagPolicy, error)
func (*TagPoliciesAPI) ListTagPolicies ¶
func (a *TagPoliciesAPI) ListTagPolicies(ctx context.Context, request ListTagPoliciesRequest) listing.Iterator[TagPolicy]
Lists the tag policies for all governed tags in the account.
func (*TagPoliciesAPI) ListTagPoliciesAll ¶
func (a *TagPoliciesAPI) ListTagPoliciesAll(ctx context.Context, request ListTagPoliciesRequest) ([]TagPolicy, error)
Lists the tag policies for all governed tags in the account.
func (*TagPoliciesAPI) UpdateTagPolicy ¶
func (a *TagPoliciesAPI) UpdateTagPolicy(ctx context.Context, request UpdateTagPolicyRequest) (*TagPolicy, error)
type TagPoliciesInterface ¶
type TagPoliciesInterface interface {
// Creates a new tag policy, making the associated tag key governed.
CreateTagPolicy(ctx context.Context, request CreateTagPolicyRequest) (*TagPolicy, error)
// Deletes a tag policy by its associated governed tag's key, leaving that tag
// key ungoverned.
DeleteTagPolicy(ctx context.Context, request DeleteTagPolicyRequest) error
// Gets a single tag policy by its associated governed tag's key.
GetTagPolicy(ctx context.Context, request GetTagPolicyRequest) (*TagPolicy, error)
// Lists the tag policies for all governed tags in the account.
//
// 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.
//
// 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.
UpdateTagPolicy(ctx context.Context, request UpdateTagPolicyRequest) (*TagPolicy, error)
}
type TagPoliciesService
deprecated
type TagPoliciesService interface {
// Creates a new tag policy, making the associated tag key governed.
CreateTagPolicy(ctx context.Context, request CreateTagPolicyRequest) (*TagPolicy, error)
// Deletes a tag policy by its associated governed tag's key, leaving that
// tag key ungoverned.
DeleteTagPolicy(ctx context.Context, request DeleteTagPolicyRequest) error
// Gets a single tag policy by its associated governed tag's key.
GetTagPolicy(ctx context.Context, request GetTagPolicyRequest) (*TagPolicy, error)
// Lists the tag policies for all governed tags in the account.
ListTagPolicies(ctx context.Context, request ListTagPoliciesRequest) (*ListTagPoliciesResponse, error)
// Updates an existing tag policy for a single governed tag.
UpdateTagPolicy(ctx context.Context, request UpdateTagPolicyRequest) (*TagPolicy, error)
}
The Tag Policy API allows you to manage policies for governed tags in Databricks. Permissions for tag policies can be managed using the Account Access Control Proxy API.
Deprecated: Do not use this interface, it will be removed in a future version of the SDK.
type TagPolicy ¶
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:"-"`
}
func (TagPolicy) MarshalJSON ¶
func (*TagPolicy) UnmarshalJSON ¶
type UpdateTagPolicyRequest ¶
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"`
}