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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-cloudchannel Show documentation

There is a newer version: v1-rev20241202-2.0.0

Show newest version







Cloudchannel.Accounts (Cloud Channel API v1-rev20241109-2.0.0)











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



java.lang.Object


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







Enclosing class:
Cloudchannel




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











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
Cloudchannel.Accounts.ChannelPartnerLinks
The "channelPartnerLinks" collection of methods.



class 
Cloudchannel.Accounts.CheckCloudIdentityAccountsExist 


class 
Cloudchannel.Accounts.Customers
The "customers" collection of methods.



class 
Cloudchannel.Accounts.ListSubscribers 


class 
Cloudchannel.Accounts.ListTransferableOffers 


class 
Cloudchannel.Accounts.ListTransferableSkus 


class 
Cloudchannel.Accounts.Offers
The "offers" collection of methods.



class 
Cloudchannel.Accounts.Register 


class 
Cloudchannel.Accounts.ReportJobs
The "reportJobs" collection of methods.



class 
Cloudchannel.Accounts.Reports
The "reports" collection of methods.



class 
Cloudchannel.Accounts.SkuGroups
The "skuGroups" collection of methods.



class 
Cloudchannel.Accounts.Unregister 









Constructor Summary

Constructors 

Constructor and Description


Accounts() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


Cloudchannel.Accounts.ChannelPartnerLinks
channelPartnerLinks()
An accessor for creating requests from the ChannelPartnerLinks collection.



Cloudchannel.Accounts.CheckCloudIdentityAccountsExist
checkCloudIdentityAccountsExist(String parent,
                               GoogleCloudChannelV1CheckCloudIdentityAccountsExistRequest content)
Confirms the existence of Cloud Identity accounts based on the domain and if the Cloud Identity
 accounts are owned by the reseller.



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



Cloudchannel.Accounts.ListSubscribers
listSubscribers(String account)
Lists service accounts with subscriber privileges on the Pub/Sub topic created for this Channel
 Services account or integrator.



Cloudchannel.Accounts.ListTransferableOffers
listTransferableOffers(String parent,
                      GoogleCloudChannelV1ListTransferableOffersRequest content)
List TransferableOffers of a customer based on Cloud Identity ID or Customer Name in the request.



Cloudchannel.Accounts.ListTransferableSkus
listTransferableSkus(String parent,
                    GoogleCloudChannelV1ListTransferableSkusRequest content)
List TransferableSkus of a customer based on the Cloud Identity ID or Customer Name in the
 request.



Cloudchannel.Accounts.Offers
offers()
An accessor for creating requests from the Offers collection.



Cloudchannel.Accounts.Register
register(String account,
        GoogleCloudChannelV1RegisterSubscriberRequest content)
Registers a service account with subscriber privileges on the Pub/Sub topic for this Channel
 Services account or integrator.



Cloudchannel.Accounts.ReportJobs
reportJobs()
An accessor for creating requests from the ReportJobs collection.



Cloudchannel.Accounts.Reports
reports()
An accessor for creating requests from the Reports collection.



Cloudchannel.Accounts.SkuGroups
skuGroups()
An accessor for creating requests from the SkuGroups collection.



Cloudchannel.Accounts.Unregister
unregister(String account,
          GoogleCloudChannelV1UnregisterSubscriberRequest content)
Unregisters a service account with subscriber privileges on the Pub/Sub topic created for this
 Channel Services account or integrator.







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














Constructor Detail





Accounts
public Accounts()









Method Detail





checkCloudIdentityAccountsExist
public Cloudchannel.Accounts.CheckCloudIdentityAccountsExist checkCloudIdentityAccountsExist(String parent,
                                                                                             GoogleCloudChannelV1CheckCloudIdentityAccountsExistRequest content)
                                                                                      throws IOException
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 resources for
 the domain (may be empty) Note: in the v1alpha1 version of the API, a NOT_FOUND error returns if
 no CloudIdentityCustomerAccount resources match the domain.

 Create a request for the method "accounts.checkCloudIdentityAccountsExist".

 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 reseller account's resource name. Parent uses the format: accounts/{account_id}
content - the GoogleCloudChannelV1CheckCloudIdentityAccountsExistRequest
Returns:
the request
Throws:
IOException








listSubscribers
public Cloudchannel.Accounts.ListSubscribers listSubscribers(String account)
                                                      throws IOException
Lists service accounts with subscriber privileges on the Pub/Sub topic created for this Channel
 Services account or integrator. 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.

 Create a request for the method "accounts.listSubscribers".

 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:
account - Optional. Resource name of the account. Required if integrator is not provided. Otherwise, leave
        this field empty/unset.
Returns:
the request
Throws:
IOException








listTransferableOffers
public Cloudchannel.Accounts.ListTransferableOffers listTransferableOffers(String parent,
                                                                           GoogleCloudChannelV1ListTransferableOffersRequest content)
                                                                    throws IOException
List TransferableOffers 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. * 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. Return value: List of TransferableOffer for the given customer
 and SKU.

 Create a request for the method "accounts.listTransferableOffers".

 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.
content - the GoogleCloudChannelV1ListTransferableOffersRequest
Returns:
the request
Throws:
IOException








listTransferableSkus
public Cloudchannel.Accounts.ListTransferableSkus listTransferableSkus(String parent,
                                                                       GoogleCloudChannelV1ListTransferableSkusRequest content)
                                                                throws IOException
List TransferableSkus 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.

 Create a request for the method "accounts.listTransferableSkus".

 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 reseller account's resource name. Parent uses the format: accounts/{account_id}
