Package licensemanager is an auto-generated package for the License Manager API.
License Manager is a tool to manage and track third-party licenses on Google Cloud.
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:
- Authentication and Authorization
- Timeouts and Cancellation
- Testing against Client Libraries
- Debugging Client Libraries
- Inspecting errors
Example usage
To get started with this package, create a client.
// go get cloud.google.com/go/licensemanager/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 := licensemanager . NewClient ( 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 := & 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 () 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 .( * licensemanagerpb . AggregateUsageResponse ) }
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.
Functions
func DefaultAuthScopes
func
DefaultAuthScopes
()
[]
string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
CallOptions
type
CallOptions
struct
{
ListConfigurations
[]
gax
.
CallOption
GetConfiguration
[]
gax
.
CallOption
CreateConfiguration
[]
gax
.
CallOption
UpdateConfiguration
[]
gax
.
CallOption
DeleteConfiguration
[]
gax
.
CallOption
ListInstances
[]
gax
.
CallOption
GetInstance
[]
gax
.
CallOption
DeactivateConfiguration
[]
gax
.
CallOption
ReactivateConfiguration
[]
gax
.
CallOption
QueryConfigurationLicenseUsage
[]
gax
.
CallOption
AggregateUsage
[]
gax
.
CallOption
ListProducts
[]
gax
.
CallOption
GetProduct
[]
gax
.
CallOption
GetLocation
[]
gax
.
CallOption
ListLocations
[]
gax
.
CallOption
CancelOperation
[]
gax
.
CallOption
DeleteOperation
[]
gax
.
CallOption
GetOperation
[]
gax
.
CallOption
ListOperations
[]
gax
.
CallOption
}
CallOptions contains the retry settings for each method of Client.
Client
type
Client
struct
{
// 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
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
package
main
import
(
"context"
licensemanager
"cloud.google.com/go/licensemanager/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
:=
licensemanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func NewRESTClient
NewRESTClient creates a new license manager rest client.
Service describing handlers for resources
Example
package
main
import
(
"context"
licensemanager
"cloud.google.com/go/licensemanager/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
:=
licensemanager
.
NewRESTClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func (*Client) AggregateUsage
func
(
c
*
Client
)
AggregateUsage
(
ctx
context
.
Context
,
req
*
licensemanagerpb
.
AggregateUsageRequest
,
opts
...
gax
.
CallOption
)
*
UsageIterator
AggregateUsage aggregates Usage per Instance for a Configuration.
Examples
package
main
import
(
"context"
licensemanager
"cloud.google.com/go/licensemanager/apiv1"
licensemanagerpb
"cloud.google.com/go/licensemanager/apiv1/licensemanagerpb"
"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
:=
licensemanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
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
()
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
.(
*
licensemanagerpb
.
AggregateUsageResponse
)
}
}
all
package
main
import
(
"context"
licensemanager
"cloud.google.com/go/licensemanager/apiv1"
licensemanagerpb
"cloud.google.com/go/licensemanager/apiv1/licensemanagerpb"
)
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
:=
licensemanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& licensemanagerpb
.
AggregateUsageRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/licensemanager/apiv1/licensemanagerpb#AggregateUsageRequest.
}
for
resp
,
err
:=
range
c
.
AggregateUsage
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) CancelOperation
func
(
c
*
Client
)
CancelOperation
(
ctx
context
.
Context
,
req
*
longrunningpb
.
CancelOperationRequest
,
opts
...
gax
.
CallOption
)
error
CancelOperation is a utility method from google.longrunning.Operations.
Example
package
main
import
(
"context"
licensemanager
"cloud.google.com/go/licensemanager/apiv1"
longrunningpb
"cloud.google.com/go/longrunning/autogen/longrunningpb"
)
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
:=
licensemanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
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
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*Client) Close
Close closes the connection to the API service. The user should invoke this when the 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 always return the same resource.
func (*Client) CreateConfiguration
func
(
c
*
Client
)
CreateConfiguration
(
ctx
context
.
Context
,
req
*
licensemanagerpb
.
CreateConfigurationRequest
,
opts
...
gax
.
CallOption
)
(
*
CreateConfigurationOperation
,
error
)
CreateConfiguration creates a new Configuration in a given project and location.
Example
package
main
import
(
"context"
licensemanager
"cloud.google.com/go/licensemanager/apiv1"
licensemanagerpb
"cloud.google.com/go/licensemanager/apiv1/licensemanagerpb"
)
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
:=
licensemanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
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
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) CreateConfigurationOperation
func
(
c
*
Client
)
CreateConfigurationOperation
(
name
string
)
*
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
func
(
c
*
Client
)
DeactivateConfiguration
(
ctx
context
.
Context
,
req
*
licensemanagerpb
.
DeactivateConfigurationRequest
,
opts
...
gax
.
CallOption
)
(
*
DeactivateConfigurationOperation
,
error
)
DeactivateConfiguration deactivates the given configuration.
Example
package
main
import
(
"context"
licensemanager
"cloud.google.com/go/licensemanager/apiv1"
licensemanagerpb
"cloud.google.com/go/licensemanager/apiv1/licensemanagerpb"
)
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
:=
licensemanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
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
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) DeactivateConfigurationOperation
func
(
c
*
Client
)
DeactivateConfigurationOperation
(
name
string
)
*
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
func
(
c
*
Client
)
DeleteConfiguration
(
ctx
context
.
Context
,
req
*
licensemanagerpb
.
DeleteConfigurationRequest
,
opts
...
gax
.
CallOption
)
(
*
DeleteConfigurationOperation
,
error
)
DeleteConfiguration deletes a single Configuration.
Example
package
main
import
(
"context"
licensemanager
"cloud.google.com/go/licensemanager/apiv1"
licensemanagerpb
"cloud.google.com/go/licensemanager/apiv1/licensemanagerpb"
)
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
:=
licensemanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
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
)
if
err
!=
nil
{
// TODO: Handle error.
}
err
=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*Client) DeleteConfigurationOperation
func
(
c
*
Client
)
DeleteConfigurationOperation
(
name
string
)
*
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
func
(
c
*
Client
)
DeleteOperation
(
ctx
context
.
Context
,
req
*
longrunningpb
.
DeleteOperationRequest
,
opts
...
gax
.
CallOption
)
error
DeleteOperation is a utility method from google.longrunning.Operations.
Example
package
main
import
(
"context"
licensemanager
"cloud.google.com/go/licensemanager/apiv1"
longrunningpb
"cloud.google.com/go/longrunning/autogen/longrunningpb"
)
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
:=
licensemanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
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
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*Client) GetConfiguration
func
(
c
*
Client
)
GetConfiguration
(
ctx
context
.
Context
,
req
*
licensemanagerpb
.
GetConfigurationRequest
,
opts
...
gax
.
CallOption
)
(
*
licensemanagerpb
.
Configuration
,
error
)
GetConfiguration gets details of a single Configuration.
Example
package
main
import
(
"context"
licensemanager
"cloud.google.com/go/licensemanager/apiv1"
licensemanagerpb
"cloud.google.com/go/licensemanager/apiv1/licensemanagerpb"
)
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
:=
licensemanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
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
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) GetInstance
func
(
c
*
Client
)
GetInstance
(
ctx
context
.
Context
,
req
*
licensemanagerpb
.
GetInstanceRequest
,
opts
...
gax
.
CallOption
)
(
*
licensemanagerpb
.
Instance
,
error
)
GetInstance gets details of a single Instance.
Example
package
main
import
(
"context"
licensemanager
"cloud.google.com/go/licensemanager/apiv1"
licensemanagerpb
"cloud.google.com/go/licensemanager/apiv1/licensemanagerpb"
)
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
:=
licensemanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
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
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) GetLocation
func
(
c
*
Client
)
GetLocation
(
ctx
context
.
Context
,
req
*
locationpb
.
GetLocationRequest
,
opts
...
gax
.
CallOption
)
(
*
locationpb
.
Location
,
error
)
GetLocation gets information about a location.
Example
package
main
import
(
"context"
licensemanager
"cloud.google.com/go/licensemanager/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
:=
licensemanager
.
NewClient
(
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 (*Client) GetOperation
func
(
c
*
Client
)
GetOperation
(
ctx
context
.
Context
,
req
*
longrunningpb
.
GetOperationRequest
,
opts
...
gax
.
CallOption
)
(
*
longrunningpb
.
Operation
,
error
)
GetOperation is a utility method from google.longrunning.Operations.
Example
package
main
import
(
"context"
licensemanager
"cloud.google.com/go/licensemanager/apiv1"
longrunningpb
"cloud.google.com/go/longrunning/autogen/longrunningpb"
)
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
:=
licensemanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
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
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) GetProduct
func
(
c
*
Client
)
GetProduct
(
ctx
context
.
Context
,
req
*
licensemanagerpb
.
GetProductRequest
,
opts
...
gax
.
CallOption
)
(
*
licensemanagerpb
.
Product
,
error
)
GetProduct gets details of a single Product.
Example
package
main
import
(
"context"
licensemanager
"cloud.google.com/go/licensemanager/apiv1"
licensemanagerpb
"cloud.google.com/go/licensemanager/apiv1/licensemanagerpb"
)
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
:=
licensemanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
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
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) ListConfigurations
func
(
c
*
Client
)
ListConfigurations
(
ctx
context
.
Context
,
req
*
licensemanagerpb
.
ListConfigurationsRequest
,
opts
...
gax
.
CallOption
)
*
ConfigurationIterator
ListConfigurations lists Configurations in a given project and location.
Examples
package
main
import
(
"context"
licensemanager
"cloud.google.com/go/licensemanager/apiv1"
licensemanagerpb
"cloud.google.com/go/licensemanager/apiv1/licensemanagerpb"
"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
:=
licensemanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
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
()
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
.(
*
licensemanagerpb
.
ListConfigurationsResponse
)
}
}
all
package
main
import
(
"context"
licensemanager
"cloud.google.com/go/licensemanager/apiv1"
licensemanagerpb
"cloud.google.com/go/licensemanager/apiv1/licensemanagerpb"
)
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
:=
licensemanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& licensemanagerpb
.
ListConfigurationsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/licensemanager/apiv1/licensemanagerpb#ListConfigurationsRequest.
}
for
resp
,
err
:=
range
c
.
ListConfigurations
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) ListInstances
func
(
c
*
Client
)
ListInstances
(
ctx
context
.
Context
,
req
*
licensemanagerpb
.
ListInstancesRequest
,
opts
...
gax
.
CallOption
)
*
InstanceIterator
ListInstances lists Instances in a given project and location.
Examples
package
main
import
(
"context"
licensemanager
"cloud.google.com/go/licensemanager/apiv1"
licensemanagerpb
"cloud.google.com/go/licensemanager/apiv1/licensemanagerpb"
"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
:=
licensemanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
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
()
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
.(
*
licensemanagerpb
.
ListInstancesResponse
)
}
}
all
package
main
import
(
"context"
licensemanager
"cloud.google.com/go/licensemanager/apiv1"
licensemanagerpb
"cloud.google.com/go/licensemanager/apiv1/licensemanagerpb"
)
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
:=
licensemanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& licensemanagerpb
.
ListInstancesRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/licensemanager/apiv1/licensemanagerpb#ListInstancesRequest.
}
for
resp
,
err
:=
range
c
.
ListInstances
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) ListLocations
func
(
c
*
Client
)
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"
licensemanager
"cloud.google.com/go/licensemanager/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
:=
licensemanager
.
NewClient
(
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"
licensemanager
"cloud.google.com/go/licensemanager/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
:=
licensemanager
.
NewClient
(
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 (*Client) ListOperations
func
(
c
*
Client
)
ListOperations
(
ctx
context
.
Context
,
req
*
longrunningpb
.
ListOperationsRequest
,
opts
...
gax
.
CallOption
)
*
OperationIterator
ListOperations is a utility method from google.longrunning.Operations.
Examples
package
main
import
(
"context"
licensemanager
"cloud.google.com/go/licensemanager/apiv1"
longrunningpb
"cloud.google.com/go/longrunning/autogen/longrunningpb"
"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
:=
licensemanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
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
()
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
.(
*
longrunningpb
.
ListOperationsResponse
)
}
}
all
package
main
import
(
"context"
licensemanager
"cloud.google.com/go/licensemanager/apiv1"
longrunningpb
"cloud.google.com/go/longrunning/autogen/longrunningpb"
)
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
:=
licensemanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& longrunningpb
.
ListOperationsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/longrunning/autogen/longrunningpb#ListOperationsRequest.
}
for
resp
,
err
:=
range
c
.
ListOperations
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) ListProducts
func
(
c
*
Client
)
ListProducts
(
ctx
context
.
Context
,
req
*
licensemanagerpb
.
ListProductsRequest
,
opts
...
gax
.
CallOption
)
*
ProductIterator
ListProducts lists Products in a given project and location.
Examples
package
main
import
(
"context"
licensemanager
"cloud.google.com/go/licensemanager/apiv1"
licensemanagerpb
"cloud.google.com/go/licensemanager/apiv1/licensemanagerpb"
"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
:=
licensemanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
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
()
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
.(
*
licensemanagerpb
.
ListProductsResponse
)
}
}
all
package
main
import
(
"context"
licensemanager
"cloud.google.com/go/licensemanager/apiv1"
licensemanagerpb
"cloud.google.com/go/licensemanager/apiv1/licensemanagerpb"
)
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
:=
licensemanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& licensemanagerpb
.
ListProductsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/licensemanager/apiv1/licensemanagerpb#ListProductsRequest.
}
for
resp
,
err
:=
range
c
.
ListProducts
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) QueryConfigurationLicenseUsage
func
(
c
*
Client
)
QueryConfigurationLicenseUsage
(
ctx
context
.
Context
,
req
*
licensemanagerpb
.
QueryConfigurationLicenseUsageRequest
,
opts
...
gax
.
CallOption
)
(
*
licensemanagerpb
.
QueryConfigurationLicenseUsageResponse
,
error
)
QueryConfigurationLicenseUsage license Usage information for a Configuration.
Example
package
main
import
(
"context"
licensemanager
"cloud.google.com/go/licensemanager/apiv1"
licensemanagerpb
"cloud.google.com/go/licensemanager/apiv1/licensemanagerpb"
)
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
:=
licensemanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
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
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) ReactivateConfiguration
func
(
c
*
Client
)
ReactivateConfiguration
(
ctx
context
.
Context
,
req
*
licensemanagerpb
.
ReactivateConfigurationRequest
,
opts
...
gax
.
CallOption
)
(
*
ReactivateConfigurationOperation
,
error
)
ReactivateConfiguration reactivates the given configuration.
Example
package
main
import
(
"context"
licensemanager
"cloud.google.com/go/licensemanager/apiv1"
licensemanagerpb
"cloud.google.com/go/licensemanager/apiv1/licensemanagerpb"
)
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
:=
licensemanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
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
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) ReactivateConfigurationOperation
func
(
c
*
Client
)
ReactivateConfigurationOperation
(
name
string
)
*
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
func
(
c
*
Client
)
UpdateConfiguration
(
ctx
context
.
Context
,
req
*
licensemanagerpb
.
UpdateConfigurationRequest
,
opts
...
gax
.
CallOption
)
(
*
UpdateConfigurationOperation
,
error
)
UpdateConfiguration updates the parameters of a single Configuration.
Example
package
main
import
(
"context"
licensemanager
"cloud.google.com/go/licensemanager/apiv1"
licensemanagerpb
"cloud.google.com/go/licensemanager/apiv1/licensemanagerpb"
)
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
:=
licensemanager
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
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
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) UpdateConfigurationOperation
func
(
c
*
Client
)
UpdateConfigurationOperation
(
name
string
)
*
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
type
ConfigurationIterator
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
[]
*
licensemanagerpb
.
Configuration
,
nextPageToken
string
,
err
error
)
// 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, the iterator will stop after that iteration.
func (*ConfigurationIterator) Next
func
(
it
*
ConfigurationIterator
)
Next
()
(
*
licensemanagerpb
.
Configuration
,
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 (*ConfigurationIterator) PageInfo
func
(
it
*
ConfigurationIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
CreateConfigurationOperation
type
CreateConfigurationOperation
struct
{
// contains filtered or unexported fields
}
CreateConfigurationOperation manages a long-running operation from CreateConfiguration.
func (*CreateConfigurationOperation) Done
func
(
op
*
CreateConfigurationOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*CreateConfigurationOperation) Metadata
func
(
op
*
CreateConfigurationOperation
)
Metadata
()
(
*
licensemanagerpb
.
OperationMetadata
,
error
)
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
func
(
op
*
CreateConfigurationOperation
)
Name
()
string
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
func
(
op
*
CreateConfigurationOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
licensemanagerpb
.
Configuration
,
error
)
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 and the 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
func
(
op
*
CreateConfigurationOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
licensemanagerpb
.
Configuration
,
error
)
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
type
DeactivateConfigurationOperation
struct
{
// contains filtered or unexported fields
}
DeactivateConfigurationOperation manages a long-running operation from DeactivateConfiguration.
func (*DeactivateConfigurationOperation) Done
func
(
op
*
DeactivateConfigurationOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*DeactivateConfigurationOperation) Metadata
func
(
op
*
DeactivateConfigurationOperation
)
Metadata
()
(
*
licensemanagerpb
.
OperationMetadata
,
error
)
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
func
(
op
*
DeactivateConfigurationOperation
)
Name
()
string
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
func
(
op
*
DeactivateConfigurationOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
licensemanagerpb
.
Configuration
,
error
)
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 and the 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
func
(
op
*
DeactivateConfigurationOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
licensemanagerpb
.
Configuration
,
error
)
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
type
DeleteConfigurationOperation
struct
{
// contains filtered or unexported fields
}
DeleteConfigurationOperation manages a long-running operation from DeleteConfiguration.
func (*DeleteConfigurationOperation) Done
func
(
op
*
DeleteConfigurationOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*DeleteConfigurationOperation) Metadata
func
(
op
*
DeleteConfigurationOperation
)
Metadata
()
(
*
licensemanagerpb
.
OperationMetadata
,
error
)
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
func
(
op
*
DeleteConfigurationOperation
)
Name
()
string
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
func
(
op
*
DeleteConfigurationOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
error
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 and the 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
func
(
op
*
DeleteConfigurationOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
error
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
type
InstanceIterator
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
[]
*
licensemanagerpb
.
Instance
,
nextPageToken
string
,
err
error
)
// 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, the iterator will stop after that iteration.
func (*InstanceIterator) Next
func
(
it
*
InstanceIterator
)
Next
()
(
*
licensemanagerpb
.
Instance
,
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 (*InstanceIterator) PageInfo
func
(
it
*
InstanceIterator
)
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.
OperationIterator
type
OperationIterator
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
[]
*
longrunningpb
.
Operation
,
nextPageToken
string
,
err
error
)
// 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, the iterator will stop after that iteration.
func (*OperationIterator) Next
func
(
it
*
OperationIterator
)
Next
()
(
*
longrunningpb
.
Operation
,
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 (*OperationIterator) PageInfo
func
(
it
*
OperationIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
ProductIterator
type
ProductIterator
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
[]
*
licensemanagerpb
.
Product
,
nextPageToken
string
,
err
error
)
// 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, the iterator will stop after that iteration.
func (*ProductIterator) Next
func
(
it
*
ProductIterator
)
Next
()
(
*
licensemanagerpb
.
Product
,
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 (*ProductIterator) PageInfo
func
(
it
*
ProductIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
ReactivateConfigurationOperation
type
ReactivateConfigurationOperation
struct
{
// contains filtered or unexported fields
}
ReactivateConfigurationOperation manages a long-running operation from ReactivateConfiguration.
func (*ReactivateConfigurationOperation) Done
func
(
op
*
ReactivateConfigurationOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*ReactivateConfigurationOperation) Metadata
func
(
op
*
ReactivateConfigurationOperation
)
Metadata
()
(
*
licensemanagerpb
.
OperationMetadata
,
error
)
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
func
(
op
*
ReactivateConfigurationOperation
)
Name
()
string
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
func
(
op
*
ReactivateConfigurationOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
licensemanagerpb
.
Configuration
,
error
)
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 and the 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
func
(
op
*
ReactivateConfigurationOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
licensemanagerpb
.
Configuration
,
error
)
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
type
UpdateConfigurationOperation
struct
{
// contains filtered or unexported fields
}
UpdateConfigurationOperation manages a long-running operation from UpdateConfiguration.
func (*UpdateConfigurationOperation) Done
func
(
op
*
UpdateConfigurationOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*UpdateConfigurationOperation) Metadata
func
(
op
*
UpdateConfigurationOperation
)
Metadata
()
(
*
licensemanagerpb
.
OperationMetadata
,
error
)
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
func
(
op
*
UpdateConfigurationOperation
)
Name
()
string
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
func
(
op
*
UpdateConfigurationOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
licensemanagerpb
.
Configuration
,
error
)
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 and the 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
func
(
op
*
UpdateConfigurationOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
licensemanagerpb
.
Configuration
,
error
)
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
type
UsageIterator
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
[]
*
licensemanagerpb
.
Usage
,
nextPageToken
string
,
err
error
)
// 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, the iterator will stop after that iteration.
func (*UsageIterator) Next
func
(
it
*
UsageIterator
)
Next
()
(
*
licensemanagerpb
.
Usage
,
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 (*UsageIterator) PageInfo
func
(
it
*
UsageIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
