iamutil

Documentation

Overview

THIS FILE IS AUTOGENERATED USING go generate. DO NOT EDIT.

Index

• Constants
• type AccessBinding
• type ApiHandle
  • func GetApiHandle(client *http.Client, userAgent string) *ApiHandle
  • func (h *ApiHandle) DoGetRequest(ctx context.Context, r Resource, out interface{}) (err error)
  • func (h *ApiHandle) DoSetRequest(ctx context.Context, r Resource, data io.Reader, out interface{}) error
• type Binding
• type Condition
• type Dataset
• type DatasetResource
  • func (r *DatasetResource) GetConfig() *RestResource
  • func (r *DatasetResource) GetIamPolicy(ctx context.Context, h *ApiHandle) (*Policy, error)
  • func (r *DatasetResource) GetRelativeId() *gcputil.RelativeResourceName
  • func (r *DatasetResource) SetIamPolicy(ctx context.Context, h *ApiHandle, p *Policy) (*Policy, error)
• type GeneratedResources
  • func GetEnabledResources() GeneratedResources
  • func (apis GeneratedResources) GetRestConfig(rawName string, fullName *gcputil.FullResourceName, prefix string) (*RestResource, error)
  • func (apis GeneratedResources) Parse(rawName string) (Resource, error)
• type IamResource
  • func (r *IamResource) GetConfig() *RestResource
  • func (r *IamResource) GetIamPolicy(ctx context.Context, h *ApiHandle) (*Policy, error)
  • func (r *IamResource) GetRelativeId() *gcputil.RelativeResourceName
  • func (r *IamResource) SetIamPolicy(ctx context.Context, h *ApiHandle, p *Policy) (*Policy, error)
• type Policy
  • func (p *Policy) AddBindings(toAdd *PolicyDelta) (changed bool, updated *Policy)
  • func (p *Policy) ChangedBindings(toAdd *PolicyDelta, toRemove *PolicyDelta) (changed bool, updated *Policy)
  • func (p *Policy) RemoveBindings(toRemove *PolicyDelta) (changed bool, updated *Policy)
• type PolicyDelta
• type Resource
• type ResourceParser
• type RestMethod
• type RestResource

Constants

const (
	ServiceAccountMemberTmpl = "serviceAccount:%s"
)

Types

type AccessBinding

type AccessBinding struct {
	Role         string `json:"role,omitempty"`
	UserByEmail  string `json:"userByEmail,omitempty"`
	GroupByEmail string `json:"groupByEmail,omitempty"`
}

NOTE: BigQuery does not conform to the typical REST for IAM policies instead it has an access array with bindings on the dataset object. https://cloud.google.com/bigquery/docs/reference/rest/v2/datasets#Dataset

type ApiHandle

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

func GetApiHandle

func GetApiHandle(client *http.Client, userAgent string) *ApiHandle

func (*ApiHandle) DoGetRequest

func (h *ApiHandle) DoGetRequest(ctx context.Context, r Resource, out interface{}) (err error)

func (*ApiHandle) DoSetRequest

func (h *ApiHandle) DoSetRequest(ctx context.Context, r Resource, data io.Reader, out interface{}) error

type Binding

type Binding struct {
	Members   []string   `json:"members,omitempty"`
	Role      string     `json:"role,omitempty"`
	Condition *Condition `json:"condition,omitempty"`
}

type Condition

type Condition struct {
	Title       string `json:"title,omitempty"`
	Description string `json:"description,omitempty"`
	Expression  string `json:"expression,omitempty"`
}

type Dataset

type Dataset struct {
	Access []*AccessBinding `json:"access,omitempty"`
	Etag   string           `json:"etag,omitempty"`
}

type DatasetResource

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

NOTE: DatasetResource implements IamResource. This is because bigquery datasets have their own ACLs instead of an IAM policy

func (*DatasetResource) GetConfig

