Class CloudChannelServiceGrpc.CloudChannelServiceImplBase

public abstract static class CloudChannelServiceGrpc.CloudChannelServiceImplBase implements BindableService

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

  1. Resellers and distributors can manage a customer entity.
  2. Distributors can register an authorized reseller in their channel and provide them with delegated admin access.
  3. Resellers and distributors can manage customer entitlements. CloudChannelService exposes the following resources:
  4. Customers: An entity\u2014usually an enterprise\u2014managed by a reseller or distributor.
  5. 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.
  6. ChannelPartnerLinks: An entity that identifies links between distributors and their indirect resellers in a channel.

Inheritance

java.lang.Object > CloudChannelServiceGrpc.CloudChannelServiceImplBase

Implements

io.grpc.BindableService

Constructors

CloudChannelServiceImplBase()

public CloudChannelServiceImplBase()

Methods

activateEntitlement(ActivateEntitlementRequest request, StreamObserver<Operation> responseObserver)

public void activateEntitlement(ActivateEntitlementRequest request, StreamObserver<Operation> responseObserver)

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
NameDescription
requestActivateEntitlementRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

bindService()

public final ServerServiceDefinition bindService()
Returns
TypeDescription
io.grpc.ServerServiceDefinition

cancelEntitlement(CancelEntitlementRequest request, StreamObserver<Operation> responseObserver)

public void cancelEntitlement(CancelEntitlementRequest request, StreamObserver<Operation> responseObserver)

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
NameDescription
requestCancelEntitlementRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

changeOffer(ChangeOfferRequest request, StreamObserver<Operation> responseObserver)

public void changeOffer(ChangeOfferRequest request, StreamObserver<Operation> responseObserver)

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
NameDescription
requestChangeOfferRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

changeParameters(ChangeParametersRequest request, StreamObserver<Operation> responseObserver)

public void changeParameters(ChangeParametersRequest request, StreamObserver<Operation> responseObserver)

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
NameDescription
requestChangeParametersRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

changeRenewalSettings(ChangeRenewalSettingsRequest request, StreamObserver<Operation> responseObserver)

public void changeRenewalSettings(ChangeRenewalSettingsRequest request, StreamObserver<Operation> responseObserver)

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
NameDescription
requestChangeRenewalSettingsRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

checkCloudIdentityAccountsExist(CheckCloudIdentityAccountsExistRequest request, StreamObserver<CheckCloudIdentityAccountsExistResponse> responseObserver)

public void checkCloudIdentityAccountsExist(CheckCloudIdentityAccountsExistRequest request, StreamObserver<CheckCloudIdentityAccountsExistResponse> responseObserver)

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
NameDescription
requestCheckCloudIdentityAccountsExistRequest
responseObserverio.grpc.stub.StreamObserver<CheckCloudIdentityAccountsExistResponse>
public void createChannelPartnerLink(CreateChannelPartnerLinkRequest request, StreamObserver<ChannelPartnerLink> responseObserver)

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
NameDescription
requestCreateChannelPartnerLinkRequest
responseObserverio.grpc.stub.StreamObserver<ChannelPartnerLink>

createCustomer(CreateCustomerRequest request, StreamObserver<Customer> responseObserver)

public void createCustomer(CreateCustomerRequest request, StreamObserver<Customer> responseObserver)

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.
  • 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
NameDescription
requestCreateCustomerRequest
responseObserverio.grpc.stub.StreamObserver<Customer>

createEntitlement(CreateEntitlementRequest request, StreamObserver<Operation> responseObserver)

public void createEntitlement(CreateEntitlementRequest request, StreamObserver<Operation> responseObserver)

Creates an entitlement for a customer. Possible error codes:

  • PERMISSION_DENIED: The customer doesn't belong to the reseller.
  • 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
NameDescription
requestCreateEntitlementRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

deleteCustomer(DeleteCustomerRequest request, StreamObserver<Empty> responseObserver)

public void deleteCustomer(DeleteCustomerRequest request, StreamObserver<Empty> responseObserver)

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
NameDescription
requestDeleteCustomerRequest
responseObserverio.grpc.stub.StreamObserver<Empty>
public void getChannelPartnerLink(GetChannelPartnerLinkRequest request, StreamObserver<ChannelPartnerLink> responseObserver)

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
NameDescription
requestGetChannelPartnerLinkRequest
responseObserverio.grpc.stub.StreamObserver<ChannelPartnerLink>

