Package procurement is an auto-generated package for the Cloud Commerce Consumer Procurement API.
Enables consumers to procure products served by Cloud Marketplace platform
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.
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 := procurement.NewLicenseManagementClient(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.
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 := procurement.NewLicenseManagementClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close() req := &procurementpb.AssignRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/commerce/consumer/procurement/apiv1/procurementpb#AssignRequest. } resp, err := c.Assign(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp
Use of Context
The ctx passed to NewLicenseManagementClient 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.
CancelOrderOperation
type CancelOrderOperation struct {
// contains filtered or unexported fields
}
CancelOrderOperation manages a long-running operation from CancelOrder.
func (*CancelOrderOperation) Done
func (op *CancelOrderOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*CancelOrderOperation) Metadata
func (op *CancelOrderOperation) Metadata() (*procurementpb.CancelOrderMetadata, 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 (*CancelOrderOperation) Name
func (op *CancelOrderOperation) 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 (*CancelOrderOperation) Poll
func (op *CancelOrderOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*procurementpb.Order, 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 (*CancelOrderOperation) Wait
func (op *CancelOrderOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*procurementpb.Order, 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.
ConsumerProcurementCallOptions
type ConsumerProcurementCallOptions struct {
PlaceOrder []gax.CallOption
GetOrder []gax.CallOption
ListOrders []gax.CallOption
ModifyOrder []gax.CallOption
CancelOrder []gax.CallOption
GetOperation []gax.CallOption
}
ConsumerProcurementCallOptions contains the retry settings for each method of ConsumerProcurementClient.
ConsumerProcurementClient
type ConsumerProcurementClient struct {
// The call options for this service.
CallOptions *ConsumerProcurementCallOptions
// 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
}
ConsumerProcurementClient is a client for interacting with Cloud Commerce Consumer Procurement API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
ConsumerProcurementService allows customers to make purchases of products served by the Cloud Commerce platform.
When purchases are made, the ConsumerProcurementService programs the appropriate backends, including both Google’s own infrastructure, as well as third-party systems, and to enable billing setup for charging for the procured item.
func NewConsumerProcurementClient
func NewConsumerProcurementClient(ctx context.Context, opts ...option.ClientOption) (*ConsumerProcurementClient, error)
NewConsumerProcurementClient creates a new consumer procurement service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
ConsumerProcurementService allows customers to make purchases of products served by the Cloud Commerce platform.
When purchases are made, the ConsumerProcurementService programs the appropriate backends, including both Google’s own infrastructure, as well as third-party systems, and to enable billing setup for charging for the procured item.
Example
package main
import (
"context"
procurement "cloud.google.com/go/commerce/consumer/procurement/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 := procurement.NewConsumerProcurementClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func NewConsumerProcurementRESTClient
func NewConsumerProcurementRESTClient(ctx context.Context, opts ...option.ClientOption) (*ConsumerProcurementClient, error)
NewConsumerProcurementRESTClient creates a new consumer procurement service rest client.
ConsumerProcurementService allows customers to make purchases of products served by the Cloud Commerce platform.
When purchases are made, the ConsumerProcurementService programs the appropriate backends, including both Google’s own infrastructure, as well as third-party systems, and to enable billing setup for charging for the procured item.
Example
package main
import (
"context"
procurement "cloud.google.com/go/commerce/consumer/procurement/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 := procurement.NewConsumerProcurementRESTClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func (*ConsumerProcurementClient) CancelOrder
func (c *ConsumerProcurementClient) CancelOrder(ctx context.Context, req *procurementpb.CancelOrderRequest, opts ...gax.CallOption) (*CancelOrderOperation, error)
CancelOrder cancels an existing Order. Every product procured in the Order will be cancelled.
Example
package main
import (
"context"
procurement "cloud.google.com/go/commerce/consumer/procurement/apiv1"
procurementpb "cloud.google.com/go/commerce/consumer/procurement/apiv1/procurementpb"
)
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 := procurement.NewConsumerProcurementClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &procurementpb.CancelOrderRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/commerce/consumer/procurement/apiv1/procurementpb#CancelOrderRequest.
}
op, err := c.CancelOrder(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ConsumerProcurementClient) CancelOrderOperation
func (c *ConsumerProcurementClient) CancelOrderOperation(name string) *CancelOrderOperation
CancelOrderOperation returns a new CancelOrderOperation from a given name. The name must be that of a previously created CancelOrderOperation, possibly from a different process.
func (*ConsumerProcurementClient) Close
func (c *ConsumerProcurementClient) Close() error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*ConsumerProcurementClient) Connection (deprecated)
func (c *ConsumerProcurementClient) 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 (*ConsumerProcurementClient) GetOperation
func (c *ConsumerProcurementClient) 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"
procurement "cloud.google.com/go/commerce/consumer/procurement/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 := procurement.NewConsumerProcurementClient(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 (*ConsumerProcurementClient) GetOrder
func (c *ConsumerProcurementClient) GetOrder(ctx context.Context, req *procurementpb.GetOrderRequest, opts ...gax.CallOption) (*procurementpb.Order, error)
GetOrder returns the requested Order resource.
Example
package main
import (
"context"
procurement "cloud.google.com/go/commerce/consumer/procurement/apiv1"
procurementpb "cloud.google.com/go/commerce/consumer/procurement/apiv1/procurementpb"
)
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 := procurement.NewConsumerProcurementClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &procurementpb.GetOrderRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/commerce/consumer/procurement/apiv1/procurementpb#GetOrderRequest.
}
resp, err := c.GetOrder(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ConsumerProcurementClient) ListOrders
func (c *ConsumerProcurementClient) ListOrders(ctx context.Context, req *procurementpb.ListOrdersRequest, opts ...gax.CallOption) *OrderIterator
ListOrders lists Order resources that the user has access to, within the scope of the parent resource.
Examples
package main
import (
"context"
procurement "cloud.google.com/go/commerce/consumer/procurement/apiv1"
procurementpb "cloud.google.com/go/commerce/consumer/procurement/apiv1/procurementpb"
"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 := procurement.NewConsumerProcurementClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &procurementpb.ListOrdersRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/commerce/consumer/procurement/apiv1/procurementpb#ListOrdersRequest.
}
it := c.ListOrders(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.(*procurementpb.ListOrdersResponse)
}
}
all
package main
import (
"context"
procurement "cloud.google.com/go/commerce/consumer/procurement/apiv1"
procurementpb "cloud.google.com/go/commerce/consumer/procurement/apiv1/procurementpb"
)
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 := procurement.NewConsumerProcurementClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &procurementpb.ListOrdersRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/commerce/consumer/procurement/apiv1/procurementpb#ListOrdersRequest.
}
for resp, err := range c.ListOrders(ctx, req).All() {
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*ConsumerProcurementClient) ModifyOrder
func (c *ConsumerProcurementClient) ModifyOrder(ctx context.Context, req *procurementpb.ModifyOrderRequest, opts ...gax.CallOption) (*ModifyOrderOperation, error)
ModifyOrder modifies an existing Order resource.
Example
package main
import (
"context"
procurement "cloud.google.com/go/commerce/consumer/procurement/apiv1"
procurementpb "cloud.google.com/go/commerce/consumer/procurement/apiv1/procurementpb"
)
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 := procurement.NewConsumerProcurementClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &procurementpb.ModifyOrderRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/commerce/consumer/procurement/apiv1/procurementpb#ModifyOrderRequest.
}
op, err := c.ModifyOrder(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ConsumerProcurementClient) ModifyOrderOperation
func (c *ConsumerProcurementClient) ModifyOrderOperation(name string) *ModifyOrderOperation
ModifyOrderOperation returns a new ModifyOrderOperation from a given name. The name must be that of a previously created ModifyOrderOperation, possibly from a different process.
func (*ConsumerProcurementClient) PlaceOrder
func (c *ConsumerProcurementClient) PlaceOrder(ctx context.Context, req *procurementpb.PlaceOrderRequest, opts ...gax.CallOption) (*PlaceOrderOperation, error)
PlaceOrder creates a new Order.
This API only supports GCP spend-based committed use discounts specified by GCP documentation.
The returned long-running operation is in-progress until the backend completes the creation of the resource. Once completed, the order is in OrderState.ORDER_STATE_ACTIVE. In case of failure, the order resource will be removed.
Example
package main
import (
"context"
procurement "cloud.google.com/go/commerce/consumer/procurement/apiv1"
procurementpb "cloud.google.com/go/commerce/consumer/procurement/apiv1/procurementpb"
)
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 := procurement.NewConsumerProcurementClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &procurementpb.PlaceOrderRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/commerce/consumer/procurement/apiv1/procurementpb#PlaceOrderRequest.
}
op, err := c.PlaceOrder(ctx, req)
if err != nil {
// TODO: Handle error.
}
resp, err := op.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*ConsumerProcurementClient) PlaceOrderOperation
func (c *ConsumerProcurementClient) PlaceOrderOperation(name string) *PlaceOrderOperation
PlaceOrderOperation returns a new PlaceOrderOperation from a given name. The name must be that of a previously created PlaceOrderOperation, possibly from a different process.
LicenseManagementCallOptions
type LicenseManagementCallOptions struct {
GetLicensePool []gax.CallOption
UpdateLicensePool []gax.CallOption
Assign []gax.CallOption
Unassign []gax.CallOption
EnumerateLicensedUsers []gax.CallOption
GetOperation []gax.CallOption
}
LicenseManagementCallOptions contains the retry settings for each method of LicenseManagementClient.
LicenseManagementClient
type LicenseManagementClient struct {
// The call options for this service.
CallOptions *LicenseManagementCallOptions
// contains filtered or unexported fields
}
LicenseManagementClient is a client for interacting with Cloud Commerce Consumer Procurement API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
Service for managing licenses.
func NewLicenseManagementClient
func NewLicenseManagementClient(ctx context.Context, opts ...option.ClientOption) (*LicenseManagementClient, error)
NewLicenseManagementClient creates a new license management service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
Service for managing licenses.
Example
package main
import (
"context"
procurement "cloud.google.com/go/commerce/consumer/procurement/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 := procurement.NewLicenseManagementClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func NewLicenseManagementRESTClient
func NewLicenseManagementRESTClient(ctx context.Context, opts ...option.ClientOption) (*LicenseManagementClient, error)
NewLicenseManagementRESTClient creates a new license management service rest client.
Service for managing licenses.
Example
package main
import (
"context"
procurement "cloud.google.com/go/commerce/consumer/procurement/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 := procurement.NewLicenseManagementRESTClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func (*LicenseManagementClient) Assign
func (c *LicenseManagementClient) Assign(ctx context.Context, req *procurementpb.AssignRequest, opts ...gax.CallOption) (*procurementpb.AssignResponse, error)
Assign assigns a license to a user.
Example
package main
import (
"context"
procurement "cloud.google.com/go/commerce/consumer/procurement/apiv1"
procurementpb "cloud.google.com/go/commerce/consumer/procurement/apiv1/procurementpb"
)
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 := procurement.NewLicenseManagementClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &procurementpb.AssignRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/commerce/consumer/procurement/apiv1/procurementpb#AssignRequest.
}
resp, err := c.Assign(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*LicenseManagementClient) Close
func (c *LicenseManagementClient) Close() error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*LicenseManagementClient) Connection (deprecated)
func (c *LicenseManagementClient) 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 (*LicenseManagementClient) EnumerateLicensedUsers
func (c *LicenseManagementClient) EnumerateLicensedUsers(ctx context.Context, req *procurementpb.EnumerateLicensedUsersRequest, opts ...gax.CallOption) *LicensedUserIterator
EnumerateLicensedUsers enumerates all users assigned a license.
Examples
package main
import (
"context"
procurement "cloud.google.com/go/commerce/consumer/procurement/apiv1"
procurementpb "cloud.google.com/go/commerce/consumer/procurement/apiv1/procurementpb"
"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 := procurement.NewLicenseManagementClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &procurementpb.EnumerateLicensedUsersRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/commerce/consumer/procurement/apiv1/procurementpb#EnumerateLicensedUsersRequest.
}
it := c.EnumerateLicensedUsers(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.(*procurementpb.EnumerateLicensedUsersResponse)
}
}
all
package main
import (
"context"
procurement "cloud.google.com/go/commerce/consumer/procurement/apiv1"
procurementpb "cloud.google.com/go/commerce/consumer/procurement/apiv1/procurementpb"
)
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 := procurement.NewLicenseManagementClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &procurementpb.EnumerateLicensedUsersRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/commerce/consumer/procurement/apiv1/procurementpb#EnumerateLicensedUsersRequest.
}
for resp, err := range c.EnumerateLicensedUsers(ctx, req).All() {
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*LicenseManagementClient) GetLicensePool
func (c *LicenseManagementClient) GetLicensePool(ctx context.Context, req *procurementpb.GetLicensePoolRequest, opts ...gax.CallOption) (*procurementpb.LicensePool, error)
GetLicensePool gets the license pool.
Example
package main
import (
"context"
procurement "cloud.google.com/go/commerce/consumer/procurement/apiv1"
procurementpb "cloud.google.com/go/commerce/consumer/procurement/apiv1/procurementpb"
)
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 := procurement.NewLicenseManagementClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &procurementpb.GetLicensePoolRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/commerce/consumer/procurement/apiv1/procurementpb#GetLicensePoolRequest.
}
resp, err := c.GetLicensePool(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*LicenseManagementClient) GetOperation
func (c *LicenseManagementClient) 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"
procurement "cloud.google.com/go/commerce/consumer/procurement/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 := procurement.NewLicenseManagementClient(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 (*LicenseManagementClient) Unassign
func (c *LicenseManagementClient) Unassign(ctx context.Context, req *procurementpb.UnassignRequest, opts ...gax.CallOption) (*procurementpb.UnassignResponse, error)
Unassign unassigns a license from a user.
Example
package main
import (
"context"
procurement "cloud.google.com/go/commerce/consumer/procurement/apiv1"
procurementpb "cloud.google.com/go/commerce/consumer/procurement/apiv1/procurementpb"
)
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 := procurement.NewLicenseManagementClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &procurementpb.UnassignRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/commerce/consumer/procurement/apiv1/procurementpb#UnassignRequest.
}
resp, err := c.Unassign(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*LicenseManagementClient) UpdateLicensePool
func (c *LicenseManagementClient) UpdateLicensePool(ctx context.Context, req *procurementpb.UpdateLicensePoolRequest, opts ...gax.CallOption) (*procurementpb.LicensePool, error)
UpdateLicensePool updates the license pool if one exists for this Order.
Example
package main
import (
"context"
procurement "cloud.google.com/go/commerce/consumer/procurement/apiv1"
procurementpb "cloud.google.com/go/commerce/consumer/procurement/apiv1/procurementpb"
)
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 := procurement.NewLicenseManagementClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &procurementpb.UpdateLicensePoolRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/commerce/consumer/procurement/apiv1/procurementpb#UpdateLicensePoolRequest.
}
resp, err := c.UpdateLicensePool(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
LicensedUserIterator
type LicensedUserIterator 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 []*procurementpb.LicensedUser, nextPageToken string, err error)
// contains filtered or unexported fields
}
LicensedUserIterator manages a stream of *procurementpb.LicensedUser.
func (*LicensedUserIterator) All
func (it *LicensedUserIterator) All() iter.Seq2[*procurementpb.LicensedUser, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*LicensedUserIterator) Next
func (it *LicensedUserIterator) Next() (*procurementpb.LicensedUser, 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 (*LicensedUserIterator) PageInfo
func (it *LicensedUserIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
ModifyOrderOperation
type ModifyOrderOperation struct {
// contains filtered or unexported fields
}
ModifyOrderOperation manages a long-running operation from ModifyOrder.
func (*ModifyOrderOperation) Done
func (op *ModifyOrderOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*ModifyOrderOperation) Metadata
func (op *ModifyOrderOperation) Metadata() (*procurementpb.ModifyOrderMetadata, 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 (*ModifyOrderOperation) Name
func (op *ModifyOrderOperation) 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 (*ModifyOrderOperation) Poll
func (op *ModifyOrderOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*procurementpb.Order, 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 (*ModifyOrderOperation) Wait
func (op *ModifyOrderOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*procurementpb.Order, 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.
OrderIterator
type OrderIterator 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 []*procurementpb.Order, nextPageToken string, err error)
// contains filtered or unexported fields
}
OrderIterator manages a stream of *procurementpb.Order.
func (*OrderIterator) All
func (it *OrderIterator) All() iter.Seq2[*procurementpb.Order, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*OrderIterator) Next
func (it *OrderIterator) Next() (*procurementpb.Order, 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 (*OrderIterator) PageInfo
func (it *OrderIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
PlaceOrderOperation
type PlaceOrderOperation struct {
// contains filtered or unexported fields
}
PlaceOrderOperation manages a long-running operation from PlaceOrder.
func (*PlaceOrderOperation) Done
func (op *PlaceOrderOperation) Done() bool
Done reports whether the long-running operation has completed.
func (*PlaceOrderOperation) Metadata
func (op *PlaceOrderOperation) Metadata() (*procurementpb.PlaceOrderMetadata, 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 (*PlaceOrderOperation) Name
func (op *PlaceOrderOperation) 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 (*PlaceOrderOperation) Poll
func (op *PlaceOrderOperation) Poll(ctx context.Context, opts ...gax.CallOption) (*procurementpb.Order, 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 (*PlaceOrderOperation) Wait
func (op *PlaceOrderOperation) Wait(ctx context.Context, opts ...gax.CallOption) (*procurementpb.Order, 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.