func (r *DatasetResource) GetConfig() *RestResource

func (*DatasetResource) GetIamPolicy

func (r *DatasetResource) GetIamPolicy(ctx context.Context, h *ApiHandle) (*Policy, error)

func (*DatasetResource) GetRelativeId

func (r *DatasetResource) GetRelativeId() *gcputil.RelativeResourceName

func (*DatasetResource) SetIamPolicy

func (r *DatasetResource) SetIamPolicy(ctx context.Context, h *ApiHandle, p *Policy) (*Policy, error)

type GeneratedResources

type GeneratedResources map[string]map[string]map[string]RestResource

GeneratedResources implements ResourceParser - a value is generated using internal/generate_iam.go

func GetEnabledResources

func GetEnabledResources() GeneratedResources

func (GeneratedResources) GetRestConfig

func (apis GeneratedResources) GetRestConfig(rawName string, fullName *gcputil.FullResourceName, prefix string) (*RestResource, error)

func (GeneratedResources) Parse

func (apis GeneratedResources) Parse(rawName string) (Resource, error)

type IamResource

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

IamResource implements Resource.

func (*IamResource) GetConfig

func (r *IamResource) GetConfig() *RestResource

func (*IamResource) GetIamPolicy

func (r *IamResource) GetIamPolicy(ctx context.Context, h *ApiHandle) (*Policy, error)

func (*IamResource) GetRelativeId

func (r *IamResource) GetRelativeId() *gcputil.RelativeResourceName

func (*IamResource) SetIamPolicy

func (r *IamResource) SetIamPolicy(ctx context.Context, h *ApiHandle, p *Policy) (*Policy, error)

type Policy

type Policy struct {
	Bindings []*Binding `json:"bindings,omitempty"`
	Etag     string     `json:"etag,omitempty"`
	Version  int        `json:"version,omitempty"`
}

func (*Policy) AddBindings

func (p *Policy) AddBindings(toAdd *PolicyDelta) (changed bool, updated *Policy)

func (*Policy) ChangedBindings

func (p *Policy) ChangedBindings(toAdd *PolicyDelta, toRemove *PolicyDelta) (changed bool, updated *Policy)

func (*Policy) RemoveBindings

func (p *Policy) RemoveBindings(toRemove *PolicyDelta) (changed bool, updated *Policy)

type PolicyDelta

type PolicyDelta struct {
	Roles util.StringSet
	Email string
}

type Resource

type Resource interface {
	GetIamPolicy(context.Context, *ApiHandle) (*Policy, error)
	SetIamPolicy(context.Context, *ApiHandle, *Policy) (*Policy, error)
	GetConfig() *RestResource
	GetRelativeId() *gcputil.RelativeResourceName
}

Resource handles constructing HTTP requests for getting and setting IAM policies.

type ResourceParser

type ResourceParser interface {
	Parse(string) (Resource, error)
}

ResourceParser handles parsing resource ID and REST config from a given resource ID or name.

type RestMethod

type RestMethod struct {
	HttpMethod    string
	BaseURL       string
	Path          string
	RequestFormat string
}

type RestResource

type RestResource struct {
	// Name is the base name of the resource
	// i.e. for a GCE instance: "instance"
	Name string

	// TypeKey is the identifying path for the resource, or
	// the RESTful resource identifier without resource IDs
	// i.e. For a GCE instance: "projects/zones/instances"
	TypeKey string

	// Service is the name of the service this resource belongs to.
	Service string

	// IsPreferredVersion is true if this version of the API/resource is preferred.
	IsPreferredVersion bool

	// HTTP metadata for getting Policy data in GCP
	GetMethod RestMethod

	// HTTP metadata for setting Policy data in GCP
	SetMethod RestMethod

	// Ordered parameters to be replaced in method paths
	Parameters []string

	// Mapping of collection ids onto the parameter to be replaced
	CollectionReplacementKeys map[string]string
}