diff --git a/internal/.repo-metadata-full.json b/internal/.repo-metadata-full.json index cef63319426..ffe045e4ee0 100644 --- a/internal/.repo-metadata-full.json +++ b/internal/.repo-metadata-full.json @@ -799,6 +799,14 @@ "docs_url": "https://pkg.go.dev/cloud.google.com/go/resourcemanager/apiv2", "release_level": "ga" }, + "cloud.google.com/go/resourcesettings/apiv1": { + "distribution_name": "cloud.google.com/go/resourcesettings/apiv1", + "description": "Resource Settings API", + "language": "Go", + "client_library_type": "generated", + "docs_url": "https://pkg.go.dev/cloud.google.com/go/resourcesettings/apiv1", + "release_level": "beta" + }, "cloud.google.com/go/retail/apiv2": { "distribution_name": "cloud.google.com/go/retail/apiv2", "description": "Retail API", diff --git a/internal/gapicgen/generator/config.go b/internal/gapicgen/generator/config.go index b9defa13cc4..d7a6078cb26 100644 --- a/internal/gapicgen/generator/config.go +++ b/internal/gapicgen/generator/config.go @@ -1045,6 +1045,15 @@ var microgenGapicConfigs = []*microgenConfig{ apiServiceConfigPath: "google/cloud/metastore/v1beta/metastore_v1beta.yaml", releaseLevel: "beta", }, + { + inputDirectoryPath: "google/cloud/resourcesettings/v1", + pkg: "resourcesettings", + importPath: "cloud.google.com/go/resourcesettings/apiv1", + gRPCServiceConfigPath: "google/cloud/resourcesettings/v1/resourcesettings_grpc_service_config.json", + apiServiceConfigPath: "google/cloud/resourcesettings/v1/resourcesettings_v1.yaml", + // GA after 2021/04/23 + releaseLevel: "beta", + }, // Non-Cloud APIs { diff --git a/resourcesettings/apiv1/doc.go b/resourcesettings/apiv1/doc.go new file mode 100644 index 00000000000..5e88b0f2a06 --- /dev/null +++ b/resourcesettings/apiv1/doc.go @@ -0,0 +1,118 @@ +// Copyright 2021 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Code generated by protoc-gen-go_gapic. DO NOT EDIT. + +// 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. +package resourcesettings // import "cloud.google.com/go/resourcesettings/apiv1" + +import ( + "context" + "os" + "runtime" + "strconv" + "strings" + "unicode" + + "google.golang.org/api/option" + "google.golang.org/grpc/metadata" +) + +// For more information on implementing a client constructor hook, see +// https://github.com/googleapis/google-cloud-go/wiki/Customizing-constructors. +type clientHookParams struct{} +type clientHook func(context.Context, clientHookParams) ([]option.ClientOption, error) + +const versionClient = "20210323" + +func insertMetadata(ctx context.Context, mds ...metadata.MD) context.Context { + out, _ := metadata.FromOutgoingContext(ctx) + out = out.Copy() + for _, md := range mds { + for k, v := range md { + out[k] = append(out[k], v...) + } + } + return metadata.NewOutgoingContext(ctx, out) +} + +func checkDisableDeadlines() (bool, error) { + raw, ok := os.LookupEnv("GOOGLE_API_GO_EXPERIMENTAL_DISABLE_DEFAULT_DEADLINE") + if !ok { + return false, nil + } + + b, err := strconv.ParseBool(raw) + return b, err +} + +// DefaultAuthScopes reports the default set of authentication scopes to use with this package. +func DefaultAuthScopes() []string { + return []string{ + "https://www.googleapis.com/auth/cloud-platform", + } +} + +// versionGo returns the Go runtime version. The returned string +// has no whitespace, suitable for reporting in header. +func versionGo() string { + const develPrefix = "devel +" + + s := runtime.Version() + if strings.HasPrefix(s, develPrefix) { + s = s[len(develPrefix):] + if p := strings.IndexFunc(s, unicode.IsSpace); p >= 0 { + s = s[:p] + } + return s + } + + notSemverRune := func(r rune) bool { + return !strings.ContainsRune("0123456789.", r) + } + + if strings.HasPrefix(s, "go1") { + s = s[2:] + var prerelease string + if p := strings.IndexFunc(s, notSemverRune); p >= 0 { + s, prerelease = s[:p], s[p:] + } + if strings.HasSuffix(s, ".") { + s += "0" + } else if strings.Count(s, ".") < 2 { + s += ".0" + } + if prerelease != "" { + s += "-" + prerelease + } + return s + } + return "UNKNOWN" +} diff --git a/resourcesettings/apiv1/gapic_metadata.json b/resourcesettings/apiv1/gapic_metadata.json new file mode 100644 index 00000000000..b7952d4cc62 --- /dev/null +++ b/resourcesettings/apiv1/gapic_metadata.json @@ -0,0 +1,53 @@ +{ + "schema": "1.0", + "comment": "This file maps proto services/RPCs to the corresponding library clients/methods.", + "language": "go", + "protoPackage": "google.cloud.resourcesettings.v1", + "libraryPackage": "cloud.google.com/go/resourcesettings/apiv1", + "services": { + "ResourceSettingsService": { + "clients": { + "grpc": { + "libraryClient": "Client", + "rpcs": { + "CreateSettingValue": { + "methods": [ + "CreateSettingValue" + ] + }, + "DeleteSettingValue": { + "methods": [ + "DeleteSettingValue" + ] + }, + "GetSettingValue": { + "methods": [ + "GetSettingValue" + ] + }, + "ListSettings": { + "methods": [ + "ListSettings" + ] + }, + "LookupEffectiveSettingValue": { + "methods": [ + "LookupEffectiveSettingValue" + ] + }, + "SearchSettingValues": { + "methods": [ + "SearchSettingValues" + ] + }, + "UpdateSettingValue": { + "methods": [ + "UpdateSettingValue" + ] + } + } + } + } + } + } +} diff --git a/resourcesettings/apiv1/resource_settings_client.go b/resourcesettings/apiv1/resource_settings_client.go new file mode 100644 index 00000000000..26dca5fceab --- /dev/null +++ b/resourcesettings/apiv1/resource_settings_client.go @@ -0,0 +1,565 @@ +// Copyright 2021 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Code generated by protoc-gen-go_gapic. DO NOT EDIT. + +package resourcesettings + +import ( + "context" + "fmt" + "math" + "net/url" + "time" + + "github.com/golang/protobuf/proto" + gax "github.com/googleapis/gax-go/v2" + "google.golang.org/api/iterator" + "google.golang.org/api/option" + "google.golang.org/api/option/internaloption" + gtransport "google.golang.org/api/transport/grpc" + resourcesettingspb "google.golang.org/genproto/googleapis/cloud/resourcesettings/v1" + "google.golang.org/grpc" + "google.golang.org/grpc/codes" + "google.golang.org/grpc/metadata" +) + +var newClientHook clientHook + +// CallOptions contains the retry settings for each method of Client. +type CallOptions struct { + ListSettings []gax.CallOption + SearchSettingValues []gax.CallOption + GetSettingValue []gax.CallOption + LookupEffectiveSettingValue []gax.CallOption + CreateSettingValue []gax.CallOption + UpdateSettingValue []gax.CallOption + DeleteSettingValue []gax.CallOption +} + +func defaultClientOptions() []option.ClientOption { + return []option.ClientOption{ + internaloption.WithDefaultEndpoint("resourcesettings.googleapis.com:443"), + internaloption.WithDefaultMTLSEndpoint("resourcesettings.mtls.googleapis.com:443"), + internaloption.WithDefaultAudience("https://resourcesettings.googleapis.com/"), + internaloption.WithDefaultScopes(DefaultAuthScopes()...), + option.WithGRPCDialOption(grpc.WithDisableServiceConfig()), + option.WithGRPCDialOption(grpc.WithDefaultCallOptions( + grpc.MaxCallRecvMsgSize(math.MaxInt32))), + } +} + +func defaultCallOptions() *CallOptions { + return &CallOptions{ + ListSettings: []gax.CallOption{ + gax.WithRetry(func() gax.Retryer { + return gax.OnCodes([]codes.Code{ + codes.Unavailable, + codes.DeadlineExceeded, + }, gax.Backoff{ + Initial: 1000 * time.Millisecond, + Max: 10000 * time.Millisecond, + Multiplier: 1.30, + }) + }), + }, + SearchSettingValues: []gax.CallOption{ + gax.WithRetry(func() gax.Retryer { + return gax.OnCodes([]codes.Code{ + codes.Unavailable, + codes.DeadlineExceeded, + }, gax.Backoff{ + Initial: 1000 * time.Millisecond, + Max: 10000 * time.Millisecond, + Multiplier: 1.30, + }) + }), + }, + GetSettingValue: []gax.CallOption{ + gax.WithRetry(func() gax.Retryer { + return gax.OnCodes([]codes.Code{ + codes.Unavailable, + codes.DeadlineExceeded, + }, gax.Backoff{ + Initial: 1000 * time.Millisecond, + Max: 10000 * time.Millisecond, + Multiplier: 1.30, + }) + }), + }, + LookupEffectiveSettingValue: []gax.CallOption{ + gax.WithRetry(func() gax.Retryer { + return gax.OnCodes([]codes.Code{ + codes.Unavailable, + codes.DeadlineExceeded, + }, gax.Backoff{ + Initial: 1000 * time.Millisecond, + Max: 10000 * time.Millisecond, + Multiplier: 1.30, + }) + }), + }, + CreateSettingValue: []gax.CallOption{ + gax.WithRetry(func() gax.Retryer { + return gax.OnCodes([]codes.Code{ + codes.Unavailable, + codes.DeadlineExceeded, + }, gax.Backoff{ + Initial: 1000 * time.Millisecond, + Max: 10000 * time.Millisecond, + Multiplier: 1.30, + }) + }), + }, + UpdateSettingValue: []gax.CallOption{ + gax.WithRetry(func() gax.Retryer { + return gax.OnCodes([]codes.Code{ + codes.Unavailable, + codes.DeadlineExceeded, + }, gax.Backoff{ + Initial: 1000 * time.Millisecond, + Max: 10000 * time.Millisecond, + Multiplier: 1.30, + }) + }), + }, + DeleteSettingValue: []gax.CallOption{ + gax.WithRetry(func() gax.Retryer { + return gax.OnCodes([]codes.Code{ + codes.Unavailable, + codes.DeadlineExceeded, + }, gax.Backoff{ + Initial: 1000 * time.Millisecond, + Max: 10000 * time.Millisecond, + Multiplier: 1.30, + }) + }), + }, + } +} + +// 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. +type Client struct { + // Connection pool of gRPC connections to the service. + connPool gtransport.ConnPool + + // flag to opt out of default deadlines via GOOGLE_API_GO_EXPERIMENTAL_DISABLE_DEFAULT_DEADLINE + disableDeadlines bool + + // The gRPC API client. + client resourcesettingspb.ResourceSettingsServiceClient + + // The call options for this service. + CallOptions *CallOptions + + // The x-goog-* metadata to be sent with each request. + xGoogMetadata metadata.MD +} + +// 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. +func NewClient(ctx context.Context, opts ...option.ClientOption) (*Client, error) { + clientOpts := defaultClientOptions() + + if newClientHook != nil { + hookOpts, err := newClientHook(ctx, clientHookParams{}) + if err != nil { + return nil, err + } + clientOpts = append(clientOpts, hookOpts...) + } + + disableDeadlines, err := checkDisableDeadlines() + if err != nil { + return nil, err + } + + connPool, err := gtransport.DialPool(ctx, append(clientOpts, opts...)...) + if err != nil { + return nil, err + } + c := &Client{ + connPool: connPool, + disableDeadlines: disableDeadlines, + CallOptions: defaultCallOptions(), + + client: resourcesettingspb.NewResourceSettingsServiceClient(connPool), + } + c.setGoogleClientInfo() + + return c, nil +} + +// Connection returns a connection to the API service. +// +// Deprecated. +func (c *Client) Connection() *grpc.ClientConn { + return c.connPool.Conn() +} + +// Close closes the connection to the API service. The user should invoke this when +// the client is no longer required. +func (c *Client) Close() error { + return c.connPool.Close() +} + +// setGoogleClientInfo sets the name and version of the application in +// the `x-goog-api-client` header passed on each request. Intended for +// use by Google-written clients. +func (c *Client) setGoogleClientInfo(keyval ...string) { + kv := append([]string{"gl-go", versionGo()}, keyval...) + kv = append(kv, "gapic", versionClient, "gax", gax.Version, "grpc", grpc.Version) + c.xGoogMetadata = metadata.Pairs("x-goog-api-client", gax.XGoogHeader(kv...)) +} + +// ListSettings lists all the settings that are available on the Cloud resource parent. +func (c *Client) ListSettings(ctx context.Context, req *resourcesettingspb.ListSettingsRequest, opts ...gax.CallOption) *SettingIterator { + md := metadata.Pairs("x-goog-request-params", fmt.Sprintf("%s=%v", "parent", url.QueryEscape(req.GetParent()))) + ctx = insertMetadata(ctx, c.xGoogMetadata, md) + opts = append(c.CallOptions.ListSettings[0:len(c.CallOptions.ListSettings):len(c.CallOptions.ListSettings)], opts...) + it := &SettingIterator{} + req = proto.Clone(req).(*resourcesettingspb.ListSettingsRequest) + it.InternalFetch = func(pageSize int, pageToken string) ([]*resourcesettingspb.Setting, string, error) { + var resp *resourcesettingspb.ListSettingsResponse + req.PageToken = pageToken + if pageSize > math.MaxInt32 { + req.PageSize = math.MaxInt32 + } else { + req.PageSize = int32(pageSize) + } + err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { + var err error + resp, err = c.client.ListSettings(ctx, req, settings.GRPC...) + return err + }, opts...) + if err != nil { + return nil, "", err + } + + it.Response = resp + return resp.GetSettings(), resp.GetNextPageToken(), nil + } + fetch := func(pageSize int, pageToken string) (string, error) { + items, nextPageToken, err := it.InternalFetch(pageSize, pageToken) + if err != nil { + return "", err + } + it.items = append(it.items, items...) + return nextPageToken, nil + } + it.pageInfo, it.nextFunc = iterator.NewPageInfo(fetch, it.bufLen, it.takeBuf) + it.pageInfo.MaxSize = int(req.GetPageSize()) + it.pageInfo.Token = req.GetPageToken() + return it +} + +// SearchSettingValues searches for all setting values that exist on the resource parent. The +// setting values are not limited to those of a particular setting. +func (c *Client) SearchSettingValues(ctx context.Context, req *resourcesettingspb.SearchSettingValuesRequest, opts ...gax.CallOption) *SettingValueIterator { + md := metadata.Pairs("x-goog-request-params", fmt.Sprintf("%s=%v", "parent", url.QueryEscape(req.GetParent()))) + ctx = insertMetadata(ctx, c.xGoogMetadata, md) + opts = append(c.CallOptions.SearchSettingValues[0:len(c.CallOptions.SearchSettingValues):len(c.CallOptions.SearchSettingValues)], opts...) + it := &SettingValueIterator{} + req = proto.Clone(req).(*resourcesettingspb.SearchSettingValuesRequest) + it.InternalFetch = func(pageSize int, pageToken string) ([]*resourcesettingspb.SettingValue, string, error) { + var resp *resourcesettingspb.SearchSettingValuesResponse + req.PageToken = pageToken + if pageSize > math.MaxInt32 { + req.PageSize = math.MaxInt32 + } else { + req.PageSize = int32(pageSize) + } + err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { + var err error + resp, err = c.client.SearchSettingValues(ctx, req, settings.GRPC...) + return err + }, opts...) + if err != nil { + return nil, "", err + } + + it.Response = resp + return resp.GetSettingValues(), resp.GetNextPageToken(), nil + } + fetch := func(pageSize int, pageToken string) (string, error) { + items, nextPageToken, err := it.InternalFetch(pageSize, pageToken) + if err != nil { + return "", err + } + it.items = append(it.items, items...) + return nextPageToken, nil + } + it.pageInfo, it.nextFunc = iterator.NewPageInfo(fetch, it.bufLen, it.takeBuf) + it.pageInfo.MaxSize = int(req.GetPageSize()) + it.pageInfo.Token = req.GetPageToken() + return it +} + +// GetSettingValue gets a setting value. +// +// Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the +// setting value does not exist. +func (c *Client) GetSettingValue(ctx context.Context, req *resourcesettingspb.GetSettingValueRequest, opts ...gax.CallOption) (*resourcesettingspb.SettingValue, error) { + if _, ok := ctx.Deadline(); !ok && !c.disableDeadlines { + cctx, cancel := context.WithTimeout(ctx, 60000*time.Millisecond) + defer cancel() + ctx = cctx + } + md := metadata.Pairs("x-goog-request-params", fmt.Sprintf("%s=%v", "name", url.QueryEscape(req.GetName()))) + ctx = insertMetadata(ctx, c.xGoogMetadata, md) + opts = append(c.CallOptions.GetSettingValue[0:len(c.CallOptions.GetSettingValue):len(c.CallOptions.GetSettingValue)], opts...) + var resp *resourcesettingspb.SettingValue + err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { + var err error + resp, err = c.client.GetSettingValue(ctx, req, settings.GRPC...) + return err + }, opts...) + if err != nil { + return nil, err + } + return resp, nil +} + +// 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. +func (c *Client) LookupEffectiveSettingValue(ctx context.Context, req *resourcesettingspb.LookupEffectiveSettingValueRequest, opts ...gax.CallOption) (*resourcesettingspb.SettingValue, error) { + if _, ok := ctx.Deadline(); !ok && !c.disableDeadlines { + cctx, cancel := context.WithTimeout(ctx, 60000*time.Millisecond) + defer cancel() + ctx = cctx + } + md := metadata.Pairs("x-goog-request-params", fmt.Sprintf("%s=%v", "name", url.QueryEscape(req.GetName()))) + ctx = insertMetadata(ctx, c.xGoogMetadata, md) + opts = append(c.CallOptions.LookupEffectiveSettingValue[0:len(c.CallOptions.LookupEffectiveSettingValue):len(c.CallOptions.LookupEffectiveSettingValue)], opts...) + var resp *resourcesettingspb.SettingValue + err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { + var err error + resp, err = c.client.LookupEffectiveSettingValue(ctx, req, settings.GRPC...) + return err + }, opts...) + if err != nil { + return nil, err + } + return resp, nil +} + +// 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. +func (c *Client) CreateSettingValue(ctx context.Context, req *resourcesettingspb.CreateSettingValueRequest, opts ...gax.CallOption) (*resourcesettingspb.SettingValue, error) { + if _, ok := ctx.Deadline(); !ok && !c.disableDeadlines { + cctx, cancel := context.WithTimeout(ctx, 60000*time.Millisecond) + defer cancel() + ctx = cctx + } + md := metadata.Pairs("x-goog-request-params", fmt.Sprintf("%s=%v", "parent", url.QueryEscape(req.GetParent()))) + ctx = insertMetadata(ctx, c.xGoogMetadata, md) + opts = append(c.CallOptions.CreateSettingValue[0:len(c.CallOptions.CreateSettingValue):len(c.CallOptions.CreateSettingValue)], opts...) + var resp *resourcesettingspb.SettingValue + err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { + var err error + resp, err = c.client.CreateSettingValue(ctx, req, settings.GRPC...) + return err + }, opts...) + if err != nil { + return nil, err + } + return resp, nil +} + +// 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. +func (c *Client) UpdateSettingValue(ctx context.Context, req *resourcesettingspb.UpdateSettingValueRequest, opts ...gax.CallOption) (*resourcesettingspb.SettingValue, error) { + if _, ok := ctx.Deadline(); !ok && !c.disableDeadlines { + cctx, cancel := context.WithTimeout(ctx, 60000*time.Millisecond) + defer cancel() + ctx = cctx + } + md := metadata.Pairs("x-goog-request-params", fmt.Sprintf("%s=%v", "setting_value.name", url.QueryEscape(req.GetSettingValue().GetName()))) + ctx = insertMetadata(ctx, c.xGoogMetadata, md) + opts = append(c.CallOptions.UpdateSettingValue[0:len(c.CallOptions.UpdateSettingValue):len(c.CallOptions.UpdateSettingValue)], opts...) + var resp *resourcesettingspb.SettingValue + err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { + var err error + resp, err = c.client.UpdateSettingValue(ctx, req, settings.GRPC...) + return err + }, opts...) + if err != nil { + return nil, err + } + return resp, nil +} + +// 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. +func (c *Client) DeleteSettingValue(ctx context.Context, req *resourcesettingspb.DeleteSettingValueRequest, opts ...gax.CallOption) error { + if _, ok := ctx.Deadline(); !ok && !c.disableDeadlines { + cctx, cancel := context.WithTimeout(ctx, 60000*time.Millisecond) + defer cancel() + ctx = cctx + } + md := metadata.Pairs("x-goog-request-params", fmt.Sprintf("%s=%v", "name", url.QueryEscape(req.GetName()))) + ctx = insertMetadata(ctx, c.xGoogMetadata, md) + opts = append(c.CallOptions.DeleteSettingValue[0:len(c.CallOptions.DeleteSettingValue):len(c.CallOptions.DeleteSettingValue)], opts...) + err := gax.Invoke(ctx, func(ctx context.Context, settings gax.CallSettings) error { + var err error + _, err = c.client.DeleteSettingValue(ctx, req, settings.GRPC...) + return err + }, opts...) + return err +} + +// SettingIterator manages a stream of *resourcesettingspb.Setting. +type SettingIterator struct { + items []*resourcesettingspb.Setting + pageInfo *iterator.PageInfo + nextFunc func() error + + // 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) +} + +// PageInfo supports pagination. See the google.golang.org/api/iterator package for details. +func (it *SettingIterator) PageInfo() *iterator.PageInfo { + return it.pageInfo +} + +// 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 (it *SettingIterator) Next() (*resourcesettingspb.Setting, error) { + var item *resourcesettingspb.Setting + if err := it.nextFunc(); err != nil { + return item, err + } + item = it.items[0] + it.items = it.items[1:] + return item, nil +} + +func (it *SettingIterator) bufLen() int { + return len(it.items) +} + +func (it *SettingIterator) takeBuf() interface{} { + b := it.items + it.items = nil + return b +} + +// SettingValueIterator manages a stream of *resourcesettingspb.SettingValue. +type SettingValueIterator struct { + items []*resourcesettingspb.SettingValue + pageInfo *iterator.PageInfo + nextFunc func() error + + // 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) +} + +// PageInfo supports pagination. See the google.golang.org/api/iterator package for details. +func (it *SettingValueIterator) PageInfo() *iterator.PageInfo { + return it.pageInfo +} + +// 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 (it *SettingValueIterator) Next() (*resourcesettingspb.SettingValue, error) { + var item *resourcesettingspb.SettingValue + if err := it.nextFunc(); err != nil { + return item, err + } + item = it.items[0] + it.items = it.items[1:] + return item, nil +} + +func (it *SettingValueIterator) bufLen() int { + return len(it.items) +} + +func (it *SettingValueIterator) takeBuf() interface{} { + b := it.items + it.items = nil + return b +} diff --git a/resourcesettings/apiv1/resource_settings_client_example_test.go b/resourcesettings/apiv1/resource_settings_client_example_test.go new file mode 100644 index 00000000000..80370af3ab0 --- /dev/null +++ b/resourcesettings/apiv1/resource_settings_client_example_test.go @@ -0,0 +1,185 @@ +// Copyright 2021 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// https://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Code generated by protoc-gen-go_gapic. DO NOT EDIT. + +package resourcesettings_test + +import ( + "context" + + resourcesettings "cloud.google.com/go/resourcesettings/apiv1" + "google.golang.org/api/iterator" + resourcesettingspb "google.golang.org/genproto/googleapis/cloud/resourcesettings/v1" +) + +func ExampleNewClient() { + ctx := context.Background() + c, err := resourcesettings.NewClient(ctx) + if err != nil { + // TODO: Handle error. + } + // TODO: Use client. + _ = c +} + +func ExampleClient_ListSettings() { + // 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 ExampleClient_SearchSettingValues() { + // 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 ExampleClient_GetSettingValue() { + // 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 ExampleClient_LookupEffectiveSettingValue() { + // 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 ExampleClient_CreateSettingValue() { + // 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 ExampleClient_UpdateSettingValue() { + // 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 +} + +func ExampleClient_DeleteSettingValue() { + 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. + } +}