CloudChannelServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.channel_v1.services.cloud_channel_service.transports.base.CloudChannelServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)CloudChannelService enables Google cloud resellers and distributors to manage their customers, channel partners, entitlements and reports.
Using this service:
- Resellers or distributors can manage a customer entity.
- Distributors can register an authorized reseller in their channel and then enable delegated admin access for the reseller.
- Resellers or distributors can manage entitlements for their customers.
The service primarily exposes the following resources:
Customers: A Customer represents an entity managed by a reseller or distributor. A customer typically represents an enterprise. In an n-tier resale channel hierarchy, customers are generally represented as leaf nodes. Customers primarily have an Entitlement sub-resource discussed below.
Entitlements: An Entitlement represents an entity which provides a customer means to start using a service. Entitlements are created or updated as a result of a successful fulfillment.
ChannelPartnerLinks: A ChannelPartnerLink is an entity that identifies links between distributors and their indirect resellers in a channel.
Properties
transport
Return the transport used by the client instance.
| Type | Description |
CloudChannelServiceTransport | The transport used by the client instance. |
Methods
CloudChannelServiceClient
CloudChannelServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.channel_v1.services.cloud_channel_service.transports.base.CloudChannelServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)Instantiate the cloud channel service client.
| Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str, CloudChannelServiceTransport]
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. It won't take effect if a |
client_info |
google.api_core.gapic_v1.client_info.ClientInfo
The client info used to send a user-agent string along with API requests. If |
| Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
activate_entitlement
activate_entitlement(request: Optional[google.cloud.channel_v1.types.service.ActivateEntitlementRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Activates a previously suspended entitlement. The entitlement must be in a suspended state for it to be activated. Entitlements suspended for pending ToS acceptance can't be activated using this method. An entitlement activation is a long-running operation and can result in updates to the state of the customer entitlement.
Possible Error Codes:
- PERMISSION_DENIED: If the customer doesn't belong to the reseller or if the reseller account making the request and reseller account being queried for are different.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request.
- NOT_FOUND: Entitlement resource not found.
- SUSPENSION_NOT_RESELLER_INITIATED: Can't activate an entitlement that is pending TOS acceptance. Only reseller initiated suspensions can be activated.
- NOT_SUSPENDED: Can't activate entitlements that are already in ACTIVE state. Can only activate suspended entitlements.
- INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
Return Value: Long Running Operation ID.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of xref_OperationMetadata.
| Name | Description |
request |
google.cloud.channel_v1.types.ActivateEntitlementRequest
The request object. Request message for CloudChannelService.ActivateEntitlement. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be Entitlement An entitlement is a representation of a customer's ability to use a service. |
cancel_entitlement
cancel_entitlement(request: Optional[google.cloud.channel_v1.types.service.CancelEntitlementRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Cancels a previously fulfilled entitlement. An entitlement cancellation is a long-running operation.
Possible Error Codes:
- PERMISSION_DENIED: If the customer doesn't belong to the reseller or if the reseller account making the request and reseller account being queried for are different.
- FAILED_PRECONDITION: If there are any Google Cloud projects linked to the Google Cloud entitlement's Cloud Billing subaccount.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request.
- NOT_FOUND: Entitlement resource not found.
- DELETION_TYPE_NOT_ALLOWED: Cancel is only allowed for Google Workspace add-ons or entitlements for Google Cloud's development platform.
- INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
Return Value: Long Running Operation ID.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The response will contain google.protobuf.Empty on success. The Operation metadata will contain an instance of xref_OperationMetadata.
| Name | Description |
request |
google.cloud.channel_v1.types.CancelEntitlementRequest
The request object. Request message for CloudChannelService.CancelEntitlement. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}. |
change_offer
change_offer(request: Optional[google.cloud.channel_v1.types.service.ChangeOfferRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Updates the Offer for an existing customer entitlement.
An entitlement update is a long-running operation and results in updates to the entitlement as a result of fulfillment.
Possible Error Codes:
- PERMISSION_DENIED: If the customer doesn't belong to the reseller.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request.
- NOT_FOUND: Offer or Entitlement resource not found.
- INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
Return Value: Long Running Operation ID.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of xref_OperationMetadata.
| Name | Description |
request |
google.cloud.channel_v1.types.ChangeOfferRequest
The request object. Request message for CloudChannelService.ChangeOffer. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be Entitlement An entitlement is a representation of a customer's ability to use a service. |
change_parameters
change_parameters(request: Optional[google.cloud.channel_v1.types.service.ChangeParametersRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Change parameters of the entitlement
An entitlement parameters update is a long-running operation and results in updates to the entitlement as a result of fulfillment.
Possible Error Codes:
- PERMISSION_DENIED: If the customer doesn't belong to the reseller.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request. For example, if the number of seats being changed to is greater than the allowed number of max seats for the resource. Or decreasing seats for a commitment based plan.
- NOT_FOUND: Entitlement resource not found.
- INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
Return Value: Long Running Operation ID.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of xref_OperationMetadata.
| Name | Description |
request |
google.cloud.channel_v1.types.ChangeParametersRequest
The request object. Request message for [CloudChannelService.ChangeParametersRequest][]. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be Entitlement An entitlement is a representation of a customer's ability to use a service. |
change_renewal_settings
change_renewal_settings(request: Optional[google.cloud.channel_v1.types.service.ChangeRenewalSettingsRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Updates the renewal settings for an existing customer entitlement.
An entitlement update is a long-running operation and results in updates to the entitlement as a result of fulfillment.
Possible Error Codes:
- PERMISSION_DENIED: If the customer doesn't belong to the reseller.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request.
- NOT_FOUND: Entitlement resource not found.
- NOT_COMMITMENT_PLAN: Renewal Settings are only applicable for a commitment plan. Can't enable or disable renewal for non-commitment plans.
- INTERNAL: Any non user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
- UNKNOWN: Any non user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
Return Value: Long Running Operation ID.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of xref_OperationMetadata.
| Name | Description |
request |
google.cloud.channel_v1.types.ChangeRenewalSettingsRequest
The request object. Request message for CloudChannelService.ChangeRenewalSettings. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be Entitlement An entitlement is a representation of a customer's ability to use a service. |
check_cloud_identity_accounts_exist
check_cloud_identity_accounts_exist(request: Optional[google.cloud.channel_v1.types.service.CheckCloudIdentityAccountsExistRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Confirms the existence of Cloud Identity accounts, based on the domain and whether the Cloud Identity accounts are owned by the reseller.
Possible Error Codes:
- PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request.
- INVALID_VALUE: Invalid domain value in the request.
Return Value: List of xref_CloudIdentityCustomerAccount resources for the domain. List may be empty.
Note: in the v1alpha1 version of the API, a NOT_FOUND error is returned if no xref_CloudIdentityCustomerAccount resources match the domain.
| Name | Description |
request |
google.cloud.channel_v1.types.CheckCloudIdentityAccountsExistRequest
The request object. Request message for CloudChannelService.CheckCloudIdentityAccountsExist. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.types.CheckCloudIdentityAccountsExistResponse | Response message for CloudChannelService.CheckCloudIdentityAccountsExist. |
common_billing_account_path
common_billing_account_path(billing_account: str)Return a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)Return a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)Return a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)Return a fully-qualified organization string.
common_project_path
common_project_path(project: str)Return a fully-qualified project string.
create_channel_partner_link
create_channel_partner_link(request: Optional[google.cloud.channel_v1.types.service.CreateChannelPartnerLinkRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Initiates a channel partner link between a distributor and a reseller or between resellers in an n-tier reseller channel. To accept the invite, the invited partner should follow the invite_link_uri provided in the response. If the link creation is accepted, a valid link is set up between the two involved parties. To call this method, you must be a distributor.
Possible Error Codes:
- PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request.
- ALREADY_EXISTS: If the ChannelPartnerLink sent in the request already exists.
- NOT_FOUND: If no Cloud Identity customer exists for domain provided.
- INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
Return Value: Newly created xref_ChannelPartnerLink resource if successful, otherwise error is returned.
| Name | Description |
request |
google.cloud.channel_v1.types.CreateChannelPartnerLinkRequest
The request object. Request message for CloudChannelService.CreateChannelPartnerLink |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.types.ChannelPartnerLink | Entity representing a link between distributors and their indirect resellers in an n-tier resale channel. |
create_customer
create_customer(request: Optional[google.cloud.channel_v1.types.service.CreateCustomerRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Creates a new xref_Customer resource under the reseller or distributor account.
Possible Error Codes:
- PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
INVALID_ARGUMENT: It can happen in following scenarios -
- Missing or invalid required parameters in the request.
- Domain field value doesn't match the domain specified in primary email.
Return Value: If successful, the newly created xref_Customer resource, otherwise returns an error.
| Name | Description |
request |
google.cloud.channel_v1.types.CreateCustomerRequest
The request object. Request message for CloudChannelService.CreateCustomer |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.types.Customer | Entity representing a customer of a reseller or distributor. |
create_entitlement
create_entitlement(request: Optional[google.cloud.channel_v1.types.service.CreateEntitlementRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Creates an entitlement for a customer.
Possible Error Codes:
- PERMISSION_DENIED: If the customer doesn't belong to the reseller.
INVALID_ARGUMENT: It can happen in below scenarios -
- Missing or invalid required parameters in the request.
- Cannot purchase an entitlement if there is already an entitlement for customer, for a SKU from the same product family.
- INVALID_VALUE: Offer passed in isn't valid. Make sure OfferId is valid. If it is valid, then contact Google Channel support for further troubleshooting.
NOT_FOUND: If the customer or offer resource is not found for the reseller.
ALREADY_EXISTS: This failure can happen in the following cases:
- If the SKU has been already purchased for the customer.
- If the customer's primary email already exists. In this case retry after changing the customer's primary contact email.
CONDITION_NOT_MET or FAILED_PRECONDITION: This failure can happen in the following cases:
- Purchasing a SKU that requires domain verification and the domain has not been verified.
- Purchasing an Add-On SKU like Vault or Drive without purchasing the pre-requisite SKU, such as Google Workspace Business Starter.
Applicable only for developer accounts: reseller and resold domain. Must meet the following domain naming requirements:
- Domain names must start with goog-test.
- Resold domain names must include the reseller domain.
INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel Support in this case.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel Support in this case.
Return Value: Long Running Operation ID.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of xref_OperationMetadata.
| Name | Description |
request |
google.cloud.channel_v1.types.CreateEntitlementRequest
The request object. Request message for CloudChannelService.CreateEntitlement |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be Entitlement An entitlement is a representation of a customer's ability to use a service. |
customer_path
customer_path(account: str, customer: str)Return a fully-qualified customer string.
delete_customer
delete_customer(request: Optional[google.cloud.channel_v1.types.service.DeleteCustomerRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Deletes the given xref_Customer permanently and irreversibly.
Possible Error Codes:
- PERMISSION_DENIED: If the account making the request does not own this customer.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request.
- FAILED_PRECONDITION: If the customer has existing entitlements.
- NOT_FOUND: No xref_Customer resource found for the name specified in the request.
| Name | Description |
request |
google.cloud.channel_v1.types.DeleteCustomerRequest
The request object. Request message for CloudChannelService.DeleteCustomer. |
name |
str
Required. The resource name of the customer to delete. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
entitlement_path
entitlement_path(account: str, customer: str, entitlement: str)Return a fully-qualified entitlement string.
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Type | Description |
CloudChannelServiceClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)Creates an instance of this client using the provided credentials info.
| Name | Description |
info |
dict
The service account private key info. |
| Type | Description |
CloudChannelServiceClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Type | Description |
CloudChannelServiceClient | The constructed client. |
get_channel_partner_link
get_channel_partner_link(request: Optional[google.cloud.channel_v1.types.service.GetChannelPartnerLinkRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Returns a requested xref_ChannelPartnerLink resource. To call this method, you must be a distributor.
Possible Error Codes:
- PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request.
- NOT_FOUND: ChannelPartnerLink resource not found. Results due invalid channel partner link name.
Return Value: xref_ChannelPartnerLink resource if found, otherwise returns an error.
| Name | Description |
request |
google.cloud.channel_v1.types.GetChannelPartnerLinkRequest
The request object. Request message for CloudChannelService.GetChannelPartnerLink. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.types.ChannelPartnerLink | Entity representing a link between distributors and their indirect resellers in an n-tier resale channel. |
get_customer
get_customer(request: Optional[google.cloud.channel_v1.types.service.GetCustomerRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Returns a requested xref_Customer resource.
Possible Error Codes:
- PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request.
- NOT_FOUND: If the customer resource doesn't exist. Usually the result of an invalid name parameter.
Return Value: xref_Customer resource if found, error otherwise.
| Name | Description |
request |
google.cloud.channel_v1.types.GetCustomerRequest
The request object. Request message for CloudChannelService.GetCustomer. |
name |
str
Required. The resource name of the customer to retrieve. The name takes the format: accounts/{account_id}/customers/{customer_id} This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.types.Customer | Entity representing a customer of a reseller or distributor. |
get_entitlement
get_entitlement(request: Optional[google.cloud.channel_v1.types.service.GetEntitlementRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Returns a requested xref_Entitlement resource.
Possible Error Codes:
- PERMISSION_DENIED: If the customer doesn't belong to the reseller.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request.
- NOT_FOUND: If the entitlement is not found for the customer.
Return Value: If found, the requested xref_Entitlement resource, otherwise returns an error.
| Name | Description |
request |
google.cloud.channel_v1.types.GetEntitlementRequest
The request object. Request message for CloudChannelService.GetEntitlement. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.types.Entitlement | An entitlement is a representation of a customer's ability to use a service. |
list_channel_partner_links
list_channel_partner_links(request: Optional[google.cloud.channel_v1.types.service.ListChannelPartnerLinksRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())List xref_ChannelPartnerLinks belonging to a distributor. To call this method, you must be a distributor.
Possible Error Codes:
- PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request.
Return Value: If successful, returns the list of xref_ChannelPartnerLink resources for the distributor account, otherwise returns an error.
| Name | Description |
request |
google.cloud.channel_v1.types.ListChannelPartnerLinksRequest
The request object. Request message for CloudChannelService.ListChannelPartnerLinks |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.services.cloud_channel_service.pagers.ListChannelPartnerLinksPager | Response message for CloudChannelService.ListChannelPartnerLinks. Iterating over this object will yield results and resolve additional pages automatically. |
list_customers
list_customers(request: Optional[google.cloud.channel_v1.types.service.ListCustomersRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())List downstream xref_Customers.
Possible Error Codes:
- PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request.
Return Value: List of xref_Customers pertaining to the reseller or empty list if there are none.
| Name | Description |
request |
google.cloud.channel_v1.types.ListCustomersRequest
The request object. Request message for CloudChannelService.ListCustomers |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.services.cloud_channel_service.pagers.ListCustomersPager | Response message for CloudChannelService.ListCustomers. Iterating over this object will yield results and resolve additional pages automatically. |
list_entitlements
list_entitlements(request: Optional[google.cloud.channel_v1.types.service.ListEntitlementsRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())List xref_Entitlements belonging to a customer.
Possible Error Codes:
- PERMISSION_DENIED: If the customer doesn't belong to the reseller.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request.
Return Value: List of xref_Entitlements belonging to the customer, or empty list if there are none.
| Name | Description |
request |
google.cloud.channel_v1.types.ListEntitlementsRequest
The request object. Request message for CloudChannelService.ListEntitlements |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.services.cloud_channel_service.pagers.ListEntitlementsPager | Response message for CloudChannelService.ListEntitlements. Iterating over this object will yield results and resolve additional pages automatically. |
list_offers
list_offers(request: Optional[google.cloud.channel_v1.types.service.ListOffersRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists the Offers the reseller can sell.
Possible Error Codes:
- INVALID_ARGUMENT: Missing or invalid required parameters in the request.
| Name | Description |
request |
google.cloud.channel_v1.types.ListOffersRequest
The request object. Request message for ListOffers. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.services.cloud_channel_service.pagers.ListOffersPager | Response message for ListOffers. Iterating over this object will yield results and resolve additional pages automatically. |
list_products
list_products(request: Optional[google.cloud.channel_v1.types.service.ListProductsRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists the Products the reseller is authorized to sell.
Possible Error Codes:
- INVALID_ARGUMENT: Missing or invalid required parameters in the request.
| Name | Description |
request |
google.cloud.channel_v1.types.ListProductsRequest
The request object. Request message for ListProducts. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.services.cloud_channel_service.pagers.ListProductsPager | Response message for ListProducts. Iterating over this object will yield results and resolve additional pages automatically. |
list_purchasable_offers
list_purchasable_offers(request: Optional[google.cloud.channel_v1.types.service.ListPurchasableOffersRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists the Purchasable Offers for the following cases:
- Offers that can be newly purchased for a customer
- Offers that can be changed to, for an entitlement.
Possible Error Codes:
- PERMISSION_DENIED: If the customer doesn't belong to the reseller
- INVALID_ARGUMENT: Missing or invalid required parameters in the request.
| Name | Description |
request |
google.cloud.channel_v1.types.ListPurchasableOffersRequest
The request object. Request message for ListPurchasableOffers. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.services.cloud_channel_service.pagers.ListPurchasableOffersPager | Response message for ListPurchasableOffers. Iterating over this object will yield results and resolve additional pages automatically. |
list_purchasable_skus
list_purchasable_skus(request: Optional[google.cloud.channel_v1.types.service.ListPurchasableSkusRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists the Purchasable SKUs for following cases:
- SKUs that can be newly purchased for a customer
- SKUs that can be upgraded/downgraded to, for an entitlement.
Possible Error Codes:
- PERMISSION_DENIED: If the customer doesn't belong to the reseller
- INVALID_ARGUMENT: Missing or invalid required parameters in the request.
| Name | Description |
request |
google.cloud.channel_v1.types.ListPurchasableSkusRequest
The request object. Request message for ListPurchasableSkus. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.services.cloud_channel_service.pagers.ListPurchasableSkusPager | Response message for ListPurchasableSkus. Iterating over this object will yield results and resolve additional pages automatically. |
list_skus
list_skus(request: Optional[google.cloud.channel_v1.types.service.ListSkusRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists the SKUs for a product the reseller is authorized to sell.
Possible Error Codes:
- INVALID_ARGUMENT: Missing or invalid required parameters in the request.
| Name | Description |
request |
google.cloud.channel_v1.types.ListSkusRequest
The request object. Request message for ListSkus. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.services.cloud_channel_service.pagers.ListSkusPager | Response message for ListSkus. Iterating over this object will yield results and resolve additional pages automatically. |
list_subscribers
list_subscribers(request: Optional[google.cloud.channel_v1.types.service.ListSubscribersRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists service accounts with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account.
Possible Error Codes:
- PERMISSION_DENIED: If the reseller account making the request and the reseller account being provided are different, or if the account is not a super admin.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request.
- NOT_FOUND: If the topic resource doesn't exist.
- INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
Return Value: List of service email addresses if successful, otherwise error is returned.
| Name | Description |
request |
google.cloud.channel_v1.types.ListSubscribersRequest
The request object. Request Message for ListSubscribers. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.services.cloud_channel_service.pagers.ListSubscribersPager | Response Message for ListSubscribers. Iterating over this object will yield results and resolve additional pages automatically. |
list_transferable_offers
list_transferable_offers(request: Optional[google.cloud.channel_v1.types.service.ListTransferableOffersRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())List xref_TransferableOffers of a customer based on Cloud Identity ID or Customer Name in the request.
This method is used when a reseller gets the entitlement information of a customer that is not owned. The reseller should provide the customer's Cloud Identity ID or Customer Name.
Possible Error Codes:
PERMISSION_DENIED: Appears because of one of the following:
- If the customer doesn't belong to the reseller and no auth token or invalid auth token is supplied.
- If the reseller account making the request and the reseller account being queried for are different.
INVALID_ARGUMENT: Missing or invalid required parameters in the request.
Return Value: List of xref_TransferableOffer for the given customer and SKU.
| Name | Description |
request |
google.cloud.channel_v1.types.ListTransferableOffersRequest
The request object. Request message for CloudChannelService.ListTransferableOffers |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.services.cloud_channel_service.pagers.ListTransferableOffersPager | Response message for CloudChannelService.ListTransferableOffers. Iterating over this object will yield results and resolve additional pages automatically. |
list_transferable_skus
list_transferable_skus(request: Optional[google.cloud.channel_v1.types.service.ListTransferableSkusRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())List xref_TransferableSkus of a customer based on Cloud Identity ID or Customer Name in the request.
This method is used when a reseller lists the entitlements information of a customer that is not owned. The reseller should provide the customer's Cloud Identity ID or Customer Name.
Possible Error Codes:
PERMISSION_DENIED: Appears because of one of the following -
- The customer doesn't belong to the reseller and no auth token.
- The supplied auth token is invalid.
- The reseller account making the request and the queries reseller account are different.
INVALID_ARGUMENT: Missing or invalid required parameters in the request.
Return Value: List of xref_TransferableSku for the given customer.
| Name | Description |
request |
google.cloud.channel_v1.types.ListTransferableSkusRequest
The request object. Request message for CloudChannelService.ListTransferableSkus |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.services.cloud_channel_service.pagers.ListTransferableSkusPager | Response message for CloudChannelService.ListTransferableSkus. Iterating over this object will yield results and resolve additional pages automatically. |
offer_path
offer_path(account: str, offer: str)Return a fully-qualified offer string.
parse_common_billing_account_path
parse_common_billing_account_path(path: str)Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)Parse a project path into its component segments.
parse_customer_path
parse_customer_path(path: str)Parse a customer path into its component segments.
parse_entitlement_path
parse_entitlement_path(path: str)Parse a entitlement path into its component segments.
parse_offer_path
parse_offer_path(path: str)Parse a offer path into its component segments.
parse_product_path
parse_product_path(path: str)Parse a product path into its component segments.
parse_sku_path
parse_sku_path(path: str)Parse a sku path into its component segments.
product_path
product_path(product: str)Return a fully-qualified product string.
provision_cloud_identity
provision_cloud_identity(request: Optional[google.cloud.channel_v1.types.service.ProvisionCloudIdentityRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Creates a Cloud Identity for the given customer using the customer's information or the information provided here, if present.
Possible Error Codes:
- PERMISSION_DENIED: If the customer doesn't belong to the reseller.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request.
- NOT_FOUND: If the customer is not found for the reseller.
- ALREADY_EXISTS: If the customer's primary email already exists. In this case, retry after changing the customer's primary contact email.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support in this case.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support in this case.
Return Value: Long Running Operation ID.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of xref_OperationMetadata.
| Name | Description |
request |
google.cloud.channel_v1.types.ProvisionCloudIdentityRequest
The request object. Request message for CloudChannelService.ProvisionCloudIdentity |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be Customer Entity representing a customer of a reseller or distributor. |
register_subscriber
register_subscriber(request: Optional[google.cloud.channel_v1.types.service.RegisterSubscriberRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Registers a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. Once you create a subscriber, you will get the events as per xref_SubscriberEvent
Possible Error Codes:
- PERMISSION_DENIED: If the reseller account making the request and the reseller account being provided are different, or if the impersonated user is not a super admin.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request.
- INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
Return Value: Topic name with service email address registered if successful, otherwise error is returned.
| Name | Description |
request |
google.cloud.channel_v1.types.RegisterSubscriberRequest
The request object. Request Message for RegisterSubscriber. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.types.RegisterSubscriberResponse | Response Message for RegisterSubscriber. |
sku_path
sku_path(product: str, sku: str)Return a fully-qualified sku string.
start_paid_service
start_paid_service(request: Optional[google.cloud.channel_v1.types.service.StartPaidServiceRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Starts paid service for a trial entitlement.
Starts paid service for a trial entitlement immediately. This method is only applicable if a plan has already been set up for a trial entitlement but has some trial days remaining.
Possible Error Codes:
- PERMISSION_DENIED: If the customer doesn't belong to the reseller.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request.
- NOT_FOUND: Entitlement resource not found.
- FAILED_PRECONDITION/NOT_IN_TRIAL: This method only works for entitlement on trial plans.
- INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
Return Value: Long Running Operation ID.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of xref_OperationMetadata.
| Name | Description |
request |
google.cloud.channel_v1.types.StartPaidServiceRequest
The request object. Request message for CloudChannelService.StartPaidService. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be Entitlement An entitlement is a representation of a customer's ability to use a service. |
suspend_entitlement
suspend_entitlement(request: Optional[google.cloud.channel_v1.types.service.SuspendEntitlementRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Suspends a previously fulfilled entitlement. An entitlement suspension is a long-running operation.
Possible Error Codes:
- PERMISSION_DENIED: If the customer doesn't belong to the reseller.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request.
- NOT_FOUND: Entitlement resource not found.
- NOT_ACTIVE: Entitlement is not active.
- INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
Return Value: Long Running Operation ID.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of xref_OperationMetadata.
| Name | Description |
request |
google.cloud.channel_v1.types.SuspendEntitlementRequest
The request object. Request message for CloudChannelService.SuspendEntitlement. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be Entitlement An entitlement is a representation of a customer's ability to use a service. |
transfer_entitlements
transfer_entitlements(request: Optional[google.cloud.channel_v1.types.service.TransferEntitlementsRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Transfers customer entitlements to new reseller.
Possible Error Codes:
- PERMISSION_DENIED: If the customer doesn't belong to the reseller.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request.
- NOT_FOUND: If the customer or offer resource is not found for the reseller.
- ALREADY_EXISTS: If the SKU has been already transferred for the customer.
CONDITION_NOT_MET or FAILED_PRECONDITION: This failure can happen in the following cases:
- Transferring a SKU that requires domain verification and the domain has not been verified.
- Transferring an Add-On SKU like Vault or Drive without transferring the pre-requisite SKU, such as G Suite Basic.
Applicable only for developer accounts: reseller and resold domain must follow the domain naming convention as follows:
- Domain names must start with goog-test.
- Resold domain names must include the reseller domain.
All transferring entitlements must be specified.
INTERNAL: Any non-user error related to a technical issue in the backend. Please contact Cloud Channel Support in this case.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Please contact Cloud Channel Support in this case.
Return Value: Long Running Operation ID.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of xref_OperationMetadata.
| Name | Description |
request |
google.cloud.channel_v1.types.TransferEntitlementsRequest
The request object. Request message for CloudChannelService.TransferEntitlements. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be TransferEntitlementsResponse Response message for CloudChannelService.TransferEntitlements. This will be put into the response field of google.longrunning.Operation. |
transfer_entitlements_to_google
transfer_entitlements_to_google(request: Optional[google.cloud.channel_v1.types.service.TransferEntitlementsToGoogleRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Transfers customer entitlements from current reseller to Google.
Possible Error Codes:
- PERMISSION_DENIED: If the customer doesn't belong to the reseller.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request.
- NOT_FOUND: If the customer or offer resource is not found for the reseller.
- ALREADY_EXISTS: If the SKU has been already transferred for the customer.
CONDITION_NOT_MET or FAILED_PRECONDITION: This failure can happen in the following cases:
- Transferring a SKU that requires domain verification and the domain has not been verified.
- Transferring an Add-On SKU like Vault or Drive without purchasing the pre-requisite SKU, such as G Suite Basic.
Applicable only for developer accounts: reseller and resold domain must follow the domain naming convention as follows:
- Domain names must start with goog-test.
- Resold domain names must include the reseller domain.
INTERNAL: Any non-user error related to a technical issue in the backend. Please contact Cloud Channel Support in this case.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Please contact Cloud Channel Support in this case.
Return Value: Long Running Operation ID.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The response will contain google.protobuf.Empty on success. The Operation metadata will contain an instance of xref_OperationMetadata.
| Name | Description |
request |
google.cloud.channel_v1.types.TransferEntitlementsToGoogleRequest
The request object. Request message for CloudChannelService.TransferEntitlementsToGoogle. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}. |
unregister_subscriber
unregister_subscriber(request: Optional[google.cloud.channel_v1.types.service.UnregisterSubscriberRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Unregisters a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. If there are no more service account left with sunbscriber privileges, the topic will be deleted. You can check this by calling ListSubscribers api.
Possible Error Codes:
- PERMISSION_DENIED: If the reseller account making the request and the reseller account being provided are different, or if the impersonated user is not a super admin.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request.
- NOT_FOUND: If the topic resource doesn't exist.
- INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
Return Value: Topic name from which service email address has been unregistered if successful, otherwise error is returned. If the service email was already not associated with the topic, the success response will be returned.
| Name | Description |
request |
google.cloud.channel_v1.types.UnregisterSubscriberRequest
The request object. Request Message for UnregisterSubscriber. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.types.UnregisterSubscriberResponse | Response Message for UnregisterSubscriber. |
update_channel_partner_link
update_channel_partner_link(request: Optional[google.cloud.channel_v1.types.service.UpdateChannelPartnerLinkRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Updates a channel partner link. A distributor calls this method to change a link's status. For example, suspend a partner link. To call this method, you must be a distributor.
Possible Error Codes:
- PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
INVALID_ARGUMENT: It can happen in following scenarios -
- Missing or invalid required parameters in the request.
- Updating link state from invited to active or suspended.
- Sending 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. In this case, contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the updated xref_ChannelPartnerLink resource, otherwise returns an error.
| Name | Description |
request |
google.cloud.channel_v1.types.UpdateChannelPartnerLinkRequest
The request object. Request message for CloudChannelService.UpdateChannelPartnerLink |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.types.ChannelPartnerLink | Entity representing a link between distributors and their indirect resellers in an n-tier resale channel. |
update_customer
update_customer(request: Optional[google.cloud.channel_v1.types.service.UpdateCustomerRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Updates an existing xref_Customer resource belonging to the reseller or distributor.
Possible Error Codes:
- PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request.
- NOT_FOUND: No xref_Customer resource found for the name specified in the request.
Return Value: If successful, the updated xref_Customer resource, otherwise returns an error.
| Name | Description |
request |
google.cloud.channel_v1.types.UpdateCustomerRequest
The request object. Request message for CloudChannelService.UpdateCustomer. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
google.cloud.channel_v1.types.Customer | Entity representing a customer of a reseller or distributor. |