Class CloudChannelServiceClientImpl (1.1.0)

Version 1.1.0

• 2.14.0 (latest)
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class CloudChannelServiceClientImpl : CloudChannelServiceClient

CloudChannelService client wrapper implementation, for convenient use.

Inheritance

Object > CloudChannelServiceClient > CloudChannelServiceClientImpl

Inherited Members

CloudChannelServiceClient.DefaultEndpoint

CloudChannelServiceClient.DefaultScopes

CloudChannelServiceClient.CreateAsync(CancellationToken)

CloudChannelServiceClient.Create()

CloudChannelServiceClient.ShutdownDefaultChannelsAsync()

CloudChannelServiceClient.GetCustomerAsync(GetCustomerRequest, CancellationToken)

CloudChannelServiceClient.GetCustomer(String, CallSettings)

CloudChannelServiceClient.GetCustomerAsync(String, CallSettings)

CloudChannelServiceClient.GetCustomerAsync(String, CancellationToken)

CloudChannelServiceClient.GetCustomer(CustomerName, CallSettings)

CloudChannelServiceClient.GetCustomerAsync(CustomerName, CallSettings)

CloudChannelServiceClient.GetCustomerAsync(CustomerName, CancellationToken)

CloudChannelServiceClient.CheckCloudIdentityAccountsExistAsync(CheckCloudIdentityAccountsExistRequest, CancellationToken)

CloudChannelServiceClient.CreateCustomerAsync(CreateCustomerRequest, CancellationToken)

CloudChannelServiceClient.UpdateCustomerAsync(UpdateCustomerRequest, CancellationToken)

CloudChannelServiceClient.DeleteCustomerAsync(DeleteCustomerRequest, CancellationToken)

CloudChannelServiceClient.DeleteCustomer(String, CallSettings)

CloudChannelServiceClient.DeleteCustomerAsync(String, CallSettings)

CloudChannelServiceClient.DeleteCustomerAsync(String, CancellationToken)

CloudChannelServiceClient.DeleteCustomer(CustomerName, CallSettings)

CloudChannelServiceClient.DeleteCustomerAsync(CustomerName, CallSettings)

CloudChannelServiceClient.DeleteCustomerAsync(CustomerName, CancellationToken)

CloudChannelServiceClient.ProvisionCloudIdentityAsync(ProvisionCloudIdentityRequest, CancellationToken)

CloudChannelServiceClient.PollOnceProvisionCloudIdentity(String, CallSettings)

CloudChannelServiceClient.PollOnceProvisionCloudIdentityAsync(String, CallSettings)

CloudChannelServiceClient.GetEntitlementAsync(GetEntitlementRequest, CancellationToken)

CloudChannelServiceClient.CreateEntitlementAsync(CreateEntitlementRequest, CancellationToken)

CloudChannelServiceClient.PollOnceCreateEntitlement(String, CallSettings)

CloudChannelServiceClient.PollOnceCreateEntitlementAsync(String, CallSettings)

CloudChannelServiceClient.ChangeParametersAsync(ChangeParametersRequest, CancellationToken)

CloudChannelServiceClient.PollOnceChangeParameters(String, CallSettings)

CloudChannelServiceClient.PollOnceChangeParametersAsync(String, CallSettings)

CloudChannelServiceClient.ChangeRenewalSettingsAsync(ChangeRenewalSettingsRequest, CancellationToken)

CloudChannelServiceClient.PollOnceChangeRenewalSettings(String, CallSettings)

CloudChannelServiceClient.PollOnceChangeRenewalSettingsAsync(String, CallSettings)

CloudChannelServiceClient.ChangeOfferAsync(ChangeOfferRequest, CancellationToken)

CloudChannelServiceClient.PollOnceChangeOffer(String, CallSettings)

CloudChannelServiceClient.PollOnceChangeOfferAsync(String, CallSettings)

CloudChannelServiceClient.StartPaidServiceAsync(StartPaidServiceRequest, CancellationToken)

CloudChannelServiceClient.PollOnceStartPaidService(String, CallSettings)

CloudChannelServiceClient.PollOnceStartPaidServiceAsync(String, CallSettings)

CloudChannelServiceClient.SuspendEntitlementAsync(SuspendEntitlementRequest, CancellationToken)

CloudChannelServiceClient.PollOnceSuspendEntitlement(String, CallSettings)

CloudChannelServiceClient.PollOnceSuspendEntitlementAsync(String, CallSettings)

CloudChannelServiceClient.CancelEntitlementAsync(CancelEntitlementRequest, CancellationToken)

CloudChannelServiceClient.PollOnceCancelEntitlement(String, CallSettings)

CloudChannelServiceClient.PollOnceCancelEntitlementAsync(String, CallSettings)

CloudChannelServiceClient.ActivateEntitlementAsync(ActivateEntitlementRequest, CancellationToken)

CloudChannelServiceClient.PollOnceActivateEntitlement(String, CallSettings)

CloudChannelServiceClient.PollOnceActivateEntitlementAsync(String, CallSettings)

CloudChannelServiceClient.TransferEntitlementsAsync(TransferEntitlementsRequest, CancellationToken)

CloudChannelServiceClient.PollOnceTransferEntitlements(String, CallSettings)

CloudChannelServiceClient.PollOnceTransferEntitlementsAsync(String, CallSettings)

CloudChannelServiceClient.TransferEntitlementsToGoogleAsync(TransferEntitlementsToGoogleRequest, CancellationToken)

CloudChannelServiceClient.PollOnceTransferEntitlementsToGoogle(String, CallSettings)

CloudChannelServiceClient.PollOnceTransferEntitlementsToGoogleAsync(String, CallSettings)

CloudChannelServiceClient.GetChannelPartnerLinkAsync(GetChannelPartnerLinkRequest, CancellationToken)

CloudChannelServiceClient.CreateChannelPartnerLinkAsync(CreateChannelPartnerLinkRequest, CancellationToken)

CloudChannelServiceClient.UpdateChannelPartnerLinkAsync(UpdateChannelPartnerLinkRequest, CancellationToken)

CloudChannelServiceClient.RegisterSubscriberAsync(RegisterSubscriberRequest, CancellationToken)

CloudChannelServiceClient.UnregisterSubscriberAsync(UnregisterSubscriberRequest, CancellationToken)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Channel.V1

Assembly

Google.Cloud.Channel.V1.dll

Remarks

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.

Constructors

CloudChannelServiceClientImpl(CloudChannelService.CloudChannelServiceClient, CloudChannelServiceSettings)

public CloudChannelServiceClientImpl(CloudChannelService.CloudChannelServiceClient grpcClient, CloudChannelServiceSettings settings)

Constructs a client wrapper for the CloudChannelService service, with the specified gRPC client and settings.

