package iam

Import Path
	cloud.google.com/go/iam (on go.dev)

Dependency Relation
	imports 8 packages, and imported by 2 packages

Involved Source Files

	   d➜ iam.go
		Package iam supports the resource-specific operations of Google Cloud
		IAM (Identity and Access Management) for the Google Cloud Libraries.
		See https://cloud.google.com/iam for more about IAM.

		Users of the Google Cloud Libraries will typically not use this package
		directly. Instead they will begin with some resource that supports IAM, like
		a pubsub topic, and call its IAM method to get a Handle for that resource.
Package-Level Type Names (total 7, in which 5 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Handle (struct)
		A Handle provides IAM operations for a resource.

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			c client
			resource string
		Methods (total 4, all are exported)
			(*T) Policy(ctx context.Context) (*Policy, error)
				Policy retrieves the IAM policy for the resource.

			(*T) SetPolicy(ctx context.Context, policy *Policy) error
				SetPolicy replaces the resource's current policy with the supplied Policy.

				If policy was created from a prior call to Get, then the modification will
				only succeed if the policy has not changed since the Get.

			(*T) TestPermissions(ctx context.Context, permissions []string) ([]string, error)
				TestPermissions returns the subset of permissions that the caller has on the resource.

			(*T) V3() *Handle3
				V3 returns a Handle3, which is like Handle except it sets
				requestedPolicyVersion to 3 when retrieving a policy and policy.version to 3
				when storing a policy.

		As Outputs Of (at least 5, all are exported)
			func InternalNewHandle(conn grpc.ClientConnInterface, resource string) *Handle
			func InternalNewHandleClient(c client, resource string) *Handle
			func InternalNewHandleGRPCClient(c pb.IAMPolicyClient, resource string) *Handle
			func cloud.google.com/go/secretmanager/apiv1.(*Client).IAM(name string) *Handle
			func cloud.google.com/go/storage.(*BucketHandle).IAM() *Handle

	 type Handle3 (struct)
		A Handle3 provides IAM operations for a resource. It is similar to a Handle, but provides access to newer IAM features (e.g., conditions).

		Fields (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			c client
			resource string
			version int32
		Methods (total 3, all are exported)
			(*T) Policy(ctx context.Context) (*Policy3, error)
				Policy retrieves the IAM policy for the resource.

				requestedPolicyVersion is always set to 3.

			(*T) SetPolicy(ctx context.Context, policy *Policy3) error
				SetPolicy replaces the resource's current policy with the supplied Policy.

				If policy was created from a prior call to Get, then the modification will
				only succeed if the policy has not changed since the Get.

			(*T) TestPermissions(ctx context.Context, permissions []string) ([]string, error)
				TestPermissions returns the subset of permissions that the caller has on the resource.

		As Outputs Of (at least one exported)
			func (*Handle).V3() *Handle3

	 type Policy (struct)
		A Policy is a list of Bindings representing roles
		granted to members.

		The zero Policy is a valid policy with no bindings.

		Fields (only one, which is exported)
			InternalProto *pb.Policy
				This field is exported for use by the Google Cloud Libraries only.
				It may become unexported in a future release.

		Methods (total 7, in which 5 are exported)
			(*T) Add(member string, r RoleName)
				Add adds member member to role r if it is not already present.
				A new binding is created if there is no binding for the role.

			(*T) HasRole(member string, r RoleName) bool
				HasRole reports whether member has role r.

			(*T) Members(r RoleName) []string
				Members returns the list of members with the supplied role.
				The return value should not be modified. Use Add and Remove
				to modify the members of a role.

			(*T) Remove(member string, r RoleName)
				Remove removes member from role r if it is present.

			(*T) Roles() []RoleName
				Roles returns the names of all the roles that appear in the Policy.

			/* 2 unexporteds ... *//* 2 unexporteds: */
			(*T) binding(r RoleName) *pb.Binding
				binding returns the Binding for the suppied role, or nil if there isn't one.

			(*T) bindingIndex(r RoleName) int
		As Outputs Of (at least one exported)
			func (*Handle).Policy(ctx context.Context) (*Policy, error)
		As Inputs Of (at least one exported)
			func (*Handle).SetPolicy(ctx context.Context, policy *Policy) error

	 type Policy3 (struct)
		A Policy3 is a list of Bindings representing roles granted to members.

		The zero Policy3 is a valid policy with no bindings.

		It is similar to a Policy, except a Policy3 provides direct access to the
		list of Bindings.

		The policy version is always set to 3.

		Fields (total 2, in which 1 are exported)
			Bindings []*pb.Binding
			/* one unexported ... *//* one unexported: */
			etag []byte
		As Outputs Of (at least one exported)
			func (*Handle3).Policy(ctx context.Context) (*Policy3, error)
		As Inputs Of (at least one exported)
			func (*Handle3).SetPolicy(ctx context.Context, policy *Policy3) error

	 type RoleName string (basic type)
		A RoleName is a name representing a collection of permissions.

		As Outputs Of (at least one exported)
			func (*Policy).Roles() []RoleName
		As Inputs Of (at least 6, in which 4 are exported)
			func (*Policy).Add(member string, r RoleName)
			func (*Policy).HasRole(member string, r RoleName) bool
			func (*Policy).Members(r RoleName) []string
			func (*Policy).Remove(member string, r RoleName)
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func (*Policy).binding(r RoleName) *pb.Binding
			func (*Policy).bindingIndex(r RoleName) int
		As Types Of (total 3, all are exported)
			const Editor
			const Owner
			const Viewer

	/* 2 unexporteds ... *//* 2 unexporteds: */
	 type client (interface)
		client abstracts the IAMPolicy API to allow multiple implementations.

		Methods (total 4, all are exported)
			( T) Get(ctx context.Context, resource string) (*pb.Policy, error)
			( T) GetWithVersion(ctx context.Context, resource string, requestedPolicyVersion int32) (*pb.Policy, error)
			( T) Set(ctx context.Context, resource string, p *pb.Policy) error
			( T) Test(ctx context.Context, resource string, perms []string) ([]string, error)
		Implemented By (at least 2, neither is exported)
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			*grpcClient
			*cloud.google.com/go/storage.iamClient
		As Inputs Of (at least one exported)
			func InternalNewHandleClient(c client, resource string) *Handle

	 type grpcClient (struct)
		grpcClient implements client for the standard gRPC-based IAMPolicy service.

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			c pb.IAMPolicyClient
		Methods (total 4, all are exported)
			(*T) Get(ctx context.Context, resource string) (*pb.Policy, error)
			(*T) GetWithVersion(ctx context.Context, resource string, requestedPolicyVersion int32) (*pb.Policy, error)
			(*T) Set(ctx context.Context, resource string, p *pb.Policy) error
			(*T) Test(ctx context.Context, resource string, perms []string) ([]string, error)
		Implements (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			*T : client


Package-Level Functions (total 5, in which 3 are exported)

	 func InternalNewHandle(conn grpc.ClientConnInterface, resource string) *Handle
		InternalNewHandle is for use by the Google Cloud Libraries only.

		InternalNewHandle returns a Handle for resource.
		The conn parameter refers to a server that must support the IAMPolicy service.

	 func InternalNewHandleClient(c client, resource string) *Handle
		InternalNewHandleClient is for use by the Google Cloud Libraries only.

		InternalNewHandleClient returns a Handle for resource using the given
		client implementation.

	 func InternalNewHandleGRPCClient(c pb.IAMPolicyClient, resource string) *Handle
		InternalNewHandleGRPCClient is for use by the Google Cloud Libraries only.

		InternalNewHandleClient returns a Handle for resource using the given
		grpc service that implements IAM as a mixin

	/* 2 unexporteds ... *//* 2 unexporteds: */
	 func insertMetadata(ctx context.Context, mds ...metadata.MD) context.Context
		insertMetadata inserts metadata into the given context

	 func memberIndex(m string, b *pb.Binding) int
		memberIndex returns the index of m in b's Members, or -1 if not found.


Package-Level Variables (only one, which is unexported)

	/* one unexported ... *//* one unexported: */
	  var withRetry gax.CallOption
Package-Level Constants (total 5, all are exported)

	const AllAuthenticatedUsers = "allAuthenticatedUsers"
		AllAuthenticatedUsers is a special member that denotes all authenticated users.

	const AllUsers = "allUsers"
		AllUsers is a special member that denotes all users, even unauthenticated ones.

	const Editor RoleName = "roles/editor"
		Common role names.

	const Owner RoleName = "roles/owner"
		Common role names.

	const Viewer RoleName = "roles/viewer"
		Common role names.

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.