Class CloudChannelServiceClient (3.5.1)

Version 3.5.1

• 3.58.0 (latest)
• 3.57.0
• 3.56.0
• 3.55.0
• 3.53.0
• 3.52.0
• 3.51.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.41.0
• 3.40.0
• 3.39.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.28.0
• 3.27.0
• 3.26.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.6
• 3.6.1
• 3.5.1
• 3.3.1

public class CloudChannelServiceClient implements BackgroundResource

Service Description: CloudChannelService lets Google cloud resellers and distributors manage their customers, channel partners, entitlements, and reports.

Using this service: 1. Resellers and distributors can manage a customer entity. 2. Distributors can register an authorized reseller in their channel and provide them with delegated admin access. 3. Resellers and distributors can manage customer entitlements.

CloudChannelService exposes the following resources: - Customers: An entity\u2014usually an enterprise\u2014managed by a reseller or distributor.

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

- ChannelPartnerLinks: An entity that identifies links between distributors and their indirect resellers in a channel.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   CustomerName name = CustomerName.of("[ACCOUNT]", "[CUSTOMER]");
   Customer response = cloudChannelServiceClient.getCustomer(name);
 }
 

Note: close() needs to be called on the CloudChannelServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of CloudChannelServiceSettings to create(). For example:

To customize credentials:

 CloudChannelServiceSettings cloudChannelServiceSettings =
     CloudChannelServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CloudChannelServiceClient cloudChannelServiceClient =
     CloudChannelServiceClient.create(cloudChannelServiceSettings);
 

To customize the endpoint:

 CloudChannelServiceSettings cloudChannelServiceSettings =
     CloudChannelServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 CloudChannelServiceClient cloudChannelServiceClient =
     CloudChannelServiceClient.create(cloudChannelServiceSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > CloudChannelServiceClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final CloudChannelServiceClient create()

Constructs an instance of CloudChannelServiceClient with default settings.

Returns

Type	Description
CloudChannelServiceClient

Exceptions

Type	Description
IOException

create(CloudChannelServiceSettings settings)

public static final CloudChannelServiceClient create(CloudChannelServiceSettings settings)

Constructs an instance of CloudChannelServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter

Name	Description
settings	CloudChannelServiceSettings

Returns

Type	Description
CloudChannelServiceClient

Exceptions

Type	Description
IOException

create(CloudChannelServiceStub stub)

public static final CloudChannelServiceClient create(CloudChannelServiceStub stub)

Constructs an instance of CloudChannelServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(CloudChannelServiceSettings).

Parameter

Name	Description
stub	CloudChannelServiceStub

Returns

Type	Description
CloudChannelServiceClient

Constructors

CloudChannelServiceClient(CloudChannelServiceSettings settings)

protected CloudChannelServiceClient(CloudChannelServiceSettings settings)

Constructs an instance of CloudChannelServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter

Name	Description
settings	CloudChannelServiceSettings

CloudChannelServiceClient(CloudChannelServiceStub stub)

protected CloudChannelServiceClient(CloudChannelServiceStub stub)

Parameter

Name	Description
stub	CloudChannelServiceStub

Methods

activateEntitlementAsync(ActivateEntitlementRequest request)

public final OperationFuture<Entitlement,OperationMetadata> activateEntitlementAsync(ActivateEntitlementRequest request)

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ActivateEntitlementRequest request =
       ActivateEntitlementRequest.newBuilder()
           .setName("name3373707")
           .setRequestId("requestId693933066")
           .build();
   Entitlement response = cloudChannelServiceClient.activateEntitlementAsync(request).get();
 }
 

Parameter

Name	Description
request	ActivateEntitlementRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Entitlement,OperationMetadata>

activateEntitlementCallable()

public final UnaryCallable<ActivateEntitlementRequest,Operation> activateEntitlementCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ActivateEntitlementRequest request =
       ActivateEntitlementRequest.newBuilder()
           .setName("name3373707")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       cloudChannelServiceClient.activateEntitlementCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<ActivateEntitlementRequest,Operation>

activateEntitlementOperationCallable()

public final OperationCallable<ActivateEntitlementRequest,Entitlement,OperationMetadata> activateEntitlementOperationCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ActivateEntitlementRequest request =
       ActivateEntitlementRequest.newBuilder()
           .setName("name3373707")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<ActivateEntitlementRequest,Entitlement,OperationMetadata>

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters

Name	Description
duration	long
unit	TimeUnit

Returns

Type	Description
boolean

Exceptions

Type	Description
InterruptedException

cancelEntitlementAsync(CancelEntitlementRequest request)

public final OperationFuture<Empty,OperationMetadata> cancelEntitlementAsync(CancelEntitlementRequest request)

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   CancelEntitlementRequest request =
       CancelEntitlementRequest.newBuilder()
           .setName("name3373707")
           .setRequestId("requestId693933066")
           .build();
   cloudChannelServiceClient.cancelEntitlementAsync(request).get();
 }
 

Parameter

Name	Description
request	CancelEntitlementRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Empty,OperationMetadata>

cancelEntitlementCallable()

public final UnaryCallable<CancelEntitlementRequest,Operation> cancelEntitlementCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   CancelEntitlementRequest request =
       CancelEntitlementRequest.newBuilder()
           .setName("name3373707")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       cloudChannelServiceClient.cancelEntitlementCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Returns

Type	Description
UnaryCallable<CancelEntitlementRequest,Operation>

cancelEntitlementOperationCallable()

public final OperationCallable<CancelEntitlementRequest,Empty,OperationMetadata> cancelEntitlementOperationCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   CancelEntitlementRequest request =
       CancelEntitlementRequest.newBuilder()
           .setName("name3373707")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<CancelEntitlementRequest,Empty,OperationMetadata>

changeOfferAsync(ChangeOfferRequest request)

public final OperationFuture<Entitlement,OperationMetadata> changeOfferAsync(ChangeOfferRequest request)

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ChangeOfferRequest request =
       ChangeOfferRequest.newBuilder()
           .setName("name3373707")
           .setOffer(OfferName.of("[ACCOUNT]", "[OFFER]").toString())
           .addAllParameters(new ArrayList<Parameter>())
           .setPurchaseOrderId("purchaseOrderId2029917384")
           .setRequestId("requestId693933066")
           .build();
   Entitlement response = cloudChannelServiceClient.changeOfferAsync(request).get();
 }
 

Parameter

Name	Description
request	ChangeOfferRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Entitlement,OperationMetadata>

changeOfferCallable()

