Cloud Location Finder API v1 - Package cloud.google.com/go/locationfinder/apiv1 (v0.1.1)

Package locationfinder is an auto-generated package for the Cloud Location Finder API.

NOTE: This package is in beta. It is not stable, and may be subject to changes.

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:

Example usage

To get started with this package, create a client.

// go get cloud.google.com/go/locationfinder/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 := locationfinder.NewCloudLocationFinderClient(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 := &locationfinderpb.GetCloudLocationRequest{
    // TODO: Fill request struct fields.
    // See https://pkg.go.dev/cloud.google.com/go/locationfinder/apiv1/locationfinderpb#GetCloudLocationRequest.
}
resp, err := c.GetCloudLocation(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

Use of Context

The ctx passed to NewCloudLocationFinderClient 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.

Functions

func DefaultAuthScopes 

func DefaultAuthScopes() []string

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

CloudLocationFinderCallOptions

type CloudLocationFinderCallOptions struct {
	ListCloudLocations   []gax.CallOption
	GetCloudLocation     []gax.CallOption
	SearchCloudLocations []gax.CallOption
	GetLocation          []gax.CallOption
	ListLocations        []gax.CallOption
}

CloudLocationFinderCallOptions contains the retry settings for each method of CloudLocationFinderClient.

CloudLocationFinderClient

type CloudLocationFinderClient struct {

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

CloudLocationFinderClient is a client for interacting with Cloud Location Finder API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Service describing handlers for resources

func NewCloudLocationFinderClient 

func NewCloudLocationFinderClient(ctx context.Context, opts ...option.ClientOption) (*CloudLocationFinderClient, error)

NewCloudLocationFinderClient creates a new cloud location finder client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

Service describing handlers for resources

Example

package main

import (
	"context"

	locationfinder "cloud.google.com/go/locationfinder/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 := locationfinder.NewCloudLocationFinderClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func NewCloudLocationFinderRESTClient 

func NewCloudLocationFinderRESTClient(ctx context.Context, opts ...option.ClientOption) (*CloudLocationFinderClient, error)

NewCloudLocationFinderRESTClient creates a new cloud location finder rest client.

Service describing handlers for resources

Example

package main

import (
	"context"

	locationfinder "cloud.google.com/go/locationfinder/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 := locationfinder.NewCloudLocationFinderRESTClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func (*CloudLocationFinderClient) Close 

func (c *CloudLocationFinderClient) Close() error

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

func (*CloudLocationFinderClient) Connection (deprecated)

func (c *CloudLocationFinderClient) 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 (*CloudLocationFinderClient) GetCloudLocation 

func (c *CloudLocationFinderClient) GetCloudLocation(ctx context.Context, req *locationfinderpb.GetCloudLocationRequest, opts ...gax.CallOption) (*locationfinderpb.CloudLocation, error)

GetCloudLocation retrieves a resource containing information about a cloud location.

Example

package main

import (
	"context"

	locationfinder "cloud.google.com/go/locationfinder/apiv1"
	locationfinderpb "cloud.google.com/go/locationfinder/apiv1/locationfinderpb"
)

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 := locationfinder.NewCloudLocationFinderClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &locationfinderpb.GetCloudLocationRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/locationfinder/apiv1/locationfinderpb#GetCloudLocationRequest.
	}
	resp, err := c.GetCloudLocation(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*CloudLocationFinderClient) GetLocation 

func (c *CloudLocationFinderClient) GetLocation(ctx context.Context, req *locationpb.GetLocationRequest, opts ...gax.CallOption) (*locationpb.Location, error)

GetLocation gets information about a location.

Example

package main

import (
	"context"

	locationfinder "cloud.google.com/go/locationfinder/apiv1"

	locationpb "google.golang.org/genproto/googleapis/cloud/location"
)

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 := locationfinder.NewCloudLocationFinderClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

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

func (*CloudLocationFinderClient) ListCloudLocations 

func (c *CloudLocationFinderClient) ListCloudLocations(ctx context.Context, req *locationfinderpb.ListCloudLocationsRequest, opts ...gax.CallOption) *CloudLocationIterator

ListCloudLocations lists cloud locations under a given project and location.

Examples

package main

import (
	"context"

	locationfinder "cloud.google.com/go/locationfinder/apiv1"
	locationfinderpb "cloud.google.com/go/locationfinder/apiv1/locationfinderpb"
	"google.golang.org/api/iterator"
)

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 := locationfinder.NewCloudLocationFinderClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &locationfinderpb.ListCloudLocationsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/locationfinder/apiv1/locationfinderpb#ListCloudLocationsRequest.
	}
	it := c.ListCloudLocations(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp

		// If you need to access the underlying RPC response,
		// you can do so by casting the `Response` as below.
		// Otherwise, remove this line. Only populated after
		// first call to Next(). Not safe for concurrent access.
		_ = it.Response.(*locationfinderpb.ListCloudLocationsResponse)
	}
}
all
package main

import (
	"context"

	locationfinder "cloud.google.com/go/locationfinder/apiv1"
	locationfinderpb "cloud.google.com/go/locationfinder/apiv1/locationfinderpb"
)

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 := locationfinder.NewCloudLocationFinderClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &locationfinderpb.ListCloudLocationsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/locationfinder/apiv1/locationfinderpb#ListCloudLocationsRequest.
	}
	for resp, err := range c.ListCloudLocations(ctx, req).All() {
		if err != nil {
			// TODO: Handle error and break/return/continue. Iteration will stop after any error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*CloudLocationFinderClient) ListLocations 

func (c *CloudLocationFinderClient) ListLocations(ctx context.Context, req *locationpb.ListLocationsRequest, opts ...gax.CallOption) *LocationIterator

ListLocations lists information about the supported locations for this service.

Examples

package main

import (
	"context"

	locationfinder "cloud.google.com/go/locationfinder/apiv1"
	"google.golang.org/api/iterator"

	locationpb "google.golang.org/genproto/googleapis/cloud/location"
)

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 := locationfinder.NewCloudLocationFinderClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &locationpb.ListLocationsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest.
	}
	it := c.ListLocations(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp

		// If you need to access the underlying RPC response,
		// you can do so by casting the `Response` as below.
		// Otherwise, remove this line. Only populated after
		// first call to Next(). Not safe for concurrent access.
		_ = it.Response.(*locationpb.ListLocationsResponse)
	}
}
all
package main

