Class CloudChannelServiceClient
- java.lang.Object
-
- com.google.cloud.channel.v1.CloudChannelServiceClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource
,AutoCloseable
@Generated("by gapic-generator-java") public class CloudChannelServiceClient extends Object implements com.google.api.gax.core.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: - [Customer][google.cloud.channel.v1.Customer]s: An entity-usually an enterprise-managed by a reseller or distributor.
- [Entitlement][google.cloud.channel.v1.Entitlement]s: 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.
- [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]s: 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:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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:
- 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.
- 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.
- 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:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library CloudChannelServiceSettings cloudChannelServiceSettings = CloudChannelServiceSettings.newBuilder() .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials)) .build(); CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create(cloudChannelServiceSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library CloudChannelServiceSettings cloudChannelServiceSettings = CloudChannelServiceSettings.newBuilder().setEndpoint(myEndpoint).build(); CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create(cloudChannelServiceSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library CloudChannelServiceSettings cloudChannelServiceSettings = CloudChannelServiceSettings.newHttpJsonBuilder().build(); CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create(cloudChannelServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
-
-
Nested Class Summary
-
Constructor Summary
Constructors Modifier Constructor Description protected
CloudChannelServiceClient(CloudChannelServiceSettings settings)
Constructs an instance of CloudChannelServiceClient, using the given settings.protected
CloudChannelServiceClient(CloudChannelServiceStub stub)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description com.google.api.gax.longrunning.OperationFuture<Entitlement,OperationMetadata>
activateEntitlementAsync(ActivateEntitlementRequest request)
Activates a previously suspended entitlement.com.google.api.gax.rpc.UnaryCallable<ActivateEntitlementRequest,com.google.longrunning.Operation>
activateEntitlementCallable()
Activates a previously suspended entitlement.com.google.api.gax.rpc.OperationCallable<ActivateEntitlementRequest,Entitlement,OperationMetadata>
activateEntitlementOperationCallable()
Activates a previously suspended entitlement.boolean
awaitTermination(long duration, TimeUnit unit)
com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>
cancelEntitlementAsync(CancelEntitlementRequest request)
Cancels a previously fulfilled entitlement.com.google.api.gax.rpc.UnaryCallable<CancelEntitlementRequest,com.google.longrunning.Operation>
cancelEntitlementCallable()
Cancels a previously fulfilled entitlement.com.google.api.gax.rpc.OperationCallable<CancelEntitlementRequest,com.google.protobuf.Empty,OperationMetadata>
cancelEntitlementOperationCallable()
Cancels a previously fulfilled entitlement.com.google.api.gax.longrunning.OperationFuture<Entitlement,OperationMetadata>
changeOfferAsync(ChangeOfferRequest request)
Updates the Offer for an existing customer entitlement.com.google.api.gax.rpc.UnaryCallable<ChangeOfferRequest,com.google.longrunning.Operation>
changeOfferCallable()
Updates the Offer for an existing customer entitlement.com.google.api.gax.rpc.OperationCallable<ChangeOfferRequest,Entitlement,OperationMetadata>
changeOfferOperationCallable()
Updates the Offer for an existing customer entitlement.com.google.api.gax.longrunning.OperationFuture<Entitlement,OperationMetadata>
changeParametersAsync(ChangeParametersRequest request)
Change parameters of the entitlement.com.google.api.gax.rpc.UnaryCallable<ChangeParametersRequest,com.google.longrunning.Operation>
changeParametersCallable()
Change parameters of the entitlement.com.google.api.gax.rpc.OperationCallable<ChangeParametersRequest,Entitlement,OperationMetadata>
changeParametersOperationCallable()
Change parameters of the entitlement.com.google.api.gax.longrunning.OperationFuture<Entitlement,OperationMetadata>
changeRenewalSettingsAsync(ChangeRenewalSettingsRequest request)
Updates the renewal settings for an existing customer entitlement.com.google.api.gax.rpc.UnaryCallable<ChangeRenewalSettingsRequest,com.google.longrunning.Operation>
changeRenewalSettingsCallable()
Updates the renewal settings for an existing customer entitlement.com.google.api.gax.rpc.OperationCallable<ChangeRenewalSettingsRequest,Entitlement,OperationMetadata>
changeRenewalSettingsOperationCallable()
Updates the renewal settings for an existing customer entitlement.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.com.google.api.gax.rpc.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.void
close()
static CloudChannelServiceClient
create()
Constructs an instance of CloudChannelServiceClient with default settings.static CloudChannelServiceClient
create(CloudChannelServiceSettings settings)
Constructs an instance of CloudChannelServiceClient, using the given settings.static CloudChannelServiceClient
create(CloudChannelServiceStub stub)
Constructs an instance of CloudChannelServiceClient, using the given stub for making calls.ChannelPartnerLink
createChannelPartnerLink(CreateChannelPartnerLinkRequest request)
Initiates a channel partner link between a distributor and a reseller, or between resellers in an n-tier reseller channel.com.google.api.gax.rpc.UnaryCallable<CreateChannelPartnerLinkRequest,ChannelPartnerLink>
createChannelPartnerLinkCallable()
Initiates a channel partner link between a distributor and a reseller, or between resellers in an n-tier reseller channel.ChannelPartnerRepricingConfig
createChannelPartnerRepricingConfig(ChannelPartnerLinkName parent, ChannelPartnerRepricingConfig channelPartnerRepricingConfig)
Creates a ChannelPartnerRepricingConfig.ChannelPartnerRepricingConfig
createChannelPartnerRepricingConfig(CreateChannelPartnerRepricingConfigRequest request)
Creates a ChannelPartnerRepricingConfig.ChannelPartnerRepricingConfig
createChannelPartnerRepricingConfig(String parent, ChannelPartnerRepricingConfig channelPartnerRepricingConfig)
Creates a ChannelPartnerRepricingConfig.com.google.api.gax.rpc.UnaryCallable<CreateChannelPartnerRepricingConfigRequest,ChannelPartnerRepricingConfig>
createChannelPartnerRepricingConfigCallable()
Creates a ChannelPartnerRepricingConfig.Customer
createCustomer(CreateCustomerRequest request)
Creates a new [Customer][google.cloud.channel.v1.Customer] resource under the reseller or distributor account.com.google.api.gax.rpc.UnaryCallable<CreateCustomerRequest,Customer>
createCustomerCallable()
Creates a new [Customer][google.cloud.channel.v1.Customer] resource under the reseller or distributor account.CustomerRepricingConfig
createCustomerRepricingConfig(CreateCustomerRepricingConfigRequest request)
Creates a CustomerRepricingConfig.CustomerRepricingConfig
createCustomerRepricingConfig(CustomerName parent, CustomerRepricingConfig customerRepricingConfig)
Creates a CustomerRepricingConfig.CustomerRepricingConfig
createCustomerRepricingConfig(String parent, CustomerRepricingConfig customerRepricingConfig)
Creates a CustomerRepricingConfig.com.google.api.gax.rpc.UnaryCallable<CreateCustomerRepricingConfigRequest,CustomerRepricingConfig>
createCustomerRepricingConfigCallable()
Creates a CustomerRepricingConfig.com.google.api.gax.longrunning.OperationFuture<Entitlement,OperationMetadata>
createEntitlementAsync(CreateEntitlementRequest request)
Creates an entitlement for a customer.com.google.api.gax.rpc.UnaryCallable<CreateEntitlementRequest,com.google.longrunning.Operation>
createEntitlementCallable()
Creates an entitlement for a customer.com.google.api.gax.rpc.OperationCallable<CreateEntitlementRequest,Entitlement,OperationMetadata>
createEntitlementOperationCallable()
Creates an entitlement for a customer.void
deleteChannelPartnerRepricingConfig(ChannelPartnerRepricingConfigName name)
Deletes the given [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] permanently.void
deleteChannelPartnerRepricingConfig(DeleteChannelPartnerRepricingConfigRequest request)
Deletes the given [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] permanently.void
deleteChannelPartnerRepricingConfig(String name)
Deletes the given [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] permanently.com.google.api.gax.rpc.UnaryCallable<DeleteChannelPartnerRepricingConfigRequest,com.google.protobuf.Empty>
deleteChannelPartnerRepricingConfigCallable()
Deletes the given [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] permanently.void
deleteCustomer(CustomerName name)
Deletes the given [Customer][google.cloud.channel.v1.Customer] permanently.void
deleteCustomer(DeleteCustomerRequest request)
Deletes the given [Customer][google.cloud.channel.v1.Customer] permanently.void
deleteCustomer(String name)
Deletes the given [Customer][google.cloud.channel.v1.Customer] permanently.com.google.api.gax.rpc.UnaryCallable<DeleteCustomerRequest,com.google.protobuf.Empty>
deleteCustomerCallable()
Deletes the given [Customer][google.cloud.channel.v1.Customer] permanently.void
deleteCustomerRepricingConfig(CustomerRepricingConfigName name)
Deletes the given [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] permanently.void
deleteCustomerRepricingConfig(DeleteCustomerRepricingConfigRequest request)
Deletes the given [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] permanently.void
deleteCustomerRepricingConfig(String name)
Deletes the given [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] permanently.com.google.api.gax.rpc.UnaryCallable<DeleteCustomerRepricingConfigRequest,com.google.protobuf.Empty>
deleteCustomerRepricingConfigCallable()
Deletes the given [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] permanently.ChannelPartnerLink
getChannelPartnerLink(GetChannelPartnerLinkRequest request)
Returns the requested [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource.com.google.api.gax.rpc.UnaryCallable<GetChannelPartnerLinkRequest,ChannelPartnerLink>
getChannelPartnerLinkCallable()
Returns the requested [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink] resource.ChannelPartnerRepricingConfig
getChannelPartnerRepricingConfig(ChannelPartnerRepricingConfigName name)
Gets information about how a Distributor modifies their bill before sending it to a ChannelPartner.ChannelPartnerRepricingConfig
getChannelPartnerRepricingConfig(GetChannelPartnerRepricingConfigRequest request)
Gets information about how a Distributor modifies their bill before sending it to a ChannelPartner.ChannelPartnerRepricingConfig
getChannelPartnerRepricingConfig(String name)
Gets information about how a Distributor modifies their bill before sending it to a ChannelPartner.com.google.api.gax.rpc.UnaryCallable<GetChannelPartnerRepricingConfigRequest,ChannelPartnerRepricingConfig>
getChannelPartnerRepricingConfigCallable()
Gets information about how a Distributor modifies their bill before sending it to a ChannelPartner.Customer
getCustomer(CustomerName name)
Returns the requested [Customer][google.cloud.channel.v1.Customer] resource.Customer
getCustomer(GetCustomerRequest request)
Returns the requested [Customer][google.cloud.channel.v1.Customer] resource.Customer
getCustomer(String name)
Returns the requested [Customer][google.cloud.channel.v1.Customer] resource.com.google.api.gax.rpc.UnaryCallable<GetCustomerRequest,Customer>
getCustomerCallable()
Returns the requested [Customer][google.cloud.channel.v1.Customer] resource.CustomerRepricingConfig
getCustomerRepricingConfig(CustomerRepricingConfigName name)
Gets information about how a Reseller modifies their bill before sending it to a Customer.CustomerRepricingConfig
getCustomerRepricingConfig(GetCustomerRepricingConfigRequest request)
Gets information about how a Reseller modifies their bill before sending it to a Customer.CustomerRepricingConfig
getCustomerRepricingConfig(String name)
Gets information about how a Reseller modifies their bill before sending it to a Customer.com.google.api.gax.rpc.UnaryCallable<GetCustomerRepricingConfigRequest,CustomerRepricingConfig>
getCustomerRepricingConfigCallable()
Gets information about how a Reseller modifies their bill before sending it to a Customer.Entitlement
getEntitlement(GetEntitlementRequest request)
Returns the requested [Entitlement][google.cloud.channel.v1.Entitlement] resource.com.google.api.gax.rpc.UnaryCallable<GetEntitlementRequest,Entitlement>
getEntitlementCallable()
Returns the requested [Entitlement][google.cloud.channel.v1.Entitlement] resource.com.google.api.gax.httpjson.longrunning.OperationsClient
getHttpJsonOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.com.google.longrunning.OperationsClient
getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.CloudChannelServiceSettings
getSettings()
CloudChannelServiceStub
getStub()
Customer
importCustomer(ImportCustomerRequest request)
Imports a [Customer][google.cloud.channel.v1.Customer] from the Cloud Identity associated with the provided Cloud Identity ID or domain before a TransferEntitlements call.com.google.api.gax.rpc.UnaryCallable<ImportCustomerRequest,Customer>
importCustomerCallable()
Imports a [Customer][google.cloud.channel.v1.Customer] from the Cloud Identity associated with the provided Cloud Identity ID or domain before a TransferEntitlements call.boolean
isShutdown()
boolean
isTerminated()
CloudChannelServiceClient.ListChannelPartnerLinksPagedResponse
listChannelPartnerLinks(ListChannelPartnerLinksRequest request)
List [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]s belonging to a distributor.com.google.api.gax.rpc.UnaryCallable<ListChannelPartnerLinksRequest,ListChannelPartnerLinksResponse>
listChannelPartnerLinksCallable()
List [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]s belonging to a distributor.com.google.api.gax.rpc.UnaryCallable<ListChannelPartnerLinksRequest,CloudChannelServiceClient.ListChannelPartnerLinksPagedResponse>
listChannelPartnerLinksPagedCallable()
List [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]s belonging to a distributor.CloudChannelServiceClient.ListChannelPartnerRepricingConfigsPagedResponse
listChannelPartnerRepricingConfigs(ChannelPartnerLinkName parent)
Lists information about how a Reseller modifies their bill before sending it to a ChannelPartner.CloudChannelServiceClient.ListChannelPartnerRepricingConfigsPagedResponse
listChannelPartnerRepricingConfigs(ListChannelPartnerRepricingConfigsRequest request)
Lists information about how a Reseller modifies their bill before sending it to a ChannelPartner.CloudChannelServiceClient.ListChannelPartnerRepricingConfigsPagedResponse
listChannelPartnerRepricingConfigs(String parent)
Lists information about how a Reseller modifies their bill before sending it to a ChannelPartner.com.google.api.gax.rpc.UnaryCallable<ListChannelPartnerRepricingConfigsRequest,ListChannelPartnerRepricingConfigsResponse>
listChannelPartnerRepricingConfigsCallable()
Lists information about how a Reseller modifies their bill before sending it to a ChannelPartner.com.google.api.gax.rpc.UnaryCallable<ListChannelPartnerRepricingConfigsRequest,CloudChannelServiceClient.ListChannelPartnerRepricingConfigsPagedResponse>
listChannelPartnerRepricingConfigsPagedCallable()
Lists information about how a Reseller modifies their bill before sending it to a ChannelPartner.CloudChannelServiceClient.ListCustomerRepricingConfigsPagedResponse
listCustomerRepricingConfigs(CustomerName parent)
Lists information about how a Reseller modifies their bill before sending it to a Customer.CloudChannelServiceClient.ListCustomerRepricingConfigsPagedResponse
listCustomerRepricingConfigs(ListCustomerRepricingConfigsRequest request)
Lists information about how a Reseller modifies their bill before sending it to a Customer.CloudChannelServiceClient.ListCustomerRepricingConfigsPagedResponse
listCustomerRepricingConfigs(String parent)
Lists information about how a Reseller modifies their bill before sending it to a Customer.com.google.api.gax.rpc.UnaryCallable<ListCustomerRepricingConfigsRequest,ListCustomerRepricingConfigsResponse>
listCustomerRepricingConfigsCallable()
Lists information about how a Reseller modifies their bill before sending it to a Customer.com.google.api.gax.rpc.UnaryCallable<ListCustomerRepricingConfigsRequest,CloudChannelServiceClient.ListCustomerRepricingConfigsPagedResponse>
listCustomerRepricingConfigsPagedCallable()
Lists information about how a Reseller modifies their bill before sending it to a Customer.CloudChannelServiceClient.ListCustomersPagedResponse
listCustomers(ListCustomersRequest request)
List [Customer][google.cloud.channel.v1.Customer]s.com.google.api.gax.rpc.UnaryCallable<ListCustomersRequest,ListCustomersResponse>
listCustomersCallable()
List [Customer][google.cloud.channel.v1.Customer]s.com.google.api.gax.rpc.UnaryCallable<ListCustomersRequest,CloudChannelServiceClient.ListCustomersPagedResponse>
listCustomersPagedCallable()
List [Customer][google.cloud.channel.v1.Customer]s.CloudChannelServiceClient.ListEntitlementChangesPagedResponse
listEntitlementChanges(EntitlementName parent)
List entitlement history.CloudChannelServiceClient.ListEntitlementChangesPagedResponse
listEntitlementChanges(ListEntitlementChangesRequest request)
List entitlement history.CloudChannelServiceClient.ListEntitlementChangesPagedResponse
listEntitlementChanges(String parent)
List entitlement history.com.google.api.gax.rpc.UnaryCallable<ListEntitlementChangesRequest,ListEntitlementChangesResponse>
listEntitlementChangesCallable()
List entitlement history.com.google.api.gax.rpc.UnaryCallable<ListEntitlementChangesRequest,CloudChannelServiceClient.ListEntitlementChangesPagedResponse>
listEntitlementChangesPagedCallable()
List entitlement history.CloudChannelServiceClient.ListEntitlementsPagedResponse
listEntitlements(ListEntitlementsRequest request)
Lists [Entitlement][google.cloud.channel.v1.Entitlement]s belonging to a customer.com.google.api.gax.rpc.UnaryCallable<ListEntitlementsRequest,ListEntitlementsResponse>
listEntitlementsCallable()
Lists [Entitlement][google.cloud.channel.v1.Entitlement]s belonging to a customer.com.google.api.gax.rpc.UnaryCallable<ListEntitlementsRequest,CloudChannelServiceClient.ListEntitlementsPagedResponse>
listEntitlementsPagedCallable()
Lists [Entitlement][google.cloud.channel.v1.Entitlement]s belonging to a customer.CloudChannelServiceClient.ListOffersPagedResponse
listOffers(ListOffersRequest request)
Lists the Offers the reseller can sell.com.google.api.gax.rpc.UnaryCallable<ListOffersRequest,ListOffersResponse>
listOffersCallable()
Lists the Offers the reseller can sell.com.google.api.gax.rpc.UnaryCallable<ListOffersRequest,CloudChannelServiceClient.ListOffersPagedResponse>
listOffersPagedCallable()
Lists the Offers the reseller can sell.CloudChannelServiceClient.ListProductsPagedResponse
listProducts(ListProductsRequest request)
Lists the Products the reseller is authorized to sell.com.google.api.gax.rpc.UnaryCallable<ListProductsRequest,ListProductsResponse>
listProductsCallable()
Lists the Products the reseller is authorized to sell.com.google.api.gax.rpc.UnaryCallable<ListProductsRequest,CloudChannelServiceClient.ListProductsPagedResponse>
listProductsPagedCallable()
Lists the Products the reseller is authorized to sell.CloudChannelServiceClient.ListPurchasableOffersPagedResponse
listPurchasableOffers(ListPurchasableOffersRequest request)
Lists the following: Offers that you can purchase for a customer.com.google.api.gax.rpc.UnaryCallable<ListPurchasableOffersRequest,ListPurchasableOffersResponse>
listPurchasableOffersCallable()
Lists the following: Offers that you can purchase for a customer.com.google.api.gax.rpc.UnaryCallable<ListPurchasableOffersRequest,CloudChannelServiceClient.ListPurchasableOffersPagedResponse>
listPurchasableOffersPagedCallable()
Lists the following: Offers that you can purchase for a customer.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.com.google.api.gax.rpc.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.com.google.api.gax.rpc.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.CloudChannelServiceClient.ListSkuGroupBillableSkusPagedResponse
listSkuGroupBillableSkus(ListSkuGroupBillableSkusRequest request)
Lists the Billable SKUs in a given SKU group.CloudChannelServiceClient.ListSkuGroupBillableSkusPagedResponse
listSkuGroupBillableSkus(SkuGroupName parent)
Lists the Billable SKUs in a given SKU group.CloudChannelServiceClient.ListSkuGroupBillableSkusPagedResponse
listSkuGroupBillableSkus(String parent)
Lists the Billable SKUs in a given SKU group.com.google.api.gax.rpc.UnaryCallable<ListSkuGroupBillableSkusRequest,ListSkuGroupBillableSkusResponse>
listSkuGroupBillableSkusCallable()
Lists the Billable SKUs in a given SKU group.com.google.api.gax.rpc.UnaryCallable<ListSkuGroupBillableSkusRequest,CloudChannelServiceClient.ListSkuGroupBillableSkusPagedResponse>
listSkuGroupBillableSkusPagedCallable()
Lists the Billable SKUs in a given SKU group.CloudChannelServiceClient.ListSkuGroupsPagedResponse
listSkuGroups(ListSkuGroupsRequest request)
Lists the Rebilling supported SKU groups the account is authorized to sell.CloudChannelServiceClient.ListSkuGroupsPagedResponse
listSkuGroups(String parent)
Lists the Rebilling supported SKU groups the account is authorized to sell.com.google.api.gax.rpc.UnaryCallable<ListSkuGroupsRequest,ListSkuGroupsResponse>
listSkuGroupsCallable()
Lists the Rebilling supported SKU groups the account is authorized to sell.com.google.api.gax.rpc.UnaryCallable<ListSkuGroupsRequest,CloudChannelServiceClient.ListSkuGroupsPagedResponse>
listSkuGroupsPagedCallable()
Lists the Rebilling supported SKU groups the account is authorized to sell.CloudChannelServiceClient.ListSkusPagedResponse
listSkus(ListSkusRequest request)
Lists the SKUs for a product the reseller is authorized to sell.com.google.api.gax.rpc.UnaryCallable<ListSkusRequest,ListSkusResponse>
listSkusCallable()
Lists the SKUs for a product the reseller is authorized to sell.com.google.api.gax.rpc.UnaryCallable<ListSkusRequest,CloudChannelServiceClient.ListSkusPagedResponse>
listSkusPagedCallable()
Lists the SKUs for a product the reseller is authorized to sell.CloudChannelServiceClient.ListSubscribersPagedResponse
listSubscribers(ListSubscribersRequest request)
Lists service accounts with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account.com.google.api.gax.rpc.UnaryCallable<ListSubscribersRequest,ListSubscribersResponse>
listSubscribersCallable()
Lists service accounts with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account.com.google.api.gax.rpc.UnaryCallable<ListSubscribersRequest,CloudChannelServiceClient.ListSubscribersPagedResponse>
listSubscribersPagedCallable()
Lists service accounts with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account.CloudChannelServiceClient.ListTransferableOffersPagedResponse
listTransferableOffers(ListTransferableOffersRequest request)
List [TransferableOffer][google.cloud.channel.v1.TransferableOffer]s of a customer based on Cloud Identity ID or Customer Name in the request.com.google.api.gax.rpc.UnaryCallable<ListTransferableOffersRequest,ListTransferableOffersResponse>
listTransferableOffersCallable()
List [TransferableOffer][google.cloud.channel.v1.TransferableOffer]s of a customer based on Cloud Identity ID or Customer Name in the request.com.google.api.gax.rpc.UnaryCallable<ListTransferableOffersRequest,CloudChannelServiceClient.ListTransferableOffersPagedResponse>
listTransferableOffersPagedCallable()
List [TransferableOffer][google.cloud.channel.v1.TransferableOffer]s of a customer based on Cloud Identity ID or Customer Name in the request.CloudChannelServiceClient.ListTransferableSkusPagedResponse
listTransferableSkus(ListTransferableSkusRequest request)
List [TransferableSku][google.cloud.channel.v1.TransferableSku]s of a customer based on the Cloud Identity ID or Customer Name in the request.com.google.api.gax.rpc.UnaryCallable<ListTransferableSkusRequest,ListTransferableSkusResponse>
listTransferableSkusCallable()
List [TransferableSku][google.cloud.channel.v1.TransferableSku]s of a customer based on the Cloud Identity ID or Customer Name in the request.com.google.api.gax.rpc.UnaryCallable<ListTransferableSkusRequest,CloudChannelServiceClient.ListTransferableSkusPagedResponse>
listTransferableSkusPagedCallable()
List [TransferableSku][google.cloud.channel.v1.TransferableSku]s of a customer based on the Cloud Identity ID or Customer Name in the request.Offer
lookupOffer(LookupOfferRequest request)
Returns the requested [Offer][google.cloud.channel.v1.Offer] resource.com.google.api.gax.rpc.UnaryCallable<LookupOfferRequest,Offer>
lookupOfferCallable()
Returns the requested [Offer][google.cloud.channel.v1.Offer] resource.com.google.api.gax.longrunning.OperationFuture<Customer,OperationMetadata>
provisionCloudIdentityAsync(ProvisionCloudIdentityRequest request)
Creates a Cloud Identity for the given customer using the customer's information, or the information provided here.com.google.api.gax.rpc.UnaryCallable<ProvisionCloudIdentityRequest,com.google.longrunning.Operation>
provisionCloudIdentityCallable()
Creates a Cloud Identity for the given customer using the customer's information, or the information provided here.com.google.api.gax.rpc.OperationCallable<ProvisionCloudIdentityRequest,Customer,OperationMetadata>
provisionCloudIdentityOperationCallable()
Creates a Cloud Identity for the given customer using the customer's information, or the information provided here.QueryEligibleBillingAccountsResponse
queryEligibleBillingAccounts(QueryEligibleBillingAccountsRequest request)
Lists the billing accounts that are eligible to purchase particular SKUs for a given customer.com.google.api.gax.rpc.UnaryCallable<QueryEligibleBillingAccountsRequest,QueryEligibleBillingAccountsResponse>
queryEligibleBillingAccountsCallable()
Lists the billing accounts that are eligible to purchase particular SKUs for a given customer.RegisterSubscriberResponse
registerSubscriber(RegisterSubscriberRequest request)
Registers a service account with subscriber privileges on the Cloud Pub/Sub topic for this Channel Services account.com.google.api.gax.rpc.UnaryCallable<RegisterSubscriberRequest,RegisterSubscriberResponse>
registerSubscriberCallable()
Registers a service account with subscriber privileges on the Cloud Pub/Sub topic for this Channel Services account.void
shutdown()
void
shutdownNow()
com.google.api.gax.longrunning.OperationFuture<Entitlement,OperationMetadata>
startPaidServiceAsync(StartPaidServiceRequest request)
Starts paid service for a trial entitlement.com.google.api.gax.rpc.UnaryCallable<StartPaidServiceRequest,com.google.longrunning.Operation>
startPaidServiceCallable()
Starts paid service for a trial entitlement.com.google.api.gax.rpc.OperationCallable<StartPaidServiceRequest,Entitlement,OperationMetadata>
startPaidServiceOperationCallable()
Starts paid service for a trial entitlement.com.google.api.gax.longrunning.OperationFuture<Entitlement,OperationMetadata>
suspendEntitlementAsync(SuspendEntitlementRequest request)
Suspends a previously fulfilled entitlement.com.google.api.gax.rpc.UnaryCallable<SuspendEntitlementRequest,com.google.longrunning.Operation>
suspendEntitlementCallable()
Suspends a previously fulfilled entitlement.com.google.api.gax.rpc.OperationCallable<SuspendEntitlementRequest,Entitlement,OperationMetadata>
suspendEntitlementOperationCallable()
Suspends a previously fulfilled entitlement.com.google.api.gax.longrunning.OperationFuture<TransferEntitlementsResponse,OperationMetadata>
transferEntitlementsAsync(TransferEntitlementsRequest request)
Transfers customer entitlements to new reseller.com.google.api.gax.rpc.UnaryCallable<TransferEntitlementsRequest,com.google.longrunning.Operation>
transferEntitlementsCallable()
Transfers customer entitlements to new reseller.com.google.api.gax.rpc.OperationCallable<TransferEntitlementsRequest,TransferEntitlementsResponse,OperationMetadata>
transferEntitlementsOperationCallable()
Transfers customer entitlements to new reseller.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>
transferEntitlementsToGoogleAsync(TransferEntitlementsToGoogleRequest request)
Transfers customer entitlements from their current reseller to Google.com.google.api.gax.rpc.UnaryCallable<TransferEntitlementsToGoogleRequest,com.google.longrunning.Operation>
transferEntitlementsToGoogleCallable()
Transfers customer entitlements from their current reseller to Google.com.google.api.gax.rpc.OperationCallable<TransferEntitlementsToGoogleRequest,com.google.protobuf.Empty,OperationMetadata>
transferEntitlementsToGoogleOperationCallable()
Transfers customer entitlements from their current reseller to Google.UnregisterSubscriberResponse
unregisterSubscriber(UnregisterSubscriberRequest request)
Unregisters a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account.com.google.api.gax.rpc.UnaryCallable<UnregisterSubscriberRequest,UnregisterSubscriberResponse>
unregisterSubscriberCallable()
Unregisters a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account.ChannelPartnerLink
updateChannelPartnerLink(UpdateChannelPartnerLinkRequest request)
Updates a channel partner link.com.google.api.gax.rpc.UnaryCallable<UpdateChannelPartnerLinkRequest,ChannelPartnerLink>
updateChannelPartnerLinkCallable()
Updates a channel partner link.ChannelPartnerRepricingConfig
updateChannelPartnerRepricingConfig(ChannelPartnerRepricingConfig channelPartnerRepricingConfig)
Updates a ChannelPartnerRepricingConfig.ChannelPartnerRepricingConfig
updateChannelPartnerRepricingConfig(UpdateChannelPartnerRepricingConfigRequest request)
Updates a ChannelPartnerRepricingConfig.com.google.api.gax.rpc.UnaryCallable<UpdateChannelPartnerRepricingConfigRequest,ChannelPartnerRepricingConfig>
updateChannelPartnerRepricingConfigCallable()
Updates a ChannelPartnerRepricingConfig.Customer
updateCustomer(UpdateCustomerRequest request)
Updates an existing [Customer][google.cloud.channel.v1.Customer] resource for the reseller or distributor.com.google.api.gax.rpc.UnaryCallable<UpdateCustomerRequest,Customer>
updateCustomerCallable()
Updates an existing [Customer][google.cloud.channel.v1.Customer] resource for the reseller or distributor.CustomerRepricingConfig
updateCustomerRepricingConfig(CustomerRepricingConfig customerRepricingConfig)
Updates a CustomerRepricingConfig.CustomerRepricingConfig
updateCustomerRepricingConfig(UpdateCustomerRepricingConfigRequest request)
Updates a CustomerRepricingConfig.com.google.api.gax.rpc.UnaryCallable<UpdateCustomerRepricingConfigRequest,CustomerRepricingConfig>
updateCustomerRepricingConfigCallable()
Updates a CustomerRepricingConfig.
-
-
-
Constructor Detail
-
CloudChannelServiceClient
protected CloudChannelServiceClient(CloudChannelServiceSettings settings) throws IOException
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.- Throws:
IOException
-
CloudChannelServiceClient
protected CloudChannelServiceClient(CloudChannelServiceStub stub)
-
-
Method Detail
-
create
public static final CloudChannelServiceClient create() throws IOException
Constructs an instance of CloudChannelServiceClient with default settings.- Throws:
IOException
-
create
public static final CloudChannelServiceClient create(CloudChannelServiceSettings settings) throws IOException
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.- Throws:
IOException
-
create
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).
-
getSettings
public final CloudChannelServiceSettings getSettings()
-
getStub
public CloudChannelServiceStub getStub()
-
getOperationsClient
public final com.google.longrunning.OperationsClient getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
-
getHttpJsonOperationsClient
@BetaApi public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
-
listCustomers
public final CloudChannelServiceClient.ListCustomersPagedResponse listCustomers(ListCustomersRequest request)
List [Customer][google.cloud.channel.v1.Customer]s.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 [Customer][google.cloud.channel.v1.Customer]s, or an empty list if there are no customers.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { ListCustomersRequest request = ListCustomersRequest.newBuilder() .setParent("parent-995424086") .setPageSize(883849137) .setPageToken("pageToken873572522") .setFilter("filter-1274492040") .build(); for (Customer element : cloudChannelServiceClient.listCustomers(request).iterateAll()) { // doThingsWith(element); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listCustomersPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<ListCustomersRequest,CloudChannelServiceClient.ListCustomersPagedResponse> listCustomersPagedCallable()
List [Customer][google.cloud.channel.v1.Customer]s.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 [Customer][google.cloud.channel.v1.Customer]s, or an empty list if there are no customers.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { ListCustomersRequest request = ListCustomersRequest.newBuilder() .setParent("parent-995424086") .setPageSize(883849137) .setPageToken("pageToken873572522") .setFilter("filter-1274492040") .build(); ApiFuture<Customer> future = cloudChannelServiceClient.listCustomersPagedCallable().futureCall(request); // Do something. for (Customer element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listCustomersCallable
public final com.google.api.gax.rpc.UnaryCallable<ListCustomersRequest,ListCustomersResponse> listCustomersCallable()
List [Customer][google.cloud.channel.v1.Customer]s.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 [Customer][google.cloud.channel.v1.Customer]s, or an empty list if there are no customers.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { ListCustomersRequest request = ListCustomersRequest.newBuilder() .setParent("parent-995424086") .setPageSize(883849137) .setPageToken("pageToken873572522") .setFilter("filter-1274492040") .build(); while (true) { ListCustomersResponse response = cloudChannelServiceClient.listCustomersCallable().call(request); for (Customer element : response.getCustomersList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
getCustomer
public final Customer getCustomer(CustomerName name)
Returns the requested [Customer][google.cloud.channel.v1.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][google.cloud.channel.v1.Customer] resource.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { CustomerName name = CustomerName.of("[ACCOUNT]", "[CUSTOMER]"); Customer response = cloudChannelServiceClient.getCustomer(name); }
- Parameters:
name
- Required. The resource name of the customer to retrieve. Name uses the format: accounts/{account_id}/customers/{customer_id}- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getCustomer
public final Customer getCustomer(String name)
Returns the requested [Customer][google.cloud.channel.v1.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][google.cloud.channel.v1.Customer] resource.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { String name = CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString(); Customer response = cloudChannelServiceClient.getCustomer(name); }
- Parameters:
name
- Required. The resource name of the customer to retrieve. Name uses the format: accounts/{account_id}/customers/{customer_id}- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getCustomer
public final Customer getCustomer(GetCustomerRequest request)
Returns the requested [Customer][google.cloud.channel.v1.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][google.cloud.channel.v1.Customer] resource.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { GetCustomerRequest request = GetCustomerRequest.newBuilder() .setName(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString()) .build(); Customer response = cloudChannelServiceClient.getCustomer(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getCustomerCallable
public final com.google.api.gax.rpc.UnaryCallable<GetCustomerRequest,Customer> getCustomerCallable()
Returns the requested [Customer][google.cloud.channel.v1.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][google.cloud.channel.v1.Customer] resource.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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(); }
-
checkCloudIdentityAccountsExist
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][google.cloud.channel.v1.CloudIdentityCustomerAccount] resources for the domain (may be empty)
Note: in the v1alpha1 version of the API, a NOT_FOUND error returns if no [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] resources match the domain.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { CheckCloudIdentityAccountsExistRequest request = CheckCloudIdentityAccountsExistRequest.newBuilder() .setParent("parent-995424086") .setDomain("domain-1326197564") .build(); CheckCloudIdentityAccountsExistResponse response = cloudChannelServiceClient.checkCloudIdentityAccountsExist(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
checkCloudIdentityAccountsExistCallable
public final com.google.api.gax.rpc.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][google.cloud.channel.v1.CloudIdentityCustomerAccount] resources for the domain (may be empty)
Note: in the v1alpha1 version of the API, a NOT_FOUND error returns if no [CloudIdentityCustomerAccount][google.cloud.channel.v1.CloudIdentityCustomerAccount] resources match the domain.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { CheckCloudIdentityAccountsExistRequest request = CheckCloudIdentityAccountsExistRequest.newBuilder() .setParent("parent-995424086") .setDomain("domain-1326197564") .build(); ApiFuture<CheckCloudIdentityAccountsExistResponse> future = cloudChannelServiceClient.checkCloudIdentityAccountsExistCallable().futureCall(request); // Do something. CheckCloudIdentityAccountsExistResponse response = future.get(); }
-
createCustomer
public final Customer createCustomer(CreateCustomerRequest request)
Creates a new [Customer][google.cloud.channel.v1.Customer] resource under the reseller or distributor account.Possible error codes:
- PERMISSION_DENIED: * The reseller account making the request is different from the reseller account in the API request. * You are not authorized to create a customer. See https://support.google.com/channelservices/answer/9759265
- INVALID_ARGUMENT: * Required request parameters are missing or invalid. * Domain field value doesn't match the primary email domain.
Return value: The newly created [Customer][google.cloud.channel.v1.Customer] resource.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { CreateCustomerRequest request = CreateCustomerRequest.newBuilder() .setParent("parent-995424086") .setCustomer(Customer.newBuilder().build()) .build(); Customer response = cloudChannelServiceClient.createCustomer(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createCustomerCallable
public final com.google.api.gax.rpc.UnaryCallable<CreateCustomerRequest,Customer> createCustomerCallable()
Creates a new [Customer][google.cloud.channel.v1.Customer] resource under the reseller or distributor account.Possible error codes:
- PERMISSION_DENIED: * The reseller account making the request is different from the reseller account in the API request. * You are not authorized to create a customer. See https://support.google.com/channelservices/answer/9759265
- INVALID_ARGUMENT: * Required request parameters are missing or invalid. * Domain field value doesn't match the primary email domain.
Return value: The newly created [Customer][google.cloud.channel.v1.Customer] resource.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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(); }
-
updateCustomer
public final Customer updateCustomer(UpdateCustomerRequest request)
Updates an existing [Customer][google.cloud.channel.v1.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][google.cloud.channel.v1.Customer] resource found for the name in the request.
Return value: The updated [Customer][google.cloud.channel.v1.Customer] resource.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { UpdateCustomerRequest request = UpdateCustomerRequest.newBuilder() .setCustomer(Customer.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); Customer response = cloudChannelServiceClient.updateCustomer(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateCustomerCallable
public final com.google.api.gax.rpc.UnaryCallable<UpdateCustomerRequest,Customer> updateCustomerCallable()
Updates an existing [Customer][google.cloud.channel.v1.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][google.cloud.channel.v1.Customer] resource found for the name in the request.
Return value: The updated [Customer][google.cloud.channel.v1.Customer] resource.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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(); }
-
deleteCustomer
public final void deleteCustomer(CustomerName name)
Deletes the given [Customer][google.cloud.channel.v1.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][google.cloud.channel.v1.Customer] resource found for the name in the request.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { CustomerName name = CustomerName.of("[ACCOUNT]", "[CUSTOMER]"); cloudChannelServiceClient.deleteCustomer(name); }
- Parameters:
name
- Required. The resource name of the customer to delete.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteCustomer
public final void deleteCustomer(String name)
Deletes the given [Customer][google.cloud.channel.v1.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][google.cloud.channel.v1.Customer] resource found for the name in the request.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { String name = CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString(); cloudChannelServiceClient.deleteCustomer(name); }
- Parameters:
name
- Required. The resource name of the customer to delete.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteCustomer
public final void deleteCustomer(DeleteCustomerRequest request)
Deletes the given [Customer][google.cloud.channel.v1.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][google.cloud.channel.v1.Customer] resource found for the name in the request.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { DeleteCustomerRequest request = DeleteCustomerRequest.newBuilder() .setName(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString()) .build(); cloudChannelServiceClient.deleteCustomer(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteCustomerCallable
public final com.google.api.gax.rpc.UnaryCallable<DeleteCustomerRequest,com.google.protobuf.Empty> deleteCustomerCallable()
Deletes the given [Customer][google.cloud.channel.v1.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][google.cloud.channel.v1.Customer] resource found for the name in the request.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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(); }
-
importCustomer
public final Customer importCustomer(ImportCustomerRequest request)
Imports a [Customer][google.cloud.channel.v1.Customer] from the Cloud Identity associated with the provided Cloud Identity ID or domain before a TransferEntitlements call. If a linked Customer already exists and overwrite_if_exists is true, it will update that Customer's data.Possible error codes:
- PERMISSION_DENIED: * The reseller account making the request is different from the reseller account in the API request. * You are not authorized to import the customer. See https://support.google.com/channelservices/answer/9759265
- NOT_FOUND: Cloud Identity doesn't exist or was deleted.
- INVALID_ARGUMENT: Required parameters are missing, or the auth_token is expired or invalid.
- ALREADY_EXISTS: A customer already exists and has conflicting critical fields. Requires an overwrite.
Return value: The [Customer][google.cloud.channel.v1.Customer].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
importCustomerCallable
public final com.google.api.gax.rpc.UnaryCallable<ImportCustomerRequest,Customer> importCustomerCallable()
Imports a [Customer][google.cloud.channel.v1.Customer] from the Cloud Identity associated with the provided Cloud Identity ID or domain before a TransferEntitlements call. If a linked Customer already exists and overwrite_if_exists is true, it will update that Customer's data.Possible error codes:
- PERMISSION_DENIED: * The reseller account making the request is different from the reseller account in the API request. * You are not authorized to import the customer. See https://support.google.com/channelservices/answer/9759265
- NOT_FOUND: Cloud Identity doesn't exist or was deleted.
- INVALID_ARGUMENT: Required parameters are missing, or the auth_token is expired or invalid.
- ALREADY_EXISTS: A customer already exists and has conflicting critical fields. Requires an overwrite.
Return value: The [Customer][google.cloud.channel.v1.Customer].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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(); }
-
provisionCloudIdentityAsync
public final com.google.api.gax.longrunning.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. * You are not authorized to provision cloud identity id. See https://support.google.com/channelservices/answer/9759265
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- NOT_FOUND: The customer was not found.
- ALREADY_EXISTS: The customer's primary email already exists. Retry after changing the customer's primary contact email.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata contains an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
provisionCloudIdentityOperationCallable
public final com.google.api.gax.rpc.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. * You are not authorized to provision cloud identity id. See https://support.google.com/channelservices/answer/9759265
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- NOT_FOUND: The customer was not found.
- ALREADY_EXISTS: The customer's primary email already exists. Retry after changing the customer's primary contact email.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata contains an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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<Customer, OperationMetadata> future = cloudChannelServiceClient.provisionCloudIdentityOperationCallable().futureCall(request); // Do something. Customer response = future.get(); }
-
provisionCloudIdentityCallable
public final com.google.api.gax.rpc.UnaryCallable<ProvisionCloudIdentityRequest,com.google.longrunning.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. * You are not authorized to provision cloud identity id. See https://support.google.com/channelservices/answer/9759265
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- NOT_FOUND: The customer was not found.
- ALREADY_EXISTS: The customer's primary email already exists. Retry after changing the customer's primary contact email.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata contains an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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(); }
-
listEntitlements
public final CloudChannelServiceClient.ListEntitlementsPagedResponse listEntitlements(ListEntitlementsRequest request)
Lists [Entitlement][google.cloud.channel.v1.Entitlement]s 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 [Entitlement][google.cloud.channel.v1.Entitlement]s.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listEntitlementsPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<ListEntitlementsRequest,CloudChannelServiceClient.ListEntitlementsPagedResponse> listEntitlementsPagedCallable()
Lists [Entitlement][google.cloud.channel.v1.Entitlement]s 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 [Entitlement][google.cloud.channel.v1.Entitlement]s.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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); } }
-
listEntitlementsCallable
public final com.google.api.gax.rpc.UnaryCallable<ListEntitlementsRequest,ListEntitlementsResponse> listEntitlementsCallable()
Lists [Entitlement][google.cloud.channel.v1.Entitlement]s 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 [Entitlement][google.cloud.channel.v1.Entitlement]s.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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.getEntitlementsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
listTransferableSkus
public final CloudChannelServiceClient.ListTransferableSkusPagedResponse listTransferableSkus(ListTransferableSkusRequest request)
List [TransferableSku][google.cloud.channel.v1.TransferableSku]s 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][google.cloud.channel.v1.TransferableSku].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listTransferableSkusPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<ListTransferableSkusRequest,CloudChannelServiceClient.ListTransferableSkusPagedResponse> listTransferableSkusPagedCallable()
List [TransferableSku][google.cloud.channel.v1.TransferableSku]s 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][google.cloud.channel.v1.TransferableSku].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { ListTransferableSkusRequest request = ListTransferableSkusRequest.newBuilder() .setParent("parent-995424086") .setPageSize(883849137) .setPageToken("pageToken873572522") .setAuthToken("authToken1450587441") .setLanguageCode("languageCode-2092349083") .build(); ApiFuture<TransferableSku> future = cloudChannelServiceClient.listTransferableSkusPagedCallable().futureCall(request); // Do something. for (TransferableSku element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listTransferableSkusCallable
public final com.google.api.gax.rpc.UnaryCallable<ListTransferableSkusRequest,ListTransferableSkusResponse> listTransferableSkusCallable()
List [TransferableSku][google.cloud.channel.v1.TransferableSku]s 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][google.cloud.channel.v1.TransferableSku].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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.getTransferableSkusList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
listTransferableOffers
public final CloudChannelServiceClient.ListTransferableOffersPagedResponse listTransferableOffers(ListTransferableOffersRequest request)
List [TransferableOffer][google.cloud.channel.v1.TransferableOffer]s of a customer based on Cloud Identity ID or Customer Name in the request.Use this method when a reseller gets the entitlement information of an unowned customer. The reseller should provide the customer's Cloud Identity ID or Customer Name.
Possible error codes:
- PERMISSION_DENIED: * The customer doesn't belong to the reseller and has no auth token. * The customer provided incorrect reseller information when generating auth token. * The reseller account making the request is different from the reseller account in the query. * The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
Return value: List of [TransferableOffer][google.cloud.channel.v1.TransferableOffer] for the given customer and SKU.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { ListTransferableOffersRequest request = ListTransferableOffersRequest.newBuilder() .setParent("parent-995424086") .setPageSize(883849137) .setPageToken("pageToken873572522") .setSku("sku113949") .setLanguageCode("languageCode-2092349083") .setBillingAccount("billingAccount708726578") .build(); for (TransferableOffer element : cloudChannelServiceClient.listTransferableOffers(request).iterateAll()) { // doThingsWith(element); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listTransferableOffersPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<ListTransferableOffersRequest,CloudChannelServiceClient.ListTransferableOffersPagedResponse> listTransferableOffersPagedCallable()
List [TransferableOffer][google.cloud.channel.v1.TransferableOffer]s of a customer based on Cloud Identity ID or Customer Name in the request.Use this method when a reseller gets the entitlement information of an unowned customer. The reseller should provide the customer's Cloud Identity ID or Customer Name.
Possible error codes:
- PERMISSION_DENIED: * The customer doesn't belong to the reseller and has no auth token. * The customer provided incorrect reseller information when generating auth token. * The reseller account making the request is different from the reseller account in the query. * The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
Return value: List of [TransferableOffer][google.cloud.channel.v1.TransferableOffer] for the given customer and SKU.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { ListTransferableOffersRequest request = ListTransferableOffersRequest.newBuilder() .setParent("parent-995424086") .setPageSize(883849137) .setPageToken("pageToken873572522") .setSku("sku113949") .setLanguageCode("languageCode-2092349083") .setBillingAccount("billingAccount708726578") .build(); ApiFuture<TransferableOffer> future = cloudChannelServiceClient.listTransferableOffersPagedCallable().futureCall(request); // Do something. for (TransferableOffer element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listTransferableOffersCallable
public final com.google.api.gax.rpc.UnaryCallable<ListTransferableOffersRequest,ListTransferableOffersResponse> listTransferableOffersCallable()
List [TransferableOffer][google.cloud.channel.v1.TransferableOffer]s of a customer based on Cloud Identity ID or Customer Name in the request.Use this method when a reseller gets the entitlement information of an unowned customer. The reseller should provide the customer's Cloud Identity ID or Customer Name.
Possible error codes:
- PERMISSION_DENIED: * The customer doesn't belong to the reseller and has no auth token. * The customer provided incorrect reseller information when generating auth token. * The reseller account making the request is different from the reseller account in the query. * The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
Return value: List of [TransferableOffer][google.cloud.channel.v1.TransferableOffer] for the given customer and SKU.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { ListTransferableOffersRequest request = ListTransferableOffersRequest.newBuilder() .setParent("parent-995424086") .setPageSize(883849137) .setPageToken("pageToken873572522") .setSku("sku113949") .setLanguageCode("languageCode-2092349083") .setBillingAccount("billingAccount708726578") .build(); while (true) { ListTransferableOffersResponse response = cloudChannelServiceClient.listTransferableOffersCallable().call(request); for (TransferableOffer element : response.getTransferableOffersList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
getEntitlement
public final Entitlement getEntitlement(GetEntitlementRequest request)
Returns the requested [Entitlement][google.cloud.channel.v1.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][google.cloud.channel.v1.Entitlement] resource.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { GetEntitlementRequest request = GetEntitlementRequest.newBuilder() .setName(EntitlementName.of("[ACCOUNT]", "[CUSTOMER]", "[ENTITLEMENT]").toString()) .build(); Entitlement response = cloudChannelServiceClient.getEntitlement(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getEntitlementCallable
public final com.google.api.gax.rpc.UnaryCallable<GetEntitlementRequest,Entitlement> getEntitlementCallable()
Returns the requested [Entitlement][google.cloud.channel.v1.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][google.cloud.channel.v1.Entitlement] resource.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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(); }
-
createEntitlementAsync
public final com.google.api.gax.longrunning.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. * The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265
- INVALID_ARGUMENT: * Required request parameters are missing or invalid. * There is already a customer entitlement for a SKU from the same product family.
- INVALID_VALUE: Make sure the OfferId is valid. If it is, contact Google Channel support for further troubleshooting.
- NOT_FOUND: The customer or offer resource was not found.
- ALREADY_EXISTS: * The SKU was already purchased for the customer. * The customer's primary email already exists. Retry after changing the customer's primary contact email.
- CONDITION_NOT_MET or FAILED_PRECONDITION: * The domain required for purchasing a SKU has not been verified. * A pre-requisite SKU required to purchase an Add-On SKU is missing. For example, Google Workspace Business Starter is required to purchase Vault or Drive. * (Developer accounts only) Reseller and resold domain must meet the following naming requirements: * Domain names must start with goog-test. * Domain names must include the reseller domain.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createEntitlementOperationCallable
public final com.google.api.gax.rpc.OperationCallable<CreateEntitlementRequest,Entitlement,OperationMetadata> createEntitlementOperationCallable()
Creates an entitlement for a customer.Possible error codes:
- PERMISSION_DENIED: * The customer doesn't belong to the reseller. * The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265
- INVALID_ARGUMENT: * Required request parameters are missing or invalid. * There is already a customer entitlement for a SKU from the same product family.
- INVALID_VALUE: Make sure the OfferId is valid. If it is, contact Google Channel support for further troubleshooting.
- NOT_FOUND: The customer or offer resource was not found.
- ALREADY_EXISTS: * The SKU was already purchased for the customer. * The customer's primary email already exists. Retry after changing the customer's primary contact email.
- CONDITION_NOT_MET or FAILED_PRECONDITION: * The domain required for purchasing a SKU has not been verified. * A pre-requisite SKU required to purchase an Add-On SKU is missing. For example, Google Workspace Business Starter is required to purchase Vault or Drive. * (Developer accounts only) Reseller and resold domain must meet the following naming requirements: * Domain names must start with goog-test. * Domain names must include the reseller domain.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { CreateEntitlementRequest request = CreateEntitlementRequest.newBuilder() .setParent(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString()) .setEntitlement(Entitlement.newBuilder().build()) .setRequestId("requestId693933066") .build(); OperationFuture<Entitlement, OperationMetadata> future = cloudChannelServiceClient.createEntitlementOperationCallable().futureCall(request); // Do something. Entitlement response = future.get(); }
-
createEntitlementCallable
public final com.google.api.gax.rpc.UnaryCallable<CreateEntitlementRequest,com.google.longrunning.Operation> createEntitlementCallable()
Creates an entitlement for a customer.Possible error codes:
- PERMISSION_DENIED: * The customer doesn't belong to the reseller. * The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265
- INVALID_ARGUMENT: * Required request parameters are missing or invalid. * There is already a customer entitlement for a SKU from the same product family.
- INVALID_VALUE: Make sure the OfferId is valid. If it is, contact Google Channel support for further troubleshooting.
- NOT_FOUND: The customer or offer resource was not found.
- ALREADY_EXISTS: * The SKU was already purchased for the customer. * The customer's primary email already exists. Retry after changing the customer's primary contact email.
- CONDITION_NOT_MET or FAILED_PRECONDITION: * The domain required for purchasing a SKU has not been verified. * A pre-requisite SKU required to purchase an Add-On SKU is missing. For example, Google Workspace Business Starter is required to purchase Vault or Drive. * (Developer accounts only) Reseller and resold domain must meet the following naming requirements: * Domain names must start with goog-test. * Domain names must include the reseller domain.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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(); }
-
changeParametersAsync
public final com.google.api.gax.longrunning.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][google.cloud.channel.v1.OperationMetadata].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
changeParametersOperationCallable
public final com.google.api.gax.rpc.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][google.cloud.channel.v1.OperationMetadata].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { ChangeParametersRequest request = ChangeParametersRequest.newBuilder() .setName("name3373707") .addAllParameters(new ArrayList<Parameter>()) .setRequestId("requestId693933066") .setPurchaseOrderId("purchaseOrderId2029917384") .build(); OperationFuture<Entitlement, OperationMetadata> future = cloudChannelServiceClient.changeParametersOperationCallable().futureCall(request); // Do something. Entitlement response = future.get(); }
-
changeParametersCallable
public final com.google.api.gax.rpc.UnaryCallable<ChangeParametersRequest,com.google.longrunning.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][google.cloud.channel.v1.OperationMetadata].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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(); }
-
changeRenewalSettingsAsync
public final com.google.api.gax.longrunning.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][google.cloud.channel.v1.OperationMetadata].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { ChangeRenewalSettingsRequest request = ChangeRenewalSettingsRequest.newBuilder() .setName("name3373707") .setRenewalSettings(RenewalSettings.newBuilder().build()) .setRequestId("requestId693933066") .build(); Entitlement response = cloudChannelServiceClient.changeRenewalSettingsAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
changeRenewalSettingsOperationCallable
public final com.google.api.gax.rpc.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][google.cloud.channel.v1.OperationMetadata].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { ChangeRenewalSettingsRequest request = ChangeRenewalSettingsRequest.newBuilder() .setName("name3373707") .setRenewalSettings(RenewalSettings.newBuilder().build()) .setRequestId("requestId693933066") .build(); OperationFuture<Entitlement, OperationMetadata> future = cloudChannelServiceClient.changeRenewalSettingsOperationCallable().futureCall(request); // Do something. Entitlement response = future.get(); }
-
changeRenewalSettingsCallable
public final com.google.api.gax.rpc.UnaryCallable<ChangeRenewalSettingsRequest,com.google.longrunning.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][google.cloud.channel.v1.OperationMetadata].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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(); }
-
changeOfferAsync
public final com.google.api.gax.longrunning.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][google.cloud.channel.v1.OperationMetadata].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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") .setBillingAccount("billingAccount708726578") .build(); Entitlement response = cloudChannelServiceClient.changeOfferAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
changeOfferOperationCallable
public final com.google.api.gax.rpc.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][google.cloud.channel.v1.OperationMetadata].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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") .setBillingAccount("billingAccount708726578") .build(); OperationFuture<Entitlement, OperationMetadata> future = cloudChannelServiceClient.changeOfferOperationCallable().futureCall(request); // Do something. Entitlement response = future.get(); }
-
changeOfferCallable
public final com.google.api.gax.rpc.UnaryCallable<ChangeOfferRequest,com.google.longrunning.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][google.cloud.channel.v1.OperationMetadata].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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") .setBillingAccount("billingAccount708726578") .build(); ApiFuture<Operation> future = cloudChannelServiceClient.changeOfferCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
startPaidServiceAsync
public final com.google.api.gax.longrunning.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][google.cloud.channel.v1.OperationMetadata].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { StartPaidServiceRequest request = StartPaidServiceRequest.newBuilder() .setName("name3373707") .setRequestId("requestId693933066") .build(); Entitlement response = cloudChannelServiceClient.startPaidServiceAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
startPaidServiceOperationCallable
public final com.google.api.gax.rpc.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][google.cloud.channel.v1.OperationMetadata].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { StartPaidServiceRequest request = StartPaidServiceRequest.newBuilder() .setName("name3373707") .setRequestId("requestId693933066") .build(); OperationFuture<Entitlement, OperationMetadata> future = cloudChannelServiceClient.startPaidServiceOperationCallable().futureCall(request); // Do something. Entitlement response = future.get(); }
-
startPaidServiceCallable
public final com.google.api.gax.rpc.UnaryCallable<StartPaidServiceRequest,com.google.longrunning.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][google.cloud.channel.v1.OperationMetadata].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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(); }
-
suspendEntitlementAsync
public final com.google.api.gax.longrunning.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][google.cloud.channel.v1.OperationMetadata].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { SuspendEntitlementRequest request = SuspendEntitlementRequest.newBuilder() .setName("name3373707") .setRequestId("requestId693933066") .build(); Entitlement response = cloudChannelServiceClient.suspendEntitlementAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
suspendEntitlementOperationCallable
public final com.google.api.gax.rpc.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][google.cloud.channel.v1.OperationMetadata].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { SuspendEntitlementRequest request = SuspendEntitlementRequest.newBuilder() .setName("name3373707") .setRequestId("requestId693933066") .build(); OperationFuture<Entitlement, OperationMetadata> future = cloudChannelServiceClient.suspendEntitlementOperationCallable().futureCall(request); // Do something. Entitlement response = future.get(); }
-
suspendEntitlementCallable
public final com.google.api.gax.rpc.UnaryCallable<SuspendEntitlementRequest,com.google.longrunning.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][google.cloud.channel.v1.OperationMetadata].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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(); }
-
cancelEntitlementAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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][google.cloud.channel.v1.OperationMetadata].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { CancelEntitlementRequest request = CancelEntitlementRequest.newBuilder() .setName("name3373707") .setRequestId("requestId693933066") .build(); cloudChannelServiceClient.cancelEntitlementAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
cancelEntitlementOperationCallable
public final com.google.api.gax.rpc.OperationCallable<CancelEntitlementRequest,com.google.protobuf.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][google.cloud.channel.v1.OperationMetadata].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { CancelEntitlementRequest request = CancelEntitlementRequest.newBuilder() .setName("name3373707") .setRequestId("requestId693933066") .build(); OperationFuture<Empty, OperationMetadata> future = cloudChannelServiceClient.cancelEntitlementOperationCallable().futureCall(request); // Do something. future.get(); }
-
cancelEntitlementCallable
public final com.google.api.gax.rpc.UnaryCallable<CancelEntitlementRequest,com.google.longrunning.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][google.cloud.channel.v1.OperationMetadata].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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(); }
-
activateEntitlementAsync
public final com.google.api.gax.longrunning.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][google.cloud.channel.v1.OperationMetadata].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { ActivateEntitlementRequest request = ActivateEntitlementRequest.newBuilder() .setName("name3373707") .setRequestId("requestId693933066") .build(); Entitlement response = cloudChannelServiceClient.activateEntitlementAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
activateEntitlementOperationCallable
public final com.google.api.gax.rpc.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][google.cloud.channel.v1.OperationMetadata].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { ActivateEntitlementRequest request = ActivateEntitlementRequest.newBuilder() .setName("name3373707") .setRequestId("requestId693933066") .build(); OperationFuture<Entitlement, OperationMetadata> future = cloudChannelServiceClient.activateEntitlementOperationCallable().futureCall(request); // Do something. Entitlement response = future.get(); }
-
activateEntitlementCallable
public final com.google.api.gax.rpc.UnaryCallable<ActivateEntitlementRequest,com.google.longrunning.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][google.cloud.channel.v1.OperationMetadata].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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(); }
-
transferEntitlementsAsync
public final com.google.api.gax.longrunning.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. * The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- NOT_FOUND: The customer or offer resource was not found.
- ALREADY_EXISTS: The SKU was already transferred for the customer.
- CONDITION_NOT_MET or FAILED_PRECONDITION: * The SKU requires domain verification to transfer, but the domain is not verified. * An Add-On SKU (example, Vault or Drive) is missing the pre-requisite SKU (example, G Suite Basic). * (Developer accounts only) Reseller and resold domain must meet the following naming requirements: * Domain names must start with goog-test. * Domain names must include the reseller domain. * Specify all transferring entitlements.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
transferEntitlementsOperationCallable
public final com.google.api.gax.rpc.OperationCallable<TransferEntitlementsRequest,TransferEntitlementsResponse,OperationMetadata> transferEntitlementsOperationCallable()
Transfers customer entitlements to new reseller.Possible error codes:
- PERMISSION_DENIED: * The customer doesn't belong to the reseller. * The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- NOT_FOUND: The customer or offer resource was not found.
- ALREADY_EXISTS: The SKU was already transferred for the customer.
- CONDITION_NOT_MET or FAILED_PRECONDITION: * The SKU requires domain verification to transfer, but the domain is not verified. * An Add-On SKU (example, Vault or Drive) is missing the pre-requisite SKU (example, G Suite Basic). * (Developer accounts only) Reseller and resold domain must meet the following naming requirements: * Domain names must start with goog-test. * Domain names must include the reseller domain. * Specify all transferring entitlements.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { TransferEntitlementsRequest request = TransferEntitlementsRequest.newBuilder() .setParent("parent-995424086") .addAllEntitlements(new ArrayList<Entitlement>()) .setAuthToken("authToken1450587441") .setRequestId("requestId693933066") .build(); OperationFuture<TransferEntitlementsResponse, OperationMetadata> future = cloudChannelServiceClient.transferEntitlementsOperationCallable().futureCall(request); // Do something. TransferEntitlementsResponse response = future.get(); }
-
transferEntitlementsCallable
public final com.google.api.gax.rpc.UnaryCallable<TransferEntitlementsRequest,com.google.longrunning.Operation> transferEntitlementsCallable()
Transfers customer entitlements to new reseller.Possible error codes:
- PERMISSION_DENIED: * The customer doesn't belong to the reseller. * The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
- NOT_FOUND: The customer or offer resource was not found.
- ALREADY_EXISTS: The SKU was already transferred for the customer.
- CONDITION_NOT_MET or FAILED_PRECONDITION: * The SKU requires domain verification to transfer, but the domain is not verified. * An Add-On SKU (example, Vault or Drive) is missing the pre-requisite SKU (example, G Suite Basic). * (Developer accounts only) Reseller and resold domain must meet the following naming requirements: * Domain names must start with goog-test. * Domain names must include the reseller domain. * Specify all transferring entitlements.
- INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support.
Return value: The ID of a long-running operation.
To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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(); }
-
transferEntitlementsToGoogleAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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][google.cloud.channel.v1.OperationMetadata].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { TransferEntitlementsToGoogleRequest request = TransferEntitlementsToGoogleRequest.newBuilder() .setParent("parent-995424086") .addAllEntitlements(new ArrayList<Entitlement>()) .setRequestId("requestId693933066") .build(); cloudChannelServiceClient.transferEntitlementsToGoogleAsync(request).get(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
transferEntitlementsToGoogleOperationCallable
public final com.google.api.gax.rpc.OperationCallable<TransferEntitlementsToGoogleRequest,com.google.protobuf.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][google.cloud.channel.v1.OperationMetadata].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { TransferEntitlementsToGoogleRequest request = TransferEntitlementsToGoogleRequest.newBuilder() .setParent("parent-995424086") .addAllEntitlements(new ArrayList<Entitlement>()) .setRequestId("requestId693933066") .build(); OperationFuture<Empty, OperationMetadata> future = cloudChannelServiceClient .transferEntitlementsToGoogleOperationCallable() .futureCall(request); // Do something. future.get(); }
-
transferEntitlementsToGoogleCallable
public final com.google.api.gax.rpc.UnaryCallable<TransferEntitlementsToGoogleRequest,com.google.longrunning.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][google.cloud.channel.v1.OperationMetadata].
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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(); }
-
listChannelPartnerLinks
public final CloudChannelServiceClient.ListChannelPartnerLinksPagedResponse listChannelPartnerLinks(ListChannelPartnerLinksRequest request)
List [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]s 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][google.cloud.channel.v1.ChannelPartnerLink] resources.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listChannelPartnerLinksPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<ListChannelPartnerLinksRequest,CloudChannelServiceClient.ListChannelPartnerLinksPagedResponse> listChannelPartnerLinksPagedCallable()
List [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]s 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][google.cloud.channel.v1.ChannelPartnerLink] resources.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { ListChannelPartnerLinksRequest request = ListChannelPartnerLinksRequest.newBuilder() .setParent("parent-995424086") .setPageSize(883849137) .setPageToken("pageToken873572522") .setView(ChannelPartnerLinkView.forNumber(0)) .build(); ApiFuture<ChannelPartnerLink> future = cloudChannelServiceClient.listChannelPartnerLinksPagedCallable().futureCall(request); // Do something. for (ChannelPartnerLink element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listChannelPartnerLinksCallable
public final com.google.api.gax.rpc.UnaryCallable<ListChannelPartnerLinksRequest,ListChannelPartnerLinksResponse> listChannelPartnerLinksCallable()
List [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]s 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][google.cloud.channel.v1.ChannelPartnerLink] resources.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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.getChannelPartnerLinksList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
getChannelPartnerLink
public final ChannelPartnerLink getChannelPartnerLink(GetChannelPartnerLinkRequest request)
Returns the requested [ChannelPartnerLink][google.cloud.channel.v1.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][google.cloud.channel.v1.ChannelPartnerLink] resource.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { GetChannelPartnerLinkRequest request = GetChannelPartnerLinkRequest.newBuilder() .setName("name3373707") .setView(ChannelPartnerLinkView.forNumber(0)) .build(); ChannelPartnerLink response = cloudChannelServiceClient.getChannelPartnerLink(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getChannelPartnerLinkCallable
public final com.google.api.gax.rpc.UnaryCallable<GetChannelPartnerLinkRequest,ChannelPartnerLink> getChannelPartnerLinkCallable()
Returns the requested [ChannelPartnerLink][google.cloud.channel.v1.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][google.cloud.channel.v1.ChannelPartnerLink] resource.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { GetChannelPartnerLinkRequest request = GetChannelPartnerLinkRequest.newBuilder() .setName("name3373707") .setView(ChannelPartnerLinkView.forNumber(0)) .build(); ApiFuture<ChannelPartnerLink> future = cloudChannelServiceClient.getChannelPartnerLinkCallable().futureCall(request); // Do something. ChannelPartnerLink response = future.get(); }
-
createChannelPartnerLink
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][google.cloud.channel.v1.ChannelPartnerLink] resource.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { CreateChannelPartnerLinkRequest request = CreateChannelPartnerLinkRequest.newBuilder() .setParent("parent-995424086") .setChannelPartnerLink(ChannelPartnerLink.newBuilder().build()) .build(); ChannelPartnerLink response = cloudChannelServiceClient.createChannelPartnerLink(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createChannelPartnerLinkCallable
public final com.google.api.gax.rpc.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][google.cloud.channel.v1.ChannelPartnerLink] resource.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { CreateChannelPartnerLinkRequest request = CreateChannelPartnerLinkRequest.newBuilder() .setParent("parent-995424086") .setChannelPartnerLink(ChannelPartnerLink.newBuilder().build()) .build(); ApiFuture<ChannelPartnerLink> future = cloudChannelServiceClient.createChannelPartnerLinkCallable().futureCall(request); // Do something. ChannelPartnerLink response = future.get(); }
-
updateChannelPartnerLink
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][google.cloud.channel.v1.ChannelPartnerLink] resource.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateChannelPartnerLinkCallable
public final com.google.api.gax.rpc.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][google.cloud.channel.v1.ChannelPartnerLink] resource.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { UpdateChannelPartnerLinkRequest request = UpdateChannelPartnerLinkRequest.newBuilder() .setName("name3373707") .setChannelPartnerLink(ChannelPartnerLink.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); ApiFuture<ChannelPartnerLink> future = cloudChannelServiceClient.updateChannelPartnerLinkCallable().futureCall(request); // Do something. ChannelPartnerLink response = future.get(); }
-
getCustomerRepricingConfig
public final CustomerRepricingConfig getCustomerRepricingConfig(CustomerRepricingConfigName name)
Gets information about how a Reseller modifies their bill before sending it to a Customer.Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] was not found.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resource, otherwise returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { CustomerRepricingConfigName name = CustomerRepricingConfigName.of("[ACCOUNT]", "[CUSTOMER]", "[CUSTOMER_REPRICING_CONFIG]"); CustomerRepricingConfig response = cloudChannelServiceClient.getCustomerRepricingConfig(name); }
- Parameters:
name
- Required. The resource name of the CustomerRepricingConfig. Format: accounts/{account_id}/customers/{customer_id}/customerRepricingConfigs/{id}.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getCustomerRepricingConfig
public final CustomerRepricingConfig getCustomerRepricingConfig(String name)
Gets information about how a Reseller modifies their bill before sending it to a Customer.Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] was not found.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resource, otherwise returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { String name = CustomerRepricingConfigName.of("[ACCOUNT]", "[CUSTOMER]", "[CUSTOMER_REPRICING_CONFIG]") .toString(); CustomerRepricingConfig response = cloudChannelServiceClient.getCustomerRepricingConfig(name); }
- Parameters:
name
- Required. The resource name of the CustomerRepricingConfig. Format: accounts/{account_id}/customers/{customer_id}/customerRepricingConfigs/{id}.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getCustomerRepricingConfig
public final CustomerRepricingConfig getCustomerRepricingConfig(GetCustomerRepricingConfigRequest request)
Gets information about how a Reseller modifies their bill before sending it to a Customer.Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] was not found.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resource, otherwise returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { GetCustomerRepricingConfigRequest request = GetCustomerRepricingConfigRequest.newBuilder() .setName( CustomerRepricingConfigName.of( "[ACCOUNT]", "[CUSTOMER]", "[CUSTOMER_REPRICING_CONFIG]") .toString()) .build(); CustomerRepricingConfig response = cloudChannelServiceClient.getCustomerRepricingConfig(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getCustomerRepricingConfigCallable
public final com.google.api.gax.rpc.UnaryCallable<GetCustomerRepricingConfigRequest,CustomerRepricingConfig> getCustomerRepricingConfigCallable()
Gets information about how a Reseller modifies their bill before sending it to a Customer.Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] was not found.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resource, otherwise returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { GetCustomerRepricingConfigRequest request = GetCustomerRepricingConfigRequest.newBuilder() .setName( CustomerRepricingConfigName.of( "[ACCOUNT]", "[CUSTOMER]", "[CUSTOMER_REPRICING_CONFIG]") .toString()) .build(); ApiFuture<CustomerRepricingConfig> future = cloudChannelServiceClient.getCustomerRepricingConfigCallable().futureCall(request); // Do something. CustomerRepricingConfig response = future.get(); }
-
listCustomerRepricingConfigs
public final CloudChannelServiceClient.ListCustomerRepricingConfigsPagedResponse listCustomerRepricingConfigs(CustomerName parent)
Lists information about how a Reseller modifies their bill before sending it to a Customer.Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] specified does not exist or is not associated with the given account.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resources. The data for each resource is displayed in the ascending order of:
- Customer ID
- [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement]
- [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month]
- [CustomerRepricingConfig.update_time][google.cloud.channel.v1.CustomerRepricingConfig.update_time]
If unsuccessful, returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { CustomerName parent = CustomerName.of("[ACCOUNT]", "[CUSTOMER]"); for (CustomerRepricingConfig element : cloudChannelServiceClient.listCustomerRepricingConfigs(parent).iterateAll()) { // doThingsWith(element); } }
- Parameters:
parent
- Required. The resource name of the customer. Parent uses the format: accounts/{account_id}/customers/{customer_id}. Supports accounts/{account_id}/customers/- to retrieve configs for all customers.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listCustomerRepricingConfigs
public final CloudChannelServiceClient.ListCustomerRepricingConfigsPagedResponse listCustomerRepricingConfigs(String parent)
Lists information about how a Reseller modifies their bill before sending it to a Customer.Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] specified does not exist or is not associated with the given account.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resources. The data for each resource is displayed in the ascending order of:
- Customer ID
- [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement]
- [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month]
- [CustomerRepricingConfig.update_time][google.cloud.channel.v1.CustomerRepricingConfig.update_time]
If unsuccessful, returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { String parent = CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString(); for (CustomerRepricingConfig element : cloudChannelServiceClient.listCustomerRepricingConfigs(parent).iterateAll()) { // doThingsWith(element); } }
- Parameters:
parent
- Required. The resource name of the customer. Parent uses the format: accounts/{account_id}/customers/{customer_id}. Supports accounts/{account_id}/customers/- to retrieve configs for all customers.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listCustomerRepricingConfigs
public final CloudChannelServiceClient.ListCustomerRepricingConfigsPagedResponse listCustomerRepricingConfigs(ListCustomerRepricingConfigsRequest request)
Lists information about how a Reseller modifies their bill before sending it to a Customer.Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] specified does not exist or is not associated with the given account.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resources. The data for each resource is displayed in the ascending order of:
- Customer ID
- [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement]
- [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month]
- [CustomerRepricingConfig.update_time][google.cloud.channel.v1.CustomerRepricingConfig.update_time]
If unsuccessful, returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { ListCustomerRepricingConfigsRequest request = ListCustomerRepricingConfigsRequest.newBuilder() .setParent(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setFilter("filter-1274492040") .build(); for (CustomerRepricingConfig element : cloudChannelServiceClient.listCustomerRepricingConfigs(request).iterateAll()) { // doThingsWith(element); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listCustomerRepricingConfigsPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<ListCustomerRepricingConfigsRequest,CloudChannelServiceClient.ListCustomerRepricingConfigsPagedResponse> listCustomerRepricingConfigsPagedCallable()
Lists information about how a Reseller modifies their bill before sending it to a Customer.Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] specified does not exist or is not associated with the given account.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resources. The data for each resource is displayed in the ascending order of:
- Customer ID
- [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement]
- [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month]
- [CustomerRepricingConfig.update_time][google.cloud.channel.v1.CustomerRepricingConfig.update_time]
If unsuccessful, returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { ListCustomerRepricingConfigsRequest request = ListCustomerRepricingConfigsRequest.newBuilder() .setParent(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setFilter("filter-1274492040") .build(); ApiFuture<CustomerRepricingConfig> future = cloudChannelServiceClient.listCustomerRepricingConfigsPagedCallable().futureCall(request); // Do something. for (CustomerRepricingConfig element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listCustomerRepricingConfigsCallable
public final com.google.api.gax.rpc.UnaryCallable<ListCustomerRepricingConfigsRequest,ListCustomerRepricingConfigsResponse> listCustomerRepricingConfigsCallable()
Lists information about how a Reseller modifies their bill before sending it to a Customer.Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] specified does not exist or is not associated with the given account.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resources. The data for each resource is displayed in the ascending order of:
- Customer ID
- [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement]
- [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month]
- [CustomerRepricingConfig.update_time][google.cloud.channel.v1.CustomerRepricingConfig.update_time]
If unsuccessful, returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { ListCustomerRepricingConfigsRequest request = ListCustomerRepricingConfigsRequest.newBuilder() .setParent(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setFilter("filter-1274492040") .build(); while (true) { ListCustomerRepricingConfigsResponse response = cloudChannelServiceClient.listCustomerRepricingConfigsCallable().call(request); for (CustomerRepricingConfig element : response.getCustomerRepricingConfigsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
createCustomerRepricingConfig
public final CustomerRepricingConfig createCustomerRepricingConfig(CustomerName parent, CustomerRepricingConfig customerRepricingConfig)
Creates a CustomerRepricingConfig. Call this method to set modifications for a specific customer's bill. You can only create configs if the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is a future month. If needed, you can create a config for the current month, with some restrictions.When creating a config for a future month, make sure there are no existing configs for that [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].
The following restrictions are for creating configs in the current month.
- This functionality is reserved for recovering from an erroneous config, and should not be used for regular business cases.
- The new config will not modify exports used with other configs. Changes to the config may be immediate, but may take up to 24 hours.
- There is a limit of ten configs for any [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement], for any [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].
- The contained [CustomerRepricingConfig.repricing_config][google.cloud.channel.v1.CustomerRepricingConfig.repricing_config] value must be different from the value used in the current config for a [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement].
Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.
- NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] specified does not exist or is not associated with the given account.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the updated [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resource, otherwise returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { CustomerName parent = CustomerName.of("[ACCOUNT]", "[CUSTOMER]"); CustomerRepricingConfig customerRepricingConfig = CustomerRepricingConfig.newBuilder().build(); CustomerRepricingConfig response = cloudChannelServiceClient.createCustomerRepricingConfig(parent, customerRepricingConfig); }
- Parameters:
parent
- Required. The resource name of the customer that will receive this repricing config. Parent uses the format: accounts/{account_id}/customers/{customer_id}customerRepricingConfig
- Required. The CustomerRepricingConfig object to update.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createCustomerRepricingConfig
public final CustomerRepricingConfig createCustomerRepricingConfig(String parent, CustomerRepricingConfig customerRepricingConfig)
Creates a CustomerRepricingConfig. Call this method to set modifications for a specific customer's bill. You can only create configs if the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is a future month. If needed, you can create a config for the current month, with some restrictions.When creating a config for a future month, make sure there are no existing configs for that [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].
The following restrictions are for creating configs in the current month.
- This functionality is reserved for recovering from an erroneous config, and should not be used for regular business cases.
- The new config will not modify exports used with other configs. Changes to the config may be immediate, but may take up to 24 hours.
- There is a limit of ten configs for any [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement], for any [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].
- The contained [CustomerRepricingConfig.repricing_config][google.cloud.channel.v1.CustomerRepricingConfig.repricing_config] value must be different from the value used in the current config for a [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement].
Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.
- NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] specified does not exist or is not associated with the given account.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the updated [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resource, otherwise returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { String parent = CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString(); CustomerRepricingConfig customerRepricingConfig = CustomerRepricingConfig.newBuilder().build(); CustomerRepricingConfig response = cloudChannelServiceClient.createCustomerRepricingConfig(parent, customerRepricingConfig); }
- Parameters:
parent
- Required. The resource name of the customer that will receive this repricing config. Parent uses the format: accounts/{account_id}/customers/{customer_id}customerRepricingConfig
- Required. The CustomerRepricingConfig object to update.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createCustomerRepricingConfig
public final CustomerRepricingConfig createCustomerRepricingConfig(CreateCustomerRepricingConfigRequest request)
Creates a CustomerRepricingConfig. Call this method to set modifications for a specific customer's bill. You can only create configs if the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is a future month. If needed, you can create a config for the current month, with some restrictions.When creating a config for a future month, make sure there are no existing configs for that [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].
The following restrictions are for creating configs in the current month.
- This functionality is reserved for recovering from an erroneous config, and should not be used for regular business cases.
- The new config will not modify exports used with other configs. Changes to the config may be immediate, but may take up to 24 hours.
- There is a limit of ten configs for any [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement], for any [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].
- The contained [CustomerRepricingConfig.repricing_config][google.cloud.channel.v1.CustomerRepricingConfig.repricing_config] value must be different from the value used in the current config for a [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement].
Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.
- NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] specified does not exist or is not associated with the given account.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the updated [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resource, otherwise returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { CreateCustomerRepricingConfigRequest request = CreateCustomerRepricingConfigRequest.newBuilder() .setParent(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString()) .setCustomerRepricingConfig(CustomerRepricingConfig.newBuilder().build()) .build(); CustomerRepricingConfig response = cloudChannelServiceClient.createCustomerRepricingConfig(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createCustomerRepricingConfigCallable
public final com.google.api.gax.rpc.UnaryCallable<CreateCustomerRepricingConfigRequest,CustomerRepricingConfig> createCustomerRepricingConfigCallable()
Creates a CustomerRepricingConfig. Call this method to set modifications for a specific customer's bill. You can only create configs if the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is a future month. If needed, you can create a config for the current month, with some restrictions.When creating a config for a future month, make sure there are no existing configs for that [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].
The following restrictions are for creating configs in the current month.
- This functionality is reserved for recovering from an erroneous config, and should not be used for regular business cases.
- The new config will not modify exports used with other configs. Changes to the config may be immediate, but may take up to 24 hours.
- There is a limit of ten configs for any [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement], for any [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].
- The contained [CustomerRepricingConfig.repricing_config][google.cloud.channel.v1.CustomerRepricingConfig.repricing_config] value must be different from the value used in the current config for a [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement].
Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.
- NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] specified does not exist or is not associated with the given account.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the updated [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resource, otherwise returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { CreateCustomerRepricingConfigRequest request = CreateCustomerRepricingConfigRequest.newBuilder() .setParent(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString()) .setCustomerRepricingConfig(CustomerRepricingConfig.newBuilder().build()) .build(); ApiFuture<CustomerRepricingConfig> future = cloudChannelServiceClient.createCustomerRepricingConfigCallable().futureCall(request); // Do something. CustomerRepricingConfig response = future.get(); }
-
updateCustomerRepricingConfig
public final CustomerRepricingConfig updateCustomerRepricingConfig(CustomerRepricingConfig customerRepricingConfig)
Updates a CustomerRepricingConfig. Call this method to set modifications for a specific customer's bill. This method overwrites the existing CustomerRepricingConfig.You can only update configs if the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is a future month. To make changes to configs for the current month, use [CreateCustomerRepricingConfig][google.cloud.channel.v1.CloudChannelService.CreateCustomerRepricingConfig], taking note of its restrictions. You cannot update the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].
When updating a config in the future:
- This config must already exist.
Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.
- NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] specified does not exist or is not associated with the given account.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the updated [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resource, otherwise returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { CustomerRepricingConfig customerRepricingConfig = CustomerRepricingConfig.newBuilder().build(); CustomerRepricingConfig response = cloudChannelServiceClient.updateCustomerRepricingConfig(customerRepricingConfig); }
- Parameters:
customerRepricingConfig
- Required. The CustomerRepricingConfig object to update.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateCustomerRepricingConfig
public final CustomerRepricingConfig updateCustomerRepricingConfig(UpdateCustomerRepricingConfigRequest request)
Updates a CustomerRepricingConfig. Call this method to set modifications for a specific customer's bill. This method overwrites the existing CustomerRepricingConfig.You can only update configs if the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is a future month. To make changes to configs for the current month, use [CreateCustomerRepricingConfig][google.cloud.channel.v1.CloudChannelService.CreateCustomerRepricingConfig], taking note of its restrictions. You cannot update the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].
When updating a config in the future:
- This config must already exist.
Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.
- NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] specified does not exist or is not associated with the given account.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the updated [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resource, otherwise returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { UpdateCustomerRepricingConfigRequest request = UpdateCustomerRepricingConfigRequest.newBuilder() .setCustomerRepricingConfig(CustomerRepricingConfig.newBuilder().build()) .build(); CustomerRepricingConfig response = cloudChannelServiceClient.updateCustomerRepricingConfig(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateCustomerRepricingConfigCallable
public final com.google.api.gax.rpc.UnaryCallable<UpdateCustomerRepricingConfigRequest,CustomerRepricingConfig> updateCustomerRepricingConfigCallable()
Updates a CustomerRepricingConfig. Call this method to set modifications for a specific customer's bill. This method overwrites the existing CustomerRepricingConfig.You can only update configs if the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is a future month. To make changes to configs for the current month, use [CreateCustomerRepricingConfig][google.cloud.channel.v1.CloudChannelService.CreateCustomerRepricingConfig], taking note of its restrictions. You cannot update the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].
When updating a config in the future:
- This config must already exist.
Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.
- NOT_FOUND: The [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] specified does not exist or is not associated with the given account.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the updated [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] resource, otherwise returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { UpdateCustomerRepricingConfigRequest request = UpdateCustomerRepricingConfigRequest.newBuilder() .setCustomerRepricingConfig(CustomerRepricingConfig.newBuilder().build()) .build(); ApiFuture<CustomerRepricingConfig> future = cloudChannelServiceClient.updateCustomerRepricingConfigCallable().futureCall(request); // Do something. CustomerRepricingConfig response = future.get(); }
-
deleteCustomerRepricingConfig
public final void deleteCustomerRepricingConfig(CustomerRepricingConfigName name)
Deletes the given [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] permanently. You can only delete configs if their [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is set to a date after the current month.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 [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] is active or in the past.
- NOT_FOUND: No [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] found for the name in the request.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { CustomerRepricingConfigName name = CustomerRepricingConfigName.of("[ACCOUNT]", "[CUSTOMER]", "[CUSTOMER_REPRICING_CONFIG]"); cloudChannelServiceClient.deleteCustomerRepricingConfig(name); }
- Parameters:
name
- Required. The resource name of the customer repricing config rule to delete. Format: accounts/{account_id}/customers/{customer_id}/customerRepricingConfigs/{id}.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteCustomerRepricingConfig
public final void deleteCustomerRepricingConfig(String name)
Deletes the given [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] permanently. You can only delete configs if their [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is set to a date after the current month.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 [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] is active or in the past.
- NOT_FOUND: No [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] found for the name in the request.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { String name = CustomerRepricingConfigName.of("[ACCOUNT]", "[CUSTOMER]", "[CUSTOMER_REPRICING_CONFIG]") .toString(); cloudChannelServiceClient.deleteCustomerRepricingConfig(name); }
- Parameters:
name
- Required. The resource name of the customer repricing config rule to delete. Format: accounts/{account_id}/customers/{customer_id}/customerRepricingConfigs/{id}.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteCustomerRepricingConfig
public final void deleteCustomerRepricingConfig(DeleteCustomerRepricingConfigRequest request)
Deletes the given [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] permanently. You can only delete configs if their [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is set to a date after the current month.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 [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] is active or in the past.
- NOT_FOUND: No [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] found for the name in the request.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { DeleteCustomerRepricingConfigRequest request = DeleteCustomerRepricingConfigRequest.newBuilder() .setName( CustomerRepricingConfigName.of( "[ACCOUNT]", "[CUSTOMER]", "[CUSTOMER_REPRICING_CONFIG]") .toString()) .build(); cloudChannelServiceClient.deleteCustomerRepricingConfig(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteCustomerRepricingConfigCallable
public final com.google.api.gax.rpc.UnaryCallable<DeleteCustomerRepricingConfigRequest,com.google.protobuf.Empty> deleteCustomerRepricingConfigCallable()
Deletes the given [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] permanently. You can only delete configs if their [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is set to a date after the current month.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 [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] is active or in the past.
- NOT_FOUND: No [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig] found for the name in the request.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { DeleteCustomerRepricingConfigRequest request = DeleteCustomerRepricingConfigRequest.newBuilder() .setName( CustomerRepricingConfigName.of( "[ACCOUNT]", "[CUSTOMER]", "[CUSTOMER_REPRICING_CONFIG]") .toString()) .build(); ApiFuture<Empty> future = cloudChannelServiceClient.deleteCustomerRepricingConfigCallable().futureCall(request); // Do something. future.get(); }
-
getChannelPartnerRepricingConfig
public final ChannelPartnerRepricingConfig getChannelPartnerRepricingConfig(ChannelPartnerRepricingConfigName name)
Gets information about how a Distributor modifies their bill before sending it to a ChannelPartner.Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] was not found.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resource, otherwise returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { ChannelPartnerRepricingConfigName name = ChannelPartnerRepricingConfigName.of( "[ACCOUNT]", "[CHANNEL_PARTNER]", "[CHANNEL_PARTNER_REPRICING_CONFIG]"); ChannelPartnerRepricingConfig response = cloudChannelServiceClient.getChannelPartnerRepricingConfig(name); }
- Parameters:
name
- Required. The resource name of the ChannelPartnerRepricingConfig Format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}/channelPartnerRepricingConfigs/{id}.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getChannelPartnerRepricingConfig
public final ChannelPartnerRepricingConfig getChannelPartnerRepricingConfig(String name)
Gets information about how a Distributor modifies their bill before sending it to a ChannelPartner.Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] was not found.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resource, otherwise returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { String name = ChannelPartnerRepricingConfigName.of( "[ACCOUNT]", "[CHANNEL_PARTNER]", "[CHANNEL_PARTNER_REPRICING_CONFIG]") .toString(); ChannelPartnerRepricingConfig response = cloudChannelServiceClient.getChannelPartnerRepricingConfig(name); }
- Parameters:
name
- Required. The resource name of the ChannelPartnerRepricingConfig Format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}/channelPartnerRepricingConfigs/{id}.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getChannelPartnerRepricingConfig
public final ChannelPartnerRepricingConfig getChannelPartnerRepricingConfig(GetChannelPartnerRepricingConfigRequest request)
Gets information about how a Distributor modifies their bill before sending it to a ChannelPartner.Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] was not found.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resource, otherwise returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { GetChannelPartnerRepricingConfigRequest request = GetChannelPartnerRepricingConfigRequest.newBuilder() .setName( ChannelPartnerRepricingConfigName.of( "[ACCOUNT]", "[CHANNEL_PARTNER]", "[CHANNEL_PARTNER_REPRICING_CONFIG]") .toString()) .build(); ChannelPartnerRepricingConfig response = cloudChannelServiceClient.getChannelPartnerRepricingConfig(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getChannelPartnerRepricingConfigCallable
public final com.google.api.gax.rpc.UnaryCallable<GetChannelPartnerRepricingConfigRequest,ChannelPartnerRepricingConfig> getChannelPartnerRepricingConfigCallable()
Gets information about how a Distributor modifies their bill before sending it to a ChannelPartner.Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] was not found.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resource, otherwise returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { GetChannelPartnerRepricingConfigRequest request = GetChannelPartnerRepricingConfigRequest.newBuilder() .setName( ChannelPartnerRepricingConfigName.of( "[ACCOUNT]", "[CHANNEL_PARTNER]", "[CHANNEL_PARTNER_REPRICING_CONFIG]") .toString()) .build(); ApiFuture<ChannelPartnerRepricingConfig> future = cloudChannelServiceClient.getChannelPartnerRepricingConfigCallable().futureCall(request); // Do something. ChannelPartnerRepricingConfig response = future.get(); }
-
listChannelPartnerRepricingConfigs
public final CloudChannelServiceClient.ListChannelPartnerRepricingConfigsPagedResponse listChannelPartnerRepricingConfigs(ChannelPartnerLinkName parent)
Lists information about how a Reseller modifies their bill before sending it to a ChannelPartner.Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] specified does not exist or is not associated with the given account.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resources. The data for each resource is displayed in the ascending order of:
- Channel Partner ID
- [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month]
- [ChannelPartnerRepricingConfig.update_time][google.cloud.channel.v1.ChannelPartnerRepricingConfig.update_time]
If unsuccessful, returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { ChannelPartnerLinkName parent = ChannelPartnerLinkName.of("[ACCOUNT]", "[CHANNEL_PARTNER_LINK]"); for (ChannelPartnerRepricingConfig element : cloudChannelServiceClient.listChannelPartnerRepricingConfigs(parent).iterateAll()) { // doThingsWith(element); } }
- Parameters:
parent
- Required. The resource name of the account's [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]. Parent uses the format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}. Supports accounts/{account_id}/channelPartnerLinks/- to retrieve configs for all channel partners.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listChannelPartnerRepricingConfigs
public final CloudChannelServiceClient.ListChannelPartnerRepricingConfigsPagedResponse listChannelPartnerRepricingConfigs(String parent)
Lists information about how a Reseller modifies their bill before sending it to a ChannelPartner.Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] specified does not exist or is not associated with the given account.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resources. The data for each resource is displayed in the ascending order of:
- Channel Partner ID
- [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month]
- [ChannelPartnerRepricingConfig.update_time][google.cloud.channel.v1.ChannelPartnerRepricingConfig.update_time]
If unsuccessful, returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { String parent = ChannelPartnerLinkName.of("[ACCOUNT]", "[CHANNEL_PARTNER_LINK]").toString(); for (ChannelPartnerRepricingConfig element : cloudChannelServiceClient.listChannelPartnerRepricingConfigs(parent).iterateAll()) { // doThingsWith(element); } }
- Parameters:
parent
- Required. The resource name of the account's [ChannelPartnerLink][google.cloud.channel.v1.ChannelPartnerLink]. Parent uses the format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}. Supports accounts/{account_id}/channelPartnerLinks/- to retrieve configs for all channel partners.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listChannelPartnerRepricingConfigs
public final CloudChannelServiceClient.ListChannelPartnerRepricingConfigsPagedResponse listChannelPartnerRepricingConfigs(ListChannelPartnerRepricingConfigsRequest request)
Lists information about how a Reseller modifies their bill before sending it to a ChannelPartner.Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] specified does not exist or is not associated with the given account.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resources. The data for each resource is displayed in the ascending order of:
- Channel Partner ID
- [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month]
- [ChannelPartnerRepricingConfig.update_time][google.cloud.channel.v1.ChannelPartnerRepricingConfig.update_time]
If unsuccessful, returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { ListChannelPartnerRepricingConfigsRequest request = ListChannelPartnerRepricingConfigsRequest.newBuilder() .setParent( ChannelPartnerLinkName.of("[ACCOUNT]", "[CHANNEL_PARTNER_LINK]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setFilter("filter-1274492040") .build(); for (ChannelPartnerRepricingConfig element : cloudChannelServiceClient.listChannelPartnerRepricingConfigs(request).iterateAll()) { // doThingsWith(element); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listChannelPartnerRepricingConfigsPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<ListChannelPartnerRepricingConfigsRequest,CloudChannelServiceClient.ListChannelPartnerRepricingConfigsPagedResponse> listChannelPartnerRepricingConfigsPagedCallable()
Lists information about how a Reseller modifies their bill before sending it to a ChannelPartner.Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] specified does not exist or is not associated with the given account.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resources. The data for each resource is displayed in the ascending order of:
- Channel Partner ID
- [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month]
- [ChannelPartnerRepricingConfig.update_time][google.cloud.channel.v1.ChannelPartnerRepricingConfig.update_time]
If unsuccessful, returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { ListChannelPartnerRepricingConfigsRequest request = ListChannelPartnerRepricingConfigsRequest.newBuilder() .setParent( ChannelPartnerLinkName.of("[ACCOUNT]", "[CHANNEL_PARTNER_LINK]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setFilter("filter-1274492040") .build(); ApiFuture<ChannelPartnerRepricingConfig> future = cloudChannelServiceClient .listChannelPartnerRepricingConfigsPagedCallable() .futureCall(request); // Do something. for (ChannelPartnerRepricingConfig element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listChannelPartnerRepricingConfigsCallable
public final com.google.api.gax.rpc.UnaryCallable<ListChannelPartnerRepricingConfigsRequest,ListChannelPartnerRepricingConfigsResponse> listChannelPartnerRepricingConfigsCallable()
Lists information about how a Reseller modifies their bill before sending it to a ChannelPartner.Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] specified does not exist or is not associated with the given account.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resources. The data for each resource is displayed in the ascending order of:
- Channel Partner ID
- [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month]
- [ChannelPartnerRepricingConfig.update_time][google.cloud.channel.v1.ChannelPartnerRepricingConfig.update_time]
If unsuccessful, returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { ListChannelPartnerRepricingConfigsRequest request = ListChannelPartnerRepricingConfigsRequest.newBuilder() .setParent( ChannelPartnerLinkName.of("[ACCOUNT]", "[CHANNEL_PARTNER_LINK]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setFilter("filter-1274492040") .build(); while (true) { ListChannelPartnerRepricingConfigsResponse response = cloudChannelServiceClient.listChannelPartnerRepricingConfigsCallable().call(request); for (ChannelPartnerRepricingConfig element : response.getChannelPartnerRepricingConfigsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
createChannelPartnerRepricingConfig
public final ChannelPartnerRepricingConfig createChannelPartnerRepricingConfig(ChannelPartnerLinkName parent, ChannelPartnerRepricingConfig channelPartnerRepricingConfig)
Creates a ChannelPartnerRepricingConfig. Call this method to set modifications for a specific ChannelPartner's bill. You can only create configs if the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is a future month. If needed, you can create a config for the current month, with some restrictions.When creating a config for a future month, make sure there are no existing configs for that [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].
The following restrictions are for creating configs in the current month.
- This functionality is reserved for recovering from an erroneous config, and should not be used for regular business cases.
- The new config will not modify exports used with other configs. Changes to the config may be immediate, but may take up to 24 hours.
- There is a limit of ten configs for any ChannelPartner or [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement], for any [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].
- The contained [ChannelPartnerRepricingConfig.repricing_config][google.cloud.channel.v1.ChannelPartnerRepricingConfig.repricing_config] value must be different from the value used in the current config for a ChannelPartner.
Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.
- NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] specified does not exist or is not associated with the given account.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the updated [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resource, otherwise returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { ChannelPartnerLinkName parent = ChannelPartnerLinkName.of("[ACCOUNT]", "[CHANNEL_PARTNER_LINK]"); ChannelPartnerRepricingConfig channelPartnerRepricingConfig = ChannelPartnerRepricingConfig.newBuilder().build(); ChannelPartnerRepricingConfig response = cloudChannelServiceClient.createChannelPartnerRepricingConfig( parent, channelPartnerRepricingConfig); }
- Parameters:
parent
- Required. The resource name of the ChannelPartner that will receive the repricing config. Parent uses the format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}channelPartnerRepricingConfig
- Required. The ChannelPartnerRepricingConfig object to update.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createChannelPartnerRepricingConfig
public final ChannelPartnerRepricingConfig createChannelPartnerRepricingConfig(String parent, ChannelPartnerRepricingConfig channelPartnerRepricingConfig)
Creates a ChannelPartnerRepricingConfig. Call this method to set modifications for a specific ChannelPartner's bill. You can only create configs if the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is a future month. If needed, you can create a config for the current month, with some restrictions.When creating a config for a future month, make sure there are no existing configs for that [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].
The following restrictions are for creating configs in the current month.
- This functionality is reserved for recovering from an erroneous config, and should not be used for regular business cases.
- The new config will not modify exports used with other configs. Changes to the config may be immediate, but may take up to 24 hours.
- There is a limit of ten configs for any ChannelPartner or [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement], for any [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].
- The contained [ChannelPartnerRepricingConfig.repricing_config][google.cloud.channel.v1.ChannelPartnerRepricingConfig.repricing_config] value must be different from the value used in the current config for a ChannelPartner.
Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.
- NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] specified does not exist or is not associated with the given account.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the updated [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resource, otherwise returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { String parent = ChannelPartnerLinkName.of("[ACCOUNT]", "[CHANNEL_PARTNER_LINK]").toString(); ChannelPartnerRepricingConfig channelPartnerRepricingConfig = ChannelPartnerRepricingConfig.newBuilder().build(); ChannelPartnerRepricingConfig response = cloudChannelServiceClient.createChannelPartnerRepricingConfig( parent, channelPartnerRepricingConfig); }
- Parameters:
parent
- Required. The resource name of the ChannelPartner that will receive the repricing config. Parent uses the format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}channelPartnerRepricingConfig
- Required. The ChannelPartnerRepricingConfig object to update.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createChannelPartnerRepricingConfig
public final ChannelPartnerRepricingConfig createChannelPartnerRepricingConfig(CreateChannelPartnerRepricingConfigRequest request)
Creates a ChannelPartnerRepricingConfig. Call this method to set modifications for a specific ChannelPartner's bill. You can only create configs if the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is a future month. If needed, you can create a config for the current month, with some restrictions.When creating a config for a future month, make sure there are no existing configs for that [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].
The following restrictions are for creating configs in the current month.
- This functionality is reserved for recovering from an erroneous config, and should not be used for regular business cases.
- The new config will not modify exports used with other configs. Changes to the config may be immediate, but may take up to 24 hours.
- There is a limit of ten configs for any ChannelPartner or [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement], for any [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].
- The contained [ChannelPartnerRepricingConfig.repricing_config][google.cloud.channel.v1.ChannelPartnerRepricingConfig.repricing_config] value must be different from the value used in the current config for a ChannelPartner.
Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.
- NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] specified does not exist or is not associated with the given account.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the updated [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resource, otherwise returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { CreateChannelPartnerRepricingConfigRequest request = CreateChannelPartnerRepricingConfigRequest.newBuilder() .setParent( ChannelPartnerLinkName.of("[ACCOUNT]", "[CHANNEL_PARTNER_LINK]").toString()) .setChannelPartnerRepricingConfig(ChannelPartnerRepricingConfig.newBuilder().build()) .build(); ChannelPartnerRepricingConfig response = cloudChannelServiceClient.createChannelPartnerRepricingConfig(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createChannelPartnerRepricingConfigCallable
public final com.google.api.gax.rpc.UnaryCallable<CreateChannelPartnerRepricingConfigRequest,ChannelPartnerRepricingConfig> createChannelPartnerRepricingConfigCallable()
Creates a ChannelPartnerRepricingConfig. Call this method to set modifications for a specific ChannelPartner's bill. You can only create configs if the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is a future month. If needed, you can create a config for the current month, with some restrictions.When creating a config for a future month, make sure there are no existing configs for that [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].
The following restrictions are for creating configs in the current month.
- This functionality is reserved for recovering from an erroneous config, and should not be used for regular business cases.
- The new config will not modify exports used with other configs. Changes to the config may be immediate, but may take up to 24 hours.
- There is a limit of ten configs for any ChannelPartner or [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement], for any [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].
- The contained [ChannelPartnerRepricingConfig.repricing_config][google.cloud.channel.v1.ChannelPartnerRepricingConfig.repricing_config] value must be different from the value used in the current config for a ChannelPartner.
Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.
- NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] specified does not exist or is not associated with the given account.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the updated [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resource, otherwise returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { CreateChannelPartnerRepricingConfigRequest request = CreateChannelPartnerRepricingConfigRequest.newBuilder() .setParent( ChannelPartnerLinkName.of("[ACCOUNT]", "[CHANNEL_PARTNER_LINK]").toString()) .setChannelPartnerRepricingConfig(ChannelPartnerRepricingConfig.newBuilder().build()) .build(); ApiFuture<ChannelPartnerRepricingConfig> future = cloudChannelServiceClient .createChannelPartnerRepricingConfigCallable() .futureCall(request); // Do something. ChannelPartnerRepricingConfig response = future.get(); }
-
updateChannelPartnerRepricingConfig
public final ChannelPartnerRepricingConfig updateChannelPartnerRepricingConfig(ChannelPartnerRepricingConfig channelPartnerRepricingConfig)
Updates a ChannelPartnerRepricingConfig. Call this method to set modifications for a specific ChannelPartner's bill. This method overwrites the existing CustomerRepricingConfig.You can only update configs if the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is a future month. To make changes to configs for the current month, use [CreateChannelPartnerRepricingConfig][google.cloud.channel.v1.CloudChannelService.CreateChannelPartnerRepricingConfig], taking note of its restrictions. You cannot update the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].
When updating a config in the future:
- This config must already exist.
Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.
- NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] specified does not exist or is not associated with the given account.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the updated [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resource, otherwise returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { ChannelPartnerRepricingConfig channelPartnerRepricingConfig = ChannelPartnerRepricingConfig.newBuilder().build(); ChannelPartnerRepricingConfig response = cloudChannelServiceClient.updateChannelPartnerRepricingConfig( channelPartnerRepricingConfig); }
- Parameters:
channelPartnerRepricingConfig
- Required. The ChannelPartnerRepricingConfig object to update.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateChannelPartnerRepricingConfig
public final ChannelPartnerRepricingConfig updateChannelPartnerRepricingConfig(UpdateChannelPartnerRepricingConfigRequest request)
Updates a ChannelPartnerRepricingConfig. Call this method to set modifications for a specific ChannelPartner's bill. This method overwrites the existing CustomerRepricingConfig.You can only update configs if the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is a future month. To make changes to configs for the current month, use [CreateChannelPartnerRepricingConfig][google.cloud.channel.v1.CloudChannelService.CreateChannelPartnerRepricingConfig], taking note of its restrictions. You cannot update the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].
When updating a config in the future:
- This config must already exist.
Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.
- NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] specified does not exist or is not associated with the given account.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the updated [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resource, otherwise returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { UpdateChannelPartnerRepricingConfigRequest request = UpdateChannelPartnerRepricingConfigRequest.newBuilder() .setChannelPartnerRepricingConfig(ChannelPartnerRepricingConfig.newBuilder().build()) .build(); ChannelPartnerRepricingConfig response = cloudChannelServiceClient.updateChannelPartnerRepricingConfig(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateChannelPartnerRepricingConfigCallable
public final com.google.api.gax.rpc.UnaryCallable<UpdateChannelPartnerRepricingConfigRequest,ChannelPartnerRepricingConfig> updateChannelPartnerRepricingConfigCallable()
Updates a ChannelPartnerRepricingConfig. Call this method to set modifications for a specific ChannelPartner's bill. This method overwrites the existing CustomerRepricingConfig.You can only update configs if the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is a future month. To make changes to configs for the current month, use [CreateChannelPartnerRepricingConfig][google.cloud.channel.v1.CloudChannelService.CreateChannelPartnerRepricingConfig], taking note of its restrictions. You cannot update the [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month].
When updating a config in the future:
- This config must already exist.
Possible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different.
- INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months.
- NOT_FOUND: The [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] specified does not exist or is not associated with the given account.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the updated [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] resource, otherwise returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { UpdateChannelPartnerRepricingConfigRequest request = UpdateChannelPartnerRepricingConfigRequest.newBuilder() .setChannelPartnerRepricingConfig(ChannelPartnerRepricingConfig.newBuilder().build()) .build(); ApiFuture<ChannelPartnerRepricingConfig> future = cloudChannelServiceClient .updateChannelPartnerRepricingConfigCallable() .futureCall(request); // Do something. ChannelPartnerRepricingConfig response = future.get(); }
-
deleteChannelPartnerRepricingConfig
public final void deleteChannelPartnerRepricingConfig(ChannelPartnerRepricingConfigName name)
Deletes the given [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] permanently. You can only delete configs if their [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is set to a date after the current month.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 [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] is active or in the past.
- NOT_FOUND: No [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] found for the name in the request.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { ChannelPartnerRepricingConfigName name = ChannelPartnerRepricingConfigName.of( "[ACCOUNT]", "[CHANNEL_PARTNER]", "[CHANNEL_PARTNER_REPRICING_CONFIG]"); cloudChannelServiceClient.deleteChannelPartnerRepricingConfig(name); }
- Parameters:
name
- Required. The resource name of the channel partner repricing config rule to delete.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteChannelPartnerRepricingConfig
public final void deleteChannelPartnerRepricingConfig(String name)
Deletes the given [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] permanently. You can only delete configs if their [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is set to a date after the current month.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 [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] is active or in the past.
- NOT_FOUND: No [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] found for the name in the request.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { String name = ChannelPartnerRepricingConfigName.of( "[ACCOUNT]", "[CHANNEL_PARTNER]", "[CHANNEL_PARTNER_REPRICING_CONFIG]") .toString(); cloudChannelServiceClient.deleteChannelPartnerRepricingConfig(name); }
- Parameters:
name
- Required. The resource name of the channel partner repricing config rule to delete.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteChannelPartnerRepricingConfig
public final void deleteChannelPartnerRepricingConfig(DeleteChannelPartnerRepricingConfigRequest request)
Deletes the given [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] permanently. You can only delete configs if their [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is set to a date after the current month.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 [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] is active or in the past.
- NOT_FOUND: No [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] found for the name in the request.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { DeleteChannelPartnerRepricingConfigRequest request = DeleteChannelPartnerRepricingConfigRequest.newBuilder() .setName( ChannelPartnerRepricingConfigName.of( "[ACCOUNT]", "[CHANNEL_PARTNER]", "[CHANNEL_PARTNER_REPRICING_CONFIG]") .toString()) .build(); cloudChannelServiceClient.deleteChannelPartnerRepricingConfig(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteChannelPartnerRepricingConfigCallable
public final com.google.api.gax.rpc.UnaryCallable<DeleteChannelPartnerRepricingConfigRequest,com.google.protobuf.Empty> deleteChannelPartnerRepricingConfigCallable()
Deletes the given [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] permanently. You can only delete configs if their [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month] is set to a date after the current month.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 [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] is active or in the past.
- NOT_FOUND: No [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig] found for the name in the request.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { DeleteChannelPartnerRepricingConfigRequest request = DeleteChannelPartnerRepricingConfigRequest.newBuilder() .setName( ChannelPartnerRepricingConfigName.of( "[ACCOUNT]", "[CHANNEL_PARTNER]", "[CHANNEL_PARTNER_REPRICING_CONFIG]") .toString()) .build(); ApiFuture<Empty> future = cloudChannelServiceClient .deleteChannelPartnerRepricingConfigCallable() .futureCall(request); // Do something. future.get(); }
-
listSkuGroups
public final CloudChannelServiceClient.ListSkuGroupsPagedResponse listSkuGroups(String parent)
Lists the Rebilling supported SKU groups the account is authorized to sell. Reference: https://cloud.google.com/skus/sku-groupsPossible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different, or the account doesn't exist.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the [SkuGroup][google.cloud.channel.v1.SkuGroup] resources. The data for each resource is displayed in the alphabetical order of SKU group display name. The data for each resource is displayed in the ascending order of [SkuGroup.display_name][google.cloud.channel.v1.SkuGroup.display_name]
If unsuccessful, returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { String parent = "parent-995424086"; for (SkuGroup element : cloudChannelServiceClient.listSkuGroups(parent).iterateAll()) { // doThingsWith(element); } }
- Parameters:
parent
- Required. The resource name of the account from which to list SKU groups. Parent uses the format: accounts/{account}.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listSkuGroups
public final CloudChannelServiceClient.ListSkuGroupsPagedResponse listSkuGroups(ListSkuGroupsRequest request)
Lists the Rebilling supported SKU groups the account is authorized to sell. Reference: https://cloud.google.com/skus/sku-groupsPossible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different, or the account doesn't exist.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the [SkuGroup][google.cloud.channel.v1.SkuGroup] resources. The data for each resource is displayed in the alphabetical order of SKU group display name. The data for each resource is displayed in the ascending order of [SkuGroup.display_name][google.cloud.channel.v1.SkuGroup.display_name]
If unsuccessful, returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { ListSkuGroupsRequest request = ListSkuGroupsRequest.newBuilder() .setParent("parent-995424086") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); for (SkuGroup element : cloudChannelServiceClient.listSkuGroups(request).iterateAll()) { // doThingsWith(element); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listSkuGroupsPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<ListSkuGroupsRequest,CloudChannelServiceClient.ListSkuGroupsPagedResponse> listSkuGroupsPagedCallable()
Lists the Rebilling supported SKU groups the account is authorized to sell. Reference: https://cloud.google.com/skus/sku-groupsPossible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different, or the account doesn't exist.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the [SkuGroup][google.cloud.channel.v1.SkuGroup] resources. The data for each resource is displayed in the alphabetical order of SKU group display name. The data for each resource is displayed in the ascending order of [SkuGroup.display_name][google.cloud.channel.v1.SkuGroup.display_name]
If unsuccessful, returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { ListSkuGroupsRequest request = ListSkuGroupsRequest.newBuilder() .setParent("parent-995424086") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); ApiFuture<SkuGroup> future = cloudChannelServiceClient.listSkuGroupsPagedCallable().futureCall(request); // Do something. for (SkuGroup element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listSkuGroupsCallable
public final com.google.api.gax.rpc.UnaryCallable<ListSkuGroupsRequest,ListSkuGroupsResponse> listSkuGroupsCallable()
Lists the Rebilling supported SKU groups the account is authorized to sell. Reference: https://cloud.google.com/skus/sku-groupsPossible Error Codes:
- PERMISSION_DENIED: If the account making the request and the account being queried are different, or the account doesn't exist.
- INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support.
Return Value: If successful, the [SkuGroup][google.cloud.channel.v1.SkuGroup] resources. The data for each resource is displayed in the alphabetical order of SKU group display name. The data for each resource is displayed in the ascending order of [SkuGroup.display_name][google.cloud.channel.v1.SkuGroup.display_name]
If unsuccessful, returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { ListSkuGroupsRequest request = ListSkuGroupsRequest.newBuilder() .setParent("parent-995424086") .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); while (true) { ListSkuGroupsResponse response = cloudChannelServiceClient.listSkuGroupsCallable().call(request); for (SkuGroup element : response.getSkuGroupsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
listSkuGroupBillableSkus
public final CloudChannelServiceClient.ListSkuGroupBillableSkusPagedResponse listSkuGroupBillableSkus(SkuGroupName parent)
Lists the Billable SKUs in a given SKU group.Possible error codes: PERMISSION_DENIED: If the account making the request and the account being queried for are different, or the account doesn't exist. INVALID_ARGUMENT: Missing or invalid required parameters in the request. INTERNAL: Any non-user error related to technical issue in the backend. In this case, contact cloud channel support.
Return Value: If successful, the [BillableSku][google.cloud.channel.v1.BillableSku] resources. The data for each resource is displayed in the ascending order of:
- [BillableSku.service_display_name][google.cloud.channel.v1.BillableSku.service_display_name]
- [BillableSku.sku_display_name][google.cloud.channel.v1.BillableSku.sku_display_name]
If unsuccessful, returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { SkuGroupName parent = SkuGroupName.of("[ACCOUNT]", "[SKU_GROUP]"); for (BillableSku element : cloudChannelServiceClient.listSkuGroupBillableSkus(parent).iterateAll()) { // doThingsWith(element); } }
- Parameters:
parent
- Required. Resource name of the SKU group. Format: accounts/{account}/skuGroups/{sku_group}.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listSkuGroupBillableSkus
public final CloudChannelServiceClient.ListSkuGroupBillableSkusPagedResponse listSkuGroupBillableSkus(String parent)
Lists the Billable SKUs in a given SKU group.Possible error codes: PERMISSION_DENIED: If the account making the request and the account being queried for are different, or the account doesn't exist. INVALID_ARGUMENT: Missing or invalid required parameters in the request. INTERNAL: Any non-user error related to technical issue in the backend. In this case, contact cloud channel support.
Return Value: If successful, the [BillableSku][google.cloud.channel.v1.BillableSku] resources. The data for each resource is displayed in the ascending order of:
- [BillableSku.service_display_name][google.cloud.channel.v1.BillableSku.service_display_name]
- [BillableSku.sku_display_name][google.cloud.channel.v1.BillableSku.sku_display_name]
If unsuccessful, returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { String parent = SkuGroupName.of("[ACCOUNT]", "[SKU_GROUP]").toString(); for (BillableSku element : cloudChannelServiceClient.listSkuGroupBillableSkus(parent).iterateAll()) { // doThingsWith(element); } }
- Parameters:
parent
- Required. Resource name of the SKU group. Format: accounts/{account}/skuGroups/{sku_group}.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listSkuGroupBillableSkus
public final CloudChannelServiceClient.ListSkuGroupBillableSkusPagedResponse listSkuGroupBillableSkus(ListSkuGroupBillableSkusRequest request)
Lists the Billable SKUs in a given SKU group.Possible error codes: PERMISSION_DENIED: If the account making the request and the account being queried for are different, or the account doesn't exist. INVALID_ARGUMENT: Missing or invalid required parameters in the request. INTERNAL: Any non-user error related to technical issue in the backend. In this case, contact cloud channel support.
Return Value: If successful, the [BillableSku][google.cloud.channel.v1.BillableSku] resources. The data for each resource is displayed in the ascending order of:
- [BillableSku.service_display_name][google.cloud.channel.v1.BillableSku.service_display_name]
- [BillableSku.sku_display_name][google.cloud.channel.v1.BillableSku.sku_display_name]
If unsuccessful, returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { ListSkuGroupBillableSkusRequest request = ListSkuGroupBillableSkusRequest.newBuilder() .setParent(SkuGroupName.of("[ACCOUNT]", "[SKU_GROUP]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); for (BillableSku element : cloudChannelServiceClient.listSkuGroupBillableSkus(request).iterateAll()) { // doThingsWith(element); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listSkuGroupBillableSkusPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<ListSkuGroupBillableSkusRequest,CloudChannelServiceClient.ListSkuGroupBillableSkusPagedResponse> listSkuGroupBillableSkusPagedCallable()
Lists the Billable SKUs in a given SKU group.Possible error codes: PERMISSION_DENIED: If the account making the request and the account being queried for are different, or the account doesn't exist. INVALID_ARGUMENT: Missing or invalid required parameters in the request. INTERNAL: Any non-user error related to technical issue in the backend. In this case, contact cloud channel support.
Return Value: If successful, the [BillableSku][google.cloud.channel.v1.BillableSku] resources. The data for each resource is displayed in the ascending order of:
- [BillableSku.service_display_name][google.cloud.channel.v1.BillableSku.service_display_name]
- [BillableSku.sku_display_name][google.cloud.channel.v1.BillableSku.sku_display_name]
If unsuccessful, returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { ListSkuGroupBillableSkusRequest request = ListSkuGroupBillableSkusRequest.newBuilder() .setParent(SkuGroupName.of("[ACCOUNT]", "[SKU_GROUP]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); ApiFuture<BillableSku> future = cloudChannelServiceClient.listSkuGroupBillableSkusPagedCallable().futureCall(request); // Do something. for (BillableSku element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listSkuGroupBillableSkusCallable
public final com.google.api.gax.rpc.UnaryCallable<ListSkuGroupBillableSkusRequest,ListSkuGroupBillableSkusResponse> listSkuGroupBillableSkusCallable()
Lists the Billable SKUs in a given SKU group.Possible error codes: PERMISSION_DENIED: If the account making the request and the account being queried for are different, or the account doesn't exist. INVALID_ARGUMENT: Missing or invalid required parameters in the request. INTERNAL: Any non-user error related to technical issue in the backend. In this case, contact cloud channel support.
Return Value: If successful, the [BillableSku][google.cloud.channel.v1.BillableSku] resources. The data for each resource is displayed in the ascending order of:
- [BillableSku.service_display_name][google.cloud.channel.v1.BillableSku.service_display_name]
- [BillableSku.sku_display_name][google.cloud.channel.v1.BillableSku.sku_display_name]
If unsuccessful, returns an error.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { ListSkuGroupBillableSkusRequest request = ListSkuGroupBillableSkusRequest.newBuilder() .setParent(SkuGroupName.of("[ACCOUNT]", "[SKU_GROUP]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .build(); while (true) { ListSkuGroupBillableSkusResponse response = cloudChannelServiceClient.listSkuGroupBillableSkusCallable().call(request); for (BillableSku element : response.getBillableSkusList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
lookupOffer
public final Offer lookupOffer(LookupOfferRequest request)
Returns the requested [Offer][google.cloud.channel.v1.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][google.cloud.channel.v1.Offer] resource.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { LookupOfferRequest request = LookupOfferRequest.newBuilder() .setEntitlement( EntitlementName.of("[ACCOUNT]", "[CUSTOMER]", "[ENTITLEMENT]").toString()) .build(); Offer response = cloudChannelServiceClient.lookupOffer(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
lookupOfferCallable
public final com.google.api.gax.rpc.UnaryCallable<LookupOfferRequest,Offer> lookupOfferCallable()
Returns the requested [Offer][google.cloud.channel.v1.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][google.cloud.channel.v1.Offer] resource.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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(); }
-
listProducts
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:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listProductsPagedCallable
public final com.google.api.gax.rpc.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:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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); } }
-
listProductsCallable
public final com.google.api.gax.rpc.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:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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.getProductsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
listSkus
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:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listSkusPagedCallable
public final com.google.api.gax.rpc.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:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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); } }
-
listSkusCallable
public final com.google.api.gax.rpc.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:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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.getSkusList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
listOffers
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:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { ListOffersRequest request = ListOffersRequest.newBuilder() .setParent("parent-995424086") .setPageSize(883849137) .setPageToken("pageToken873572522") .setFilter("filter-1274492040") .setLanguageCode("languageCode-2092349083") .setShowFutureOffers(true) .build(); for (Offer element : cloudChannelServiceClient.listOffers(request).iterateAll()) { // doThingsWith(element); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listOffersPagedCallable
public final com.google.api.gax.rpc.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:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { ListOffersRequest request = ListOffersRequest.newBuilder() .setParent("parent-995424086") .setPageSize(883849137) .setPageToken("pageToken873572522") .setFilter("filter-1274492040") .setLanguageCode("languageCode-2092349083") .setShowFutureOffers(true) .build(); ApiFuture<Offer> future = cloudChannelServiceClient.listOffersPagedCallable().futureCall(request); // Do something. for (Offer element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listOffersCallable
public final com.google.api.gax.rpc.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:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { ListOffersRequest request = ListOffersRequest.newBuilder() .setParent("parent-995424086") .setPageSize(883849137) .setPageToken("pageToken873572522") .setFilter("filter-1274492040") .setLanguageCode("languageCode-2092349083") .setShowFutureOffers(true) .build(); while (true) { ListOffersResponse response = cloudChannelServiceClient.listOffersCallable().call(request); for (Offer element : response.getOffersList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
listPurchasableSkus
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:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listPurchasableSkusPagedCallable
public final com.google.api.gax.rpc.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:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { ListPurchasableSkusRequest request = ListPurchasableSkusRequest.newBuilder() .setCustomer(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setLanguageCode("languageCode-2092349083") .build(); ApiFuture<PurchasableSku> future = cloudChannelServiceClient.listPurchasableSkusPagedCallable().futureCall(request); // Do something. for (PurchasableSku element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listPurchasableSkusCallable
public final com.google.api.gax.rpc.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:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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.getPurchasableSkusList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
listPurchasableOffers
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 * The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listPurchasableOffersPagedCallable
public final com.google.api.gax.rpc.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 * The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { ListPurchasableOffersRequest request = ListPurchasableOffersRequest.newBuilder() .setCustomer(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setLanguageCode("languageCode-2092349083") .build(); ApiFuture<PurchasableOffer> future = cloudChannelServiceClient.listPurchasableOffersPagedCallable().futureCall(request); // Do something. for (PurchasableOffer element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listPurchasableOffersCallable
public final com.google.api.gax.rpc.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 * The reseller is not authorized to transact on this Product. See https://support.google.com/channelservices/answer/9759265
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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.getPurchasableOffersList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
queryEligibleBillingAccounts
public final QueryEligibleBillingAccountsResponse queryEligibleBillingAccounts(QueryEligibleBillingAccountsRequest request)
Lists the billing accounts that are eligible to purchase particular SKUs for a given customer.Possible error codes:
- PERMISSION_DENIED: The customer doesn't belong to the reseller.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
Return value: Based on the provided list of SKUs, returns a list of SKU groups that must be purchased using the same billing account and the billing accounts eligible to purchase each SKU group.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { QueryEligibleBillingAccountsRequest request = QueryEligibleBillingAccountsRequest.newBuilder() .setCustomer(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString()) .addAllSkus(new ArrayList<String>()) .build(); QueryEligibleBillingAccountsResponse response = cloudChannelServiceClient.queryEligibleBillingAccounts(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
queryEligibleBillingAccountsCallable
public final com.google.api.gax.rpc.UnaryCallable<QueryEligibleBillingAccountsRequest,QueryEligibleBillingAccountsResponse> queryEligibleBillingAccountsCallable()
Lists the billing accounts that are eligible to purchase particular SKUs for a given customer.Possible error codes:
- PERMISSION_DENIED: The customer doesn't belong to the reseller.
- INVALID_ARGUMENT: Required request parameters are missing or invalid.
Return value: Based on the provided list of SKUs, returns a list of SKU groups that must be purchased using the same billing account and the billing accounts eligible to purchase each SKU group.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { QueryEligibleBillingAccountsRequest request = QueryEligibleBillingAccountsRequest.newBuilder() .setCustomer(CustomerName.of("[ACCOUNT]", "[CUSTOMER]").toString()) .addAllSkus(new ArrayList<String>()) .build(); ApiFuture<QueryEligibleBillingAccountsResponse> future = cloudChannelServiceClient.queryEligibleBillingAccountsCallable().futureCall(request); // Do something. QueryEligibleBillingAccountsResponse response = future.get(); }
-
registerSubscriber
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][google.cloud.channel.v1.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:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { RegisterSubscriberRequest request = RegisterSubscriberRequest.newBuilder() .setAccount("account-1177318867") .setServiceAccount("serviceAccount1079137720") .build(); RegisterSubscriberResponse response = cloudChannelServiceClient.registerSubscriber(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
registerSubscriberCallable
public final com.google.api.gax.rpc.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][google.cloud.channel.v1.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:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { RegisterSubscriberRequest request = RegisterSubscriberRequest.newBuilder() .setAccount("account-1177318867") .setServiceAccount("serviceAccount1079137720") .build(); ApiFuture<RegisterSubscriberResponse> future = cloudChannelServiceClient.registerSubscriberCallable().futureCall(request); // Do something. RegisterSubscriberResponse response = future.get(); }
-
unregisterSubscriber
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:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { UnregisterSubscriberRequest request = UnregisterSubscriberRequest.newBuilder() .setAccount("account-1177318867") .setServiceAccount("serviceAccount1079137720") .build(); UnregisterSubscriberResponse response = cloudChannelServiceClient.unregisterSubscriber(request); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
unregisterSubscriberCallable
public final com.google.api.gax.rpc.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:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { UnregisterSubscriberRequest request = UnregisterSubscriberRequest.newBuilder() .setAccount("account-1177318867") .setServiceAccount("serviceAccount1079137720") .build(); ApiFuture<UnregisterSubscriberResponse> future = cloudChannelServiceClient.unregisterSubscriberCallable().futureCall(request); // Do something. UnregisterSubscriberResponse response = future.get(); }
-
listSubscribers
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:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listSubscribersPagedCallable
public final com.google.api.gax.rpc.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:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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); } }
-
listSubscribersCallable
public final com.google.api.gax.rpc.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:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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.getServiceAccountsList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
listEntitlementChanges
public final CloudChannelServiceClient.ListEntitlementChangesPagedResponse listEntitlementChanges(EntitlementName parent)
List entitlement history.Possible error codes:
- PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different.
- INVALID_ARGUMENT: Missing or invalid required fields in the request.
- NOT_FOUND: The parent resource doesn't exist. Usually the result of an invalid name parameter.
- INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact CloudChannel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
Return value: List of [EntitlementChange][google.cloud.channel.v1.EntitlementChange]s.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { EntitlementName parent = EntitlementName.of("[ACCOUNT]", "[CUSTOMER]", "[ENTITLEMENT]"); for (EntitlementChange element : cloudChannelServiceClient.listEntitlementChanges(parent).iterateAll()) { // doThingsWith(element); } }
- Parameters:
parent
- Required. The resource name of the entitlement for which to list entitlement changes. The `-` wildcard may be used to match entitlements across a customer. Formats:* accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id} * accounts/{account_id}/customers/{customer_id}/entitlements/-
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listEntitlementChanges
public final CloudChannelServiceClient.ListEntitlementChangesPagedResponse listEntitlementChanges(String parent)
List entitlement history.Possible error codes:
- PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different.
- INVALID_ARGUMENT: Missing or invalid required fields in the request.
- NOT_FOUND: The parent resource doesn't exist. Usually the result of an invalid name parameter.
- INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact CloudChannel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
Return value: List of [EntitlementChange][google.cloud.channel.v1.EntitlementChange]s.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { String parent = EntitlementName.of("[ACCOUNT]", "[CUSTOMER]", "[ENTITLEMENT]").toString(); for (EntitlementChange element : cloudChannelServiceClient.listEntitlementChanges(parent).iterateAll()) { // doThingsWith(element); } }
- Parameters:
parent
- Required. The resource name of the entitlement for which to list entitlement changes. The `-` wildcard may be used to match entitlements across a customer. Formats:* accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id} * accounts/{account_id}/customers/{customer_id}/entitlements/-
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listEntitlementChanges
public final CloudChannelServiceClient.ListEntitlementChangesPagedResponse listEntitlementChanges(ListEntitlementChangesRequest request)
List entitlement history.Possible error codes:
- PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different.
- INVALID_ARGUMENT: Missing or invalid required fields in the request.
- NOT_FOUND: The parent resource doesn't exist. Usually the result of an invalid name parameter.
- INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact CloudChannel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
Return value: List of [EntitlementChange][google.cloud.channel.v1.EntitlementChange]s.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { ListEntitlementChangesRequest request = ListEntitlementChangesRequest.newBuilder() .setParent(EntitlementName.of("[ACCOUNT]", "[CUSTOMER]", "[ENTITLEMENT]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setFilter("filter-1274492040") .build(); for (EntitlementChange element : cloudChannelServiceClient.listEntitlementChanges(request).iterateAll()) { // doThingsWith(element); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listEntitlementChangesPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<ListEntitlementChangesRequest,CloudChannelServiceClient.ListEntitlementChangesPagedResponse> listEntitlementChangesPagedCallable()
List entitlement history.Possible error codes:
- PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different.
- INVALID_ARGUMENT: Missing or invalid required fields in the request.
- NOT_FOUND: The parent resource doesn't exist. Usually the result of an invalid name parameter.
- INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact CloudChannel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
Return value: List of [EntitlementChange][google.cloud.channel.v1.EntitlementChange]s.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { ListEntitlementChangesRequest request = ListEntitlementChangesRequest.newBuilder() .setParent(EntitlementName.of("[ACCOUNT]", "[CUSTOMER]", "[ENTITLEMENT]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setFilter("filter-1274492040") .build(); ApiFuture<EntitlementChange> future = cloudChannelServiceClient.listEntitlementChangesPagedCallable().futureCall(request); // Do something. for (EntitlementChange element : future.get().iterateAll()) { // doThingsWith(element); } }
-
listEntitlementChangesCallable
public final com.google.api.gax.rpc.UnaryCallable<ListEntitlementChangesRequest,ListEntitlementChangesResponse> listEntitlementChangesCallable()
List entitlement history.Possible error codes:
- PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different.
- INVALID_ARGUMENT: Missing or invalid required fields in the request.
- NOT_FOUND: The parent resource doesn't exist. Usually the result of an invalid name parameter.
- INTERNAL: Any non-user error related to a technical issue in the backend. In this case, contact CloudChannel support.
- UNKNOWN: Any non-user error related to a technical issue in the backend. In this case, contact Cloud Channel support.
Return value: List of [EntitlementChange][google.cloud.channel.v1.EntitlementChange]s.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (CloudChannelServiceClient cloudChannelServiceClient = CloudChannelServiceClient.create()) { ListEntitlementChangesRequest request = ListEntitlementChangesRequest.newBuilder() .setParent(EntitlementName.of("[ACCOUNT]", "[CUSTOMER]", "[ENTITLEMENT]").toString()) .setPageSize(883849137) .setPageToken("pageToken873572522") .setFilter("filter-1274492040") .build(); while (true) { ListEntitlementChangesResponse response = cloudChannelServiceClient.listEntitlementChangesCallable().call(request); for (EntitlementChange element : response.getEntitlementChangesList()) { // doThingsWith(element); } String nextPageToken = response.getNextPageToken(); if (!Strings.isNullOrEmpty(nextPageToken)) { request = request.toBuilder().setPageToken(nextPageToken).build(); } else { break; } } }
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
shutdown
public void shutdown()
- Specified by:
shutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isShutdown
public boolean isShutdown()
- Specified by:
isShutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isTerminated
public boolean isTerminated()
- Specified by:
isTerminated
in interfacecom.google.api.gax.core.BackgroundResource
-
shutdownNow
public void shutdownNow()
- Specified by:
shutdownNow
in interfacecom.google.api.gax.core.BackgroundResource
-
awaitTermination
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
- Specified by:
awaitTermination
in interfacecom.google.api.gax.core.BackgroundResource
- Throws:
InterruptedException
-
-