Package cloud.google.com/go/policytroubleshooter/apiv1

Package policytroubleshooter is an auto-generated package for the Policy Troubleshooter API.

Use of Context

The ctx passed to NewClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.

To close the open connection, use the Close() method.

For information about setting deadlines, reusing contexts, and more please visit pkg.go.dev/cloud.google.com/go.

Functions

func DefaultAuthScopes

func DefaultAuthScopes() []string

DefaultAuthScopes reports the default set of authentication scopes to use with this package.

IamCheckerCallOptions

type IamCheckerCallOptions struct {
	TroubleshootIamPolicy []gax.CallOption
}

IamCheckerCallOptions contains the retry settings for each method of IamCheckerClient.

IamCheckerClient

type IamCheckerClient struct {

	// The call options for this service.
	CallOptions *IamCheckerCallOptions
	// contains filtered or unexported fields
}

IamCheckerClient is a client for interacting with Policy Troubleshooter API.

Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

func NewIamCheckerClient

func NewIamCheckerClient(ctx context.Context, opts ...option.ClientOption) (*IamCheckerClient, error)

NewIamCheckerClient creates a new iam checker client.

IAM Policy Troubleshooter service.

This service helps you troubleshoot access issues for Google Cloud resources.

Example

package main

import (
	policytroubleshooter "cloud.google.com/go/policytroubleshooter/apiv1"
	"context"
)

func main() {
	ctx := context.Background()
	c, err := policytroubleshooter.NewIamCheckerClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use client.
	_ = c
}

func (*IamCheckerClient) Close

func (c *IamCheckerClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*IamCheckerClient) Connection

func (c *IamCheckerClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated.

func (*IamCheckerClient) TroubleshootIamPolicy

TroubleshootIamPolicy checks whether a member has a specific permission for a specific resource, and explains why the member does or does not have that permission.

Example

package main

import (
	policytroubleshooter "cloud.google.com/go/policytroubleshooter/apiv1"
	"context"
	policytroubleshooterpb "google.golang.org/genproto/googleapis/cloud/policytroubleshooter/v1"
)

func main() {
	// import policytroubleshooterpb "google.golang.org/genproto/googleapis/cloud/policytroubleshooter/v1"

	ctx := context.Background()
	c, err := policytroubleshooter.NewIamCheckerClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}

	req := &policytroubleshooterpb.TroubleshootIamPolicyRequest{
		// TODO: Fill request struct fields.
	}
	resp, err := c.TroubleshootIamPolicy(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}