Class CloudChannelServiceClient (2.26.0)

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

Using this service:

Resellers and distributors can manage a customer entity.
Distributors can register an authorized reseller in their channel and provide them with delegated admin access.
Resellers and distributors can manage customer entitlements.

CloudChannelService exposes the following resources:

Customers: An entity-usually an enterprise-managed by a reseller or distributor.
Entitlements: An entity that provides a customer with the means to use a service. Entitlements are created or updated as a result of a successful fulfillment.
ChannelPartnerLinks: An entity that identifies links between distributors and their indirect resellers in a channel.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

CloudChannelServiceClient(CloudChannelServiceClient const &)

Copy and move support

Parameter
Name	Description
	`CloudChannelServiceClient const &`

CloudChannelServiceClient(CloudChannelServiceClient &&)

Copy and move support

Parameter
Name	Description
	`CloudChannelServiceClient &&`

CloudChannelServiceClient(std::shared_ptr< CloudChannelServiceConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< CloudChannelServiceConnection >`
`opts`	`Options`

Operators

operator=(CloudChannelServiceClient const &)

Copy and move support

Parameter
Name	Description
	`CloudChannelServiceClient const &`

Returns
Type	Description
`CloudChannelServiceClient &`

operator=(CloudChannelServiceClient &&)

Copy and move support

Parameter
Name	Description
	`CloudChannelServiceClient &&`

Returns
Type	Description
`CloudChannelServiceClient &`

Functions

ListCustomers(google::cloud::channel::v1::ListCustomersRequest, Options)

List Customers.

Possible error codes:

PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
INVALID_ARGUMENT: Required request parameters are missing or invalid.

Return value: List of Customers, or an empty list if there are no customers.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::ListCustomersRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.ListCustomersRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::channel::v1::Customer >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.channel.v1.Customer, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetCustomer(std::string const &, Options)

Returns the requested Customer resource.

Possible error codes:

PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: The customer resource doesn't exist. Usually the result of an invalid name parameter.

Return value: The Customer resource.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the customer to retrieve. Name uses the format: accounts/{account_id}/customers/{customer_id}
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::channel::v1::Customer >`	the result of the RPC. The response message type (google.cloud.channel.v1.Customer) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetCustomer(google::cloud::channel::v1::GetCustomerRequest const &, Options)

Returns the requested Customer resource.

Possible error codes:

PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: The customer resource doesn't exist. Usually the result of an invalid name parameter.

Return value: The Customer resource.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::GetCustomerRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.GetCustomerRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::channel::v1::Customer >`	the result of the RPC. The response message type (google.cloud.channel.v1.Customer) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CheckCloudIdentityAccountsExist(google::cloud::channel::v1::CheckCloudIdentityAccountsExistRequest const &, Options)

Confirms the existence of Cloud Identity accounts based on the domain and if the Cloud Identity accounts are owned by the reseller.

Possible error codes:

PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
INVALID_VALUE: Invalid domain value in the request.

Return value: A list of CloudIdentityCustomerAccount resources for the domain (may be empty)

Note: in the v1alpha1 version of the API, a NOT_FOUND error returns if no CloudIdentityCustomerAccount resources match the domain.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::CheckCloudIdentityAccountsExistRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.CheckCloudIdentityAccountsExistRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::channel::v1::CheckCloudIdentityAccountsExistResponse >`	the result of the RPC. The response message type (google.cloud.channel.v1.CheckCloudIdentityAccountsExistResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateCustomer(google::cloud::channel::v1::CreateCustomerRequest const &, Options)

Creates a new Customer resource under the reseller or distributor account.

Possible error codes:

PERMISSION_DENIED:
- The reseller account making the request is different from the reseller account in the API request.
- You are not authorized to create a customer. See https://support.google.com/channelservices/answer/9759265
INVALID_ARGUMENT:
- Required request parameters are missing or invalid.
- Domain field value doesn't match the primary email domain.

Return value: The newly created Customer resource.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::CreateCustomerRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.CreateCustomerRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::channel::v1::Customer >`	the result of the RPC. The response message type (google.cloud.channel.v1.Customer) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateCustomer(google::cloud::channel::v1::UpdateCustomerRequest const &, Options)

Updates an existing Customer resource for the reseller or distributor.

Possible error codes:

PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: No Customer resource found for the name in the request.

Return value: The updated Customer resource.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::UpdateCustomerRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.UpdateCustomerRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::channel::v1::Customer >`	the result of the RPC. The response message type (google.cloud.channel.v1.Customer) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteCustomer(std::string const &, Options)

Deletes the given Customer permanently.

Possible error codes:

PERMISSION_DENIED: The account making the request does not own this customer.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
FAILED_PRECONDITION: The customer has existing entitlements.
NOT_FOUND: No Customer resource found for the name in the request.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the customer to delete.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

DeleteCustomer(google::cloud::channel::v1::DeleteCustomerRequest const &, Options)

Deletes the given Customer permanently.

Possible error codes:

PERMISSION_DENIED: The account making the request does not own this customer.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
FAILED_PRECONDITION: The customer has existing entitlements.
NOT_FOUND: No Customer resource found for the name in the request.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::DeleteCustomerRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.DeleteCustomerRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

ImportCustomer(google::cloud::channel::v1::ImportCustomerRequest const &, Options)

Imports a Customer from the Cloud Identity associated with the provided Cloud Identity ID or domain before a TransferEntitlements call.

If a linked Customer already exists and overwrite_if_exists is true, it will update that Customer's data.

Possible error codes:

PERMISSION_DENIED:
- The reseller account making the request is different from the reseller account in the API request.
- You are not authorized to import the customer. See https://support.google.com/channelservices/answer/9759265
NOT_FOUND: Cloud Identity doesn't exist or was deleted.
INVALID_ARGUMENT: Required parameters are missing, or the auth_token is expired or invalid.
ALREADY_EXISTS: A customer already exists and has conflicting critical fields. Requires an overwrite.

Return value: The Customer.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::ImportCustomerRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.ImportCustomerRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::channel::v1::Customer >`	the result of the RPC. The response message type (google.cloud.channel.v1.Customer) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ProvisionCloudIdentity(google::cloud::channel::v1::ProvisionCloudIdentityRequest const &, Options)

Creates a Cloud Identity for the given customer using the customer's information, or the information provided here.

Possible error codes:

PERMISSION_DENIED:
- The customer doesn't belong to the reseller.
- You are not authorized to provision cloud identity id. See https://support.google.com/channelservices/answer/9759265
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: The customer was not found.
ALREADY_EXISTS: The customer's primary email already exists. 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.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

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

Parameters
Name	Description
`request`	`google::cloud::channel::v1::ProvisionCloudIdentityRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.ProvisionCloudIdentityRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::channel::v1::Customer > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.channel.v1.Customer proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ProvisionCloudIdentity(ExperimentalTag, NoAwaitTag, google::cloud::channel::v1::ProvisionCloudIdentityRequest const &, Options)

Creates a Cloud Identity for the given customer using the customer's information, or the information provided here.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`ExperimentalTag`
	`NoAwaitTag`
`request`	`google::cloud::channel::v1::ProvisionCloudIdentityRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

ProvisionCloudIdentity(ExperimentalTag, google::longrunning::Operation const &, Options)

Creates a Cloud Identity for the given customer using the customer's information, or the information provided here.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
	`ExperimentalTag`
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::channel::v1::Customer > >`

ListEntitlements(google::cloud::channel::v1::ListEntitlementsRequest, Options)

Lists Entitlements belonging to a customer.

Possible error codes:

PERMISSION_DENIED: The customer doesn't belong to the reseller.
INVALID_ARGUMENT: Required request parameters are missing or invalid.

Return value: A list of the customer's Entitlements.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::ListEntitlementsRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.ListEntitlementsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::channel::v1::Entitlement >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.channel.v1.Entitlement, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListTransferableSkus(google::cloud::channel::v1::ListTransferableSkusRequest, Options)

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

Use this method to list the entitlements information of an unowned customer. You should provide the customer's Cloud Identity ID or Customer Name.

Possible error codes:

PERMISSION_DENIED:
- The customer doesn't belong to the reseller and has no auth token.
- The supplied auth token is invalid.
- The reseller account making the request is different from the reseller account in the query.
INVALID_ARGUMENT: Required request parameters are missing or invalid.

Return value: A list of the customer's TransferableSku.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::ListTransferableSkusRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.ListTransferableSkusRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::channel::v1::TransferableSku >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.channel.v1.TransferableSku, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListTransferableOffers(google::cloud::channel::v1::ListTransferableOffersRequest, Options)

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

Use this method when a reseller gets the entitlement information of an unowned customer. The reseller should provide the customer's Cloud Identity ID or Customer Name.

Possible error codes:

PERMISSION_DENIED:
- The customer doesn't belong to the reseller and has no auth token.
- The customer provided incorrect reseller information when generating auth token.
- The reseller account making the request is different from the reseller account in the query.
- The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265
INVALID_ARGUMENT: Required request parameters are missing or invalid.

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

Parameters
Name	Description
`request`	`google::cloud::channel::v1::ListTransferableOffersRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.ListTransferableOffersRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::channel::v1::TransferableOffer >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.channel.v1.TransferableOffer, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetEntitlement(google::cloud::channel::v1::GetEntitlementRequest const &, Options)

Returns the requested Entitlement resource.

Possible error codes:

PERMISSION_DENIED: The customer doesn't belong to the reseller.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: The customer entitlement was not found.

Return value: The requested Entitlement resource.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::GetEntitlementRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.GetEntitlementRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::channel::v1::Entitlement >`	the result of the RPC. The response message type (google.cloud.channel.v1.Entitlement) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateEntitlement(google::cloud::channel::v1::CreateEntitlementRequest const &, Options)

Creates an entitlement for a customer.

Possible error codes:

PERMISSION_DENIED:
- The customer doesn't belong to the reseller.
- The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265
INVALID_ARGUMENT:
- Required request parameters are missing or invalid.
- There is already a customer entitlement for a SKU from the same product family.
INVALID_VALUE: Make sure the OfferId is valid. If it is, contact Google Channel support for further troubleshooting.
NOT_FOUND: The customer or offer resource was not found.
ALREADY_EXISTS:
- The SKU was already purchased for the customer.
- The customer's primary email already exists. Retry after changing the customer's primary contact email.
CONDITION_NOT_MET or FAILED_PRECONDITION:
- The domain required for purchasing a SKU has not been verified.
- A pre-requisite SKU required to purchase an Add-On SKU is missing. For example, Google Workspace Business Starter is required to purchase Vault or Drive.
- (Developer accounts only) Reseller and resold domain must meet the following naming requirements:
  - Domain names must start with goog-test.
  - Domain names must include the reseller domain.
INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

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

Parameters
Name	Description
`request`	`google::cloud::channel::v1::CreateEntitlementRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.CreateEntitlementRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::channel::v1::Entitlement > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.channel.v1.Entitlement proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateEntitlement(ExperimentalTag, NoAwaitTag, google::cloud::channel::v1::CreateEntitlementRequest const &, Options)

Creates an entitlement for a customer.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`ExperimentalTag`
	`NoAwaitTag`
`request`	`google::cloud::channel::v1::CreateEntitlementRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

CreateEntitlement(ExperimentalTag, google::longrunning::Operation const &, Options)

Creates an entitlement for a customer.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
	`ExperimentalTag`
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::channel::v1::Entitlement > >`

ChangeParameters(google::cloud::channel::v1::ChangeParametersRequest const &, Options)

Change parameters of the entitlement.

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

Possible error codes:

PERMISSION_DENIED: The customer doesn't belong to the reseller.
INVALID_ARGUMENT: Required request parameters are missing or invalid. For example, the number of seats being changed is greater than the allowed number of max seats, 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. Contact Cloud Channel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

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

Parameters
Name	Description
`request`	`google::cloud::channel::v1::ChangeParametersRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.ChangeParametersRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::channel::v1::Entitlement > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.channel.v1.Entitlement proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ChangeParameters(ExperimentalTag, NoAwaitTag, google::cloud::channel::v1::ChangeParametersRequest const &, Options)

Change parameters of the entitlement.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`ExperimentalTag`
	`NoAwaitTag`
`request`	`google::cloud::channel::v1::ChangeParametersRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

ChangeParameters(ExperimentalTag, google::longrunning::Operation const &, Options)

Change parameters of the entitlement.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
	`ExperimentalTag`
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::channel::v1::Entitlement > >`

ChangeRenewalSettings(google::cloud::channel::v1::ChangeRenewalSettingsRequest const &, Options)

Updates the renewal settings for an existing customer entitlement.

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

Possible error codes:

PERMISSION_DENIED: The customer doesn't belong to the reseller.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: Entitlement resource not found.
NOT_COMMITMENT_PLAN: Renewal Settings are only applicable for a commitment plan. Can't enable or disable renewals for non-commitment plans.
INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

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

Parameters
Name	Description
`request`	`google::cloud::channel::v1::ChangeRenewalSettingsRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.ChangeRenewalSettingsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::channel::v1::Entitlement > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.channel.v1.Entitlement proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ChangeRenewalSettings(ExperimentalTag, NoAwaitTag, google::cloud::channel::v1::ChangeRenewalSettingsRequest const &, Options)

Updates the renewal settings for an existing customer entitlement.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`ExperimentalTag`
	`NoAwaitTag`
`request`	`google::cloud::channel::v1::ChangeRenewalSettingsRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

ChangeRenewalSettings(ExperimentalTag, google::longrunning::Operation const &, Options)

Updates the renewal settings for an existing customer entitlement.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
	`ExperimentalTag`
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::channel::v1::Entitlement > >`

ChangeOffer(google::cloud::channel::v1::ChangeOfferRequest const &, Options)

Updates the Offer for an existing customer entitlement.

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

Possible error codes:

PERMISSION_DENIED: The customer doesn't belong to the reseller.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: Offer or Entitlement resource not found.
INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

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

Parameters
Name	Description
`request`	`google::cloud::channel::v1::ChangeOfferRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.ChangeOfferRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::channel::v1::Entitlement > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.channel.v1.Entitlement proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ChangeOffer(ExperimentalTag, NoAwaitTag, google::cloud::channel::v1::ChangeOfferRequest const &, Options)

Updates the Offer for an existing customer entitlement.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`ExperimentalTag`
	`NoAwaitTag`
`request`	`google::cloud::channel::v1::ChangeOfferRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

ChangeOffer(ExperimentalTag, google::longrunning::Operation const &, Options)

Updates the Offer for an existing customer entitlement.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
	`ExperimentalTag`
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::channel::v1::Entitlement > >`

StartPaidService(google::cloud::channel::v1::StartPaidServiceRequest const &, Options)

Starts paid service for a trial entitlement.

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

Possible error codes:

PERMISSION_DENIED: The customer doesn't belong to the reseller.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
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. Contact Cloud Channel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

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

Parameters
Name	Description
`request`	`google::cloud::channel::v1::StartPaidServiceRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.StartPaidServiceRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::channel::v1::Entitlement > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.channel.v1.Entitlement proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

StartPaidService(ExperimentalTag, NoAwaitTag, google::cloud::channel::v1::StartPaidServiceRequest const &, Options)

Starts paid service for a trial entitlement.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`ExperimentalTag`
	`NoAwaitTag`
`request`	`google::cloud::channel::v1::StartPaidServiceRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

StartPaidService(ExperimentalTag, google::longrunning::Operation const &, Options)

Starts paid service for a trial entitlement.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
	`ExperimentalTag`
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::channel::v1::Entitlement > >`

SuspendEntitlement(google::cloud::channel::v1::SuspendEntitlementRequest const &, Options)

Suspends a previously fulfilled entitlement.

An entitlement suspension is a long-running operation.

Possible error codes:

PERMISSION_DENIED: The customer doesn't belong to the reseller.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
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. Contact Cloud Channel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

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

Parameters
Name	Description
`request`	`google::cloud::channel::v1::SuspendEntitlementRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.SuspendEntitlementRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::channel::v1::Entitlement > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.channel.v1.Entitlement proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

SuspendEntitlement(ExperimentalTag, NoAwaitTag, google::cloud::channel::v1::SuspendEntitlementRequest const &, Options)

Suspends a previously fulfilled entitlement.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`ExperimentalTag`
	`NoAwaitTag`
`request`	`google::cloud::channel::v1::SuspendEntitlementRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

SuspendEntitlement(ExperimentalTag, google::longrunning::Operation const &, Options)

Suspends a previously fulfilled entitlement.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
	`ExperimentalTag`
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::channel::v1::Entitlement > >`

CancelEntitlement(google::cloud::channel::v1::CancelEntitlementRequest const &, Options)

Cancels a previously fulfilled entitlement.

An entitlement cancellation is a long-running operation.

Possible error codes:

PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
FAILED_PRECONDITION: There are Google Cloud projects linked to the Google Cloud entitlement's Cloud Billing subaccount.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
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. Contact Cloud Channel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

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.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::CancelEntitlementRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.CancelEntitlementRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::channel::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.channel.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CancelEntitlement(ExperimentalTag, NoAwaitTag, google::cloud::channel::v1::CancelEntitlementRequest const &, Options)

Cancels a previously fulfilled entitlement.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`ExperimentalTag`
	`NoAwaitTag`
`request`	`google::cloud::channel::v1::CancelEntitlementRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

CancelEntitlement(ExperimentalTag, google::longrunning::Operation const &, Options)

Cancels a previously fulfilled entitlement.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
	`ExperimentalTag`
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::channel::v1::OperationMetadata > >`

ActivateEntitlement(google::cloud::channel::v1::ActivateEntitlementRequest const &, Options)

Activates a previously suspended entitlement.

Entitlements suspended for pending ToS acceptance can't be activated using this method.

An entitlement activation is a long-running operation and it updates the state of the customer entitlement.

Possible error codes:

PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: Entitlement resource not found.
SUSPENSION_NOT_RESELLER_INITIATED: Can only activate reseller-initiated suspensions and entitlements that have accepted the TOS.
NOT_SUSPENDED: Can only activate suspended entitlements not in an ACTIVE state.
INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

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

Parameters
Name	Description
`request`	`google::cloud::channel::v1::ActivateEntitlementRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.ActivateEntitlementRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::channel::v1::Entitlement > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.channel.v1.Entitlement proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ActivateEntitlement(ExperimentalTag, NoAwaitTag, google::cloud::channel::v1::ActivateEntitlementRequest const &, Options)

Activates a previously suspended entitlement.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`ExperimentalTag`
	`NoAwaitTag`
`request`	`google::cloud::channel::v1::ActivateEntitlementRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

ActivateEntitlement(ExperimentalTag, google::longrunning::Operation const &, Options)

Activates a previously suspended entitlement.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
	`ExperimentalTag`
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::channel::v1::Entitlement > >`

TransferEntitlements(google::cloud::channel::v1::TransferEntitlementsRequest const &, Options)

Transfers customer entitlements to new reseller.

Possible error codes:

PERMISSION_DENIED:
- The customer doesn't belong to the reseller.
- The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: The customer or offer resource was not found.
ALREADY_EXISTS: The SKU was already transferred for the customer.
CONDITION_NOT_MET or FAILED_PRECONDITION:
- The SKU requires domain verification to transfer, but the domain is not verified.
- An Add-On SKU (example, Vault or Drive) is missing the pre-requisite SKU (example, G Suite Basic).
- (Developer accounts only) Reseller and resold domain must meet the following naming requirements:
  - Domain names must start with goog-test.
  - Domain names must include the reseller domain.
- Specify all transferring entitlements.
INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

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

Parameters
Name	Description
`request`	`google::cloud::channel::v1::TransferEntitlementsRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.TransferEntitlementsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::channel::v1::TransferEntitlementsResponse > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.channel.v1.TransferEntitlementsResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

TransferEntitlements(ExperimentalTag, NoAwaitTag, google::cloud::channel::v1::TransferEntitlementsRequest const &, Options)

Transfers customer entitlements to new reseller.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`ExperimentalTag`
	`NoAwaitTag`
`request`	`google::cloud::channel::v1::TransferEntitlementsRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

TransferEntitlements(ExperimentalTag, google::longrunning::Operation const &, Options)

Transfers customer entitlements to new reseller.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
	`ExperimentalTag`
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::channel::v1::TransferEntitlementsResponse > >`

TransferEntitlementsToGoogle(google::cloud::channel::v1::TransferEntitlementsToGoogleRequest const &, Options)

Transfers customer entitlements from their current reseller to Google.

Possible error codes:

PERMISSION_DENIED: The customer doesn't belong to the reseller.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: The customer or offer resource was not found.
ALREADY_EXISTS: The SKU was already transferred for the customer.
CONDITION_NOT_MET or FAILED_PRECONDITION:
- The SKU requires domain verification to transfer, but the domain is not verified.
- An Add-On SKU (example, Vault or Drive) is missing the pre-requisite SKU (example, G Suite Basic).
- (Developer accounts only) Reseller and resold domain must meet the following naming requirements:
  - Domain names must start with goog-test.
  - Domain names must include the reseller domain.
INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The ID of a long-running operation.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::TransferEntitlementsToGoogleRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.TransferEntitlementsToGoogleRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

future< StatusOr< google::cloud::channel::v1::OperationMetadata > >

A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.channel.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

TransferEntitlementsToGoogle(ExperimentalTag, NoAwaitTag, google::cloud::channel::v1::TransferEntitlementsToGoogleRequest const &, Options)

Transfers customer entitlements from their current reseller to Google.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	`ExperimentalTag`
	`NoAwaitTag`
`request`	`google::cloud::channel::v1::TransferEntitlementsToGoogleRequest const &`
`opts`	`Options`

Returns
Type	Description
`StatusOr< google::longrunning::Operation >`

TransferEntitlementsToGoogle(ExperimentalTag, google::longrunning::Operation const &, Options)

Transfers customer entitlements from their current reseller to Google.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
	`ExperimentalTag`
`operation`	`google::longrunning::Operation const &`
`opts`	`Options`

Returns
Type	Description
`future< StatusOr< google::cloud::channel::v1::OperationMetadata > >`

ListChannelPartnerLinks(google::cloud::channel::v1::ListChannelPartnerLinksRequest, Options)

List ChannelPartnerLinks belonging to a distributor.

You must be a distributor to call this method.

Possible error codes:

PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
INVALID_ARGUMENT: Required request parameters are missing or invalid.

Return value: The list of the distributor account's ChannelPartnerLink resources.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::ListChannelPartnerLinksRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.ListChannelPartnerLinksRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::channel::v1::ChannelPartnerLink >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.channel.v1.ChannelPartnerLink, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetChannelPartnerLink(google::cloud::channel::v1::GetChannelPartnerLinkRequest const &, Options)

Returns the requested ChannelPartnerLink resource.

You must be a distributor to call this method.

Possible error codes:

PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: ChannelPartnerLink resource not found because of an invalid channel partner link name.

Return value: The ChannelPartnerLink resource.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::GetChannelPartnerLinkRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.GetChannelPartnerLinkRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::channel::v1::ChannelPartnerLink >`	the result of the RPC. The response message type (google.cloud.channel.v1.ChannelPartnerLink) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateChannelPartnerLink(google::cloud::channel::v1::CreateChannelPartnerLinkRequest const &, Options)

Initiates a channel partner link between a distributor and a reseller, or between resellers in an n-tier reseller channel.

Invited partners need to follow the invite_link_uri provided in the response to accept. After accepting the invitation, a link is set up between the two parties. You must be a distributor to call this method.

Possible error codes:

PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
ALREADY_EXISTS: The ChannelPartnerLink sent in the request already exists.
NOT_FOUND: No Cloud Identity customer exists for provided domain.
INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The new ChannelPartnerLink resource.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::CreateChannelPartnerLinkRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.CreateChannelPartnerLinkRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::channel::v1::ChannelPartnerLink >`	the result of the RPC. The response message type (google.cloud.channel.v1.ChannelPartnerLink) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateChannelPartnerLink(google::cloud::channel::v1::UpdateChannelPartnerLinkRequest const &, Options)

Updates a channel partner link.

Distributors call this method to change a link's status. For example, to suspend a partner link. You must be a distributor to call this method.

Possible error codes:

PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
INVALID_ARGUMENT:
- Required request parameters are missing or invalid.
- Link state cannot change from invited to active or suspended.
- Cannot send reseller_cloud_identity_id, invite_url, or name in update mask.
NOT_FOUND: ChannelPartnerLink resource not found.
INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The updated ChannelPartnerLink resource.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::UpdateChannelPartnerLinkRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.UpdateChannelPartnerLinkRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::channel::v1::ChannelPartnerLink >`	the result of the RPC. The response message type (google.cloud.channel.v1.ChannelPartnerLink) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetCustomerRepricingConfig(std::string const &, Options)

Gets information about how a Reseller modifies their bill before sending it to a Customer.

Possible Error Codes:

PERMISSION_DENIED: If the account making the request and the account being queried are different.
NOT_FOUND: The CustomerRepricingConfig was not found.
INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.

Return Value: If successful, the CustomerRepricingConfig resource, otherwise returns an error.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the CustomerRepricingConfig. Format: accounts/{account_id}/customers/{customer_id}/customerRepricingConfigs/{id}.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::channel::v1::CustomerRepricingConfig >`	the result of the RPC. The response message type (google.cloud.channel.v1.CustomerRepricingConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetCustomerRepricingConfig(google::cloud::channel::v1::GetCustomerRepricingConfigRequest const &, Options)

Gets information about how a Reseller modifies their bill before sending it to a Customer.

Possible Error Codes:

PERMISSION_DENIED: If the account making the request and the account being queried are different.
NOT_FOUND: The CustomerRepricingConfig was not found.
INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.

Return Value: If successful, the CustomerRepricingConfig resource, otherwise returns an error.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::GetCustomerRepricingConfigRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.GetCustomerRepricingConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::channel::v1::CustomerRepricingConfig >`	the result of the RPC. The response message type (google.cloud.channel.v1.CustomerRepricingConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListCustomerRepricingConfigs(std::string const &, Options)

Lists information about how a Reseller modifies their bill before sending it to a Customer.

Possible Error Codes:

PERMISSION_DENIED: If the account making the request and the account being queried are different.
NOT_FOUND: The CustomerRepricingConfig specified does not exist or is not associated with the given account.
INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.

Return Value: If successful, the CustomerRepricingConfig resources. The data for each resource is displayed in the ascending order of:

If unsuccessful, returns an error.

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the customer. Parent uses the format: accounts/{account_id}/customers/{customer_id}. Supports accounts/{account_id}/customers/- to retrieve configs for all customers.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::channel::v1::CustomerRepricingConfig >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.channel.v1.CustomerRepricingConfig, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListCustomerRepricingConfigs(google::cloud::channel::v1::ListCustomerRepricingConfigsRequest, Options)

Lists information about how a Reseller modifies their bill before sending it to a Customer.

Possible Error Codes:

PERMISSION_DENIED: If the account making the request and the account being queried are different.
NOT_FOUND: The CustomerRepricingConfig specified does not exist or is not associated with the given account.
INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.

Return Value: If successful, the CustomerRepricingConfig resources. The data for each resource is displayed in the ascending order of:

If unsuccessful, returns an error.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::ListCustomerRepricingConfigsRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.ListCustomerRepricingConfigsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::channel::v1::CustomerRepricingConfig >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.channel.v1.CustomerRepricingConfig, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

CreateCustomerRepricingConfig(std::string const &, google::cloud::channel::v1::CustomerRepricingConfig const &, Options)

Creates a CustomerRepricingConfig.

Call this method to set modifications for a specific customer's bill. You can only create configs if the RepricingConfig.effective_invoice_month is a future month. If needed, you can create a config for the current month, with some restrictions.

When creating a config for a future month, make sure there are no existing configs for that RepricingConfig.effective_invoice_month.

The following restrictions are for creating configs in the current month.

This functionality is reserved for recovering from an erroneous config, and should not be used for regular business cases.
The new config will not modify exports used with other configs. Changes to the config may be immediate, but may take up to 24 hours.
There is a limit of ten configs for any RepricingConfig.EntitlementGranularity.entitlement, for any RepricingConfig.effective_invoice_month.
The contained CustomerRepricingConfig.repricing_config value must be different from the value used in the current config for a RepricingConfig.EntitlementGranularity.entitlement.

Possible Error Codes:

PERMISSION_DENIED: If the account making the request and the account being queried are different.
INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.
NOT_FOUND: The CustomerRepricingConfig specified does not exist or is not associated with the given account.
INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.

Return Value: If successful, the updated CustomerRepricingConfig resource, otherwise returns an error.

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the customer that will receive this repricing config. Parent uses the format: accounts/{account_id}/customers/{customer_id}
`customer_repricing_config`	`google::cloud::channel::v1::CustomerRepricingConfig const &` Required. The CustomerRepricingConfig object to update.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::channel::v1::CustomerRepricingConfig >`	the result of the RPC. The response message type (google.cloud.channel.v1.CustomerRepricingConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateCustomerRepricingConfig(google::cloud::channel::v1::CreateCustomerRepricingConfigRequest const &, Options)

Creates a CustomerRepricingConfig.

When creating a config for a future month, make sure there are no existing configs for that RepricingConfig.effective_invoice_month.

The following restrictions are for creating configs in the current month.

This functionality is reserved for recovering from an erroneous config, and should not be used for regular business cases.
The new config will not modify exports used with other configs. Changes to the config may be immediate, but may take up to 24 hours.
There is a limit of ten configs for any RepricingConfig.EntitlementGranularity.entitlement, for any RepricingConfig.effective_invoice_month.
The contained CustomerRepricingConfig.repricing_config value must be different from the value used in the current config for a RepricingConfig.EntitlementGranularity.entitlement.

Possible Error Codes:

PERMISSION_DENIED: If the account making the request and the account being queried are different.
INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.
NOT_FOUND: The CustomerRepricingConfig specified does not exist or is not associated with the given account.
INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.

Return Value: If successful, the updated CustomerRepricingConfig resource, otherwise returns an error.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::CreateCustomerRepricingConfigRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.CreateCustomerRepricingConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::channel::v1::CustomerRepricingConfig >`	the result of the RPC. The response message type (google.cloud.channel.v1.CustomerRepricingConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateCustomerRepricingConfig(google::cloud::channel::v1::CustomerRepricingConfig const &, Options)

Updates a CustomerRepricingConfig.

Call this method to set modifications for a specific customer's bill. This method overwrites the existing CustomerRepricingConfig.

You can only update configs if the RepricingConfig.effective_invoice_month is a future month. To make changes to configs for the current month, use CreateCustomerRepricingConfig, taking note of its restrictions. You cannot update the RepricingConfig.effective_invoice_month.

When updating a config in the future:

This config must already exist.

Possible Error Codes:

PERMISSION_DENIED: If the account making the request and the account being queried are different.
INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.
NOT_FOUND: The CustomerRepricingConfig specified does not exist or is not associated with the given account.
INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.

Return Value: If successful, the updated CustomerRepricingConfig resource, otherwise returns an error.

Parameters
Name	Description
`customer_repricing_config`	`google::cloud::channel::v1::CustomerRepricingConfig const &` Required. The CustomerRepricingConfig object to update.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::channel::v1::CustomerRepricingConfig >`	the result of the RPC. The response message type (google.cloud.channel.v1.CustomerRepricingConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateCustomerRepricingConfig(google::cloud::channel::v1::UpdateCustomerRepricingConfigRequest const &, Options)

Updates a CustomerRepricingConfig.

Call this method to set modifications for a specific customer's bill. This method overwrites the existing CustomerRepricingConfig.

When updating a config in the future:

This config must already exist.

Possible Error Codes:

PERMISSION_DENIED: If the account making the request and the account being queried are different.
INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.
NOT_FOUND: The CustomerRepricingConfig specified does not exist or is not associated with the given account.
INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.

Return Value: If successful, the updated CustomerRepricingConfig resource, otherwise returns an error.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::UpdateCustomerRepricingConfigRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.UpdateCustomerRepricingConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::channel::v1::CustomerRepricingConfig >`	the result of the RPC. The response message type (google.cloud.channel.v1.CustomerRepricingConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteCustomerRepricingConfig(std::string const &, Options)

Deletes the given CustomerRepricingConfig permanently.

You can only delete configs if their RepricingConfig.effective_invoice_month is set to a date after the current month.

Possible error codes:

PERMISSION_DENIED: The account making the request does not own this customer.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
FAILED_PRECONDITION: The CustomerRepricingConfig is active or in the past.
NOT_FOUND: No CustomerRepricingConfig found for the name in the request.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the customer repricing config rule to delete. Format: accounts/{account_id}/customers/{customer_id}/customerRepricingConfigs/{id}.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

DeleteCustomerRepricingConfig(google::cloud::channel::v1::DeleteCustomerRepricingConfigRequest const &, Options)

Deletes the given CustomerRepricingConfig permanently.

You can only delete configs if their RepricingConfig.effective_invoice_month is set to a date after the current month.

Possible error codes:

PERMISSION_DENIED: The account making the request does not own this customer.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
FAILED_PRECONDITION: The CustomerRepricingConfig is active or in the past.
NOT_FOUND: No CustomerRepricingConfig found for the name in the request.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::DeleteCustomerRepricingConfigRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.DeleteCustomerRepricingConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

GetChannelPartnerRepricingConfig(std::string const &, Options)

Gets information about how a Distributor modifies their bill before sending it to a ChannelPartner.

Possible Error Codes:

PERMISSION_DENIED: If the account making the request and the account being queried are different.
NOT_FOUND: The ChannelPartnerRepricingConfig was not found.
INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.

Return Value: If successful, the ChannelPartnerRepricingConfig resource, otherwise returns an error.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the ChannelPartnerRepricingConfig Format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}/channelPartnerRepricingConfigs/{id}.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::channel::v1::ChannelPartnerRepricingConfig >`	the result of the RPC. The response message type (google.cloud.channel.v1.ChannelPartnerRepricingConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetChannelPartnerRepricingConfig(google::cloud::channel::v1::GetChannelPartnerRepricingConfigRequest const &, Options)

Gets information about how a Distributor modifies their bill before sending it to a ChannelPartner.

Possible Error Codes:

PERMISSION_DENIED: If the account making the request and the account being queried are different.
NOT_FOUND: The ChannelPartnerRepricingConfig was not found.
INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.

Return Value: If successful, the ChannelPartnerRepricingConfig resource, otherwise returns an error.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::GetChannelPartnerRepricingConfigRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.GetChannelPartnerRepricingConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::channel::v1::ChannelPartnerRepricingConfig >`	the result of the RPC. The response message type (google.cloud.channel.v1.ChannelPartnerRepricingConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListChannelPartnerRepricingConfigs(std::string const &, Options)

Lists information about how a Reseller modifies their bill before sending it to a ChannelPartner.

Possible Error Codes:

PERMISSION_DENIED: If the account making the request and the account being queried are different.
NOT_FOUND: The ChannelPartnerRepricingConfig specified does not exist or is not associated with the given account.
INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.

Return Value: If successful, the ChannelPartnerRepricingConfig resources. The data for each resource is displayed in the ascending order of:

Channel Partner ID
RepricingConfig.effective_invoice_month
ChannelPartnerRepricingConfig.update_time

If unsuccessful, returns an error.

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the account's ChannelPartnerLink. Parent uses the format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}. Supports accounts/{account_id}/channelPartnerLinks/- to retrieve configs for all channel partners.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::channel::v1::ChannelPartnerRepricingConfig >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.channel.v1.ChannelPartnerRepricingConfig, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListChannelPartnerRepricingConfigs(google::cloud::channel::v1::ListChannelPartnerRepricingConfigsRequest, Options)

Lists information about how a Reseller modifies their bill before sending it to a ChannelPartner.

Possible Error Codes:

PERMISSION_DENIED: If the account making the request and the account being queried are different.
NOT_FOUND: The ChannelPartnerRepricingConfig specified does not exist or is not associated with the given account.
INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.

Return Value: If successful, the ChannelPartnerRepricingConfig resources. The data for each resource is displayed in the ascending order of:

Channel Partner ID
RepricingConfig.effective_invoice_month
ChannelPartnerRepricingConfig.update_time

If unsuccessful, returns an error.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::ListChannelPartnerRepricingConfigsRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.ListChannelPartnerRepricingConfigsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::channel::v1::ChannelPartnerRepricingConfig >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.channel.v1.ChannelPartnerRepricingConfig, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

CreateChannelPartnerRepricingConfig(std::string const &, google::cloud::channel::v1::ChannelPartnerRepricingConfig const &, Options)

Creates a ChannelPartnerRepricingConfig.

Call this method to set modifications for a specific ChannelPartner's bill. You can only create configs if the RepricingConfig.effective_invoice_month is a future month. If needed, you can create a config for the current month, with some restrictions.

When creating a config for a future month, make sure there are no existing configs for that RepricingConfig.effective_invoice_month.

The following restrictions are for creating configs in the current month.

This functionality is reserved for recovering from an erroneous config, and should not be used for regular business cases.
The new config will not modify exports used with other configs. Changes to the config may be immediate, but may take up to 24 hours.
There is a limit of ten configs for any ChannelPartner or RepricingConfig.EntitlementGranularity.entitlement, for any RepricingConfig.effective_invoice_month.
The contained ChannelPartnerRepricingConfig.repricing_config value must be different from the value used in the current config for a ChannelPartner.

Possible Error Codes:

PERMISSION_DENIED: If the account making the request and the account being queried are different.
INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.
NOT_FOUND: The ChannelPartnerRepricingConfig specified does not exist or is not associated with the given account.
INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.

Return Value: If successful, the updated ChannelPartnerRepricingConfig resource, otherwise returns an error.

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the ChannelPartner that will receive the repricing config. Parent uses the format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}
`channel_partner_repricing_config`	`google::cloud::channel::v1::ChannelPartnerRepricingConfig const &` Required. The ChannelPartnerRepricingConfig object to update.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::channel::v1::ChannelPartnerRepricingConfig >`	the result of the RPC. The response message type (google.cloud.channel.v1.ChannelPartnerRepricingConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateChannelPartnerRepricingConfig(google::cloud::channel::v1::CreateChannelPartnerRepricingConfigRequest const &, Options)

Creates a ChannelPartnerRepricingConfig.

When creating a config for a future month, make sure there are no existing configs for that RepricingConfig.effective_invoice_month.

The following restrictions are for creating configs in the current month.

This functionality is reserved for recovering from an erroneous config, and should not be used for regular business cases.
The new config will not modify exports used with other configs. Changes to the config may be immediate, but may take up to 24 hours.
There is a limit of ten configs for any ChannelPartner or RepricingConfig.EntitlementGranularity.entitlement, for any RepricingConfig.effective_invoice_month.
The contained ChannelPartnerRepricingConfig.repricing_config value must be different from the value used in the current config for a ChannelPartner.

Possible Error Codes:

PERMISSION_DENIED: If the account making the request and the account being queried are different.
INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.
NOT_FOUND: The ChannelPartnerRepricingConfig specified does not exist or is not associated with the given account.
INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.

Return Value: If successful, the updated ChannelPartnerRepricingConfig resource, otherwise returns an error.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::CreateChannelPartnerRepricingConfigRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.CreateChannelPartnerRepricingConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::channel::v1::ChannelPartnerRepricingConfig >`	the result of the RPC. The response message type (google.cloud.channel.v1.ChannelPartnerRepricingConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateChannelPartnerRepricingConfig(google::cloud::channel::v1::ChannelPartnerRepricingConfig const &, Options)

Updates a ChannelPartnerRepricingConfig.

Call this method to set modifications for a specific ChannelPartner's bill. This method overwrites the existing CustomerRepricingConfig.

You can only update configs if the RepricingConfig.effective_invoice_month is a future month. To make changes to configs for the current month, use CreateChannelPartnerRepricingConfig, taking note of its restrictions. You cannot update the RepricingConfig.effective_invoice_month.

When updating a config in the future:

This config must already exist.

Possible Error Codes:

PERMISSION_DENIED: If the account making the request and the account being queried are different.
INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.
NOT_FOUND: The ChannelPartnerRepricingConfig specified does not exist or is not associated with the given account.
INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.

Return Value: If successful, the updated ChannelPartnerRepricingConfig resource, otherwise returns an error.

Parameters
Name	Description
`channel_partner_repricing_config`	`google::cloud::channel::v1::ChannelPartnerRepricingConfig const &` Required. The ChannelPartnerRepricingConfig object to update.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::channel::v1::ChannelPartnerRepricingConfig >`	the result of the RPC. The response message type (google.cloud.channel.v1.ChannelPartnerRepricingConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateChannelPartnerRepricingConfig(google::cloud::channel::v1::UpdateChannelPartnerRepricingConfigRequest const &, Options)

Updates a ChannelPartnerRepricingConfig.

Call this method to set modifications for a specific ChannelPartner's bill. This method overwrites the existing CustomerRepricingConfig.

When updating a config in the future:

This config must already exist.

Possible Error Codes:

PERMISSION_DENIED: If the account making the request and the account being queried are different.
INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.
NOT_FOUND: The ChannelPartnerRepricingConfig specified does not exist or is not associated with the given account.
INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.

Return Value: If successful, the updated ChannelPartnerRepricingConfig resource, otherwise returns an error.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::UpdateChannelPartnerRepricingConfigRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.UpdateChannelPartnerRepricingConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::channel::v1::ChannelPartnerRepricingConfig >`	the result of the RPC. The response message type (google.cloud.channel.v1.ChannelPartnerRepricingConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteChannelPartnerRepricingConfig(std::string const &, Options)

Deletes the given ChannelPartnerRepricingConfig permanently.

You can only delete configs if their RepricingConfig.effective_invoice_month is set to a date after the current month.

Possible error codes:

PERMISSION_DENIED: The account making the request does not own this customer.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
FAILED_PRECONDITION: The ChannelPartnerRepricingConfig is active or in the past.
NOT_FOUND: No ChannelPartnerRepricingConfig found for the name in the request.

Parameters
Name	Description
`name`	`std::string const &` Required. The resource name of the channel partner repricing config rule to delete.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

DeleteChannelPartnerRepricingConfig(google::cloud::channel::v1::DeleteChannelPartnerRepricingConfigRequest const &, Options)

Deletes the given ChannelPartnerRepricingConfig permanently.

You can only delete configs if their RepricingConfig.effective_invoice_month is set to a date after the current month.

Possible error codes:

PERMISSION_DENIED: The account making the request does not own this customer.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
FAILED_PRECONDITION: The ChannelPartnerRepricingConfig is active or in the past.
NOT_FOUND: No ChannelPartnerRepricingConfig found for the name in the request.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::DeleteChannelPartnerRepricingConfigRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.DeleteChannelPartnerRepricingConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

ListSkuGroups(std::string const &, Options)

Lists the Rebilling supported SKU groups the account is authorized to sell.

Reference: https://cloud.google.com/skus/sku-groups

Possible Error Codes:

PERMISSION_DENIED: If the account making the request and the account being queried are different, or the account doesn't exist.
INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.

Return Value: If successful, the SkuGroup resources. The data for each resource is displayed in the alphabetical order of SKU group display name. The data for each resource is displayed in the ascending order of SkuGroup.display_name

If unsuccessful, returns an error.

Parameters
Name	Description
`parent`	`std::string const &` Required. The resource name of the account from which to list SKU groups. Parent uses the format: accounts/{account}.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::channel::v1::SkuGroup >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.channel.v1.SkuGroup, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListSkuGroups(google::cloud::channel::v1::ListSkuGroupsRequest, Options)

Lists the Rebilling supported SKU groups the account is authorized to sell.

Reference: https://cloud.google.com/skus/sku-groups

Possible Error Codes:

PERMISSION_DENIED: If the account making the request and the account being queried are different, or the account doesn't exist.
INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.

If unsuccessful, returns an error.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::ListSkuGroupsRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.ListSkuGroupsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::channel::v1::SkuGroup >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.channel.v1.SkuGroup, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListSkuGroupBillableSkus(std::string const &, Options)

Lists the Billable SKUs in a given SKU group.

Possible error codes: PERMISSION_DENIED: If the account making the request and the account being queried for are different, or the account doesn't exist. INVALID_ARGUMENT: Missing or invalid required parameters in the request. INTERNAL: Any non-user error related to technical issue in the backend. In this case, contact cloud channel support.

Return Value: If successful, the BillableSku resources. The data for each resource is displayed in the ascending order of:

If unsuccessful, returns an error.

Parameters
Name	Description
`parent`	`std::string const &` Required. Resource name of the SKU group. Format: accounts/{account}/skuGroups/{sku_group}.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::channel::v1::BillableSku >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.channel.v1.BillableSku, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListSkuGroupBillableSkus(google::cloud::channel::v1::ListSkuGroupBillableSkusRequest, Options)

Lists the Billable SKUs in a given SKU group.

Return Value: If successful, the BillableSku resources. The data for each resource is displayed in the ascending order of:

If unsuccessful, returns an error.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::ListSkuGroupBillableSkusRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.ListSkuGroupBillableSkusRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::channel::v1::BillableSku >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.channel.v1.BillableSku, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

LookupOffer(google::cloud::channel::v1::LookupOfferRequest const &, Options)

Returns the requested Offer resource.

Possible error codes:

PERMISSION_DENIED: The entitlement doesn't belong to the reseller.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: Entitlement or offer was not found.

Return value: The Offer resource.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::LookupOfferRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.LookupOfferRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::channel::v1::Offer >`	the result of the RPC. The response message type (google.cloud.channel.v1.Offer) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListProducts(google::cloud::channel::v1::ListProductsRequest, Options)

Lists the Products the reseller is authorized to sell.

Possible error codes:

INVALID_ARGUMENT: Required request parameters are missing or invalid.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::ListProductsRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.ListProductsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::channel::v1::Product >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.channel.v1.Product, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListSkus(google::cloud::channel::v1::ListSkusRequest, Options)

Lists the SKUs for a product the reseller is authorized to sell.

Possible error codes:

INVALID_ARGUMENT: Required request parameters are missing or invalid.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::ListSkusRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.ListSkusRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::channel::v1::Sku >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.channel.v1.Sku, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListOffers(google::cloud::channel::v1::ListOffersRequest, Options)

Lists the Offers the reseller can sell.

Possible error codes:

INVALID_ARGUMENT: Required request parameters are missing or invalid.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::ListOffersRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.ListOffersRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::channel::v1::Offer >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.channel.v1.Offer, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListPurchasableSkus(google::cloud::channel::v1::ListPurchasableSkusRequest, Options)

Lists the following:

SKUs that you can purchase for a customer
SKUs that you can upgrade or downgrade for an entitlement.

Possible error codes:

PERMISSION_DENIED: The customer doesn't belong to the reseller.
INVALID_ARGUMENT: Required request parameters are missing or invalid.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::ListPurchasableSkusRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.ListPurchasableSkusRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::channel::v1::PurchasableSku >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.channel.v1.PurchasableSku, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListPurchasableOffers(google::cloud::channel::v1::ListPurchasableOffersRequest, Options)

Lists the following:

Offers that you can purchase for a customer.
Offers that you can change for an entitlement.

Possible error codes:

PERMISSION_DENIED:
- The customer doesn't belong to the reseller
- The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265
INVALID_ARGUMENT: Required request parameters are missing or invalid.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::ListPurchasableOffersRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.ListPurchasableOffersRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::channel::v1::PurchasableOffer >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.channel.v1.PurchasableOffer, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

QueryEligibleBillingAccounts(google::cloud::channel::v1::QueryEligibleBillingAccountsRequest const &, Options)

Lists the billing accounts that are eligible to purchase particular SKUs for a given customer.

Possible error codes:

PERMISSION_DENIED: The customer doesn't belong to the reseller.
INVALID_ARGUMENT: Required request parameters are missing or invalid.

Return value: Based on the provided list of SKUs, returns a list of SKU groups that must be purchased using the same billing account and the billing accounts eligible to purchase each SKU group.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::QueryEligibleBillingAccountsRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.QueryEligibleBillingAccountsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::channel::v1::QueryEligibleBillingAccountsResponse >`	the result of the RPC. The response message type (google.cloud.channel.v1.QueryEligibleBillingAccountsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

RegisterSubscriber(google::cloud::channel::v1::RegisterSubscriberRequest const &, Options)

Registers a service account with subscriber privileges on the Cloud Pub/Sub topic for this Channel Services account.

After you create a subscriber, you get the events through [SubscriberEvent][google.cloud.channel.v1.SubscriberEvent]

Possible error codes:

PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The topic name with the registered service email address.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::RegisterSubscriberRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.RegisterSubscriberRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::channel::v1::RegisterSubscriberResponse >`	the result of the RPC. The response message type (google.cloud.channel.v1.RegisterSubscriberResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UnregisterSubscriber(google::cloud::channel::v1::UnregisterSubscriberRequest const &, Options)

Unregisters a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account.

If there are no service accounts left with subscriber privileges, this deletes the topic. You can call ListSubscribers to check for these accounts.

Possible error codes:

PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: The topic resource doesn't exist.
INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: The topic name that unregistered the service email address. Returns a success response if the service email address wasn't registered with the topic.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::UnregisterSubscriberRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.UnregisterSubscriberRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::channel::v1::UnregisterSubscriberResponse >`	the result of the RPC. The response message type (google.cloud.channel.v1.UnregisterSubscriberResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

ListSubscribers(google::cloud::channel::v1::ListSubscribersRequest, Options)

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

Possible error codes:

PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin.
INVALID_ARGUMENT: Required request parameters are missing or invalid.
NOT_FOUND: The topic resource doesn't exist.
INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

Return value: A list of service email addresses.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::ListSubscribersRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.ListSubscribersRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< std::string >

ListEntitlementChanges(std::string const &, Options)

List entitlement history.

Possible error codes:

PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different.
INVALID_ARGUMENT: Missing or invalid required fields in the request.
NOT_FOUND: The parent resource doesn't exist. Usually the result of an invalid name parameter.
INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact CloudChannel 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 EntitlementChanges.

Parameters

Name Description

parent

std::string const &

Required. The resource name of the entitlement for which to list entitlement changes. The - wildcard may be used to match entitlements across a customer. Formats:

accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
accounts/{account_id}/customers/{customer_id}/entitlements/-

opts

Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::channel::v1::EntitlementChange >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.channel.v1.EntitlementChange, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListEntitlementChanges(google::cloud::channel::v1::ListEntitlementChangesRequest, Options)

List entitlement history.

Possible error codes:

PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different.
INVALID_ARGUMENT: Missing or invalid required fields in the request.
NOT_FOUND: The parent resource doesn't exist. Usually the result of an invalid name parameter.
INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact CloudChannel 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 EntitlementChanges.

Parameters
Name	Description
`request`	`google::cloud::channel::v1::ListEntitlementChangesRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.channel.v1.ListEntitlementChangesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::channel::v1::EntitlementChange >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.channel.v1.EntitlementChange, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.