Cloud Channel API v1 - Package cloud.google.com/go/channel/apiv1 (v0.78.0)

Package channel is an auto-generated package for the Cloud Channel API.

Use of Context

The ctx passed to NewClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.

To close the open connection, use the Close() method.

For information about setting deadlines, reusing contexts, and more please visit pkg.go.dev/cloud.google.com/go.

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

ActivateEntitlementOperation manages a long-running operation from ActivateEntitlement.

Done reports whether the long-running operation has completed.

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.

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.

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.

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

See documentation of Poll for error-handling information.

CancelEntitlementOperation manages a long-running operation from CancelEntitlement.

Done reports whether the long-running operation has completed.

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.

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.

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.

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

See documentation of Poll for error-handling information.

ChangeOfferOperation manages a long-running operation from ChangeOffer.

Done reports whether the long-running operation has completed.

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.

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.

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.

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

See documentation of Poll for error-handling information.

ChangeParametersOperation manages a long-running operation from ChangeParameters.

Done reports whether the long-running operation has completed.

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.

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.

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.

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

See documentation of Poll for error-handling information.

ChangeRenewalSettingsOperation manages a long-running operation from ChangeRenewalSettings.

Done reports whether the long-running operation has completed.

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.

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.

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.

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

See documentation of Poll for error-handling information.

ChannelPartnerLinkIterator manages a stream of *channelpb.ChannelPartnerLink.

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.

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

CloudChannelCallOptions contains the retry settings for each method of CloudChannelClient.

CloudChannelClient is a client for interacting with Cloud Channel API.

Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

NewCloudChannelClient creates a new cloud channel service client.

CloudChannelService enables Google cloud resellers and distributors to manage their customers, channel partners, entitlements and reports.

Using this service:

Resellers or distributors can manage a customer entity.

Distributors can register an authorized reseller in their channel and then enable delegated admin access for the reseller.

Resellers or distributors can manage entitlements for their customers.

The service primarily exposes the following resources:

Customers: A Customer represents an entity managed by a reseller or distributor. A customer typically represents an enterprise. In an n-tier resale channel hierarchy, customers are generally represented as leaf nodes. Customers primarily have an Entitlement sub-resource discussed below.

Entitlements: An Entitlement represents an entity which provides a customer means to start using a service. Entitlements are created or updated as a result of a successful fulfillment.

ChannelPartnerLinks: A ChannelPartnerLink is an entity that identifies links between distributors and their indirect resellers in a channel.

ActivateEntitlement activates a previously suspended entitlement. The entitlement must be in a suspended state for it to be activated. Entitlements suspended for pending ToS acceptance can’t be activated using this method. An entitlement activation is a long-running operation and can result in updates to the state of the customer entitlement.

Possible Error Codes:

PERMISSION_DENIED: If the customer doesn’t belong to the reseller or if the reseller account making the request and reseller account being queried for are different.

INVALID_ARGUMENT: Missing or invalid required parameters in the request.

NOT_FOUND: Entitlement resource not found.

SUSPENSION_NOT_RESELLER_INITIATED: Can’t activate an entitlement that is pending TOS acceptance. Only reseller initiated suspensions can be activated.

NOT_SUSPENDED: Can’t activate entitlements that are already in ACTIVE state. Can only activate suspended entitlements.

INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.

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

CancelEntitlement cancels a previously fulfilled entitlement. An entitlement cancellation is a long-running operation.

Possible Error Codes:

PERMISSION_DENIED: If the customer doesn’t belong to the reseller or if the reseller account making the request and reseller account being queried for are different.

FAILED_PRECONDITION: If there are any Google Cloud projects linked to the Google Cloud entitlement’s Cloud Billing subaccount.

INVALID_ARGUMENT: Missing or invalid required parameters in the request.

NOT_FOUND: Entitlement resource not found.

DELETION_TYPE_NOT_ALLOWED: Cancel is only allowed for Google Workspace add-ons or entitlements for Google Cloud’s development platform.

INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The response will contain google.protobuf.Empty on success. The Operation metadata will contain an instance of OperationMetadata.

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

ChangeOffer updates the Offer for an existing customer entitlement.

An entitlement update is a long-running operation and results in updates to the entitlement as a result of fulfillment.

Possible Error Codes:

PERMISSION_DENIED: If the customer doesn’t belong to the reseller.

INVALID_ARGUMENT: Missing or invalid required parameters in the request.

NOT_FOUND: Offer or Entitlement resource not found.

INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.

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

ChangeParameters change parameters of the entitlement

An entitlement parameters update is a long-running operation and results in updates to the entitlement as a result of fulfillment.

Possible Error Codes:

PERMISSION_DENIED: If the customer doesn’t belong to the reseller.

INVALID_ARGUMENT: Missing or invalid required parameters in the request. For example, if the number of seats being changed to is greater than the allowed number of max seats for the resource. Or decreasing seats for a commitment based plan.

NOT_FOUND: Entitlement resource not found.

INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.

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

ChangeRenewalSettings updates the renewal settings for an existing customer entitlement.

An entitlement update is a long-running operation and results in updates to the entitlement as a result of fulfillment.

Possible Error Codes:

PERMISSION_DENIED: If the customer doesn’t belong to the reseller.

INVALID_ARGUMENT: Missing or invalid required parameters in the request.

NOT_FOUND: Entitlement resource not found.

NOT_COMMITMENT_PLAN: Renewal Settings are only applicable for a commitment plan. Can’t enable or disable renewal for non-commitment plans.

INTERNAL: Any non user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

UNKNOWN: Any non user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.

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

CheckCloudIdentityAccountsExist confirms the existence of Cloud Identity accounts, based on the domain and whether the Cloud Identity accounts are owned by the reseller.

Possible Error Codes:

PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.

INVALID_ARGUMENT: Missing or invalid required parameters in the request.

INVALID_VALUE: Invalid domain value in the request.

NOT_FOUND: If there is no CloudIdentityCustomerAccount customer for the domain specified in the request.

Return Value: List of CloudIdentityCustomerAccount resources if any exist for the domain, otherwise an error is returned.

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

Connection returns a connection to the API service.

Deprecated.

CreateChannelPartnerLink initiates a channel partner link between a distributor and a reseller or between resellers in an n-tier reseller channel. To accept the invite, the invited partner should follow the invite_link_uri provided in the response. If the link creation is accepted, a valid link is set up between the two involved parties. To call this method, you must be a distributor.

Possible Error Codes:

PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.

INVALID_ARGUMENT: Missing or invalid required parameters in the request.

ALREADY_EXISTS: If the ChannelPartnerLink sent in the request already exists.

NOT_FOUND: If no Cloud Identity customer exists for domain provided.

INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Newly created ChannelPartnerLink resource if successful, otherwise error is returned.

CreateCustomer creates a new Customer resource under the reseller or distributor account.

Possible Error Codes:

Return Value: If successful, the newly created Customer resource, otherwise returns an error.

CreateEntitlement creates an entitlement for a customer.

Possible Error Codes:

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.

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

DeleteCustomer deletes the given Customer permanently and irreversibly.

Possible Error Codes:

PERMISSION_DENIED: If the account making the request does not own this customer.

INVALID_ARGUMENT: Missing or invalid required parameters in the request.

FAILED_PRECONDITION: If the customer has existing entitlements.

NOT_FOUND: No Customer resource found for the name specified in the request.

GetChannelPartnerLink returns a requested ChannelPartnerLink resource. To call this method, you must be a distributor.

Possible Error Codes:

PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.

INVALID_ARGUMENT: Missing or invalid required parameters in the request.

NOT_FOUND: ChannelPartnerLink resource not found. Results due invalid channel partner link name.

Return Value: ChannelPartnerLink resource if found, otherwise returns an error.

GetCustomer returns a requested Customer resource.

Possible Error Codes:

PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.

INVALID_ARGUMENT: Missing or invalid required parameters in the request.

NOT_FOUND: If the customer resource doesn’t exist. Usually the result of an invalid name parameter.

Return Value: Customer resource if found, error otherwise.

GetEntitlement returns a requested Entitlement resource.

Possible Error Codes:

PERMISSION_DENIED: If the customer doesn’t belong to the reseller.

INVALID_ARGUMENT: Missing or invalid required parameters in the request.

NOT_FOUND: If the entitlement is not found for the customer.

Return Value: If found, the requested Entitlement resource, otherwise returns an error.

ListChannelPartnerLinks list ChannelPartnerLinks belonging to a distributor. To call this method, you must be a distributor.

Possible Error Codes:

PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.

INVALID_ARGUMENT: Missing or invalid required parameters in the request.

Return Value: If successful, returns the list of ChannelPartnerLink resources for the distributor account, otherwise returns an error.

ListCustomers list downstream Customers.

Possible Error Codes:

PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.

INVALID_ARGUMENT: Missing or invalid required parameters in the request.

Return Value: List of Customers pertaining to the reseller or empty list if there are none.

ListEntitlements list Entitlements belonging to a customer.

Possible Error Codes:

PERMISSION_DENIED: If the customer doesn’t belong to the reseller.

