public sealed class CloudChannelServiceClientImpl : CloudChannelServiceClientReference documentation and code samples for the Cloud Channel v1 API class CloudChannelServiceClientImpl.
CloudChannelService client wrapper implementation, for convenient use.
Namespace
GoogleCloudGoogle.Cloud.ChannelV1Assembly
Google.Cloud.Channel.V1.dll
Remarks
CloudChannelService lets Google cloud resellers and distributors manage their customers, channel partners, entitlements, and reports.
Using this service:
- Resellers and distributors can manage a customer entity.
- Distributors can register an authorized reseller in their channel and provide them with delegated admin access.
- 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(CloudChannelServiceClient, CloudChannelServiceSettings, ILogger)
public CloudChannelServiceClientImpl(CloudChannelService.CloudChannelServiceClient grpcClient, CloudChannelServiceSettings settings, ILogger logger)Constructs a client wrapper for the CloudChannelService service, with the specified gRPC client and settings.
| Parameters | |
|---|---|
| Name | Description |
grpcClient | CloudChannelServiceCloudChannelServiceClientThe underlying gRPC client. |
settings | CloudChannelServiceSettingsThe base CloudChannelServiceSettings used within this client. |
logger | ILoggerOptional ILogger to use within this client. |
Properties
ActivateEntitlementOperationsClient
public override OperationsClient ActivateEntitlementOperationsClient { get; }The long-running operations client for ActivateEntitlement.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
CancelEntitlementOperationsClient
public override OperationsClient CancelEntitlementOperationsClient { get; }The long-running operations client for CancelEntitlement.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
ChangeOfferOperationsClient
public override OperationsClient ChangeOfferOperationsClient { get; }The long-running operations client for ChangeOffer.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
ChangeParametersOperationsClient
public override OperationsClient ChangeParametersOperationsClient { get; }The long-running operations client for ChangeParameters.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
ChangeRenewalSettingsOperationsClient
public override OperationsClient ChangeRenewalSettingsOperationsClient { get; }The long-running operations client for ChangeRenewalSettings.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
CreateEntitlementOperationsClient
public override OperationsClient CreateEntitlementOperationsClient { get; }The long-running operations client for CreateEntitlement.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
GrpcClient
public override CloudChannelService.CloudChannelServiceClient GrpcClient { get; }The underlying gRPC CloudChannelService client
| Property Value | |
|---|---|
| Type | Description |
CloudChannelServiceCloudChannelServiceClient | |
ProvisionCloudIdentityOperationsClient
public override OperationsClient ProvisionCloudIdentityOperationsClient { get; }The long-running operations client for ProvisionCloudIdentity.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
StartPaidServiceOperationsClient
public override OperationsClient StartPaidServiceOperationsClient { get; }The long-running operations client for StartPaidService.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
SuspendEntitlementOperationsClient
public override OperationsClient SuspendEntitlementOperationsClient { get; }The long-running operations client for SuspendEntitlement.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
TransferEntitlementsOperationsClient
public override OperationsClient TransferEntitlementsOperationsClient { get; }The long-running operations client for TransferEntitlements.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
TransferEntitlementsToGoogleOperationsClient
public override OperationsClient TransferEntitlementsToGoogleOperationsClient { get; }The long-running operations client for TransferEntitlementsToGoogle.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
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 | ActivateEntitlementRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEntitlementOperationMetadata | The RPC response. |
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 | ActivateEntitlementRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEntitlementOperationMetadata | A Task containing the RPC response. |
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 | CancelEntitlementRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyOperationMetadata | The RPC response. |
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 | CancelEntitlementRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyOperationMetadata | A Task containing the RPC response. |
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 | ChangeOfferRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEntitlementOperationMetadata | The RPC response. |
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 | ChangeOfferRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEntitlementOperationMetadata | A Task containing the RPC response. |
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 | ChangeParametersRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEntitlementOperationMetadata | The RPC response. |
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 | ChangeParametersRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEntitlement | |