License Manager API v1 - Package cloud.google.com/go/licensemanager/apiv1 (v0.1.1)

Beta

This library is covered by thePre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see thelaunch stage descriptions.

Note: To get more information about this package, such as access to older versions, viewthis package on pkg.go.dev.

Package licensemanager is an auto-generated package for theLicense Manager API.

License Manager is a tool to manage and track third-party licenses onGoogle Cloud.

NOTE:Thispackageisinbeta.Itisnotstable,andmaybesubjecttochanges.

General documentation

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

Example usage

To get started with this package, create a client.

// go get cloud.google.com/go/licensemanager/apiv1@latestctx:=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_Optionsc,err:=licensemanager.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.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:=&licensemanagerpb.AggregateUsageRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/licensemanager/apiv1/licensemanagerpb#AggregateUsageRequest.}it:=c.AggregateUsage(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=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.(*licensemanagerpb.AggregateUsageResponse)}

Use of Context

The ctx passed to NewClient is used for authentication requests andfor 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

funcDefaultAuthScopes()[]string

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

CallOptions

typeCallOptionsstruct{ListConfigurations[]gax.CallOptionGetConfiguration[]gax.CallOptionCreateConfiguration[]gax.CallOptionUpdateConfiguration[]gax.CallOptionDeleteConfiguration[]gax.CallOptionListInstances[]gax.CallOptionGetInstance[]gax.CallOptionDeactivateConfiguration[]gax.CallOptionReactivateConfiguration[]gax.CallOptionQueryConfigurationLicenseUsage[]gax.CallOptionAggregateUsage[]gax.CallOptionListProducts[]gax.CallOptionGetProduct[]gax.CallOptionGetLocation[]gax.CallOptionListLocations[]gax.CallOptionCancelOperation[]gax.CallOptionDeleteOperation[]gax.CallOptionGetOperation[]gax.CallOptionListOperations[]gax.CallOption}

CallOptions contains the retry settings for each method of Client.

Client

typeClientstruct{// The call options for this service.CallOptions*CallOptions// LROClient is used internally to handle long-running operations.// It is exposed so that its CallOptions can be modified if required.// Users should not Close this client.LROClient*lroauto.OperationsClient// contains filtered or unexported fields}

Client is a client for interacting with License Manager API.Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Service describing handlers for resources

func NewClient

funcNewClient(ctxcontext.Context,opts...option.ClientOption)(*Client,error)

NewClient creates a new license manager 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

packagemainimport("context"licensemanager"cloud.google.com/go/licensemanager/apiv1")funcmain(){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_Optionsc,err:=licensemanager.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()// TODO: Use client._=c}

func NewRESTClient

funcNewRESTClient(ctxcontext.Context,opts...option.ClientOption)(*Client,error)

NewRESTClient creates a new license manager rest client.

Service describing handlers for resources

Example

packagemainimport("context"licensemanager"cloud.google.com/go/licensemanager/apiv1")funcmain(){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_Optionsc,err:=licensemanager.NewRESTClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()// TODO: Use client._=c}

func (*Client) AggregateUsage

AggregateUsage aggregates Usage per Instance for a Configuration.

Examples

packagemainimport("context"licensemanager"cloud.google.com/go/licensemanager/apiv1"licensemanagerpb"cloud.google.com/go/licensemanager/apiv1/licensemanagerpb""google.golang.org/api/iterator")funcmain(){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_Optionsc,err:=licensemanager.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&licensemanagerpb.AggregateUsageRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/licensemanager/apiv1/licensemanagerpb#AggregateUsageRequest.}it:=c.AggregateUsage(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=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.(*licensemanagerpb.AggregateUsageResponse)}}
all
packagemainimport("context"licensemanager"cloud.google.com/go/licensemanager/apiv1"licensemanagerpb"cloud.google.com/go/licensemanager/apiv1/licensemanagerpb")funcmain(){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_Optionsc,err:=licensemanager.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&licensemanagerpb.AggregateUsageRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/licensemanager/apiv1/licensemanagerpb#AggregateUsageRequest.}forresp,err:=rangec.AggregateUsage(ctx,req).All(){iferr!=nil{// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._=resp}}

func (*Client) CancelOperation

CancelOperation is a utility method from google.longrunning.Operations.

Example

packagemainimport("context"licensemanager"cloud.google.com/go/licensemanager/apiv1"longrunningpb"cloud.google.com/go/longrunning/autogen/longrunningpb")funcmain(){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_Optionsc,err:=licensemanager.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&longrunningpb.CancelOperationRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#CancelOperationRequest.}err=c.CancelOperation(ctx,req)iferr!=nil{// TODO: Handle error.}}

func (*Client) Close

func(c*Client)Close()error

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

func (*Client) Connection (deprecated)

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

Connection returns a connection to the API service.

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

func (*Client) CreateConfiguration

CreateConfiguration creates a new Configuration in a given project and location.

Example

packagemainimport("context"licensemanager"cloud.google.com/go/licensemanager/apiv1"licensemanagerpb"cloud.google.com/go/licensemanager/apiv1/licensemanagerpb")funcmain(){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_Optionsc,err:=licensemanager.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&licensemanagerpb.CreateConfigurationRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/licensemanager/apiv1/licensemanagerpb#CreateConfigurationRequest.}op,err:=c.CreateConfiguration(ctx,req)iferr!=nil{// TODO: Handle error.}resp,err:=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) CreateConfigurationOperation

func(c*Client)CreateConfigurationOperation(namestring)*CreateConfigurationOperation

CreateConfigurationOperation returns a new CreateConfigurationOperation from a given name.The name must be that of a previously created CreateConfigurationOperation, possibly from a different process.

func (*Client) DeactivateConfiguration

DeactivateConfiguration deactivates the given configuration.

Example

packagemainimport("context"licensemanager"cloud.google.com/go/licensemanager/apiv1"licensemanagerpb"cloud.google.com/go/licensemanager/apiv1/licensemanagerpb")funcmain(){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_Optionsc,err:=licensemanager.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&licensemanagerpb.DeactivateConfigurationRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/licensemanager/apiv1/licensemanagerpb#DeactivateConfigurationRequest.}op,err:=c.DeactivateConfiguration(ctx,req)iferr!=nil{// TODO: Handle error.}resp,err:=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) DeactivateConfigurationOperation

func(c*Client)DeactivateConfigurationOperation(namestring)*DeactivateConfigurationOperation

DeactivateConfigurationOperation returns a new DeactivateConfigurationOperation from a given name.The name must be that of a previously created DeactivateConfigurationOperation, possibly from a different process.

func (*Client) DeleteConfiguration

DeleteConfiguration deletes a single Configuration.

Example

packagemainimport("context"licensemanager"cloud.google.com/go/licensemanager/apiv1"licensemanagerpb"cloud.google.com/go/licensemanager/apiv1/licensemanagerpb")funcmain(){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_Optionsc,err:=licensemanager.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&licensemanagerpb.DeleteConfigurationRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/licensemanager/apiv1/licensemanagerpb#DeleteConfigurationRequest.}op,err:=c.DeleteConfiguration(ctx,req)iferr!=nil{// TODO: Handle error.}err=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}}

func (*Client) DeleteConfigurationOperation

func(c*Client)DeleteConfigurationOperation(namestring)*DeleteConfigurationOperation

DeleteConfigurationOperation returns a new DeleteConfigurationOperation from a given name.The name must be that of a previously created DeleteConfigurationOperation, possibly from a different process.

func (*Client) DeleteOperation

DeleteOperation is a utility method from google.longrunning.Operations.

Example

packagemainimport("context"licensemanager"cloud.google.com/go/licensemanager/apiv1"longrunningpb"cloud.google.com/go/longrunning/autogen/longrunningpb")funcmain(){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_Optionsc,err:=licensemanager.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&longrunningpb.DeleteOperationRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#DeleteOperationRequest.}err=c.DeleteOperation(ctx,req)iferr!=nil{// TODO: Handle error.}}

func (*Client) GetConfiguration

GetConfiguration gets details of a single Configuration.

Example

packagemainimport("context"licensemanager"cloud.google.com/go/licensemanager/apiv1"licensemanagerpb"cloud.google.com/go/licensemanager/apiv1/licensemanagerpb")funcmain(){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_Optionsc,err:=licensemanager.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&licensemanagerpb.GetConfigurationRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/licensemanager/apiv1/licensemanagerpb#GetConfigurationRequest.}resp,err:=c.GetConfiguration(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) GetInstance

GetInstance gets details of a single Instance.

Example

packagemainimport("context"licensemanager"cloud.google.com/go/licensemanager/apiv1"licensemanagerpb"cloud.google.com/go/licensemanager/apiv1/licensemanagerpb")funcmain(){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_Optionsc,err:=licensemanager.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&licensemanagerpb.GetInstanceRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/licensemanager/apiv1/licensemanagerpb#GetInstanceRequest.}resp,err:=c.GetInstance(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) GetLocation

GetLocation gets information about a location.

Example

packagemainimport("context"licensemanager"cloud.google.com/go/licensemanager/apiv1"locationpb"google.golang.org/genproto/googleapis/cloud/location")funcmain(){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_Optionsc,err:=licensemanager.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.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)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) GetOperation

GetOperation is a utility method from google.longrunning.Operations.

Example

packagemainimport("context"licensemanager"cloud.google.com/go/licensemanager/apiv1"longrunningpb"cloud.google.com/go/longrunning/autogen/longrunningpb")funcmain(){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_Optionsc,err:=licensemanager.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&longrunningpb.GetOperationRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#GetOperationRequest.}resp,err:=c.GetOperation(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) GetProduct

GetProduct gets details of a single Product.

Example

packagemainimport("context"licensemanager"cloud.google.com/go/licensemanager/apiv1"licensemanagerpb"cloud.google.com/go/licensemanager/apiv1/licensemanagerpb")funcmain(){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_Optionsc,err:=licensemanager.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&licensemanagerpb.GetProductRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/licensemanager/apiv1/licensemanagerpb#GetProductRequest.}resp,err:=c.GetProduct(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) ListConfigurations

ListConfigurations lists Configurations in a given project and location.

Examples

packagemainimport("context"licensemanager"cloud.google.com/go/licensemanager/apiv1"licensemanagerpb"cloud.google.com/go/licensemanager/apiv1/licensemanagerpb""google.golang.org/api/iterator")funcmain(){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_Optionsc,err:=licensemanager.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&licensemanagerpb.ListConfigurationsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/licensemanager/apiv1/licensemanagerpb#ListConfigurationsRequest.}it:=c.ListConfigurations(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=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.(*licensemanagerpb.ListConfigurationsResponse)}}
all
packagemainimport("context"licensemanager"cloud.google.com/go/licensemanager/apiv1"licensemanagerpb"cloud.google.com/go/licensemanager/apiv1/licensemanagerpb")funcmain(){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_Optionsc,err:=licensemanager.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&licensemanagerpb.ListConfigurationsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/licensemanager/apiv1/licensemanagerpb#ListConfigurationsRequest.}forresp,err:=rangec.ListConfigurations(ctx,req).All(){iferr!=nil{// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._=resp}}

func (*Client) ListInstances

ListInstances lists Instances in a given project and location.

Examples

packagemainimport("context"licensemanager"cloud.google.com/go/licensemanager/apiv1"licensemanagerpb"cloud.google.com/go/licensemanager/apiv1/licensemanagerpb""google.golang.org/api/iterator")funcmain(){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_Optionsc,err:=licensemanager.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&licensemanagerpb.ListInstancesRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/licensemanager/apiv1/licensemanagerpb#ListInstancesRequest.}it:=c.ListInstances(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=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.(*licensemanagerpb.ListInstancesResponse)}}
all
packagemainimport("context"licensemanager"cloud.google.com/go/licensemanager/apiv1"licensemanagerpb"cloud.google.com/go/licensemanager/apiv1/licensemanagerpb")funcmain(){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_Optionsc,err:=licensemanager.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&licensemanagerpb.ListInstancesRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/licensemanager/apiv1/licensemanagerpb#ListInstancesRequest.}forresp,err:=rangec.ListInstances(ctx,req).All(){iferr!=nil{// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._=resp}}

func (*Client) ListLocations

ListLocations lists information about the supported locations for this service.

Examples

packagemainimport("context"licensemanager"cloud.google.com/go/licensemanager/apiv1""google.golang.org/api/iterator"locationpb"google.golang.org/genproto/googleapis/cloud/location")funcmain(){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_Optionsc,err:=licensemanager.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.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()iferr==iterator.Done{break}iferr!=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
packagemainimport("context"licensemanager"cloud.google.com/go/licensemanager/apiv1"locationpb"google.golang.org/genproto/googleapis/cloud/location")funcmain(){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_Optionsc,err:=licensemanager.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&locationpb.ListLocationsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest.}forresp,err:=rangec.ListLocations(ctx,req).All(){iferr!=nil{// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._=resp}}

func (*Client) ListOperations

ListOperations is a utility method from google.longrunning.Operations.

Examples

packagemainimport("context"licensemanager"cloud.google.com/go/licensemanager/apiv1"longrunningpb"cloud.google.com/go/longrunning/autogen/longrunningpb""google.golang.org/api/iterator")funcmain(){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_Optionsc,err:=licensemanager.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&longrunningpb.ListOperationsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.}it:=c.ListOperations(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=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.(*longrunningpb.ListOperationsResponse)}}
all
packagemainimport("context"licensemanager"cloud.google.com/go/licensemanager/apiv1"longrunningpb"cloud.google.com/go/longrunning/autogen/longrunningpb")funcmain(){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_Optionsc,err:=licensemanager.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&longrunningpb.ListOperationsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.}forresp,err:=rangec.ListOperations(ctx,req).All(){iferr!=nil{// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._=resp}}

func (*Client) ListProducts

ListProducts lists Products in a given project and location.

Examples

packagemainimport("context"licensemanager"cloud.google.com/go/licensemanager/apiv1"licensemanagerpb"cloud.google.com/go/licensemanager/apiv1/licensemanagerpb""google.golang.org/api/iterator")funcmain(){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_Optionsc,err:=licensemanager.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&licensemanagerpb.ListProductsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/licensemanager/apiv1/licensemanagerpb#ListProductsRequest.}it:=c.ListProducts(ctx,req)for{resp,err:=it.Next()iferr==iterator.Done{break}iferr!=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.(*licensemanagerpb.ListProductsResponse)}}
all
packagemainimport("context"licensemanager"cloud.google.com/go/licensemanager/apiv1"licensemanagerpb"cloud.google.com/go/licensemanager/apiv1/licensemanagerpb")funcmain(){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_Optionsc,err:=licensemanager.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&licensemanagerpb.ListProductsRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/licensemanager/apiv1/licensemanagerpb#ListProductsRequest.}forresp,err:=rangec.ListProducts(ctx,req).All(){iferr!=nil{// TODO: Handle error and break/return/continue. Iteration will stop after any error.}// TODO: Use resp._=resp}}

func (*Client) QueryConfigurationLicenseUsage

QueryConfigurationLicenseUsage license Usage information for a Configuration.

Example

packagemainimport("context"licensemanager"cloud.google.com/go/licensemanager/apiv1"licensemanagerpb"cloud.google.com/go/licensemanager/apiv1/licensemanagerpb")funcmain(){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_Optionsc,err:=licensemanager.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&licensemanagerpb.QueryConfigurationLicenseUsageRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/licensemanager/apiv1/licensemanagerpb#QueryConfigurationLicenseUsageRequest.}resp,err:=c.QueryConfigurationLicenseUsage(ctx,req)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) ReactivateConfiguration

ReactivateConfiguration reactivates the given configuration.

Example

packagemainimport("context"licensemanager"cloud.google.com/go/licensemanager/apiv1"licensemanagerpb"cloud.google.com/go/licensemanager/apiv1/licensemanagerpb")funcmain(){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_Optionsc,err:=licensemanager.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&licensemanagerpb.ReactivateConfigurationRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/licensemanager/apiv1/licensemanagerpb#ReactivateConfigurationRequest.}op,err:=c.ReactivateConfiguration(ctx,req)iferr!=nil{// TODO: Handle error.}resp,err:=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) ReactivateConfigurationOperation

func(c*Client)ReactivateConfigurationOperation(namestring)*ReactivateConfigurationOperation

ReactivateConfigurationOperation returns a new ReactivateConfigurationOperation from a given name.The name must be that of a previously created ReactivateConfigurationOperation, possibly from a different process.

func (*Client) UpdateConfiguration

UpdateConfiguration updates the parameters of a single Configuration.

Example

packagemainimport("context"licensemanager"cloud.google.com/go/licensemanager/apiv1"licensemanagerpb"cloud.google.com/go/licensemanager/apiv1/licensemanagerpb")funcmain(){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_Optionsc,err:=licensemanager.NewClient(ctx)iferr!=nil{// TODO: Handle error.}deferc.Close()req:=&licensemanagerpb.UpdateConfigurationRequest{// TODO: Fill request struct fields.// See https://pkg.go.dev/cloud.google.com/go/licensemanager/apiv1/licensemanagerpb#UpdateConfigurationRequest.}op,err:=c.UpdateConfiguration(ctx,req)iferr!=nil{// TODO: Handle error.}resp,err:=op.Wait(ctx)iferr!=nil{// TODO: Handle error.}// TODO: Use resp._=resp}

func (*Client) UpdateConfigurationOperation

func(c*Client)UpdateConfigurationOperation(namestring)*UpdateConfigurationOperation

UpdateConfigurationOperation returns a new UpdateConfigurationOperation from a given name.The name must be that of a previously created UpdateConfigurationOperation, possibly from a different process.

ConfigurationIterator

typeConfigurationIteratorstruct{// 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.Responseinterface{}// 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.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*licensemanagerpb.Configuration,nextPageTokenstring,errerror)// contains filtered or unexported fields}

ConfigurationIterator manages a stream of *licensemanagerpb.Configuration.

func (*ConfigurationIterator) All

func(it*ConfigurationIterator)All()iter.Seq2[*licensemanagerpb.Configuration,error]

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

func (*ConfigurationIterator) Next

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

func (*ConfigurationIterator) PageInfo

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

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

CreateConfigurationOperation

typeCreateConfigurationOperationstruct{// contains filtered or unexported fields}

CreateConfigurationOperation manages a long-running operation from CreateConfiguration.

func (*CreateConfigurationOperation) Done

Done reports whether the long-running operation has completed.

func (*CreateConfigurationOperation) Metadata

Metadata returns metadata associated with the long-running operation.Metadata itself does not contact the server, but Poll does.To get the latest metadata, call this method after a successful call to Poll.If the metadata is not available, the returned metadata and error are both nil.

func (*CreateConfigurationOperation) Name

Name returns the name of the long-running operation.The name is assigned by the server and is unique within the service from which the operation is created.

func (*CreateConfigurationOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds andthe operation has completed with failure, the error is returned and op.Done will return true.If Poll succeeds and the operation has completed successfully,op.Done will return true, and the response of the operation is returned.If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*CreateConfigurationOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

DeactivateConfigurationOperation

typeDeactivateConfigurationOperationstruct{// contains filtered or unexported fields}

DeactivateConfigurationOperation manages a long-running operation from DeactivateConfiguration.

func (*DeactivateConfigurationOperation) Done

Done reports whether the long-running operation has completed.

func (*DeactivateConfigurationOperation) Metadata

Metadata returns metadata associated with the long-running operation.Metadata itself does not contact the server, but Poll does.To get the latest metadata, call this method after a successful call to Poll.If the metadata is not available, the returned metadata and error are both nil.

func (*DeactivateConfigurationOperation) Name

Name returns the name of the long-running operation.The name is assigned by the server and is unique within the service from which the operation is created.

func (*DeactivateConfigurationOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds andthe operation has completed with failure, the error is returned and op.Done will return true.If Poll succeeds and the operation has completed successfully,op.Done will return true, and the response of the operation is returned.If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*DeactivateConfigurationOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

DeleteConfigurationOperation

typeDeleteConfigurationOperationstruct{// contains filtered or unexported fields}

DeleteConfigurationOperation manages a long-running operation from DeleteConfiguration.

func (*DeleteConfigurationOperation) Done

Done reports whether the long-running operation has completed.

func (*DeleteConfigurationOperation) Metadata

Metadata returns metadata associated with the long-running operation.Metadata itself does not contact the server, but Poll does.To get the latest metadata, call this method after a successful call to Poll.If the metadata is not available, the returned metadata and error are both nil.

func (*DeleteConfigurationOperation) Name

Name returns the name of the long-running operation.The name is assigned by the server and is unique within the service from which the operation is created.

func (*DeleteConfigurationOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds andthe operation has completed with failure, the error is returned and op.Done will return true.If Poll succeeds and the operation has completed successfully,op.Done will return true, and the response of the operation is returned.If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*DeleteConfigurationOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

InstanceIterator

typeInstanceIteratorstruct{// 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.Responseinterface{}// 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.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*licensemanagerpb.Instance,nextPageTokenstring,errerror)// contains filtered or unexported fields}

InstanceIterator manages a stream of *licensemanagerpb.Instance.

func (*InstanceIterator) All

func(it*InstanceIterator)All()iter.Seq2[*licensemanagerpb.Instance,error]

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

func (*InstanceIterator) Next

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

func (*InstanceIterator) PageInfo

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

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

LocationIterator

typeLocationIteratorstruct{// 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.Responseinterface{}// 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.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*locationpb.Location,nextPageTokenstring,errerror)// 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, theiterator will stop after that iteration.

func (*LocationIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no moreresults. 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.

OperationIterator

typeOperationIteratorstruct{// 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.Responseinterface{}// 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.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*longrunningpb.Operation,nextPageTokenstring,errerror)// contains filtered or unexported fields}

OperationIterator manages a stream of *longrunningpb.Operation.

func (*OperationIterator) All

func(it*OperationIterator)All()iter.Seq2[*longrunningpb.Operation,error]

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

func (*OperationIterator) Next

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

func (*OperationIterator) PageInfo

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

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

ProductIterator

typeProductIteratorstruct{// 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.Responseinterface{}// 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.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*licensemanagerpb.Product,nextPageTokenstring,errerror)// contains filtered or unexported fields}

ProductIterator manages a stream of *licensemanagerpb.Product.

func (*ProductIterator) All

func(it*ProductIterator)All()iter.Seq2[*licensemanagerpb.Product,error]

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

func (*ProductIterator) Next

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

func (*ProductIterator) PageInfo

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

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

ReactivateConfigurationOperation

typeReactivateConfigurationOperationstruct{// contains filtered or unexported fields}

ReactivateConfigurationOperation manages a long-running operation from ReactivateConfiguration.

func (*ReactivateConfigurationOperation) Done

Done reports whether the long-running operation has completed.

func (*ReactivateConfigurationOperation) Metadata

Metadata returns metadata associated with the long-running operation.Metadata itself does not contact the server, but Poll does.To get the latest metadata, call this method after a successful call to Poll.If the metadata is not available, the returned metadata and error are both nil.

func (*ReactivateConfigurationOperation) Name

Name returns the name of the long-running operation.The name is assigned by the server and is unique within the service from which the operation is created.

func (*ReactivateConfigurationOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds andthe operation has completed with failure, the error is returned and op.Done will return true.If Poll succeeds and the operation has completed successfully,op.Done will return true, and the response of the operation is returned.If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*ReactivateConfigurationOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

UpdateConfigurationOperation

typeUpdateConfigurationOperationstruct{// contains filtered or unexported fields}

UpdateConfigurationOperation manages a long-running operation from UpdateConfiguration.

func (*UpdateConfigurationOperation) Done

Done reports whether the long-running operation has completed.

func (*UpdateConfigurationOperation) Metadata

Metadata returns metadata associated with the long-running operation.Metadata itself does not contact the server, but Poll does.To get the latest metadata, call this method after a successful call to Poll.If the metadata is not available, the returned metadata and error are both nil.

func (*UpdateConfigurationOperation) Name

Name returns the name of the long-running operation.The name is assigned by the server and is unique within the service from which the operation is created.

func (*UpdateConfigurationOperation) Poll

Poll fetches the latest state of the long-running operation.

Poll also fetches the latest metadata, which can be retrieved by Metadata.

If Poll fails, the error is returned and op is unmodified. If Poll succeeds andthe operation has completed with failure, the error is returned and op.Done will return true.If Poll succeeds and the operation has completed successfully,op.Done will return true, and the response of the operation is returned.If Poll succeeds and the operation has not completed, the returned response and error are both nil.

func (*UpdateConfigurationOperation) Wait

Wait blocks until the long-running operation is completed, returning the response and any errors encountered.

See documentation of Poll for error-handling information.

UsageIterator

typeUsageIteratorstruct{// 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.Responseinterface{}// 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.InternalFetchfunc(pageSizeint,pageTokenstring)(results[]*licensemanagerpb.Usage,nextPageTokenstring,errerror)// contains filtered or unexported fields}

UsageIterator manages a stream of *licensemanagerpb.Usage.

func (*UsageIterator) All

func(it*UsageIterator)All()iter.Seq2[*licensemanagerpb.Usage,error]

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

func (*UsageIterator) Next

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

func (*UsageIterator) PageInfo

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

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

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-30 UTC.