import (
	"context"

	locationfinder "cloud.google.com/go/locationfinder/apiv1"

	locationpb "google.golang.org/genproto/googleapis/cloud/location"
)

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 := locationfinder.NewCloudLocationFinderClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &locationpb.ListLocationsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest.
	}
	for resp, err := range c.ListLocations(ctx, req).All() {
		if err != nil {
			// TODO: Handle error and break/return/continue. Iteration will stop after any error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

func (*CloudLocationFinderClient) SearchCloudLocations 

func (c *CloudLocationFinderClient) SearchCloudLocations(ctx context.Context, req *locationfinderpb.SearchCloudLocationsRequest, opts ...gax.CallOption) *CloudLocationIterator

SearchCloudLocations searches for cloud locations from a given source location.

Examples

package main

import (
	"context"

	locationfinder "cloud.google.com/go/locationfinder/apiv1"
	locationfinderpb "cloud.google.com/go/locationfinder/apiv1/locationfinderpb"
	"google.golang.org/api/iterator"
)

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 := locationfinder.NewCloudLocationFinderClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &locationfinderpb.SearchCloudLocationsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/locationfinder/apiv1/locationfinderpb#SearchCloudLocationsRequest.
	}
	it := c.SearchCloudLocations(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp

		// If you need to access the underlying RPC response,
		// you can do so by casting the `Response` as below.
		// Otherwise, remove this line. Only populated after
		// first call to Next(). Not safe for concurrent access.
		_ = it.Response.(*locationfinderpb.SearchCloudLocationsResponse)
	}
}
all
package main

import (
	"context"

	locationfinder "cloud.google.com/go/locationfinder/apiv1"
	locationfinderpb "cloud.google.com/go/locationfinder/apiv1/locationfinderpb"
)

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 := locationfinder.NewCloudLocationFinderClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &locationfinderpb.SearchCloudLocationsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/locationfinder/apiv1/locationfinderpb#SearchCloudLocationsRequest.
	}
	for resp, err := range c.SearchCloudLocations(ctx, req).All() {
		if err != nil {
			// TODO: Handle error and break/return/continue. Iteration will stop after any error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

CloudLocationIterator

type CloudLocationIterator 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 []*locationfinderpb.CloudLocation, nextPageToken string, err error)
	// contains filtered or unexported fields
}

CloudLocationIterator manages a stream of *locationfinderpb.CloudLocation.

func (*CloudLocationIterator) All 

func (it *CloudLocationIterator) All() iter.Seq2[*locationfinderpb.CloudLocation, error]

All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.

func (*CloudLocationIterator) Next 

func (it *CloudLocationIterator) Next() (*locationfinderpb.CloudLocation, error)

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 (*CloudLocationIterator) PageInfo 

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

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

LocationIterator

type LocationIterator 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 []*locationpb.Location, nextPageToken string, err error)
	// contains filtered or unexported fields
}

LocationIterator manages a stream of *locationpb.Location.

func (*LocationIterator) All 

func (it *LocationIterator) All() iter.Seq2[*locationpb.Location, error]

All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.

func (*LocationIterator) Next 

func (it *LocationIterator) Next() (*locationpb.Location, error)

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 (*LocationIterator) PageInfo 

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

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