Cloud Channel v1 API - Class CloudChannelServiceClientImpl (2.9.0)

public sealed class CloudChannelServiceClientImpl : CloudChannelServiceClient

Reference documentation and code samples for the Cloud Channel v1 API class CloudChannelServiceClientImpl.

CloudChannelService client wrapper implementation, for convenient use.

Inheritance

object > CloudChannelServiceClient > CloudChannelServiceClientImpl

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(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
NameDescription
grpcClientCloudChannelServiceCloudChannelServiceClient

The underlying gRPC client.

settingsCloudChannelServiceSettings

The base CloudChannelServiceSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

ActivateEntitlementOperationsClient

public override OperationsClient ActivateEntitlementOperationsClient { get; }

The long-running operations client for ActivateEntitlement.

Property Value
TypeDescription
OperationsClient
Overrides

CancelEntitlementOperationsClient

public override OperationsClient CancelEntitlementOperationsClient { get; }

The long-running operations client for CancelEntitlement.

Property Value
TypeDescription
OperationsClient
Overrides

ChangeOfferOperationsClient

public override OperationsClient ChangeOfferOperationsClient { get; }

The long-running operations client for ChangeOffer.

Property Value
TypeDescription
OperationsClient
Overrides

ChangeParametersOperationsClient

public override OperationsClient ChangeParametersOperationsClient { get; }

The long-running operations client for ChangeParameters.

Property Value
TypeDescription
OperationsClient
Overrides

ChangeRenewalSettingsOperationsClient

public override OperationsClient ChangeRenewalSettingsOperationsClient { get; }

The long-running operations client for ChangeRenewalSettings.

Property Value
TypeDescription
OperationsClient
Overrides

CreateEntitlementOperationsClient

public override OperationsClient CreateEntitlementOperationsClient { get; }

The long-running operations client for CreateEntitlement.

Property Value
TypeDescription
OperationsClient
Overrides

GrpcClient

public override CloudChannelService.CloudChannelServiceClient GrpcClient { get; }

The underlying gRPC CloudChannelService client

Property Value
TypeDescription
CloudChannelServiceCloudChannelServiceClient
Overrides

ProvisionCloudIdentityOperationsClient

public override OperationsClient ProvisionCloudIdentityOperationsClient { get; }

The long-running operations client for ProvisionCloudIdentity.

Property Value
TypeDescription
OperationsClient
Overrides

StartPaidServiceOperationsClient

public override OperationsClient StartPaidServiceOperationsClient { get; }

The long-running operations client for StartPaidService.

Property Value
TypeDescription
OperationsClient
Overrides

SuspendEntitlementOperationsClient

public override OperationsClient SuspendEntitlementOperationsClient { get; }

The long-running operations client for SuspendEntitlement.

Property Value
TypeDescription
OperationsClient
Overrides

TransferEntitlementsOperationsClient

public override OperationsClient TransferEntitlementsOperationsClient { get; }

The long-running operations client for TransferEntitlements.

Property Value
TypeDescription
OperationsClient
Overrides

TransferEntitlementsToGoogleOperationsClient

public override OperationsClient TransferEntitlementsToGoogleOperationsClient { get; }

The long-running operations client for TransferEntitlementsToGoogle.

Property Value
TypeDescription
OperationsClient
Overrides

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
NameDescription
requestActivateEntitlementRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEntitlementOperationMetadata

The RPC response.

Overrides

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
NameDescription
requestActivateEntitlementRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEntitlementOperationMetadata

A Task containing the RPC response.

Overrides

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
NameDescription
requestCancelEntitlementRequest

The request object containing all of the parameters for the API call.

callSettings