Class AccountsResource.CustomersResource.EntitlementsResource

The "entitlements" collection of methods.

Inheritance

object

AccountsResource.CustomersResource.EntitlementsResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Cloudchannel.v1

Assembly: Google.Apis.Cloudchannel.v1.dll

Syntax

public class AccountsResource.CustomersResource.EntitlementsResource

Constructors

EntitlementsResource(IClientService)

Constructs a new resource.

Declaration

public EntitlementsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

Activate(GoogleCloudChannelV1ActivateEntitlementRequest, string)

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.

Declaration

public virtual AccountsResource.CustomersResource.EntitlementsResource.ActivateRequest Activate(GoogleCloudChannelV1ActivateEntitlementRequest body, string name)

Parameters

Type	Name	Description
GoogleCloudChannelV1ActivateEntitlementRequest	body	The body of the request.
string	name	Required. The resource name of the entitlement to activate. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}

Returns

Type	Description
AccountsResource.CustomersResource.EntitlementsResource.ActivateRequest

Cancel(GoogleCloudChannelV1CancelEntitlementRequest, string)

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.

Declaration

public virtual AccountsResource.CustomersResource.EntitlementsResource.CancelRequest Cancel(GoogleCloudChannelV1CancelEntitlementRequest body, string name)

Parameters

Type	Name	Description
GoogleCloudChannelV1CancelEntitlementRequest	body	The body of the request.
string	name	Required. The resource name of the entitlement to cancel. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}

Returns

Type	Description
AccountsResource.CustomersResource.EntitlementsResource.CancelRequest

ChangeOffer(GoogleCloudChannelV1ChangeOfferRequest, string)

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.

Declaration

public virtual AccountsResource.CustomersResource.EntitlementsResource.ChangeOfferRequest ChangeOffer(GoogleCloudChannelV1ChangeOfferRequest body, string name)

Parameters

Type	Name	Description
GoogleCloudChannelV1ChangeOfferRequest	body	The body of the request.
string	name	Required. The resource name of the entitlement to update. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}

Returns

Type	Description
AccountsResource.CustomersResource.EntitlementsResource.ChangeOfferRequest

ChangeParameters(GoogleCloudChannelV1ChangeParametersRequest, string)

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.

Declaration

public virtual AccountsResource.CustomersResource.EntitlementsResource.ChangeParametersRequest ChangeParameters(GoogleCloudChannelV1ChangeParametersRequest body, string name)

Parameters

Type	Name	Description
GoogleCloudChannelV1ChangeParametersRequest	body	The body of the request.
string	name	Required. The name of the entitlement to update. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}

Returns

Type	Description
AccountsResource.CustomersResource.EntitlementsResource.ChangeParametersRequest

ChangeRenewalSettings(GoogleCloudChannelV1ChangeRenewalSettingsRequest, string)

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.

Declaration

public virtual AccountsResource.CustomersResource.EntitlementsResource.ChangeRenewalSettingsRequest ChangeRenewalSettings(GoogleCloudChannelV1ChangeRenewalSettingsRequest body, string name)

Parameters

Type	Name	Description
GoogleCloudChannelV1ChangeRenewalSettingsRequest	body	The body of the request.
string	name	Required. The name of the entitlement to update. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}

Returns

Type	Description
AccountsResource.CustomersResource.EntitlementsResource.ChangeRenewalSettingsRequest

Create(GoogleCloudChannelV1CreateEntitlementRequest, string)

Creates an entitlement for a customer. Possible error codes: * PERMISSION_DENIED: * The customer doesn't belong to the reseller. * The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265 * 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.

Declaration

public virtual AccountsResource.CustomersResource.EntitlementsResource.CreateRequest Create(GoogleCloudChannelV1CreateEntitlementRequest body, string parent)

Parameters

Type	Name	Description
GoogleCloudChannelV1CreateEntitlementRequest	body	The body of the request.
string	parent	Required. The resource name of the reseller's customer account in which to create the entitlement. Parent uses the format: accounts/{account_id}/customers/{customer_id}

Returns

Type	Description
AccountsResource.CustomersResource.EntitlementsResource.CreateRequest

Get(string)

Returns the requested 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 resource.

Declaration

public virtual AccountsResource.CustomersResource.EntitlementsResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	Required. The resource name of the entitlement to retrieve. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}

Returns

Type	Description
AccountsResource.CustomersResource.EntitlementsResource.GetRequest

List(string)

Lists Entitlements 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 Entitlements.

Declaration

public virtual AccountsResource.CustomersResource.EntitlementsResource.ListRequest List(string parent)

Parameters

Type	Name	Description
string	parent	Required. The resource name of the reseller's customer account to list entitlements for. Parent uses the format: accounts/{account_id}/customers/{customer_id}

Returns

Type	Description
AccountsResource.CustomersResource.EntitlementsResource.ListRequest

ListEntitlementChanges(string)

List entitlement history. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different. * INVALID_ARGUMENT: Missing or invalid required fields in the request. * NOT_FOUND: The parent resource doesn't exist. Usually the result of an invalid name parameter. * INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact CloudChannel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support. Return value: List of EntitlementChanges.

Declaration

public virtual AccountsResource.CustomersResource.EntitlementsResource.ListEntitlementChangesRequest ListEntitlementChanges(string parent)

Parameters

Type	Name	Description
string	parent	Required. The resource name of the entitlement for which to list entitlement changes. The - wildcard may be used to match entitlements across a customer. Formats: * accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id} * accounts/{account_id}/customers/{customer_id}/entitlements/-

Returns

Type	Description
AccountsResource.CustomersResource.EntitlementsResource.ListEntitlementChangesRequest

LookupOffer(string)

Returns the requested 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 resource.

Declaration

public virtual AccountsResource.CustomersResource.EntitlementsResource.LookupOfferRequest LookupOffer(string entitlement)

Parameters

Type	Name	Description
string	entitlement	Required. The resource name of the entitlement to retrieve the Offer. Entitlement uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}

Returns

Type	Description
AccountsResource.CustomersResource.EntitlementsResource.LookupOfferRequest

StartPaidService(GoogleCloudChannelV1StartPaidServiceRequest, string)

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.

Declaration

public virtual AccountsResource.CustomersResource.EntitlementsResource.StartPaidServiceRequest StartPaidService(GoogleCloudChannelV1StartPaidServiceRequest body, string name)

Parameters

Type	Name	Description
GoogleCloudChannelV1StartPaidServiceRequest	body	The body of the request.
string	name	Required. The name of the entitlement to start a paid service for. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}

Returns

Type	Description
AccountsResource.CustomersResource.EntitlementsResource.StartPaidServiceRequest

Suspend(GoogleCloudChannelV1SuspendEntitlementRequest, string)

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.

Declaration

public virtual AccountsResource.CustomersResource.EntitlementsResource.SuspendRequest Suspend(GoogleCloudChannelV1SuspendEntitlementRequest body, string name)

Parameters

Type	Name	Description
GoogleCloudChannelV1SuspendEntitlementRequest	body	The body of the request.
string	name	Required. The resource name of the entitlement to suspend. Name uses the format: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}

Returns

Type	Description
AccountsResource.CustomersResource.EntitlementsResource.SuspendRequest