package policytroubleshooter

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

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

General documentation

For information that is relevant for all client libraries please reference https://pkg.go.dev/cloud.google.com/go#pkg-overview. Some information on this page includes:

• Authentication and Authorization
• Timeouts and Cancellation
• Testing against Client Libraries
• Debugging Client Libraries
• Inspecting errors

Example usage

To get started with this package, create a client.

// go get cloud.google.com/go/policytroubleshooter/apiv1@latest
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, mentioned above.

req := &policytroubleshooterpb.TroubleshootIamPolicyRequest{
	// TODO: Fill request struct fields.
	// See https://pkg.go.dev/cloud.google.com/go/policytroubleshooter/apiv1/policytroubleshooterpb#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.

Index ¶

• func DefaultAuthScopes() []string
• type IamCheckerCallOptions
• type IamCheckerClient
• func NewIamCheckerClient(ctx context.Context, opts ...option.ClientOption) (*IamCheckerClient, error)
• func NewIamCheckerRESTClient(ctx context.Context, opts ...option.ClientOption) (*IamCheckerClient, error)
• func (c *IamCheckerClient) Close() error
• func (c *IamCheckerClient) Connection() *grpc.ClientConn
• func (c *IamCheckerClient) TroubleshootIamPolicy(ctx context.Context, req *policytroubleshooterpb.TroubleshootIamPolicyRequest, opts ...gax.CallOption) (*policytroubleshooterpb.TroubleshootIamPolicyResponse, error)

Examples ¶

• IamCheckerClient.TroubleshootIamPolicy
• NewIamCheckerClient
• NewIamCheckerRESTClient

Functions ¶

func DefaultAuthScopes ¶

func DefaultAuthScopes() []string

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

Types ¶

type IamCheckerCallOptions ¶

type IamCheckerCallOptions struct {
	TroubleshootIamPolicy []gax.CallOption
}

IamCheckerCallOptions contains the retry settings for each method of IamCheckerClient.

type 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.

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 NewIamCheckerRESTClient ¶

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

NewIamCheckerRESTClient creates a new iam checker rest client.

IAM Policy Troubleshooter service.

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

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.NewIamCheckerRESTClient(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 ¶

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 ¶

func (c *IamCheckerClient) TroubleshootIamPolicy(ctx context.Context, req *policytroubleshooterpb.TroubleshootIamPolicyRequest, opts ...gax.CallOption) (*policytroubleshooterpb.TroubleshootIamPolicyResponse, error)

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

package main

import (
	"context"

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

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/cloud.google.com/go/policytroubleshooter/apiv1/policytroubleshooterpb#TroubleshootIamPolicyRequest.
	}
	resp, err := c.TroubleshootIamPolicy(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

Source Files ¶

auxiliary.go auxiliary_go123.go doc.go helpers.go iam_checker_client.go version.go

Directories ¶