As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

CloudChannelService

class google.cloud.channel_v1.services.cloud_channel_service.CloudChannelServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.channel_v1.services.cloud_channel_service.transports.base.CloudChannelServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/.nox/docs/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

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:

  • [Customer][google.cloud.channel.v1.Customer]s: An entity—usually an enterprise—managed by a reseller or distributor.

  • [Entitlement][google.cloud.channel.v1.Entitlement]s: 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.

  • [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]s: An entity that identifies links between distributors and their indirect resellers in a channel.

Instantiates the cloud channel service client.

Parameters
  • 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 (ClientOptions) – Custom options for the client. It won’t take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

async activate_entitlement(request: Optional[google.cloud.channel_v1.types.service.ActivateEntitlementRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

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][google.cloud.channel.v1.OperationMetadata].

Parameters
  • request (google.cloud.channel_v1.types.ActivateEntitlementRequest) – The request object. Request message for [CloudChannelService.ActivateEntitlement][google.cloud.channel.v1.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.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.channel_v1.types.Entitlement An entitlement is a representation of a customer’s ability to use a service.

Return type

google.api_core.operation_async.AsyncOperation

async cancel_entitlement(request: Optional[google.cloud.channel_v1.types.service.CancelEntitlementRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

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][google.cloud.channel.v1.OperationMetadata].

Parameters
  • request (google.cloud.channel_v1.types.CancelEntitlementRequest) – The request object. Request message for [CloudChannelService.CancelEntitlement][google.cloud.channel.v1.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.

Returns

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 {}.

Return type

google.api_core.operation_async.AsyncOperation

async change_offer(request: Optional[google.cloud.channel_v1.types.service.ChangeOfferRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

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][google.cloud.channel.v1.OperationMetadata].

Parameters
  • request (google.cloud.channel_v1.types.ChangeOfferRequest) – The request object. Request message for [CloudChannelService.ChangeOffer][google.cloud.channel.v1.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.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.channel_v1.types.Entitlement An entitlement is a representation of a customer’s ability to use a service.

Return type

google.api_core.operation_async.AsyncOperation

async change_parameters(request: Optional[google.cloud.channel_v1.types.service.ChangeParametersRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

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][google.cloud.channel.v1.OperationMetadata].

Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.channel_v1.types.Entitlement An entitlement is a representation of a customer’s ability to use a service.

Return type

google.api_core.operation_async.AsyncOperation

async change_renewal_settings(request: Optional[google.cloud.channel_v1.types.service.ChangeRenewalSettingsRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

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][google.cloud.channel.v1.OperationMetadata].

Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.channel_v1.types.Entitlement An entitlement is a representation of a customer’s ability to use a service.

Return type

google.api_core.operation_async.AsyncOperation

async check_cloud_identity_accounts_exist(request: Optional[google.cloud.channel_v1.types.service.CheckCloudIdentityAccountsExistRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.channel_v1.types.service.CheckCloudIdentityAccountsExistResponse[source]

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][google.cloud.channel.v1.CloudIdentityCustomerAccount] resources for the domain (may be empty)

Note: in the v1alpha1 version of the API, a NOT_FOUND error returns if no [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] resources match the domain.

Parameters
Returns

Response message for

[CloudChannelService.CheckCloudIdentityAccountsExist][google.cloud.channel.v1.CloudChannelService.CheckCloudIdentityAccountsExist].

Return type

google.cloud.channel_v1.types.CheckCloudIdentityAccountsExistResponse

static common_billing_account_path(billing_account: str)str

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)str

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str)str

Returns a fully-qualified location string.

static common_organization_path(organization: str)str

Returns a fully-qualified organization string.

static common_project_path(project: str)str

Returns a fully-qualified project string.

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][google.cloud.channel.v1.ChannelPartnerLink] resource.

Parameters
Returns

Entity representing a link between distributors and their indirect resellers in an n-tier resale channel.

Return type

google.cloud.channel_v1.types.ChannelPartnerLink

async create_customer(request: Optional[google.cloud.channel_v1.types.service.CreateCustomerRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.channel_v1.types.customers.Customer[source]

Creates a new [Customer][google.cloud.channel.v1.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][google.cloud.channel.v1.Customer] resource.

Parameters
  • request (google.cloud.channel_v1.types.CreateCustomerRequest) – The request object. Request message for [CloudChannelService.CreateCustomer][google.cloud.channel.v1.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.

Returns

Entity representing a customer of a reseller or distributor.

Return type

google.cloud.channel_v1.types.Customer

async create_entitlement(request: Optional[google.cloud.channel_v1.types.service.CreateEntitlementRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

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][google.cloud.channel.v1.OperationMetadata].

Parameters
  • request (google.cloud.channel_v1.types.CreateEntitlementRequest) – The request object. Request message for [CloudChannelService.CreateEntitlement][google.cloud.channel.v1.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.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.channel_v1.types.Entitlement An entitlement is a representation of a customer’s ability to use a service.

Return type

google.api_core.operation_async.AsyncOperation

static customer_path(account: str, customer: str)str

Returns a fully-qualified customer string.

async delete_customer(request: Optional[google.cloud.channel_v1.types.service.DeleteCustomerRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())None[source]

Deletes the given [Customer][google.cloud.channel.v1.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][google.cloud.channel.v1.Customer] resource found for the name in the request.

Parameters
  • request (google.cloud.channel_v1.types.DeleteCustomerRequest) – The request object. Request message for [CloudChannelService.DeleteCustomer][google.cloud.channel.v1.CloudChannelService.DeleteCustomer].

  • name (str) –

    Required. The resource name of the customer to delete.

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • 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.

static entitlement_path(account: str, customer: str, entitlement: str)str

Returns a fully-qualified entitlement string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

CloudChannelServiceAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

CloudChannelServiceAsyncClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

CloudChannelServiceAsyncClient

Returns the requested [ChannelPartnerLink][google.cloud.channel.v1.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][google.cloud.channel.v1.ChannelPartnerLink] resource.

Parameters
Returns

Entity representing a link between distributors and their indirect resellers in an n-tier resale channel.

Return type

google.cloud.channel_v1.types.ChannelPartnerLink

async get_customer(request: Optional[google.cloud.channel_v1.types.service.GetCustomerRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.channel_v1.types.customers.Customer[source]

Returns the requested [Customer][google.cloud.channel.v1.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][google.cloud.channel.v1.Customer] resource.

Parameters
  • request (google.cloud.channel_v1.types.GetCustomerRequest) – The request object. Request message for [CloudChannelService.GetCustomer][google.cloud.channel.v1.CloudChannelService.GetCustomer].

  • name (str) –

    Required. The resource name of the customer to retrieve. Name uses the format: accounts/{account_id}/customers/{customer_id}

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • 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.

Returns

Entity representing a customer of a reseller or distributor.

Return type

google.cloud.channel_v1.types.Customer

async get_entitlement(request: Optional[google.cloud.channel_v1.types.service.GetEntitlementRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.channel_v1.types.entitlements.Entitlement[source]

Returns the requested [Entitlement][google.cloud.channel.v1.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][google.cloud.channel.v1.Entitlement] resource.

Parameters
  • request (google.cloud.channel_v1.types.GetEntitlementRequest) – The request object. Request message for [CloudChannelService.GetEntitlement][google.cloud.channel.v1.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.

Returns

An entitlement is a representation of a customer’s ability to use a service.

Return type

google.cloud.channel_v1.types.Entitlement

get_transport_class()Type[google.cloud.channel_v1.services.cloud_channel_service.transports.base.CloudChannelServiceTransport]

Returns an appropriate transport class.

Parameters

label – The name of the desired transport. If none is provided, then the first transport in the registry is used.

Returns

The transport class to use.

async import_customer(request: Optional[google.cloud.channel_v1.types.service.ImportCustomerRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.channel_v1.types.customers.Customer[source]

Imports a [Customer][google.cloud.channel.v1.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][google.cloud.channel.v1.Customer].

Parameters
  • request (google.cloud.channel_v1.types.ImportCustomerRequest) – The request object. Request message for [CloudChannelService.ImportCustomer][google.cloud.channel.v1.CloudChannelService.ImportCustomer]

  • 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.

Returns

Entity representing a customer of a reseller or distributor.

Return type

google.cloud.channel_v1.types.Customer

List [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]s 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][google.cloud.channel.v1.ChannelPartnerLink] resources.

Parameters
Returns

Response message for [CloudChannelService.ListChannelPartnerLinks][google.cloud.channel.v1.CloudChannelService.ListChannelPartnerLinks].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.channel_v1.services.cloud_channel_service.pagers.ListChannelPartnerLinksAsyncPager

async list_customers(request: Optional[google.cloud.channel_v1.types.service.ListCustomersRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.channel_v1.services.cloud_channel_service.pagers.ListCustomersAsyncPager[source]

List [Customer][google.cloud.channel.v1.Customer]s.

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 [Customer][google.cloud.channel.v1.Customer]s, or an empty list if there are no customers.

Parameters
  • request (google.cloud.channel_v1.types.ListCustomersRequest) – The request object. Request message for [CloudChannelService.ListCustomers][google.cloud.channel.v1.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.

Returns

Response message for [CloudChannelService.ListCustomers][google.cloud.channel.v1.CloudChannelService.ListCustomers].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.channel_v1.services.cloud_channel_service.pagers.ListCustomersAsyncPager

async list_entitlements(request: Optional[google.cloud.channel_v1.types.service.ListEntitlementsRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.channel_v1.services.cloud_channel_service.pagers.ListEntitlementsAsyncPager[source]

Lists [Entitlement][google.cloud.channel.v1.Entitlement]s 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 [Entitlement][google.cloud.channel.v1.Entitlement]s.

Parameters
  • request (google.cloud.channel_v1.types.ListEntitlementsRequest) – The request object. Request message for [CloudChannelService.ListEntitlements][google.cloud.channel.v1.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.

Returns

Response message for [CloudChannelService.ListEntitlements][google.cloud.channel.v1.CloudChannelService.ListEntitlements].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.channel_v1.services.cloud_channel_service.pagers.ListEntitlementsAsyncPager

async list_offers(request: Optional[google.cloud.channel_v1.types.service.ListOffersRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.channel_v1.services.cloud_channel_service.pagers.ListOffersAsyncPager[source]

Lists the Offers the reseller can sell.

Possible error codes:

  • INVALID_ARGUMENT: Required request parameters are missing or invalid.

Parameters
Returns

Response message for ListOffers. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.channel_v1.services.cloud_channel_service.pagers.ListOffersAsyncPager

async list_products(request: Optional[google.cloud.channel_v1.types.service.ListProductsRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.channel_v1.services.cloud_channel_service.pagers.ListProductsAsyncPager[source]

Lists the Products the reseller is authorized to sell.

Possible error codes:

  • INVALID_ARGUMENT: Required request parameters are missing or invalid.

Parameters
Returns

Response message for ListProducts. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.channel_v1.services.cloud_channel_service.pagers.ListProductsAsyncPager

async list_purchasable_offers(request: Optional[google.cloud.channel_v1.types.service.ListPurchasableOffersRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.channel_v1.services.cloud_channel_service.pagers.ListPurchasableOffersAsyncPager[source]

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
Returns

Response message for ListPurchasableOffers. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.channel_v1.services.cloud_channel_service.pagers.ListPurchasableOffersAsyncPager

async list_purchasable_skus(request: Optional[google.cloud.channel_v1.types.service.ListPurchasableSkusRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.channel_v1.services.cloud_channel_service.pagers.ListPurchasableSkusAsyncPager[source]

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
Returns

Response message for ListPurchasableSkus. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.channel_v1.services.cloud_channel_service.pagers.ListPurchasableSkusAsyncPager

async list_skus(request: Optional[google.cloud.channel_v1.types.service.ListSkusRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.channel_v1.services.cloud_channel_service.pagers.ListSkusAsyncPager[source]

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
Returns

Response message for ListSkus. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.channel_v1.services.cloud_channel_service.pagers.ListSkusAsyncPager

async list_subscribers(request: Optional[google.cloud.channel_v1.types.service.ListSubscribersRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.channel_v1.services.cloud_channel_service.pagers.ListSubscribersAsyncPager[source]

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
Returns

Response Message for ListSubscribers. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.channel_v1.services.cloud_channel_service.pagers.ListSubscribersAsyncPager

async list_transferable_offers(request: Optional[google.cloud.channel_v1.types.service.ListTransferableOffersRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.channel_v1.services.cloud_channel_service.pagers.ListTransferableOffersAsyncPager[source]

List [TransferableOffer][google.cloud.channel.v1.TransferableOffer]s 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][google.cloud.channel.v1.TransferableOffer] for the given customer and SKU.

Parameters
Returns

Response message for [CloudChannelService.ListTransferableOffers][google.cloud.channel.v1.CloudChannelService.ListTransferableOffers].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.channel_v1.services.cloud_channel_service.pagers.ListTransferableOffersAsyncPager

async list_transferable_skus(request: Optional[google.cloud.channel_v1.types.service.ListTransferableSkusRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.channel_v1.services.cloud_channel_service.pagers.ListTransferableSkusAsyncPager[source]

List [TransferableSku][google.cloud.channel.v1.TransferableSku]s 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][google.cloud.channel.v1.TransferableSku].

Parameters
Returns

Response message for [CloudChannelService.ListTransferableSkus][google.cloud.channel.v1.CloudChannelService.ListTransferableSkus].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.channel_v1.services.cloud_channel_service.pagers.ListTransferableSkusAsyncPager

async lookup_offer(request: Optional[google.cloud.channel_v1.types.service.LookupOfferRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.channel_v1.types.offers.Offer[source]

Returns the requested [Offer][google.cloud.channel.v1.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][google.cloud.channel.v1.Offer] resource.

Parameters
Returns

Represents an offer made to resellers for purchase.

An offer is associated with a [Sku][google.cloud.channel.v1.Sku], has a plan for payment, a price, and defines the constraints for buying.

Return type

google.cloud.channel_v1.types.Offer

static offer_path(account: str, offer: str)str

Returns a fully-qualified offer string.

static parse_common_billing_account_path(path: str)Dict[str, str]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str)Dict[str, str]

Parse a folder path into its component segments.

static parse_common_location_path(path: str)Dict[str, str]

Parse a location path into its component segments.

static parse_common_organization_path(path: str)Dict[str, str]

Parse a organization path into its component segments.

static parse_common_project_path(path: str)Dict[str, str]

Parse a project path into its component segments.

static parse_customer_path(path: str)Dict[str, str]

Parses a customer path into its component segments.

static parse_entitlement_path(path: str)Dict[str, str]

Parses a entitlement path into its component segments.

static parse_offer_path(path: str)Dict[str, str]

Parses a offer path into its component segments.

static parse_product_path(path: str)Dict[str, str]

Parses a product path into its component segments.

static parse_sku_path(path: str)Dict[str, str]

Parses a sku path into its component segments.

static product_path(product: str)str

Returns a fully-qualified product string.

async provision_cloud_identity(request: Optional[google.cloud.channel_v1.types.service.ProvisionCloudIdentityRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

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][google.cloud.channel.v1.OperationMetadata].

Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.channel_v1.types.Customer Entity representing a customer of a reseller or distributor.

Return type

google.api_core.operation_async.AsyncOperation

async register_subscriber(request: Optional[google.cloud.channel_v1.types.service.RegisterSubscriberRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.channel_v1.types.service.RegisterSubscriberResponse[source]

Registers a service account with subscriber privileges on the Cloud Pub/Sub topic for this Channel Services account. After you create a subscriber, you get the events through [SubscriberEvent][google.cloud.channel.v1.SubscriberEvent]

Possible error codes:

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

  • INVALID_ARGUMENT: Required request parameters are missing or invalid.

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

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

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

Parameters
Returns

Response Message for RegisterSubscriber.

Return type

google.cloud.channel_v1.types.RegisterSubscriberResponse

static sku_path(product: str, sku: str)str

Returns a fully-qualified sku string.

async start_paid_service(request: Optional[google.cloud.channel_v1.types.service.StartPaidServiceRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

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][google.cloud.channel.v1.OperationMetadata].

Parameters
  • request (google.cloud.channel_v1.types.StartPaidServiceRequest) – The request object. Request message for [CloudChannelService.StartPaidService][google.cloud.channel.v1.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.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.channel_v1.types.Entitlement An entitlement is a representation of a customer’s ability to use a service.

Return type

google.api_core.operation_async.AsyncOperation

async suspend_entitlement(request: Optional[google.cloud.channel_v1.types.service.SuspendEntitlementRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

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][google.cloud.channel.v1.OperationMetadata].

Parameters
  • request (google.cloud.channel_v1.types.SuspendEntitlementRequest) – The request object. Request message for [CloudChannelService.SuspendEntitlement][google.cloud.channel.v1.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.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.channel_v1.types.Entitlement An entitlement is a representation of a customer’s ability to use a service.

Return type

google.api_core.operation_async.AsyncOperation

async transfer_entitlements(request: Optional[google.cloud.channel_v1.types.service.TransferEntitlementsRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

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][google.cloud.channel.v1.OperationMetadata].

Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.channel_v1.types.TransferEntitlementsResponse Response message for [CloudChannelService.TransferEntitlements][google.cloud.channel.v1.CloudChannelService.TransferEntitlements].

This is put in the response field of google.longrunning.Operation.

Return type

google.api_core.operation_async.AsyncOperation

async transfer_entitlements_to_google(request: Optional[google.cloud.channel_v1.types.service.TransferEntitlementsToGoogleRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

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][google.cloud.channel.v1.OperationMetadata].

Parameters
Returns

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 {}.

Return type

google.api_core.operation_async.AsyncOperation

property transport: google.cloud.channel_v1.services.cloud_channel_service.transports.base.CloudChannelServiceTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

CloudChannelServiceTransport

async unregister_subscriber(request: Optional[google.cloud.channel_v1.types.service.UnregisterSubscriberRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.channel_v1.types.service.UnregisterSubscriberResponse[source]

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
Returns

Response Message for UnregisterSubscriber.

Return type

google.cloud.channel_v1.types.UnregisterSubscriberResponse

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][google.cloud.channel.v1.ChannelPartnerLink] resource.

Parameters
Returns

Entity representing a link between distributors and their indirect resellers in an n-tier resale channel.

Return type

google.cloud.channel_v1.types.ChannelPartnerLink

async update_customer(request: Optional[google.cloud.channel_v1.types.service.UpdateCustomerRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.channel_v1.types.customers.Customer[source]

Updates an existing [Customer][google.cloud.channel.v1.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][google.cloud.channel.v1.Customer] resource found for the name in the request.

Return value: The updated [Customer][google.cloud.channel.v1.Customer] resource.

Parameters
  • request (google.cloud.channel_v1.types.UpdateCustomerRequest) – The request object. Request message for [CloudChannelService.UpdateCustomer][google.cloud.channel.v1.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.

Returns

Entity representing a customer of a reseller or distributor.

Return type

google.cloud.channel_v1.types.Customer

class google.cloud.channel_v1.services.cloud_channel_service.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>)[source]

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:

  • [Customer][google.cloud.channel.v1.Customer]s: An entity—usually an enterprise—managed by a reseller or distributor.

  • [Entitlement][google.cloud.channel.v1.Entitlement]s: 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.

  • [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]s: An entity that identifies links between distributors and their indirect resellers in a channel.

Instantiates the cloud channel service client.

Parameters
  • 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 transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

  • 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 None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]

Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

activate_entitlement(request: Optional[Union[google.cloud.channel_v1.types.service.ActivateEntitlementRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

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][google.cloud.channel.v1.OperationMetadata].

Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.channel_v1.types.Entitlement An entitlement is a representation of a customer’s ability to use a service.

Return type

google.api_core.operation.Operation

cancel_entitlement(request: Optional[Union[google.cloud.channel_v1.types.service.CancelEntitlementRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

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][google.cloud.channel.v1.OperationMetadata].

Parameters
Returns

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 {}.

Return type

google.api_core.operation.Operation

change_offer(request: Optional[Union[google.cloud.channel_v1.types.service.ChangeOfferRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

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][google.cloud.channel.v1.OperationMetadata].

Parameters
  • request (Union[google.cloud.channel_v1.types.ChangeOfferRequest, dict]) – The request object. Request message for [CloudChannelService.ChangeOffer][google.cloud.channel.v1.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.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.channel_v1.types.Entitlement An entitlement is a representation of a customer’s ability to use a service.

Return type

google.api_core.operation.Operation

change_parameters(request: Optional[Union[google.cloud.channel_v1.types.service.ChangeParametersRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

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][google.cloud.channel.v1.OperationMetadata].

Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.channel_v1.types.Entitlement An entitlement is a representation of a customer’s ability to use a service.

Return type

google.api_core.operation.Operation

change_renewal_settings(request: Optional[Union[google.cloud.channel_v1.types.service.ChangeRenewalSettingsRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

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][google.cloud.channel.v1.OperationMetadata].

Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.channel_v1.types.Entitlement An entitlement is a representation of a customer’s ability to use a service.

Return type

google.api_core.operation.Operation

check_cloud_identity_accounts_exist(request: Optional[Union[google.cloud.channel_v1.types.service.CheckCloudIdentityAccountsExistRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.channel_v1.types.service.CheckCloudIdentityAccountsExistResponse[source]

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][google.cloud.channel.v1.CloudIdentityCustomerAccount] resources for the domain (may be empty)

Note: in the v1alpha1 version of the API, a NOT_FOUND error returns if no [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] resources match the domain.

Parameters
Returns

Response message for

[CloudChannelService.CheckCloudIdentityAccountsExist][google.cloud.channel.v1.CloudChannelService.CheckCloudIdentityAccountsExist].

Return type

google.cloud.channel_v1.types.CheckCloudIdentityAccountsExistResponse

static common_billing_account_path(billing_account: str)str[source]

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)str[source]

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str)str[source]

Returns a fully-qualified location string.

static common_organization_path(organization: str)str[source]

Returns a fully-qualified organization string.

static common_project_path(project: str)str[source]

Returns a fully-qualified project string.

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][google.cloud.channel.v1.ChannelPartnerLink] resource.

Parameters
Returns

Entity representing a link between distributors and their indirect resellers in an n-tier resale channel.

Return type

google.cloud.channel_v1.types.ChannelPartnerLink

create_customer(request: Optional[Union[google.cloud.channel_v1.types.service.CreateCustomerRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.channel_v1.types.customers.Customer[source]

Creates a new [Customer][google.cloud.channel.v1.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][google.cloud.channel.v1.Customer] resource.

Parameters
  • request (Union[google.cloud.channel_v1.types.CreateCustomerRequest, dict]) – The request object. Request message for [CloudChannelService.CreateCustomer][google.cloud.channel.v1.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.

Returns

Entity representing a customer of a reseller or distributor.

Return type

google.cloud.channel_v1.types.Customer

create_entitlement(request: Optional[Union[google.cloud.channel_v1.types.service.CreateEntitlementRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

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][google.cloud.channel.v1.OperationMetadata].

Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.channel_v1.types.Entitlement An entitlement is a representation of a customer’s ability to use a service.

Return type

google.api_core.operation.Operation

static customer_path(account: str, customer: str)str[source]

Returns a fully-qualified customer string.

delete_customer(request: Optional[Union[google.cloud.channel_v1.types.service.DeleteCustomerRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())None[source]

Deletes the given [Customer][google.cloud.channel.v1.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][google.cloud.channel.v1.Customer] resource found for the name in the request.

Parameters
  • request (Union[google.cloud.channel_v1.types.DeleteCustomerRequest, dict]) – The request object. Request message for [CloudChannelService.DeleteCustomer][google.cloud.channel.v1.CloudChannelService.DeleteCustomer].

  • name (str) –

    Required. The resource name of the customer to delete.

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • 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.

static entitlement_path(account: str, customer: str, entitlement: str)str[source]

Returns a fully-qualified entitlement string.

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

CloudChannelServiceClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

CloudChannelServiceClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

CloudChannelServiceClient

Returns the requested [ChannelPartnerLink][google.cloud.channel.v1.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][google.cloud.channel.v1.ChannelPartnerLink] resource.

Parameters
Returns

Entity representing a link between distributors and their indirect resellers in an n-tier resale channel.

Return type

google.cloud.channel_v1.types.ChannelPartnerLink

get_customer(request: Optional[Union[google.cloud.channel_v1.types.service.GetCustomerRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.channel_v1.types.customers.Customer[source]

Returns the requested [Customer][google.cloud.channel.v1.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][google.cloud.channel.v1.Customer] resource.

Parameters
  • request (Union[google.cloud.channel_v1.types.GetCustomerRequest, dict]) – The request object. Request message for [CloudChannelService.GetCustomer][google.cloud.channel.v1.CloudChannelService.GetCustomer].

  • name (str) –

    Required. The resource name of the customer to retrieve. Name uses the format: accounts/{account_id}/customers/{customer_id}

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • 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.

Returns

Entity representing a customer of a reseller or distributor.

Return type

google.cloud.channel_v1.types.Customer

get_entitlement(request: Optional[Union[google.cloud.channel_v1.types.service.GetEntitlementRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.channel_v1.types.entitlements.Entitlement[source]

Returns the requested [Entitlement][google.cloud.channel.v1.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][google.cloud.channel.v1.Entitlement] resource.

Parameters
  • request (Union[google.cloud.channel_v1.types.GetEntitlementRequest, dict]) – The request object. Request message for [CloudChannelService.GetEntitlement][google.cloud.channel.v1.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.

Returns

An entitlement is a representation of a customer’s ability to use a service.

Return type

google.cloud.channel_v1.types.Entitlement

import_customer(request: Optional[Union[google.cloud.channel_v1.types.service.ImportCustomerRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.channel_v1.types.customers.Customer[source]

Imports a [Customer][google.cloud.channel.v1.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][google.cloud.channel.v1.Customer].

Parameters
  • request (Union[google.cloud.channel_v1.types.ImportCustomerRequest, dict]) – The request object. Request message for [CloudChannelService.ImportCustomer][google.cloud.channel.v1.CloudChannelService.ImportCustomer]

  • 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.

Returns

Entity representing a customer of a reseller or distributor.

Return type

google.cloud.channel_v1.types.Customer

List [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]s 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][google.cloud.channel.v1.ChannelPartnerLink] resources.

Parameters
Returns

Response message for [CloudChannelService.ListChannelPartnerLinks][google.cloud.channel.v1.CloudChannelService.ListChannelPartnerLinks].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.channel_v1.services.cloud_channel_service.pagers.ListChannelPartnerLinksPager

list_customers(request: Optional[Union[google.cloud.channel_v1.types.service.ListCustomersRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.channel_v1.services.cloud_channel_service.pagers.ListCustomersPager[source]

List [Customer][google.cloud.channel.v1.Customer]s.

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 [Customer][google.cloud.channel.v1.Customer]s, or an empty list if there are no customers.

Parameters
  • request (Union[google.cloud.channel_v1.types.ListCustomersRequest, dict]) – The request object. Request message for [CloudChannelService.ListCustomers][google.cloud.channel.v1.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.

Returns

Response message for [CloudChannelService.ListCustomers][google.cloud.channel.v1.CloudChannelService.ListCustomers].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.channel_v1.services.cloud_channel_service.pagers.ListCustomersPager

list_entitlements(request: Optional[Union[google.cloud.channel_v1.types.service.ListEntitlementsRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.channel_v1.services.cloud_channel_service.pagers.ListEntitlementsPager[source]

Lists [Entitlement][google.cloud.channel.v1.Entitlement]s 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 [Entitlement][google.cloud.channel.v1.Entitlement]s.

Parameters
Returns

Response message for [CloudChannelService.ListEntitlements][google.cloud.channel.v1.CloudChannelService.ListEntitlements].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.channel_v1.services.cloud_channel_service.pagers.ListEntitlementsPager

list_offers(request: Optional[Union[google.cloud.channel_v1.types.service.ListOffersRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.channel_v1.services.cloud_channel_service.pagers.ListOffersPager[source]

Lists the Offers the reseller can sell.

Possible error codes:

  • INVALID_ARGUMENT: Required request parameters are missing or invalid.

Parameters
Returns

Response message for ListOffers. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.channel_v1.services.cloud_channel_service.pagers.ListOffersPager

list_products(request: Optional[Union[google.cloud.channel_v1.types.service.ListProductsRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.channel_v1.services.cloud_channel_service.pagers.ListProductsPager[source]

Lists the Products the reseller is authorized to sell.

Possible error codes:

  • INVALID_ARGUMENT: Required request parameters are missing or invalid.

Parameters
Returns

Response message for ListProducts. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.channel_v1.services.cloud_channel_service.pagers.ListProductsPager

list_purchasable_offers(request: Optional[Union[google.cloud.channel_v1.types.service.ListPurchasableOffersRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.channel_v1.services.cloud_channel_service.pagers.ListPurchasableOffersPager[source]

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
Returns

Response message for ListPurchasableOffers. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.channel_v1.services.cloud_channel_service.pagers.ListPurchasableOffersPager

list_purchasable_skus(request: Optional[Union[google.cloud.channel_v1.types.service.ListPurchasableSkusRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.channel_v1.services.cloud_channel_service.pagers.ListPurchasableSkusPager[source]

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
Returns

Response message for ListPurchasableSkus. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.channel_v1.services.cloud_channel_service.pagers.ListPurchasableSkusPager

list_skus(request: Optional[Union[google.cloud.channel_v1.types.service.ListSkusRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.channel_v1.services.cloud_channel_service.pagers.ListSkusPager[source]

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
Returns

Response message for ListSkus. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.channel_v1.services.cloud_channel_service.pagers.ListSkusPager

list_subscribers(request: Optional[Union[google.cloud.channel_v1.types.service.ListSubscribersRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.channel_v1.services.cloud_channel_service.pagers.ListSubscribersPager[source]

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
Returns

Response Message for ListSubscribers. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.channel_v1.services.cloud_channel_service.pagers.ListSubscribersPager

list_transferable_offers(request: Optional[Union[google.cloud.channel_v1.types.service.ListTransferableOffersRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.channel_v1.services.cloud_channel_service.pagers.ListTransferableOffersPager[source]

List [TransferableOffer][google.cloud.channel.v1.TransferableOffer]s 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][google.cloud.channel.v1.TransferableOffer] for the given customer and SKU.

Parameters
Returns

Response message for [CloudChannelService.ListTransferableOffers][google.cloud.channel.v1.CloudChannelService.ListTransferableOffers].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.channel_v1.services.cloud_channel_service.pagers.ListTransferableOffersPager

list_transferable_skus(request: Optional[Union[google.cloud.channel_v1.types.service.ListTransferableSkusRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.channel_v1.services.cloud_channel_service.pagers.ListTransferableSkusPager[source]

List [TransferableSku][google.cloud.channel.v1.TransferableSku]s 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][google.cloud.channel.v1.TransferableSku].

Parameters
Returns

Response message for [CloudChannelService.ListTransferableSkus][google.cloud.channel.v1.CloudChannelService.ListTransferableSkus].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.channel_v1.services.cloud_channel_service.pagers.ListTransferableSkusPager

lookup_offer(request: Optional[Union[google.cloud.channel_v1.types.service.LookupOfferRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.channel_v1.types.offers.Offer[source]

Returns the requested [Offer][google.cloud.channel.v1.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][google.cloud.channel.v1.Offer] resource.

Parameters
Returns

Represents an offer made to resellers for purchase.

An offer is associated with a [Sku][google.cloud.channel.v1.Sku], has a plan for payment, a price, and defines the constraints for buying.

Return type

google.cloud.channel_v1.types.Offer

static offer_path(account: str, offer: str)str[source]

Returns a fully-qualified offer string.

static parse_common_billing_account_path(path: str)Dict[str, str][source]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str)Dict[str, str][source]

Parse a folder path into its component segments.

static parse_common_location_path(path: str)Dict[str, str][source]

Parse a location path into its component segments.

static parse_common_organization_path(path: str)Dict[str, str][source]

Parse a organization path into its component segments.

static parse_common_project_path(path: str)Dict[str, str][source]

Parse a project path into its component segments.

static parse_customer_path(path: str)Dict[str, str][source]

Parses a customer path into its component segments.

static parse_entitlement_path(path: str)Dict[str, str][source]

Parses a entitlement path into its component segments.

static parse_offer_path(path: str)Dict[str, str][source]

Parses a offer path into its component segments.

static parse_product_path(path: str)Dict[str, str][source]

Parses a product path into its component segments.

static parse_sku_path(path: str)Dict[str, str][source]

Parses a sku path into its component segments.

static product_path(product: str)str[source]

Returns a fully-qualified product string.

provision_cloud_identity(request: Optional[Union[google.cloud.channel_v1.types.service.ProvisionCloudIdentityRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

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][google.cloud.channel.v1.OperationMetadata].

Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.channel_v1.types.Customer Entity representing a customer of a reseller or distributor.

Return type

google.api_core.operation.Operation

register_subscriber(request: Optional[Union[google.cloud.channel_v1.types.service.RegisterSubscriberRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.channel_v1.types.service.RegisterSubscriberResponse[source]

Registers a service account with subscriber privileges on the Cloud Pub/Sub topic for this Channel Services account. After you create a subscriber, you get the events through [SubscriberEvent][google.cloud.channel.v1.SubscriberEvent]

Possible error codes:

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

  • INVALID_ARGUMENT: Required request parameters are missing or invalid.

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

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

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

Parameters
Returns

Response Message for RegisterSubscriber.

Return type

google.cloud.channel_v1.types.RegisterSubscriberResponse

static sku_path(product: str, sku: str)str[source]

Returns a fully-qualified sku string.

start_paid_service(request: Optional[Union[google.cloud.channel_v1.types.service.StartPaidServiceRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

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][google.cloud.channel.v1.OperationMetadata].

Parameters
  • request (Union[google.cloud.channel_v1.types.StartPaidServiceRequest, dict]) – The request object. Request message for [CloudChannelService.StartPaidService][google.cloud.channel.v1.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.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.channel_v1.types.Entitlement An entitlement is a representation of a customer’s ability to use a service.

Return type

google.api_core.operation.Operation

suspend_entitlement(request: Optional[Union[google.cloud.channel_v1.types.service.SuspendEntitlementRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

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][google.cloud.channel.v1.OperationMetadata].

Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.channel_v1.types.Entitlement An entitlement is a representation of a customer’s ability to use a service.

Return type

google.api_core.operation.Operation

transfer_entitlements(request: Optional[Union[google.cloud.channel_v1.types.service.TransferEntitlementsRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

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][google.cloud.channel.v1.OperationMetadata].

Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.channel_v1.types.TransferEntitlementsResponse Response message for [CloudChannelService.TransferEntitlements][google.cloud.channel.v1.CloudChannelService.TransferEntitlements].

This is put in the response field of google.longrunning.Operation.

Return type

google.api_core.operation.Operation

transfer_entitlements_to_google(request: Optional[Union[google.cloud.channel_v1.types.service.TransferEntitlementsToGoogleRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

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][google.cloud.channel.v1.OperationMetadata].

Parameters
Returns

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 {}.

Return type

google.api_core.operation.Operation

property transport: google.cloud.channel_v1.services.cloud_channel_service.transports.base.CloudChannelServiceTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

CloudChannelServiceTransport

unregister_subscriber(request: Optional[Union[google.cloud.channel_v1.types.service.UnregisterSubscriberRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.channel_v1.types.service.UnregisterSubscriberResponse[source]

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
Returns

Response Message for UnregisterSubscriber.

Return type

google.cloud.channel_v1.types.UnregisterSubscriberResponse

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][google.cloud.channel.v1.ChannelPartnerLink] resource.

Parameters
Returns

Entity representing a link between distributors and their indirect resellers in an n-tier resale channel.

Return type

google.cloud.channel_v1.types.ChannelPartnerLink

update_customer(request: Optional[Union[google.cloud.channel_v1.types.service.UpdateCustomerRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.channel_v1.types.customers.Customer[source]

Updates an existing [Customer][google.cloud.channel.v1.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][google.cloud.channel.v1.Customer] resource found for the name in the request.

Return value: The updated [Customer][google.cloud.channel.v1.Customer] resource.

Parameters
  • request (Union[google.cloud.channel_v1.types.UpdateCustomerRequest, dict]) – The request object. Request message for [CloudChannelService.UpdateCustomer][google.cloud.channel.v1.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.

Returns

Entity representing a customer of a reseller or distributor.

Return type

google.cloud.channel_v1.types.Customer

class google.cloud.channel_v1.services.cloud_channel_service.pagers.ListChannelPartnerLinksAsyncPager(method: Callable[[...], Awaitable[google.cloud.channel_v1.types.service.ListChannelPartnerLinksResponse]], request: google.cloud.channel_v1.types.service.ListChannelPartnerLinksRequest, response: google.cloud.channel_v1.types.service.ListChannelPartnerLinksResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_channel_partner_links requests.

This class thinly wraps an initial google.cloud.channel_v1.types.ListChannelPartnerLinksResponse object, and provides an __aiter__ method to iterate through its channel_partner_links field.

If there are more pages, the __aiter__ method will make additional ListChannelPartnerLinks requests and continue to iterate through the channel_partner_links field on the corresponding responses.

All the usual google.cloud.channel_v1.types.ListChannelPartnerLinksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.channel_v1.services.cloud_channel_service.pagers.ListChannelPartnerLinksPager(method: Callable[[...], google.cloud.channel_v1.types.service.ListChannelPartnerLinksResponse], request: google.cloud.channel_v1.types.service.ListChannelPartnerLinksRequest, response: google.cloud.channel_v1.types.service.ListChannelPartnerLinksResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_channel_partner_links requests.

This class thinly wraps an initial google.cloud.channel_v1.types.ListChannelPartnerLinksResponse object, and provides an __iter__ method to iterate through its channel_partner_links field.

If there are more pages, the __iter__ method will make additional ListChannelPartnerLinks requests and continue to iterate through the channel_partner_links field on the corresponding responses.

All the usual google.cloud.channel_v1.types.ListChannelPartnerLinksResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.cloud.channel_v1.services.cloud_channel_service.pagers.ListCustomersAsyncPager(method: Callable[[...], Awaitable[google.cloud.channel_v1.types.service.ListCustomersResponse]], request: google.cloud.channel_v1.types.service.ListCustomersRequest, response: google.cloud.channel_v1.types.service.ListCustomersResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_customers requests.

This class thinly wraps an initial google.cloud.channel_v1.types.ListCustomersResponse object, and provides an __aiter__ method to iterate through its customers field.

If there are more pages, the __aiter__ method will make additional ListCustomers requests and continue to iterate through the customers field on the corresponding responses.

All the usual google.cloud.channel_v1.types.ListCustomersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.channel_v1.services.cloud_channel_service.pagers.ListCustomersPager(method: Callable[[...], google.cloud.channel_v1.types.service.ListCustomersResponse], request: google.cloud.channel_v1.types.service.ListCustomersRequest, response: google.cloud.channel_v1.types.service.ListCustomersResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_customers requests.

This class thinly wraps an initial google.cloud.channel_v1.types.ListCustomersResponse object, and provides an __iter__ method to iterate through its customers field.

If there are more pages, the __iter__ method will make additional ListCustomers requests and continue to iterate through the customers field on the corresponding responses.

All the usual google.cloud.channel_v1.types.ListCustomersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.cloud.channel_v1.services.cloud_channel_service.pagers.ListEntitlementsAsyncPager(method: Callable[[...], Awaitable[google.cloud.channel_v1.types.service.ListEntitlementsResponse]], request: google.cloud.channel_v1.types.service.ListEntitlementsRequest, response: google.cloud.channel_v1.types.service.ListEntitlementsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_entitlements requests.

This class thinly wraps an initial google.cloud.channel_v1.types.ListEntitlementsResponse object, and provides an __aiter__ method to iterate through its entitlements field.

If there are more pages, the __aiter__ method will make additional ListEntitlements requests and continue to iterate through the entitlements field on the corresponding responses.

All the usual google.cloud.channel_v1.types.ListEntitlementsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.channel_v1.services.cloud_channel_service.pagers.ListEntitlementsPager(method: Callable[[...], google.cloud.channel_v1.types.service.ListEntitlementsResponse], request: google.cloud.channel_v1.types.service.ListEntitlementsRequest, response: google.cloud.channel_v1.types.service.ListEntitlementsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_entitlements requests.

This class thinly wraps an initial google.cloud.channel_v1.types.ListEntitlementsResponse object, and provides an __iter__ method to iterate through its entitlements field.

If there are more pages, the __iter__ method will make additional ListEntitlements requests and continue to iterate through the entitlements field on the corresponding responses.

All the usual google.cloud.channel_v1.types.ListEntitlementsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.cloud.channel_v1.services.cloud_channel_service.pagers.ListOffersAsyncPager(method: Callable[[...], Awaitable[google.cloud.channel_v1.types.service.ListOffersResponse]], request: google.cloud.channel_v1.types.service.ListOffersRequest, response: google.cloud.channel_v1.types.service.ListOffersResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_offers requests.

This class thinly wraps an initial google.cloud.channel_v1.types.ListOffersResponse object, and provides an __aiter__ method to iterate through its offers field.

If there are more pages, the __aiter__ method will make additional ListOffers requests and continue to iterate through the offers field on the corresponding responses.

All the usual google.cloud.channel_v1.types.ListOffersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.channel_v1.services.cloud_channel_service.pagers.ListOffersPager(method: Callable[[...], google.cloud.channel_v1.types.service.ListOffersResponse], request: google.cloud.channel_v1.types.service.ListOffersRequest, response: google.cloud.channel_v1.types.service.ListOffersResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_offers requests.

This class thinly wraps an initial google.cloud.channel_v1.types.ListOffersResponse object, and provides an __iter__ method to iterate through its offers field.

If there are more pages, the __iter__ method will make additional ListOffers requests and continue to iterate through the offers field on the corresponding responses.

All the usual google.cloud.channel_v1.types.ListOffersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.cloud.channel_v1.services.cloud_channel_service.pagers.ListProductsAsyncPager(method: Callable[[...], Awaitable[google.cloud.channel_v1.types.service.ListProductsResponse]], request: google.cloud.channel_v1.types.service.ListProductsRequest, response: google.cloud.channel_v1.types.service.ListProductsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_products requests.

This class thinly wraps an initial google.cloud.channel_v1.types.ListProductsResponse object, and provides an __aiter__ method to iterate through its products field.

If there are more pages, the __aiter__ method will make additional ListProducts requests and continue to iterate through the products field on the corresponding responses.

All the usual google.cloud.channel_v1.types.ListProductsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.channel_v1.services.cloud_channel_service.pagers.ListProductsPager(method: Callable[[...], google.cloud.channel_v1.types.service.ListProductsResponse], request: google.cloud.channel_v1.types.service.ListProductsRequest, response: google.cloud.channel_v1.types.service.ListProductsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_products requests.

This class thinly wraps an initial google.cloud.channel_v1.types.ListProductsResponse object, and provides an __iter__ method to iterate through its products field.

If there are more pages, the __iter__ method will make additional ListProducts requests and continue to iterate through the products field on the corresponding responses.

All the usual google.cloud.channel_v1.types.ListProductsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.cloud.channel_v1.services.cloud_channel_service.pagers.ListPurchasableOffersAsyncPager(method: Callable[[...], Awaitable[google.cloud.channel_v1.types.service.ListPurchasableOffersResponse]], request: google.cloud.channel_v1.types.service.ListPurchasableOffersRequest, response: google.cloud.channel_v1.types.service.ListPurchasableOffersResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_purchasable_offers requests.

This class thinly wraps an initial google.cloud.channel_v1.types.ListPurchasableOffersResponse object, and provides an __aiter__ method to iterate through its purchasable_offers field.

If there are more pages, the __aiter__ method will make additional ListPurchasableOffers requests and continue to iterate through the purchasable_offers field on the corresponding responses.

All the usual google.cloud.channel_v1.types.ListPurchasableOffersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.channel_v1.services.cloud_channel_service.pagers.ListPurchasableOffersPager(method: Callable[[...], google.cloud.channel_v1.types.service.ListPurchasableOffersResponse], request: google.cloud.channel_v1.types.service.ListPurchasableOffersRequest, response: google.cloud.channel_v1.types.service.ListPurchasableOffersResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_purchasable_offers requests.

This class thinly wraps an initial google.cloud.channel_v1.types.ListPurchasableOffersResponse object, and provides an __iter__ method to iterate through its purchasable_offers field.

If there are more pages, the __iter__ method will make additional ListPurchasableOffers requests and continue to iterate through the purchasable_offers field on the corresponding responses.

All the usual google.cloud.channel_v1.types.ListPurchasableOffersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.cloud.channel_v1.services.cloud_channel_service.pagers.ListPurchasableSkusAsyncPager(method: Callable[[...], Awaitable[google.cloud.channel_v1.types.service.ListPurchasableSkusResponse]], request: google.cloud.channel_v1.types.service.ListPurchasableSkusRequest, response: google.cloud.channel_v1.types.service.ListPurchasableSkusResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_purchasable_skus requests.

This class thinly wraps an initial google.cloud.channel_v1.types.ListPurchasableSkusResponse object, and provides an __aiter__ method to iterate through its purchasable_skus field.

If there are more pages, the __aiter__ method will make additional ListPurchasableSkus requests and continue to iterate through the purchasable_skus field on the corresponding responses.

All the usual google.cloud.channel_v1.types.ListPurchasableSkusResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.channel_v1.services.cloud_channel_service.pagers.ListPurchasableSkusPager(method: Callable[[...], google.cloud.channel_v1.types.service.ListPurchasableSkusResponse], request: google.cloud.channel_v1.types.service.ListPurchasableSkusRequest, response: google.cloud.channel_v1.types.service.ListPurchasableSkusResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_purchasable_skus requests.

This class thinly wraps an initial google.cloud.channel_v1.types.ListPurchasableSkusResponse object, and provides an __iter__ method to iterate through its purchasable_skus field.

If there are more pages, the __iter__ method will make additional ListPurchasableSkus requests and continue to iterate through the purchasable_skus field on the corresponding responses.

All the usual google.cloud.channel_v1.types.ListPurchasableSkusResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.cloud.channel_v1.services.cloud_channel_service.pagers.ListSkusAsyncPager(method: Callable[[...], Awaitable[google.cloud.channel_v1.types.service.ListSkusResponse]], request: google.cloud.channel_v1.types.service.ListSkusRequest, response: google.cloud.channel_v1.types.service.ListSkusResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_skus requests.

This class thinly wraps an initial google.cloud.channel_v1.types.ListSkusResponse object, and provides an __aiter__ method to iterate through its skus field.

If there are more pages, the __aiter__ method will make additional ListSkus requests and continue to iterate through the skus field on the corresponding responses.

All the usual google.cloud.channel_v1.types.ListSkusResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.channel_v1.services.cloud_channel_service.pagers.ListSkusPager(method: Callable[[...], google.cloud.channel_v1.types.service.ListSkusResponse], request: google.cloud.channel_v1.types.service.ListSkusRequest, response: google.cloud.channel_v1.types.service.ListSkusResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_skus requests.

This class thinly wraps an initial google.cloud.channel_v1.types.ListSkusResponse object, and provides an __iter__ method to iterate through its skus field.

If there are more pages, the __iter__ method will make additional ListSkus requests and continue to iterate through the skus field on the corresponding responses.

All the usual google.cloud.channel_v1.types.ListSkusResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.cloud.channel_v1.services.cloud_channel_service.pagers.ListSubscribersAsyncPager(method: Callable[[...], Awaitable[google.cloud.channel_v1.types.service.ListSubscribersResponse]], request: google.cloud.channel_v1.types.service.ListSubscribersRequest, response: google.cloud.channel_v1.types.service.ListSubscribersResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_subscribers requests.

This class thinly wraps an initial google.cloud.channel_v1.types.ListSubscribersResponse object, and provides an __aiter__ method to iterate through its service_accounts field.

If there are more pages, the __aiter__ method will make additional ListSubscribers requests and continue to iterate through the service_accounts field on the corresponding responses.

All the usual google.cloud.channel_v1.types.ListSubscribersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.channel_v1.services.cloud_channel_service.pagers.ListSubscribersPager(method: Callable[[...], google.cloud.channel_v1.types.service.ListSubscribersResponse], request: google.cloud.channel_v1.types.service.ListSubscribersRequest, response: google.cloud.channel_v1.types.service.ListSubscribersResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_subscribers requests.

This class thinly wraps an initial google.cloud.channel_v1.types.ListSubscribersResponse object, and provides an __iter__ method to iterate through its service_accounts field.

If there are more pages, the __iter__ method will make additional ListSubscribers requests and continue to iterate through the service_accounts field on the corresponding responses.

All the usual google.cloud.channel_v1.types.ListSubscribersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.cloud.channel_v1.services.cloud_channel_service.pagers.ListTransferableOffersAsyncPager(method: Callable[[...], Awaitable[google.cloud.channel_v1.types.service.ListTransferableOffersResponse]], request: google.cloud.channel_v1.types.service.ListTransferableOffersRequest, response: google.cloud.channel_v1.types.service.ListTransferableOffersResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_transferable_offers requests.

This class thinly wraps an initial google.cloud.channel_v1.types.ListTransferableOffersResponse object, and provides an __aiter__ method to iterate through its transferable_offers field.

If there are more pages, the __aiter__ method will make additional ListTransferableOffers requests and continue to iterate through the transferable_offers field on the corresponding responses.

All the usual google.cloud.channel_v1.types.ListTransferableOffersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.channel_v1.services.cloud_channel_service.pagers.ListTransferableOffersPager(method: Callable[[...], google.cloud.channel_v1.types.service.ListTransferableOffersResponse], request: google.cloud.channel_v1.types.service.ListTransferableOffersRequest, response: google.cloud.channel_v1.types.service.ListTransferableOffersResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_transferable_offers requests.

This class thinly wraps an initial google.cloud.channel_v1.types.ListTransferableOffersResponse object, and provides an __iter__ method to iterate through its transferable_offers field.

If there are more pages, the __iter__ method will make additional ListTransferableOffers requests and continue to iterate through the transferable_offers field on the corresponding responses.

All the usual google.cloud.channel_v1.types.ListTransferableOffersResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.cloud.channel_v1.services.cloud_channel_service.pagers.ListTransferableSkusAsyncPager(method: Callable[[...], Awaitable[google.cloud.channel_v1.types.service.ListTransferableSkusResponse]], request: google.cloud.channel_v1.types.service.ListTransferableSkusRequest, response: google.cloud.channel_v1.types.service.ListTransferableSkusResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_transferable_skus requests.

This class thinly wraps an initial google.cloud.channel_v1.types.ListTransferableSkusResponse object, and provides an __aiter__ method to iterate through its transferable_skus field.

If there are more pages, the __aiter__ method will make additional ListTransferableSkus requests and continue to iterate through the transferable_skus field on the corresponding responses.

All the usual google.cloud.channel_v1.types.ListTransferableSkusResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.channel_v1.services.cloud_channel_service.pagers.ListTransferableSkusPager(method: Callable[[...], google.cloud.channel_v1.types.service.ListTransferableSkusResponse], request: google.cloud.channel_v1.types.service.ListTransferableSkusRequest, response: google.cloud.channel_v1.types.service.ListTransferableSkusResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_transferable_skus requests.

This class thinly wraps an initial google.cloud.channel_v1.types.ListTransferableSkusResponse object, and provides an __iter__ method to iterate through its transferable_skus field.

If there are more pages, the __iter__ method will make additional ListTransferableSkus requests and continue to iterate through the transferable_skus field on the corresponding responses.

All the usual google.cloud.channel_v1.types.ListTransferableSkusResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters