firebaserules

Documentation

Overview

Copyright 2023 Google LLC. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2023 Google LLC. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• func ApplyRelease(ctx context.Context, config *dcl.Config, u *unstructured.Resource, ...) (*unstructured.Resource, error)
• func ApplyRuleset(ctx context.Context, config *dcl.Config, u *unstructured.Resource, ...) (*unstructured.Resource, error)
• func DeleteRelease(ctx context.Context, config *dcl.Config, u *unstructured.Resource) error
• func DeleteRuleset(ctx context.Context, config *dcl.Config, u *unstructured.Resource) error
• func GetRelease(ctx context.Context, config *dcl.Config, u *unstructured.Resource) (*unstructured.Resource, error)
• func GetRuleset(ctx context.Context, config *dcl.Config, u *unstructured.Resource) (*unstructured.Resource, error)
• func ListRelease(ctx context.Context, config *dcl.Config, project string) ([]*unstructured.Resource, error)
• func ListRuleset(ctx context.Context, config *dcl.Config, project string) ([]*unstructured.Resource, error)
• func ReleaseHasDiff(ctx context.Context, config *dcl.Config, u *unstructured.Resource, ...) (bool, error)
• func ReleaseID(u *unstructured.Resource) (string, error)
• func ReleaseToUnstructured(r *dclService.Release) *unstructured.Resource
• func RulesetHasDiff(ctx context.Context, config *dcl.Config, u *unstructured.Resource, ...) (bool, error)
• func RulesetID(u *unstructured.Resource) (string, error)
• func RulesetToUnstructured(r *dclService.Ruleset) *unstructured.Resource
• func UnstructuredToRelease(u *unstructured.Resource) (*dclService.Release, error)
• func UnstructuredToRuleset(u *unstructured.Resource) (*dclService.Ruleset, error)
• type Release
  • func (r *Release) Apply(ctx context.Context, config *dcl.Config, resource *unstructured.Resource, ...) (*unstructured.Resource, error)
  • func (r *Release) Delete(ctx context.Context, config *dcl.Config, resource *unstructured.Resource) error
  • func (r *Release) DeletePolicyMember(ctx context.Context, config *dcl.Config, resource *unstructured.Resource, ...) error
  • func (r *Release) Get(ctx context.Context, config *dcl.Config, resource *unstructured.Resource) (*unstructured.Resource, error)
  • func (r *Release) GetPolicy(ctx context.Context, config *dcl.Config, resource *unstructured.Resource) (*unstructured.Resource, error)
  • func (r *Release) GetPolicyMember(ctx context.Context, config *dcl.Config, resource *unstructured.Resource, ...) (*unstructured.Resource, error)
  • func (r *Release) HasDiff(ctx context.Context, config *dcl.Config, resource *unstructured.Resource, ...) (bool, error)
  • func (r *Release) ID(resource *unstructured.Resource) (string, error)
  • func (r *Release) STV() unstructured.ServiceTypeVersion
  • func (r *Release) SetPolicy(ctx context.Context, config *dcl.Config, resource *unstructured.Resource, ...) (*unstructured.Resource, error)
  • func (r *Release) SetPolicyMember(ctx context.Context, config *dcl.Config, resource *unstructured.Resource, ...) (*unstructured.Resource, error)
  • func (r *Release) SetPolicyWithEtag(ctx context.Context, config *dcl.Config, resource *unstructured.Resource, ...) (*unstructured.Resource, error)
