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

Package resourcesettings is an auto-generated package for the Resource Settings API.

The Resource Settings API allows users to control and modify the behavior of their GCP resources (e.g., VM, firewall, Project, etc.) across the Cloud Resource Hierarchy.

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.

CallOptions

type CallOptions struct {
	ListSettings                []gax.CallOption
	SearchSettingValues         []gax.CallOption
	GetSettingValue             []gax.CallOption
	LookupEffectiveSettingValue []gax.CallOption
	CreateSettingValue          []gax.CallOption
	UpdateSettingValue          []gax.CallOption
	DeleteSettingValue          []gax.CallOption
}

CallOptions contains the retry settings for each method of Client.

Client

type Client struct {

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

Client is a client for interacting with Resource Settings API.

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

func NewClient

func NewClient(ctx context.Context, opts ...option.ClientOption) (*Client, error)

NewClient creates a new resource settings service client.

An interface to interact with resource settings and setting values throughout the resource hierarchy.

Services may surface a number of settings for users to control how their resources behave. Setting values applied on a given Cloud resource are evaluated hierarchically and inherited by all descendants of that resource.

For all requests, returns a google.rpc.Status with google.rpc.Code.PERMISSION_DENIED if the IAM check fails or the parent resource is not in a Cloud Organization. For all requests, returns a google.rpc.Status with google.rpc.Code.INVALID_ARGUMENT if the request is malformed.

Example

package main

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

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

func (*Client) Close

func (c *Client) Close() error

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

func (*Client) Connection

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

Connection returns a connection to the API service.

Deprecated.

func (*Client) CreateSettingValue

CreateSettingValue creates a setting value.

Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the setting does not exist. Returns a google.rpc.Status with google.rpc.Code.ALREADY_EXISTS if the setting value already exists on the given Cloud resource. Returns a google.rpc.Status with google.rpc.Code.FAILED_PRECONDITION if the setting is flagged as read only.

Example

package main

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

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

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

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

func (*Client) DeleteSettingValue

func (c *Client) DeleteSettingValue(ctx context.Context, req *resourcesettingspb.DeleteSettingValueRequest, opts ...gax.CallOption) error

DeleteSettingValue deletes a setting value. If the setting value does not exist, the operation is a no-op.

Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the setting or the setting value does not exist. The setting value will not exist if a prior call to DeleteSettingValue for the setting value already returned a success code. Returns a google.rpc.Status with google.rpc.Code.FAILED_PRECONDITION if the setting is flagged as read only.

Example

package main

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

func main() {
	ctx := context.Background()
	c, err := resourcesettings.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}

	req := &resourcesettingspb.DeleteSettingValueRequest{
		// TODO: Fill request struct fields.
	}
	err = c.DeleteSettingValue(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}

func (*Client) GetSettingValue

GetSettingValue gets a setting value.

Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the setting value does not exist.

Example

package main

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

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

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

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

func (*Client) ListSettings

ListSettings lists all the settings that are available on the Cloud resource parent.

Example

package main

import (
	resourcesettings "cloud.google.com/go/resourcesettings/apiv1"
	"context"
	"google.golang.org/api/iterator"
	resourcesettingspb "google.golang.org/genproto/googleapis/cloud/resourcesettings/v1"
)

func main() {
	// import resourcesettingspb "google.golang.org/genproto/googleapis/cloud/resourcesettings/v1"
	// import "google.golang.org/api/iterator"

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

	req := &resourcesettingspb.ListSettingsRequest{
		// TODO: Fill request struct fields.
	}
	it := c.ListSettings(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*Client) LookupEffectiveSettingValue

LookupEffectiveSettingValue computes the effective setting value of a setting at the Cloud resource parent. The effective setting value is the calculated setting value at a Cloud resource and evaluates to one of the following options in the given order (the next option is used if the previous one does not exist):

the setting value on the given resource

the setting value on the given resource’s nearest ancestor

the setting’s default value

an empty setting value, defined as a SettingValue with all fields unset

Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the setting does not exist.

Example

package main

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

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

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

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

func (*Client) SearchSettingValues

SearchSettingValues searches for all setting values that exist on the resource parent. The setting values are not limited to those of a particular setting.

Example

package main

import (
	resourcesettings "cloud.google.com/go/resourcesettings/apiv1"
	"context"
	"google.golang.org/api/iterator"
	resourcesettingspb "google.golang.org/genproto/googleapis/cloud/resourcesettings/v1"
)

func main() {
	// import resourcesettingspb "google.golang.org/genproto/googleapis/cloud/resourcesettings/v1"
	// import "google.golang.org/api/iterator"

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

	req := &resourcesettingspb.SearchSettingValuesRequest{
		// TODO: Fill request struct fields.
	}
	it := c.SearchSettingValues(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*Client) UpdateSettingValue

UpdateSettingValue updates a setting value.

Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the setting or the setting value does not exist. Returns a google.rpc.Status with google.rpc.Code.FAILED_PRECONDITION if the setting is flagged as read only. Returns a google.rpc.Status with google.rpc.Code.ABORTED if the etag supplied in the request does not match the persisted etag of the setting value.

Note: the supplied setting value will perform a full overwrite of all fields.

Example

package main

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

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

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

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

SettingIterator

type SettingIterator struct {

	// Response is the raw response for the current page.
	// It must be cast to the RPC response type.
	// Calling Next() or InternalFetch() updates this value.
	Response interface{}

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*resourcesettingspb.Setting, nextPageToken string, err error)
	// contains filtered or unexported fields
}

SettingIterator manages a stream of *resourcesettingspb.Setting.

func (*SettingIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*SettingIterator) PageInfo

func (it *SettingIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

SettingValueIterator

type SettingValueIterator struct {

	// Response is the raw response for the current page.
	// It must be cast to the RPC response type.
	// Calling Next() or InternalFetch() updates this value.
	Response interface{}

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*resourcesettingspb.SettingValue, nextPageToken string, err error)
	// contains filtered or unexported fields
}

SettingValueIterator manages a stream of *resourcesettingspb.SettingValue.

func (*SettingValueIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*SettingValueIterator) PageInfo

func (it *SettingValueIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.