Policy Troubleshooter API v1 - Package cloud.google.com/go/policytroubleshooter/apiv1 (v1.3.0)

Stay organized with collections Save and categorize content based on your preferences.

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

Example usage

To get started with this package, create a client.

ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := policytroubleshooter.NewIamCheckerClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.

Using the Client

The following is an example of making an API call with the newly created client.

ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := policytroubleshooter.NewIamCheckerClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

req := &policytroubleshooterpb.TroubleshootIamPolicyRequest{
    // TODO: Fill request struct fields.
    // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/policytroubleshooter/v1#TroubleshootIamPolicyRequest.
}
resp, err := c.TroubleshootIamPolicy(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

Use of Context

The ctx passed to NewIamCheckerClient 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 https://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.

IAM Policy Troubleshooter service.

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

func NewIamCheckerClient

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

NewIamCheckerClient creates a new iam checker client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

IAM Policy Troubleshooter service.

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

Example

package main

import (
	"context"

	policytroubleshooter "cloud.google.com/go/policytroubleshooter/apiv1"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := policytroubleshooter.NewIamCheckerClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// 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 (deprecated)

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

Connection returns a connection to the API service.

Deprecated: Connections are now pooled so this method does not always return the same resource.

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 (
	"context"

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

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := policytroubleshooter.NewIamCheckerClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &policytroubleshooterpb.TroubleshootIamPolicyRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/policytroubleshooter/v1#TroubleshootIamPolicyRequest.
	}
	resp, err := c.TroubleshootIamPolicy(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}