public sealed class CloudChannelServiceClientImpl : CloudChannelServiceClient
Reference documentation and code samples for the Cloud Channel v1 API class CloudChannelServiceClientImpl.
CloudChannelService client wrapper implementation, for convenient use.
Namespace
Google.Cloud.Channel.V1Assembly
Google.Cloud.Channel.V1.dll
Remarks
CloudChannelService lets Google cloud resellers and distributors manage their customers, channel partners, entitlements, and reports.
Using this service:
- Resellers and distributors can manage a customer entity.
- Distributors can register an authorized reseller in their channel and provide them with delegated admin access.
- Resellers and distributors can manage customer entitlements.
CloudChannelService exposes the following resources:
[Customer][google.cloud.channel.v1.Customer]s: An entity-usually an enterprise-managed by a reseller or distributor.
[Entitlement][google.cloud.channel.v1.Entitlement]s: An entity that provides a customer with the means to use a service. Entitlements are created or updated as a result of a successful fulfillment.
[ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]s: An entity that identifies links between distributors and their indirect resellers in a channel.
Constructors
CloudChannelServiceClientImpl(CloudChannelService.CloudChannelServiceClient, CloudChannelServiceSettings, ILogger)
public CloudChannelServiceClientImpl(CloudChannelService.CloudChannelServiceClient grpcClient, CloudChannelServiceSettings settings, ILogger logger)
Constructs a client wrapper for the CloudChannelService service, with the specified gRPC client and settings.
Parameters | |
---|---|
Name | Description |
grpcClient | CloudChannelService.CloudChannelServiceClient The underlying gRPC client. |
settings | CloudChannelServiceSettings The base CloudChannelServiceSettings used within this client. |
logger | ILogger Optional ILogger to use within this client. |
Properties
ActivateEntitlementOperationsClient
public override OperationsClient ActivateEntitlementOperationsClient { get; }
The long-running operations client for ActivateEntitlement
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
CancelEntitlementOperationsClient
public override OperationsClient CancelEntitlementOperationsClient { get; }
The long-running operations client for CancelEntitlement
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
ChangeOfferOperationsClient
public override OperationsClient ChangeOfferOperationsClient { get; }
The long-running operations client for ChangeOffer
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
ChangeParametersOperationsClient
public override OperationsClient ChangeParametersOperationsClient { get; }
The long-running operations client for ChangeParameters
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
ChangeRenewalSettingsOperationsClient
public override OperationsClient ChangeRenewalSettingsOperationsClient { get; }
The long-running operations client for ChangeRenewalSettings
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
CreateEntitlementOperationsClient
public override OperationsClient CreateEntitlementOperationsClient { get; }
The long-running operations client for CreateEntitlement
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
GrpcClient
public override CloudChannelService.CloudChannelServiceClient GrpcClient { get; }
The underlying gRPC CloudChannelService client
Property Value | |
---|---|
Type | Description |
CloudChannelService.CloudChannelServiceClient |
ProvisionCloudIdentityOperationsClient
public override OperationsClient ProvisionCloudIdentityOperationsClient { get; }
The long-running operations client for ProvisionCloudIdentity
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
StartPaidServiceOperationsClient
public override OperationsClient StartPaidServiceOperationsClient { get; }
The long-running operations client for StartPaidService
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
SuspendEntitlementOperationsClient
public override OperationsClient SuspendEntitlementOperationsClient { get; }
The long-running operations client for SuspendEntitlement
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
TransferEntitlementsOperationsClient
public override OperationsClient TransferEntitlementsOperationsClient { get; }
The long-running operations client for TransferEntitlements
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
TransferEntitlementsToGoogleOperationsClient
public override OperationsClient TransferEntitlementsToGoogleOperationsClient { get; }
The long-running operations client for TransferEntitlementsToGoogle
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
Methods
ActivateEntitlement(ActivateEntitlementRequest, CallSettings)
public override Operation<Entitlement, OperationMetadata> ActivateEntitlement(ActivateEntitlementRequest request, CallSettings callSettings = null)
Activates a previously suspended entitlement. Entitlements suspended for pending ToS acceptance can't be activated using this method.
An entitlement activation is a long-running operation and it updates the state of the customer entitlement.
Possible error codes:
- PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- NOT_FOUND: Entitlement resource not found.
- SUSPENSION_NOT_RESELLER_INITIATED: Can only activate reseller-initiated suspensions and entitlements that have accepted the TOS.
- NOT_SUSPENDED: Can only activate suspended entitlements not in an ACTIVE state.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
Parameters | |
---|---|
Name | Description |
request | ActivateEntitlementRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Entitlement, OperationMetadata> | The RPC response. |
ActivateEntitlementAsync(ActivateEntitlementRequest, CallSettings)
public override async Task<Operation<Entitlement, OperationMetadata>> ActivateEntitlementAsync(ActivateEntitlementRequest request, CallSettings callSettings = null)
Activates a previously suspended entitlement. Entitlements suspended for pending ToS acceptance can't be activated using this method.
An entitlement activation is a long-running operation and it updates the state of the customer entitlement.
Possible error codes:
- PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- NOT_FOUND: Entitlement resource not found.
- SUSPENSION_NOT_RESELLER_INITIATED: Can only activate reseller-initiated suspensions and entitlements that have accepted the TOS.
- NOT_SUSPENDED: Can only activate suspended entitlements not in an ACTIVE state.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
Parameters | |
---|---|
Name | Description |
request | ActivateEntitlementRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Entitlement, OperationMetadata>> | A Task containing the RPC response. |
CancelEntitlement(CancelEntitlementRequest, CallSettings)
public override Operation<Empty, OperationMetadata> CancelEntitlement(CancelEntitlementRequest request, CallSettings callSettings = null)
Cancels a previously fulfilled entitlement.
An entitlement cancellation is a long-running operation.
Possible error codes:
- PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
- FAILED_PRECONDITION: There are Google Cloud projects linked to the Google Cloud entitlement's Cloud Billing subaccount.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- NOT_FOUND: Entitlement resource not found.
- DELETION_TYPE_NOT_ALLOWED: Cancel is only allowed for Google Workspace add-ons, or entitlements for Google Cloud's development platform.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The response will contain google.protobuf.Empty on success. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
Parameters | |
---|---|
Name | Description |
request | CancelEntitlementRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Empty, OperationMetadata> | The RPC response. |
CancelEntitlementAsync(CancelEntitlementRequest, CallSettings)
public override async Task<Operation<Empty, OperationMetadata>> CancelEntitlementAsync(CancelEntitlementRequest request, CallSettings callSettings = null)
Cancels a previously fulfilled entitlement.
An entitlement cancellation is a long-running operation.
Possible error codes:
- PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
- FAILED_PRECONDITION: There are Google Cloud projects linked to the Google Cloud entitlement's Cloud Billing subaccount.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- NOT_FOUND: Entitlement resource not found.
- DELETION_TYPE_NOT_ALLOWED: Cancel is only allowed for Google Workspace add-ons, or entitlements for Google Cloud's development platform.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The response will contain google.protobuf.Empty on success. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
Parameters | |
---|---|
Name | Description |
request | CancelEntitlementRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Empty, OperationMetadata>> | A Task containing the RPC response. |
ChangeOffer(ChangeOfferRequest, CallSettings)
public override Operation<Entitlement, OperationMetadata> ChangeOffer(ChangeOfferRequest request, CallSettings callSettings = null)
Updates the Offer for an existing customer entitlement.
An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment.
Possible error codes:
- PERMISSION_DENIED: The customer doesn't belong to the reseller.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- NOT_FOUND: Offer or Entitlement resource not found.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
Parameters | |
---|---|
Name | Description |
request | ChangeOfferRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Entitlement, OperationMetadata> | The RPC response. |
ChangeOfferAsync(ChangeOfferRequest, CallSettings)
public override async Task<Operation<Entitlement, OperationMetadata>> ChangeOfferAsync(ChangeOfferRequest request, CallSettings callSettings = null)
Updates the Offer for an existing customer entitlement.
An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment.
Possible error codes:
- PERMISSION_DENIED: The customer doesn't belong to the reseller.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- NOT_FOUND: Offer or Entitlement resource not found.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
Parameters | |
---|---|
Name | Description |
request | ChangeOfferRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Entitlement, OperationMetadata>> | A Task containing the RPC response. |
ChangeParameters(ChangeParametersRequest, CallSettings)
public override Operation<Entitlement, OperationMetadata> ChangeParameters(ChangeParametersRequest request, CallSettings callSettings = null)
Change parameters of the entitlement.
An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment.
Possible error codes:
- PERMISSION_DENIED: The customer doesn't belong to the reseller.
- INVALID_ARGUMENT: Required request parameters are missing or invalid. For example, the number of seats being changed is greater than the allowed number of max seats, or decreasing seats for a commitment based plan.
- NOT_FOUND: Entitlement resource not found.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
Parameters | |
---|---|
Name | Description |
request | ChangeParametersRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Entitlement, OperationMetadata> | The RPC response. |
ChangeParametersAsync(ChangeParametersRequest, CallSettings)
public override async Task<Operation<Entitlement, OperationMetadata>> ChangeParametersAsync(ChangeParametersRequest request, CallSettings callSettings = null)
Change parameters of the entitlement.
An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment.
Possible error codes:
- PERMISSION_DENIED: The customer doesn't belong to the reseller.
- INVALID_ARGUMENT: Required request parameters are missing or invalid. For example, the number of seats being changed is greater than the allowed number of max seats, or decreasing seats for a commitment based plan.
- NOT_FOUND: Entitlement resource not found.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
Parameters | |
---|---|
Name | Description |
request | ChangeParametersRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Entitlement, OperationMetadata>> | A Task containing the RPC response. |
ChangeRenewalSettings(ChangeRenewalSettingsRequest, CallSettings)
public override Operation<Entitlement, OperationMetadata> ChangeRenewalSettings(ChangeRenewalSettingsRequest request, CallSettings callSettings = null)
Updates the renewal settings for an existing customer entitlement.
An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment.
Possible error codes:
- PERMISSION_DENIED: The customer doesn't belong to the reseller.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- NOT_FOUND: Entitlement resource not found.
- NOT_COMMITMENT_PLAN: Renewal Settings are only applicable for a commitment plan. Can't enable or disable renewals for non-commitment plans.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
Parameters | |
---|---|
Name | Description |
request | ChangeRenewalSettingsRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Entitlement, OperationMetadata> | The RPC response. |
ChangeRenewalSettingsAsync(ChangeRenewalSettingsRequest, CallSettings)
public override async Task<Operation<Entitlement, OperationMetadata>> ChangeRenewalSettingsAsync(ChangeRenewalSettingsRequest request, CallSettings callSettings = null)
Updates the renewal settings for an existing customer entitlement.
An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment.
Possible error codes:
- PERMISSION_DENIED: The customer doesn't belong to the reseller.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- NOT_FOUND: Entitlement resource not found.
- NOT_COMMITMENT_PLAN: Renewal Settings are only applicable for a commitment plan. Can't enable or disable renewals for non-commitment plans.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
Parameters | |
---|---|
Name | Description |
request | ChangeRenewalSettingsRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Entitlement, OperationMetadata>> | A Task containing the RPC response. |
CheckCloudIdentityAccountsExist(CheckCloudIdentityAccountsExistRequest, CallSettings)
public override CheckCloudIdentityAccountsExistResponse CheckCloudIdentityAccountsExist(CheckCloudIdentityAccountsExistRequest request, CallSettings callSettings = null)
Confirms the existence of Cloud Identity accounts based on the domain and if the Cloud Identity accounts are owned by the reseller.
Possible error codes:
- PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- INVALID_VALUE: Invalid domain value in the request.
Return value: A list of [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] resources for the domain (may be empty)
Note: in the v1alpha1 version of the API, a NOT_FOUND error returns if no [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] resources match the domain.
Parameters | |
---|---|
Name | Description |
request | CheckCloudIdentityAccountsExistRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
CheckCloudIdentityAccountsExistResponse | The RPC response. |
CheckCloudIdentityAccountsExistAsync(CheckCloudIdentityAccountsExistRequest, CallSettings)
public override Task<CheckCloudIdentityAccountsExistResponse> CheckCloudIdentityAccountsExistAsync(CheckCloudIdentityAccountsExistRequest request, CallSettings callSettings = null)
Confirms the existence of Cloud Identity accounts based on the domain and if the Cloud Identity accounts are owned by the reseller.
Possible error codes:
- PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- INVALID_VALUE: Invalid domain value in the request.
Return value: A list of [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] resources for the domain (may be empty)
Note: in the v1alpha1 version of the API, a NOT_FOUND error returns if no [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] resources match the domain.
Parameters | |
---|---|
Name | Description |
request | CheckCloudIdentityAccountsExistRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<CheckCloudIdentityAccountsExistResponse> | A Task containing the RPC response. |
CreateChannelPartnerLink(CreateChannelPartnerLinkRequest, CallSettings)
public override ChannelPartnerLink CreateChannelPartnerLink(CreateChannelPartnerLinkRequest request, CallSettings callSettings = null)
Initiates a channel partner link between a distributor and a reseller, or between resellers in an n-tier reseller channel. Invited partners need to follow the invite_link_uri provided in the response to accept. After accepting the invitation, a link is set up between the two parties. You must be a distributor to call this method.
Possible error codes:
- PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- ALREADY_EXISTS: The ChannelPartnerLink sent in the request already exists.
- NOT_FOUND: No Cloud Identity customer exists for provided domain.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The new [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource.
Parameters | |
---|---|
Name | Description |
request | CreateChannelPartnerLinkRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
ChannelPartnerLink | The RPC response. |
CreateChannelPartnerLinkAsync(CreateChannelPartnerLinkRequest, CallSettings)
public override Task<ChannelPartnerLink> CreateChannelPartnerLinkAsync(CreateChannelPartnerLinkRequest request, CallSettings callSettings = null)
Initiates a channel partner link between a distributor and a reseller, or between resellers in an n-tier reseller channel. Invited partners need to follow the invite_link_uri provided in the response to accept. After accepting the invitation, a link is set up between the two parties. You must be a distributor to call this method.
Possible error codes:
- PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- ALREADY_EXISTS: The ChannelPartnerLink sent in the request already exists.
- NOT_FOUND: No Cloud Identity customer exists for provided domain.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The new [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource.
Parameters | |
---|---|
Name | Description |
request | CreateChannelPartnerLinkRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<ChannelPartnerLink> | A Task containing the RPC response. |
CreateChannelPartnerRepricingConfig(CreateChannelPartnerRepricingConfigRequest, CallSettings)
public override ChannelPartnerRepricingConfig CreateChannelPartnerRepricingConfig(CreateChannelPartnerRepricingConfigRequest request, CallSettings callSettings = null)
Creates a ChannelPartnerRepricingConfig. Call this method to set modifications for a specific ChannelPartner's bill. You can only create configs if the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is a future month. If needed, you can create a config for the current month, with some restrictions.
When creating a config for a future month, make sure there are no existing configs for that [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].
The following restrictions are for creating configs in the current month.
- This functionality is reserved for recovering from an erroneous config, and should not be used for regular business cases.
- The new config will not modify exports used with other configs. Changes to the config may be immediate, but may take up to 24 hours.
- There is a limit of ten configs for any ChannelPartner or [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].
- The contained [ChannelPartnerRepricingConfig.repricing_config][google.cloud.channel.v1.ChannelPartnerRepricingConfig.repricing_config] vaule must be different from the value used in the current config for a ChannelPartner.
Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.
- NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] specified does not exist or is not associated with the given account.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the updated [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resource, otherwise returns an error.
Parameters | |
---|---|
Name | Description |
request | CreateChannelPartnerRepricingConfigRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
ChannelPartnerRepricingConfig | The RPC response. |
CreateChannelPartnerRepricingConfigAsync(CreateChannelPartnerRepricingConfigRequest, CallSettings)
public override Task<ChannelPartnerRepricingConfig> CreateChannelPartnerRepricingConfigAsync(CreateChannelPartnerRepricingConfigRequest request, CallSettings callSettings = null)
Creates a ChannelPartnerRepricingConfig. Call this method to set modifications for a specific ChannelPartner's bill. You can only create configs if the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is a future month. If needed, you can create a config for the current month, with some restrictions.
When creating a config for a future month, make sure there are no existing configs for that [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].
The following restrictions are for creating configs in the current month.
- This functionality is reserved for recovering from an erroneous config, and should not be used for regular business cases.
- The new config will not modify exports used with other configs. Changes to the config may be immediate, but may take up to 24 hours.
- There is a limit of ten configs for any ChannelPartner or [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].
- The contained [ChannelPartnerRepricingConfig.repricing_config][google.cloud.channel.v1.ChannelPartnerRepricingConfig.repricing_config] vaule must be different from the value used in the current config for a ChannelPartner.
Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.
- NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] specified does not exist or is not associated with the given account.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the updated [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resource, otherwise returns an error.
Parameters | |
---|---|
Name | Description |
request | CreateChannelPartnerRepricingConfigRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<ChannelPartnerRepricingConfig> | A Task containing the RPC response. |
CreateCustomer(CreateCustomerRequest, CallSettings)
public override Customer CreateCustomer(CreateCustomerRequest request, CallSettings callSettings = null)
Creates a new [Customer][google.cloud.channel.v1.Customer] resource under the reseller or distributor account.
Possible error codes:
- PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
- INVALID_ARGUMENT:
- Required request parameters are missing or invalid.
- Domain field value doesn't match the primary email domain.
Return value: The newly created [Customer][google.cloud.channel.v1.Customer] resource.
Parameters | |
---|---|
Name | Description |
request | CreateCustomerRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Customer | The RPC response. |
CreateCustomerAsync(CreateCustomerRequest, CallSettings)
public override Task<Customer> CreateCustomerAsync(CreateCustomerRequest request, CallSettings callSettings = null)
Creates a new [Customer][google.cloud.channel.v1.Customer] resource under the reseller or distributor account.
Possible error codes:
- PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
- INVALID_ARGUMENT:
- Required request parameters are missing or invalid.
- Domain field value doesn't match the primary email domain.
Return value: The newly created [Customer][google.cloud.channel.v1.Customer] resource.
Parameters | |
---|---|
Name | Description |
request | CreateCustomerRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Customer> | A Task containing the RPC response. |
CreateCustomerRepricingConfig(CreateCustomerRepricingConfigRequest, CallSettings)
public override CustomerRepricingConfig CreateCustomerRepricingConfig(CreateCustomerRepricingConfigRequest request, CallSettings callSettings = null)
Creates a CustomerRepricingConfig. Call this method to set modifications for a specific customer's bill. You can only create configs if the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is a future month. If needed, you can create a config for the current month, with some restrictions.
When creating a config for a future month, make sure there are no existing configs for that [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].
The following restrictions are for creating configs in the current month.
- This functionality is reserved for recovering from an erroneous config, and should not be used for regular business cases.
- The new config will not modify exports used with other configs. Changes to the config may be immediate, but may take up to 24 hours.
- There is a limit of ten configs for any [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement] or [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].
- The contained [CustomerRepricingConfig.repricing_config][google.cloud.channel.v1.CustomerRepricingConfig.repricing_config] vaule must be different from the value used in the current config for a [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement].
Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.
- NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] specified does not exist or is not associated with the given account.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the updated [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resource, otherwise returns an error.
Parameters | |
---|---|
Name | Description |
request | CreateCustomerRepricingConfigRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
CustomerRepricingConfig | The RPC response. |
CreateCustomerRepricingConfigAsync(CreateCustomerRepricingConfigRequest, CallSettings)
public override Task<CustomerRepricingConfig> CreateCustomerRepricingConfigAsync(CreateCustomerRepricingConfigRequest request, CallSettings callSettings = null)
Creates a CustomerRepricingConfig. Call this method to set modifications for a specific customer's bill. You can only create configs if the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is a future month. If needed, you can create a config for the current month, with some restrictions.
When creating a config for a future month, make sure there are no existing configs for that [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].
The following restrictions are for creating configs in the current month.
- This functionality is reserved for recovering from an erroneous config, and should not be used for regular business cases.
- The new config will not modify exports used with other configs. Changes to the config may be immediate, but may take up to 24 hours.
- There is a limit of ten configs for any [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement] or [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].
- The contained [CustomerRepricingConfig.repricing_config][google.cloud.channel.v1.CustomerRepricingConfig.repricing_config] vaule must be different from the value used in the current config for a [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement].
Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.
- NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] specified does not exist or is not associated with the given account.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the updated [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resource, otherwise returns an error.
Parameters | |
---|---|
Name | Description |
request | CreateCustomerRepricingConfigRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<CustomerRepricingConfig> | A Task containing the RPC response. |
CreateEntitlement(CreateEntitlementRequest, CallSettings)
public override Operation<Entitlement, OperationMetadata> CreateEntitlement(CreateEntitlementRequest request, CallSettings callSettings = null)
Creates an entitlement for a customer.
Possible error codes:
- PERMISSION_DENIED: The customer doesn't belong to the reseller.
- INVALID_ARGUMENT:
- Required request parameters are missing or invalid.
- There is already a customer entitlement for a SKU from the same product family.
- INVALID_VALUE: Make sure the OfferId is valid. If it is, contact Google Channel support for further troubleshooting.
- NOT_FOUND: The customer or offer resource was not found.
- ALREADY_EXISTS:
- The SKU was already purchased for the customer.
- The customer's primary email already exists. Retry after changing the customer's primary contact email.
- CONDITION_NOT_MET or FAILED_PRECONDITION:
- The domain required for purchasing a SKU has not been verified.
- A pre-requisite SKU required to purchase an Add-On SKU is missing. For example, Google Workspace Business Starter is required to purchase Vault or Drive.
- (Developer accounts only) Reseller and resold domain must meet the following naming requirements:
- Domain names must start with goog-test.
- Domain names must include the reseller domain.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
Parameters | |
---|---|
Name | Description |
request | CreateEntitlementRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Entitlement, OperationMetadata> | The RPC response. |
CreateEntitlementAsync(CreateEntitlementRequest, CallSettings)
public override async Task<Operation<Entitlement, OperationMetadata>> CreateEntitlementAsync(CreateEntitlementRequest request, CallSettings callSettings = null)
Creates an entitlement for a customer.
Possible error codes:
- PERMISSION_DENIED: The customer doesn't belong to the reseller.
- INVALID_ARGUMENT:
- Required request parameters are missing or invalid.
- There is already a customer entitlement for a SKU from the same product family.
- INVALID_VALUE: Make sure the OfferId is valid. If it is, contact Google Channel support for further troubleshooting.
- NOT_FOUND: The customer or offer resource was not found.
- ALREADY_EXISTS:
- The SKU was already purchased for the customer.
- The customer's primary email already exists. Retry after changing the customer's primary contact email.
- CONDITION_NOT_MET or FAILED_PRECONDITION:
- The domain required for purchasing a SKU has not been verified.
- A pre-requisite SKU required to purchase an Add-On SKU is missing. For example, Google Workspace Business Starter is required to purchase Vault or Drive.
- (Developer accounts only) Reseller and resold domain must meet the following naming requirements:
- Domain names must start with goog-test.
- Domain names must include the reseller domain.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
Parameters | |
---|---|
Name | Description |
request | CreateEntitlementRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Entitlement, OperationMetadata>> | A Task containing the RPC response. |
DeleteChannelPartnerRepricingConfig(DeleteChannelPartnerRepricingConfigRequest, CallSettings)
public override void DeleteChannelPartnerRepricingConfig(DeleteChannelPartnerRepricingConfigRequest request, CallSettings callSettings = null)
Deletes the given [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] permanently. You can only delete configs if their [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is set to a date after the current month.
Possible error codes:
- PERMISSION_DENIED: The account making the request does not own this customer.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- FAILED_PRECONDITION: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] is active or in the past.
- NOT_FOUND: No [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] found for the name in the request.
Parameters | |
---|---|
Name | Description |
request | DeleteChannelPartnerRepricingConfigRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
DeleteChannelPartnerRepricingConfigAsync(DeleteChannelPartnerRepricingConfigRequest, CallSettings)
public override Task DeleteChannelPartnerRepricingConfigAsync(DeleteChannelPartnerRepricingConfigRequest request, CallSettings callSettings = null)
Deletes the given [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] permanently. You can only delete configs if their [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is set to a date after the current month.
Possible error codes:
- PERMISSION_DENIED: The account making the request does not own this customer.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- FAILED_PRECONDITION: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] is active or in the past.
- NOT_FOUND: No [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] found for the name in the request.
Parameters | |
---|---|
Name | Description |
request | DeleteChannelPartnerRepricingConfigRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
DeleteCustomer(DeleteCustomerRequest, CallSettings)
public override void DeleteCustomer(DeleteCustomerRequest request, CallSettings callSettings = null)
Deletes the given [Customer][google.cloud.channel.v1.Customer] permanently.
Possible error codes:
- PERMISSION_DENIED: The account making the request does not own this customer.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- FAILED_PRECONDITION: The customer has existing entitlements.
- NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name in the request.
Parameters | |
---|---|
Name | Description |
request | DeleteCustomerRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
DeleteCustomerAsync(DeleteCustomerRequest, CallSettings)
public override Task DeleteCustomerAsync(DeleteCustomerRequest request, CallSettings callSettings = null)
Deletes the given [Customer][google.cloud.channel.v1.Customer] permanently.
Possible error codes:
- PERMISSION_DENIED: The account making the request does not own this customer.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- FAILED_PRECONDITION: The customer has existing entitlements.
- NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name in the request.
Parameters | |
---|---|
Name | Description |
request | DeleteCustomerRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
DeleteCustomerRepricingConfig(DeleteCustomerRepricingConfigRequest, CallSettings)
public override void DeleteCustomerRepricingConfig(DeleteCustomerRepricingConfigRequest request, CallSettings callSettings = null)
Deletes the given [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] permanently. You can only delete configs if their [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is set to a date after the current month.
Possible error codes:
- PERMISSION_DENIED: The account making the request does not own this customer.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- FAILED_PRECONDITION: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] is active or in the past.
- NOT_FOUND: No [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] found for the name in the request.
Parameters | |
---|---|
Name | Description |
request | DeleteCustomerRepricingConfigRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
DeleteCustomerRepricingConfigAsync(DeleteCustomerRepricingConfigRequest, CallSettings)
public override Task DeleteCustomerRepricingConfigAsync(DeleteCustomerRepricingConfigRequest request, CallSettings callSettings = null)
Deletes the given [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] permanently. You can only delete configs if their [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is set to a date after the current month.
Possible error codes:
- PERMISSION_DENIED: The account making the request does not own this customer.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- FAILED_PRECONDITION: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] is active or in the past.
- NOT_FOUND: No [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] found for the name in the request.
Parameters | |
---|---|
Name | Description |
request | DeleteCustomerRepricingConfigRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task | A Task containing the RPC response. |
GetChannelPartnerLink(GetChannelPartnerLinkRequest, CallSettings)
public override ChannelPartnerLink GetChannelPartnerLink(GetChannelPartnerLinkRequest request, CallSettings callSettings = null)
Returns the requested [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource. You must be a distributor to call this method.
Possible error codes:
- PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- NOT_FOUND: ChannelPartnerLink resource not found because of an invalid channel partner link name.
Return value: The [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource.
Parameters | |
---|---|
Name | Description |
request | GetChannelPartnerLinkRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
ChannelPartnerLink | The RPC response. |
GetChannelPartnerLinkAsync(GetChannelPartnerLinkRequest, CallSettings)
public override Task<ChannelPartnerLink> GetChannelPartnerLinkAsync(GetChannelPartnerLinkRequest request, CallSettings callSettings = null)
Returns the requested [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource. You must be a distributor to call this method.
Possible error codes:
- PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- NOT_FOUND: ChannelPartnerLink resource not found because of an invalid channel partner link name.
Return value: The [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource.
Parameters | |
---|---|
Name | Description |
request | GetChannelPartnerLinkRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<ChannelPartnerLink> | A Task containing the RPC response. |
GetChannelPartnerRepricingConfig(GetChannelPartnerRepricingConfigRequest, CallSettings)
public override ChannelPartnerRepricingConfig GetChannelPartnerRepricingConfig(GetChannelPartnerRepricingConfigRequest request, CallSettings callSettings = null)
Gets information about how a Distributor modifies their bill before sending it to a ChannelPartner.
Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] was not found.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resource, otherwise returns an error.
Parameters | |
---|---|
Name | Description |
request | GetChannelPartnerRepricingConfigRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
ChannelPartnerRepricingConfig | The RPC response. |
GetChannelPartnerRepricingConfigAsync(GetChannelPartnerRepricingConfigRequest, CallSettings)
public override Task<ChannelPartnerRepricingConfig> GetChannelPartnerRepricingConfigAsync(GetChannelPartnerRepricingConfigRequest request, CallSettings callSettings = null)
Gets information about how a Distributor modifies their bill before sending it to a ChannelPartner.
Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] was not found.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resource, otherwise returns an error.
Parameters | |
---|---|
Name | Description |
request | GetChannelPartnerRepricingConfigRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<ChannelPartnerRepricingConfig> | A Task containing the RPC response. |
GetCustomer(GetCustomerRequest, CallSettings)
public override Customer GetCustomer(GetCustomerRequest request, CallSettings callSettings = null)
Returns the requested [Customer][google.cloud.channel.v1.Customer] resource.
Possible error codes:
- PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- NOT_FOUND: The customer resource doesn't exist. Usually the result of an invalid name parameter.
Return value: The [Customer][google.cloud.channel.v1.Customer] resource.
Parameters | |
---|---|
Name | Description |
request | GetCustomerRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Customer | The RPC response. |
GetCustomerAsync(GetCustomerRequest, CallSettings)
public override Task<Customer> GetCustomerAsync(GetCustomerRequest request, CallSettings callSettings = null)
Returns the requested [Customer][google.cloud.channel.v1.Customer] resource.
Possible error codes:
- PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- NOT_FOUND: The customer resource doesn't exist. Usually the result of an invalid name parameter.
Return value: The [Customer][google.cloud.channel.v1.Customer] resource.
Parameters | |
---|---|
Name | Description |
request | GetCustomerRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Customer> | A Task containing the RPC response. |
GetCustomerRepricingConfig(GetCustomerRepricingConfigRequest, CallSettings)
public override CustomerRepricingConfig GetCustomerRepricingConfig(GetCustomerRepricingConfigRequest request, CallSettings callSettings = null)
Gets information about how a Reseller modifies their bill before sending it to a Customer.
Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] was not found.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resource, otherwise returns an error.
Parameters | |
---|---|
Name | Description |
request | GetCustomerRepricingConfigRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
CustomerRepricingConfig | The RPC response. |
GetCustomerRepricingConfigAsync(GetCustomerRepricingConfigRequest, CallSettings)
public override Task<CustomerRepricingConfig> GetCustomerRepricingConfigAsync(GetCustomerRepricingConfigRequest request, CallSettings callSettings = null)
Gets information about how a Reseller modifies their bill before sending it to a Customer.
Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] was not found.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resource, otherwise returns an error.
Parameters | |
---|---|
Name | Description |
request | GetCustomerRepricingConfigRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<CustomerRepricingConfig> | A Task containing the RPC response. |
GetEntitlement(GetEntitlementRequest, CallSettings)
public override Entitlement GetEntitlement(GetEntitlementRequest request, CallSettings callSettings = null)
Returns the requested [Entitlement][google.cloud.channel.v1.Entitlement] resource.
Possible error codes:
- PERMISSION_DENIED: The customer doesn't belong to the reseller.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- NOT_FOUND: The customer entitlement was not found.
Return value: The requested [Entitlement][google.cloud.channel.v1.Entitlement] resource.
Parameters | |
---|---|
Name | Description |
request | GetEntitlementRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Entitlement | The RPC response. |
GetEntitlementAsync(GetEntitlementRequest, CallSettings)
public override Task<Entitlement> GetEntitlementAsync(GetEntitlementRequest request, CallSettings callSettings = null)
Returns the requested [Entitlement][google.cloud.channel.v1.Entitlement] resource.
Possible error codes:
- PERMISSION_DENIED: The customer doesn't belong to the reseller.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- NOT_FOUND: The customer entitlement was not found.
Return value: The requested [Entitlement][google.cloud.channel.v1.Entitlement] resource.
Parameters | |
---|---|
Name | Description |
request | GetEntitlementRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Entitlement> | A Task containing the RPC response. |
ImportCustomer(ImportCustomerRequest, CallSettings)
public override Customer ImportCustomer(ImportCustomerRequest request, CallSettings callSettings = null)
Imports a [Customer][google.cloud.channel.v1.Customer] from the Cloud Identity associated with the provided Cloud Identity ID or domain before a TransferEntitlements call. If a linked Customer already exists and overwrite_if_exists is true, it will update that Customer's data.
Possible error codes:
- PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
- NOT_FOUND: Cloud Identity doesn't exist or was deleted.
- INVALID_ARGUMENT: Required parameters are missing, or the auth_token is expired or invalid.
- ALREADY_EXISTS: A customer already exists and has conflicting critical fields. Requires an overwrite.
Return value: The [Customer][google.cloud.channel.v1.Customer].
Parameters | |
---|---|
Name | Description |
request | ImportCustomerRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Customer | The RPC response. |
ImportCustomerAsync(ImportCustomerRequest, CallSettings)
public override Task<Customer> ImportCustomerAsync(ImportCustomerRequest request, CallSettings callSettings = null)
Imports a [Customer][google.cloud.channel.v1.Customer] from the Cloud Identity associated with the provided Cloud Identity ID or domain before a TransferEntitlements call. If a linked Customer already exists and overwrite_if_exists is true, it will update that Customer's data.
Possible error codes:
- PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
- NOT_FOUND: Cloud Identity doesn't exist or was deleted.
- INVALID_ARGUMENT: Required parameters are missing, or the auth_token is expired or invalid.
- ALREADY_EXISTS: A customer already exists and has conflicting critical fields. Requires an overwrite.
Return value: The [Customer][google.cloud.channel.v1.Customer].
Parameters | |
---|---|
Name | Description |
request | ImportCustomerRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Customer> | A Task containing the RPC response. |
ListChannelPartnerLinks(ListChannelPartnerLinksRequest, CallSettings)
public override PagedEnumerable<ListChannelPartnerLinksResponse, ChannelPartnerLink> ListChannelPartnerLinks(ListChannelPartnerLinksRequest request, CallSettings callSettings = null)
List [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]s belonging to a distributor. You must be a distributor to call this method.
Possible error codes:
- PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
Return value: The list of the distributor account's [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resources.
Parameters | |
---|---|
Name | Description |
request | ListChannelPartnerLinksRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerable<ListChannelPartnerLinksResponse, ChannelPartnerLink> | A pageable sequence of ChannelPartnerLink resources. |
ListChannelPartnerLinksAsync(ListChannelPartnerLinksRequest, CallSettings)
public override PagedAsyncEnumerable<ListChannelPartnerLinksResponse, ChannelPartnerLink> ListChannelPartnerLinksAsync(ListChannelPartnerLinksRequest request, CallSettings callSettings = null)
List [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]s belonging to a distributor. You must be a distributor to call this method.
Possible error codes:
- PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
Return value: The list of the distributor account's [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resources.
Parameters | |
---|---|
Name | Description |
request | ListChannelPartnerLinksRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerable<ListChannelPartnerLinksResponse, ChannelPartnerLink> | A pageable asynchronous sequence of ChannelPartnerLink resources. |
ListChannelPartnerRepricingConfigs(ListChannelPartnerRepricingConfigsRequest, CallSettings)
public override PagedEnumerable<ListChannelPartnerRepricingConfigsResponse, ChannelPartnerRepricingConfig> ListChannelPartnerRepricingConfigs(ListChannelPartnerRepricingConfigsRequest request, CallSettings callSettings = null)
Lists information about how a Reseller modifies their bill before sending it to a ChannelPartner.
Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] specified does not exist or is not associated with the given account.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resources. The data for each resource is displayed in the ascending order of:
- channel partner ID
- [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month]
- [ChannelPartnerRepricingConfig.update_time][google.cloud.channel.v1.ChannelPartnerRepricingConfig.update_time]
If unsuccessful, returns an error.
Parameters | |
---|---|
Name | Description |
request | ListChannelPartnerRepricingConfigsRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerable<ListChannelPartnerRepricingConfigsResponse, ChannelPartnerRepricingConfig> | A pageable sequence of ChannelPartnerRepricingConfig resources. |
ListChannelPartnerRepricingConfigsAsync(ListChannelPartnerRepricingConfigsRequest, CallSettings)
public override PagedAsyncEnumerable<ListChannelPartnerRepricingConfigsResponse, ChannelPartnerRepricingConfig> ListChannelPartnerRepricingConfigsAsync(ListChannelPartnerRepricingConfigsRequest request, CallSettings callSettings = null)
Lists information about how a Reseller modifies their bill before sending it to a ChannelPartner.
Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] specified does not exist or is not associated with the given account.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resources. The data for each resource is displayed in the ascending order of:
- channel partner ID
- [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month]
- [ChannelPartnerRepricingConfig.update_time][google.cloud.channel.v1.ChannelPartnerRepricingConfig.update_time]
If unsuccessful, returns an error.
Parameters | |
---|---|
Name | Description |
request | ListChannelPartnerRepricingConfigsRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerable<ListChannelPartnerRepricingConfigsResponse, ChannelPartnerRepricingConfig> | A pageable asynchronous sequence of ChannelPartnerRepricingConfig resources. |
ListCustomerRepricingConfigs(ListCustomerRepricingConfigsRequest, CallSettings)
public override PagedEnumerable<ListCustomerRepricingConfigsResponse, CustomerRepricingConfig> ListCustomerRepricingConfigs(ListCustomerRepricingConfigsRequest request, CallSettings callSettings = null)
Lists information about how a Reseller modifies their bill before sending it to a Customer.
Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] specified does not exist or is not associated with the given account.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resources. The data for each resource is displayed in the ascending order of:
- customer ID
- [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement]
- [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month]
- [CustomerRepricingConfig.update_time][google.cloud.channel.v1.CustomerRepricingConfig.update_time]
If unsuccessful, returns an error.
Parameters | |
---|---|
Name | Description |
request | ListCustomerRepricingConfigsRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerable<ListCustomerRepricingConfigsResponse, CustomerRepricingConfig> | A pageable sequence of CustomerRepricingConfig resources. |
ListCustomerRepricingConfigsAsync(ListCustomerRepricingConfigsRequest, CallSettings)
public override PagedAsyncEnumerable<ListCustomerRepricingConfigsResponse, CustomerRepricingConfig> ListCustomerRepricingConfigsAsync(ListCustomerRepricingConfigsRequest request, CallSettings callSettings = null)
Lists information about how a Reseller modifies their bill before sending it to a Customer.
Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] specified does not exist or is not associated with the given account.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resources. The data for each resource is displayed in the ascending order of:
- customer ID
- [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement]
- [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month]
- [CustomerRepricingConfig.update_time][google.cloud.channel.v1.CustomerRepricingConfig.update_time]
If unsuccessful, returns an error.
Parameters | |
---|---|
Name | Description |
request | ListCustomerRepricingConfigsRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerable<ListCustomerRepricingConfigsResponse, CustomerRepricingConfig> | A pageable asynchronous sequence of CustomerRepricingConfig resources. |
ListCustomers(ListCustomersRequest, CallSettings)
public override PagedEnumerable<ListCustomersResponse, Customer> ListCustomers(ListCustomersRequest request, CallSettings callSettings = null)
List [Customer][google.cloud.channel.v1.Customer]s.
Possible error codes:
- PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
Return value: List of [Customer][google.cloud.channel.v1.Customer]s, or an empty list if there are no customers.
Parameters | |
---|---|
Name | Description |
request | ListCustomersRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerable<ListCustomersResponse, Customer> | A pageable sequence of Customer resources. |
ListCustomersAsync(ListCustomersRequest, CallSettings)
public override PagedAsyncEnumerable<ListCustomersResponse, Customer> ListCustomersAsync(ListCustomersRequest request, CallSettings callSettings = null)
List [Customer][google.cloud.channel.v1.Customer]s.
Possible error codes:
- PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
Return value: List of [Customer][google.cloud.channel.v1.Customer]s, or an empty list if there are no customers.
Parameters | |
---|---|
Name | Description |
request | ListCustomersRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerable<ListCustomersResponse, Customer> | A pageable asynchronous sequence of Customer resources. |
ListEntitlements(ListEntitlementsRequest, CallSettings)
public override PagedEnumerable<ListEntitlementsResponse, Entitlement> ListEntitlements(ListEntitlementsRequest request, CallSettings callSettings = null)
Lists [Entitlement][google.cloud.channel.v1.Entitlement]s belonging to a customer.
Possible error codes:
- PERMISSION_DENIED: The customer doesn't belong to the reseller.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
Return value: A list of the customer's [Entitlement][google.cloud.channel.v1.Entitlement]s.
Parameters | |
---|---|
Name | Description |
request | ListEntitlementsRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerable<ListEntitlementsResponse, Entitlement> | A pageable sequence of Entitlement resources. |
ListEntitlementsAsync(ListEntitlementsRequest, CallSettings)
public override PagedAsyncEnumerable<ListEntitlementsResponse, Entitlement> ListEntitlementsAsync(ListEntitlementsRequest request, CallSettings callSettings = null)
Lists [Entitlement][google.cloud.channel.v1.Entitlement]s belonging to a customer.
Possible error codes:
- PERMISSION_DENIED: The customer doesn't belong to the reseller.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
Return value: A list of the customer's [Entitlement][google.cloud.channel.v1.Entitlement]s.
Parameters | |
---|---|
Name | Description |
request | ListEntitlementsRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerable<ListEntitlementsResponse, Entitlement> | A pageable asynchronous sequence of Entitlement resources. |
ListOffers(ListOffersRequest, CallSettings)
public override PagedEnumerable<ListOffersResponse, Offer> ListOffers(ListOffersRequest request, CallSettings callSettings = null)
Lists the Offers the reseller can sell.
Possible error codes:
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
Parameters | |
---|---|
Name | Description |
request | ListOffersRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerable<ListOffersResponse, Offer> | A pageable sequence of Offer resources. |
ListOffersAsync(ListOffersRequest, CallSettings)
public override PagedAsyncEnumerable<ListOffersResponse, Offer> ListOffersAsync(ListOffersRequest request, CallSettings callSettings = null)
Lists the Offers the reseller can sell.
Possible error codes:
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
Parameters | |
---|---|
Name | Description |
request | ListOffersRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerable<ListOffersResponse, Offer> | A pageable asynchronous sequence of Offer resources. |
ListProducts(ListProductsRequest, CallSettings)
public override PagedEnumerable<ListProductsResponse, Product> ListProducts(ListProductsRequest request, CallSettings callSettings = null)
Lists the Products the reseller is authorized to sell.
Possible error codes:
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
Parameters | |
---|---|
Name | Description |
request | ListProductsRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerable<ListProductsResponse, Product> | A pageable sequence of Product resources. |
ListProductsAsync(ListProductsRequest, CallSettings)
public override PagedAsyncEnumerable<ListProductsResponse, Product> ListProductsAsync(ListProductsRequest request, CallSettings callSettings = null)
Lists the Products the reseller is authorized to sell.
Possible error codes:
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
Parameters | |
---|---|
Name | Description |
request | ListProductsRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerable<ListProductsResponse, Product> | A pageable asynchronous sequence of Product resources. |
ListPurchasableOffers(ListPurchasableOffersRequest, CallSettings)
public override PagedEnumerable<ListPurchasableOffersResponse, PurchasableOffer> ListPurchasableOffers(ListPurchasableOffersRequest request, CallSettings callSettings = null)
Lists the following:
- Offers that you can purchase for a customer.
- Offers that you can change for an entitlement.
Possible error codes:
- PERMISSION_DENIED: The customer doesn't belong to the reseller
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
Parameters | |
---|---|
Name | Description |
request | ListPurchasableOffersRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerable<ListPurchasableOffersResponse, PurchasableOffer> | A pageable sequence of PurchasableOffer resources. |
ListPurchasableOffersAsync(ListPurchasableOffersRequest, CallSettings)
public override PagedAsyncEnumerable<ListPurchasableOffersResponse, PurchasableOffer> ListPurchasableOffersAsync(ListPurchasableOffersRequest request, CallSettings callSettings = null)
Lists the following:
- Offers that you can purchase for a customer.
- Offers that you can change for an entitlement.
Possible error codes:
- PERMISSION_DENIED: The customer doesn't belong to the reseller
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
Parameters | |
---|---|
Name | Description |
request | ListPurchasableOffersRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerable<ListPurchasableOffersResponse, PurchasableOffer> | A pageable asynchronous sequence of PurchasableOffer resources. |
ListPurchasableSkus(ListPurchasableSkusRequest, CallSettings)
public override PagedEnumerable<ListPurchasableSkusResponse, PurchasableSku> ListPurchasableSkus(ListPurchasableSkusRequest request, CallSettings callSettings = null)
Lists the following:
- SKUs that you can purchase for a customer
- SKUs that you can upgrade or downgrade for an entitlement.
Possible error codes:
- PERMISSION_DENIED: The customer doesn't belong to the reseller.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
Parameters | |
---|---|
Name | Description |
request | ListPurchasableSkusRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerable<ListPurchasableSkusResponse, PurchasableSku> | A pageable sequence of PurchasableSku resources. |
ListPurchasableSkusAsync(ListPurchasableSkusRequest, CallSettings)
public override PagedAsyncEnumerable<ListPurchasableSkusResponse, PurchasableSku> ListPurchasableSkusAsync(ListPurchasableSkusRequest request, CallSettings callSettings = null)
Lists the following:
- SKUs that you can purchase for a customer
- SKUs that you can upgrade or downgrade for an entitlement.
Possible error codes:
- PERMISSION_DENIED: The customer doesn't belong to the reseller.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
Parameters | |
---|---|
Name | Description |
request | ListPurchasableSkusRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerable<ListPurchasableSkusResponse, PurchasableSku> | A pageable asynchronous sequence of PurchasableSku resources. |
ListSkus(ListSkusRequest, CallSettings)
public override PagedEnumerable<ListSkusResponse, Sku> ListSkus(ListSkusRequest request, CallSettings callSettings = null)
Lists the SKUs for a product the reseller is authorized to sell.
Possible error codes:
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
Parameters | |
---|---|
Name | Description |
request | ListSkusRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerable<ListSkusResponse, Sku> | A pageable sequence of Sku resources. |
ListSkusAsync(ListSkusRequest, CallSettings)
public override PagedAsyncEnumerable<ListSkusResponse, Sku> ListSkusAsync(ListSkusRequest request, CallSettings callSettings = null)
Lists the SKUs for a product the reseller is authorized to sell.
Possible error codes:
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
Parameters | |
---|---|
Name | Description |
request | ListSkusRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerable<ListSkusResponse, Sku> | A pageable asynchronous sequence of Sku resources. |
ListSubscribers(ListSubscribersRequest, CallSettings)
public override PagedEnumerable<ListSubscribersResponse, string> ListSubscribers(ListSubscribersRequest request, CallSettings callSettings = null)
Lists service accounts with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account.
Possible error codes:
- PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- NOT_FOUND: The topic resource doesn't exist.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: A list of service email addresses.
Parameters | |
---|---|
Name | Description |
request | ListSubscribersRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerable<ListSubscribersResponse, String> | A pageable sequence of String resources. |
ListSubscribersAsync(ListSubscribersRequest, CallSettings)
public override PagedAsyncEnumerable<ListSubscribersResponse, string> ListSubscribersAsync(ListSubscribersRequest request, CallSettings callSettings = null)
Lists service accounts with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account.
Possible error codes:
- PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- NOT_FOUND: The topic resource doesn't exist.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: A list of service email addresses.
Parameters | |
---|---|
Name | Description |
request | ListSubscribersRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerable<ListSubscribersResponse, String> | A pageable asynchronous sequence of String resources. |
ListTransferableOffers(ListTransferableOffersRequest, CallSettings)
public override PagedEnumerable<ListTransferableOffersResponse, TransferableOffer> ListTransferableOffers(ListTransferableOffersRequest request, CallSettings callSettings = null)
List [TransferableOffer][google.cloud.channel.v1.TransferableOffer]s of a customer based on Cloud Identity ID or Customer Name in the request.
Use this method when a reseller gets the entitlement information of an unowned customer. The reseller should provide the customer's Cloud Identity ID or Customer Name.
Possible error codes:
- PERMISSION_DENIED:
- The customer doesn't belong to the reseller and has no auth token.
- The customer provided incorrect reseller information when generating auth token.
- The reseller account making the request is different from the reseller account in the query.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
Return value: List of [TransferableOffer][google.cloud.channel.v1.TransferableOffer] for the given customer and SKU.
Parameters | |
---|---|
Name | Description |
request | ListTransferableOffersRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerable<ListTransferableOffersResponse, TransferableOffer> | A pageable sequence of TransferableOffer resources. |
ListTransferableOffersAsync(ListTransferableOffersRequest, CallSettings)
public override PagedAsyncEnumerable<ListTransferableOffersResponse, TransferableOffer> ListTransferableOffersAsync(ListTransferableOffersRequest request, CallSettings callSettings = null)
List [TransferableOffer][google.cloud.channel.v1.TransferableOffer]s of a customer based on Cloud Identity ID or Customer Name in the request.
Use this method when a reseller gets the entitlement information of an unowned customer. The reseller should provide the customer's Cloud Identity ID or Customer Name.
Possible error codes:
- PERMISSION_DENIED:
- The customer doesn't belong to the reseller and has no auth token.
- The customer provided incorrect reseller information when generating auth token.
- The reseller account making the request is different from the reseller account in the query.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
Return value: List of [TransferableOffer][google.cloud.channel.v1.TransferableOffer] for the given customer and SKU.
Parameters | |
---|---|
Name | Description |
request | ListTransferableOffersRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerable<ListTransferableOffersResponse, TransferableOffer> | A pageable asynchronous sequence of TransferableOffer resources. |
ListTransferableSkus(ListTransferableSkusRequest, CallSettings)
public override PagedEnumerable<ListTransferableSkusResponse, TransferableSku> ListTransferableSkus(ListTransferableSkusRequest request, CallSettings callSettings = null)
List [TransferableSku][google.cloud.channel.v1.TransferableSku]s of a customer based on the Cloud Identity ID or Customer Name in the request.
Use this method to list the entitlements information of an unowned customer. You should provide the customer's Cloud Identity ID or Customer Name.
Possible error codes:
- PERMISSION_DENIED:
- The customer doesn't belong to the reseller and has no auth token.
- The supplied auth token is invalid.
- The reseller account making the request is different from the reseller account in the query.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
Return value: A list of the customer's [TransferableSku][google.cloud.channel.v1.TransferableSku].
Parameters | |
---|---|
Name | Description |
request | ListTransferableSkusRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerable<ListTransferableSkusResponse, TransferableSku> | A pageable sequence of TransferableSku resources. |
ListTransferableSkusAsync(ListTransferableSkusRequest, CallSettings)
public override PagedAsyncEnumerable<ListTransferableSkusResponse, TransferableSku> ListTransferableSkusAsync(ListTransferableSkusRequest request, CallSettings callSettings = null)
List [TransferableSku][google.cloud.channel.v1.TransferableSku]s of a customer based on the Cloud Identity ID or Customer Name in the request.
Use this method to list the entitlements information of an unowned customer. You should provide the customer's Cloud Identity ID or Customer Name.
Possible error codes:
- PERMISSION_DENIED:
- The customer doesn't belong to the reseller and has no auth token.
- The supplied auth token is invalid.
- The reseller account making the request is different from the reseller account in the query.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
Return value: A list of the customer's [TransferableSku][google.cloud.channel.v1.TransferableSku].
Parameters | |
---|---|
Name | Description |
request | ListTransferableSkusRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerable<ListTransferableSkusResponse, TransferableSku> | A pageable asynchronous sequence of TransferableSku resources. |
LookupOffer(LookupOfferRequest, CallSettings)
public override Offer LookupOffer(LookupOfferRequest request, CallSettings callSettings = null)
Returns the requested [Offer][google.cloud.channel.v1.Offer] resource.
Possible error codes:
- PERMISSION_DENIED: The entitlement doesn't belong to the reseller.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- NOT_FOUND: Entitlement or offer was not found.
Return value: The [Offer][google.cloud.channel.v1.Offer] resource.
Parameters | |
---|---|
Name | Description |
request | LookupOfferRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Offer | The RPC response. |
LookupOfferAsync(LookupOfferRequest, CallSettings)
public override Task<Offer> LookupOfferAsync(LookupOfferRequest request, CallSettings callSettings = null)
Returns the requested [Offer][google.cloud.channel.v1.Offer] resource.
Possible error codes:
- PERMISSION_DENIED: The entitlement doesn't belong to the reseller.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- NOT_FOUND: Entitlement or offer was not found.
Return value: The [Offer][google.cloud.channel.v1.Offer] resource.
Parameters | |
---|---|
Name | Description |
request | LookupOfferRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Offer> | A Task containing the RPC response. |
ProvisionCloudIdentity(ProvisionCloudIdentityRequest, CallSettings)
public override Operation<Customer, OperationMetadata> ProvisionCloudIdentity(ProvisionCloudIdentityRequest request, CallSettings callSettings = null)
Creates a Cloud Identity for the given customer using the customer's information, or the information provided here.
Possible error codes:
- PERMISSION_DENIED: The customer doesn't belong to the reseller.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- NOT_FOUND: The customer was not found.
- ALREADY_EXISTS: The customer's primary email already exists. Retry after changing the customer's primary contact email.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata contains an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
Parameters | |
---|---|
Name | Description |
request | ProvisionCloudIdentityRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Customer, OperationMetadata> | The RPC response. |
ProvisionCloudIdentityAsync(ProvisionCloudIdentityRequest, CallSettings)
public override async Task<Operation<Customer, OperationMetadata>> ProvisionCloudIdentityAsync(ProvisionCloudIdentityRequest request, CallSettings callSettings = null)
Creates a Cloud Identity for the given customer using the customer's information, or the information provided here.
Possible error codes:
- PERMISSION_DENIED: The customer doesn't belong to the reseller.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- NOT_FOUND: The customer was not found.
- ALREADY_EXISTS: The customer's primary email already exists. Retry after changing the customer's primary contact email.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata contains an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
Parameters | |
---|---|
Name | Description |
request | ProvisionCloudIdentityRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Customer, OperationMetadata>> | A Task containing the RPC response. |
RegisterSubscriber(RegisterSubscriberRequest, CallSettings)
public override RegisterSubscriberResponse RegisterSubscriber(RegisterSubscriberRequest request, CallSettings callSettings = null)
Registers a service account with subscriber privileges on the Cloud Pub/Sub topic for this Channel Services account. After you create a subscriber, you get the events through [SubscriberEvent][google.cloud.channel.v1.SubscriberEvent]
Possible error codes:
- PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The topic name with the registered service email address.
Parameters | |
---|---|
Name | Description |
request | RegisterSubscriberRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
RegisterSubscriberResponse | The RPC response. |
RegisterSubscriberAsync(RegisterSubscriberRequest, CallSettings)
public override Task<RegisterSubscriberResponse> RegisterSubscriberAsync(RegisterSubscriberRequest request, CallSettings callSettings = null)
Registers a service account with subscriber privileges on the Cloud Pub/Sub topic for this Channel Services account. After you create a subscriber, you get the events through [SubscriberEvent][google.cloud.channel.v1.SubscriberEvent]
Possible error codes:
- PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The topic name with the registered service email address.
Parameters | |
---|---|
Name | Description |
request | RegisterSubscriberRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<RegisterSubscriberResponse> | A Task containing the RPC response. |
StartPaidService(StartPaidServiceRequest, CallSettings)
public override Operation<Entitlement, OperationMetadata> StartPaidService(StartPaidServiceRequest request, CallSettings callSettings = null)
Starts paid service for a trial entitlement.
Starts paid service for a trial entitlement immediately. This method is only applicable if a plan is set up for a trial entitlement but has some trial days remaining.
Possible error codes:
- PERMISSION_DENIED: The customer doesn't belong to the reseller.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- NOT_FOUND: Entitlement resource not found.
- FAILED_PRECONDITION/NOT_IN_TRIAL: This method only works for entitlement on trial plans.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
Parameters | |
---|---|
Name | Description |
request | StartPaidServiceRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Entitlement, OperationMetadata> | The RPC response. |
StartPaidServiceAsync(StartPaidServiceRequest, CallSettings)
public override async Task<Operation<Entitlement, OperationMetadata>> StartPaidServiceAsync(StartPaidServiceRequest request, CallSettings callSettings = null)
Starts paid service for a trial entitlement.
Starts paid service for a trial entitlement immediately. This method is only applicable if a plan is set up for a trial entitlement but has some trial days remaining.
Possible error codes:
- PERMISSION_DENIED: The customer doesn't belong to the reseller.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- NOT_FOUND: Entitlement resource not found.
- FAILED_PRECONDITION/NOT_IN_TRIAL: This method only works for entitlement on trial plans.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
Parameters | |
---|---|
Name | Description |
request | StartPaidServiceRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Entitlement, OperationMetadata>> | A Task containing the RPC response. |
SuspendEntitlement(SuspendEntitlementRequest, CallSettings)
public override Operation<Entitlement, OperationMetadata> SuspendEntitlement(SuspendEntitlementRequest request, CallSettings callSettings = null)
Suspends a previously fulfilled entitlement.
An entitlement suspension is a long-running operation.
Possible error codes:
- PERMISSION_DENIED: The customer doesn't belong to the reseller.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- NOT_FOUND: Entitlement resource not found.
- NOT_ACTIVE: Entitlement is not active.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
Parameters | |
---|---|
Name | Description |
request | SuspendEntitlementRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Entitlement, OperationMetadata> | The RPC response. |
SuspendEntitlementAsync(SuspendEntitlementRequest, CallSettings)
public override async Task<Operation<Entitlement, OperationMetadata>> SuspendEntitlementAsync(SuspendEntitlementRequest request, CallSettings callSettings = null)
Suspends a previously fulfilled entitlement.
An entitlement suspension is a long-running operation.
Possible error codes:
- PERMISSION_DENIED: The customer doesn't belong to the reseller.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- NOT_FOUND: Entitlement resource not found.
- NOT_ACTIVE: Entitlement is not active.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
Parameters | |
---|---|
Name | Description |
request | SuspendEntitlementRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Entitlement, OperationMetadata>> | A Task containing the RPC response. |
TransferEntitlements(TransferEntitlementsRequest, CallSettings)
public override Operation<TransferEntitlementsResponse, OperationMetadata> TransferEntitlements(TransferEntitlementsRequest request, CallSettings callSettings = null)
Transfers customer entitlements to new reseller.
Possible error codes:
- PERMISSION_DENIED: The customer doesn't belong to the reseller.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- NOT_FOUND: The customer or offer resource was not found.
- ALREADY_EXISTS: The SKU was already transferred for the customer.
- CONDITION_NOT_MET or FAILED_PRECONDITION:
- The SKU requires domain verification to transfer, but the domain is not verified.
- An Add-On SKU (example, Vault or Drive) is missing the pre-requisite SKU (example, G Suite Basic).
- (Developer accounts only) Reseller and resold domain must meet the following naming requirements:
- Domain names must start with goog-test.
- Domain names must include the reseller domain.
- Specify all transferring entitlements.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
Parameters | |
---|---|
Name | Description |
request | TransferEntitlementsRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<TransferEntitlementsResponse, OperationMetadata> | The RPC response. |
TransferEntitlementsAsync(TransferEntitlementsRequest, CallSettings)
public override async Task<Operation<TransferEntitlementsResponse, OperationMetadata>> TransferEntitlementsAsync(TransferEntitlementsRequest request, CallSettings callSettings = null)
Transfers customer entitlements to new reseller.
Possible error codes:
- PERMISSION_DENIED: The customer doesn't belong to the reseller.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- NOT_FOUND: The customer or offer resource was not found.
- ALREADY_EXISTS: The SKU was already transferred for the customer.
- CONDITION_NOT_MET or FAILED_PRECONDITION:
- The SKU requires domain verification to transfer, but the domain is not verified.
- An Add-On SKU (example, Vault or Drive) is missing the pre-requisite SKU (example, G Suite Basic).
- (Developer accounts only) Reseller and resold domain must meet the following naming requirements:
- Domain names must start with goog-test.
- Domain names must include the reseller domain.
- Specify all transferring entitlements.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
Parameters | |
---|---|
Name | Description |
request | TransferEntitlementsRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<TransferEntitlementsResponse, OperationMetadata>> | A Task containing the RPC response. |
TransferEntitlementsToGoogle(TransferEntitlementsToGoogleRequest, CallSettings)
public override Operation<Empty, OperationMetadata> TransferEntitlementsToGoogle(TransferEntitlementsToGoogleRequest request, CallSettings callSettings = null)
Transfers customer entitlements from their current reseller to Google.
Possible error codes:
- PERMISSION_DENIED: The customer doesn't belong to the reseller.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- NOT_FOUND: The customer or offer resource was not found.
- ALREADY_EXISTS: The SKU was already transferred for the customer.
- CONDITION_NOT_MET or FAILED_PRECONDITION:
- The SKU requires domain verification to transfer, but the domain is not verified.
- An Add-On SKU (example, Vault or Drive) is missing the pre-requisite SKU (example, G Suite Basic).
- (Developer accounts only) Reseller and resold domain must meet the following naming requirements:
- Domain names must start with goog-test.
- Domain names must include the reseller domain.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The response will contain google.protobuf.Empty on success. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
Parameters | |
---|---|
Name | Description |
request | TransferEntitlementsToGoogleRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Empty, OperationMetadata> | The RPC response. |
TransferEntitlementsToGoogleAsync(TransferEntitlementsToGoogleRequest, CallSettings)
public override async Task<Operation<Empty, OperationMetadata>> TransferEntitlementsToGoogleAsync(TransferEntitlementsToGoogleRequest request, CallSettings callSettings = null)
Transfers customer entitlements from their current reseller to Google.
Possible error codes:
- PERMISSION_DENIED: The customer doesn't belong to the reseller.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- NOT_FOUND: The customer or offer resource was not found.
- ALREADY_EXISTS: The SKU was already transferred for the customer.
- CONDITION_NOT_MET or FAILED_PRECONDITION:
- The SKU requires domain verification to transfer, but the domain is not verified.
- An Add-On SKU (example, Vault or Drive) is missing the pre-requisite SKU (example, G Suite Basic).
- (Developer accounts only) Reseller and resold domain must meet the following naming requirements:
- Domain names must start with goog-test.
- Domain names must include the reseller domain.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The response will contain google.protobuf.Empty on success. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
Parameters | |
---|---|
Name | Description |
request | TransferEntitlementsToGoogleRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Empty, OperationMetadata>> | A Task containing the RPC response. |
UnregisterSubscriber(UnregisterSubscriberRequest, CallSettings)
public override UnregisterSubscriberResponse UnregisterSubscriber(UnregisterSubscriberRequest request, CallSettings callSettings = null)
Unregisters a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. If there are no service accounts left with subscriber privileges, this deletes the topic. You can call ListSubscribers to check for these accounts.
Possible error codes:
- PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- NOT_FOUND: The topic resource doesn't exist.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The topic name that unregistered the service email address. Returns a success response if the service email address wasn't registered with the topic.
Parameters | |
---|---|
Name | Description |
request | UnregisterSubscriberRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
UnregisterSubscriberResponse | The RPC response. |
UnregisterSubscriberAsync(UnregisterSubscriberRequest, CallSettings)
public override Task<UnregisterSubscriberResponse> UnregisterSubscriberAsync(UnregisterSubscriberRequest request, CallSettings callSettings = null)
Unregisters a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. If there are no service accounts left with subscriber privileges, this deletes the topic. You can call ListSubscribers to check for these accounts.
Possible error codes:
- PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- NOT_FOUND: The topic resource doesn't exist.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The topic name that unregistered the service email address. Returns a success response if the service email address wasn't registered with the topic.
Parameters | |
---|---|
Name | Description |
request | UnregisterSubscriberRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<UnregisterSubscriberResponse> | A Task containing the RPC response. |
UpdateChannelPartnerLink(UpdateChannelPartnerLinkRequest, CallSettings)
public override ChannelPartnerLink UpdateChannelPartnerLink(UpdateChannelPartnerLinkRequest request, CallSettings callSettings = null)
Updates a channel partner link. Distributors call this method to change a link's status. For example, to suspend a partner link. You must be a distributor to call this method.
Possible error codes:
- PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
- INVALID_ARGUMENT:
- Required request parameters are missing or invalid.
- Link state cannot change from invited to active or suspended.
- Cannot send reseller_cloud_identity_id, invite_url, or name in update mask.
- NOT_FOUND: ChannelPartnerLink resource not found.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The updated [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource.
Parameters | |
---|---|
Name | Description |
request | UpdateChannelPartnerLinkRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
ChannelPartnerLink | The RPC response. |
UpdateChannelPartnerLinkAsync(UpdateChannelPartnerLinkRequest, CallSettings)
public override Task<ChannelPartnerLink> UpdateChannelPartnerLinkAsync(UpdateChannelPartnerLinkRequest request, CallSettings callSettings = null)
Updates a channel partner link. Distributors call this method to change a link's status. For example, to suspend a partner link. You must be a distributor to call this method.
Possible error codes:
- PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
- INVALID_ARGUMENT:
- Required request parameters are missing or invalid.
- Link state cannot change from invited to active or suspended.
- Cannot send reseller_cloud_identity_id, invite_url, or name in update mask.
- NOT_FOUND: ChannelPartnerLink resource not found.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The updated [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource.
Parameters | |
---|---|
Name | Description |
request | UpdateChannelPartnerLinkRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<ChannelPartnerLink> | A Task containing the RPC response. |
UpdateChannelPartnerRepricingConfig(UpdateChannelPartnerRepricingConfigRequest, CallSettings)
public override ChannelPartnerRepricingConfig UpdateChannelPartnerRepricingConfig(UpdateChannelPartnerRepricingConfigRequest request, CallSettings callSettings = null)
Updates a ChannelPartnerRepricingConfig. Call this method to set modifications for a specific ChannelPartner's bill. This method overwrites the existing CustomerRepricingConfig.
You can only update configs if the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is a future month. To make changes to configs for the current month, use [CreateChannelPartnerRepricingConfig][google.cloud.channel.v1.CloudChannelService.CreateChannelPartnerRepricingConfig], taking note of its restrictions. You cannot update the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].
When updating a config in the future:
- This config must already exist.
Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.
- NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] specified does not exist or is not associated with the given account.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the updated [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resource, otherwise returns an error.
Parameters | |
---|---|
Name | Description |
request | UpdateChannelPartnerRepricingConfigRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
ChannelPartnerRepricingConfig | The RPC response. |
UpdateChannelPartnerRepricingConfigAsync(UpdateChannelPartnerRepricingConfigRequest, CallSettings)
public override Task<ChannelPartnerRepricingConfig> UpdateChannelPartnerRepricingConfigAsync(UpdateChannelPartnerRepricingConfigRequest request, CallSettings callSettings = null)
Updates a ChannelPartnerRepricingConfig. Call this method to set modifications for a specific ChannelPartner's bill. This method overwrites the existing CustomerRepricingConfig.
You can only update configs if the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is a future month. To make changes to configs for the current month, use [CreateChannelPartnerRepricingConfig][google.cloud.channel.v1.CloudChannelService.CreateChannelPartnerRepricingConfig], taking note of its restrictions. You cannot update the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].
When updating a config in the future:
- This config must already exist.
Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.
- NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] specified does not exist or is not associated with the given account.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the updated [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resource, otherwise returns an error.
Parameters | |
---|---|
Name | Description |
request | UpdateChannelPartnerRepricingConfigRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<ChannelPartnerRepricingConfig> | A Task containing the RPC response. |
UpdateCustomer(UpdateCustomerRequest, CallSettings)
public override Customer UpdateCustomer(UpdateCustomerRequest request, CallSettings callSettings = null)
Updates an existing [Customer][google.cloud.channel.v1.Customer] resource for the reseller or distributor.
Possible error codes:
- PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name in the request.
Return value: The updated [Customer][google.cloud.channel.v1.Customer] resource.
Parameters | |
---|---|
Name | Description |
request | UpdateCustomerRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Customer | The RPC response. |
UpdateCustomerAsync(UpdateCustomerRequest, CallSettings)
public override Task<Customer> UpdateCustomerAsync(UpdateCustomerRequest request, CallSettings callSettings = null)
Updates an existing [Customer][google.cloud.channel.v1.Customer] resource for the reseller or distributor.
Possible error codes:
- PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- NOT_FOUND: No [Customer][google.cloud.channel.v1.Customer] resource found for the name in the request.
Return value: The updated [Customer][google.cloud.channel.v1.Customer] resource.
Parameters | |
---|---|
Name | Description |
request | UpdateCustomerRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Customer> | A Task containing the RPC response. |
UpdateCustomerRepricingConfig(UpdateCustomerRepricingConfigRequest, CallSettings)
public override CustomerRepricingConfig UpdateCustomerRepricingConfig(UpdateCustomerRepricingConfigRequest request, CallSettings callSettings = null)
Updates a CustomerRepricingConfig. Call this method to set modifications for a specific customer's bill. This method overwrites the existing CustomerRepricingConfig.
You can only update configs if the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is a future month. To make changes to configs for the current month, use [CreateCustomerRepricingConfig][google.cloud.channel.v1.CloudChannelService.CreateCustomerRepricingConfig], taking note of its restrictions. You cannot update the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].
When updating a config in the future:
- This config must already exist.
Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.
- NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] specified does not exist or is not associated with the given account.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the updated [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resource, otherwise returns an error.
Parameters | |
---|---|
Name | Description |
request | UpdateCustomerRepricingConfigRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
CustomerRepricingConfig | The RPC response. |
UpdateCustomerRepricingConfigAsync(UpdateCustomerRepricingConfigRequest, CallSettings)
public override Task<CustomerRepricingConfig> UpdateCustomerRepricingConfigAsync(UpdateCustomerRepricingConfigRequest request, CallSettings callSettings = null)
Updates a CustomerRepricingConfig. Call this method to set modifications for a specific customer's bill. This method overwrites the existing CustomerRepricingConfig.
You can only update configs if the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is a future month. To make changes to configs for the current month, use [CreateCustomerRepricingConfig][google.cloud.channel.v1.CloudChannelService.CreateCustomerRepricingConfig], taking note of its restrictions. You cannot update the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].
When updating a config in the future:
- This config must already exist.
Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.
- NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] specified does not exist or is not associated with the given account.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the updated [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resource, otherwise returns an error.
Parameters | |
---|---|
Name | Description |
request | UpdateCustomerRepricingConfigRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<CustomerRepricingConfig> | A Task containing the RPC response. |