• type Ruleset
  • func (r *Ruleset) Apply(ctx context.Context, config *dcl.Config, resource *unstructured.Resource, ...) (*unstructured.Resource, error)
  • func (r *Ruleset) Delete(ctx context.Context, config *dcl.Config, resource *unstructured.Resource) error
  • func (r *Ruleset) DeletePolicyMember(ctx context.Context, config *dcl.Config, resource *unstructured.Resource, ...) error
  • func (r *Ruleset) Get(ctx context.Context, config *dcl.Config, resource *unstructured.Resource) (*unstructured.Resource, error)
  • func (r *Ruleset) GetPolicy(ctx context.Context, config *dcl.Config, resource *unstructured.Resource) (*unstructured.Resource, error)
  • func (r *Ruleset) GetPolicyMember(ctx context.Context, config *dcl.Config, resource *unstructured.Resource, ...) (*unstructured.Resource, error)
  • func (r *Ruleset) HasDiff(ctx context.Context, config *dcl.Config, resource *unstructured.Resource, ...) (bool, error)
  • func (r *Ruleset) ID(resource *unstructured.Resource) (string, error)
  • func (r *Ruleset) STV() unstructured.ServiceTypeVersion
  • func (r *Ruleset) SetPolicy(ctx context.Context, config *dcl.Config, resource *unstructured.Resource, ...) (*unstructured.Resource, error)
  • func (r *Ruleset) SetPolicyMember(ctx context.Context, config *dcl.Config, resource *unstructured.Resource, ...) (*unstructured.Resource, error)
  • func (r *Ruleset) SetPolicyWithEtag(ctx context.Context, config *dcl.Config, resource *unstructured.Resource, ...) (*unstructured.Resource, error)

Functions

func ApplyRelease

func ApplyRelease(ctx context.Context, config *dcl.Config, u *unstructured.Resource, opts ...dcl.ApplyOption) (*unstructured.Resource, error)

func ApplyRuleset

func ApplyRuleset(ctx context.Context, config *dcl.Config, u *unstructured.Resource, opts ...dcl.ApplyOption) (*unstructured.Resource, error)

func DeleteRelease

func DeleteRelease(ctx context.Context, config *dcl.Config, u *unstructured.Resource) error

func DeleteRuleset

func DeleteRuleset(ctx context.Context, config *dcl.Config, u *unstructured.Resource) error

func GetRelease

func GetRelease(ctx context.Context, config *dcl.Config, u *unstructured.Resource) (*unstructured.Resource, error)

func GetRuleset

func GetRuleset(ctx context.Context, config *dcl.Config, u *unstructured.Resource) (*unstructured.Resource, error)

func ListRelease

func ListRelease(ctx context.Context, config *dcl.Config, project string) ([]*unstructured.Resource, error)

func ListRuleset

func ListRuleset(ctx context.Context, config *dcl.Config, project string) ([]*unstructured.Resource, error)

func ReleaseHasDiff

func ReleaseHasDiff(ctx context.Context, config *dcl.Config, u *unstructured.Resource, opts ...dcl.ApplyOption) (bool, error)

func ReleaseID

func ReleaseID(u *unstructured.Resource) (string, error)

func ReleaseToUnstructured

func ReleaseToUnstructured(r *dclService.Release) *unstructured.Resource

func RulesetHasDiff

func RulesetHasDiff(ctx context.Context, config *dcl.Config, u *unstructured.Resource, opts ...dcl.ApplyOption) (bool, error)

func RulesetID

func RulesetID(u *unstructured.Resource) (string, error)

func RulesetToUnstructured

func RulesetToUnstructured(r *dclService.Ruleset) *unstructured.Resource

func UnstructuredToRelease

func UnstructuredToRelease(u *unstructured.Resource) (*dclService.Release, error)

func UnstructuredToRuleset

func UnstructuredToRuleset(u *unstructured.Resource) (*dclService.Ruleset, error)

Types

type Release

type Release struct{}

func (*Release) Apply

func (r *Release) Apply(ctx context.Context, config *dcl.Config, resource *unstructured.Resource, opts ...dcl.ApplyOption) (*unstructured.Resource, error)

func (*Release) Delete

func (r *Release) Delete(ctx context.Context, config *dcl.Config, resource *unstructured.Resource) error

func (*Release) DeletePolicyMember

func (r *Release) DeletePolicyMember(ctx context.Context, config *dcl.Config, resource *unstructured.Resource, member *unstructured.Resource) error