INVALID_ARGUMENT: Missing or invalid required parameters in the request.

Return Value: List of Entitlements belonging to the customer, or empty list if there are none.

ListOffers lists the Offers the reseller can sell.

Possible Error Codes:

INVALID_ARGUMENT: Missing or invalid required parameters in the request.

ListProducts lists the Products the reseller is authorized to sell.

Possible Error Codes:

INVALID_ARGUMENT: Missing or invalid required parameters in the request.

ListPurchasableOffers lists the Purchasable Offers for the following cases:

Offers that can be newly purchased for a customer

Offers that can be changed to, for an entitlement.

Possible Error Codes:

PERMISSION_DENIED: If the customer doesn’t belong to the reseller

INVALID_ARGUMENT: Missing or invalid required parameters in the request.

ListPurchasableSkus lists the Purchasable SKUs for following cases:

SKUs that can be newly purchased for a customer

SKUs that can be upgraded/downgraded to, for an entitlement.

Possible Error Codes:

PERMISSION_DENIED: If the customer doesn’t belong to the reseller

INVALID_ARGUMENT: Missing or invalid required parameters in the request.

ListSkus lists the SKUs for a product the reseller is authorized to sell.

Possible Error Codes:

INVALID_ARGUMENT: Missing or invalid required parameters in the request.

ListSubscribers lists service accounts with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account.

Possible Error Codes:

PERMISSION_DENIED: If the reseller account making the request and the reseller account being provided are different, or if the account is not a super admin.

INVALID_ARGUMENT: Missing or invalid required parameters in the request.

NOT_FOUND: If the topic resource doesn’t exist.

INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: List of service email addresses if successful, otherwise error is returned.

ListTransferableOffers list TransferableOffers of a customer based on Cloud Identity ID or Customer Name in the request.

This method is used when a reseller gets the entitlement information of a customer that is not owned. The reseller should provide the customer’s Cloud Identity ID or Customer Name.

Possible Error Codes:

PERMISSION_DENIED, due to one of the following reasons: (a) If the customer doesn’t belong to the reseller and no auth token or invalid auth token is supplied. (b) If the reseller account making the request and the reseller account being queried for are different.

INVALID_ARGUMENT: Missing or invalid required parameters in the request.

Return Value: List of TransferableOffer for the given customer and SKU.

ListTransferableSkus list TransferableSkus of a customer based on Cloud Identity ID or Customer Name in the request.

This method is used when a reseller lists the entitlements information of a customer that is not owned. The reseller should provide the customer’s Cloud Identity ID or Customer Name.

Possible Error Codes:

Return Value: List of TransferableSku for the given customer.

ProvisionCloudIdentity creates a Cloud Identity for the given customer using the customer’s information or the information provided here, if present.

Possible Error Codes:

PERMISSION_DENIED: If the customer doesn’t belong to the reseller.

INVALID_ARGUMENT: Missing or invalid required parameters in the request.

NOT_FOUND: If the customer is not found for the reseller.

ALREADY_EXISTS: If the customer’s primary email already exists. In this case, retry after changing the customer’s primary contact email.

INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support in this case.

UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support in this case.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.

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

RegisterSubscriber registers a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. Once you create a subscriber, you will get the events as per SubscriberEvent

Possible Error Codes:

PERMISSION_DENIED: If the reseller account making the request and the reseller account being provided are different, or if the impersonated user is not a super admin.

INVALID_ARGUMENT: Missing or invalid required parameters in the request.

INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Topic name with service email address registered if successful, otherwise error is returned.

StartPaidService starts paid service for a trial entitlement.

Starts paid service for a trial entitlement immediately. This method is only applicable if a plan has already been set up for a trial entitlement but has some trial days remaining.

Possible Error Codes:

PERMISSION_DENIED: If the customer doesn’t belong to the reseller.

INVALID_ARGUMENT: Missing or invalid required parameters in the request.

NOT_FOUND: Entitlement resource not found.

FAILED_PRECONDITION/NOT_IN_TRIAL: This method only works for entitlement on trial plans.

INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.

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

SuspendEntitlement suspends a previously fulfilled entitlement. An entitlement suspension is a long-running operation.

Possible Error Codes:

PERMISSION_DENIED: If the customer doesn’t belong to the reseller.

INVALID_ARGUMENT: Missing or invalid required parameters in the request.

NOT_FOUND: Entitlement resource not found.

NOT_ACTIVE: Entitlement is not active.

INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.

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

TransferEntitlements transfers customer entitlements to new reseller.

Possible Error Codes:

Return Value: Long Running Operation ID.

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata.