• Home
• com.google.apis
• google-api-services-cloudchannel
• v1-rev20241109-2.0.0
• source code
• Cloudchannel.Accounts.Customers.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.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



java.lang.Object


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







Enclosing class:
Cloudchannel.Accounts




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











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
Cloudchannel.Accounts.Customers.CloudchannelImport 


class 
Cloudchannel.Accounts.Customers.Create 


class 
Cloudchannel.Accounts.Customers.CustomerRepricingConfigs
The "customerRepricingConfigs" collection of methods.



class 
Cloudchannel.Accounts.Customers.Delete 


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



class 
Cloudchannel.Accounts.Customers.Get 


class 
Cloudchannel.Accounts.Customers.List 


class 
Cloudchannel.Accounts.Customers.ListPurchasableOffers 


class 
Cloudchannel.Accounts.Customers.ListPurchasableSkus 


class 
Cloudchannel.Accounts.Customers.Patch 


class 
Cloudchannel.Accounts.Customers.ProvisionCloudIdentity 


class 
Cloudchannel.Accounts.Customers.QueryEligibleBillingAccounts 


class 
Cloudchannel.Accounts.Customers.TransferEntitlements 


class 
Cloudchannel.Accounts.Customers.TransferEntitlementsToGoogle 









Constructor Summary

Constructors 

Constructor and Description


Customers() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


Cloudchannel.Accounts.Customers.CloudchannelImport
cloudchannelImport(String parent,
                  GoogleCloudChannelV1ImportCustomerRequest content)
Imports a Customer from the Cloud Identity associated with the provided Cloud Identity ID or
 domain before a TransferEntitlements call.



Cloudchannel.Accounts.Customers.Create
create(String parent,
      GoogleCloudChannelV1Customer content)
Creates a new Customer resource under the reseller or distributor account.



Cloudchannel.Accounts.Customers.CustomerRepricingConfigs
customerRepricingConfigs()
An accessor for creating requests from the CustomerRepricingConfigs collection.



Cloudchannel.Accounts.Customers.Delete
delete(String name)
Deletes the given Customer permanently.



Cloudchannel.Accounts.Customers.Entitlements
entitlements()
An accessor for creating requests from the Entitlements collection.



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



Cloudchannel.Accounts.Customers.List
list(String parent)
List Customers.



Cloudchannel.Accounts.Customers.ListPurchasableOffers
listPurchasableOffers(String customer)
Lists the following: * Offers that you can purchase for a customer.



Cloudchannel.Accounts.Customers.ListPurchasableSkus
listPurchasableSkus(String customer)
Lists the following: * SKUs that you can purchase for a customer * SKUs that you can upgrade or
 downgrade for an entitlement.



Cloudchannel.Accounts.Customers.Patch
patch(String name,
     GoogleCloudChannelV1Customer content)
Updates an existing Customer resource for the reseller or distributor.



Cloudchannel.Accounts.Customers.ProvisionCloudIdentity
provisionCloudIdentity(String customer,
                      GoogleCloudChannelV1ProvisionCloudIdentityRequest content)
Creates a Cloud Identity for the given customer using the customer's information, or the
 information provided here.



Cloudchannel.Accounts.Customers.QueryEligibleBillingAccounts
queryEligibleBillingAccounts(String customer)
Lists the billing accounts that are eligible to purchase particular SKUs for a given customer.



Cloudchannel.Accounts.Customers.TransferEntitlements
transferEntitlements(String parent,
                    GoogleCloudChannelV1TransferEntitlementsRequest content)
Transfers customer entitlements to new reseller.



Cloudchannel.Accounts.Customers.TransferEntitlementsToGoogle
transferEntitlementsToGoogle(String parent,
                            GoogleCloudChannelV1TransferEntitlementsToGoogleRequest content)
Transfers customer entitlements from their current reseller to Google.







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














Constructor Detail





Customers
public Customers()









Method Detail





create
public Cloudchannel.Accounts.Customers.Create create(String parent,
                                                     GoogleCloudChannelV1Customer content)
                                              throws IOException
Creates a new 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. * You are not authorized to create a customer. See
 https://support.google.com/channelservices/answer/9759265 * 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 resource.

 Create a request for the method "customers.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 reseller account in which to create the customer. Parent uses the
        format: accounts/{account_id}
content - the GoogleCloudChannelV1Customer
Returns:
the request
Throws:
IOException








delete
public Cloudchannel.Accounts.Customers.Delete delete(String name)
                                              throws IOException
Deletes the given 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 resource found for the name in the request.

 Create a request for the method "customers.delete".

 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 customer to delete.
Returns:
the request
Throws:
IOException








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

 Create a request for the method "customers.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 customer to retrieve. Name uses the format:
        accounts/{account_id}/customers/{customer_id}
Returns:
the request
Throws:
IOException








cloudchannelImport
public Cloudchannel.Accounts.Customers.CloudchannelImport cloudchannelImport(String parent,
                                                                             GoogleCloudChannelV1ImportCustomerRequest content)
                                                                      throws IOException
Imports a 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. * You are not authorized to import the customer. See
 https://support.google.com/channelservices/answer/9759265 * 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.

 Create a request for the method "customers.import".

 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 account. Parent takes the format:
        accounts/{account_id} or accounts/{account_id}/channelPartnerLinks/{channel_partner_id}
content - the GoogleCloudChannelV1ImportCustomerRequest
Returns:
the request
Throws:
IOException








list
public Cloudchannel.Accounts.Customers.List list(String parent)
                                          throws IOException
List Customers. 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 Customers, or an empty list if
 there are no customers.

 Create a request for the method "customers.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 account to list customers from. Parent uses the format:
        accounts/{account_id}.
Returns:
the request
Throws:
IOException








listPurchasableOffers
public Cloudchannel.Accounts.Customers.ListPurchasableOffers listPurchasableOffers(String customer)
                                                                            throws IOException
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 * 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.

 Create a request for the method "customers.listPurchasableOffers".

 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:
customer - Required. The resource name of the customer to list Offers for. Format:
        accounts/{account_id}/customers/{customer_id}.
Returns:
the request
Throws:
IOException








listPurchasableSkus
public Cloudchannel.Accounts.Customers.ListPurchasableSkus listPurchasableSkus(String customer)
                                                                        throws IOException
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.

 Create a request for the method "customers.listPurchasableSkus".

 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:
customer - Required. The resource name of the customer to list SKUs for. Format:
        accounts/{account_id}/customers/{customer_id}.
Returns:
the request
Throws:
IOException








patch
public Cloudchannel.Accounts.Customers.Patch patch(String name,
                                                   GoogleCloudChannelV1Customer content)
                                            throws IOException
Updates an existing 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 resource found for the name in the request. Return value: The updated
 Customer resource.

 Create a request for the method "customers.patch".

 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 - Output only. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id}
content - the GoogleCloudChannelV1Customer
Returns:
the request
Throws:
IOException








provisionCloudIdentity
public Cloudchannel.Accounts.Customers.ProvisionCloudIdentity provisionCloudIdentity(String customer,
                                                                                     GoogleCloudChannelV1ProvisionCloudIdentityRequest content)
                                                                              throws IOException
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. * You are not authorized to provision cloud identity id. See
 https://support.google.com/channelservices/answer/9759265 * 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.

 Create a request for the method "customers.provisionCloudIdentity".

 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:
customer - Required. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id}
content - the GoogleCloudChannelV1ProvisionCloudIdentityRequest
Returns:
the request
Throws:
IOException








queryEligibleBillingAccounts
public Cloudchannel.Accounts.Customers.QueryEligibleBillingAccounts queryEligibleBillingAccounts(String customer)
                                                                                          throws IOException
Lists the billing accounts that are eligible to purchase particular SKUs for a given 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: Based on the
 provided list of SKUs, returns a list of SKU groups that must be purchased using the same billing
 account and the billing accounts eligible to purchase each SKU group.

 Create a request for the method "customers.queryEligibleBillingAccounts".

 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:
customer - Required. The resource name of the customer to list eligible billing accounts for. Format:
        accounts/{account_id}/customers/{customer_id}.
Returns:
the request
Throws:
IOException








transferEntitlements
public Cloudchannel.Accounts.Customers.TransferEntitlements transferEntitlements(String parent,
                                                                                 GoogleCloudChannelV1TransferEntitlementsRequest content)
                                                                          throws IOException
Transfers customer entitlements to new reseller. 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. * 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.

 Create a request for the method "customers.transferEntitlements".

 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 that will receive transferred
        entitlements. Parent uses the format: accounts/{account_id}/customers/{customer_id}
content - the GoogleCloudChannelV1TransferEntitlementsRequest
Returns:
the request
Throws:
IOException








transferEntitlementsToGoogle
public Cloudchannel.Accounts.Customers.TransferEntitlementsToGoogle transferEntitlementsToGoogle(String parent,
                                                                                                 GoogleCloudChannelV1TransferEntitlementsToGoogleRequest content)
                                                                                          throws IOException
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.

 Create a request for the method "customers.transferEntitlementsToGoogle".

 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 where the entitlements transfer from.
        Parent uses the format: accounts/{account_id}/customers/{customer_id}
content - the GoogleCloudChannelV1TransferEntitlementsToGoogleRequest
Returns:
the request
Throws:
IOException








customerRepricingConfigs
public Cloudchannel.Accounts.Customers.CustomerRepricingConfigs customerRepricingConfigs()
An accessor for creating requests from the CustomerRepricingConfigs collection.

 
The typical use is:
 
    Cloudchannel cloudchannel = new Cloudchannel(...);
    Cloudchannel.CustomerRepricingConfigs.List request = cloudchannel.customerRepricingConfigs().list(parameters ...)
 

Returns:
the resource collection








entitlements
public Cloudchannel.Accounts.Customers.Entitlements entitlements()
An accessor for creating requests from the Entitlements collection.

 
The typical use is:
 
    Cloudchannel cloudchannel = new Cloudchannel(...);
    Cloudchannel.Entitlements.List request = cloudchannel.entitlements().list(parameters ...)
 

Returns:
the resource collection














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.