public final UnaryCallable<ChangeOfferRequest,Operation> changeOfferCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ChangeOfferRequest request =
       ChangeOfferRequest.newBuilder()
           .setName("name3373707")
           .setOffer(OfferName.of("[ACCOUNT]", "[OFFER]").toString())
           .addAllParameters(new ArrayList<Parameter>())
           .setPurchaseOrderId("purchaseOrderId2029917384")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       cloudChannelServiceClient.changeOfferCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<ChangeOfferRequest,Operation>

changeOfferOperationCallable()

public final OperationCallable<ChangeOfferRequest,Entitlement,OperationMetadata> changeOfferOperationCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ChangeOfferRequest request =
       ChangeOfferRequest.newBuilder()
           .setName("name3373707")
           .setOffer(OfferName.of("[ACCOUNT]", "[OFFER]").toString())
           .addAllParameters(new ArrayList<Parameter>())
           .setPurchaseOrderId("purchaseOrderId2029917384")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<ChangeOfferRequest,Entitlement,OperationMetadata>

changeParametersAsync(ChangeParametersRequest request)

public final OperationFuture<Entitlement,OperationMetadata> changeParametersAsync(ChangeParametersRequest request)

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ChangeParametersRequest request =
       ChangeParametersRequest.newBuilder()
           .setName("name3373707")
           .addAllParameters(new ArrayList<Parameter>())
           .setRequestId("requestId693933066")
           .setPurchaseOrderId("purchaseOrderId2029917384")
           .build();
   Entitlement response = cloudChannelServiceClient.changeParametersAsync(request).get();
 }
 

Parameter

Name	Description
request	ChangeParametersRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Entitlement,OperationMetadata>

changeParametersCallable()

public final UnaryCallable<ChangeParametersRequest,Operation> changeParametersCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ChangeParametersRequest request =
       ChangeParametersRequest.newBuilder()
           .setName("name3373707")
           .addAllParameters(new ArrayList<Parameter>())
           .setRequestId("requestId693933066")
           .setPurchaseOrderId("purchaseOrderId2029917384")
           .build();
   ApiFuture<Operation> future =
       cloudChannelServiceClient.changeParametersCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<ChangeParametersRequest,Operation>

changeParametersOperationCallable()

public final OperationCallable<ChangeParametersRequest,Entitlement,OperationMetadata> changeParametersOperationCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ChangeParametersRequest request =
       ChangeParametersRequest.newBuilder()
           .setName("name3373707")
           .addAllParameters(new ArrayList<Parameter>())
           .setRequestId("requestId693933066")
           .setPurchaseOrderId("purchaseOrderId2029917384")
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<ChangeParametersRequest,Entitlement,OperationMetadata>

changeRenewalSettingsAsync(ChangeRenewalSettingsRequest request)

public final OperationFuture<Entitlement,OperationMetadata> changeRenewalSettingsAsync(ChangeRenewalSettingsRequest request)

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ChangeRenewalSettingsRequest request =
       ChangeRenewalSettingsRequest.newBuilder()
           .setName("name3373707")
           .setRenewalSettings(RenewalSettings.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   Entitlement response = cloudChannelServiceClient.changeRenewalSettingsAsync(request).get();
 }
 

Parameter

Name	Description
request	ChangeRenewalSettingsRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Entitlement,OperationMetadata>

changeRenewalSettingsCallable()

public final UnaryCallable<ChangeRenewalSettingsRequest,Operation> changeRenewalSettingsCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ChangeRenewalSettingsRequest request =
       ChangeRenewalSettingsRequest.newBuilder()
           .setName("name3373707")
           .setRenewalSettings(RenewalSettings.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       cloudChannelServiceClient.changeRenewalSettingsCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<ChangeRenewalSettingsRequest,Operation>

changeRenewalSettingsOperationCallable()

public final OperationCallable<ChangeRenewalSettingsRequest,Entitlement,OperationMetadata> changeRenewalSettingsOperationCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ChangeRenewalSettingsRequest request =
       ChangeRenewalSettingsRequest.newBuilder()
           .setName("name3373707")
           .setRenewalSettings(RenewalSettings.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<ChangeRenewalSettingsRequest,Entitlement,OperationMetadata>

checkCloudIdentityAccountsExist(CheckCloudIdentityAccountsExistRequest request)

public final CheckCloudIdentityAccountsExistResponse checkCloudIdentityAccountsExist(CheckCloudIdentityAccountsExistRequest request)

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   CheckCloudIdentityAccountsExistRequest request =
       CheckCloudIdentityAccountsExistRequest.newBuilder()
           .setParent("parent-995424086")
           .setDomain("domain-1326197564")
           .build();
   CheckCloudIdentityAccountsExistResponse response =
       cloudChannelServiceClient.checkCloudIdentityAccountsExist(request);
 }
 

Parameter

Name	Description
request	CheckCloudIdentityAccountsExistRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
CheckCloudIdentityAccountsExistResponse

checkCloudIdentityAccountsExistCallable()

public final UnaryCallable<CheckCloudIdentityAccountsExistRequest,CheckCloudIdentityAccountsExistResponse> checkCloudIdentityAccountsExistCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   CheckCloudIdentityAccountsExistRequest request =
       CheckCloudIdentityAccountsExistRequest.newBuilder()
           .setParent("parent-995424086")
           .setDomain("domain-1326197564")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<CheckCloudIdentityAccountsExistRequest,CheckCloudIdentityAccountsExistResponse>

close()

public final void close()

createChannelPartnerLink(CreateChannelPartnerLinkRequest request)

public final ChannelPartnerLink createChannelPartnerLink(CreateChannelPartnerLinkRequest request)

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 resource.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   CreateChannelPartnerLinkRequest request =
       CreateChannelPartnerLinkRequest.newBuilder()
           .setParent("parent-995424086")
           .setChannelPartnerLink(ChannelPartnerLink.newBuilder().build())
           .build();
   ChannelPartnerLink response = cloudChannelServiceClient.createChannelPartnerLink(request);
 }
 

Parameter

Name	Description
request	CreateChannelPartnerLinkRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
ChannelPartnerLink

createChannelPartnerLinkCallable()

public final UnaryCallable<CreateChannelPartnerLinkRequest,ChannelPartnerLink> createChannelPartnerLinkCallable()

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 resource.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   CreateChannelPartnerLinkRequest request =
       CreateChannelPartnerLinkRequest.newBuilder()
           .setParent("parent-995424086")
           .setChannelPartnerLink(ChannelPartnerLink.newBuilder().build())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<CreateChannelPartnerLinkRequest,ChannelPartnerLink>

