Class CloudChannelService.CloudChannelServiceClient (1.0.0)

public class CloudChannelServiceClient : ClientBase<CloudChannelService.CloudChannelServiceClient>

Client for CloudChannelService

Inheritance

Object > ClientBase > ClientBase<CloudChannelService.CloudChannelServiceClient> > CloudChannelService.CloudChannelServiceClient

Namespace

Google.Cloud.Channel.V1

Assembly

Google.Cloud.Channel.V1.dll

Constructors

CloudChannelServiceClient()

protected CloudChannelServiceClient()

Protected parameterless constructor to allow creation of test doubles.

CloudChannelServiceClient(CallInvoker)

public CloudChannelServiceClient(CallInvoker callInvoker)

Creates a new client for CloudChannelService that uses a custom CallInvoker.

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

CloudChannelServiceClient(ChannelBase)

public CloudChannelServiceClient(ChannelBase channel)

Creates a new client for CloudChannelService

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

CloudChannelServiceClient(ClientBase.ClientBaseConfiguration)

protected CloudChannelServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

The client configuration.

Methods

ActivateEntitlement(ActivateEntitlementRequest, CallOptions)

public virtual Operation ActivateEntitlement(ActivateEntitlementRequest request, CallOptions options)

Activates a previously suspended entitlement. The entitlement must be in a suspended state for it to be activated. Entitlements suspended for pending ToS acceptance can't be activated using this method. An entitlement activation is a long-running operation and can result in updates to the state of the customer entitlement.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller or if the reseller account making the request and reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: Entitlement resource not found.
  • SUSPENSION_NOT_RESELLER_INITIATED: Can't activate an entitlement that is pending TOS acceptance. Only reseller initiated suspensions can be activated.
  • NOT_SUSPENDED: Can't activate entitlements that are already in ACTIVE state. Can only activate suspended entitlements.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

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 to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Google.LongRunning.Operation

The response received from the server.