content - the GoogleCloudChannelV1ListTransferableSkusRequest
Returns:
the request
Throws:
IOException








register
public Cloudchannel.Accounts.Register register(String account,
                                               GoogleCloudChannelV1RegisterSubscriberRequest content)
                                        throws IOException
Registers a service account with subscriber privileges on the Pub/Sub topic for this Channel
 Services account or integrator. After you create a subscriber, you get the events through
 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.

 Create a request for the method "accounts.register".

 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:
account - Optional. Resource name of the account. Required if integrator is not provided. Otherwise, leave
        this field empty/unset.
content - the GoogleCloudChannelV1RegisterSubscriberRequest
Returns:
the request
Throws:
IOException








unregister
public Cloudchannel.Accounts.Unregister unregister(String account,
                                                   GoogleCloudChannelV1UnregisterSubscriberRequest content)
                                            throws IOException
Unregisters a service account with subscriber privileges on the Pub/Sub topic created for this
 Channel Services account or integrator. 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.

 Create a request for the method "accounts.unregister".

 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:
account - Optional. Resource name of the account. Required if integrator is not provided. Otherwise, leave
        this field empty/unset.
content - the GoogleCloudChannelV1UnregisterSubscriberRequest
Returns:
the request
Throws:
IOException








channelPartnerLinks
public Cloudchannel.Accounts.ChannelPartnerLinks channelPartnerLinks()
An accessor for creating requests from the ChannelPartnerLinks collection.

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

Returns:
the resource collection








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

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

Returns:
the resource collection








offers
public Cloudchannel.Accounts.Offers offers()
An accessor for creating requests from the Offers collection.

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

Returns:
the resource collection








reportJobs
public Cloudchannel.Accounts.ReportJobs reportJobs()
An accessor for creating requests from the ReportJobs collection.

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

Returns:
the resource collection








reports
public Cloudchannel.Accounts.Reports reports()
An accessor for creating requests from the Reports collection.

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

Returns:
the resource collection








skuGroups
public Cloudchannel.Accounts.SkuGroups skuGroups()
An accessor for creating requests from the SkuGroups collection.

 The typical use is:
     Cloudchannel cloudchannel = new Cloudchannel(...);
    Cloudchannel.SkuGroups.List request = cloudchannel.skuGroups().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.

Modifier and Type	Class and Description
`class`	`Cloudchannel.Accounts.ChannelPartnerLinks` The "channelPartnerLinks" collection of methods.
`class`	`Cloudchannel.Accounts.CheckCloudIdentityAccountsExist`
`class`	`Cloudchannel.Accounts.Customers` The "customers" collection of methods.
`class`	`Cloudchannel.Accounts.ListSubscribers`
`class`	`Cloudchannel.Accounts.ListTransferableOffers`
`class`	`Cloudchannel.Accounts.ListTransferableSkus`
`class`	`Cloudchannel.Accounts.Offers` The "offers" collection of methods.
`class`	`Cloudchannel.Accounts.Register`
`class`	`Cloudchannel.Accounts.ReportJobs` The "reportJobs" collection of methods.
`class`	`Cloudchannel.Accounts.Reports` The "reports" collection of methods.
`class`	`Cloudchannel.Accounts.SkuGroups` The "skuGroups" collection of methods.
`class`	`Cloudchannel.Accounts.Unregister`

Modifier and Type	Method and Description
`Cloudchannel.Accounts.ChannelPartnerLinks`	`channelPartnerLinks()` An accessor for creating requests from the ChannelPartnerLinks collection.
`Cloudchannel.Accounts.CheckCloudIdentityAccountsExist`	`checkCloudIdentityAccountsExist(String parent, GoogleCloudChannelV1CheckCloudIdentityAccountsExistRequest content)` Confirms the existence of Cloud Identity accounts based on the domain and if the Cloud Identity accounts are owned by the reseller.
`Cloudchannel.Accounts.Customers`	`customers()` An accessor for creating requests from the Customers collection.
`Cloudchannel.Accounts.ListSubscribers`	`listSubscribers(String account)` Lists service accounts with subscriber privileges on the Pub/Sub topic created for this Channel Services account or integrator.
`Cloudchannel.Accounts.ListTransferableOffers`	`listTransferableOffers(String parent, GoogleCloudChannelV1ListTransferableOffersRequest content)` List TransferableOffers of a customer based on Cloud Identity ID or Customer Name in the request.
`Cloudchannel.Accounts.ListTransferableSkus`	`listTransferableSkus(String parent, GoogleCloudChannelV1ListTransferableSkusRequest content)` List TransferableSkus of a customer based on the Cloud Identity ID or Customer Name in the request.
`Cloudchannel.Accounts.Offers`	`offers()` An accessor for creating requests from the Offers collection.
`Cloudchannel.Accounts.Register`	`register(String account, GoogleCloudChannelV1RegisterSubscriberRequest content)` Registers a service account with subscriber privileges on the Pub/Sub topic for this Channel Services account or integrator.
`Cloudchannel.Accounts.ReportJobs`	`reportJobs()` An accessor for creating requests from the ReportJobs collection.
`Cloudchannel.Accounts.Reports`	`reports()` An accessor for creating requests from the Reports collection.
`Cloudchannel.Accounts.SkuGroups`	`skuGroups()` An accessor for creating requests from the SkuGroups collection.
`Cloudchannel.Accounts.Unregister`	`unregister(String account, GoogleCloudChannelV1UnregisterSubscriberRequest content)` Unregisters a service account with subscriber privileges on the Pub/Sub topic created for this Channel Services account or integrator.