createCustomer(CreateCustomerRequest request)

public final Customer createCustomer(CreateCustomerRequest request)

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.
• 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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   CreateCustomerRequest request =
       CreateCustomerRequest.newBuilder()
           .setParent("parent-995424086")
           .setCustomer(Customer.newBuilder().build())
           .build();
   Customer response = cloudChannelServiceClient.createCustomer(request);
 }
 

Parameter

Name	Description
request	CreateCustomerRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
Customer

createCustomerCallable()

public final UnaryCallable<CreateCustomerRequest,Customer> createCustomerCallable()

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.
• 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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   CreateCustomerRequest request =
       CreateCustomerRequest.newBuilder()
           .setParent("parent-995424086")
           .setCustomer(Customer.newBuilder().build())
           .build();
   ApiFuture<Customer> future =
       cloudChannelServiceClient.createCustomerCallable().futureCall(request);
   // Do something.
   Customer response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<CreateCustomerRequest,Customer>

createEntitlementAsync(CreateEntitlementRequest request)

public final OperationFuture<Entitlement,OperationMetadata> createEntitlementAsync(CreateEntitlementRequest request)

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   CreateEntitlementRequest request =
       CreateEntitlementRequest.newBuilder()
           .setParent(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString())
           .setEntitlement(Entitlement.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   Entitlement response = cloudChannelServiceClient.createEntitlementAsync(request).get();
 }
 

Parameter

Name	Description
request	CreateEntitlementRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Entitlement,OperationMetadata>

createEntitlementCallable()

public final UnaryCallable<CreateEntitlementRequest,Operation> createEntitlementCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   CreateEntitlementRequest request =
       CreateEntitlementRequest.newBuilder()
           .setParent(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString())
           .setEntitlement(Entitlement.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       cloudChannelServiceClient.createEntitlementCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<CreateEntitlementRequest,Operation>

createEntitlementOperationCallable()

public final OperationCallable<CreateEntitlementRequest,Entitlement,OperationMetadata> createEntitlementOperationCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   CreateEntitlementRequest request =
       CreateEntitlementRequest.newBuilder()
           .setParent(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString())
           .setEntitlement(Entitlement.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<CreateEntitlementRequest,Entitlement,OperationMetadata>

deleteCustomer(CustomerName name)

public final void deleteCustomer(CustomerName name)

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   CustomerName name = CustomerName.of("[ACCOUNT]", "[CUSTOMER]");
   cloudChannelServiceClient.deleteCustomer(name);
 }
 

Parameter

Name	Description
name	CustomerName Required. The resource name of the customer to delete.

deleteCustomer(DeleteCustomerRequest request)

public final void deleteCustomer(DeleteCustomerRequest request)

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   DeleteCustomerRequest request =
       DeleteCustomerRequest.newBuilder()
           .setName(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString())
           .build();
   cloudChannelServiceClient.deleteCustomer(request);
 }
 

Parameter

Name	Description
request	DeleteCustomerRequest The request object containing all of the parameters for the API call.

deleteCustomer(String name)

public final void deleteCustomer(String name)

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   String name = CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString();
   cloudChannelServiceClient.deleteCustomer(name);
 }
 

Parameter

Name	Description
name	String Required. The resource name of the customer to delete.

deleteCustomerCallable()

public final UnaryCallable<DeleteCustomerRequest,Empty> deleteCustomerCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   DeleteCustomerRequest request =
       DeleteCustomerRequest.newBuilder()
           .setName(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString())
           .build();
   ApiFuture<Empty> future =
       cloudChannelServiceClient.deleteCustomerCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Returns

Type	Description
UnaryCallable<DeleteCustomerRequest,Empty>

getChannelPartnerLink(GetChannelPartnerLinkRequest request)

public final ChannelPartnerLink getChannelPartnerLink(GetChannelPartnerLinkRequest request)

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

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   GetChannelPartnerLinkRequest request =
       GetChannelPartnerLinkRequest.newBuilder()
           .setName("name3373707")
           .setView(ChannelPartnerLinkView.forNumber(0))
           .build();
   ChannelPartnerLink response = cloudChannelServiceClient.getChannelPartnerLink(request);
 }
 

Parameter

Name	Description
request	GetChannelPartnerLinkRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
ChannelPartnerLink

getChannelPartnerLinkCallable()

public final UnaryCallable<GetChannelPartnerLinkRequest,ChannelPartnerLink> getChannelPartnerLinkCallable()

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

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   GetChannelPartnerLinkRequest request =
       GetChannelPartnerLinkRequest.newBuilder()
           .setName("name3373707")
           .setView(ChannelPartnerLinkView.forNumber(0))
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<GetChannelPartnerLinkRequest,ChannelPartnerLink>

getCustomer(CustomerName name)

public final Customer getCustomer(CustomerName name)

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   CustomerName name = CustomerName.of("[ACCOUNT]", "[CUSTOMER]");
   Customer response = cloudChannelServiceClient.getCustomer(name);
 }
 

Parameter

Name	Description
name	CustomerName Required. The resource name of the customer to retrieve. Name uses the format: accounts/{account_id}/customers/{customer_id}

Returns

Type	Description
Customer

getCustomer(GetCustomerRequest request)

public final Customer getCustomer(GetCustomerRequest request)

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   GetCustomerRequest request =
       GetCustomerRequest.newBuilder()
           .setName(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString())
           .build();
   Customer response = cloudChannelServiceClient.getCustomer(request);
 }
 

Parameter

Name	Description
request	GetCustomerRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
Customer

getCustomer(String name)

public final Customer getCustomer(String name)

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   String name = CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString();
   Customer response = cloudChannelServiceClient.getCustomer(name);
 }
 

Parameter

Name	Description
name	String Required. The resource name of the customer to retrieve. Name uses the format: accounts/{account_id}/customers/{customer_id}

Returns

Type	Description
Customer

getCustomerCallable()

public final UnaryCallable<GetCustomerRequest,Customer> getCustomerCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   GetCustomerRequest request =
       GetCustomerRequest.newBuilder()
           .setName(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString())
           .build();
   ApiFuture<Customer> future =
       cloudChannelServiceClient.getCustomerCallable().futureCall(request);
   // Do something.
   Customer response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<GetCustomerRequest,Customer>

getEntitlement(GetEntitlementRequest request)

public final Entitlement getEntitlement(GetEntitlementRequest request)

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   GetEntitlementRequest request =
       GetEntitlementRequest.newBuilder()
           .setName(EntitlementName.of("[ACCOUNT]", "[CUSTOMER]", "[ENTITLEMENT]").toString())
           .build();
   Entitlement response = cloudChannelServiceClient.getEntitlement(request);
 }
 