Parameters
Name	Description
grpcClient	CloudChannelService.CloudChannelServiceClient The underlying gRPC client.
settings	CloudChannelServiceSettings The base CloudChannelServiceSettings used within this client.

Properties

ActivateEntitlementOperationsClient

public override OperationsClient ActivateEntitlementOperationsClient { get; }

The long-running operations client for ActivateEntitlement.

Property Value
Type	Description
Google.LongRunning.OperationsClient

Overrides

CloudChannelServiceClient.ActivateEntitlementOperationsClient

CancelEntitlementOperationsClient

public override OperationsClient CancelEntitlementOperationsClient { get; }

The long-running operations client for CancelEntitlement.

Property Value
Type	Description
Google.LongRunning.OperationsClient

Overrides

CloudChannelServiceClient.CancelEntitlementOperationsClient

ChangeOfferOperationsClient

public override OperationsClient ChangeOfferOperationsClient { get; }

The long-running operations client for ChangeOffer.

Property Value
Type	Description
Google.LongRunning.OperationsClient

Overrides

CloudChannelServiceClient.ChangeOfferOperationsClient

ChangeParametersOperationsClient

public override OperationsClient ChangeParametersOperationsClient { get; }

The long-running operations client for ChangeParameters.

Property Value
Type	Description
Google.LongRunning.OperationsClient

Overrides

CloudChannelServiceClient.ChangeParametersOperationsClient

ChangeRenewalSettingsOperationsClient

public override OperationsClient ChangeRenewalSettingsOperationsClient { get; }

The long-running operations client for ChangeRenewalSettings.

Property Value
Type	Description
Google.LongRunning.OperationsClient

Overrides

CloudChannelServiceClient.ChangeRenewalSettingsOperationsClient

CreateEntitlementOperationsClient

public override OperationsClient CreateEntitlementOperationsClient { get; }

The long-running operations client for CreateEntitlement.

Property Value
Type	Description
Google.LongRunning.OperationsClient

Overrides

CloudChannelServiceClient.CreateEntitlementOperationsClient

GrpcClient

public override CloudChannelService.CloudChannelServiceClient GrpcClient { get; }

The underlying gRPC CloudChannelService client

Property Value
Type	Description
CloudChannelService.CloudChannelServiceClient

Overrides

CloudChannelServiceClient.GrpcClient

ProvisionCloudIdentityOperationsClient

public override OperationsClient ProvisionCloudIdentityOperationsClient { get; }

The long-running operations client for ProvisionCloudIdentity.

Property Value
Type	Description
Google.LongRunning.OperationsClient

Overrides

CloudChannelServiceClient.ProvisionCloudIdentityOperationsClient

StartPaidServiceOperationsClient

public override OperationsClient StartPaidServiceOperationsClient { get; }

The long-running operations client for StartPaidService.

Property Value
Type	Description
Google.LongRunning.OperationsClient

Overrides

CloudChannelServiceClient.StartPaidServiceOperationsClient

SuspendEntitlementOperationsClient

public override OperationsClient SuspendEntitlementOperationsClient { get; }

The long-running operations client for SuspendEntitlement.

Property Value
Type	Description
Google.LongRunning.OperationsClient

Overrides

CloudChannelServiceClient.SuspendEntitlementOperationsClient

TransferEntitlementsOperationsClient

public override OperationsClient TransferEntitlementsOperationsClient { get; }

The long-running operations client for TransferEntitlements.

Property Value
Type	Description
Google.LongRunning.OperationsClient

Overrides

CloudChannelServiceClient.TransferEntitlementsOperationsClient

TransferEntitlementsToGoogleOperationsClient

public override OperationsClient TransferEntitlementsToGoogleOperationsClient { get; }

The long-running operations client for TransferEntitlementsToGoogle.

Property Value
Type	Description
Google.LongRunning.OperationsClient

Overrides

CloudChannelServiceClient.TransferEntitlementsToGoogleOperationsClient

Methods

ActivateEntitlement(ActivateEntitlementRequest, CallSettings)

public override Operation<Entitlement, OperationMetadata> ActivateEntitlement(ActivateEntitlementRequest request, CallSettings callSettings = null)

Activates a previously suspended entitlement. Entitlements suspended for pending ToS acceptance can't be activated using this method.

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

Possible error codes:

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

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

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

Parameters
Name	Description
request	ActivateEntitlementRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Google.LongRunning.Operation<Entitlement, OperationMetadata>	The RPC response.

Overrides

CloudChannelServiceClient.ActivateEntitlement(ActivateEntitlementRequest, CallSettings)

ActivateEntitlementAsync(ActivateEntitlementRequest, CallSettings)

public override Task<Operation<Entitlement, OperationMetadata>> ActivateEntitlementAsync(ActivateEntitlementRequest request, CallSettings callSettings = null)

Activates a previously suspended entitlement. Entitlements suspended for pending ToS acceptance can't be activated using this method.

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

Possible error codes:

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

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

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

Parameters
Name	Description
request	ActivateEntitlementRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Google.LongRunning.Operation<Entitlement, OperationMetadata>>	A Task containing the RPC response.

Overrides

CloudChannelServiceClient.ActivateEntitlementAsync(ActivateEntitlementRequest, CallSettings)

CancelEntitlement(CancelEntitlementRequest, CallSettings)

public override Operation<Empty, OperationMetadata> CancelEntitlement(CancelEntitlementRequest request, CallSettings callSettings = null)

Cancels a previously fulfilled entitlement.

An entitlement cancellation is a long-running operation.

Possible error codes:

• PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
• FAILED_PRECONDITION: There are Google Cloud projects linked to the Google Cloud entitlement's Cloud Billing subaccount.
• INVALID_ARGUMENT: Required request parameters are missing or invalid.
• NOT_FOUND: Entitlement resource not found.
• DELETION_TYPE_NOT_ALLOWED: Cancel is only allowed for Google Workspace add-ons, or entitlements for Google Cloud's development platform.
• INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
• UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

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

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

Parameters
Name	Description
request	CancelEntitlementRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Google.LongRunning.Operation<Empty, OperationMetadata>	The RPC response.

Overrides

CloudChannelServiceClient.CancelEntitlement(CancelEntitlementRequest, CallSettings)

