Package com.google.cloud.channel.v1 (3.10.0)

A client to Cloud Channel API

The interfaces provided are listed below, along with usage samples.

CloudChannelReportsServiceClient

Service Description: CloudChannelReportsService lets Google Cloud resellers and distributors retrieve and combine a variety of data in Cloud Channel for multiple products (Google Cloud Platform (GCP), Google Voice, and Google Workspace.)

Sample for CloudChannelReportsServiceClient:


 // 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 (CloudChannelReportsServiceClient cloudChannelReportsServiceClient =
     CloudChannelReportsServiceClient.create()) {
   RunReportJobRequest request =
       RunReportJobRequest.newBuilder()
           .setName(ReportName.of("[ACCOUNT]", "[REPORT]").toString())
           .setDateRange(DateRange.newBuilder().build())
           .setFilter("filter-1274492040")
           .setLanguageCode("languageCode-2092349083")
           .build();
   RunReportJobResponse response =
       cloudChannelReportsServiceClient.runReportJobAsync(request).get();
 }

CloudChannelServiceClient

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

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

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

- Entitlements: An entity that provides a customer with the means to use a service. Entitlements are created or updated as a result of a successful fulfillment.

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

Sample for CloudChannelServiceClient:


 // 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);
 }

Classes

ActivateEntitlementRequest

Request message for CloudChannelService.ActivateEntitlement.

Protobuf type google.cloud.channel.v1.ActivateEntitlementRequest

ActivateEntitlementRequest.Builder

Request message for CloudChannelService.ActivateEntitlement.

Protobuf type google.cloud.channel.v1.ActivateEntitlementRequest

AdminUser

Information needed to create an Admin User for Google Workspace.

Protobuf type google.cloud.channel.v1.AdminUser

AdminUser.Builder

Information needed to create an Admin User for Google Workspace.

Protobuf type google.cloud.channel.v1.AdminUser

AssociationInfo

Association links that an entitlement has to other entitlements.

Protobuf type google.cloud.channel.v1.AssociationInfo

AssociationInfo.Builder

Association links that an entitlement has to other entitlements.

Protobuf type google.cloud.channel.v1.AssociationInfo

CancelEntitlementRequest

Request message for CloudChannelService.CancelEntitlement.

Protobuf type google.cloud.channel.v1.CancelEntitlementRequest

CancelEntitlementRequest.Builder

Request message for CloudChannelService.CancelEntitlement.

Protobuf type google.cloud.channel.v1.CancelEntitlementRequest

ChangeOfferRequest

Request message for CloudChannelService.ChangeOffer.

Protobuf type google.cloud.channel.v1.ChangeOfferRequest

ChangeOfferRequest.Builder

Request message for CloudChannelService.ChangeOffer.

Protobuf type google.cloud.channel.v1.ChangeOfferRequest

ChangeParametersRequest

Request message for [CloudChannelService.ChangeParametersRequest][].

Protobuf type google.cloud.channel.v1.ChangeParametersRequest

ChangeParametersRequest.Builder

Request message for [CloudChannelService.ChangeParametersRequest][].

Protobuf type google.cloud.channel.v1.ChangeParametersRequest

ChangeRenewalSettingsRequest

Request message for CloudChannelService.ChangeRenewalSettings.

Protobuf type google.cloud.channel.v1.ChangeRenewalSettingsRequest

ChangeRenewalSettingsRequest.Builder

Request message for CloudChannelService.ChangeRenewalSettings.

Protobuf type google.cloud.channel.v1.ChangeRenewalSettingsRequest

ChannelPartnerLink

Entity representing a link between distributors and their indirect resellers in an n-tier resale channel.

Protobuf type google.cloud.channel.v1.ChannelPartnerLink

ChannelPartnerLink.Builder

Entity representing a link between distributors and their indirect resellers in an n-tier resale channel.

Protobuf type google.cloud.channel.v1.ChannelPartnerLink

ChannelPartnerLinkName