Parameter

Name	Description
request	GetEntitlementRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
Entitlement

getEntitlementCallable()

public final UnaryCallable<GetEntitlementRequest,Entitlement> getEntitlementCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   GetEntitlementRequest request =
       GetEntitlementRequest.newBuilder()
           .setName(EntitlementName.of("[ACCOUNT]", "[CUSTOMER]", "[ENTITLEMENT]").toString())
           .build();
   ApiFuture<Entitlement> future =
       cloudChannelServiceClient.getEntitlementCallable().futureCall(request);
   // Do something.
   Entitlement response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<GetEntitlementRequest,Entitlement>

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns

Type	Description
OperationsClient

getSettings()

public final CloudChannelServiceSettings getSettings()

Returns

Type	Description
CloudChannelServiceSettings

getStub()

public CloudChannelServiceStub getStub()

Returns

Type	Description
CloudChannelServiceStub

importCustomer(ImportCustomerRequest request)

public final Customer importCustomer(ImportCustomerRequest request)

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.
• 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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ImportCustomerRequest request =
       ImportCustomerRequest.newBuilder()
           .setParent("parent-995424086")
           .setAuthToken("authToken1450587441")
           .setOverwriteIfExists(true)
           .setChannelPartnerId("channelPartnerId-170366400")
           .setCustomer(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString())
           .build();
   Customer response = cloudChannelServiceClient.importCustomer(request);
 }
 

Parameter

Name	Description
request	ImportCustomerRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
Customer

importCustomerCallable()

public final UnaryCallable<ImportCustomerRequest,Customer> importCustomerCallable()

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.
• 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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ImportCustomerRequest request =
       ImportCustomerRequest.newBuilder()
           .setParent("parent-995424086")
           .setAuthToken("authToken1450587441")
           .setOverwriteIfExists(true)
           .setChannelPartnerId("channelPartnerId-170366400")
           .setCustomer(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString())
           .build();
   ApiFuture<Customer> future =
       cloudChannelServiceClient.importCustomerCallable().futureCall(request);
   // Do something.
   Customer response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<ImportCustomerRequest,Customer>

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

listChannelPartnerLinks(ListChannelPartnerLinksRequest request)

public final CloudChannelServiceClient.ListChannelPartnerLinksPagedResponse listChannelPartnerLinks(ListChannelPartnerLinksRequest request)

