• Home
• com.google.apis
• google-api-services-cloudchannel
• v1-rev20241109-2.0.0
• source code
• Cloudchannel.Accounts.Customers.Entitlements.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.cloudchannel.v1.Cloudchannel.Accounts.Customers.Entitlements.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.cloudchannel.v1
Class Cloudchannel.Accounts.Customers.Entitlements



java.lang.Object


com.google.api.services.cloudchannel.v1.Cloudchannel.Accounts.Customers.Entitlements







Enclosing class:
Cloudchannel.Accounts.Customers




public class Cloudchannel.Accounts.Customers.Entitlements
extends Object
The "entitlements" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
Cloudchannel.Accounts.Customers.Entitlements.Activate 


class 
Cloudchannel.Accounts.Customers.Entitlements.Cancel 


class 
Cloudchannel.Accounts.Customers.Entitlements.ChangeOffer 


class 
Cloudchannel.Accounts.Customers.Entitlements.ChangeParameters 


class 
Cloudchannel.Accounts.Customers.Entitlements.ChangeRenewalSettings 


class 
Cloudchannel.Accounts.Customers.Entitlements.Create 


class 
Cloudchannel.Accounts.Customers.Entitlements.Get 


class 
Cloudchannel.Accounts.Customers.Entitlements.List 


class 
Cloudchannel.Accounts.Customers.Entitlements.ListEntitlementChanges 


class 
Cloudchannel.Accounts.Customers.Entitlements.LookupOffer 


class 
Cloudchannel.Accounts.Customers.Entitlements.StartPaidService 


class 
Cloudchannel.Accounts.Customers.Entitlements.Suspend 









Constructor Summary

Constructors 

Constructor and Description


Entitlements() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


Cloudchannel.Accounts.Customers.Entitlements.Activate
activate(String name,
        GoogleCloudChannelV1ActivateEntitlementRequest content)
Activates a previously suspended entitlement.



Cloudchannel.Accounts.Customers.Entitlements.Cancel
cancel(String name,
      GoogleCloudChannelV1CancelEntitlementRequest content)
Cancels a previously fulfilled entitlement.



Cloudchannel.Accounts.Customers.Entitlements.ChangeOffer
changeOffer(String name,
           GoogleCloudChannelV1ChangeOfferRequest content)
Updates the Offer for an existing customer entitlement.



Cloudchannel.Accounts.Customers.Entitlements.ChangeParameters
changeParameters(String name,
                GoogleCloudChannelV1ChangeParametersRequest content)
Change parameters of the entitlement.



Cloudchannel.Accounts.Customers.Entitlements.ChangeRenewalSettings
changeRenewalSettings(String name,
                     GoogleCloudChannelV1ChangeRenewalSettingsRequest content)
Updates the renewal settings for an existing customer entitlement.



Cloudchannel.Accounts.Customers.Entitlements.Create
create(String parent,
      GoogleCloudChannelV1CreateEntitlementRequest content)
Creates an entitlement for a customer.



Cloudchannel.Accounts.Customers.Entitlements.Get
get(String name)
Returns the requested Entitlement resource.



Cloudchannel.Accounts.Customers.Entitlements.List
list(String parent)
Lists Entitlements belonging to a customer.



Cloudchannel.Accounts.Customers.Entitlements.ListEntitlementChanges
listEntitlementChanges(String parent)
List entitlement history.



Cloudchannel.Accounts.Customers.Entitlements.LookupOffer
lookupOffer(String entitlement)
Returns the requested Offer resource.



Cloudchannel.Accounts.Customers.Entitlements.StartPaidService
startPaidService(String name,
                GoogleCloudChannelV1StartPaidServiceRequest content)
Starts paid service for a trial entitlement.



Cloudchannel.Accounts.Customers.Entitlements.Suspend
suspend(String name,
       GoogleCloudChannelV1SuspendEntitlementRequest content)
Suspends a previously fulfilled entitlement.







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





Entitlements
public Entitlements()









Method Detail





activate
public Cloudchannel.Accounts.Customers.Entitlements.Activate activate(String name,
                                                                      GoogleCloudChannelV1ActivateEntitlementRequest content)
                                                               throws IOException
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.

 Create a request for the method "entitlements.activate".

 This request holds the parameters needed by the cloudchannel server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The resource name of the entitlement to activate. Name uses the format:
        accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
content - the GoogleCloudChannelV1ActivateEntitlementRequest
Returns:
the request
Throws:
IOException