ChannelPartnerLinkName.Builder

Builder for accounts/{account}/channelPartnerLinks/{channel_partner_link}.

ChannelPartnerLinksProto

ChannelPartnerRepricingConfig

Configuration for how a distributor will rebill a channel partner (also known as a distributor-authorized reseller).

Protobuf type google.cloud.channel.v1.ChannelPartnerRepricingConfig

ChannelPartnerRepricingConfig.Builder

Configuration for how a distributor will rebill a channel partner (also known as a distributor-authorized reseller).

Protobuf type google.cloud.channel.v1.ChannelPartnerRepricingConfig

ChannelPartnerRepricingConfigName

ChannelPartnerRepricingConfigName.Builder

Builder for accounts/{account}/channelPartnerLinks/{channel_partner}/channelPartnerRepricingConfigs/{channel_partner_repricing_config}.

CheckCloudIdentityAccountsExistRequest

Request message for CloudChannelService.CheckCloudIdentityAccountsExist.

Protobuf type google.cloud.channel.v1.CheckCloudIdentityAccountsExistRequest

CheckCloudIdentityAccountsExistRequest.Builder

Request message for CloudChannelService.CheckCloudIdentityAccountsExist.

Protobuf type google.cloud.channel.v1.CheckCloudIdentityAccountsExistRequest

CheckCloudIdentityAccountsExistResponse

Response message for CloudChannelService.CheckCloudIdentityAccountsExist.

Protobuf type google.cloud.channel.v1.CheckCloudIdentityAccountsExistResponse

CheckCloudIdentityAccountsExistResponse.Builder

Response message for CloudChannelService.CheckCloudIdentityAccountsExist.

Protobuf type google.cloud.channel.v1.CheckCloudIdentityAccountsExistResponse

CloudChannelReportsServiceClient

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 (CloudChannelReportsServiceClient cloudChannelReportsServiceClient =
     CloudChannelReportsServiceClient.create()) {
   RunReportJobRequest request =
       RunReportJobRequest.newBuilder()
           .setName(ReportName.of("[ACCOUNT]", "[REPORT]").toString())
           .setDateRange(DateRange.newBuilder().build())
           .setFilter("filter-1274492040")
           .setLanguageCode("languageCode-2092349083")
           .build();
   RunReportJobResponse response =
       cloudChannelReportsServiceClient.runReportJobAsync(request).get();
 }

Note: close() needs to be called on the CloudChannelReportsServiceClient 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 CloudChannelReportsServiceSettings 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
 CloudChannelReportsServiceSettings cloudChannelReportsServiceSettings =
     CloudChannelReportsServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CloudChannelReportsServiceClient cloudChannelReportsServiceClient =
     CloudChannelReportsServiceClient.create(cloudChannelReportsServiceSettings);

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
 CloudChannelReportsServiceSettings cloudChannelReportsServiceSettings =
     CloudChannelReportsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 CloudChannelReportsServiceClient cloudChannelReportsServiceClient =
     CloudChannelReportsServiceClient.create(cloudChannelReportsServiceSettings);

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
 CloudChannelReportsServiceSettings cloudChannelReportsServiceSettings =
     CloudChannelReportsServiceSettings.newHttpJsonBuilder().build();
 CloudChannelReportsServiceClient cloudChannelReportsServiceClient =
     CloudChannelReportsServiceClient.create(cloudChannelReportsServiceSettings);

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

CloudChannelReportsServiceClient.FetchReportResultsFixedSizeCollection

CloudChannelReportsServiceClient.FetchReportResultsPage

CloudChannelReportsServiceClient.FetchReportResultsPagedResponse

CloudChannelReportsServiceClient.ListReportsFixedSizeCollection

CloudChannelReportsServiceClient.ListReportsPage

CloudChannelReportsServiceClient.ListReportsPagedResponse

CloudChannelReportsServiceGrpc

CloudChannelReportsService lets Google Cloud resellers and distributors retrieve and combine a variety of data in Cloud Channel for multiple products (Google Cloud Platform (GCP), Google Voice, and Google Workspace.)

CloudChannelReportsServiceGrpc.CloudChannelReportsServiceBlockingStub

CloudChannelReportsServiceGrpc.CloudChannelReportsServiceFutureStub

CloudChannelReportsServiceGrpc.CloudChannelReportsServiceImplBase

CloudChannelReportsServiceGrpc.CloudChannelReportsServiceStub

CloudChannelReportsServiceSettings

Settings class to configure an instance of CloudChannelReportsServiceClient.

The default instance has everything set to sensible defaults:

The default service address (cloudchannel.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of runReportJob to 30 seconds:


 // 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
 CloudChannelReportsServiceSettings.Builder cloudChannelReportsServiceSettingsBuilder =
     CloudChannelReportsServiceSettings.newBuilder();
 cloudChannelReportsServiceSettingsBuilder
     .runReportJobSettings()
     .setRetrySettings(
         cloudChannelReportsServiceSettingsBuilder
             .runReportJobSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 CloudChannelReportsServiceSettings cloudChannelReportsServiceSettings =
     cloudChannelReportsServiceSettingsBuilder.build();

CloudChannelReportsServiceSettings.Builder

Builder for CloudChannelReportsServiceSettings.

CloudChannelServiceClient

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

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

- Entitlements: An entity that provides a customer with the means to use a service. Entitlements are created or updated as a result of a successful fulfillment.

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

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


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

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.

CloudChannelServiceClient.ListChannelPartnerLinksFixedSizeCollection

CloudChannelServiceClient.ListChannelPartnerLinksPage

CloudChannelServiceClient.ListChannelPartnerLinksPagedResponse

CloudChannelServiceClient.ListChannelPartnerRepricingConfigsFixedSizeCollection

CloudChannelServiceClient.ListChannelPartnerRepricingConfigsPage

CloudChannelServiceClient.ListChannelPartnerRepricingConfigsPagedResponse

CloudChannelServiceClient.ListCustomerRepricingConfigsFixedSizeCollection

CloudChannelServiceClient.ListCustomerRepricingConfigsPage

CloudChannelServiceClient.ListCustomerRepricingConfigsPagedResponse

CloudChannelServiceClient.ListCustomersFixedSizeCollection

CloudChannelServiceClient.ListCustomersPage

CloudChannelServiceClient.ListCustomersPagedResponse

CloudChannelServiceClient.ListEntitlementsFixedSizeCollection

CloudChannelServiceClient.ListEntitlementsPage

CloudChannelServiceClient.ListEntitlementsPagedResponse

CloudChannelServiceClient.ListOffersFixedSizeCollection

CloudChannelServiceClient.ListOffersPage

CloudChannelServiceClient.ListOffersPagedResponse

CloudChannelServiceClient.ListProductsFixedSizeCollection

CloudChannelServiceClient.ListProductsPage

CloudChannelServiceClient.ListProductsPagedResponse

CloudChannelServiceClient.ListPurchasableOffersFixedSizeCollection

CloudChannelServiceClient.ListPurchasableOffersPage

CloudChannelServiceClient.ListPurchasableOffersPagedResponse

CloudChannelServiceClient.ListPurchasableSkusFixedSizeCollection

CloudChannelServiceClient.ListPurchasableSkusPage

CloudChannelServiceClient.ListPurchasableSkusPagedResponse

CloudChannelServiceClient.ListSkusFixedSizeCollection

CloudChannelServiceClient.ListSkusPage

CloudChannelServiceClient.ListSkusPagedResponse

CloudChannelServiceClient.ListSubscribersFixedSizeCollection

CloudChannelServiceClient.ListSubscribersPage

CloudChannelServiceClient.ListSubscribersPagedResponse

CloudChannelServiceClient.ListTransferableOffersFixedSizeCollection

CloudChannelServiceClient.ListTransferableOffersPage

CloudChannelServiceClient.ListTransferableOffersPagedResponse