List ChannelPartnerLinks 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 resources.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ListChannelPartnerLinksRequest request =
       ListChannelPartnerLinksRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setView(ChannelPartnerLinkView.forNumber(0))
           .build();
   for (ChannelPartnerLink element :
       cloudChannelServiceClient.listChannelPartnerLinks(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	ListChannelPartnerLinksRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
CloudChannelServiceClient.ListChannelPartnerLinksPagedResponse

listChannelPartnerLinksCallable()

public final UnaryCallable<ListChannelPartnerLinksRequest,ListChannelPartnerLinksResponse> listChannelPartnerLinksCallable()

List ChannelPartnerLinks 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 resources.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ListChannelPartnerLinksRequest request =
       ListChannelPartnerLinksRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setView(ChannelPartnerLinkView.forNumber(0))
           .build();
   while (true) {
     ListChannelPartnerLinksResponse response =
         cloudChannelServiceClient.listChannelPartnerLinksCallable().call(request);
     for (ChannelPartnerLink element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListChannelPartnerLinksRequest,ListChannelPartnerLinksResponse>

listChannelPartnerLinksPagedCallable()

public final UnaryCallable<ListChannelPartnerLinksRequest,CloudChannelServiceClient.ListChannelPartnerLinksPagedResponse> listChannelPartnerLinksPagedCallable()

List ChannelPartnerLinks 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 resources.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ListChannelPartnerLinksRequest request =
       ListChannelPartnerLinksRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setView(ChannelPartnerLinkView.forNumber(0))
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ListChannelPartnerLinksRequest,ListChannelPartnerLinksPagedResponse>

listCustomers(ListCustomersRequest request)

public final CloudChannelServiceClient.ListCustomersPagedResponse listCustomers(ListCustomersRequest request)

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ListCustomersRequest request =
       ListCustomersRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Customer element : cloudChannelServiceClient.listCustomers(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	ListCustomersRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
CloudChannelServiceClient.ListCustomersPagedResponse

listCustomersCallable()

public final UnaryCallable<ListCustomersRequest,ListCustomersResponse> listCustomersCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ListCustomersRequest request =
       ListCustomersRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListCustomersResponse response =
         cloudChannelServiceClient.listCustomersCallable().call(request);
     for (Customer element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListCustomersRequest,ListCustomersResponse>

listCustomersPagedCallable()

public final UnaryCallable<ListCustomersRequest,CloudChannelServiceClient.ListCustomersPagedResponse> listCustomersPagedCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ListCustomersRequest request =
       ListCustomersRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Customer> future =
       cloudChannelServiceClient.listCustomersPagedCallable().futureCall(request);
   // Do something.
   for (Customer element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListCustomersRequest,ListCustomersPagedResponse>

listEntitlements(ListEntitlementsRequest request)

public final CloudChannelServiceClient.ListEntitlementsPagedResponse listEntitlements(ListEntitlementsRequest request)

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ListEntitlementsRequest request =
       ListEntitlementsRequest.newBuilder()
           .setParent(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Entitlement element : cloudChannelServiceClient.listEntitlements(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	ListEntitlementsRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
CloudChannelServiceClient.ListEntitlementsPagedResponse

listEntitlementsCallable()

public final UnaryCallable<ListEntitlementsRequest,ListEntitlementsResponse> listEntitlementsCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ListEntitlementsRequest request =
       ListEntitlementsRequest.newBuilder()
           .setParent(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListEntitlementsResponse response =
         cloudChannelServiceClient.listEntitlementsCallable().call(request);
     for (Entitlement element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListEntitlementsRequest,ListEntitlementsResponse>

listEntitlementsPagedCallable()

public final UnaryCallable<ListEntitlementsRequest,CloudChannelServiceClient.ListEntitlementsPagedResponse> listEntitlementsPagedCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ListEntitlementsRequest request =
       ListEntitlementsRequest.newBuilder()
           .setParent(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Entitlement> future =
       cloudChannelServiceClient.listEntitlementsPagedCallable().futureCall(request);
   // Do something.
   for (Entitlement element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListEntitlementsRequest,ListEntitlementsPagedResponse>

listOffers(ListOffersRequest request)

public final CloudChannelServiceClient.ListOffersPagedResponse listOffers(ListOffersRequest request)

Lists the Offers the reseller can sell.

Possible error codes:

• INVALID_ARGUMENT: Required request parameters are missing or invalid.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ListOffersRequest request =
       ListOffersRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setLanguageCode("languageCode-2092349083")
           .build();
   for (Offer element : cloudChannelServiceClient.listOffers(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	ListOffersRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
CloudChannelServiceClient.ListOffersPagedResponse

listOffersCallable()

public final UnaryCallable<ListOffersRequest,ListOffersResponse> listOffersCallable()

Lists the Offers the reseller can sell.

Possible error codes:

• INVALID_ARGUMENT: Required request parameters are missing or invalid.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ListOffersRequest request =
       ListOffersRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setLanguageCode("languageCode-2092349083")
           .build();
   while (true) {
     ListOffersResponse response = cloudChannelServiceClient.listOffersCallable().call(request);
     for (Offer element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListOffersRequest,ListOffersResponse>

listOffersPagedCallable()

public final UnaryCallable<ListOffersRequest,CloudChannelServiceClient.ListOffersPagedResponse> listOffersPagedCallable()

Lists the Offers the reseller can sell.

Possible error codes:

• INVALID_ARGUMENT: Required request parameters are missing or invalid.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ListOffersRequest request =
       ListOffersRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setLanguageCode("languageCode-2092349083")
           .build();
   ApiFuture<Offer> future =
       cloudChannelServiceClient.listOffersPagedCallable().futureCall(request);
   // Do something.
   for (Offer element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListOffersRequest,ListOffersPagedResponse>

listProducts(ListProductsRequest request)

public final CloudChannelServiceClient.ListProductsPagedResponse listProducts(ListProductsRequest request)

Lists the Products the reseller is authorized to sell.

Possible error codes:

• INVALID_ARGUMENT: Required request parameters are missing or invalid.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ListProductsRequest request =
       ListProductsRequest.newBuilder()
           .setAccount("account-1177318867")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setLanguageCode("languageCode-2092349083")
           .build();
   for (Product element : cloudChannelServiceClient.listProducts(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	ListProductsRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
CloudChannelServiceClient.ListProductsPagedResponse

listProductsCallable()

public final UnaryCallable<ListProductsRequest,ListProductsResponse> listProductsCallable()

Lists the Products the reseller is authorized to sell.

Possible error codes:

• INVALID_ARGUMENT: Required request parameters are missing or invalid.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ListProductsRequest request =
       ListProductsRequest.newBuilder()
           .setAccount("account-1177318867")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setLanguageCode("languageCode-2092349083")
           .build();
   while (true) {
     ListProductsResponse response =
         cloudChannelServiceClient.listProductsCallable().call(request);
     for (Product element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListProductsRequest,ListProductsResponse>

listProductsPagedCallable()

public final UnaryCallable<ListProductsRequest,CloudChannelServiceClient.ListProductsPagedResponse> listProductsPagedCallable()

Lists the Products the reseller is authorized to sell.

Possible error codes:

• INVALID_ARGUMENT: Required request parameters are missing or invalid.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ListProductsRequest request =
       ListProductsRequest.newBuilder()
           .setAccount("account-1177318867")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setLanguageCode("languageCode-2092349083")
           .build();
   ApiFuture<Product> future =
       cloudChannelServiceClient.listProductsPagedCallable().futureCall(request);
   // Do something.
   for (Product element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListProductsRequest,ListProductsPagedResponse>

listPurchasableOffers(ListPurchasableOffersRequest request)

public final CloudChannelServiceClient.ListPurchasableOffersPagedResponse listPurchasableOffers(ListPurchasableOffersRequest request)

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ListPurchasableOffersRequest request =
       ListPurchasableOffersRequest.newBuilder()
           .setCustomer(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setLanguageCode("languageCode-2092349083")
           .build();
   for (PurchasableOffer element :
       cloudChannelServiceClient.listPurchasableOffers(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	ListPurchasableOffersRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
CloudChannelServiceClient.ListPurchasableOffersPagedResponse

listPurchasableOffersCallable()

public final UnaryCallable<ListPurchasableOffersRequest,ListPurchasableOffersResponse> listPurchasableOffersCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ListPurchasableOffersRequest request =
       ListPurchasableOffersRequest.newBuilder()
           .setCustomer(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setLanguageCode("languageCode-2092349083")
           .build();
   while (true) {
     ListPurchasableOffersResponse response =
         cloudChannelServiceClient.listPurchasableOffersCallable().call(request);
     for (PurchasableOffer element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListPurchasableOffersRequest,ListPurchasableOffersResponse>

listPurchasableOffersPagedCallable()

public final UnaryCallable<ListPurchasableOffersRequest,CloudChannelServiceClient.ListPurchasableOffersPagedResponse> listPurchasableOffersPagedCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ListPurchasableOffersRequest request =
       ListPurchasableOffersRequest.newBuilder()
           .setCustomer(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setLanguageCode("languageCode-2092349083")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ListPurchasableOffersRequest,ListPurchasableOffersPagedResponse>

listPurchasableSkus(ListPurchasableSkusRequest request)

public final CloudChannelServiceClient.ListPurchasableSkusPagedResponse listPurchasableSkus(ListPurchasableSkusRequest request)

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ListPurchasableSkusRequest request =
       ListPurchasableSkusRequest.newBuilder()
           .setCustomer(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setLanguageCode("languageCode-2092349083")
           .build();
   for (PurchasableSku element :
       cloudChannelServiceClient.listPurchasableSkus(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	ListPurchasableSkusRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
CloudChannelServiceClient.ListPurchasableSkusPagedResponse

listPurchasableSkusCallable()

public final UnaryCallable<ListPurchasableSkusRequest,ListPurchasableSkusResponse> listPurchasableSkusCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ListPurchasableSkusRequest request =
       ListPurchasableSkusRequest.newBuilder()
           .setCustomer(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setLanguageCode("languageCode-2092349083")
           .build();
   while (true) {
     ListPurchasableSkusResponse response =
         cloudChannelServiceClient.listPurchasableSkusCallable().call(request);
     for (PurchasableSku element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListPurchasableSkusRequest,ListPurchasableSkusResponse>

listPurchasableSkusPagedCallable()

public final UnaryCallable<ListPurchasableSkusRequest,CloudChannelServiceClient.ListPurchasableSkusPagedResponse> listPurchasableSkusPagedCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ListPurchasableSkusRequest request =
       ListPurchasableSkusRequest.newBuilder()
           .setCustomer(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setLanguageCode("languageCode-2092349083")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ListPurchasableSkusRequest,ListPurchasableSkusPagedResponse>

listSkus(ListSkusRequest request)

public final CloudChannelServiceClient.ListSkusPagedResponse listSkus(ListSkusRequest request)

Lists the SKUs for a product the reseller is authorized to sell.

Possible error codes:

• INVALID_ARGUMENT: Required request parameters are missing or invalid.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ListSkusRequest request =
       ListSkusRequest.newBuilder()
           .setParent(ProductName.of("[PRODUCT]").toString())
           .setAccount("account-1177318867")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setLanguageCode("languageCode-2092349083")
           .build();
   for (Sku element : cloudChannelServiceClient.listSkus(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	ListSkusRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
CloudChannelServiceClient.ListSkusPagedResponse

listSkusCallable()

public final UnaryCallable<ListSkusRequest,ListSkusResponse> listSkusCallable()

Lists the SKUs for a product the reseller is authorized to sell.

Possible error codes:

• INVALID_ARGUMENT: Required request parameters are missing or invalid.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ListSkusRequest request =
       ListSkusRequest.newBuilder()
           .setParent(ProductName.of("[PRODUCT]").toString())
           .setAccount("account-1177318867")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setLanguageCode("languageCode-2092349083")
           .build();
   while (true) {
     ListSkusResponse response = cloudChannelServiceClient.listSkusCallable().call(request);
     for (Sku element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListSkusRequest,ListSkusResponse>

listSkusPagedCallable()

public final UnaryCallable<ListSkusRequest,CloudChannelServiceClient.ListSkusPagedResponse> listSkusPagedCallable()

Lists the SKUs for a product the reseller is authorized to sell.

Possible error codes:

• INVALID_ARGUMENT: Required request parameters are missing or invalid.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ListSkusRequest request =
       ListSkusRequest.newBuilder()
           .setParent(ProductName.of("[PRODUCT]").toString())
           .setAccount("account-1177318867")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setLanguageCode("languageCode-2092349083")
           .build();
   ApiFuture<Sku> future = cloudChannelServiceClient.listSkusPagedCallable().futureCall(request);
   // Do something.
   for (Sku element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListSkusRequest,ListSkusPagedResponse>

listSubscribers(ListSubscribersRequest request)

public final CloudChannelServiceClient.ListSubscribersPagedResponse listSubscribers(ListSubscribersRequest request)

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ListSubscribersRequest request =
       ListSubscribersRequest.newBuilder()
           .setAccount("account-1177318867")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (String element : cloudChannelServiceClient.listSubscribers(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	ListSubscribersRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
CloudChannelServiceClient.ListSubscribersPagedResponse

listSubscribersCallable()

public final UnaryCallable<ListSubscribersRequest,ListSubscribersResponse> listSubscribersCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ListSubscribersRequest request =
       ListSubscribersRequest.newBuilder()
           .setAccount("account-1177318867")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListSubscribersResponse response =
         cloudChannelServiceClient.listSubscribersCallable().call(request);
     for (String element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListSubscribersRequest,ListSubscribersResponse>

listSubscribersPagedCallable()

public final UnaryCallable<ListSubscribersRequest,CloudChannelServiceClient.ListSubscribersPagedResponse> listSubscribersPagedCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ListSubscribersRequest request =
       ListSubscribersRequest.newBuilder()
           .setAccount("account-1177318867")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<String> future =
       cloudChannelServiceClient.listSubscribersPagedCallable().futureCall(request);
   // Do something.
   for (String element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListSubscribersRequest,ListSubscribersPagedResponse>

listTransferableOffers(ListTransferableOffersRequest request)

public final CloudChannelServiceClient.ListTransferableOffersPagedResponse listTransferableOffers(ListTransferableOffersRequest request)

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 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: List of TransferableOffer for the given customer and SKU.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ListTransferableOffersRequest request =
       ListTransferableOffersRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setSku("sku113949")
           .setLanguageCode("languageCode-2092349083")
           .build();
   for (TransferableOffer element :
       cloudChannelServiceClient.listTransferableOffers(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	ListTransferableOffersRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
CloudChannelServiceClient.ListTransferableOffersPagedResponse

listTransferableOffersCallable()

public final UnaryCallable<ListTransferableOffersRequest,ListTransferableOffersResponse> listTransferableOffersCallable()

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 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: List of TransferableOffer for the given customer and SKU.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ListTransferableOffersRequest request =
       ListTransferableOffersRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setSku("sku113949")
           .setLanguageCode("languageCode-2092349083")
           .build();
   while (true) {
     ListTransferableOffersResponse response =
         cloudChannelServiceClient.listTransferableOffersCallable().call(request);
     for (TransferableOffer element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListTransferableOffersRequest,ListTransferableOffersResponse>

listTransferableOffersPagedCallable()

public final UnaryCallable<ListTransferableOffersRequest,CloudChannelServiceClient.ListTransferableOffersPagedResponse> listTransferableOffersPagedCallable()

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 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: List of TransferableOffer for the given customer and SKU.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ListTransferableOffersRequest request =
       ListTransferableOffersRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setSku("sku113949")
           .setLanguageCode("languageCode-2092349083")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ListTransferableOffersRequest,ListTransferableOffersPagedResponse>

listTransferableSkus(ListTransferableSkusRequest request)

public final CloudChannelServiceClient.ListTransferableSkusPagedResponse listTransferableSkus(ListTransferableSkusRequest request)

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ListTransferableSkusRequest request =
       ListTransferableSkusRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setAuthToken("authToken1450587441")
           .setLanguageCode("languageCode-2092349083")
           .build();
   for (TransferableSku element :
       cloudChannelServiceClient.listTransferableSkus(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	ListTransferableSkusRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
CloudChannelServiceClient.ListTransferableSkusPagedResponse

listTransferableSkusCallable()

public final UnaryCallable<ListTransferableSkusRequest,ListTransferableSkusResponse> listTransferableSkusCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ListTransferableSkusRequest request =
       ListTransferableSkusRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setAuthToken("authToken1450587441")
           .setLanguageCode("languageCode-2092349083")
           .build();
   while (true) {
     ListTransferableSkusResponse response =
         cloudChannelServiceClient.listTransferableSkusCallable().call(request);
     for (TransferableSku element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListTransferableSkusRequest,ListTransferableSkusResponse>

listTransferableSkusPagedCallable()

public final UnaryCallable<ListTransferableSkusRequest,CloudChannelServiceClient.ListTransferableSkusPagedResponse> listTransferableSkusPagedCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ListTransferableSkusRequest request =
       ListTransferableSkusRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setAuthToken("authToken1450587441")
           .setLanguageCode("languageCode-2092349083")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<ListTransferableSkusRequest,ListTransferableSkusPagedResponse>

lookupOffer(LookupOfferRequest request)

public final Offer lookupOffer(LookupOfferRequest request)

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   LookupOfferRequest request =
       LookupOfferRequest.newBuilder()
           .setEntitlement(
               EntitlementName.of("[ACCOUNT]", "[CUSTOMER]", "[ENTITLEMENT]").toString())
           .build();
   Offer response = cloudChannelServiceClient.lookupOffer(request);
 }
 

Parameter

Name	Description
request	LookupOfferRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
Offer

lookupOfferCallable()

public final UnaryCallable<LookupOfferRequest,Offer> lookupOfferCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   LookupOfferRequest request =
       LookupOfferRequest.newBuilder()
           .setEntitlement(
               EntitlementName.of("[ACCOUNT]", "[CUSTOMER]", "[ENTITLEMENT]").toString())
           .build();
   ApiFuture<Offer> future = cloudChannelServiceClient.lookupOfferCallable().futureCall(request);
   // Do something.
   Offer response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<LookupOfferRequest,Offer>

provisionCloudIdentityAsync(ProvisionCloudIdentityRequest request)

public final OperationFuture<Customer,OperationMetadata> provisionCloudIdentityAsync(ProvisionCloudIdentityRequest request)

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ProvisionCloudIdentityRequest request =
       ProvisionCloudIdentityRequest.newBuilder()
           .setCustomer(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString())
           .setCloudIdentityInfo(CloudIdentityInfo.newBuilder().build())
           .setUser(AdminUser.newBuilder().build())
           .setValidateOnly(true)
           .build();
   Customer response = cloudChannelServiceClient.provisionCloudIdentityAsync(request).get();
 }
 

Parameter

Name	Description
request	ProvisionCloudIdentityRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Customer,OperationMetadata>

provisionCloudIdentityCallable()

public final UnaryCallable<ProvisionCloudIdentityRequest,Operation> provisionCloudIdentityCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ProvisionCloudIdentityRequest request =
       ProvisionCloudIdentityRequest.newBuilder()
           .setCustomer(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString())
           .setCloudIdentityInfo(CloudIdentityInfo.newBuilder().build())
           .setUser(AdminUser.newBuilder().build())
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future =
       cloudChannelServiceClient.provisionCloudIdentityCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<ProvisionCloudIdentityRequest,Operation>

provisionCloudIdentityOperationCallable()

public final OperationCallable<ProvisionCloudIdentityRequest,Customer,OperationMetadata> provisionCloudIdentityOperationCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   ProvisionCloudIdentityRequest request =
       ProvisionCloudIdentityRequest.newBuilder()
           .setCustomer(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString())
           .setCloudIdentityInfo(CloudIdentityInfo.newBuilder().build())
           .setUser(AdminUser.newBuilder().build())
           .setValidateOnly(true)
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<ProvisionCloudIdentityRequest,Customer,OperationMetadata>

registerSubscriber(RegisterSubscriberRequest request)

public final RegisterSubscriberResponse registerSubscriber(RegisterSubscriberRequest request)

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

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   RegisterSubscriberRequest request =
       RegisterSubscriberRequest.newBuilder()
           .setAccount("account-1177318867")
           .setServiceAccount("serviceAccount1079137720")
           .build();
   RegisterSubscriberResponse response = cloudChannelServiceClient.registerSubscriber(request);
 }
 

Parameter

Name	Description
request	RegisterSubscriberRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
RegisterSubscriberResponse

registerSubscriberCallable()

public final UnaryCallable<RegisterSubscriberRequest,RegisterSubscriberResponse> registerSubscriberCallable()

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

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   RegisterSubscriberRequest request =
       RegisterSubscriberRequest.newBuilder()
           .setAccount("account-1177318867")
           .setServiceAccount("serviceAccount1079137720")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<RegisterSubscriberRequest,RegisterSubscriberResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

startPaidServiceAsync(StartPaidServiceRequest request)

public final OperationFuture<Entitlement,OperationMetadata> startPaidServiceAsync(StartPaidServiceRequest request)

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   StartPaidServiceRequest request =
       StartPaidServiceRequest.newBuilder()
           .setName("name3373707")
           .setRequestId("requestId693933066")
           .build();
   Entitlement response = cloudChannelServiceClient.startPaidServiceAsync(request).get();
 }
 

Parameter

Name	Description
request	StartPaidServiceRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Entitlement,OperationMetadata>

startPaidServiceCallable()

public final UnaryCallable<StartPaidServiceRequest,Operation> startPaidServiceCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   StartPaidServiceRequest request =
       StartPaidServiceRequest.newBuilder()
           .setName("name3373707")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       cloudChannelServiceClient.startPaidServiceCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<StartPaidServiceRequest,Operation>

startPaidServiceOperationCallable()

public final OperationCallable<StartPaidServiceRequest,Entitlement,OperationMetadata> startPaidServiceOperationCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   StartPaidServiceRequest request =
       StartPaidServiceRequest.newBuilder()
           .setName("name3373707")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<StartPaidServiceRequest,Entitlement,OperationMetadata>

suspendEntitlementAsync(SuspendEntitlementRequest request)

public final OperationFuture<Entitlement,OperationMetadata> suspendEntitlementAsync(SuspendEntitlementRequest request)

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   SuspendEntitlementRequest request =
       SuspendEntitlementRequest.newBuilder()
           .setName("name3373707")
           .setRequestId("requestId693933066")
           .build();
   Entitlement response = cloudChannelServiceClient.suspendEntitlementAsync(request).get();
 }
 

Parameter

Name	Description
request	SuspendEntitlementRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Entitlement,OperationMetadata>

suspendEntitlementCallable()

public final UnaryCallable<SuspendEntitlementRequest,Operation> suspendEntitlementCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   SuspendEntitlementRequest request =
       SuspendEntitlementRequest.newBuilder()
           .setName("name3373707")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       cloudChannelServiceClient.suspendEntitlementCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<SuspendEntitlementRequest,Operation>

suspendEntitlementOperationCallable()

public final OperationCallable<SuspendEntitlementRequest,Entitlement,OperationMetadata> suspendEntitlementOperationCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   SuspendEntitlementRequest request =
       SuspendEntitlementRequest.newBuilder()
           .setName("name3373707")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<SuspendEntitlementRequest,Entitlement,OperationMetadata>

transferEntitlementsAsync(TransferEntitlementsRequest request)

public final OperationFuture<TransferEntitlementsResponse,OperationMetadata> transferEntitlementsAsync(TransferEntitlementsRequest request)

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   TransferEntitlementsRequest request =
       TransferEntitlementsRequest.newBuilder()
           .setParent("parent-995424086")
           .addAllEntitlements(new ArrayList<Entitlement>())
           .setAuthToken("authToken1450587441")
           .setRequestId("requestId693933066")
           .build();
   TransferEntitlementsResponse response =
       cloudChannelServiceClient.transferEntitlementsAsync(request).get();
 }
 

Parameter

Name	Description
request	TransferEntitlementsRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<TransferEntitlementsResponse,OperationMetadata>

transferEntitlementsCallable()

public final UnaryCallable<TransferEntitlementsRequest,Operation> transferEntitlementsCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   TransferEntitlementsRequest request =
       TransferEntitlementsRequest.newBuilder()
           .setParent("parent-995424086")
           .addAllEntitlements(new ArrayList<Entitlement>())
           .setAuthToken("authToken1450587441")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       cloudChannelServiceClient.transferEntitlementsCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<TransferEntitlementsRequest,Operation>

transferEntitlementsOperationCallable()

public final OperationCallable<TransferEntitlementsRequest,TransferEntitlementsResponse,OperationMetadata> transferEntitlementsOperationCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   TransferEntitlementsRequest request =
       TransferEntitlementsRequest.newBuilder()
           .setParent("parent-995424086")
           .addAllEntitlements(new ArrayList<Entitlement>())
           .setAuthToken("authToken1450587441")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<TransferEntitlementsRequest,TransferEntitlementsResponse,OperationMetadata>

transferEntitlementsToGoogleAsync(TransferEntitlementsToGoogleRequest request)

public final OperationFuture<Empty,OperationMetadata> transferEntitlementsToGoogleAsync(TransferEntitlementsToGoogleRequest request)

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   TransferEntitlementsToGoogleRequest request =
       TransferEntitlementsToGoogleRequest.newBuilder()
           .setParent("parent-995424086")
           .addAllEntitlements(new ArrayList<Entitlement>())
           .setRequestId("requestId693933066")
           .build();
   cloudChannelServiceClient.transferEntitlementsToGoogleAsync(request).get();
 }
 

Parameter

Name	Description
request	TransferEntitlementsToGoogleRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Empty,OperationMetadata>

transferEntitlementsToGoogleCallable()

public final UnaryCallable<TransferEntitlementsToGoogleRequest,Operation> transferEntitlementsToGoogleCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   TransferEntitlementsToGoogleRequest request =
       TransferEntitlementsToGoogleRequest.newBuilder()
           .setParent("parent-995424086")
           .addAllEntitlements(new ArrayList<Entitlement>())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       cloudChannelServiceClient.transferEntitlementsToGoogleCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Returns

Type	Description
UnaryCallable<TransferEntitlementsToGoogleRequest,Operation>

transferEntitlementsToGoogleOperationCallable()

public final OperationCallable<TransferEntitlementsToGoogleRequest,Empty,OperationMetadata> transferEntitlementsToGoogleOperationCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   TransferEntitlementsToGoogleRequest request =
       TransferEntitlementsToGoogleRequest.newBuilder()
           .setParent("parent-995424086")
           .addAllEntitlements(new ArrayList<Entitlement>())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<TransferEntitlementsToGoogleRequest,Empty,OperationMetadata>

unregisterSubscriber(UnregisterSubscriberRequest request)

public final UnregisterSubscriberResponse unregisterSubscriber(UnregisterSubscriberRequest request)

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   UnregisterSubscriberRequest request =
       UnregisterSubscriberRequest.newBuilder()
           .setAccount("account-1177318867")
           .setServiceAccount("serviceAccount1079137720")
           .build();
   UnregisterSubscriberResponse response =
       cloudChannelServiceClient.unregisterSubscriber(request);
 }
 

Parameter

Name	Description
request	UnregisterSubscriberRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
UnregisterSubscriberResponse

unregisterSubscriberCallable()

public final UnaryCallable<UnregisterSubscriberRequest,UnregisterSubscriberResponse> unregisterSubscriberCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   UnregisterSubscriberRequest request =
       UnregisterSubscriberRequest.newBuilder()
           .setAccount("account-1177318867")
           .setServiceAccount("serviceAccount1079137720")
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<UnregisterSubscriberRequest,UnregisterSubscriberResponse>

updateChannelPartnerLink(UpdateChannelPartnerLinkRequest request)

public final ChannelPartnerLink updateChannelPartnerLink(UpdateChannelPartnerLinkRequest request)

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 resource.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   UpdateChannelPartnerLinkRequest request =
       UpdateChannelPartnerLinkRequest.newBuilder()
           .setName("name3373707")
           .setChannelPartnerLink(ChannelPartnerLink.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ChannelPartnerLink response = cloudChannelServiceClient.updateChannelPartnerLink(request);
 }
 

Parameter

Name	Description
request	UpdateChannelPartnerLinkRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
ChannelPartnerLink

updateChannelPartnerLinkCallable()

public final UnaryCallable<UpdateChannelPartnerLinkRequest,ChannelPartnerLink> updateChannelPartnerLinkCallable()

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 resource.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   UpdateChannelPartnerLinkRequest request =
       UpdateChannelPartnerLinkRequest.newBuilder()
           .setName("name3373707")
           .setChannelPartnerLink(ChannelPartnerLink.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<UpdateChannelPartnerLinkRequest,ChannelPartnerLink>

updateCustomer(UpdateCustomerRequest request)

public final Customer updateCustomer(UpdateCustomerRequest request)

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   UpdateCustomerRequest request =
       UpdateCustomerRequest.newBuilder()
           .setCustomer(Customer.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Customer response = cloudChannelServiceClient.updateCustomer(request);
 }
 

Parameter

Name	Description
request	UpdateCustomerRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
Customer

updateCustomerCallable()

public final UnaryCallable<UpdateCustomerRequest,Customer> updateCustomerCallable()

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.

Sample code:

 try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) {
   UpdateCustomerRequest request =
       UpdateCustomerRequest.newBuilder()
           .setCustomer(Customer.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Customer> future =
       cloudChannelServiceClient.updateCustomerCallable().futureCall(request);
   // Do something.
   Customer response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<UpdateCustomerRequest,Customer>