ActivateEntitlement(ActivateEntitlementRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation ActivateEntitlement(ActivateEntitlementRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Activates a previously suspended entitlement. The entitlement must be in a suspended state for it to be activated. Entitlements suspended for pending ToS acceptance can't be activated using this method. An entitlement activation is a long-running operation and can result in updates to the state of the customer entitlement.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller or if the reseller account making the request and reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: Entitlement resource not found.
  • SUSPENSION_NOT_RESELLER_INITIATED: Can't activate an entitlement that is pending TOS acceptance. Only reseller initiated suspensions can be activated.
  • NOT_SUSPENDED: Can't activate entitlements that are already in ACTIVE state. Can only activate suspended entitlements.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

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 to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Google.LongRunning.Operation

The response received from the server.

ActivateEntitlementAsync(ActivateEntitlementRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ActivateEntitlementAsync(ActivateEntitlementRequest request, CallOptions options)

Activates a previously suspended entitlement. The entitlement must be in a suspended state for it to be activated. Entitlements suspended for pending ToS acceptance can't be activated using this method. An entitlement activation is a long-running operation and can result in updates to the state of the customer entitlement.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller or if the reseller account making the request and reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: Entitlement resource not found.
  • SUSPENSION_NOT_RESELLER_INITIATED: Can't activate an entitlement that is pending TOS acceptance. Only reseller initiated suspensions can be activated.
  • NOT_SUSPENDED: Can't activate entitlements that are already in ACTIVE state. Can only activate suspended entitlements.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

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 to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Google.LongRunning.Operation>

The call object.

ActivateEntitlementAsync(ActivateEntitlementRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> ActivateEntitlementAsync(ActivateEntitlementRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Activates a previously suspended entitlement. The entitlement must be in a suspended state for it to be activated. Entitlements suspended for pending ToS acceptance can't be activated using this method. An entitlement activation is a long-running operation and can result in updates to the state of the customer entitlement.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller or if the reseller account making the request and reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: Entitlement resource not found.
  • SUSPENSION_NOT_RESELLER_INITIATED: Can't activate an entitlement that is pending TOS acceptance. Only reseller initiated suspensions can be activated.
  • NOT_SUSPENDED: Can't activate entitlements that are already in ACTIVE state. Can only activate suspended entitlements.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

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 to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Google.LongRunning.Operation>

The call object.

CancelEntitlement(CancelEntitlementRequest, CallOptions)

public virtual Operation CancelEntitlement(CancelEntitlementRequest request, CallOptions options)

Cancels a previously fulfilled entitlement. An entitlement cancellation is a long-running operation.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller or if the reseller account making the request and reseller account being queried for are different.
  • FAILED_PRECONDITION: If there are any Google Cloud projects linked to the Google Cloud entitlement's Cloud Billing subaccount.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • 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. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

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 to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Google.LongRunning.Operation

The response received from the server.

CancelEntitlement(CancelEntitlementRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation CancelEntitlement(CancelEntitlementRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Cancels a previously fulfilled entitlement. An entitlement cancellation is a long-running operation.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller or if the reseller account making the request and reseller account being queried for are different.
  • FAILED_PRECONDITION: If there are any Google Cloud projects linked to the Google Cloud entitlement's Cloud Billing subaccount.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • 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. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

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 to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Google.LongRunning.Operation

The response received from the server.

CancelEntitlementAsync(CancelEntitlementRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CancelEntitlementAsync(CancelEntitlementRequest request, CallOptions options)

Cancels a previously fulfilled entitlement. An entitlement cancellation is a long-running operation.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller or if the reseller account making the request and reseller account being queried for are different.
  • FAILED_PRECONDITION: If there are any Google Cloud projects linked to the Google Cloud entitlement's Cloud Billing subaccount.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • 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. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

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 to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Google.LongRunning.Operation>

The call object.

CancelEntitlementAsync(CancelEntitlementRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> CancelEntitlementAsync(CancelEntitlementRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Cancels a previously fulfilled entitlement. An entitlement cancellation is a long-running operation.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller or if the reseller account making the request and reseller account being queried for are different.
  • FAILED_PRECONDITION: If there are any Google Cloud projects linked to the Google Cloud entitlement's Cloud Billing subaccount.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • 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. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

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 to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Google.LongRunning.Operation>

The call object.

ChangeOffer(ChangeOfferRequest, CallOptions)

public virtual Operation ChangeOffer(ChangeOfferRequest request, CallOptions options)

Updates the Offer for an existing customer entitlement.

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

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: Offer or Entitlement resource not found.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

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
requestChangeOfferRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Google.LongRunning.Operation

The response received from the server.

ChangeOffer(ChangeOfferRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation ChangeOffer(ChangeOfferRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Updates the Offer for an existing customer entitlement.

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

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: Offer or Entitlement resource not found.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

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
requestChangeOfferRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Google.LongRunning.Operation

The response received from the server.

ChangeOfferAsync(ChangeOfferRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ChangeOfferAsync(ChangeOfferRequest request, CallOptions options)

Updates the Offer for an existing customer entitlement.

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

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: Offer or Entitlement resource not found.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

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
requestChangeOfferRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Google.LongRunning.Operation>

The call object.

ChangeOfferAsync(ChangeOfferRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> ChangeOfferAsync(ChangeOfferRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Updates the Offer for an existing customer entitlement.

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

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: Offer or Entitlement resource not found.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

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
requestChangeOfferRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Google.LongRunning.Operation>

The call object.

ChangeParameters(ChangeParametersRequest, CallOptions)

public virtual Operation ChangeParameters(ChangeParametersRequest request, CallOptions options)

Change parameters of the entitlement

An entitlement parameters update is a long-running operation and results in updates to the entitlement as a result of fulfillment.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request. For example, if the number of seats being changed to is greater than the allowed number of max seats for the resource. 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. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

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
requestChangeParametersRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Google.LongRunning.Operation

The response received from the server.

ChangeParameters(ChangeParametersRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation ChangeParameters(ChangeParametersRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Change parameters of the entitlement

An entitlement parameters update is a long-running operation and results in updates to the entitlement as a result of fulfillment.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request. For example, if the number of seats being changed to is greater than the allowed number of max seats for the resource. 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. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

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
requestChangeParametersRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Google.LongRunning.Operation

The response received from the server.

ChangeParametersAsync(ChangeParametersRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ChangeParametersAsync(ChangeParametersRequest request, CallOptions options)

Change parameters of the entitlement

An entitlement parameters update is a long-running operation and results in updates to the entitlement as a result of fulfillment.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request. For example, if the number of seats being changed to is greater than the allowed number of max seats for the resource. 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. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

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
requestChangeParametersRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Google.LongRunning.Operation>

The call object.

ChangeParametersAsync(ChangeParametersRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> ChangeParametersAsync(ChangeParametersRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Change parameters of the entitlement

An entitlement parameters update is a long-running operation and results in updates to the entitlement as a result of fulfillment.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request. For example, if the number of seats being changed to is greater than the allowed number of max seats for the resource. 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. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

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
requestChangeParametersRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Google.LongRunning.Operation>

The call object.

ChangeRenewalSettings(ChangeRenewalSettingsRequest, CallOptions)

public virtual Operation ChangeRenewalSettings(ChangeRenewalSettingsRequest request, CallOptions options)

Updates the renewal settings for an existing customer entitlement.

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

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: Entitlement resource not found.
  • NOT_COMMITMENT_PLAN: Renewal Settings are only applicable for a commitment plan. Can't enable or disable renewal for non-commitment plans.
  • INTERNAL: Any non user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

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
requestChangeRenewalSettingsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Google.LongRunning.Operation

The response received from the server.

ChangeRenewalSettings(ChangeRenewalSettingsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation ChangeRenewalSettings(ChangeRenewalSettingsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Updates the renewal settings for an existing customer entitlement.

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

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: Entitlement resource not found.
  • NOT_COMMITMENT_PLAN: Renewal Settings are only applicable for a commitment plan. Can't enable or disable renewal for non-commitment plans.
  • INTERNAL: Any non user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

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
requestChangeRenewalSettingsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Google.LongRunning.Operation

The response received from the server.

ChangeRenewalSettingsAsync(ChangeRenewalSettingsRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ChangeRenewalSettingsAsync(ChangeRenewalSettingsRequest request, CallOptions options)

Updates the renewal settings for an existing customer entitlement.

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

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: Entitlement resource not found.
  • NOT_COMMITMENT_PLAN: Renewal Settings are only applicable for a commitment plan. Can't enable or disable renewal for non-commitment plans.
  • INTERNAL: Any non user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

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
requestChangeRenewalSettingsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Google.LongRunning.Operation>

The call object.

ChangeRenewalSettingsAsync(ChangeRenewalSettingsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> ChangeRenewalSettingsAsync(ChangeRenewalSettingsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Updates the renewal settings for an existing customer entitlement.

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

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: Entitlement resource not found.
  • NOT_COMMITMENT_PLAN: Renewal Settings are only applicable for a commitment plan. Can't enable or disable renewal for non-commitment plans.
  • INTERNAL: Any non user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

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
requestChangeRenewalSettingsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Google.LongRunning.Operation>

The call object.

CheckCloudIdentityAccountsExist(CheckCloudIdentityAccountsExistRequest, CallOptions)

public virtual CheckCloudIdentityAccountsExistResponse CheckCloudIdentityAccountsExist(CheckCloudIdentityAccountsExistRequest request, CallOptions options)

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

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • INVALID_VALUE: Invalid domain value in the request.

Return Value: List of [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] resources for the domain. List may be empty.

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

Parameters
NameDescription
requestCheckCloudIdentityAccountsExistRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
CheckCloudIdentityAccountsExistResponse

The response received from the server.

CheckCloudIdentityAccountsExist(CheckCloudIdentityAccountsExistRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual CheckCloudIdentityAccountsExistResponse CheckCloudIdentityAccountsExist(CheckCloudIdentityAccountsExistRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • INVALID_VALUE: Invalid domain value in the request.

Return Value: List of [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] resources for the domain. List may be empty.

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

Parameters
NameDescription
requestCheckCloudIdentityAccountsExistRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
CheckCloudIdentityAccountsExistResponse

The response received from the server.

CheckCloudIdentityAccountsExistAsync(CheckCloudIdentityAccountsExistRequest, CallOptions)

public virtual AsyncUnaryCall<CheckCloudIdentityAccountsExistResponse> CheckCloudIdentityAccountsExistAsync(CheckCloudIdentityAccountsExistRequest request, CallOptions options)

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

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • INVALID_VALUE: Invalid domain value in the request.

Return Value: List of [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] resources for the domain. List may be empty.

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

Parameters
NameDescription
requestCheckCloudIdentityAccountsExistRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<CheckCloudIdentityAccountsExistResponse>

The call object.

CheckCloudIdentityAccountsExistAsync(CheckCloudIdentityAccountsExistRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<CheckCloudIdentityAccountsExistResponse> CheckCloudIdentityAccountsExistAsync(CheckCloudIdentityAccountsExistRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • INVALID_VALUE: Invalid domain value in the request.

Return Value: List of [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] resources for the domain. List may be empty.

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

Parameters
NameDescription
requestCheckCloudIdentityAccountsExistRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<CheckCloudIdentityAccountsExistResponse>

The call object.

public virtual ChannelPartnerLink CreateChannelPartnerLink(CreateChannelPartnerLinkRequest request, CallOptions options)

Initiates a channel partner link between a distributor and a reseller or between resellers in an n-tier reseller channel. To accept the invite, the invited partner should follow the invite_link_uri provided in the response. If the link creation is accepted, a valid link is set up between the two involved parties. To call this method, you must be a distributor.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • ALREADY_EXISTS: If the ChannelPartnerLink sent in the request already exists.
  • NOT_FOUND: If no Cloud Identity customer exists for domain provided.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Newly created [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource if successful, otherwise error is returned.

Parameters
NameDescription
requestCreateChannelPartnerLinkRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ChannelPartnerLink

The response received from the server.

public virtual ChannelPartnerLink CreateChannelPartnerLink(CreateChannelPartnerLinkRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Initiates a channel partner link between a distributor and a reseller or between resellers in an n-tier reseller channel. To accept the invite, the invited partner should follow the invite_link_uri provided in the response. If the link creation is accepted, a valid link is set up between the two involved parties. To call this method, you must be a distributor.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • ALREADY_EXISTS: If the ChannelPartnerLink sent in the request already exists.
  • NOT_FOUND: If no Cloud Identity customer exists for domain provided.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Newly created [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource if successful, otherwise error is returned.

Parameters
NameDescription
requestCreateChannelPartnerLinkRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ChannelPartnerLink

The response received from the server.

CreateChannelPartnerLinkAsync(CreateChannelPartnerLinkRequest, CallOptions)

public virtual AsyncUnaryCall<ChannelPartnerLink> CreateChannelPartnerLinkAsync(CreateChannelPartnerLinkRequest request, CallOptions options)

Initiates a channel partner link between a distributor and a reseller or between resellers in an n-tier reseller channel. To accept the invite, the invited partner should follow the invite_link_uri provided in the response. If the link creation is accepted, a valid link is set up between the two involved parties. To call this method, you must be a distributor.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • ALREADY_EXISTS: If the ChannelPartnerLink sent in the request already exists.
  • NOT_FOUND: If no Cloud Identity customer exists for domain provided.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Newly created [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource if successful, otherwise error is returned.

Parameters
NameDescription
requestCreateChannelPartnerLinkRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ChannelPartnerLink>

The call object.

CreateChannelPartnerLinkAsync(CreateChannelPartnerLinkRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ChannelPartnerLink> CreateChannelPartnerLinkAsync(CreateChannelPartnerLinkRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Initiates a channel partner link between a distributor and a reseller or between resellers in an n-tier reseller channel. To accept the invite, the invited partner should follow the invite_link_uri provided in the response. If the link creation is accepted, a valid link is set up between the two involved parties. To call this method, you must be a distributor.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • ALREADY_EXISTS: If the ChannelPartnerLink sent in the request already exists.
  • NOT_FOUND: If no Cloud Identity customer exists for domain provided.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Newly created [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource if successful, otherwise error is returned.

Parameters
NameDescription
requestCreateChannelPartnerLinkRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ChannelPartnerLink>

The call object.

CreateCustomer(CreateCustomerRequest, CallOptions)

public virtual Customer CreateCustomer(CreateCustomerRequest request, CallOptions options)

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

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: It can happen in following scenarios -
  • Missing or invalid required parameters in the request.
  • Domain field value doesn't match the domain specified in primary email.

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

Parameters
NameDescription
requestCreateCustomerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Customer

The response received from the server.

CreateCustomer(CreateCustomerRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Customer CreateCustomer(CreateCustomerRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: It can happen in following scenarios -
  • Missing or invalid required parameters in the request.
  • Domain field value doesn't match the domain specified in primary email.

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

Parameters
NameDescription
requestCreateCustomerRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Customer

The response received from the server.

CreateCustomerAsync(CreateCustomerRequest, CallOptions)

public virtual AsyncUnaryCall<Customer> CreateCustomerAsync(CreateCustomerRequest request, CallOptions options)

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

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: It can happen in following scenarios -
  • Missing or invalid required parameters in the request.
  • Domain field value doesn't match the domain specified in primary email.

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

Parameters
NameDescription
requestCreateCustomerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Customer>

The call object.

CreateCustomerAsync(CreateCustomerRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Customer> CreateCustomerAsync(CreateCustomerRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: It can happen in following scenarios -
  • Missing or invalid required parameters in the request.
  • Domain field value doesn't match the domain specified in primary email.

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

Parameters
NameDescription
requestCreateCustomerRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Customer>

The call object.

CreateEntitlement(CreateEntitlementRequest, CallOptions)

public virtual Operation CreateEntitlement(CreateEntitlementRequest request, CallOptions options)

Creates an entitlement for a customer.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: It can happen in below scenarios -
  • Missing or invalid required parameters in the request.
  • Cannot purchase an entitlement if there is already an entitlement for customer, for a SKU from the same product family.
  • INVALID_VALUE: Offer passed in isn't valid. Make sure OfferId is valid. If it is valid, then contact Google Channel support for further troubleshooting.
  • NOT_FOUND: If the customer or offer resource is not found for the reseller.
  • ALREADY_EXISTS: This failure can happen in the following cases:
  • If the SKU has been already purchased for the customer.
  • If the customer's primary email already exists. In this case retry after changing the customer's primary contact email.
  • CONDITION_NOT_MET or FAILED_PRECONDITION: This failure can happen in the following cases:
  • Purchasing a SKU that requires domain verification and the domain has not been verified.
  • Purchasing an Add-On SKU like Vault or Drive without purchasing the pre-requisite SKU, such as Google Workspace Business Starter.
  • Applicable only for developer accounts: reseller and resold domain. Must meet the following domain naming requirements:
    • Domain names must start with goog-test.
    • Resold domain names must include the reseller domain.
  • INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel Support in this case.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel Support in this case.

Return Value: Long Running Operation ID.

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
requestCreateEntitlementRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Google.LongRunning.Operation

The response received from the server.

CreateEntitlement(CreateEntitlementRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation CreateEntitlement(CreateEntitlementRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Creates an entitlement for a customer.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: It can happen in below scenarios -
  • Missing or invalid required parameters in the request.
  • Cannot purchase an entitlement if there is already an entitlement for customer, for a SKU from the same product family.
  • INVALID_VALUE: Offer passed in isn't valid. Make sure OfferId is valid. If it is valid, then contact Google Channel support for further troubleshooting.
  • NOT_FOUND: If the customer or offer resource is not found for the reseller.
  • ALREADY_EXISTS: This failure can happen in the following cases:
  • If the SKU has been already purchased for the customer.
  • If the customer's primary email already exists. In this case retry after changing the customer's primary contact email.
  • CONDITION_NOT_MET or FAILED_PRECONDITION: This failure can happen in the following cases:
  • Purchasing a SKU that requires domain verification and the domain has not been verified.
  • Purchasing an Add-On SKU like Vault or Drive without purchasing the pre-requisite SKU, such as Google Workspace Business Starter.
  • Applicable only for developer accounts: reseller and resold domain. Must meet the following domain naming requirements:
    • Domain names must start with goog-test.
    • Resold domain names must include the reseller domain.
  • INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel Support in this case.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel Support in this case.

Return Value: Long Running Operation ID.

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
requestCreateEntitlementRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Google.LongRunning.Operation

The response received from the server.

CreateEntitlementAsync(CreateEntitlementRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateEntitlementAsync(CreateEntitlementRequest request, CallOptions options)

Creates an entitlement for a customer.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: It can happen in below scenarios -
  • Missing or invalid required parameters in the request.
  • Cannot purchase an entitlement if there is already an entitlement for customer, for a SKU from the same product family.
  • INVALID_VALUE: Offer passed in isn't valid. Make sure OfferId is valid. If it is valid, then contact Google Channel support for further troubleshooting.
  • NOT_FOUND: If the customer or offer resource is not found for the reseller.
  • ALREADY_EXISTS: This failure can happen in the following cases:
  • If the SKU has been already purchased for the customer.
  • If the customer's primary email already exists. In this case retry after changing the customer's primary contact email.
  • CONDITION_NOT_MET or FAILED_PRECONDITION: This failure can happen in the following cases:
  • Purchasing a SKU that requires domain verification and the domain has not been verified.
  • Purchasing an Add-On SKU like Vault or Drive without purchasing the pre-requisite SKU, such as Google Workspace Business Starter.
  • Applicable only for developer accounts: reseller and resold domain. Must meet the following domain naming requirements:
    • Domain names must start with goog-test.
    • Resold domain names must include the reseller domain.
  • INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel Support in this case.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel Support in this case.

Return Value: Long Running Operation ID.

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
requestCreateEntitlementRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Google.LongRunning.Operation>

The call object.

CreateEntitlementAsync(CreateEntitlementRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateEntitlementAsync(CreateEntitlementRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Creates an entitlement for a customer.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: It can happen in below scenarios -
  • Missing or invalid required parameters in the request.
  • Cannot purchase an entitlement if there is already an entitlement for customer, for a SKU from the same product family.
  • INVALID_VALUE: Offer passed in isn't valid. Make sure OfferId is valid. If it is valid, then contact Google Channel support for further troubleshooting.
  • NOT_FOUND: If the customer or offer resource is not found for the reseller.
  • ALREADY_EXISTS: This failure can happen in the following cases:
  • If the SKU has been already purchased for the customer.
  • If the customer's primary email already exists. In this case retry after changing the customer's primary contact email.
  • CONDITION_NOT_MET or FAILED_PRECONDITION: This failure can happen in the following cases:
  • Purchasing a SKU that requires domain verification and the domain has not been verified.
  • Purchasing an Add-On SKU like Vault or Drive without purchasing the pre-requisite SKU, such as Google Workspace Business Starter.
  • Applicable only for developer accounts: reseller and resold domain. Must meet the following domain naming requirements:
    • Domain names must start with goog-test.
    • Resold domain names must include the reseller domain.
  • INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel Support in this case.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel Support in this case.

Return Value: Long Running Operation ID.

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
requestCreateEntitlementRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Google.LongRunning.Operation>

The call object.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Google.LongRunning.Operations.OperationsClient using the same call invoker as this client.

Returns
TypeDescription
Google.LongRunning.Operations.OperationsClient

A new Operations client for the same target as this client.

DeleteCustomer(DeleteCustomerRequest, CallOptions)

public virtual Empty DeleteCustomer(DeleteCustomerRequest request, CallOptions options)

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

Possible Error Codes:

  • PERMISSION_DENIED: If the account making the request does not own this customer.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • FAILED_PRECONDITION: If the customer has existing entitlements.
  • NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name specified in the request.
Parameters
NameDescription
requestDeleteCustomerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Google.Protobuf.WellKnownTypes.Empty

The response received from the server.

DeleteCustomer(DeleteCustomerRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Empty DeleteCustomer(DeleteCustomerRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Possible Error Codes:

  • PERMISSION_DENIED: If the account making the request does not own this customer.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • FAILED_PRECONDITION: If the customer has existing entitlements.
  • NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name specified in the request.
Parameters
NameDescription
requestDeleteCustomerRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Google.Protobuf.WellKnownTypes.Empty

The response received from the server.

DeleteCustomerAsync(DeleteCustomerRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteCustomerAsync(DeleteCustomerRequest request, CallOptions options)

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

Possible Error Codes:

  • PERMISSION_DENIED: If the account making the request does not own this customer.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • FAILED_PRECONDITION: If the customer has existing entitlements.
  • NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name specified in the request.
Parameters
NameDescription
requestDeleteCustomerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Google.Protobuf.WellKnownTypes.Empty>

The call object.

DeleteCustomerAsync(DeleteCustomerRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteCustomerAsync(DeleteCustomerRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Possible Error Codes:

  • PERMISSION_DENIED: If the account making the request does not own this customer.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • FAILED_PRECONDITION: If the customer has existing entitlements.
  • NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name specified in the request.
Parameters
NameDescription
requestDeleteCustomerRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Google.Protobuf.WellKnownTypes.Empty>

The call object.

public virtual ChannelPartnerLink GetChannelPartnerLink(GetChannelPartnerLinkRequest request, CallOptions options)

Returns a requested [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource. To call this method, you must be a distributor.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: ChannelPartnerLink resource not found. Results due invalid channel partner link name.

Return Value: [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource if found, otherwise returns an error.

Parameters
NameDescription
requestGetChannelPartnerLinkRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ChannelPartnerLink

The response received from the server.

public virtual ChannelPartnerLink GetChannelPartnerLink(GetChannelPartnerLinkRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Returns a requested [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource. To call this method, you must be a distributor.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: ChannelPartnerLink resource not found. Results due invalid channel partner link name.

Return Value: [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource if found, otherwise returns an error.

Parameters
NameDescription
requestGetChannelPartnerLinkRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ChannelPartnerLink

The response received from the server.

GetChannelPartnerLinkAsync(GetChannelPartnerLinkRequest, CallOptions)

public virtual AsyncUnaryCall<ChannelPartnerLink> GetChannelPartnerLinkAsync(GetChannelPartnerLinkRequest request, CallOptions options)

Returns a requested [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource. To call this method, you must be a distributor.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: ChannelPartnerLink resource not found. Results due invalid channel partner link name.

Return Value: [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource if found, otherwise returns an error.

Parameters
NameDescription
requestGetChannelPartnerLinkRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ChannelPartnerLink>

The call object.

GetChannelPartnerLinkAsync(GetChannelPartnerLinkRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ChannelPartnerLink> GetChannelPartnerLinkAsync(GetChannelPartnerLinkRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Returns a requested [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource. To call this method, you must be a distributor.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: ChannelPartnerLink resource not found. Results due invalid channel partner link name.

Return Value: [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource if found, otherwise returns an error.

Parameters
NameDescription
requestGetChannelPartnerLinkRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ChannelPartnerLink>

The call object.

GetCustomer(GetCustomerRequest, CallOptions)

public virtual Customer GetCustomer(GetCustomerRequest request, CallOptions options)

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

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the customer resource doesn't exist. Usually the result of an invalid name parameter.

Return Value: [Customer][google.cloud.channel.v1.Customer] resource if found, error otherwise.

Parameters
NameDescription
requestGetCustomerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Customer

The response received from the server.

GetCustomer(GetCustomerRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Customer GetCustomer(GetCustomerRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the customer resource doesn't exist. Usually the result of an invalid name parameter.

Return Value: [Customer][google.cloud.channel.v1.Customer] resource if found, error otherwise.

Parameters
NameDescription
requestGetCustomerRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Customer

The response received from the server.

GetCustomerAsync(GetCustomerRequest, CallOptions)

public virtual AsyncUnaryCall<Customer> GetCustomerAsync(GetCustomerRequest request, CallOptions options)

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

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the customer resource doesn't exist. Usually the result of an invalid name parameter.

Return Value: [Customer][google.cloud.channel.v1.Customer] resource if found, error otherwise.

Parameters
NameDescription
requestGetCustomerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Customer>

The call object.

GetCustomerAsync(GetCustomerRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Customer> GetCustomerAsync(GetCustomerRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the customer resource doesn't exist. Usually the result of an invalid name parameter.

Return Value: [Customer][google.cloud.channel.v1.Customer] resource if found, error otherwise.

Parameters
NameDescription
requestGetCustomerRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Customer>

The call object.

GetEntitlement(GetEntitlementRequest, CallOptions)

public virtual Entitlement GetEntitlement(GetEntitlementRequest request, CallOptions options)

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

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the entitlement is not found for the customer.

Return Value: If found, the requested [Entitlement][google.cloud.channel.v1.Entitlement] resource, otherwise returns an error.

Parameters
NameDescription
requestGetEntitlementRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Entitlement

The response received from the server.

GetEntitlement(GetEntitlementRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Entitlement GetEntitlement(GetEntitlementRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the entitlement is not found for the customer.

Return Value: If found, the requested [Entitlement][google.cloud.channel.v1.Entitlement] resource, otherwise returns an error.

Parameters
NameDescription
requestGetEntitlementRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Entitlement

The response received from the server.

GetEntitlementAsync(GetEntitlementRequest, CallOptions)

public virtual AsyncUnaryCall<Entitlement> GetEntitlementAsync(GetEntitlementRequest request, CallOptions options)

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

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the entitlement is not found for the customer.

Return Value: If found, the requested [Entitlement][google.cloud.channel.v1.Entitlement] resource, otherwise returns an error.

Parameters
NameDescription
requestGetEntitlementRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Entitlement>

The call object.

GetEntitlementAsync(GetEntitlementRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Entitlement> GetEntitlementAsync(GetEntitlementRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the entitlement is not found for the customer.

Return Value: If found, the requested [Entitlement][google.cloud.channel.v1.Entitlement] resource, otherwise returns an error.

Parameters
NameDescription
requestGetEntitlementRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Entitlement>

The call object.

public virtual ListChannelPartnerLinksResponse ListChannelPartnerLinks(ListChannelPartnerLinksRequest request, CallOptions options)

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

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.

Return Value: If successful, returns the list of [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resources for the distributor account, otherwise returns an error.

Parameters
NameDescription
requestListChannelPartnerLinksRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListChannelPartnerLinksResponse

The response received from the server.

public virtual ListChannelPartnerLinksResponse ListChannelPartnerLinks(ListChannelPartnerLinksRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.

Return Value: If successful, returns the list of [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resources for the distributor account, otherwise returns an error.

Parameters
NameDescription
requestListChannelPartnerLinksRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListChannelPartnerLinksResponse

The response received from the server.

ListChannelPartnerLinksAsync(ListChannelPartnerLinksRequest, CallOptions)

public virtual AsyncUnaryCall<ListChannelPartnerLinksResponse> ListChannelPartnerLinksAsync(ListChannelPartnerLinksRequest request, CallOptions options)

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

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.

Return Value: If successful, returns the list of [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resources for the distributor account, otherwise returns an error.

Parameters
NameDescription
requestListChannelPartnerLinksRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListChannelPartnerLinksResponse>

The call object.

ListChannelPartnerLinksAsync(ListChannelPartnerLinksRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListChannelPartnerLinksResponse> ListChannelPartnerLinksAsync(ListChannelPartnerLinksRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.

Return Value: If successful, returns the list of [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resources for the distributor account, otherwise returns an error.

Parameters
NameDescription
requestListChannelPartnerLinksRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListChannelPartnerLinksResponse>

The call object.

ListCustomers(ListCustomersRequest, CallOptions)

public virtual ListCustomersResponse ListCustomers(ListCustomersRequest request, CallOptions options)

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

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.

Return Value: List of [Customer][google.cloud.channel.v1.Customer]s pertaining to the reseller or empty list if there are none.

Parameters
NameDescription
requestListCustomersRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListCustomersResponse

The response received from the server.

ListCustomers(ListCustomersRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListCustomersResponse ListCustomers(ListCustomersRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.

Return Value: List of [Customer][google.cloud.channel.v1.Customer]s pertaining to the reseller or empty list if there are none.

Parameters
NameDescription
requestListCustomersRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListCustomersResponse

The response received from the server.

ListCustomersAsync(ListCustomersRequest, CallOptions)

public virtual AsyncUnaryCall<ListCustomersResponse> ListCustomersAsync(ListCustomersRequest request, CallOptions options)

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

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.

Return Value: List of [Customer][google.cloud.channel.v1.Customer]s pertaining to the reseller or empty list if there are none.

Parameters
NameDescription
requestListCustomersRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListCustomersResponse>

The call object.

ListCustomersAsync(ListCustomersRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListCustomersResponse> ListCustomersAsync(ListCustomersRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.

Return Value: List of [Customer][google.cloud.channel.v1.Customer]s pertaining to the reseller or empty list if there are none.

Parameters
NameDescription
requestListCustomersRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListCustomersResponse>

The call object.

ListEntitlements(ListEntitlementsRequest, CallOptions)

public virtual ListEntitlementsResponse ListEntitlements(ListEntitlementsRequest request, CallOptions options)

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

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.

Return Value: List of [Entitlement][google.cloud.channel.v1.Entitlement]s belonging to the customer, or empty list if there are none.

Parameters
NameDescription
requestListEntitlementsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListEntitlementsResponse

The response received from the server.

ListEntitlements(ListEntitlementsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListEntitlementsResponse ListEntitlements(ListEntitlementsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.

Return Value: List of [Entitlement][google.cloud.channel.v1.Entitlement]s belonging to the customer, or empty list if there are none.

Parameters
NameDescription
requestListEntitlementsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListEntitlementsResponse

The response received from the server.

ListEntitlementsAsync(ListEntitlementsRequest, CallOptions)

public virtual AsyncUnaryCall<ListEntitlementsResponse> ListEntitlementsAsync(ListEntitlementsRequest request, CallOptions options)

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

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.

Return Value: List of [Entitlement][google.cloud.channel.v1.Entitlement]s belonging to the customer, or empty list if there are none.

Parameters
NameDescription
requestListEntitlementsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListEntitlementsResponse>

The call object.

ListEntitlementsAsync(ListEntitlementsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListEntitlementsResponse> ListEntitlementsAsync(ListEntitlementsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.

Return Value: List of [Entitlement][google.cloud.channel.v1.Entitlement]s belonging to the customer, or empty list if there are none.

Parameters
NameDescription
requestListEntitlementsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListEntitlementsResponse>

The call object.

ListOffers(ListOffersRequest, CallOptions)

public virtual ListOffersResponse ListOffers(ListOffersRequest request, CallOptions options)

Lists the Offers the reseller can sell.

Possible Error Codes:

  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
Parameters
NameDescription
requestListOffersRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListOffersResponse

The response received from the server.

ListOffers(ListOffersRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListOffersResponse ListOffers(ListOffersRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists the Offers the reseller can sell.

Possible Error Codes:

  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
Parameters
NameDescription
requestListOffersRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListOffersResponse

The response received from the server.

ListOffersAsync(ListOffersRequest, CallOptions)

public virtual AsyncUnaryCall<ListOffersResponse> ListOffersAsync(ListOffersRequest request, CallOptions options)

Lists the Offers the reseller can sell.

Possible Error Codes:

  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
Parameters
NameDescription
requestListOffersRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListOffersResponse>

The call object.

ListOffersAsync(ListOffersRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListOffersResponse> ListOffersAsync(ListOffersRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists the Offers the reseller can sell.

Possible Error Codes:

  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
Parameters
NameDescription
requestListOffersRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListOffersResponse>

The call object.

ListProducts(ListProductsRequest, CallOptions)

public virtual ListProductsResponse ListProducts(ListProductsRequest request, CallOptions options)

Lists the Products the reseller is authorized to sell.

Possible Error Codes:

  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
Parameters
NameDescription
requestListProductsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListProductsResponse

The response received from the server.

ListProducts(ListProductsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListProductsResponse ListProducts(ListProductsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists the Products the reseller is authorized to sell.

Possible Error Codes:

  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
Parameters
NameDescription
requestListProductsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListProductsResponse

The response received from the server.

ListProductsAsync(ListProductsRequest, CallOptions)

public virtual AsyncUnaryCall<ListProductsResponse> ListProductsAsync(ListProductsRequest request, CallOptions options)

Lists the Products the reseller is authorized to sell.

Possible Error Codes:

  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
Parameters
NameDescription
requestListProductsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListProductsResponse>

The call object.

ListProductsAsync(ListProductsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListProductsResponse> ListProductsAsync(ListProductsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists the Products the reseller is authorized to sell.

Possible Error Codes:

  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
Parameters
NameDescription
requestListProductsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListProductsResponse>

The call object.

ListPurchasableOffers(ListPurchasableOffersRequest, CallOptions)

public virtual ListPurchasableOffersResponse ListPurchasableOffers(ListPurchasableOffersRequest request, CallOptions options)

Lists the Purchasable Offers for the following cases:

  • Offers that can be newly purchased for a customer
  • Offers that can be changed to, for an entitlement.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
Parameters
NameDescription
requestListPurchasableOffersRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListPurchasableOffersResponse

The response received from the server.

ListPurchasableOffers(ListPurchasableOffersRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListPurchasableOffersResponse ListPurchasableOffers(ListPurchasableOffersRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists the Purchasable Offers for the following cases:

  • Offers that can be newly purchased for a customer
  • Offers that can be changed to, for an entitlement.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
Parameters
NameDescription
requestListPurchasableOffersRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListPurchasableOffersResponse

The response received from the server.

ListPurchasableOffersAsync(ListPurchasableOffersRequest, CallOptions)

public virtual AsyncUnaryCall<ListPurchasableOffersResponse> ListPurchasableOffersAsync(ListPurchasableOffersRequest request, CallOptions options)

Lists the Purchasable Offers for the following cases:

  • Offers that can be newly purchased for a customer
  • Offers that can be changed to, for an entitlement.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
Parameters
NameDescription
requestListPurchasableOffersRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListPurchasableOffersResponse>

The call object.

ListPurchasableOffersAsync(ListPurchasableOffersRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListPurchasableOffersResponse> ListPurchasableOffersAsync(ListPurchasableOffersRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists the Purchasable Offers for the following cases:

  • Offers that can be newly purchased for a customer
  • Offers that can be changed to, for an entitlement.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
Parameters
NameDescription
requestListPurchasableOffersRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListPurchasableOffersResponse>

The call object.

ListPurchasableSkus(ListPurchasableSkusRequest, CallOptions)

public virtual ListPurchasableSkusResponse ListPurchasableSkus(ListPurchasableSkusRequest request, CallOptions options)

Lists the Purchasable SKUs for following cases:

  • SKUs that can be newly purchased for a customer
  • SKUs that can be upgraded/downgraded to, for an entitlement.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
Parameters
NameDescription
requestListPurchasableSkusRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListPurchasableSkusResponse

The response received from the server.

ListPurchasableSkus(ListPurchasableSkusRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListPurchasableSkusResponse ListPurchasableSkus(ListPurchasableSkusRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists the Purchasable SKUs for following cases:

  • SKUs that can be newly purchased for a customer
  • SKUs that can be upgraded/downgraded to, for an entitlement.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
Parameters
NameDescription
requestListPurchasableSkusRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListPurchasableSkusResponse

The response received from the server.

ListPurchasableSkusAsync(ListPurchasableSkusRequest, CallOptions)

public virtual AsyncUnaryCall<ListPurchasableSkusResponse> ListPurchasableSkusAsync(ListPurchasableSkusRequest request, CallOptions options)

Lists the Purchasable SKUs for following cases:

  • SKUs that can be newly purchased for a customer
  • SKUs that can be upgraded/downgraded to, for an entitlement.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
Parameters
NameDescription
requestListPurchasableSkusRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListPurchasableSkusResponse>

The call object.

ListPurchasableSkusAsync(ListPurchasableSkusRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListPurchasableSkusResponse> ListPurchasableSkusAsync(ListPurchasableSkusRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists the Purchasable SKUs for following cases:

  • SKUs that can be newly purchased for a customer
  • SKUs that can be upgraded/downgraded to, for an entitlement.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
Parameters
NameDescription
requestListPurchasableSkusRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListPurchasableSkusResponse>

The call object.

ListSkus(ListSkusRequest, CallOptions)

public virtual ListSkusResponse ListSkus(ListSkusRequest request, CallOptions options)

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

Possible Error Codes:

  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
Parameters
NameDescription
requestListSkusRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListSkusResponse

The response received from the server.

ListSkus(ListSkusRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListSkusResponse ListSkus(ListSkusRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Possible Error Codes:

  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
Parameters
NameDescription
requestListSkusRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListSkusResponse

The response received from the server.

ListSkusAsync(ListSkusRequest, CallOptions)

public virtual AsyncUnaryCall<ListSkusResponse> ListSkusAsync(ListSkusRequest request, CallOptions options)

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

Possible Error Codes:

  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
Parameters
NameDescription
requestListSkusRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListSkusResponse>

The call object.

ListSkusAsync(ListSkusRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListSkusResponse> ListSkusAsync(ListSkusRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Possible Error Codes:

  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
Parameters
NameDescription
requestListSkusRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListSkusResponse>

The call object.

ListSubscribers(ListSubscribersRequest, CallOptions)

public virtual ListSubscribersResponse ListSubscribers(ListSubscribersRequest request, CallOptions options)

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

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being provided are different, or if the account is not a super admin.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the topic resource doesn't exist.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: List of service email addresses if successful, otherwise error is returned.

Parameters
NameDescription
requestListSubscribersRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListSubscribersResponse

The response received from the server.

ListSubscribers(ListSubscribersRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListSubscribersResponse ListSubscribers(ListSubscribersRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being provided are different, or if the account is not a super admin.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the topic resource doesn't exist.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: List of service email addresses if successful, otherwise error is returned.

Parameters
NameDescription
requestListSubscribersRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListSubscribersResponse

The response received from the server.

ListSubscribersAsync(ListSubscribersRequest, CallOptions)

public virtual AsyncUnaryCall<ListSubscribersResponse> ListSubscribersAsync(ListSubscribersRequest request, CallOptions options)

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

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being provided are different, or if the account is not a super admin.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the topic resource doesn't exist.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: List of service email addresses if successful, otherwise error is returned.

Parameters
NameDescription
requestListSubscribersRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListSubscribersResponse>

The call object.

ListSubscribersAsync(ListSubscribersRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListSubscribersResponse> ListSubscribersAsync(ListSubscribersRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being provided are different, or if the account is not a super admin.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the topic resource doesn't exist.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: List of service email addresses if successful, otherwise error is returned.

Parameters
NameDescription
requestListSubscribersRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListSubscribersResponse>

The call object.

ListTransferableOffers(ListTransferableOffersRequest, CallOptions)

public virtual ListTransferableOffersResponse ListTransferableOffers(ListTransferableOffersRequest request, CallOptions options)

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

This method is used when a reseller gets the entitlement information of a customer that is not owned. The reseller should provide the customer's Cloud Identity ID or Customer Name.

Possible Error Codes:

  • PERMISSION_DENIED: Appears because of one of the following:
  • If the customer doesn't belong to the reseller and no auth token or invalid auth token is supplied.
  • If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.

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

Parameters
NameDescription
requestListTransferableOffersRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListTransferableOffersResponse

The response received from the server.

ListTransferableOffers(ListTransferableOffersRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListTransferableOffersResponse ListTransferableOffers(ListTransferableOffersRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

This method is used when a reseller gets the entitlement information of a customer that is not owned. The reseller should provide the customer's Cloud Identity ID or Customer Name.

Possible Error Codes:

  • PERMISSION_DENIED: Appears because of one of the following:
  • If the customer doesn't belong to the reseller and no auth token or invalid auth token is supplied.
  • If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.

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

Parameters
NameDescription
requestListTransferableOffersRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListTransferableOffersResponse

The response received from the server.

ListTransferableOffersAsync(ListTransferableOffersRequest, CallOptions)

public virtual AsyncUnaryCall<ListTransferableOffersResponse> ListTransferableOffersAsync(ListTransferableOffersRequest request, CallOptions options)

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

This method is used when a reseller gets the entitlement information of a customer that is not owned. The reseller should provide the customer's Cloud Identity ID or Customer Name.

Possible Error Codes:

  • PERMISSION_DENIED: Appears because of one of the following:
  • If the customer doesn't belong to the reseller and no auth token or invalid auth token is supplied.
  • If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.

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

Parameters
NameDescription
requestListTransferableOffersRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListTransferableOffersResponse>

The call object.

ListTransferableOffersAsync(ListTransferableOffersRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListTransferableOffersResponse> ListTransferableOffersAsync(ListTransferableOffersRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

This method is used when a reseller gets the entitlement information of a customer that is not owned. The reseller should provide the customer's Cloud Identity ID or Customer Name.

Possible Error Codes:

  • PERMISSION_DENIED: Appears because of one of the following:
  • If the customer doesn't belong to the reseller and no auth token or invalid auth token is supplied.
  • If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.

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

Parameters
NameDescription
requestListTransferableOffersRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListTransferableOffersResponse>

The call object.

ListTransferableSkus(ListTransferableSkusRequest, CallOptions)

public virtual ListTransferableSkusResponse ListTransferableSkus(ListTransferableSkusRequest request, CallOptions options)

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

This method is used when a reseller lists the entitlements information of a customer that is not owned. The reseller should provide the customer's Cloud Identity ID or Customer Name.

Possible Error Codes:

  • PERMISSION_DENIED: Appears because of one of the following -
  • The customer doesn't belong to the reseller and no auth token.
  • The supplied auth token is invalid.
  • The reseller account making the request and the queries reseller account are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.

Return Value: List of [TransferableSku][google.cloud.channel.v1.TransferableSku] for the given customer.

Parameters
NameDescription
requestListTransferableSkusRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListTransferableSkusResponse

The response received from the server.

ListTransferableSkus(ListTransferableSkusRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListTransferableSkusResponse ListTransferableSkus(ListTransferableSkusRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

This method is used when a reseller lists the entitlements information of a customer that is not owned. The reseller should provide the customer's Cloud Identity ID or Customer Name.

Possible Error Codes:

  • PERMISSION_DENIED: Appears because of one of the following -
  • The customer doesn't belong to the reseller and no auth token.
  • The supplied auth token is invalid.
  • The reseller account making the request and the queries reseller account are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.

Return Value: List of [TransferableSku][google.cloud.channel.v1.TransferableSku] for the given customer.

Parameters
NameDescription
requestListTransferableSkusRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListTransferableSkusResponse

The response received from the server.

ListTransferableSkusAsync(ListTransferableSkusRequest, CallOptions)

public virtual AsyncUnaryCall<ListTransferableSkusResponse> ListTransferableSkusAsync(ListTransferableSkusRequest request, CallOptions options)

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

This method is used when a reseller lists the entitlements information of a customer that is not owned. The reseller should provide the customer's Cloud Identity ID or Customer Name.

Possible Error Codes:

  • PERMISSION_DENIED: Appears because of one of the following -
  • The customer doesn't belong to the reseller and no auth token.
  • The supplied auth token is invalid.
  • The reseller account making the request and the queries reseller account are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.

Return Value: List of [TransferableSku][google.cloud.channel.v1.TransferableSku] for the given customer.

Parameters
NameDescription
requestListTransferableSkusRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListTransferableSkusResponse>

The call object.

ListTransferableSkusAsync(ListTransferableSkusRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListTransferableSkusResponse> ListTransferableSkusAsync(ListTransferableSkusRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

This method is used when a reseller lists the entitlements information of a customer that is not owned. The reseller should provide the customer's Cloud Identity ID or Customer Name.

Possible Error Codes:

  • PERMISSION_DENIED: Appears because of one of the following -
  • The customer doesn't belong to the reseller and no auth token.
  • The supplied auth token is invalid.
  • The reseller account making the request and the queries reseller account are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.

Return Value: List of [TransferableSku][google.cloud.channel.v1.TransferableSku] for the given customer.

Parameters
NameDescription
requestListTransferableSkusRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListTransferableSkusResponse>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override CloudChannelService.CloudChannelServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration
Returns
TypeDescription
CloudChannelService.CloudChannelServiceClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Channel.V1.CloudChannelService.CloudChannelServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

ProvisionCloudIdentity(ProvisionCloudIdentityRequest, CallOptions)

public virtual Operation ProvisionCloudIdentity(ProvisionCloudIdentityRequest request, CallOptions options)

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

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the customer is not found for the reseller.
  • ALREADY_EXISTS: If the customer's primary email already exists. In this case, 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 in this case.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support in this case.

Return Value: Long Running Operation ID.

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
requestProvisionCloudIdentityRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Google.LongRunning.Operation

The response received from the server.

ProvisionCloudIdentity(ProvisionCloudIdentityRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation ProvisionCloudIdentity(ProvisionCloudIdentityRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the customer is not found for the reseller.
  • ALREADY_EXISTS: If the customer's primary email already exists. In this case, 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 in this case.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support in this case.

Return Value: Long Running Operation ID.

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
requestProvisionCloudIdentityRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Google.LongRunning.Operation

The response received from the server.

ProvisionCloudIdentityAsync(ProvisionCloudIdentityRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ProvisionCloudIdentityAsync(ProvisionCloudIdentityRequest request, CallOptions options)

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

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the customer is not found for the reseller.
  • ALREADY_EXISTS: If the customer's primary email already exists. In this case, 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 in this case.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support in this case.

Return Value: Long Running Operation ID.

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
requestProvisionCloudIdentityRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Google.LongRunning.Operation>

The call object.

ProvisionCloudIdentityAsync(ProvisionCloudIdentityRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> ProvisionCloudIdentityAsync(ProvisionCloudIdentityRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the customer is not found for the reseller.
  • ALREADY_EXISTS: If the customer's primary email already exists. In this case, 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 in this case.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support in this case.

Return Value: Long Running Operation ID.

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
requestProvisionCloudIdentityRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Google.LongRunning.Operation>

The call object.

RegisterSubscriber(RegisterSubscriberRequest, CallOptions)

public virtual RegisterSubscriberResponse RegisterSubscriber(RegisterSubscriberRequest request, CallOptions options)

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

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being provided are different, or if the impersonated user is not a super admin.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Topic name with service email address registered if successful, otherwise error is returned.

Parameters
NameDescription
requestRegisterSubscriberRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
RegisterSubscriberResponse

The response received from the server.

RegisterSubscriber(RegisterSubscriberRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual RegisterSubscriberResponse RegisterSubscriber(RegisterSubscriberRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being provided are different, or if the impersonated user is not a super admin.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Topic name with service email address registered if successful, otherwise error is returned.

Parameters
NameDescription
requestRegisterSubscriberRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
RegisterSubscriberResponse

The response received from the server.

RegisterSubscriberAsync(RegisterSubscriberRequest, CallOptions)

public virtual AsyncUnaryCall<RegisterSubscriberResponse> RegisterSubscriberAsync(RegisterSubscriberRequest request, CallOptions options)

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

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being provided are different, or if the impersonated user is not a super admin.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Topic name with service email address registered if successful, otherwise error is returned.

Parameters
NameDescription
requestRegisterSubscriberRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<RegisterSubscriberResponse>

The call object.

RegisterSubscriberAsync(RegisterSubscriberRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<RegisterSubscriberResponse> RegisterSubscriberAsync(RegisterSubscriberRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being provided are different, or if the impersonated user is not a super admin.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Topic name with service email address registered if successful, otherwise error is returned.

Parameters
NameDescription
requestRegisterSubscriberRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<RegisterSubscriberResponse>

The call object.

StartPaidService(StartPaidServiceRequest, CallOptions)

public virtual Operation StartPaidService(StartPaidServiceRequest request, CallOptions options)

Starts paid service for a trial entitlement.

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

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • 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. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

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
requestStartPaidServiceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Google.LongRunning.Operation

The response received from the server.

StartPaidService(StartPaidServiceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation StartPaidService(StartPaidServiceRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Starts paid service for a trial entitlement.

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

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • 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. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

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
requestStartPaidServiceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Google.LongRunning.Operation

The response received from the server.

StartPaidServiceAsync(StartPaidServiceRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> StartPaidServiceAsync(StartPaidServiceRequest request, CallOptions options)

Starts paid service for a trial entitlement.

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

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • 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. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

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
requestStartPaidServiceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Google.LongRunning.Operation>

The call object.

StartPaidServiceAsync(StartPaidServiceRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> StartPaidServiceAsync(StartPaidServiceRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Starts paid service for a trial entitlement.

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

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • 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. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

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
requestStartPaidServiceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Google.LongRunning.Operation>

The call object.

SuspendEntitlement(SuspendEntitlementRequest, CallOptions)

public virtual Operation SuspendEntitlement(SuspendEntitlementRequest request, CallOptions options)

Suspends a previously fulfilled entitlement. An entitlement suspension is a long-running operation.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • 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. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

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
requestSuspendEntitlementRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Google.LongRunning.Operation

The response received from the server.

SuspendEntitlement(SuspendEntitlementRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation SuspendEntitlement(SuspendEntitlementRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Suspends a previously fulfilled entitlement. An entitlement suspension is a long-running operation.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • 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. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

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
requestSuspendEntitlementRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Google.LongRunning.Operation

The response received from the server.

SuspendEntitlementAsync(SuspendEntitlementRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SuspendEntitlementAsync(SuspendEntitlementRequest request, CallOptions options)

Suspends a previously fulfilled entitlement. An entitlement suspension is a long-running operation.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • 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. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

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
requestSuspendEntitlementRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Google.LongRunning.Operation>

The call object.

SuspendEntitlementAsync(SuspendEntitlementRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> SuspendEntitlementAsync(SuspendEntitlementRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Suspends a previously fulfilled entitlement. An entitlement suspension is a long-running operation.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • 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. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Long Running Operation ID.

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
requestSuspendEntitlementRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Google.LongRunning.Operation>

The call object.

TransferEntitlements(TransferEntitlementsRequest, CallOptions)

public virtual Operation TransferEntitlements(TransferEntitlementsRequest request, CallOptions options)

Transfers customer entitlements to new reseller.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the customer or offer resource is not found for the reseller.
  • ALREADY_EXISTS: If the SKU has been already transferred for the customer.
  • CONDITION_NOT_MET or FAILED_PRECONDITION: This failure can happen in the following cases:
  • Transferring a SKU that requires domain verification and the domain has not been verified.
  • Transferring an Add-On SKU like Vault or Drive without transferring the pre-requisite SKU, such as G Suite Basic.
  • Applicable only for developer accounts: reseller and resold domain must follow the domain naming convention as follows:
    • Domain names must start with goog-test.
    • Resold domain names must include the reseller domain.
  • All transferring entitlements must be specified.
  • INTERNAL: Any non-user error related to a technical issue in the backend. Please contact Cloud Channel Support in this case.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Please contact Cloud Channel Support in this case.

Return Value: Long Running Operation ID.

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
requestTransferEntitlementsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Google.LongRunning.Operation

The response received from the server.

TransferEntitlements(TransferEntitlementsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation TransferEntitlements(TransferEntitlementsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Transfers customer entitlements to new reseller.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the customer or offer resource is not found for the reseller.
  • ALREADY_EXISTS: If the SKU has been already transferred for the customer.
  • CONDITION_NOT_MET or FAILED_PRECONDITION: This failure can happen in the following cases:
  • Transferring a SKU that requires domain verification and the domain has not been verified.
  • Transferring an Add-On SKU like Vault or Drive without transferring the pre-requisite SKU, such as G Suite Basic.
  • Applicable only for developer accounts: reseller and resold domain must follow the domain naming convention as follows:
    • Domain names must start with goog-test.
    • Resold domain names must include the reseller domain.
  • All transferring entitlements must be specified.
  • INTERNAL: Any non-user error related to a technical issue in the backend. Please contact Cloud Channel Support in this case.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Please contact Cloud Channel Support in this case.

Return Value: Long Running Operation ID.

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
requestTransferEntitlementsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Google.LongRunning.Operation

The response received from the server.

TransferEntitlementsAsync(TransferEntitlementsRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> TransferEntitlementsAsync(TransferEntitlementsRequest request, CallOptions options)

Transfers customer entitlements to new reseller.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the customer or offer resource is not found for the reseller.
  • ALREADY_EXISTS: If the SKU has been already transferred for the customer.
  • CONDITION_NOT_MET or FAILED_PRECONDITION: This failure can happen in the following cases:
  • Transferring a SKU that requires domain verification and the domain has not been verified.
  • Transferring an Add-On SKU like Vault or Drive without transferring the pre-requisite SKU, such as G Suite Basic.
  • Applicable only for developer accounts: reseller and resold domain must follow the domain naming convention as follows:
    • Domain names must start with goog-test.
    • Resold domain names must include the reseller domain.
  • All transferring entitlements must be specified.
  • INTERNAL: Any non-user error related to a technical issue in the backend. Please contact Cloud Channel Support in this case.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Please contact Cloud Channel Support in this case.

Return Value: Long Running Operation ID.

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
requestTransferEntitlementsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Google.LongRunning.Operation>

The call object.

TransferEntitlementsAsync(TransferEntitlementsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> TransferEntitlementsAsync(TransferEntitlementsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Transfers customer entitlements to new reseller.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the customer or offer resource is not found for the reseller.
  • ALREADY_EXISTS: If the SKU has been already transferred for the customer.
  • CONDITION_NOT_MET or FAILED_PRECONDITION: This failure can happen in the following cases:
  • Transferring a SKU that requires domain verification and the domain has not been verified.
  • Transferring an Add-On SKU like Vault or Drive without transferring the pre-requisite SKU, such as G Suite Basic.
  • Applicable only for developer accounts: reseller and resold domain must follow the domain naming convention as follows:
    • Domain names must start with goog-test.
    • Resold domain names must include the reseller domain.
  • All transferring entitlements must be specified.
  • INTERNAL: Any non-user error related to a technical issue in the backend. Please contact Cloud Channel Support in this case.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Please contact Cloud Channel Support in this case.

Return Value: Long Running Operation ID.

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
requestTransferEntitlementsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Google.LongRunning.Operation>

The call object.

TransferEntitlementsToGoogle(TransferEntitlementsToGoogleRequest, CallOptions)

public virtual Operation TransferEntitlementsToGoogle(TransferEntitlementsToGoogleRequest request, CallOptions options)

Transfers customer entitlements from current reseller to Google.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the customer or offer resource is not found for the reseller.
  • ALREADY_EXISTS: If the SKU has been already transferred for the customer.
  • CONDITION_NOT_MET or FAILED_PRECONDITION: This failure can happen in the following cases:
  • Transferring a SKU that requires domain verification and the domain has not been verified.
  • Transferring an Add-On SKU like Vault or Drive without purchasing the pre-requisite SKU, such as G Suite Basic.
  • Applicable only for developer accounts: reseller and resold domain must follow the domain naming convention as follows:
    • Domain names must start with goog-test.
    • Resold domain names must include the reseller domain.
  • INTERNAL: Any non-user error related to a technical issue in the backend. Please contact Cloud Channel Support in this case.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Please contact Cloud Channel Support in this case.

Return Value: Long Running Operation ID.

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
requestTransferEntitlementsToGoogleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Google.LongRunning.Operation

The response received from the server.

TransferEntitlementsToGoogle(TransferEntitlementsToGoogleRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation TransferEntitlementsToGoogle(TransferEntitlementsToGoogleRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Transfers customer entitlements from current reseller to Google.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the customer or offer resource is not found for the reseller.
  • ALREADY_EXISTS: If the SKU has been already transferred for the customer.
  • CONDITION_NOT_MET or FAILED_PRECONDITION: This failure can happen in the following cases:
  • Transferring a SKU that requires domain verification and the domain has not been verified.
  • Transferring an Add-On SKU like Vault or Drive without purchasing the pre-requisite SKU, such as G Suite Basic.
  • Applicable only for developer accounts: reseller and resold domain must follow the domain naming convention as follows:
    • Domain names must start with goog-test.
    • Resold domain names must include the reseller domain.
  • INTERNAL: Any non-user error related to a technical issue in the backend. Please contact Cloud Channel Support in this case.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Please contact Cloud Channel Support in this case.

Return Value: Long Running Operation ID.

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
requestTransferEntitlementsToGoogleRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Google.LongRunning.Operation

The response received from the server.

TransferEntitlementsToGoogleAsync(TransferEntitlementsToGoogleRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> TransferEntitlementsToGoogleAsync(TransferEntitlementsToGoogleRequest request, CallOptions options)

Transfers customer entitlements from current reseller to Google.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the customer or offer resource is not found for the reseller.
  • ALREADY_EXISTS: If the SKU has been already transferred for the customer.
  • CONDITION_NOT_MET or FAILED_PRECONDITION: This failure can happen in the following cases:
  • Transferring a SKU that requires domain verification and the domain has not been verified.
  • Transferring an Add-On SKU like Vault or Drive without purchasing the pre-requisite SKU, such as G Suite Basic.
  • Applicable only for developer accounts: reseller and resold domain must follow the domain naming convention as follows:
    • Domain names must start with goog-test.
    • Resold domain names must include the reseller domain.
  • INTERNAL: Any non-user error related to a technical issue in the backend. Please contact Cloud Channel Support in this case.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Please contact Cloud Channel Support in this case.

Return Value: Long Running Operation ID.

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
requestTransferEntitlementsToGoogleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Google.LongRunning.Operation>

The call object.

TransferEntitlementsToGoogleAsync(TransferEntitlementsToGoogleRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> TransferEntitlementsToGoogleAsync(TransferEntitlementsToGoogleRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Transfers customer entitlements from current reseller to Google.

Possible Error Codes:

  • PERMISSION_DENIED: If the customer doesn't belong to the reseller.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the customer or offer resource is not found for the reseller.
  • ALREADY_EXISTS: If the SKU has been already transferred for the customer.
  • CONDITION_NOT_MET or FAILED_PRECONDITION: This failure can happen in the following cases:
  • Transferring a SKU that requires domain verification and the domain has not been verified.
  • Transferring an Add-On SKU like Vault or Drive without purchasing the pre-requisite SKU, such as G Suite Basic.
  • Applicable only for developer accounts: reseller and resold domain must follow the domain naming convention as follows:
    • Domain names must start with goog-test.
    • Resold domain names must include the reseller domain.
  • INTERNAL: Any non-user error related to a technical issue in the backend. Please contact Cloud Channel Support in this case.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. Please contact Cloud Channel Support in this case.

Return Value: Long Running Operation ID.

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
requestTransferEntitlementsToGoogleRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Google.LongRunning.Operation>

The call object.

UnregisterSubscriber(UnregisterSubscriberRequest, CallOptions)

public virtual UnregisterSubscriberResponse UnregisterSubscriber(UnregisterSubscriberRequest request, CallOptions options)

Unregisters a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. If there are no more service account left with sunbscriber privileges, the topic will be deleted. You can check this by calling ListSubscribers api.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being provided are different, or if the impersonated user is not a super admin.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the topic resource doesn't exist.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Topic name from which service email address has been unregistered if successful, otherwise error is returned. If the service email was already not associated with the topic, the success response will be returned.

Parameters
NameDescription
requestUnregisterSubscriberRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
UnregisterSubscriberResponse

The response received from the server.

UnregisterSubscriber(UnregisterSubscriberRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual UnregisterSubscriberResponse UnregisterSubscriber(UnregisterSubscriberRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Unregisters a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. If there are no more service account left with sunbscriber privileges, the topic will be deleted. You can check this by calling ListSubscribers api.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being provided are different, or if the impersonated user is not a super admin.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the topic resource doesn't exist.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Topic name from which service email address has been unregistered if successful, otherwise error is returned. If the service email was already not associated with the topic, the success response will be returned.

Parameters
NameDescription
requestUnregisterSubscriberRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
UnregisterSubscriberResponse

The response received from the server.

UnregisterSubscriberAsync(UnregisterSubscriberRequest, CallOptions)

public virtual AsyncUnaryCall<UnregisterSubscriberResponse> UnregisterSubscriberAsync(UnregisterSubscriberRequest request, CallOptions options)

Unregisters a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. If there are no more service account left with sunbscriber privileges, the topic will be deleted. You can check this by calling ListSubscribers api.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being provided are different, or if the impersonated user is not a super admin.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the topic resource doesn't exist.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Topic name from which service email address has been unregistered if successful, otherwise error is returned. If the service email was already not associated with the topic, the success response will be returned.

Parameters
NameDescription
requestUnregisterSubscriberRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<UnregisterSubscriberResponse>

The call object.

UnregisterSubscriberAsync(UnregisterSubscriberRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<UnregisterSubscriberResponse> UnregisterSubscriberAsync(UnregisterSubscriberRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Unregisters a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. If there are no more service account left with sunbscriber privileges, the topic will be deleted. You can check this by calling ListSubscribers api.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being provided are different, or if the impersonated user is not a super admin.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: If the topic resource doesn't exist.
  • INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

Return Value: Topic name from which service email address has been unregistered if successful, otherwise error is returned. If the service email was already not associated with the topic, the success response will be returned.

Parameters
NameDescription
requestUnregisterSubscriberRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<UnregisterSubscriberResponse>

The call object.

public virtual ChannelPartnerLink UpdateChannelPartnerLink(UpdateChannelPartnerLinkRequest request, CallOptions options)

Updates a channel partner link. A distributor calls this method to change a link's status. For example, suspend a partner link. To call this method, you must be a distributor.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: It can happen in following scenarios -
  • Missing or invalid required parameters in the request.
  • Updating link state from invited to active or suspended.
  • Sending 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. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

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

Parameters
NameDescription
requestUpdateChannelPartnerLinkRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ChannelPartnerLink

The response received from the server.

public virtual ChannelPartnerLink UpdateChannelPartnerLink(UpdateChannelPartnerLinkRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Updates a channel partner link. A distributor calls this method to change a link's status. For example, suspend a partner link. To call this method, you must be a distributor.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: It can happen in following scenarios -
  • Missing or invalid required parameters in the request.
  • Updating link state from invited to active or suspended.
  • Sending 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. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

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

Parameters
NameDescription
requestUpdateChannelPartnerLinkRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ChannelPartnerLink

The response received from the server.

UpdateChannelPartnerLinkAsync(UpdateChannelPartnerLinkRequest, CallOptions)

public virtual AsyncUnaryCall<ChannelPartnerLink> UpdateChannelPartnerLinkAsync(UpdateChannelPartnerLinkRequest request, CallOptions options)

Updates a channel partner link. A distributor calls this method to change a link's status. For example, suspend a partner link. To call this method, you must be a distributor.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: It can happen in following scenarios -
  • Missing or invalid required parameters in the request.
  • Updating link state from invited to active or suspended.
  • Sending 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. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

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

Parameters
NameDescription
requestUpdateChannelPartnerLinkRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ChannelPartnerLink>

The call object.

UpdateChannelPartnerLinkAsync(UpdateChannelPartnerLinkRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ChannelPartnerLink> UpdateChannelPartnerLinkAsync(UpdateChannelPartnerLinkRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Updates a channel partner link. A distributor calls this method to change a link's status. For example, suspend a partner link. To call this method, you must be a distributor.

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: It can happen in following scenarios -
  • Missing or invalid required parameters in the request.
  • Updating link state from invited to active or suspended.
  • Sending 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. In this case, contact Cloud Channel support.
  • UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.

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

Parameters
NameDescription
requestUpdateChannelPartnerLinkRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ChannelPartnerLink>

The call object.

UpdateCustomer(UpdateCustomerRequest, CallOptions)

public virtual Customer UpdateCustomer(UpdateCustomerRequest request, CallOptions options)

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

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name specified in the request.

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

Parameters
NameDescription
requestUpdateCustomerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Customer

The response received from the server.

UpdateCustomer(UpdateCustomerRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Customer UpdateCustomer(UpdateCustomerRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name specified in the request.

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

Parameters
NameDescription
requestUpdateCustomerRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Customer

The response received from the server.

UpdateCustomerAsync(UpdateCustomerRequest, CallOptions)

public virtual AsyncUnaryCall<Customer> UpdateCustomerAsync(UpdateCustomerRequest request, CallOptions options)

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

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name specified in the request.

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

Parameters
NameDescription
requestUpdateCustomerRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Customer>

The call object.

UpdateCustomerAsync(UpdateCustomerRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Customer> UpdateCustomerAsync(UpdateCustomerRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Possible Error Codes:

  • PERMISSION_DENIED: If the reseller account making the request and the reseller account being queried for are different.
  • INVALID_ARGUMENT: Missing or invalid required parameters in the request.
  • NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name specified in the request.

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

Parameters
NameDescription
requestUpdateCustomerRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Customer>

The call object.