Package com.google.cloud.channel.v1

Class CloudChannelReportsServiceClient

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, AutoCloseable
    @Generated("by gapic-generator-java")
public class CloudChannelReportsServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource
    Service Description: CloudChannelReportsService lets Google Cloud resellers and distributors retrieve and combine a variety of data in Cloud Channel for multiple products (Google Cloud, Google Voice, and Google Workspace.)

    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:

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

    See the individual methods for example code.

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

    This class can be customized by passing in a custom instance of 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.

    • Constructor Detail

      • CloudChannelReportsServiceClient

        protected CloudChannelReportsServiceClient​(CloudChannelReportsServiceSettings settings)
                                    throws IOException
        Constructs an instance of CloudChannelReportsServiceClient, 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

    • Method Detail

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

      • runReportJobAsync

        public final com.google.api.gax.longrunning.OperationFuture<RunReportJobResponse,​OperationMetadata> runReportJobAsync​(RunReportJobRequest request)
        Begins generation of data for a given report. The report identifier is a UID (for example, `613bf59q`).

        Possible error codes:

        • PERMISSION_DENIED: The user doesn't have access to this report.
        • INVALID_ARGUMENT: Required request parameters are missing or invalid.
        • NOT_FOUND: The report identifier was 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 contains an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

        To get the results of report generation, call [CloudChannelReportsService.FetchReportResults][google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults] with the [RunReportJobResponse.report_job][google.cloud.channel.v1.RunReportJobResponse.report_job].

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

      • runReportJobOperationCallable

        public final com.google.api.gax.rpc.OperationCallable<RunReportJobRequest,​RunReportJobResponse,​OperationMetadata> runReportJobOperationCallable()
        Begins generation of data for a given report. The report identifier is a UID (for example, `613bf59q`).

        Possible error codes:

        • PERMISSION_DENIED: The user doesn't have access to this report.
        • INVALID_ARGUMENT: Required request parameters are missing or invalid.
        • NOT_FOUND: The report identifier was 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 contains an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

        To get the results of report generation, call [CloudChannelReportsService.FetchReportResults][google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults] with the [RunReportJobResponse.report_job][google.cloud.channel.v1.RunReportJobResponse.report_job].

        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 (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();
   OperationFuture<RunReportJobResponse, OperationMetadata> future =
       cloudChannelReportsServiceClient.runReportJobOperationCallable().futureCall(request);
   // Do something.
   RunReportJobResponse response = future.get();
 }

      • runReportJobCallable

        public final com.google.api.gax.rpc.UnaryCallable<RunReportJobRequest,​com.google.longrunning.Operation> runReportJobCallable()
        Begins generation of data for a given report. The report identifier is a UID (for example, `613bf59q`).

        Possible error codes:

        • PERMISSION_DENIED: The user doesn't have access to this report.
        • INVALID_ARGUMENT: Required request parameters are missing or invalid.
        • NOT_FOUND: The report identifier was 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 contains an instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].

        To get the results of report generation, call [CloudChannelReportsService.FetchReportResults][google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults] with the [RunReportJobResponse.report_job][google.cloud.channel.v1.RunReportJobResponse.report_job].

        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 (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();
   ApiFuture<Operation> future =
       cloudChannelReportsServiceClient.runReportJobCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

      • fetchReportResults

        public final CloudChannelReportsServiceClient.FetchReportResultsPagedResponse fetchReportResults​(ReportJobName reportJob)
        Retrieves data generated by [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].

        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 (CloudChannelReportsServiceClient cloudChannelReportsServiceClient =
     CloudChannelReportsServiceClient.create()) {
   ReportJobName reportJob = ReportJobName.of("[ACCOUNT]", "[REPORT_JOB]");
   for (Row element :
       cloudChannelReportsServiceClient.fetchReportResults(reportJob).iterateAll()) {
     // doThingsWith(element);
   }
 }
        Parameters:
        reportJob - Required. The report job created by [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob]. Report_job uses the format: accounts/{account_id}/reportJobs/{report_job_id}
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • fetchReportResults

        public final CloudChannelReportsServiceClient.FetchReportResultsPagedResponse fetchReportResults​(String reportJob)
        Retrieves data generated by [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].

        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 (CloudChannelReportsServiceClient cloudChannelReportsServiceClient =
     CloudChannelReportsServiceClient.create()) {
   String reportJob = ReportJobName.of("[ACCOUNT]", "[REPORT_JOB]").toString();
   for (Row element :
       cloudChannelReportsServiceClient.fetchReportResults(reportJob).iterateAll()) {
     // doThingsWith(element);
   }
 }
        Parameters:
        reportJob - Required. The report job created by [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob]. Report_job uses the format: accounts/{account_id}/reportJobs/{report_job_id}
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • fetchReportResults

        public final CloudChannelReportsServiceClient.FetchReportResultsPagedResponse fetchReportResults​(FetchReportResultsRequest request)
        Retrieves data generated by [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].

        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 (CloudChannelReportsServiceClient cloudChannelReportsServiceClient =
     CloudChannelReportsServiceClient.create()) {
   FetchReportResultsRequest request =
       FetchReportResultsRequest.newBuilder()
           .setReportJob(ReportJobName.of("[ACCOUNT]", "[REPORT_JOB]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .addAllPartitionKeys(new ArrayList<String>())
           .build();
   for (Row element :
       cloudChannelReportsServiceClient.fetchReportResults(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

      • fetchReportResultsPagedCallable

        public final com.google.api.gax.rpc.UnaryCallable<FetchReportResultsRequest,​CloudChannelReportsServiceClient.FetchReportResultsPagedResponse> fetchReportResultsPagedCallable()
        Retrieves data generated by [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].

        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 (CloudChannelReportsServiceClient cloudChannelReportsServiceClient =
     CloudChannelReportsServiceClient.create()) {
   FetchReportResultsRequest request =
       FetchReportResultsRequest.newBuilder()
           .setReportJob(ReportJobName.of("[ACCOUNT]", "[REPORT_JOB]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .addAllPartitionKeys(new ArrayList<String>())
           .build();
   ApiFuture<Row> future =
       cloudChannelReportsServiceClient.fetchReportResultsPagedCallable().futureCall(request);
   // Do something.
   for (Row element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

      • fetchReportResultsCallable

        public final com.google.api.gax.rpc.UnaryCallable<FetchReportResultsRequest,​FetchReportResultsResponse> fetchReportResultsCallable()
        Retrieves data generated by [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].

        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 (CloudChannelReportsServiceClient cloudChannelReportsServiceClient =
     CloudChannelReportsServiceClient.create()) {
   FetchReportResultsRequest request =
       FetchReportResultsRequest.newBuilder()
           .setReportJob(ReportJobName.of("[ACCOUNT]", "[REPORT_JOB]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .addAllPartitionKeys(new ArrayList<String>())
           .build();
   while (true) {
     FetchReportResultsResponse response =
         cloudChannelReportsServiceClient.fetchReportResultsCallable().call(request);
     for (Row element : response.getRowsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

      • listReports

        public final CloudChannelReportsServiceClient.ListReportsPagedResponse listReports​(String parent)
        Lists the reports that RunReportJob can run. These reports include an ID, a description, and the list of columns that will be in the result.

        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 (CloudChannelReportsServiceClient cloudChannelReportsServiceClient =
     CloudChannelReportsServiceClient.create()) {
   String parent = "parent-995424086";
   for (Report element : cloudChannelReportsServiceClient.listReports(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
        Parameters:
        parent - Required. The resource name of the partner account to list available reports for. Parent uses the format: accounts/{account_id}
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listReports

        public final CloudChannelReportsServiceClient.ListReportsPagedResponse listReports​(ListReportsRequest request)
        Lists the reports that RunReportJob can run. These reports include an ID, a description, and the list of columns that will be in the result.

        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 (CloudChannelReportsServiceClient cloudChannelReportsServiceClient =
     CloudChannelReportsServiceClient.create()) {
   ListReportsRequest request =
       ListReportsRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setLanguageCode("languageCode-2092349083")
           .build();
   for (Report element : cloudChannelReportsServiceClient.listReports(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

      • listReportsPagedCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListReportsRequest,​CloudChannelReportsServiceClient.ListReportsPagedResponse> listReportsPagedCallable()
        Lists the reports that RunReportJob can run. These reports include an ID, a description, and the list of columns that will be in the result.

        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 (CloudChannelReportsServiceClient cloudChannelReportsServiceClient =
     CloudChannelReportsServiceClient.create()) {
   ListReportsRequest request =
       ListReportsRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setLanguageCode("languageCode-2092349083")
           .build();
   ApiFuture<Report> future =
       cloudChannelReportsServiceClient.listReportsPagedCallable().futureCall(request);
   // Do something.
   for (Report element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

      • listReportsCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListReportsRequest,​ListReportsResponse> listReportsCallable()
        Lists the reports that RunReportJob can run. These reports include an ID, a description, and the list of columns that will be in the result.

        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 (CloudChannelReportsServiceClient cloudChannelReportsServiceClient =
     CloudChannelReportsServiceClient.create()) {
   ListReportsRequest request =
       ListReportsRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setLanguageCode("languageCode-2092349083")
           .build();
   while (true) {
     ListReportsResponse response =
         cloudChannelReportsServiceClient.listReportsCallable().call(request);
     for (Report element : response.getReportsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

      • shutdown

        public void shutdown()
        Specified by:
        shutdown in interface com.google.api.gax.core.BackgroundResource

      • isShutdown

        public boolean isShutdown()
        Specified by:
        isShutdown in interface com.google.api.gax.core.BackgroundResource

      • isTerminated

        public boolean isTerminated()
        Specified by:
        isTerminated in interface com.google.api.gax.core.BackgroundResource

      • shutdownNow

        public void shutdownNow()
        Specified by:
        shutdownNow in interface com.google.api.gax.core.BackgroundResource