func (*Release) Get

func (r *Release) Get(ctx context.Context, config *dcl.Config, resource *unstructured.Resource) (*unstructured.Resource, error)

func (*Release) GetPolicy

func (r *Release) GetPolicy(ctx context.Context, config *dcl.Config, resource *unstructured.Resource) (*unstructured.Resource, error)

func (*Release) GetPolicyMember

func (r *Release) GetPolicyMember(ctx context.Context, config *dcl.Config, resource *unstructured.Resource, role, member string) (*unstructured.Resource, error)

func (*Release) HasDiff

func (r *Release) HasDiff(ctx context.Context, config *dcl.Config, resource *unstructured.Resource, opts ...dcl.ApplyOption) (bool, error)

func (*Release) ID

func (r *Release) ID(resource *unstructured.Resource) (string, error)

func (*Release) STV

func (r *Release) STV() unstructured.ServiceTypeVersion

func (*Release) SetPolicy

func (r *Release) SetPolicy(ctx context.Context, config *dcl.Config, resource *unstructured.Resource, policy *unstructured.Resource) (*unstructured.Resource, error)

func (*Release) SetPolicyMember

func (r *Release) SetPolicyMember(ctx context.Context, config *dcl.Config, resource *unstructured.Resource, member *unstructured.Resource) (*unstructured.Resource, error)

func (*Release) SetPolicyWithEtag

func (r *Release) SetPolicyWithEtag(ctx context.Context, config *dcl.Config, resource *unstructured.Resource, policy *unstructured.Resource) (*unstructured.Resource, error)

type Ruleset

type Ruleset struct{}

func (*Ruleset) Apply

func (r *Ruleset) Apply(ctx context.Context, config *dcl.Config, resource *unstructured.Resource, opts ...dcl.ApplyOption) (*unstructured.Resource, error)

func (*Ruleset) Delete

func (r *Ruleset) Delete(ctx context.Context, config *dcl.Config, resource *unstructured.Resource) error

func (*Ruleset) DeletePolicyMember

func (r *Ruleset) DeletePolicyMember(ctx context.Context, config *dcl.Config, resource *unstructured.Resource, member *unstructured.Resource) error

func (*Ruleset) Get

func (r *Ruleset) Get(ctx context.Context, config *dcl.Config, resource *unstructured.Resource) (*unstructured.Resource, error)

func (*Ruleset) GetPolicy

func (r *Ruleset) GetPolicy(ctx context.Context, config *dcl.Config, resource *unstructured.Resource) (*unstructured.Resource, error)

func (*Ruleset) GetPolicyMember

func (r *Ruleset) GetPolicyMember(ctx context.Context, config *dcl.Config, resource *unstructured.Resource, role, member string) (*unstructured.Resource, error)

func (*Ruleset) HasDiff

func (r *Ruleset) HasDiff(ctx context.Context, config *dcl.Config, resource *unstructured.Resource, opts ...dcl.ApplyOption) (bool, error)

func (*Ruleset) ID

func (r *Ruleset) ID(resource *unstructured.Resource) (string, error)

func (*Ruleset) STV

func (r *Ruleset) STV() unstructured.ServiceTypeVersion

func (*Ruleset) SetPolicy

func (r *Ruleset) SetPolicy(ctx context.Context, config *dcl.Config, resource *unstructured.Resource, policy *unstructured.Resource) (*unstructured.Resource, error)

func (*Ruleset) SetPolicyMember

func (r *Ruleset) SetPolicyMember(ctx context.Context, config *dcl.Config, resource *unstructured.Resource, member *unstructured.Resource) (*unstructured.Resource, error)

func (*Ruleset) SetPolicyWithEtag

func (r *Ruleset) SetPolicyWithEtag(ctx context.Context, config *dcl.Config, resource *unstructured.Resource, policy *unstructured.Resource) (*unstructured.Resource, error)