cancel
public Cloudchannel.Accounts.Customers.Entitlements.Cancel cancel(String name,
                                                                  GoogleCloudChannelV1CancelEntitlementRequest content)
                                                           throws IOException
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.

 Create a request for the method "entitlements.cancel".

 This request holds the parameters needed by the cloudchannel server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The resource name of the entitlement to cancel. Name uses the format:
        accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
content - the GoogleCloudChannelV1CancelEntitlementRequest
Returns:
the request
Throws:
IOException








changeOffer
public Cloudchannel.Accounts.Customers.Entitlements.ChangeOffer changeOffer(String name,
                                                                            GoogleCloudChannelV1ChangeOfferRequest content)
                                                                     throws IOException
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.

 Create a request for the method "entitlements.changeOffer".

 This request holds the parameters needed by the cloudchannel server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The resource name of the entitlement to update. Name uses the format:
        accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
content - the GoogleCloudChannelV1ChangeOfferRequest
Returns:
the request
Throws:
IOException








changeParameters
public Cloudchannel.Accounts.Customers.Entitlements.ChangeParameters changeParameters(String name,
                                                                                      GoogleCloudChannelV1ChangeParametersRequest content)
                                                                               throws IOException
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.

 Create a request for the method "entitlements.changeParameters".

 This request holds the parameters needed by the cloudchannel server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The name of the entitlement to update. Name uses the format:
        accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
content - the GoogleCloudChannelV1ChangeParametersRequest
Returns:
the request
Throws:
IOException








changeRenewalSettings
public Cloudchannel.Accounts.Customers.Entitlements.ChangeRenewalSettings changeRenewalSettings(String name,
                                                                                                GoogleCloudChannelV1ChangeRenewalSettingsRequest content)
                                                                                         throws IOException
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.

 Create a request for the method "entitlements.changeRenewalSettings".

 This request holds the parameters needed by the cloudchannel server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
name - Required. The name of the entitlement to update. Name uses the format:
        accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
content - the GoogleCloudChannelV1ChangeRenewalSettingsRequest
Returns:
the request
Throws:
IOException








create
public Cloudchannel.Accounts.Customers.Entitlements.Create create(String parent,
                                                                  GoogleCloudChannelV1CreateEntitlementRequest content)
                                                           throws IOException
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.

 Create a request for the method "entitlements.create".

 This request holds the parameters needed by the cloudchannel server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
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}
content - the GoogleCloudChannelV1CreateEntitlementRequest
Returns:
the request
Throws:
IOException








get
public Cloudchannel.Accounts.Customers.Entitlements.Get get(String name)
                                                     throws IOException
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.

 Create a request for the method "entitlements.get".

 This request holds the parameters needed by the cloudchannel server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The resource name of the entitlement to retrieve. Name uses the format:
        accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
Returns:
the request
Throws:
IOException








list
public Cloudchannel.Accounts.Customers.Entitlements.List list(String parent)
                                                       throws IOException
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.

 Create a request for the method "entitlements.list".

 This request holds the parameters needed by the cloudchannel server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
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:
the request
Throws:
IOException








listEntitlementChanges
public Cloudchannel.Accounts.Customers.Entitlements.ListEntitlementChanges listEntitlementChanges(String parent)
                                                                                           throws IOException
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.

 Create a request for the method "entitlements.listEntitlementChanges".

 This request holds the parameters needed by the cloudchannel server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
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:
the request
Throws:
IOException








lookupOffer
public Cloudchannel.Accounts.Customers.Entitlements.LookupOffer lookupOffer(String entitlement)
                                                                     throws IOException
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.

 Create a request for the method "entitlements.lookupOffer".

 This request holds the parameters needed by the cloudchannel server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
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:
the request
Throws:
IOException








startPaidService
public Cloudchannel.Accounts.Customers.Entitlements.StartPaidService startPaidService(String name,
                                                                                      GoogleCloudChannelV1StartPaidServiceRequest content)
                                                                               throws IOException
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.

 Create a request for the method "entitlements.startPaidService".

 This request holds the parameters needed by the cloudchannel server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
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}
content - the GoogleCloudChannelV1StartPaidServiceRequest
Returns:
the request
Throws:
IOException








suspend
public Cloudchannel.Accounts.Customers.Entitlements.Suspend suspend(String name,
                                                                    GoogleCloudChannelV1SuspendEntitlementRequest content)
                                                             throws IOException
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.

 Create a request for the method "entitlements.suspend".

 This request holds the parameters needed by the cloudchannel server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
name - Required. The resource name of the entitlement to suspend. Name uses the format:
        accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}
content - the GoogleCloudChannelV1SuspendEntitlementRequest
Returns:
the request
Throws:
IOException














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.