getCustomer(GetCustomerRequest request, StreamObserver<Customer> responseObserver)

public void getCustomer(GetCustomerRequest request, StreamObserver<Customer> responseObserver)

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
NameDescription
requestGetCustomerRequest
responseObserverio.grpc.stub.StreamObserver<Customer>

getEntitlement(GetEntitlementRequest request, StreamObserver<Entitlement> responseObserver)

public void getEntitlement(GetEntitlementRequest request, StreamObserver<Entitlement> responseObserver)

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
NameDescription
requestGetEntitlementRequest
responseObserverio.grpc.stub.StreamObserver<Entitlement>

importCustomer(ImportCustomerRequest request, StreamObserver<Customer> responseObserver)

public void importCustomer(ImportCustomerRequest request, StreamObserver<Customer> responseObserver)

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.
  • 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
NameDescription
requestImportCustomerRequest
responseObserverio.grpc.stub.StreamObserver<Customer>
public void listChannelPartnerLinks(ListChannelPartnerLinksRequest request, StreamObserver<ListChannelPartnerLinksResponse> responseObserver)

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
NameDescription
requestListChannelPartnerLinksRequest
responseObserverio.grpc.stub.StreamObserver<ListChannelPartnerLinksResponse>

listCustomers(ListCustomersRequest request, StreamObserver<ListCustomersResponse> responseObserver)

public void listCustomers(ListCustomersRequest request, StreamObserver<ListCustomersResponse> responseObserver)

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
NameDescription
requestListCustomersRequest
responseObserverio.grpc.stub.StreamObserver<ListCustomersResponse>

listEntitlements(ListEntitlementsRequest request, StreamObserver<ListEntitlementsResponse> responseObserver)

public void listEntitlements(ListEntitlementsRequest request, StreamObserver<ListEntitlementsResponse> responseObserver)

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
NameDescription
requestListEntitlementsRequest
responseObserverio.grpc.stub.StreamObserver<ListEntitlementsResponse>

listOffers(ListOffersRequest request, StreamObserver<ListOffersResponse> responseObserver)

public void listOffers(ListOffersRequest request, StreamObserver<ListOffersResponse> responseObserver)

Lists the Offers the reseller can sell. Possible error codes:

  • INVALID_ARGUMENT: Required request parameters are missing or invalid.
Parameters
NameDescription
requestListOffersRequest
responseObserverio.grpc.stub.StreamObserver<ListOffersResponse>

listProducts(ListProductsRequest request, StreamObserver<ListProductsResponse> responseObserver)

public void listProducts(ListProductsRequest request, StreamObserver<ListProductsResponse> responseObserver)

Lists the Products the reseller is authorized to sell. Possible error codes:

  • INVALID_ARGUMENT: Required request parameters are missing or invalid.
Parameters
NameDescription
requestListProductsRequest
responseObserverio.grpc.stub.StreamObserver<ListProductsResponse>

listPurchasableOffers(ListPurchasableOffersRequest request, StreamObserver<ListPurchasableOffersResponse> responseObserver)

public void listPurchasableOffers(ListPurchasableOffersRequest request, StreamObserver<ListPurchasableOffersResponse> responseObserver)

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
  • INVALID_ARGUMENT: Required request parameters are missing or invalid.
Parameters
NameDescription
requestListPurchasableOffersRequest
responseObserverio.grpc.stub.StreamObserver<ListPurchasableOffersResponse>

listPurchasableSkus(ListPurchasableSkusRequest request, StreamObserver<ListPurchasableSkusResponse> responseObserver)

public void listPurchasableSkus(ListPurchasableSkusRequest request, StreamObserver<ListPurchasableSkusResponse> responseObserver)

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
NameDescription
requestListPurchasableSkusRequest
responseObserverio.grpc.stub.StreamObserver<ListPurchasableSkusResponse>

listSkus(ListSkusRequest request, StreamObserver<ListSkusResponse> responseObserver)

public void listSkus(ListSkusRequest request, StreamObserver<ListSkusResponse> responseObserver)

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
NameDescription
requestListSkusRequest
responseObserverio.grpc.stub.StreamObserver<ListSkusResponse>

listSubscribers(ListSubscribersRequest request, StreamObserver<ListSubscribersResponse> responseObserver)

public void listSubscribers(ListSubscribersRequest request, StreamObserver<ListSubscribersResponse> responseObserver)

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
NameDescription
requestListSubscribersRequest
responseObserverio.grpc.stub.StreamObserver<ListSubscribersResponse>

listTransferableOffers(ListTransferableOffersRequest request, StreamObserver<ListTransferableOffersResponse> responseObserver)

public void listTransferableOffers(ListTransferableOffersRequest request, StreamObserver<ListTransferableOffersResponse> responseObserver)

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 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: List of TransferableOffer for the given customer and SKU.
Parameters
NameDescription
requestListTransferableOffersRequest
responseObserverio.grpc.stub.StreamObserver<ListTransferableOffersResponse>

listTransferableSkus(ListTransferableSkusRequest request, StreamObserver<ListTransferableSkusResponse> responseObserver)

public void listTransferableSkus(ListTransferableSkusRequest request, StreamObserver<ListTransferableSkusResponse> responseObserver)

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
NameDescription
requestListTransferableSkusRequest
responseObserverio.grpc.stub.StreamObserver<ListTransferableSkusResponse>

lookupOffer(LookupOfferRequest request, StreamObserver<Offer> responseObserver)

public void lookupOffer(LookupOfferRequest request, StreamObserver<Offer> responseObserver)

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
NameDescription
requestLookupOfferRequest
responseObserverio.grpc.stub.StreamObserver<Offer>

provisionCloudIdentity(ProvisionCloudIdentityRequest request, StreamObserver<Operation> responseObserver)

public void provisionCloudIdentity(ProvisionCloudIdentityRequest request, StreamObserver<Operation> responseObserver)

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.
  • 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
NameDescription
requestProvisionCloudIdentityRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

registerSubscriber(RegisterSubscriberRequest request, StreamObserver<RegisterSubscriberResponse> responseObserver)

public void registerSubscriber(RegisterSubscriberRequest request, StreamObserver<RegisterSubscriberResponse> responseObserver)

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 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
NameDescription
requestRegisterSubscriberRequest
responseObserverio.grpc.stub.StreamObserver<RegisterSubscriberResponse>

startPaidService(StartPaidServiceRequest request, StreamObserver<Operation> responseObserver)

public void startPaidService(StartPaidServiceRequest request, StreamObserver<Operation> responseObserver)

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
NameDescription
requestStartPaidServiceRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

suspendEntitlement(SuspendEntitlementRequest request, StreamObserver<Operation> responseObserver)

public void suspendEntitlement(SuspendEntitlementRequest request, StreamObserver<Operation> responseObserver)

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
NameDescription
requestSuspendEntitlementRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

transferEntitlements(TransferEntitlementsRequest request, StreamObserver<Operation> responseObserver)

public void transferEntitlements(TransferEntitlementsRequest request, StreamObserver<Operation> responseObserver)

Transfers customer entitlements to new reseller. 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.
    • 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
NameDescription
requestTransferEntitlementsRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

transferEntitlementsToGoogle(TransferEntitlementsToGoogleRequest request, StreamObserver<Operation> responseObserver)

public void transferEntitlementsToGoogle(TransferEntitlementsToGoogleRequest request, StreamObserver<Operation> responseObserver)

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. 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
NameDescription
requestTransferEntitlementsToGoogleRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

unregisterSubscriber(UnregisterSubscriberRequest request, StreamObserver<UnregisterSubscriberResponse> responseObserver)

public void unregisterSubscriber(UnregisterSubscriberRequest request, StreamObserver<UnregisterSubscriberResponse> responseObserver)

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
NameDescription
requestUnregisterSubscriberRequest
responseObserverio.grpc.stub.StreamObserver<UnregisterSubscriberResponse>
public void updateChannelPartnerLink(UpdateChannelPartnerLinkRequest request, StreamObserver<ChannelPartnerLink> responseObserver)

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
NameDescription
requestUpdateChannelPartnerLinkRequest
responseObserverio.grpc.stub.StreamObserver<ChannelPartnerLink>

updateCustomer(UpdateCustomerRequest request, StreamObserver<Customer> responseObserver)

public void updateCustomer(UpdateCustomerRequest request, StreamObserver<Customer> responseObserver)

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
NameDescription
requestUpdateCustomerRequest
responseObserverio.grpc.stub.StreamObserver<Customer>