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: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.channel_v1.services.cloud_channel_service.transports.base.CloudChannelServiceTransport, typing.Callable[[...], google.cloud.channel_v1.services.cloud_channel_service.transports.base.CloudChannelServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

CloudChannelService 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 async 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 (Optional[Union[str,CloudChannelServiceTransport,Callable[..., CloudChannelServiceTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the CloudChannelServiceTransport constructor. If set to None, a transport is chosen automatically.

• client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –

  Custom options for the client.

  1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “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).

  2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS 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.

  3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.

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

async activate_entitlement(request: Optional[Union[google.cloud.channel_v1.types.service.ActivateEntitlementRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_activate_entitlement():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    request = channel_v1.ActivateEntitlementRequest(
        name="name_value",
    )

    # Make the request
    operation = client.activate_entitlement(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.ActivateEntitlementRequest, dict]]) – The request object. Request message for [CloudChannelService.ActivateEntitlement][google.cloud.channel.v1.CloudChannelService.ActivateEntitlement].

• retry (google.api_core.retry_async.AsyncRetry) – 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

property api_endpoint

Return the API endpoint used by the client instance.

Returns

The API endpoint used by the client instance.

Return type

str

static billing_account_path(account: str, billing_account: str) → str

Returns a fully-qualified billing_account string.

async cancel_entitlement(request: Optional[Union[google.cloud.channel_v1.types.service.CancelEntitlementRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_cancel_entitlement():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    request = channel_v1.CancelEntitlementRequest(
        name="name_value",
    )

    # Make the request
    operation = client.cancel_entitlement(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.CancelEntitlementRequest, dict]]) – The request object. Request message for [CloudChannelService.CancelEntitlement][google.cloud.channel.v1.CloudChannelService.CancelEntitlement].

• retry (google.api_core.retry_async.AsyncRetry) – 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);

}

Return type

google.api_core.operation_async.AsyncOperation

async cancel_operation(request: Optional[google.longrunning.operations_pb2.CancelOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters

• request (CancelOperationRequest) – The request object. Request message for CancelOperation method.

• retry (google.api_core.retry_async.AsyncRetry) – 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

None

async change_offer(request: Optional[Union[google.cloud.channel_v1.types.service.ChangeOfferRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_change_offer():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    request = channel_v1.ChangeOfferRequest(
        name="name_value",
        offer="offer_value",
    )

    # Make the request
    operation = client.change_offer(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

• request (Optional[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_async.AsyncRetry) – 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[Union[google.cloud.channel_v1.types.service.ChangeParametersRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_change_parameters():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    request = channel_v1.ChangeParametersRequest(
        name="name_value",
    )

    # Make the request
    operation = client.change_parameters(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.ChangeParametersRequest, dict]]) – The request object. Request message for [CloudChannelService.ChangeParametersRequest][].

• retry (google.api_core.retry_async.AsyncRetry) – 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_renewal_settings(request: Optional[Union[google.cloud.channel_v1.types.service.ChangeRenewalSettingsRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_change_renewal_settings():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    request = channel_v1.ChangeRenewalSettingsRequest(
        name="name_value",
    )

    # Make the request
    operation = client.change_renewal_settings(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.ChangeRenewalSettingsRequest, dict]]) – The request object. Request message for [CloudChannelService.ChangeRenewalSettings][google.cloud.channel.v1.CloudChannelService.ChangeRenewalSettings].

• retry (google.api_core.retry_async.AsyncRetry) – 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 channel_partner_link_path(account: str, channel_partner_link: str) → str

Returns a fully-qualified channel_partner_link string.

static channel_partner_repricing_config_path(account: str, channel_partner: str, channel_partner_repricing_config: str) → str

Returns a fully-qualified channel_partner_repricing_config string.

async check_cloud_identity_accounts_exist(request: Optional[Union[google.cloud.channel_v1.types.service.CheckCloudIdentityAccountsExistRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.types.service.CheckCloudIdentityAccountsExistResponse

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_check_cloud_identity_accounts_exist():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    request = channel_v1.CheckCloudIdentityAccountsExistRequest(
        parent="parent_value",
        domain="domain_value",
    )

    # Make the request
    response = await client.check_cloud_identity_accounts_exist(request=request)

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.CheckCloudIdentityAccountsExistRequest, dict]]) – The request object. Request message for [CloudChannelService.CheckCloudIdentityAccountsExist][google.cloud.channel.v1.CloudChannelService.CheckCloudIdentityAccountsExist].

• retry (google.api_core.retry_async.AsyncRetry) – 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.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.

async create_channel_partner_link(request: Optional[Union[google.cloud.channel_v1.types.service.CreateChannelPartnerLinkRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.types.channel_partner_links.ChannelPartnerLink

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_create_channel_partner_link():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    channel_partner_link = channel_v1.ChannelPartnerLink()
    channel_partner_link.reseller_cloud_identity_id = "reseller_cloud_identity_id_value"
    channel_partner_link.link_state = "SUSPENDED"

    request = channel_v1.CreateChannelPartnerLinkRequest(
        parent="parent_value",
        channel_partner_link=channel_partner_link,
    )

    # Make the request
    response = await client.create_channel_partner_link(request=request)

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.CreateChannelPartnerLinkRequest, dict]]) – The request object. Request message for [CloudChannelService.CreateChannelPartnerLink][google.cloud.channel.v1.CloudChannelService.CreateChannelPartnerLink]

• retry (google.api_core.retry_async.AsyncRetry) – 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 link between distributors and their indirect resellers in an n-tier resale channel.

Return type

google.cloud.channel_v1.types.ChannelPartnerLink

async create_channel_partner_repricing_config(request: Optional[Union[google.cloud.channel_v1.types.service.CreateChannelPartnerRepricingConfigRequest, dict]] = None, *, parent: Optional[str] = None, channel_partner_repricing_config: Optional[google.cloud.channel_v1.types.repricing.ChannelPartnerRepricingConfig] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.types.repricing.ChannelPartnerRepricingConfig

Creates a ChannelPartnerRepricingConfig. Call this method to set modifications for a specific ChannelPartner’s bill. You can only create configs if the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is a future month. If needed, you can create a config for the current month, with some restrictions.

When creating a config for a future month, make sure there are no existing configs for that [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].

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

• This functionality is reserved for recovering from an erroneous config, and should not be used for regular business cases.

• The new config will not modify exports used with other configs. Changes to the config may be immediate, but may take up to 24 hours.

• There is a limit of ten configs for any ChannelPartner or [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement], for any [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].

• The contained [ChannelPartnerRepricingConfig.repricing_config][google.cloud.channel.v1.ChannelPartnerRepricingConfig.repricing_config] value must be different from the value used in the current config for a ChannelPartner.

Possible Error Codes:

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

• INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.

• NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] specified does not exist or is not associated with the given account.

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

Return Value: If successful, the updated [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resource, otherwise returns an error.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_create_channel_partner_repricing_config():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    channel_partner_repricing_config = channel_v1.ChannelPartnerRepricingConfig()
    channel_partner_repricing_config.repricing_config.rebilling_basis = "DIRECT_CUSTOMER_COST"

    request = channel_v1.CreateChannelPartnerRepricingConfigRequest(
        parent="parent_value",
        channel_partner_repricing_config=channel_partner_repricing_config,
    )

    # Make the request
    response = await client.create_channel_partner_repricing_config(request=request)

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.CreateChannelPartnerRepricingConfigRequest, dict]]) – The request object. Request message for [CloudChannelService.CreateChannelPartnerRepricingConfig][google.cloud.channel.v1.CloudChannelService.CreateChannelPartnerRepricingConfig].

• parent (str) –

  Required. The resource name of the ChannelPartner that will receive the repricing config. Parent uses the format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}

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

• channel_partner_repricing_config (google.cloud.channel_v1.types.ChannelPartnerRepricingConfig) –

  Required. The ChannelPartnerRepricingConfig object to update.

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

• retry (google.api_core.retry_async.AsyncRetry) – 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

Configuration for how a distributor will rebill a channel partner (also known as a distributor-authorized reseller).

Return type

google.cloud.channel_v1.types.ChannelPartnerRepricingConfig

async create_customer(request: Optional[Union[google.cloud.channel_v1.types.service.CreateCustomerRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.types.customers.Customer

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.

  • You are not authorized to create a customer. See https://support.google.com/channelservices/answer/9759265

• INVALID_ARGUMENT:

  • Required request parameters are missing or invalid.

  • Domain field value doesn’t match the primary email domain.

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_create_customer():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    customer = channel_v1.Customer()
    customer.org_display_name = "org_display_name_value"
    customer.domain = "domain_value"

    request = channel_v1.CreateCustomerRequest(
        parent="parent_value",
        customer=customer,
    )

    # Make the request
    response = await client.create_customer(request=request)

    # Handle the response
    print(response)

Parameters

• request (Optional[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_async.AsyncRetry) – 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_customer_repricing_config(request: Optional[Union[google.cloud.channel_v1.types.service.CreateCustomerRepricingConfigRequest, dict]] = None, *, parent: Optional[str] = None, customer_repricing_config: Optional[google.cloud.channel_v1.types.repricing.CustomerRepricingConfig] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.types.repricing.CustomerRepricingConfig

Creates a CustomerRepricingConfig. Call this method to set modifications for a specific customer’s bill. You can only create configs if the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is a future month. If needed, you can create a config for the current month, with some restrictions.

When creating a config for a future month, make sure there are no existing configs for that [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].

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

• This functionality is reserved for recovering from an erroneous config, and should not be used for regular business cases.

• The new config will not modify exports used with other configs. Changes to the config may be immediate, but may take up to 24 hours.

• There is a limit of ten configs for any [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement], for any [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].

• The contained [CustomerRepricingConfig.repricing_config][google.cloud.channel.v1.CustomerRepricingConfig.repricing_config] value must be different from the value used in the current config for a [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement].

Possible Error Codes:

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

• INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.

• NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] specified does not exist or is not associated with the given account.

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

Return Value: If successful, the updated [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resource, otherwise returns an error.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_create_customer_repricing_config():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    customer_repricing_config = channel_v1.CustomerRepricingConfig()
    customer_repricing_config.repricing_config.rebilling_basis = "DIRECT_CUSTOMER_COST"

    request = channel_v1.CreateCustomerRepricingConfigRequest(
        parent="parent_value",
        customer_repricing_config=customer_repricing_config,
    )

    # Make the request
    response = await client.create_customer_repricing_config(request=request)

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.CreateCustomerRepricingConfigRequest, dict]]) – The request object. Request message for [CloudChannelService.CreateCustomerRepricingConfig][google.cloud.channel.v1.CloudChannelService.CreateCustomerRepricingConfig].

• parent (str) –

  Required. The resource name of the customer that will receive this repricing config. Parent uses the format: accounts/{account_id}/customers/{customer_id}

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

• customer_repricing_config (google.cloud.channel_v1.types.CustomerRepricingConfig) –

  Required. The CustomerRepricingConfig object to update.

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

• retry (google.api_core.retry_async.AsyncRetry) – 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

Configuration for how a reseller will reprice a Customer.

Return type

google.cloud.channel_v1.types.CustomerRepricingConfig

async create_entitlement(request: Optional[Union[google.cloud.channel_v1.types.service.CreateEntitlementRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation

Creates an entitlement for a customer.

Possible error codes:

• PERMISSION_DENIED:

  • The customer doesn’t belong to the reseller.

  • The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265

• INVALID_ARGUMENT:

  • Required request parameters are missing or invalid.

  • There is already a customer entitlement for a SKU from the same product family.

• INVALID_VALUE: Make sure the OfferId is valid. If it is, contact Google Channel support for further troubleshooting.

• NOT_FOUND: The customer or offer resource was not found.

• ALREADY_EXISTS:

  • The SKU was already purchased for the customer.

  • The customer’s primary email already exists. Retry after changing the customer’s primary contact email.

• CONDITION_NOT_MET or FAILED_PRECONDITION:

  • The domain required for purchasing a SKU has not been verified.

  • A pre-requisite SKU required to purchase an Add-On SKU is missing. For example, Google Workspace Business Starter is required to purchase Vault or Drive.

  • (Developer accounts only) Reseller and resold domain must meet the following naming requirements:

    • Domain names must start with goog-test.

    • Domain names must include the reseller domain.

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

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

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

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_create_entitlement():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    entitlement = channel_v1.Entitlement()
    entitlement.offer = "offer_value"

    request = channel_v1.CreateEntitlementRequest(
        parent="parent_value",
        entitlement=entitlement,
    )

    # Make the request
    operation = client.create_entitlement(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.CreateEntitlementRequest, dict]]) – The request object. Request message for [CloudChannelService.CreateEntitlement][google.cloud.channel.v1.CloudChannelService.CreateEntitlement]

• retry (google.api_core.retry_async.AsyncRetry) – 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.

static customer_repricing_config_path(account: str, customer: str, customer_repricing_config: str) → str

Returns a fully-qualified customer_repricing_config string.

async delete_channel_partner_repricing_config(request: Optional[Union[google.cloud.channel_v1.types.service.DeleteChannelPartnerRepricingConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None

Deletes the given [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] permanently. You can only delete configs if their [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is set to a date after the current month.

Possible error codes:

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

• INVALID_ARGUMENT: Required request parameters are missing or invalid.

• FAILED_PRECONDITION: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] is active or in the past.

• NOT_FOUND: No [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] found for the name in the request.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_delete_channel_partner_repricing_config():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    request = channel_v1.DeleteChannelPartnerRepricingConfigRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_channel_partner_repricing_config(request=request)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.DeleteChannelPartnerRepricingConfigRequest, dict]]) – The request object. Request message for DeleteChannelPartnerRepricingConfig.

• name (str) –

  Required. The resource name of the channel partner repricing config rule 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_async.AsyncRetry) – 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.

async delete_customer(request: Optional[Union[google.cloud.channel_v1.types.service.DeleteCustomerRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_delete_customer():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    request = channel_v1.DeleteCustomerRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_customer(request=request)

Parameters

• request (Optional[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_async.AsyncRetry) – 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.

async delete_customer_repricing_config(request: Optional[Union[google.cloud.channel_v1.types.service.DeleteCustomerRepricingConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None

Deletes the given [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] permanently. You can only delete configs if their [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is set to a date after the current month.

Possible error codes:

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

• INVALID_ARGUMENT: Required request parameters are missing or invalid.

• FAILED_PRECONDITION: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] is active or in the past.

• NOT_FOUND: No [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] found for the name in the request.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_delete_customer_repricing_config():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    request = channel_v1.DeleteCustomerRepricingConfigRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_customer_repricing_config(request=request)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.DeleteCustomerRepricingConfigRequest, dict]]) – The request object. Request message for [CloudChannelService.DeleteCustomerRepricingConfig][google.cloud.channel.v1.CloudChannelService.DeleteCustomerRepricingConfig].

• name (str) –

  Required. The resource name of the customer repricing config rule to delete. Format: accounts/{account_id}/customers/{customer_id}/customerRepricingConfigs/{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_async.AsyncRetry) – 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.

async delete_operation(request: Optional[google.longrunning.operations_pb2.DeleteOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters

• request (DeleteOperationRequest) – The request object. Request message for DeleteOperation method.

• retry (google.api_core.retry_async.AsyncRetry) – 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

None

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)

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)

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

async get_channel_partner_link(request: Optional[Union[google.cloud.channel_v1.types.service.GetChannelPartnerLinkRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.types.channel_partner_links.ChannelPartnerLink

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_get_channel_partner_link():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    request = channel_v1.GetChannelPartnerLinkRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_channel_partner_link(request=request)

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.GetChannelPartnerLinkRequest, dict]]) – The request object. Request message for [CloudChannelService.GetChannelPartnerLink][google.cloud.channel.v1.CloudChannelService.GetChannelPartnerLink].

• retry (google.api_core.retry_async.AsyncRetry) – 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 link between distributors and their indirect resellers in an n-tier resale channel.

Return type

google.cloud.channel_v1.types.ChannelPartnerLink

async get_channel_partner_repricing_config(request: Optional[Union[google.cloud.channel_v1.types.service.GetChannelPartnerRepricingConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.types.repricing.ChannelPartnerRepricingConfig

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

Possible Error Codes:

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

• NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] was not found.

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

Return Value: If successful, the [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resource, otherwise returns an error.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_get_channel_partner_repricing_config():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    request = channel_v1.GetChannelPartnerRepricingConfigRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_channel_partner_repricing_config(request=request)

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.GetChannelPartnerRepricingConfigRequest, dict]]) – The request object. Request message for [CloudChannelService.GetChannelPartnerRepricingConfig][google.cloud.channel.v1.CloudChannelService.GetChannelPartnerRepricingConfig]

• name (str) –

  Required. The resource name of the ChannelPartnerRepricingConfig Format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}/channelPartnerRepricingConfigs/{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_async.AsyncRetry) – 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

Configuration for how a distributor will rebill a channel partner (also known as a distributor-authorized reseller).

Return type

google.cloud.channel_v1.types.ChannelPartnerRepricingConfig

async get_customer(request: Optional[Union[google.cloud.channel_v1.types.service.GetCustomerRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.types.customers.Customer

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_get_customer():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    request = channel_v1.GetCustomerRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_customer(request=request)

    # Handle the response
    print(response)

Parameters

• request (Optional[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_async.AsyncRetry) – 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_customer_repricing_config(request: Optional[Union[google.cloud.channel_v1.types.service.GetCustomerRepricingConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.types.repricing.CustomerRepricingConfig

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

Possible Error Codes:

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

• NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] was not found.

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

Return Value: If successful, the [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resource, otherwise returns an error.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_get_customer_repricing_config():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    request = channel_v1.GetCustomerRepricingConfigRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_customer_repricing_config(request=request)

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.GetCustomerRepricingConfigRequest, dict]]) – The request object. Request message for [CloudChannelService.GetCustomerRepricingConfig][google.cloud.channel.v1.CloudChannelService.GetCustomerRepricingConfig].

• name (str) –

  Required. The resource name of the CustomerRepricingConfig. Format: accounts/{account_id}/customers/{customer_id}/customerRepricingConfigs/{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_async.AsyncRetry) – 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

Configuration for how a reseller will reprice a Customer.

Return type

google.cloud.channel_v1.types.CustomerRepricingConfig

async get_entitlement(request: Optional[Union[google.cloud.channel_v1.types.service.GetEntitlementRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.types.entitlements.Entitlement

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_get_entitlement():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    request = channel_v1.GetEntitlementRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_entitlement(request=request)

    # Handle the response
    print(response)

Parameters

• request (Optional[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_async.AsyncRetry) – 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

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the

client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

async get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

Parameters

• request (GetOperationRequest) – The request object. Request message for GetOperation method.

• retry (google.api_core.retry_async.AsyncRetry) – 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 Operation object.

Return type

Operation

classmethod get_transport_class(label: Optional[str] = None) → 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[Union[google.cloud.channel_v1.types.service.ImportCustomerRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.types.customers.Customer

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.

  • You are not authorized to import the customer. See https://support.google.com/channelservices/answer/9759265

• NOT_FOUND: Cloud Identity doesn’t exist or was deleted.

• INVALID_ARGUMENT: Required parameters are missing, or the auth_token is expired or invalid.

• ALREADY_EXISTS: A customer already exists and has conflicting critical fields. Requires an overwrite.

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_import_customer():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    request = channel_v1.ImportCustomerRequest(
        domain="domain_value",
        parent="parent_value",
        overwrite_if_exists=True,
    )

    # Make the request
    response = await client.import_customer(request=request)

    # Handle the response
    print(response)

Parameters

• request (Optional[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_async.AsyncRetry) – 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 list_channel_partner_links(request: Optional[Union[google.cloud.channel_v1.types.service.ListChannelPartnerLinksRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.services.cloud_channel_service.pagers.ListChannelPartnerLinksAsyncPager

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_list_channel_partner_links():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    request = channel_v1.ListChannelPartnerLinksRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_channel_partner_links(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.ListChannelPartnerLinksRequest, dict]]) – The request object. Request message for [CloudChannelService.ListChannelPartnerLinks][google.cloud.channel.v1.CloudChannelService.ListChannelPartnerLinks]

• retry (google.api_core.retry_async.AsyncRetry) – 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.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_channel_partner_repricing_configs(request: Optional[Union[google.cloud.channel_v1.types.service.ListChannelPartnerRepricingConfigsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.services.cloud_channel_service.pagers.ListChannelPartnerRepricingConfigsAsyncPager

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

Possible Error Codes:

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

• NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] specified does not exist or is not associated with the given account.

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

Return Value: If successful, the [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resources. The data for each resource is displayed in the ascending order of:

• Channel Partner ID

• [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month]

• [ChannelPartnerRepricingConfig.update_time][google.cloud.channel.v1.ChannelPartnerRepricingConfig.update_time]

If unsuccessful, returns an error.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_list_channel_partner_repricing_configs():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    request = channel_v1.ListChannelPartnerRepricingConfigsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_channel_partner_repricing_configs(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.ListChannelPartnerRepricingConfigsRequest, dict]]) – The request object. Request message for [CloudChannelService.ListChannelPartnerRepricingConfigs][google.cloud.channel.v1.CloudChannelService.ListChannelPartnerRepricingConfigs].

• parent (str) –

  Required. The resource name of the account’s [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]. Parent uses the format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}. Supports accounts/{account_id}/channelPartnerLinks/- to retrieve configs for all channel partners.

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

• retry (google.api_core.retry_async.AsyncRetry) – 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.ListChannelPartnerRepricingConfigs][google.cloud.channel.v1.CloudChannelService.ListChannelPartnerRepricingConfigs].

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

Return type

google.cloud.channel_v1.services.cloud_channel_service.pagers.ListChannelPartnerRepricingConfigsAsyncPager

async list_customer_repricing_configs(request: Optional[Union[google.cloud.channel_v1.types.service.ListCustomerRepricingConfigsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.services.cloud_channel_service.pagers.ListCustomerRepricingConfigsAsyncPager

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

Possible Error Codes:

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

• NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] specified does not exist or is not associated with the given account.

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

Return Value: If successful, the [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resources. The data for each resource is displayed in the ascending order of:

• Customer ID

• [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement]

• [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month]

• [CustomerRepricingConfig.update_time][google.cloud.channel.v1.CustomerRepricingConfig.update_time]

If unsuccessful, returns an error.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_list_customer_repricing_configs():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    request = channel_v1.ListCustomerRepricingConfigsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_customer_repricing_configs(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.ListCustomerRepricingConfigsRequest, dict]]) – The request object. Request message for [CloudChannelService.ListCustomerRepricingConfigs][google.cloud.channel.v1.CloudChannelService.ListCustomerRepricingConfigs].

• parent (str) –

  Required. The resource name of the customer. Parent uses the format: accounts/{account_id}/customers/{customer_id}. Supports accounts/{account_id}/customers/- to retrieve configs for all customers.

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

• retry (google.api_core.retry_async.AsyncRetry) – 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.ListCustomerRepricingConfigs][google.cloud.channel.v1.CloudChannelService.ListCustomerRepricingConfigs].

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

Return type

google.cloud.channel_v1.services.cloud_channel_service.pagers.ListCustomerRepricingConfigsAsyncPager

async list_customers(request: Optional[Union[google.cloud.channel_v1.types.service.ListCustomersRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.services.cloud_channel_service.pagers.ListCustomersAsyncPager

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_list_customers():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    request = channel_v1.ListCustomersRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_customers(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

• request (Optional[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_async.AsyncRetry) – 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_entitlement_changes(request: Optional[Union[google.cloud.channel_v1.types.service.ListEntitlementChangesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.services.cloud_channel_service.pagers.ListEntitlementChangesAsyncPager

List entitlement history.

Possible error codes:

• PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different.

• INVALID_ARGUMENT: Missing or invalid required fields in the request.

• NOT_FOUND: The parent resource doesn’t exist. Usually the result of an invalid name parameter.

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

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

Return value: List of [EntitlementChange][google.cloud.channel.v1.EntitlementChange]s.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_list_entitlement_changes():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    request = channel_v1.ListEntitlementChangesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_entitlement_changes(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.ListEntitlementChangesRequest, dict]]) – The request object. Request message for [CloudChannelService.ListEntitlementChanges][google.cloud.channel.v1.CloudChannelService.ListEntitlementChanges]

• parent (str) –

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

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

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

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

• retry (google.api_core.retry_async.AsyncRetry) – 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.ListEntitlementChanges][google.cloud.channel.v1.CloudChannelService.ListEntitlementChanges]

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

Return type

google.cloud.channel_v1.services.cloud_channel_service.pagers.ListEntitlementChangesAsyncPager

async list_entitlements(request: Optional[Union[google.cloud.channel_v1.types.service.ListEntitlementsRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.services.cloud_channel_service.pagers.ListEntitlementsAsyncPager

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_list_entitlements():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    request = channel_v1.ListEntitlementsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_entitlements(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.ListEntitlementsRequest, dict]]) – The request object. Request message for [CloudChannelService.ListEntitlements][google.cloud.channel.v1.CloudChannelService.ListEntitlements]

• retry (google.api_core.retry_async.AsyncRetry) – 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[Union[google.cloud.channel_v1.types.service.ListOffersRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.services.cloud_channel_service.pagers.ListOffersAsyncPager

Lists the Offers the reseller can sell.

Possible error codes:

• INVALID_ARGUMENT: Required request parameters are missing or invalid.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_list_offers():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    request = channel_v1.ListOffersRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_offers(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.ListOffersRequest, dict]]) – The request object. Request message for ListOffers.

• retry (google.api_core.retry_async.AsyncRetry) – 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 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_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

Parameters

• request (ListOperationsRequest) – The request object. Request message for ListOperations method.

• retry (google.api_core.retry_async.AsyncRetry) – 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 ListOperations method.

Return type

ListOperationsResponse

async list_products(request: Optional[Union[google.cloud.channel_v1.types.service.ListProductsRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.services.cloud_channel_service.pagers.ListProductsAsyncPager

Lists the Products the reseller is authorized to sell.

Possible error codes:

• INVALID_ARGUMENT: Required request parameters are missing or invalid.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_list_products():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    request = channel_v1.ListProductsRequest(
        account="account_value",
    )

    # Make the request
    page_result = client.list_products(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.ListProductsRequest, dict]]) – The request object. Request message for ListProducts.

• retry (google.api_core.retry_async.AsyncRetry) – 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 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[Union[google.cloud.channel_v1.types.service.ListPurchasableOffersRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.services.cloud_channel_service.pagers.ListPurchasableOffersAsyncPager

Lists the following:

• Offers that you can purchase for a customer.

• Offers that you can change for an entitlement.

Possible error codes:

• PERMISSION_DENIED:

  • The customer doesn’t belong to the reseller

  • The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265

• INVALID_ARGUMENT: Required request parameters are missing or invalid.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_list_purchasable_offers():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    create_entitlement_purchase = channel_v1.CreateEntitlementPurchase()
    create_entitlement_purchase.sku = "sku_value"

    request = channel_v1.ListPurchasableOffersRequest(
        create_entitlement_purchase=create_entitlement_purchase,
        customer="customer_value",
    )

    # Make the request
    page_result = client.list_purchasable_offers(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.ListPurchasableOffersRequest, dict]]) – The request object. Request message for ListPurchasableOffers.

• retry (google.api_core.retry_async.AsyncRetry) – 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 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[Union[google.cloud.channel_v1.types.service.ListPurchasableSkusRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.services.cloud_channel_service.pagers.ListPurchasableSkusAsyncPager

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_list_purchasable_skus():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    create_entitlement_purchase = channel_v1.CreateEntitlementPurchase()
    create_entitlement_purchase.product = "product_value"

    request = channel_v1.ListPurchasableSkusRequest(
        create_entitlement_purchase=create_entitlement_purchase,
        customer="customer_value",
    )

    # Make the request
    page_result = client.list_purchasable_skus(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.ListPurchasableSkusRequest, dict]]) – The request object. Request message for ListPurchasableSkus.

• retry (google.api_core.retry_async.AsyncRetry) – 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 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_sku_group_billable_skus(request: Optional[Union[google.cloud.channel_v1.types.service.ListSkuGroupBillableSkusRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.services.cloud_channel_service.pagers.ListSkuGroupBillableSkusAsyncPager

Lists the Billable SKUs in a given SKU group.

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

Return Value: If successful, the [BillableSku][google.cloud.channel.v1.BillableSku] resources. The data for each resource is displayed in the ascending order of:

• [BillableSku.service_display_name][google.cloud.channel.v1.BillableSku.service_display_name]

• [BillableSku.sku_display_name][google.cloud.channel.v1.BillableSku.sku_display_name]

If unsuccessful, returns an error.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_list_sku_group_billable_skus():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    request = channel_v1.ListSkuGroupBillableSkusRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_sku_group_billable_skus(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.ListSkuGroupBillableSkusRequest, dict]]) – The request object. Request message for ListSkuGroupBillableSkus.

• parent (str) –

  Required. Resource name of the SKU group. Format: accounts/{account}/skuGroups/{sku_group}.

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

• retry (google.api_core.retry_async.AsyncRetry) – 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 ListSkuGroupBillableSkus. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.channel_v1.services.cloud_channel_service.pagers.ListSkuGroupBillableSkusAsyncPager

async list_sku_groups(request: Optional[Union[google.cloud.channel_v1.types.service.ListSkuGroupsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.services.cloud_channel_service.pagers.ListSkuGroupsAsyncPager

Lists the Rebilling supported SKU groups the account is authorized to sell. Reference: https://cloud.google.com/skus/sku-groups

Possible Error Codes:

• PERMISSION_DENIED: If the account making the request and the account being queried are different, or the account doesn’t exist.

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

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

If unsuccessful, returns an error.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_list_sku_groups():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    request = channel_v1.ListSkuGroupsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_sku_groups(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.ListSkuGroupsRequest, dict]]) – The request object. Request message for ListSkuGroups.

• parent (str) –

  Required. The resource name of the account from which to list SKU groups. Parent uses the format: accounts/{account}.

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

• retry (google.api_core.retry_async.AsyncRetry) – 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 ListSkuGroups.

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

Return type

google.cloud.channel_v1.services.cloud_channel_service.pagers.ListSkuGroupsAsyncPager

async list_skus(request: Optional[Union[google.cloud.channel_v1.types.service.ListSkusRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.services.cloud_channel_service.pagers.ListSkusAsyncPager

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

Possible error codes:

• INVALID_ARGUMENT: Required request parameters are missing or invalid.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_list_skus():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    request = channel_v1.ListSkusRequest(
        parent="parent_value",
        account="account_value",
    )

    # Make the request
    page_result = client.list_skus(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.ListSkusRequest, dict]]) – The request object. Request message for ListSkus.

• retry (google.api_core.retry_async.AsyncRetry) – 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 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[Union[google.cloud.channel_v1.types.service.ListSubscribersRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.services.cloud_channel_service.pagers.ListSubscribersAsyncPager

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_list_subscribers():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    request = channel_v1.ListSubscribersRequest(
        account="account_value",
    )

    # Make the request
    page_result = client.list_subscribers(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.ListSubscribersRequest, dict]]) – The request object. Request Message for ListSubscribers.

• retry (google.api_core.retry_async.AsyncRetry) – 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 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[Union[google.cloud.channel_v1.types.service.ListTransferableOffersRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.services.cloud_channel_service.pagers.ListTransferableOffersAsyncPager

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 customer provided incorrect reseller information when generating auth token.

  • The reseller account making the request is different from the reseller account in the query.

  • The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265

• INVALID_ARGUMENT: Required request parameters are missing or invalid.

Return value: List of [TransferableOffer][google.cloud.channel.v1.TransferableOffer] for the given customer and SKU.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_list_transferable_offers():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    request = channel_v1.ListTransferableOffersRequest(
        cloud_identity_id="cloud_identity_id_value",
        parent="parent_value",
        sku="sku_value",
    )

    # Make the request
    page_result = client.list_transferable_offers(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.ListTransferableOffersRequest, dict]]) – The request object. Request message for [CloudChannelService.ListTransferableOffers][google.cloud.channel.v1.CloudChannelService.ListTransferableOffers]

• retry (google.api_core.retry_async.AsyncRetry) – 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.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[Union[google.cloud.channel_v1.types.service.ListTransferableSkusRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.services.cloud_channel_service.pagers.ListTransferableSkusAsyncPager

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_list_transferable_skus():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    request = channel_v1.ListTransferableSkusRequest(
        cloud_identity_id="cloud_identity_id_value",
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_transferable_skus(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.ListTransferableSkusRequest, dict]]) – The request object. Request message for [CloudChannelService.ListTransferableSkus][google.cloud.channel.v1.CloudChannelService.ListTransferableSkus]

• retry (google.api_core.retry_async.AsyncRetry) – 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.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[Union[google.cloud.channel_v1.types.service.LookupOfferRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.types.offers.Offer

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_lookup_offer():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    request = channel_v1.LookupOfferRequest(
        entitlement="entitlement_value",
    )

    # Make the request
    response = await client.lookup_offer(request=request)

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.LookupOfferRequest, dict]]) – The request object. Request message for LookupOffer.

• retry (google.api_core.retry_async.AsyncRetry) – 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

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_billing_account_path(path: str) → Dict[str, str]

Parses a billing_account path into its component segments.

static parse_channel_partner_link_path(path: str) → Dict[str, str]

Parses a channel_partner_link path into its component segments.

static parse_channel_partner_repricing_config_path(path: str) → Dict[str, str]

Parses a channel_partner_repricing_config path into its component segments.

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_customer_repricing_config_path(path: str) → Dict[str, str]

Parses a customer_repricing_config 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_group_path(path: str) → Dict[str, str]

Parses a sku_group 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[Union[google.cloud.channel_v1.types.service.ProvisionCloudIdentityRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation

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

Possible error codes:

• PERMISSION_DENIED:

  • The customer doesn’t belong to the reseller.

  • You are not authorized to provision cloud identity id. See https://support.google.com/channelservices/answer/9759265

• INVALID_ARGUMENT: Required request parameters are missing or invalid.

• NOT_FOUND: The customer was not found.

• ALREADY_EXISTS: The customer’s primary email already exists. Retry after changing the customer’s primary contact email.

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

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

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

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata contains an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_provision_cloud_identity():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    request = channel_v1.ProvisionCloudIdentityRequest(
        customer="customer_value",
    )

    # Make the request
    operation = client.provision_cloud_identity(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.ProvisionCloudIdentityRequest, dict]]) – The request object. Request message for [CloudChannelService.ProvisionCloudIdentity][google.cloud.channel.v1.CloudChannelService.ProvisionCloudIdentity]

• retry (google.api_core.retry_async.AsyncRetry) – 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.Customer Entity representing a customer of a reseller or distributor.

Return type

google.api_core.operation_async.AsyncOperation

async query_eligible_billing_accounts(request: Optional[Union[google.cloud.channel_v1.types.service.QueryEligibleBillingAccountsRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.types.service.QueryEligibleBillingAccountsResponse

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

Possible error codes:

• PERMISSION_DENIED: The customer doesn’t belong to the reseller.

• INVALID_ARGUMENT: Required request parameters are missing or invalid.

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_query_eligible_billing_accounts():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    request = channel_v1.QueryEligibleBillingAccountsRequest(
        customer="customer_value",
        skus=['skus_value1', 'skus_value2'],
    )

    # Make the request
    response = await client.query_eligible_billing_accounts(request=request)

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.QueryEligibleBillingAccountsRequest, dict]]) – The request object. Request message for QueryEligibleBillingAccounts.

• retry (google.api_core.retry_async.AsyncRetry) – 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 QueryEligibleBillingAccounts.

Return type

google.cloud.channel_v1.types.QueryEligibleBillingAccountsResponse

async register_subscriber(request: Optional[Union[google.cloud.channel_v1.types.service.RegisterSubscriberRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.types.service.RegisterSubscriberResponse

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_register_subscriber():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    request = channel_v1.RegisterSubscriberRequest(
        account="account_value",
        service_account="service_account_value",
    )

    # Make the request
    response = await client.register_subscriber(request=request)

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.RegisterSubscriberRequest, dict]]) – The request object. Request Message for RegisterSubscriber.

• retry (google.api_core.retry_async.AsyncRetry) – 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 RegisterSubscriber.

Return type

google.cloud.channel_v1.types.RegisterSubscriberResponse

static sku_group_path(account: str, sku_group: str) → str

Returns a fully-qualified sku_group string.

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

Returns a fully-qualified sku string.

async start_paid_service(request: Optional[Union[google.cloud.channel_v1.types.service.StartPaidServiceRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_start_paid_service():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    request = channel_v1.StartPaidServiceRequest(
        name="name_value",
    )

    # Make the request
    operation = client.start_paid_service(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

• request (Optional[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_async.AsyncRetry) – 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[Union[google.cloud.channel_v1.types.service.SuspendEntitlementRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_suspend_entitlement():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    request = channel_v1.SuspendEntitlementRequest(
        name="name_value",
    )

    # Make the request
    operation = client.suspend_entitlement(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.SuspendEntitlementRequest, dict]]) – The request object. Request message for [CloudChannelService.SuspendEntitlement][google.cloud.channel.v1.CloudChannelService.SuspendEntitlement].

• retry (google.api_core.retry_async.AsyncRetry) – 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[Union[google.cloud.channel_v1.types.service.TransferEntitlementsRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation

Transfers customer entitlements to new reseller.

Possible error codes:

• PERMISSION_DENIED:

  • The customer doesn’t belong to the reseller.

  • The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265

• INVALID_ARGUMENT: Required request parameters are missing or invalid.

• NOT_FOUND: The customer or offer resource was not found.

• ALREADY_EXISTS: The SKU was already transferred for the customer.

• CONDITION_NOT_MET or FAILED_PRECONDITION:

  • The SKU requires domain verification to transfer, but the domain is not verified.

  • An Add-On SKU (example, Vault or Drive) is missing the pre-requisite SKU (example, G Suite Basic).

  • (Developer accounts only) Reseller and resold domain must meet the following naming requirements:

    • Domain names must start with goog-test.

    • Domain names must include the reseller domain.

  • Specify all transferring entitlements.

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

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

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

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_transfer_entitlements():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    entitlements = channel_v1.Entitlement()
    entitlements.offer = "offer_value"

    request = channel_v1.TransferEntitlementsRequest(
        parent="parent_value",
        entitlements=entitlements,
    )

    # Make the request
    operation = client.transfer_entitlements(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.TransferEntitlementsRequest, dict]]) – The request object. Request message for [CloudChannelService.TransferEntitlements][google.cloud.channel.v1.CloudChannelService.TransferEntitlements].

• retry (google.api_core.retry_async.AsyncRetry) – 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.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[Union[google.cloud.channel_v1.types.service.TransferEntitlementsToGoogleRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_transfer_entitlements_to_google():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    entitlements = channel_v1.Entitlement()
    entitlements.offer = "offer_value"

    request = channel_v1.TransferEntitlementsToGoogleRequest(
        parent="parent_value",
        entitlements=entitlements,
    )

    # Make the request
    operation = client.transfer_entitlements_to_google(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.TransferEntitlementsToGoogleRequest, dict]]) – The request object. Request message for [CloudChannelService.TransferEntitlementsToGoogle][google.cloud.channel.v1.CloudChannelService.TransferEntitlementsToGoogle].

• retry (google.api_core.retry_async.AsyncRetry) – 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);

}

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

property universe_domain: str

Return the universe domain used by the client instance.

Returns

The universe domain used

by the client instance.

Return type

str

async unregister_subscriber(request: Optional[Union[google.cloud.channel_v1.types.service.UnregisterSubscriberRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.types.service.UnregisterSubscriberResponse

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_unregister_subscriber():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    request = channel_v1.UnregisterSubscriberRequest(
        account="account_value",
        service_account="service_account_value",
    )

    # Make the request
    response = await client.unregister_subscriber(request=request)

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.UnregisterSubscriberRequest, dict]]) – The request object. Request Message for UnregisterSubscriber.

• retry (google.api_core.retry_async.AsyncRetry) – 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 UnregisterSubscriber.

Return type

google.cloud.channel_v1.types.UnregisterSubscriberResponse

async update_channel_partner_link(request: Optional[Union[google.cloud.channel_v1.types.service.UpdateChannelPartnerLinkRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.types.channel_partner_links.ChannelPartnerLink

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_update_channel_partner_link():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    channel_partner_link = channel_v1.ChannelPartnerLink()
    channel_partner_link.reseller_cloud_identity_id = "reseller_cloud_identity_id_value"
    channel_partner_link.link_state = "SUSPENDED"

    request = channel_v1.UpdateChannelPartnerLinkRequest(
        name="name_value",
        channel_partner_link=channel_partner_link,
    )

    # Make the request
    response = await client.update_channel_partner_link(request=request)

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.UpdateChannelPartnerLinkRequest, dict]]) – The request object. Request message for [CloudChannelService.UpdateChannelPartnerLink][google.cloud.channel.v1.CloudChannelService.UpdateChannelPartnerLink]

• retry (google.api_core.retry_async.AsyncRetry) – 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 link between distributors and their indirect resellers in an n-tier resale channel.

Return type

google.cloud.channel_v1.types.ChannelPartnerLink

async update_channel_partner_repricing_config(request: Optional[Union[google.cloud.channel_v1.types.service.UpdateChannelPartnerRepricingConfigRequest, dict]] = None, *, channel_partner_repricing_config: Optional[google.cloud.channel_v1.types.repricing.ChannelPartnerRepricingConfig] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.types.repricing.ChannelPartnerRepricingConfig

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

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

When updating a config in the future:

• This config must already exist.

Possible Error Codes:

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

• INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.

• NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] specified does not exist or is not associated with the given account.

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

Return Value: If successful, the updated [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resource, otherwise returns an error.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_update_channel_partner_repricing_config():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    channel_partner_repricing_config = channel_v1.ChannelPartnerRepricingConfig()
    channel_partner_repricing_config.repricing_config.rebilling_basis = "DIRECT_CUSTOMER_COST"

    request = channel_v1.UpdateChannelPartnerRepricingConfigRequest(
        channel_partner_repricing_config=channel_partner_repricing_config,
    )

    # Make the request
    response = await client.update_channel_partner_repricing_config(request=request)

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.UpdateChannelPartnerRepricingConfigRequest, dict]]) – The request object. Request message for [CloudChannelService.UpdateChannelPartnerRepricingConfig][google.cloud.channel.v1.CloudChannelService.UpdateChannelPartnerRepricingConfig].

• channel_partner_repricing_config (google.cloud.channel_v1.types.ChannelPartnerRepricingConfig) –

  Required. The ChannelPartnerRepricingConfig object to update.

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

• retry (google.api_core.retry_async.AsyncRetry) – 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

Configuration for how a distributor will rebill a channel partner (also known as a distributor-authorized reseller).

Return type

google.cloud.channel_v1.types.ChannelPartnerRepricingConfig

async update_customer(request: Optional[Union[google.cloud.channel_v1.types.service.UpdateCustomerRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.types.customers.Customer

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_update_customer():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    customer = channel_v1.Customer()
    customer.org_display_name = "org_display_name_value"
    customer.domain = "domain_value"

    request = channel_v1.UpdateCustomerRequest(
        customer=customer,
    )

    # Make the request
    response = await client.update_customer(request=request)

    # Handle the response
    print(response)

Parameters

• request (Optional[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_async.AsyncRetry) – 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 update_customer_repricing_config(request: Optional[Union[google.cloud.channel_v1.types.service.UpdateCustomerRepricingConfigRequest, dict]] = None, *, customer_repricing_config: Optional[google.cloud.channel_v1.types.repricing.CustomerRepricingConfig] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.types.repricing.CustomerRepricingConfig

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

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

When updating a config in the future:

• This config must already exist.

Possible Error Codes:

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

• INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.

• NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] specified does not exist or is not associated with the given account.

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

Return Value: If successful, the updated [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resource, otherwise returns an error.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

async def sample_update_customer_repricing_config():
    # Create a client
    client = channel_v1.CloudChannelServiceAsyncClient()

    # Initialize request argument(s)
    customer_repricing_config = channel_v1.CustomerRepricingConfig()
    customer_repricing_config.repricing_config.rebilling_basis = "DIRECT_CUSTOMER_COST"

    request = channel_v1.UpdateCustomerRepricingConfigRequest(
        customer_repricing_config=customer_repricing_config,
    )

    # Make the request
    response = await client.update_customer_repricing_config(request=request)

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.channel_v1.types.UpdateCustomerRepricingConfigRequest, dict]]) – The request object. Request message for [CloudChannelService.UpdateCustomerRepricingConfig][google.cloud.channel.v1.CloudChannelService.UpdateCustomerRepricingConfig].

• customer_repricing_config (google.cloud.channel_v1.types.CustomerRepricingConfig) –

  Required. The CustomerRepricingConfig object to update.

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

• retry (google.api_core.retry_async.AsyncRetry) – 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

Configuration for how a reseller will reprice a Customer.

Return type

google.cloud.channel_v1.types.CustomerRepricingConfig

class google.cloud.channel_v1.services.cloud_channel_service.CloudChannelServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.channel_v1.services.cloud_channel_service.transports.base.CloudChannelServiceTransport, typing.Callable[[...], google.cloud.channel_v1.services.cloud_channel_service.transports.base.CloudChannelServiceTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

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 (Optional[Union[str,CloudChannelServiceTransport,Callable[..., CloudChannelServiceTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the CloudChannelServiceTransport constructor. If set to None, a transport is chosen automatically.

• client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –

  Custom options for the client.

  1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “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).

  2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS 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.

  3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.

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

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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_activate_entitlement():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    request = channel_v1.ActivateEntitlementRequest(
        name="name_value",
    )

    # Make the request
    operation = client.activate_entitlement(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

• request (Union[google.cloud.channel_v1.types.ActivateEntitlementRequest, dict]) – 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.Operation

property api_endpoint

Return the API endpoint used by the client instance.

Returns

The API endpoint used by the client instance.

Return type

str

static billing_account_path(account: str, billing_account: str) → str

Returns a fully-qualified billing_account string.

cancel_entitlement(request: Optional[Union[google.cloud.channel_v1.types.service.CancelEntitlementRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_cancel_entitlement():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    request = channel_v1.CancelEntitlementRequest(
        name="name_value",
    )

    # Make the request
    operation = client.cancel_entitlement(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

• request (Union[google.cloud.channel_v1.types.CancelEntitlementRequest, dict]) – 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);

}

Return type

google.api_core.operation.Operation

cancel_operation(request: Optional[google.longrunning.operations_pb2.CancelOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters

• request (CancelOperationRequest) – The request object. Request message for CancelOperation method.

• 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

None

change_offer(request: Optional[Union[google.cloud.channel_v1.types.service.ChangeOfferRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_change_offer():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    request = channel_v1.ChangeOfferRequest(
        name="name_value",
        offer="offer_value",
    )

    # Make the request
    operation = client.change_offer(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_change_parameters():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    request = channel_v1.ChangeParametersRequest(
        name="name_value",
    )

    # Make the request
    operation = client.change_parameters(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

• request (Union[google.cloud.channel_v1.types.ChangeParametersRequest, dict]) – The request object. Request message for [CloudChannelService.ChangeParametersRequest][].

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_change_renewal_settings():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    request = channel_v1.ChangeRenewalSettingsRequest(
        name="name_value",
    )

    # Make the request
    operation = client.change_renewal_settings(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

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

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

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 channel_partner_link_path(account: str, channel_partner_link: str) → str

Returns a fully-qualified channel_partner_link string.

static channel_partner_repricing_config_path(account: str, channel_partner: str, channel_partner_repricing_config: str) → str

Returns a fully-qualified channel_partner_repricing_config string.

check_cloud_identity_accounts_exist(request: Optional[Union[google.cloud.channel_v1.types.service.CheckCloudIdentityAccountsExistRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.types.service.CheckCloudIdentityAccountsExistResponse

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_check_cloud_identity_accounts_exist():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    request = channel_v1.CheckCloudIdentityAccountsExistRequest(
        parent="parent_value",
        domain="domain_value",
    )

    # Make the request
    response = client.check_cloud_identity_accounts_exist(request=request)

    # Handle the response
    print(response)

Parameters

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

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

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.

create_channel_partner_link(request: Optional[Union[google.cloud.channel_v1.types.service.CreateChannelPartnerLinkRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.types.channel_partner_links.ChannelPartnerLink

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_create_channel_partner_link():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    channel_partner_link = channel_v1.ChannelPartnerLink()
    channel_partner_link.reseller_cloud_identity_id = "reseller_cloud_identity_id_value"
    channel_partner_link.link_state = "SUSPENDED"

    request = channel_v1.CreateChannelPartnerLinkRequest(
        parent="parent_value",
        channel_partner_link=channel_partner_link,
    )

    # Make the request
    response = client.create_channel_partner_link(request=request)

    # Handle the response
    print(response)

Parameters

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

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

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_channel_partner_repricing_config(request: Optional[Union[google.cloud.channel_v1.types.service.CreateChannelPartnerRepricingConfigRequest, dict]] = None, *, parent: Optional[str] = None, channel_partner_repricing_config: Optional[google.cloud.channel_v1.types.repricing.ChannelPartnerRepricingConfig] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.types.repricing.ChannelPartnerRepricingConfig

Creates a ChannelPartnerRepricingConfig. Call this method to set modifications for a specific ChannelPartner’s bill. You can only create configs if the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is a future month. If needed, you can create a config for the current month, with some restrictions.

When creating a config for a future month, make sure there are no existing configs for that [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].

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

• This functionality is reserved for recovering from an erroneous config, and should not be used for regular business cases.

• The new config will not modify exports used with other configs. Changes to the config may be immediate, but may take up to 24 hours.

• There is a limit of ten configs for any ChannelPartner or [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement], for any [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].

• The contained [ChannelPartnerRepricingConfig.repricing_config][google.cloud.channel.v1.ChannelPartnerRepricingConfig.repricing_config] value must be different from the value used in the current config for a ChannelPartner.

Possible Error Codes:

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

• INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.

• NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] specified does not exist or is not associated with the given account.

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

Return Value: If successful, the updated [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resource, otherwise returns an error.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_create_channel_partner_repricing_config():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    channel_partner_repricing_config = channel_v1.ChannelPartnerRepricingConfig()
    channel_partner_repricing_config.repricing_config.rebilling_basis = "DIRECT_CUSTOMER_COST"

    request = channel_v1.CreateChannelPartnerRepricingConfigRequest(
        parent="parent_value",
        channel_partner_repricing_config=channel_partner_repricing_config,
    )

    # Make the request
    response = client.create_channel_partner_repricing_config(request=request)

    # Handle the response
    print(response)

Parameters

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

• parent (str) –

  Required. The resource name of the ChannelPartner that will receive the repricing config. Parent uses the format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}

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

• channel_partner_repricing_config (google.cloud.channel_v1.types.ChannelPartnerRepricingConfig) –

  Required. The ChannelPartnerRepricingConfig object to update.

  This corresponds to the channel_partner_repricing_config 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

Configuration for how a distributor will rebill a channel partner (also known as a distributor-authorized reseller).

Return type

google.cloud.channel_v1.types.ChannelPartnerRepricingConfig

create_customer(request: Optional[Union[google.cloud.channel_v1.types.service.CreateCustomerRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.types.customers.Customer

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.

  • You are not authorized to create a customer. See https://support.google.com/channelservices/answer/9759265

• INVALID_ARGUMENT:

  • Required request parameters are missing or invalid.

  • Domain field value doesn’t match the primary email domain.

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_create_customer():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    customer = channel_v1.Customer()
    customer.org_display_name = "org_display_name_value"
    customer.domain = "domain_value"

    request = channel_v1.CreateCustomerRequest(
        parent="parent_value",
        customer=customer,
    )

    # Make the request
    response = client.create_customer(request=request)

    # Handle the response
    print(response)

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_customer_repricing_config(request: Optional[Union[google.cloud.channel_v1.types.service.CreateCustomerRepricingConfigRequest, dict]] = None, *, parent: Optional[str] = None, customer_repricing_config: Optional[google.cloud.channel_v1.types.repricing.CustomerRepricingConfig] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.types.repricing.CustomerRepricingConfig

Creates a CustomerRepricingConfig. Call this method to set modifications for a specific customer’s bill. You can only create configs if the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is a future month. If needed, you can create a config for the current month, with some restrictions.

When creating a config for a future month, make sure there are no existing configs for that [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].

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

• This functionality is reserved for recovering from an erroneous config, and should not be used for regular business cases.

• The new config will not modify exports used with other configs. Changes to the config may be immediate, but may take up to 24 hours.

• There is a limit of ten configs for any [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement], for any [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].

• The contained [CustomerRepricingConfig.repricing_config][google.cloud.channel.v1.CustomerRepricingConfig.repricing_config] value must be different from the value used in the current config for a [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement].

Possible Error Codes:

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

• INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.

• NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] specified does not exist or is not associated with the given account.

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

Return Value: If successful, the updated [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resource, otherwise returns an error.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_create_customer_repricing_config():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    customer_repricing_config = channel_v1.CustomerRepricingConfig()
    customer_repricing_config.repricing_config.rebilling_basis = "DIRECT_CUSTOMER_COST"

    request = channel_v1.CreateCustomerRepricingConfigRequest(
        parent="parent_value",
        customer_repricing_config=customer_repricing_config,
    )

    # Make the request
    response = client.create_customer_repricing_config(request=request)

    # Handle the response
    print(response)

Parameters

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

• parent (str) –

  Required. The resource name of the customer that will receive this repricing config. Parent uses the format: accounts/{account_id}/customers/{customer_id}

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

• customer_repricing_config (google.cloud.channel_v1.types.CustomerRepricingConfig) –

  Required. The CustomerRepricingConfig object to update.

  This corresponds to the customer_repricing_config 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

Configuration for how a reseller will reprice a Customer.

Return type

google.cloud.channel_v1.types.CustomerRepricingConfig

create_entitlement(request: Optional[Union[google.cloud.channel_v1.types.service.CreateEntitlementRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation

Creates an entitlement for a customer.

Possible error codes:

• PERMISSION_DENIED:

  • The customer doesn’t belong to the reseller.

  • The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265

• INVALID_ARGUMENT:

  • Required request parameters are missing or invalid.

  • There is already a customer entitlement for a SKU from the same product family.

• INVALID_VALUE: Make sure the OfferId is valid. If it is, contact Google Channel support for further troubleshooting.

• NOT_FOUND: The customer or offer resource was not found.

• ALREADY_EXISTS:

  • The SKU was already purchased for the customer.

  • The customer’s primary email already exists. Retry after changing the customer’s primary contact email.

• CONDITION_NOT_MET or FAILED_PRECONDITION:

  • The domain required for purchasing a SKU has not been verified.

  • A pre-requisite SKU required to purchase an Add-On SKU is missing. For example, Google Workspace Business Starter is required to purchase Vault or Drive.

  • (Developer accounts only) Reseller and resold domain must meet the following naming requirements:

    • Domain names must start with goog-test.

    • Domain names must include the reseller domain.

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

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

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

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_create_entitlement():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    entitlement = channel_v1.Entitlement()
    entitlement.offer = "offer_value"

    request = channel_v1.CreateEntitlementRequest(
        parent="parent_value",
        entitlement=entitlement,
    )

    # Make the request
    operation = client.create_entitlement(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

• request (Union[google.cloud.channel_v1.types.CreateEntitlementRequest, dict]) – 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.Operation

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

Returns a fully-qualified customer string.

static customer_repricing_config_path(account: str, customer: str, customer_repricing_config: str) → str

Returns a fully-qualified customer_repricing_config string.

delete_channel_partner_repricing_config(request: Optional[Union[google.cloud.channel_v1.types.service.DeleteChannelPartnerRepricingConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None

Deletes the given [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] permanently. You can only delete configs if their [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is set to a date after the current month.

Possible error codes:

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

• INVALID_ARGUMENT: Required request parameters are missing or invalid.

• FAILED_PRECONDITION: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] is active or in the past.

• NOT_FOUND: No [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] found for the name in the request.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_delete_channel_partner_repricing_config():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    request = channel_v1.DeleteChannelPartnerRepricingConfigRequest(
        name="name_value",
    )

    # Make the request
    client.delete_channel_partner_repricing_config(request=request)

Parameters

• request (Union[google.cloud.channel_v1.types.DeleteChannelPartnerRepricingConfigRequest, dict]) – The request object. Request message for DeleteChannelPartnerRepricingConfig.

• name (str) –

  Required. The resource name of the channel partner repricing config rule 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.

delete_customer(request: Optional[Union[google.cloud.channel_v1.types.service.DeleteCustomerRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_delete_customer():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    request = channel_v1.DeleteCustomerRequest(
        name="name_value",
    )

    # Make the request
    client.delete_customer(request=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.

delete_customer_repricing_config(request: Optional[Union[google.cloud.channel_v1.types.service.DeleteCustomerRepricingConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None

Deletes the given [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] permanently. You can only delete configs if their [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is set to a date after the current month.

Possible error codes:

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

• INVALID_ARGUMENT: Required request parameters are missing or invalid.

• FAILED_PRECONDITION: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] is active or in the past.

• NOT_FOUND: No [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] found for the name in the request.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_delete_customer_repricing_config():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    request = channel_v1.DeleteCustomerRepricingConfigRequest(
        name="name_value",
    )

    # Make the request
    client.delete_customer_repricing_config(request=request)

Parameters

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

• name (str) –

  Required. The resource name of the customer repricing config rule to delete. Format: accounts/{account_id}/customers/{customer_id}/customerRepricingConfigs/{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.

delete_operation(request: Optional[google.longrunning.operations_pb2.DeleteOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters

• request (DeleteOperationRequest) – The request object. Request message for DeleteOperation method.

• 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

None

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)

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)

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

get_channel_partner_link(request: Optional[Union[google.cloud.channel_v1.types.service.GetChannelPartnerLinkRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.types.channel_partner_links.ChannelPartnerLink

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_get_channel_partner_link():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    request = channel_v1.GetChannelPartnerLinkRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_channel_partner_link(request=request)

    # Handle the response
    print(response)

Parameters

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

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

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_channel_partner_repricing_config(request: Optional[Union[google.cloud.channel_v1.types.service.GetChannelPartnerRepricingConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.types.repricing.ChannelPartnerRepricingConfig

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

Possible Error Codes:

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

• NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] was not found.

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

Return Value: If successful, the [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resource, otherwise returns an error.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_get_channel_partner_repricing_config():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    request = channel_v1.GetChannelPartnerRepricingConfigRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_channel_partner_repricing_config(request=request)

    # Handle the response
    print(response)

Parameters

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

• name (str) –

  Required. The resource name of the ChannelPartnerRepricingConfig Format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}/channelPartnerRepricingConfigs/{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

Configuration for how a distributor will rebill a channel partner (also known as a distributor-authorized reseller).

Return type

google.cloud.channel_v1.types.ChannelPartnerRepricingConfig

get_customer(request: Optional[Union[google.cloud.channel_v1.types.service.GetCustomerRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.types.customers.Customer

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_get_customer():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    request = channel_v1.GetCustomerRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_customer(request=request)

    # Handle the response
    print(response)

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_customer_repricing_config(request: Optional[Union[google.cloud.channel_v1.types.service.GetCustomerRepricingConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.types.repricing.CustomerRepricingConfig

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

Possible Error Codes:

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

• NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] was not found.

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

Return Value: If successful, the [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resource, otherwise returns an error.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_get_customer_repricing_config():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    request = channel_v1.GetCustomerRepricingConfigRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_customer_repricing_config(request=request)

    # Handle the response
    print(response)

Parameters

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

• name (str) –

  Required. The resource name of the CustomerRepricingConfig. Format: accounts/{account_id}/customers/{customer_id}/customerRepricingConfigs/{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

Configuration for how a reseller will reprice a Customer.

Return type

google.cloud.channel_v1.types.CustomerRepricingConfig

get_entitlement(request: Optional[Union[google.cloud.channel_v1.types.service.GetEntitlementRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.types.entitlements.Entitlement

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_get_entitlement():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    request = channel_v1.GetEntitlementRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_entitlement(request=request)

    # Handle the response
    print(response)

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

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not “true”, the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “always”, use the default mTLS endpoint; if the environment variable is “never”, use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the

client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

Parameters

• request (GetOperationRequest) – The request object. Request message for GetOperation method.

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

Return type

Operation

import_customer(request: Optional[Union[google.cloud.channel_v1.types.service.ImportCustomerRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.types.customers.Customer

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.

  • You are not authorized to import the customer. See https://support.google.com/channelservices/answer/9759265

• NOT_FOUND: Cloud Identity doesn’t exist or was deleted.

• INVALID_ARGUMENT: Required parameters are missing, or the auth_token is expired or invalid.

• ALREADY_EXISTS: A customer already exists and has conflicting critical fields. Requires an overwrite.

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_import_customer():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    request = channel_v1.ImportCustomerRequest(
        domain="domain_value",
        parent="parent_value",
        overwrite_if_exists=True,
    )

    # Make the request
    response = client.import_customer(request=request)

    # Handle the response
    print(response)

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_channel_partner_links(request: Optional[Union[google.cloud.channel_v1.types.service.ListChannelPartnerLinksRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.services.cloud_channel_service.pagers.ListChannelPartnerLinksPager

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_list_channel_partner_links():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    request = channel_v1.ListChannelPartnerLinksRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_channel_partner_links(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

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

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

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_channel_partner_repricing_configs(request: Optional[Union[google.cloud.channel_v1.types.service.ListChannelPartnerRepricingConfigsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.services.cloud_channel_service.pagers.ListChannelPartnerRepricingConfigsPager

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

Possible Error Codes:

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

• NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] specified does not exist or is not associated with the given account.

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

Return Value: If successful, the [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resources. The data for each resource is displayed in the ascending order of:

• Channel Partner ID

• [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month]

• [ChannelPartnerRepricingConfig.update_time][google.cloud.channel.v1.ChannelPartnerRepricingConfig.update_time]

If unsuccessful, returns an error.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_list_channel_partner_repricing_configs():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    request = channel_v1.ListChannelPartnerRepricingConfigsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_channel_partner_repricing_configs(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

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

• parent (str) –

  Required. The resource name of the account’s [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]. Parent uses the format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}. Supports accounts/{account_id}/channelPartnerLinks/- to retrieve configs for all channel partners.

  This corresponds to the parent 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

Response message for

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

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

Return type

google.cloud.channel_v1.services.cloud_channel_service.pagers.ListChannelPartnerRepricingConfigsPager

list_customer_repricing_configs(request: Optional[Union[google.cloud.channel_v1.types.service.ListCustomerRepricingConfigsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.services.cloud_channel_service.pagers.ListCustomerRepricingConfigsPager

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

Possible Error Codes:

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

• NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] specified does not exist or is not associated with the given account.

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

Return Value: If successful, the [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resources. The data for each resource is displayed in the ascending order of:

• Customer ID

• [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement]

• [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month]

• [CustomerRepricingConfig.update_time][google.cloud.channel.v1.CustomerRepricingConfig.update_time]

If unsuccessful, returns an error.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_list_customer_repricing_configs():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    request = channel_v1.ListCustomerRepricingConfigsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_customer_repricing_configs(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

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

• parent (str) –

  Required. The resource name of the customer. Parent uses the format: accounts/{account_id}/customers/{customer_id}. Supports accounts/{account_id}/customers/- to retrieve configs for all customers.

  This corresponds to the parent 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

Response message for

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

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

Return type

google.cloud.channel_v1.services.cloud_channel_service.pagers.ListCustomerRepricingConfigsPager

list_customers(request: Optional[Union[google.cloud.channel_v1.types.service.ListCustomersRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.services.cloud_channel_service.pagers.ListCustomersPager

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_list_customers():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    request = channel_v1.ListCustomersRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_customers(request=request)

    # Handle the response
    for response in page_result:
        print(response)

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_entitlement_changes(request: Optional[Union[google.cloud.channel_v1.types.service.ListEntitlementChangesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.services.cloud_channel_service.pagers.ListEntitlementChangesPager

List entitlement history.

Possible error codes:

• PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different.

• INVALID_ARGUMENT: Missing or invalid required fields in the request.

• NOT_FOUND: The parent resource doesn’t exist. Usually the result of an invalid name parameter.

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

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

Return value: List of [EntitlementChange][google.cloud.channel.v1.EntitlementChange]s.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_list_entitlement_changes():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    request = channel_v1.ListEntitlementChangesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_entitlement_changes(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

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

• parent (str) –

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

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

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

  This corresponds to the parent 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

Response message for

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

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

Return type

google.cloud.channel_v1.services.cloud_channel_service.pagers.ListEntitlementChangesPager

list_entitlements(request: Optional[Union[google.cloud.channel_v1.types.service.ListEntitlementsRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.services.cloud_channel_service.pagers.ListEntitlementsPager

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_list_entitlements():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    request = channel_v1.ListEntitlementsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_entitlements(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

• request (Union[google.cloud.channel_v1.types.ListEntitlementsRequest, dict]) – 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.ListEntitlementsPager

list_offers(request: Optional[Union[google.cloud.channel_v1.types.service.ListOffersRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.services.cloud_channel_service.pagers.ListOffersPager

Lists the Offers the reseller can sell.

Possible error codes:

• INVALID_ARGUMENT: Required request parameters are missing or invalid.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_list_offers():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    request = channel_v1.ListOffersRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_offers(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

• request (Union[google.cloud.channel_v1.types.ListOffersRequest, dict]) – The request object. Request message for ListOffers.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

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_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

Parameters

• request (ListOperationsRequest) – The request object. Request message for ListOperations method.

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

Return type

ListOperationsResponse

list_products(request: Optional[Union[google.cloud.channel_v1.types.service.ListProductsRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.services.cloud_channel_service.pagers.ListProductsPager

Lists the Products the reseller is authorized to sell.

Possible error codes:

• INVALID_ARGUMENT: Required request parameters are missing or invalid.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_list_products():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    request = channel_v1.ListProductsRequest(
        account="account_value",
    )

    # Make the request
    page_result = client.list_products(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

• request (Union[google.cloud.channel_v1.types.ListProductsRequest, dict]) – The request object. Request message for ListProducts.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.services.cloud_channel_service.pagers.ListPurchasableOffersPager

Lists the following:

• Offers that you can purchase for a customer.

• Offers that you can change for an entitlement.

Possible error codes:

• PERMISSION_DENIED:

  • The customer doesn’t belong to the reseller

  • The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265

• INVALID_ARGUMENT: Required request parameters are missing or invalid.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_list_purchasable_offers():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    create_entitlement_purchase = channel_v1.CreateEntitlementPurchase()
    create_entitlement_purchase.sku = "sku_value"

    request = channel_v1.ListPurchasableOffersRequest(
        create_entitlement_purchase=create_entitlement_purchase,
        customer="customer_value",
    )

    # Make the request
    page_result = client.list_purchasable_offers(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

• request (Union[google.cloud.channel_v1.types.ListPurchasableOffersRequest, dict]) – The request object. Request message for ListPurchasableOffers.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.services.cloud_channel_service.pagers.ListPurchasableSkusPager

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_list_purchasable_skus():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    create_entitlement_purchase = channel_v1.CreateEntitlementPurchase()
    create_entitlement_purchase.product = "product_value"

    request = channel_v1.ListPurchasableSkusRequest(
        create_entitlement_purchase=create_entitlement_purchase,
        customer="customer_value",
    )

    # Make the request
    page_result = client.list_purchasable_skus(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

• request (Union[google.cloud.channel_v1.types.ListPurchasableSkusRequest, dict]) – The request object. Request message for ListPurchasableSkus.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

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_sku_group_billable_skus(request: Optional[Union[google.cloud.channel_v1.types.service.ListSkuGroupBillableSkusRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.services.cloud_channel_service.pagers.ListSkuGroupBillableSkusPager

Lists the Billable SKUs in a given SKU group.

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

Return Value: If successful, the [BillableSku][google.cloud.channel.v1.BillableSku] resources. The data for each resource is displayed in the ascending order of:

• [BillableSku.service_display_name][google.cloud.channel.v1.BillableSku.service_display_name]

• [BillableSku.sku_display_name][google.cloud.channel.v1.BillableSku.sku_display_name]

If unsuccessful, returns an error.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_list_sku_group_billable_skus():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    request = channel_v1.ListSkuGroupBillableSkusRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_sku_group_billable_skus(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

• request (Union[google.cloud.channel_v1.types.ListSkuGroupBillableSkusRequest, dict]) – The request object. Request message for ListSkuGroupBillableSkus.

• parent (str) –

  Required. Resource name of the SKU group. Format: accounts/{account}/skuGroups/{sku_group}.

  This corresponds to the parent 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

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

Return type

google.cloud.channel_v1.services.cloud_channel_service.pagers.ListSkuGroupBillableSkusPager

list_sku_groups(request: Optional[Union[google.cloud.channel_v1.types.service.ListSkuGroupsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.services.cloud_channel_service.pagers.ListSkuGroupsPager

Lists the Rebilling supported SKU groups the account is authorized to sell. Reference: https://cloud.google.com/skus/sku-groups

Possible Error Codes:

• PERMISSION_DENIED: If the account making the request and the account being queried are different, or the account doesn’t exist.

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

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

If unsuccessful, returns an error.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_list_sku_groups():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    request = channel_v1.ListSkuGroupsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_sku_groups(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

• request (Union[google.cloud.channel_v1.types.ListSkuGroupsRequest, dict]) – The request object. Request message for ListSkuGroups.

• parent (str) –

  Required. The resource name of the account from which to list SKU groups. Parent uses the format: accounts/{account}.

  This corresponds to the parent 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

Response message for ListSkuGroups.

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

Return type

google.cloud.channel_v1.services.cloud_channel_service.pagers.ListSkuGroupsPager

list_skus(request: Optional[Union[google.cloud.channel_v1.types.service.ListSkusRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.services.cloud_channel_service.pagers.ListSkusPager

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

Possible error codes:

• INVALID_ARGUMENT: Required request parameters are missing or invalid.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_list_skus():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    request = channel_v1.ListSkusRequest(
        parent="parent_value",
        account="account_value",
    )

    # Make the request
    page_result = client.list_skus(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

• request (Union[google.cloud.channel_v1.types.ListSkusRequest, dict]) – The request object. Request message for ListSkus.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.services.cloud_channel_service.pagers.ListSubscribersPager

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_list_subscribers():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    request = channel_v1.ListSubscribersRequest(
        account="account_value",
    )

    # Make the request
    page_result = client.list_subscribers(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

• request (Union[google.cloud.channel_v1.types.ListSubscribersRequest, dict]) – The request object. Request Message for ListSubscribers.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.services.cloud_channel_service.pagers.ListTransferableOffersPager

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 customer provided incorrect reseller information when generating auth token.

  • The reseller account making the request is different from the reseller account in the query.

  • The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265

• INVALID_ARGUMENT: Required request parameters are missing or invalid.

Return value: List of [TransferableOffer][google.cloud.channel.v1.TransferableOffer] for the given customer and SKU.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_list_transferable_offers():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    request = channel_v1.ListTransferableOffersRequest(
        cloud_identity_id="cloud_identity_id_value",
        parent="parent_value",
        sku="sku_value",
    )

    # Make the request
    page_result = client.list_transferable_offers(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

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

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.services.cloud_channel_service.pagers.ListTransferableSkusPager

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_list_transferable_skus():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    request = channel_v1.ListTransferableSkusRequest(
        cloud_identity_id="cloud_identity_id_value",
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_transferable_skus(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

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

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.types.offers.Offer

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_lookup_offer():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    request = channel_v1.LookupOfferRequest(
        entitlement="entitlement_value",
    )

    # Make the request
    response = client.lookup_offer(request=request)

    # Handle the response
    print(response)

Parameters

• request (Union[google.cloud.channel_v1.types.LookupOfferRequest, dict]) – The request object. Request message for LookupOffer.

• 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

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_billing_account_path(path: str) → Dict[str, str]

Parses a billing_account path into its component segments.

static parse_channel_partner_link_path(path: str) → Dict[str, str]

Parses a channel_partner_link path into its component segments.

static parse_channel_partner_repricing_config_path(path: str) → Dict[str, str]

Parses a channel_partner_repricing_config path into its component segments.

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_customer_repricing_config_path(path: str) → Dict[str, str]

Parses a customer_repricing_config 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_group_path(path: str) → Dict[str, str]

Parses a sku_group 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.

provision_cloud_identity(request: Optional[Union[google.cloud.channel_v1.types.service.ProvisionCloudIdentityRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation

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

Possible error codes:

• PERMISSION_DENIED:

  • The customer doesn’t belong to the reseller.

  • You are not authorized to provision cloud identity id. See https://support.google.com/channelservices/answer/9759265

• INVALID_ARGUMENT: Required request parameters are missing or invalid.

• NOT_FOUND: The customer was not found.

• ALREADY_EXISTS: The customer’s primary email already exists. Retry after changing the customer’s primary contact email.

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

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

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

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata contains an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_provision_cloud_identity():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    request = channel_v1.ProvisionCloudIdentityRequest(
        customer="customer_value",
    )

    # Make the request
    operation = client.provision_cloud_identity(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

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

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

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

query_eligible_billing_accounts(request: Optional[Union[google.cloud.channel_v1.types.service.QueryEligibleBillingAccountsRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.types.service.QueryEligibleBillingAccountsResponse

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

Possible error codes:

• PERMISSION_DENIED: The customer doesn’t belong to the reseller.

• INVALID_ARGUMENT: Required request parameters are missing or invalid.

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_query_eligible_billing_accounts():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    request = channel_v1.QueryEligibleBillingAccountsRequest(
        customer="customer_value",
        skus=['skus_value1', 'skus_value2'],
    )

    # Make the request
    response = client.query_eligible_billing_accounts(request=request)

    # Handle the response
    print(response)

Parameters

• request (Union[google.cloud.channel_v1.types.QueryEligibleBillingAccountsRequest, dict]) – The request object. Request message for QueryEligibleBillingAccounts.

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

Return type

google.cloud.channel_v1.types.QueryEligibleBillingAccountsResponse

register_subscriber(request: Optional[Union[google.cloud.channel_v1.types.service.RegisterSubscriberRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.types.service.RegisterSubscriberResponse

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_register_subscriber():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    request = channel_v1.RegisterSubscriberRequest(
        account="account_value",
        service_account="service_account_value",
    )

    # Make the request
    response = client.register_subscriber(request=request)

    # Handle the response
    print(response)

Parameters

• request (Union[google.cloud.channel_v1.types.RegisterSubscriberRequest, dict]) – The request object. Request Message for RegisterSubscriber.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response Message for RegisterSubscriber.

Return type

google.cloud.channel_v1.types.RegisterSubscriberResponse

static sku_group_path(account: str, sku_group: str) → str

Returns a fully-qualified sku_group string.

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

Returns a fully-qualified sku string.

start_paid_service(request: Optional[Union[google.cloud.channel_v1.types.service.StartPaidServiceRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_start_paid_service():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    request = channel_v1.StartPaidServiceRequest(
        name="name_value",
    )

    # Make the request
    operation = client.start_paid_service(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_suspend_entitlement():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    request = channel_v1.SuspendEntitlementRequest(
        name="name_value",
    )

    # Make the request
    operation = client.suspend_entitlement(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

• request (Union[google.cloud.channel_v1.types.SuspendEntitlementRequest, dict]) – 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.Operation

transfer_entitlements(request: Optional[Union[google.cloud.channel_v1.types.service.TransferEntitlementsRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation

Transfers customer entitlements to new reseller.

Possible error codes:

• PERMISSION_DENIED:

  • The customer doesn’t belong to the reseller.

  • The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265

• INVALID_ARGUMENT: Required request parameters are missing or invalid.

• NOT_FOUND: The customer or offer resource was not found.

• ALREADY_EXISTS: The SKU was already transferred for the customer.

• CONDITION_NOT_MET or FAILED_PRECONDITION:

  • The SKU requires domain verification to transfer, but the domain is not verified.

  • An Add-On SKU (example, Vault or Drive) is missing the pre-requisite SKU (example, G Suite Basic).

  • (Developer accounts only) Reseller and resold domain must meet the following naming requirements:

    • Domain names must start with goog-test.

    • Domain names must include the reseller domain.

  • Specify all transferring entitlements.

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

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

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

To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_transfer_entitlements():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    entitlements = channel_v1.Entitlement()
    entitlements.offer = "offer_value"

    request = channel_v1.TransferEntitlementsRequest(
        parent="parent_value",
        entitlements=entitlements,
    )

    # Make the request
    operation = client.transfer_entitlements(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

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

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_transfer_entitlements_to_google():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    entitlements = channel_v1.Entitlement()
    entitlements.offer = "offer_value"

    request = channel_v1.TransferEntitlementsToGoogleRequest(
        parent="parent_value",
        entitlements=entitlements,
    )

    # Make the request
    operation = client.transfer_entitlements_to_google(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

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

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

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);

}

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

property universe_domain: str

Return the universe domain used by the client instance.

Returns

The universe domain used by the client instance.

Return type

str

unregister_subscriber(request: Optional[Union[google.cloud.channel_v1.types.service.UnregisterSubscriberRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.types.service.UnregisterSubscriberResponse

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_unregister_subscriber():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    request = channel_v1.UnregisterSubscriberRequest(
        account="account_value",
        service_account="service_account_value",
    )

    # Make the request
    response = client.unregister_subscriber(request=request)

    # Handle the response
    print(response)

Parameters

• request (Union[google.cloud.channel_v1.types.UnregisterSubscriberRequest, dict]) – The request object. Request Message for UnregisterSubscriber.

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response Message for UnregisterSubscriber.

Return type

google.cloud.channel_v1.types.UnregisterSubscriberResponse

update_channel_partner_link(request: Optional[Union[google.cloud.channel_v1.types.service.UpdateChannelPartnerLinkRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.types.channel_partner_links.ChannelPartnerLink

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_update_channel_partner_link():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    channel_partner_link = channel_v1.ChannelPartnerLink()
    channel_partner_link.reseller_cloud_identity_id = "reseller_cloud_identity_id_value"
    channel_partner_link.link_state = "SUSPENDED"

    request = channel_v1.UpdateChannelPartnerLinkRequest(
        name="name_value",
        channel_partner_link=channel_partner_link,
    )

    # Make the request
    response = client.update_channel_partner_link(request=request)

    # Handle the response
    print(response)

Parameters

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

• retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.

• timeout (float) – The timeout for this request.

• metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

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_channel_partner_repricing_config(request: Optional[Union[google.cloud.channel_v1.types.service.UpdateChannelPartnerRepricingConfigRequest, dict]] = None, *, channel_partner_repricing_config: Optional[google.cloud.channel_v1.types.repricing.ChannelPartnerRepricingConfig] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.types.repricing.ChannelPartnerRepricingConfig

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

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

When updating a config in the future:

• This config must already exist.

Possible Error Codes:

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

• INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.

• NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] specified does not exist or is not associated with the given account.

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

Return Value: If successful, the updated [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resource, otherwise returns an error.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_update_channel_partner_repricing_config():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    channel_partner_repricing_config = channel_v1.ChannelPartnerRepricingConfig()
    channel_partner_repricing_config.repricing_config.rebilling_basis = "DIRECT_CUSTOMER_COST"

    request = channel_v1.UpdateChannelPartnerRepricingConfigRequest(
        channel_partner_repricing_config=channel_partner_repricing_config,
    )

    # Make the request
    response = client.update_channel_partner_repricing_config(request=request)

    # Handle the response
    print(response)

Parameters

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

• channel_partner_repricing_config (google.cloud.channel_v1.types.ChannelPartnerRepricingConfig) –

  Required. The ChannelPartnerRepricingConfig object to update.

  This corresponds to the channel_partner_repricing_config 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

Configuration for how a distributor will rebill a channel partner (also known as a distributor-authorized reseller).

Return type

google.cloud.channel_v1.types.ChannelPartnerRepricingConfig

update_customer(request: Optional[Union[google.cloud.channel_v1.types.service.UpdateCustomerRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.types.customers.Customer

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_update_customer():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    customer = channel_v1.Customer()
    customer.org_display_name = "org_display_name_value"
    customer.domain = "domain_value"

    request = channel_v1.UpdateCustomerRequest(
        customer=customer,
    )

    # Make the request
    response = client.update_customer(request=request)

    # Handle the response
    print(response)

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

update_customer_repricing_config(request: Optional[Union[google.cloud.channel_v1.types.service.UpdateCustomerRepricingConfigRequest, dict]] = None, *, customer_repricing_config: Optional[google.cloud.channel_v1.types.repricing.CustomerRepricingConfig] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.channel_v1.types.repricing.CustomerRepricingConfig

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

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

When updating a config in the future:

• This config must already exist.

Possible Error Codes:

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

• INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.

• NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] specified does not exist or is not associated with the given account.

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

Return Value: If successful, the updated [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resource, otherwise returns an error.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import channel_v1

def sample_update_customer_repricing_config():
    # Create a client
    client = channel_v1.CloudChannelServiceClient()

    # Initialize request argument(s)
    customer_repricing_config = channel_v1.CustomerRepricingConfig()
    customer_repricing_config.repricing_config.rebilling_basis = "DIRECT_CUSTOMER_COST"

    request = channel_v1.UpdateCustomerRepricingConfigRequest(
        customer_repricing_config=customer_repricing_config,
    )

    # Make the request
    response = client.update_customer_repricing_config(request=request)

    # Handle the response
    print(response)

Parameters

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

• customer_repricing_config (google.cloud.channel_v1.types.CustomerRepricingConfig) –

  Required. The CustomerRepricingConfig object to update.

  This corresponds to the customer_repricing_config 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

Configuration for how a reseller will reprice a Customer.

Return type

google.cloud.channel_v1.types.CustomerRepricingConfig

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, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

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

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.channel_v1.types.ListChannelPartnerLinksRequest) – The initial request object.

• response (google.cloud.channel_v1.types.ListChannelPartnerLinksResponse) – The initial response object.

• retry (google.api_core.retry.AsyncRetry) – 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.

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, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

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

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.channel_v1.types.ListChannelPartnerLinksRequest) – The initial request object.

• response (google.cloud.channel_v1.types.ListChannelPartnerLinksResponse) – The initial response object.

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

class google.cloud.channel_v1.services.cloud_channel_service.pagers.ListChannelPartnerRepricingConfigsAsyncPager(method: Callable[[...], Awaitable[google.cloud.channel_v1.types.service.ListChannelPartnerRepricingConfigsResponse]], request: google.cloud.channel_v1.types.service.ListChannelPartnerRepricingConfigsRequest, response: google.cloud.channel_v1.types.service.ListChannelPartnerRepricingConfigsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through list_channel_partner_repricing_configs requests.

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

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

All the usual google.cloud.channel_v1.types.ListChannelPartnerRepricingConfigsResponse 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

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.channel_v1.types.ListChannelPartnerRepricingConfigsRequest) – The initial request object.

• response (google.cloud.channel_v1.types.ListChannelPartnerRepricingConfigsResponse) – The initial response object.

• retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.channel_v1.services.cloud_channel_service.pagers.ListChannelPartnerRepricingConfigsPager(method: Callable[[...], google.cloud.channel_v1.types.service.ListChannelPartnerRepricingConfigsResponse], request: google.cloud.channel_v1.types.service.ListChannelPartnerRepricingConfigsRequest, response: google.cloud.channel_v1.types.service.ListChannelPartnerRepricingConfigsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through list_channel_partner_repricing_configs requests.

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

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

All the usual google.cloud.channel_v1.types.ListChannelPartnerRepricingConfigsResponse 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

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.channel_v1.types.ListChannelPartnerRepricingConfigsRequest) – The initial request object.

• response (google.cloud.channel_v1.types.ListChannelPartnerRepricingConfigsResponse) – The initial response object.

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

class google.cloud.channel_v1.services.cloud_channel_service.pagers.ListCustomerRepricingConfigsAsyncPager(method: Callable[[...], Awaitable[google.cloud.channel_v1.types.service.ListCustomerRepricingConfigsResponse]], request: google.cloud.channel_v1.types.service.ListCustomerRepricingConfigsRequest, response: google.cloud.channel_v1.types.service.ListCustomerRepricingConfigsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through list_customer_repricing_configs requests.

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

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

All the usual google.cloud.channel_v1.types.ListCustomerRepricingConfigsResponse 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

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.channel_v1.types.ListCustomerRepricingConfigsRequest) – The initial request object.

• response (google.cloud.channel_v1.types.ListCustomerRepricingConfigsResponse) – The initial response object.

• retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.channel_v1.services.cloud_channel_service.pagers.ListCustomerRepricingConfigsPager(method: Callable[[...], google.cloud.channel_v1.types.service.ListCustomerRepricingConfigsResponse], request: google.cloud.channel_v1.types.service.ListCustomerRepricingConfigsRequest, response: google.cloud.channel_v1.types.service.ListCustomerRepricingConfigsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through list_customer_repricing_configs requests.

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

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

All the usual google.cloud.channel_v1.types.ListCustomerRepricingConfigsResponse 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

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.channel_v1.types.ListCustomerRepricingConfigsRequest) – The initial request object.

• response (google.cloud.channel_v1.types.ListCustomerRepricingConfigsResponse) – The initial response object.

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

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, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

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

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.channel_v1.types.ListCustomersRequest) – The initial request object.

• response (google.cloud.channel_v1.types.ListCustomersResponse) – The initial response object.

• retry (google.api_core.retry.AsyncRetry) – 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.

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, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

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

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.channel_v1.types.ListCustomersRequest) – The initial request object.

• response (google.cloud.channel_v1.types.ListCustomersResponse) – The initial response object.

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

class google.cloud.channel_v1.services.cloud_channel_service.pagers.ListEntitlementChangesAsyncPager(method: Callable[[...], Awaitable[google.cloud.channel_v1.types.service.ListEntitlementChangesResponse]], request: google.cloud.channel_v1.types.service.ListEntitlementChangesRequest, response: google.cloud.channel_v1.types.service.ListEntitlementChangesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through list_entitlement_changes requests.

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

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

All the usual google.cloud.channel_v1.types.ListEntitlementChangesResponse 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

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.channel_v1.types.ListEntitlementChangesRequest) – The initial request object.

• response (google.cloud.channel_v1.types.ListEntitlementChangesResponse) – The initial response object.

• retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.channel_v1.services.cloud_channel_service.pagers.ListEntitlementChangesPager(method: Callable[[...], google.cloud.channel_v1.types.service.ListEntitlementChangesResponse], request: google.cloud.channel_v1.types.service.ListEntitlementChangesRequest, response: google.cloud.channel_v1.types.service.ListEntitlementChangesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through list_entitlement_changes requests.

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

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

All the usual google.cloud.channel_v1.types.ListEntitlementChangesResponse 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

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.channel_v1.types.ListEntitlementChangesRequest) – The initial request object.

• response (google.cloud.channel_v1.types.ListEntitlementChangesResponse) – The initial response object.

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

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, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

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

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.channel_v1.types.ListEntitlementsRequest) – The initial request object.

• response (google.cloud.channel_v1.types.ListEntitlementsResponse) – The initial response object.

• retry (google.api_core.retry.AsyncRetry) – 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.

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, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

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

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.channel_v1.types.ListEntitlementsRequest) – The initial request object.

• response (google.cloud.channel_v1.types.ListEntitlementsResponse) – The initial response object.

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

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, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

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

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.channel_v1.types.ListOffersRequest) – The initial request object.

• response (google.cloud.channel_v1.types.ListOffersResponse) – The initial response object.

• retry (google.api_core.retry.AsyncRetry) – 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.

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, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

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

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.channel_v1.types.ListOffersRequest) – The initial request object.

• response (google.cloud.channel_v1.types.ListOffersResponse) – The initial response object.

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

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, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

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

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.channel_v1.types.ListProductsRequest) – The initial request object.

• response (google.cloud.channel_v1.types.ListProductsResponse) – The initial response object.

• retry (google.api_core.retry.AsyncRetry) – 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.

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, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

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

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.channel_v1.types.ListProductsRequest) – The initial request object.

• response (google.cloud.channel_v1.types.ListProductsResponse) – The initial response object.

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

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, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

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

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.channel_v1.types.ListPurchasableOffersRequest) – The initial request object.

• response (google.cloud.channel_v1.types.ListPurchasableOffersResponse) – The initial response object.

• retry (google.api_core.retry.AsyncRetry) – 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.

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, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

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

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.channel_v1.types.ListPurchasableOffersRequest) – The initial request object.

• response (google.cloud.channel_v1.types.ListPurchasableOffersResponse) – The initial response object.

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

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, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

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

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.channel_v1.types.ListPurchasableSkusRequest) – The initial request object.

• response (google.cloud.channel_v1.types.ListPurchasableSkusResponse) – The initial response object.

• retry (google.api_core.retry.AsyncRetry) – 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.

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, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

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

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.channel_v1.types.ListPurchasableSkusRequest) – The initial request object.

• response (google.cloud.channel_v1.types.ListPurchasableSkusResponse) – The initial response object.

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

class google.cloud.channel_v1.services.cloud_channel_service.pagers.ListSkuGroupBillableSkusAsyncPager(method: Callable[[...], Awaitable[google.cloud.channel_v1.types.service.ListSkuGroupBillableSkusResponse]], request: google.cloud.channel_v1.types.service.ListSkuGroupBillableSkusRequest, response: google.cloud.channel_v1.types.service.ListSkuGroupBillableSkusResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through list_sku_group_billable_skus requests.

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

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

All the usual google.cloud.channel_v1.types.ListSkuGroupBillableSkusResponse 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

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.channel_v1.types.ListSkuGroupBillableSkusRequest) – The initial request object.

• response (google.cloud.channel_v1.types.ListSkuGroupBillableSkusResponse) – The initial response object.

• retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.channel_v1.services.cloud_channel_service.pagers.ListSkuGroupBillableSkusPager(method: Callable[[...], google.cloud.channel_v1.types.service.ListSkuGroupBillableSkusResponse], request: google.cloud.channel_v1.types.service.ListSkuGroupBillableSkusRequest, response: google.cloud.channel_v1.types.service.ListSkuGroupBillableSkusResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through list_sku_group_billable_skus requests.

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

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

All the usual google.cloud.channel_v1.types.ListSkuGroupBillableSkusResponse 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

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.channel_v1.types.ListSkuGroupBillableSkusRequest) – The initial request object.

• response (google.cloud.channel_v1.types.ListSkuGroupBillableSkusResponse) – The initial response object.

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

class google.cloud.channel_v1.services.cloud_channel_service.pagers.ListSkuGroupsAsyncPager(method: Callable[[...], Awaitable[google.cloud.channel_v1.types.service.ListSkuGroupsResponse]], request: google.cloud.channel_v1.types.service.ListSkuGroupsRequest, response: google.cloud.channel_v1.types.service.ListSkuGroupsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through list_sku_groups requests.

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

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

All the usual google.cloud.channel_v1.types.ListSkuGroupsResponse 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

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.channel_v1.types.ListSkuGroupsRequest) – The initial request object.

• response (google.cloud.channel_v1.types.ListSkuGroupsResponse) – The initial response object.

• retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.channel_v1.services.cloud_channel_service.pagers.ListSkuGroupsPager(method: Callable[[...], google.cloud.channel_v1.types.service.ListSkuGroupsResponse], request: google.cloud.channel_v1.types.service.ListSkuGroupsRequest, response: google.cloud.channel_v1.types.service.ListSkuGroupsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through list_sku_groups requests.

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

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

All the usual google.cloud.channel_v1.types.ListSkuGroupsResponse 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

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.channel_v1.types.ListSkuGroupsRequest) – The initial request object.

• response (google.cloud.channel_v1.types.ListSkuGroupsResponse) – The initial response object.

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

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, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

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

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.channel_v1.types.ListSkusRequest) – The initial request object.

• response (google.cloud.channel_v1.types.ListSkusResponse) – The initial response object.

• retry (google.api_core.retry.AsyncRetry) – 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.

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, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

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

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.channel_v1.types.ListSkusRequest) – The initial request object.

• response (google.cloud.channel_v1.types.ListSkusResponse) – The initial response object.

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

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, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

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

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.channel_v1.types.ListSubscribersRequest) – The initial request object.

• response (google.cloud.channel_v1.types.ListSubscribersResponse) – The initial response object.

• retry (google.api_core.retry.AsyncRetry) – 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.

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, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

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

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.channel_v1.types.ListSubscribersRequest) – The initial request object.

• response (google.cloud.channel_v1.types.ListSubscribersResponse) – The initial response object.

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

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, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

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

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.channel_v1.types.ListTransferableOffersRequest) – The initial request object.

• response (google.cloud.channel_v1.types.ListTransferableOffersResponse) – The initial response object.

• retry (google.api_core.retry.AsyncRetry) – 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.

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, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

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

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.channel_v1.types.ListTransferableOffersRequest) – The initial request object.

• response (google.cloud.channel_v1.types.ListTransferableOffersResponse) – The initial response object.

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

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, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

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

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.channel_v1.types.ListTransferableSkusRequest) – The initial request object.

• response (google.cloud.channel_v1.types.ListTransferableSkusResponse) – The initial response object.

• retry (google.api_core.retry.AsyncRetry) – 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.

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, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

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

• method (Callable) – The method that was originally called, and which instantiated this pager.

• request (google.cloud.channel_v1.types.ListTransferableSkusRequest) – The initial request object.

• response (google.cloud.channel_v1.types.ListTransferableSkusResponse) – The initial response object.

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