CancelEntitlementAsync(CancelEntitlementRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> CancelEntitlementAsync(CancelEntitlementRequest request, CallSettings callSettings = null)

Cancels a previously fulfilled entitlement.

An entitlement cancellation is a long-running operation.

Possible error codes:

• PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
• FAILED_PRECONDITION: There are Google Cloud projects linked to the Google Cloud entitlement's Cloud Billing subaccount.
• INVALID_ARGUMENT: Required request parameters are missing or invalid.
• NOT_FOUND: Entitlement resource not found.
• DELETION_TYPE_NOT_ALLOWED: Cancel is only allowed for Google Workspace add-ons, or entitlements for Google Cloud's development platform.
• INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
• UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

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

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

Parameters
Name	Description
request	CancelEntitlementRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Google.LongRunning.Operation<Empty, OperationMetadata>>	A Task containing the RPC response.

Overrides

CloudChannelServiceClient.CancelEntitlementAsync(CancelEntitlementRequest, CallSettings)

ChangeOffer(ChangeOfferRequest, CallSettings)

public override Operation<Entitlement, OperationMetadata> ChangeOffer(ChangeOfferRequest request, CallSettings callSettings = null)

Updates the Offer for an existing customer entitlement.

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

Possible error codes:

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

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

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

Parameters
Name	Description
request	ChangeOfferRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Google.LongRunning.Operation<Entitlement, OperationMetadata>	The RPC response.

Overrides

CloudChannelServiceClient.ChangeOffer(ChangeOfferRequest, CallSettings)

ChangeOfferAsync(ChangeOfferRequest, CallSettings)

public override Task<Operation<Entitlement, OperationMetadata>> ChangeOfferAsync(ChangeOfferRequest request, CallSettings callSettings = null)

Updates the Offer for an existing customer entitlement.

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

Possible error codes:

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

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

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

Parameters
Name	Description
request	ChangeOfferRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Google.LongRunning.Operation<Entitlement, OperationMetadata>>	A Task containing the RPC response.

Overrides

CloudChannelServiceClient.ChangeOfferAsync(ChangeOfferRequest, CallSettings)

ChangeParameters(ChangeParametersRequest, CallSettings)

public override Operation<Entitlement, OperationMetadata> ChangeParameters(ChangeParametersRequest request, CallSettings callSettings = null)

Change parameters of the entitlement.

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

Possible error codes:

• PERMISSION_DENIED: The customer doesn't belong to the reseller.
• INVALID_ARGUMENT: Required request parameters are missing or invalid. For example, the number of seats being changed is greater than the allowed number of max seats, or decreasing seats for a commitment based plan.
• NOT_FOUND: Entitlement resource not found.
• INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
• UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

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

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

Parameters
Name	Description
request	ChangeParametersRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Google.LongRunning.Operation<Entitlement, OperationMetadata>	The RPC response.

Overrides

CloudChannelServiceClient.ChangeParameters(ChangeParametersRequest, CallSettings)

ChangeParametersAsync(ChangeParametersRequest, CallSettings)

public override Task<Operation<Entitlement, OperationMetadata>> ChangeParametersAsync(ChangeParametersRequest request, CallSettings callSettings = null)

Change parameters of the entitlement.

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

Possible error codes:

• PERMISSION_DENIED: The customer doesn't belong to the reseller.
• INVALID_ARGUMENT: Required request parameters are missing or invalid. For example, the number of seats being changed is greater than the allowed number of max seats, or decreasing seats for a commitment based plan.
• NOT_FOUND: Entitlement resource not found.
• INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
• UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

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

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

Parameters
Name	Description
request	ChangeParametersRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Google.LongRunning.Operation<Entitlement, OperationMetadata>>	A Task containing the RPC response.

Overrides

CloudChannelServiceClient.ChangeParametersAsync(ChangeParametersRequest, CallSettings)

ChangeRenewalSettings(ChangeRenewalSettingsRequest, CallSettings)

public override Operation<Entitlement, OperationMetadata> ChangeRenewalSettings(ChangeRenewalSettingsRequest request, CallSettings callSettings = null)

Updates the renewal settings for an existing customer entitlement.

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

Possible error codes:

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

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

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

Parameters
Name	Description
request	ChangeRenewalSettingsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Google.LongRunning.Operation<Entitlement, OperationMetadata>	The RPC response.

Overrides

CloudChannelServiceClient.ChangeRenewalSettings(ChangeRenewalSettingsRequest, CallSettings)

ChangeRenewalSettingsAsync(ChangeRenewalSettingsRequest, CallSettings)

public override Task<Operation<Entitlement, OperationMetadata>> ChangeRenewalSettingsAsync(ChangeRenewalSettingsRequest request, CallSettings callSettings = null)

Updates the renewal settings for an existing customer entitlement.

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

Possible error codes:

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

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

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

Parameters
Name	Description
request	ChangeRenewalSettingsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Google.LongRunning.Operation<Entitlement, OperationMetadata>>	A Task containing the RPC response.

Overrides

CloudChannelServiceClient.ChangeRenewalSettingsAsync(ChangeRenewalSettingsRequest, CallSettings)

CheckCloudIdentityAccountsExist(CheckCloudIdentityAccountsExistRequest, CallSettings)

public override CheckCloudIdentityAccountsExistResponse CheckCloudIdentityAccountsExist(CheckCloudIdentityAccountsExistRequest request, CallSettings callSettings = null)

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

Possible error codes:

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

Return value: A list of [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] resources for the domain (may be empty)

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

Parameters
Name	Description
request	CheckCloudIdentityAccountsExistRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
CheckCloudIdentityAccountsExistResponse	The RPC response.

Overrides

CloudChannelServiceClient.CheckCloudIdentityAccountsExist(CheckCloudIdentityAccountsExistRequest, CallSettings)

CheckCloudIdentityAccountsExistAsync(CheckCloudIdentityAccountsExistRequest, CallSettings)

public override Task<CheckCloudIdentityAccountsExistResponse> CheckCloudIdentityAccountsExistAsync(CheckCloudIdentityAccountsExistRequest request, CallSettings callSettings = null)

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

Possible error codes:

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

Return value: A list of [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] resources for the domain (may be empty)

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

Parameters
Name	Description
request	CheckCloudIdentityAccountsExistRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<CheckCloudIdentityAccountsExistResponse>	A Task containing the RPC response.

Overrides

CloudChannelServiceClient.CheckCloudIdentityAccountsExistAsync(CheckCloudIdentityAccountsExistRequest, CallSettings)

CreateChannelPartnerLink(CreateChannelPartnerLinkRequest, CallSettings)

public override ChannelPartnerLink CreateChannelPartnerLink(CreateChannelPartnerLinkRequest request, CallSettings callSettings = null)

Initiates a channel partner link between a distributor and a reseller, or between resellers in an n-tier reseller channel. Invited partners need to follow the invite_link_uri provided in the response to accept. After accepting the invitation, a link is set up between the two parties. You must be a distributor to call this method.

Possible error codes:

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

Return value: The new [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource.

Parameters
Name	Description
request	CreateChannelPartnerLinkRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ChannelPartnerLink	The RPC response.

Overrides

CloudChannelServiceClient.CreateChannelPartnerLink(CreateChannelPartnerLinkRequest, CallSettings)

CreateChannelPartnerLinkAsync(CreateChannelPartnerLinkRequest, CallSettings)

public override Task<ChannelPartnerLink> CreateChannelPartnerLinkAsync(CreateChannelPartnerLinkRequest request, CallSettings callSettings = null)

Initiates a channel partner link between a distributor and a reseller, or between resellers in an n-tier reseller channel. Invited partners need to follow the invite_link_uri provided in the response to accept. After accepting the invitation, a link is set up between the two parties. You must be a distributor to call this method.

Possible error codes:

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

Return value: The new [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource.

Parameters
Name	Description
request	CreateChannelPartnerLinkRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<ChannelPartnerLink>	A Task containing the RPC response.

Overrides

CloudChannelServiceClient.CreateChannelPartnerLinkAsync(CreateChannelPartnerLinkRequest, CallSettings)

CreateCustomer(CreateCustomerRequest, CallSettings)

public override Customer CreateCustomer(CreateCustomerRequest request, CallSettings callSettings = null)

Creates a new [Customer][google.cloud.channel.v1.Customer] resource under the reseller or distributor account.

Possible error codes:

• PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
• INVALID_ARGUMENT:
• Required request parameters are missing or invalid.
• Domain field value doesn't match the primary email domain.

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

Parameters
Name	Description
request	CreateCustomerRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Customer	The RPC response.

Overrides

CloudChannelServiceClient.CreateCustomer(CreateCustomerRequest, CallSettings)

CreateCustomerAsync(CreateCustomerRequest, CallSettings)

public override Task<Customer> CreateCustomerAsync(CreateCustomerRequest request, CallSettings callSettings = null)

Creates a new [Customer][google.cloud.channel.v1.Customer] resource under the reseller or distributor account.

Possible error codes:

• PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
• INVALID_ARGUMENT:
• Required request parameters are missing or invalid.
• Domain field value doesn't match the primary email domain.

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

Parameters
Name	Description
request	CreateCustomerRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Customer>	A Task containing the RPC response.

Overrides

CloudChannelServiceClient.CreateCustomerAsync(CreateCustomerRequest, CallSettings)

CreateEntitlement(CreateEntitlementRequest, CallSettings)

public override Operation<Entitlement, OperationMetadata> CreateEntitlement(CreateEntitlementRequest request, CallSettings callSettings = null)

Creates an entitlement for a customer.

Possible error codes:

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

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

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

Parameters
Name	Description
request	CreateEntitlementRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Google.LongRunning.Operation<Entitlement, OperationMetadata>	The RPC response.

Overrides

CloudChannelServiceClient.CreateEntitlement(CreateEntitlementRequest, CallSettings)

CreateEntitlementAsync(CreateEntitlementRequest, CallSettings)

public override Task<Operation<Entitlement, OperationMetadata>> CreateEntitlementAsync(CreateEntitlementRequest request, CallSettings callSettings = null)

Creates an entitlement for a customer.

Possible error codes:

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

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

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

Parameters
Name	Description
request	CreateEntitlementRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Google.LongRunning.Operation<Entitlement, OperationMetadata>>	A Task containing the RPC response.

Overrides

CloudChannelServiceClient.CreateEntitlementAsync(CreateEntitlementRequest, CallSettings)

DeleteCustomer(DeleteCustomerRequest, CallSettings)

public override void DeleteCustomer(DeleteCustomerRequest request, CallSettings callSettings = null)

Deletes the given [Customer][google.cloud.channel.v1.Customer] permanently and irreversibly.

Possible error codes:

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

Parameters
Name	Description
request	DeleteCustomerRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Overrides

CloudChannelServiceClient.DeleteCustomer(DeleteCustomerRequest, CallSettings)

DeleteCustomerAsync(DeleteCustomerRequest, CallSettings)

public override Task DeleteCustomerAsync(DeleteCustomerRequest request, CallSettings callSettings = null)

Deletes the given [Customer][google.cloud.channel.v1.Customer] permanently and irreversibly.

Possible error codes:

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

Parameters
Name	Description
request	DeleteCustomerRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task	A Task containing the RPC response.

Overrides

CloudChannelServiceClient.DeleteCustomerAsync(DeleteCustomerRequest, CallSettings)

GetChannelPartnerLink(GetChannelPartnerLinkRequest, CallSettings)

public override ChannelPartnerLink GetChannelPartnerLink(GetChannelPartnerLinkRequest request, CallSettings callSettings = null)

Returns a requested [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource. You must be a distributor to call this method.

Possible error codes:

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

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

Parameters
Name	Description
request	GetChannelPartnerLinkRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ChannelPartnerLink	The RPC response.

Overrides

CloudChannelServiceClient.GetChannelPartnerLink(GetChannelPartnerLinkRequest, CallSettings)

GetChannelPartnerLinkAsync(GetChannelPartnerLinkRequest, CallSettings)

public override Task<ChannelPartnerLink> GetChannelPartnerLinkAsync(GetChannelPartnerLinkRequest request, CallSettings callSettings = null)

Returns a requested [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource. You must be a distributor to call this method.

Possible error codes:

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

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

Parameters
Name	Description
request	GetChannelPartnerLinkRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<ChannelPartnerLink>	A Task containing the RPC response.

Overrides

CloudChannelServiceClient.GetChannelPartnerLinkAsync(GetChannelPartnerLinkRequest, CallSettings)

GetCustomer(GetCustomerRequest, CallSettings)

public override Customer GetCustomer(GetCustomerRequest request, CallSettings callSettings = null)

Returns a requested [Customer][google.cloud.channel.v1.Customer] resource.

Possible error codes:

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

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

Parameters
Name	Description
request	GetCustomerRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Customer	The RPC response.

Overrides

CloudChannelServiceClient.GetCustomer(GetCustomerRequest, CallSettings)

GetCustomerAsync(GetCustomerRequest, CallSettings)

public override Task<Customer> GetCustomerAsync(GetCustomerRequest request, CallSettings callSettings = null)

Returns a requested [Customer][google.cloud.channel.v1.Customer] resource.

Possible error codes:

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

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

Parameters
Name	Description
request	GetCustomerRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Customer>	A Task containing the RPC response.

Overrides

CloudChannelServiceClient.GetCustomerAsync(GetCustomerRequest, CallSettings)

GetEntitlement(GetEntitlementRequest, CallSettings)

public override Entitlement GetEntitlement(GetEntitlementRequest request, CallSettings callSettings = null)

Returns a requested [Entitlement][google.cloud.channel.v1.Entitlement] resource.

Possible error codes:

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

Return value: The requested [Entitlement][google.cloud.channel.v1.Entitlement] resource.

Parameters
Name	Description
request	GetEntitlementRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Entitlement	The RPC response.

Overrides

CloudChannelServiceClient.GetEntitlement(GetEntitlementRequest, CallSettings)

GetEntitlementAsync(GetEntitlementRequest, CallSettings)

public override Task<Entitlement> GetEntitlementAsync(GetEntitlementRequest request, CallSettings callSettings = null)

Returns a requested [Entitlement][google.cloud.channel.v1.Entitlement] resource.

Possible error codes:

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

Return value: The requested [Entitlement][google.cloud.channel.v1.Entitlement] resource.

Parameters
Name	Description
request	GetEntitlementRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Entitlement>	A Task containing the RPC response.

Overrides

CloudChannelServiceClient.GetEntitlementAsync(GetEntitlementRequest, CallSettings)

ListChannelPartnerLinks(ListChannelPartnerLinksRequest, CallSettings)

public override PagedEnumerable<ListChannelPartnerLinksResponse, ChannelPartnerLink> ListChannelPartnerLinks(ListChannelPartnerLinksRequest request, CallSettings callSettings = null)

List [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]s belonging to a distributor. You must be a distributor to call this method.

Possible error codes:

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

Return value: The list of the distributor account's [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resources.

Parameters
Name	Description
request	ListChannelPartnerLinksRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerable<ListChannelPartnerLinksResponse, ChannelPartnerLink>	A pageable sequence of ChannelPartnerLink resources.

Overrides

CloudChannelServiceClient.ListChannelPartnerLinks(ListChannelPartnerLinksRequest, CallSettings)

ListChannelPartnerLinksAsync(ListChannelPartnerLinksRequest, CallSettings)

public override PagedAsyncEnumerable<ListChannelPartnerLinksResponse, ChannelPartnerLink> ListChannelPartnerLinksAsync(ListChannelPartnerLinksRequest request, CallSettings callSettings = null)

List [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]s belonging to a distributor. You must be a distributor to call this method.

Possible error codes:

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

Return value: The list of the distributor account's [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resources.

Parameters
Name	Description
request	ListChannelPartnerLinksRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerable<ListChannelPartnerLinksResponse, ChannelPartnerLink>	A pageable asynchronous sequence of ChannelPartnerLink resources.

Overrides

CloudChannelServiceClient.ListChannelPartnerLinksAsync(ListChannelPartnerLinksRequest, CallSettings)

ListCustomers(ListCustomersRequest, CallSettings)

public override PagedEnumerable<ListCustomersResponse, Customer> ListCustomers(ListCustomersRequest request, CallSettings callSettings = null)

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

Possible error codes:

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

Return value: List of [Customer][google.cloud.channel.v1.Customer]s, or an empty list if there are no customers.

Parameters
Name	Description
request	ListCustomersRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerable<ListCustomersResponse, Customer>	A pageable sequence of Customer resources.

Overrides

CloudChannelServiceClient.ListCustomers(ListCustomersRequest, CallSettings)

ListCustomersAsync(ListCustomersRequest, CallSettings)

public override PagedAsyncEnumerable<ListCustomersResponse, Customer> ListCustomersAsync(ListCustomersRequest request, CallSettings callSettings = null)

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

Possible error codes:

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

Return value: List of [Customer][google.cloud.channel.v1.Customer]s, or an empty list if there are no customers.

Parameters
Name	Description
request	ListCustomersRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerable<ListCustomersResponse, Customer>	A pageable asynchronous sequence of Customer resources.

Overrides

CloudChannelServiceClient.ListCustomersAsync(ListCustomersRequest, CallSettings)

ListEntitlements(ListEntitlementsRequest, CallSettings)

public override PagedEnumerable<ListEntitlementsResponse, Entitlement> ListEntitlements(ListEntitlementsRequest request, CallSettings callSettings = null)

Lists [Entitlement][google.cloud.channel.v1.Entitlement]s belonging to a customer.

Possible error codes:

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

Return value: A list of the customer's [Entitlement][google.cloud.channel.v1.Entitlement]s.

Parameters
Name	Description
request	ListEntitlementsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerable<ListEntitlementsResponse, Entitlement>	A pageable sequence of Entitlement resources.

Overrides

CloudChannelServiceClient.ListEntitlements(ListEntitlementsRequest, CallSettings)

ListEntitlementsAsync(ListEntitlementsRequest, CallSettings)

public override PagedAsyncEnumerable<ListEntitlementsResponse, Entitlement> ListEntitlementsAsync(ListEntitlementsRequest request, CallSettings callSettings = null)

Lists [Entitlement][google.cloud.channel.v1.Entitlement]s belonging to a customer.

Possible error codes:

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

Return value: A list of the customer's [Entitlement][google.cloud.channel.v1.Entitlement]s.

Parameters
Name	Description
request	ListEntitlementsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerable<ListEntitlementsResponse, Entitlement>	A pageable asynchronous sequence of Entitlement resources.

Overrides

CloudChannelServiceClient.ListEntitlementsAsync(ListEntitlementsRequest, CallSettings)

ListOffers(ListOffersRequest, CallSettings)

public override PagedEnumerable<ListOffersResponse, Offer> ListOffers(ListOffersRequest request, CallSettings callSettings = null)

Lists the Offers the reseller can sell.

Possible error codes:

• INVALID_ARGUMENT: Required request parameters are missing or invalid.

Parameters
Name	Description
request	ListOffersRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerable<ListOffersResponse, Offer>	A pageable sequence of Offer resources.

Overrides

CloudChannelServiceClient.ListOffers(ListOffersRequest, CallSettings)

ListOffersAsync(ListOffersRequest, CallSettings)

public override PagedAsyncEnumerable<ListOffersResponse, Offer> ListOffersAsync(ListOffersRequest request, CallSettings callSettings = null)

Lists the Offers the reseller can sell.

Possible error codes:

• INVALID_ARGUMENT: Required request parameters are missing or invalid.

Parameters
Name	Description
request	ListOffersRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerable<ListOffersResponse, Offer>	A pageable asynchronous sequence of Offer resources.

Overrides

CloudChannelServiceClient.ListOffersAsync(ListOffersRequest, CallSettings)

ListProducts(ListProductsRequest, CallSettings)

public override PagedEnumerable<ListProductsResponse, Product> ListProducts(ListProductsRequest request, CallSettings callSettings = null)

Lists the Products the reseller is authorized to sell.

Possible error codes:

• INVALID_ARGUMENT: Required request parameters are missing or invalid.

Parameters
Name	Description
request	ListProductsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerable<ListProductsResponse, Product>	A pageable sequence of Product resources.

Overrides

CloudChannelServiceClient.ListProducts(ListProductsRequest, CallSettings)

ListProductsAsync(ListProductsRequest, CallSettings)

public override PagedAsyncEnumerable<ListProductsResponse, Product> ListProductsAsync(ListProductsRequest request, CallSettings callSettings = null)

Lists the Products the reseller is authorized to sell.

Possible error codes:

• INVALID_ARGUMENT: Required request parameters are missing or invalid.

Parameters
Name	Description
request	ListProductsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerable<ListProductsResponse, Product>	A pageable asynchronous sequence of Product resources.

Overrides

CloudChannelServiceClient.ListProductsAsync(ListProductsRequest, CallSettings)

ListPurchasableOffers(ListPurchasableOffersRequest, CallSettings)

public override PagedEnumerable<ListPurchasableOffersResponse, PurchasableOffer> ListPurchasableOffers(ListPurchasableOffersRequest request, CallSettings callSettings = null)

Lists the following:

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

Possible error codes:

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

Parameters
Name	Description
request	ListPurchasableOffersRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerable<ListPurchasableOffersResponse, PurchasableOffer>	A pageable sequence of PurchasableOffer resources.

Overrides

CloudChannelServiceClient.ListPurchasableOffers(ListPurchasableOffersRequest, CallSettings)

ListPurchasableOffersAsync(ListPurchasableOffersRequest, CallSettings)

public override PagedAsyncEnumerable<ListPurchasableOffersResponse, PurchasableOffer> ListPurchasableOffersAsync(ListPurchasableOffersRequest request, CallSettings callSettings = null)

Lists the following:

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

Possible error codes:

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

Parameters
Name	Description
request	ListPurchasableOffersRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerable<ListPurchasableOffersResponse, PurchasableOffer>	A pageable asynchronous sequence of PurchasableOffer resources.

Overrides

CloudChannelServiceClient.ListPurchasableOffersAsync(ListPurchasableOffersRequest, CallSettings)

ListPurchasableSkus(ListPurchasableSkusRequest, CallSettings)

public override PagedEnumerable<ListPurchasableSkusResponse, PurchasableSku> ListPurchasableSkus(ListPurchasableSkusRequest request, CallSettings callSettings = null)

Lists the following:

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

Possible error codes:

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

Parameters
Name	Description
request	ListPurchasableSkusRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerable<ListPurchasableSkusResponse, PurchasableSku>	A pageable sequence of PurchasableSku resources.

Overrides

CloudChannelServiceClient.ListPurchasableSkus(ListPurchasableSkusRequest, CallSettings)

ListPurchasableSkusAsync(ListPurchasableSkusRequest, CallSettings)

public override PagedAsyncEnumerable<ListPurchasableSkusResponse, PurchasableSku> ListPurchasableSkusAsync(ListPurchasableSkusRequest request, CallSettings callSettings = null)

Lists the following:

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

Possible error codes:

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

Parameters
Name	Description
request	ListPurchasableSkusRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerable<ListPurchasableSkusResponse, PurchasableSku>	A pageable asynchronous sequence of PurchasableSku resources.

Overrides

CloudChannelServiceClient.ListPurchasableSkusAsync(ListPurchasableSkusRequest, CallSettings)

ListSkus(ListSkusRequest, CallSettings)

public override PagedEnumerable<ListSkusResponse, Sku> ListSkus(ListSkusRequest request, CallSettings callSettings = null)

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

Possible error codes:

• INVALID_ARGUMENT: Required request parameters are missing or invalid.

Parameters
Name	Description
request	ListSkusRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerable<ListSkusResponse, Sku>	A pageable sequence of Sku resources.

Overrides

CloudChannelServiceClient.ListSkus(ListSkusRequest, CallSettings)

ListSkusAsync(ListSkusRequest, CallSettings)

public override PagedAsyncEnumerable<ListSkusResponse, Sku> ListSkusAsync(ListSkusRequest request, CallSettings callSettings = null)

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

Possible error codes:

• INVALID_ARGUMENT: Required request parameters are missing or invalid.

Parameters
Name	Description
request	ListSkusRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerable<ListSkusResponse, Sku>	A pageable asynchronous sequence of Sku resources.

Overrides

CloudChannelServiceClient.ListSkusAsync(ListSkusRequest, CallSettings)

ListSubscribers(ListSubscribersRequest, CallSettings)

public override PagedEnumerable<ListSubscribersResponse, string> ListSubscribers(ListSubscribersRequest request, CallSettings callSettings = null)

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

Possible error codes:

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

Return value: A list of service email addresses.

Parameters
Name	Description
request	ListSubscribersRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerable<ListSubscribersResponse, String>	A pageable sequence of String resources.

Overrides

CloudChannelServiceClient.ListSubscribers(ListSubscribersRequest, CallSettings)

ListSubscribersAsync(ListSubscribersRequest, CallSettings)

public override PagedAsyncEnumerable<ListSubscribersResponse, string> ListSubscribersAsync(ListSubscribersRequest request, CallSettings callSettings = null)

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

Possible error codes:

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

Return value: A list of service email addresses.

Parameters
Name	Description
request	ListSubscribersRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerable<ListSubscribersResponse, String>	A pageable asynchronous sequence of String resources.

Overrides

CloudChannelServiceClient.ListSubscribersAsync(ListSubscribersRequest, CallSettings)

ListTransferableOffers(ListTransferableOffersRequest, CallSettings)

public override PagedEnumerable<ListTransferableOffersResponse, TransferableOffer> ListTransferableOffers(ListTransferableOffersRequest request, CallSettings callSettings = null)

List [TransferableOffer][google.cloud.channel.v1.TransferableOffer]s of a customer based on Cloud Identity ID or Customer Name in the request.

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

Possible error codes:

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

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

Parameters
Name	Description
request	ListTransferableOffersRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerable<ListTransferableOffersResponse, TransferableOffer>	A pageable sequence of TransferableOffer resources.

Overrides

CloudChannelServiceClient.ListTransferableOffers(ListTransferableOffersRequest, CallSettings)

ListTransferableOffersAsync(ListTransferableOffersRequest, CallSettings)

public override PagedAsyncEnumerable<ListTransferableOffersResponse, TransferableOffer> ListTransferableOffersAsync(ListTransferableOffersRequest request, CallSettings callSettings = null)

List [TransferableOffer][google.cloud.channel.v1.TransferableOffer]s of a customer based on Cloud Identity ID or Customer Name in the request.

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

Possible error codes:

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

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

Parameters
Name	Description
request	ListTransferableOffersRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerable<ListTransferableOffersResponse, TransferableOffer>	A pageable asynchronous sequence of TransferableOffer resources.

Overrides

CloudChannelServiceClient.ListTransferableOffersAsync(ListTransferableOffersRequest, CallSettings)

ListTransferableSkus(ListTransferableSkusRequest, CallSettings)

public override PagedEnumerable<ListTransferableSkusResponse, TransferableSku> ListTransferableSkus(ListTransferableSkusRequest request, CallSettings callSettings = null)

List [TransferableSku][google.cloud.channel.v1.TransferableSku]s of a customer based on the Cloud Identity ID or Customer Name in the request.

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

Possible error codes:

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

Return value: A list of the customer's [TransferableSku][google.cloud.channel.v1.TransferableSku].

Parameters
Name	Description
request	ListTransferableSkusRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerable<ListTransferableSkusResponse, TransferableSku>	A pageable sequence of TransferableSku resources.

Overrides

CloudChannelServiceClient.ListTransferableSkus(ListTransferableSkusRequest, CallSettings)

ListTransferableSkusAsync(ListTransferableSkusRequest, CallSettings)

public override PagedAsyncEnumerable<ListTransferableSkusResponse, TransferableSku> ListTransferableSkusAsync(ListTransferableSkusRequest request, CallSettings callSettings = null)

List [TransferableSku][google.cloud.channel.v1.TransferableSku]s of a customer based on the Cloud Identity ID or Customer Name in the request.

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

Possible error codes:

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

Return value: A list of the customer's [TransferableSku][google.cloud.channel.v1.TransferableSku].

Parameters
Name	Description
request	ListTransferableSkusRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerable<ListTransferableSkusResponse, TransferableSku>	A pageable asynchronous sequence of TransferableSku resources.

Overrides

CloudChannelServiceClient.ListTransferableSkusAsync(ListTransferableSkusRequest, CallSettings)

ProvisionCloudIdentity(ProvisionCloudIdentityRequest, CallSettings)

public override Operation<Customer, OperationMetadata> ProvisionCloudIdentity(ProvisionCloudIdentityRequest request, CallSettings callSettings = null)

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

Possible error codes:

• PERMISSION_DENIED: The customer doesn't belong to the reseller.
• INVALID_ARGUMENT: Required request parameters are missing or invalid.
• NOT_FOUND: The customer was not found.
• ALREADY_EXISTS: The customer's primary email already exists. Retry after changing the customer's primary contact email.
• INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
• UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

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

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

Parameters
Name	Description
request	ProvisionCloudIdentityRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Google.LongRunning.Operation<Customer, OperationMetadata>	The RPC response.

Overrides

CloudChannelServiceClient.ProvisionCloudIdentity(ProvisionCloudIdentityRequest, CallSettings)

ProvisionCloudIdentityAsync(ProvisionCloudIdentityRequest, CallSettings)

public override Task<Operation<Customer, OperationMetadata>> ProvisionCloudIdentityAsync(ProvisionCloudIdentityRequest request, CallSettings callSettings = null)

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

Possible error codes:

• PERMISSION_DENIED: The customer doesn't belong to the reseller.
• INVALID_ARGUMENT: Required request parameters are missing or invalid.
• NOT_FOUND: The customer was not found.
• ALREADY_EXISTS: The customer's primary email already exists. Retry after changing the customer's primary contact email.
• INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
• UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

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

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

Parameters
Name	Description
request	ProvisionCloudIdentityRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Google.LongRunning.Operation<Customer, OperationMetadata>>	A Task containing the RPC response.

Overrides

CloudChannelServiceClient.ProvisionCloudIdentityAsync(ProvisionCloudIdentityRequest, CallSettings)

RegisterSubscriber(RegisterSubscriberRequest, CallSettings)

public override RegisterSubscriberResponse RegisterSubscriber(RegisterSubscriberRequest request, CallSettings callSettings = null)

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

Possible error codes:

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

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

Parameters
Name	Description
request	RegisterSubscriberRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
RegisterSubscriberResponse	The RPC response.

Overrides

CloudChannelServiceClient.RegisterSubscriber(RegisterSubscriberRequest, CallSettings)

RegisterSubscriberAsync(RegisterSubscriberRequest, CallSettings)

public override Task<RegisterSubscriberResponse> RegisterSubscriberAsync(RegisterSubscriberRequest request, CallSettings callSettings = null)

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

Possible error codes:

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

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

Parameters
Name	Description
request	RegisterSubscriberRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<RegisterSubscriberResponse>	A Task containing the RPC response.

Overrides

CloudChannelServiceClient.RegisterSubscriberAsync(RegisterSubscriberRequest, CallSettings)

StartPaidService(StartPaidServiceRequest, CallSettings)

public override Operation<Entitlement, OperationMetadata> StartPaidService(StartPaidServiceRequest request, CallSettings callSettings = null)

Starts paid service for a trial entitlement.

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

Possible error codes:

• PERMISSION_DENIED: The customer doesn't belong to the reseller.
• INVALID_ARGUMENT: Required request parameters are missing or invalid.
• NOT_FOUND: Entitlement resource not found.
• FAILED_PRECONDITION/NOT_IN_TRIAL: This method only works for entitlement on trial plans.
• INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
• UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

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

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

Parameters
Name	Description
request	StartPaidServiceRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Google.LongRunning.Operation<Entitlement, OperationMetadata>	The RPC response.

Overrides

CloudChannelServiceClient.StartPaidService(StartPaidServiceRequest, CallSettings)

StartPaidServiceAsync(StartPaidServiceRequest, CallSettings)

public override Task<Operation<Entitlement, OperationMetadata>> StartPaidServiceAsync(StartPaidServiceRequest request, CallSettings callSettings = null)

Starts paid service for a trial entitlement.

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

Possible error codes:

• PERMISSION_DENIED: The customer doesn't belong to the reseller.
• INVALID_ARGUMENT: Required request parameters are missing or invalid.
• NOT_FOUND: Entitlement resource not found.
• FAILED_PRECONDITION/NOT_IN_TRIAL: This method only works for entitlement on trial plans.
• INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
• UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.

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

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

Parameters
Name	Description
request	StartPaidServiceRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Google.LongRunning.Operation<Entitlement, OperationMetadata>>	A Task containing the RPC response.

Overrides

CloudChannelServiceClient.StartPaidServiceAsync(StartPaidServiceRequest, CallSettings)

SuspendEntitlement(SuspendEntitlementRequest, CallSettings)

public override Operation<Entitlement, OperationMetadata> SuspendEntitlement(SuspendEntitlementRequest request, CallSettings callSettings = null)

Suspends a previously fulfilled entitlement.

An entitlement suspension is a long-running operation.

Possible error codes:

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

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

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

Parameters
Name	Description
request	SuspendEntitlementRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Google.LongRunning.Operation<Entitlement, OperationMetadata>	The RPC response.

Overrides

CloudChannelServiceClient.SuspendEntitlement(SuspendEntitlementRequest, CallSettings)

SuspendEntitlementAsync(SuspendEntitlementRequest, CallSettings)

public override Task<Operation<Entitlement, OperationMetadata>> SuspendEntitlementAsync(SuspendEntitlementRequest request, CallSettings callSettings = null)

Suspends a previously fulfilled entitlement.

An entitlement suspension is a long-running operation.

Possible error codes:

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

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

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

Parameters
Name	Description
request	SuspendEntitlementRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Google.LongRunning.Operation<Entitlement, OperationMetadata>>	A Task containing the RPC response.

Overrides

CloudChannelServiceClient.SuspendEntitlementAsync(SuspendEntitlementRequest, CallSettings)

TransferEntitlements(TransferEntitlementsRequest, CallSettings)

public override Operation<TransferEntitlementsResponse, OperationMetadata> TransferEntitlements(TransferEntitlementsRequest request, CallSettings callSettings = null)

Transfers customer entitlements to new reseller.

Possible error codes:

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

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

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

Parameters
Name	Description
request	TransferEntitlementsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Google.LongRunning.Operation<TransferEntitlementsResponse, OperationMetadata>	The RPC response.

Overrides

CloudChannelServiceClient.TransferEntitlements(TransferEntitlementsRequest, CallSettings)

TransferEntitlementsAsync(TransferEntitlementsRequest, CallSettings)

public override Task<Operation<TransferEntitlementsResponse, OperationMetadata>> TransferEntitlementsAsync(TransferEntitlementsRequest request, CallSettings callSettings = null)

Transfers customer entitlements to new reseller.

Possible error codes:

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

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

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

Parameters
Name	Description
request	TransferEntitlementsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Google.LongRunning.Operation<TransferEntitlementsResponse, OperationMetadata>>	A Task containing the RPC response.

Overrides

CloudChannelServiceClient.TransferEntitlementsAsync(TransferEntitlementsRequest, CallSettings)

TransferEntitlementsToGoogle(TransferEntitlementsToGoogleRequest, CallSettings)

public override Operation<Empty, OperationMetadata> TransferEntitlementsToGoogle(TransferEntitlementsToGoogleRequest request, CallSettings callSettings = null)

Transfers customer entitlements from their current reseller to Google.

Possible error codes:

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

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

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

Parameters
Name	Description
request	TransferEntitlementsToGoogleRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Google.LongRunning.Operation<Empty, OperationMetadata>	The RPC response.

Overrides

CloudChannelServiceClient.TransferEntitlementsToGoogle(TransferEntitlementsToGoogleRequest, CallSettings)

TransferEntitlementsToGoogleAsync(TransferEntitlementsToGoogleRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> TransferEntitlementsToGoogleAsync(TransferEntitlementsToGoogleRequest request, CallSettings callSettings = null)

Transfers customer entitlements from their current reseller to Google.

Possible error codes:

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

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

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

Parameters
Name	Description
request	TransferEntitlementsToGoogleRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Google.LongRunning.Operation<Empty, OperationMetadata>>	A Task containing the RPC response.

Overrides

CloudChannelServiceClient.TransferEntitlementsToGoogleAsync(TransferEntitlementsToGoogleRequest, CallSettings)

UnregisterSubscriber(UnregisterSubscriberRequest, CallSettings)

public override UnregisterSubscriberResponse UnregisterSubscriber(UnregisterSubscriberRequest request, CallSettings callSettings = null)

Unregisters a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. If there are no service accounts left with subscriber privileges, this deletes the topic. You can call ListSubscribers to check for these accounts.

Possible error codes:

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

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

Parameters
Name	Description
request	UnregisterSubscriberRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
UnregisterSubscriberResponse	The RPC response.

Overrides

CloudChannelServiceClient.UnregisterSubscriber(UnregisterSubscriberRequest, CallSettings)

UnregisterSubscriberAsync(UnregisterSubscriberRequest, CallSettings)

public override Task<UnregisterSubscriberResponse> UnregisterSubscriberAsync(UnregisterSubscriberRequest request, CallSettings callSettings = null)

Unregisters a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. If there are no service accounts left with subscriber privileges, this deletes the topic. You can call ListSubscribers to check for these accounts.

Possible error codes:

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

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

Parameters
Name	Description
request	UnregisterSubscriberRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<UnregisterSubscriberResponse>	A Task containing the RPC response.

Overrides

CloudChannelServiceClient.UnregisterSubscriberAsync(UnregisterSubscriberRequest, CallSettings)

UpdateChannelPartnerLink(UpdateChannelPartnerLinkRequest, CallSettings)

public override ChannelPartnerLink UpdateChannelPartnerLink(UpdateChannelPartnerLinkRequest request, CallSettings callSettings = null)

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

Possible error codes:

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

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

Parameters
Name	Description
request	UpdateChannelPartnerLinkRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ChannelPartnerLink	The RPC response.

Overrides

CloudChannelServiceClient.UpdateChannelPartnerLink(UpdateChannelPartnerLinkRequest, CallSettings)

UpdateChannelPartnerLinkAsync(UpdateChannelPartnerLinkRequest, CallSettings)

public override Task<ChannelPartnerLink> UpdateChannelPartnerLinkAsync(UpdateChannelPartnerLinkRequest request, CallSettings callSettings = null)

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

Possible error codes:

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

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

Parameters
Name	Description
request	UpdateChannelPartnerLinkRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<ChannelPartnerLink>	A Task containing the RPC response.

Overrides

CloudChannelServiceClient.UpdateChannelPartnerLinkAsync(UpdateChannelPartnerLinkRequest, CallSettings)

UpdateCustomer(UpdateCustomerRequest, CallSettings)

public override Customer UpdateCustomer(UpdateCustomerRequest request, CallSettings callSettings = null)

Updates an existing [Customer][google.cloud.channel.v1.Customer] resource for the reseller or distributor.

Possible error codes:

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

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

Parameters
Name	Description
request	UpdateCustomerRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Customer	The RPC response.

Overrides

CloudChannelServiceClient.UpdateCustomer(UpdateCustomerRequest, CallSettings)

UpdateCustomerAsync(UpdateCustomerRequest, CallSettings)

public override Task<Customer> UpdateCustomerAsync(UpdateCustomerRequest request, CallSettings callSettings = null)

Updates an existing [Customer][google.cloud.channel.v1.Customer] resource for the reseller or distributor.

Possible error codes:

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

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

Parameters
Name	Description
request	UpdateCustomerRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Customer>	A Task containing the RPC response.

Overrides

CloudChannelServiceClient.UpdateCustomerAsync(UpdateCustomerRequest, CallSettings)