Class ReportServiceClient (0.4.0)

Service Description: Provides methods for interacting with Reports.

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 (ReportServiceClient reportServiceClient = ReportServiceClient.create()) {
   ReportName report = ReportName.of("[NETWORK_CODE]", "[REPORT]");
   ExportSavedReportResponse response = reportServiceClient.exportSavedReportAsync(report).get();
 }
 

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

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 ReportServiceSettings 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
 ReportServiceSettings reportServiceSettings =
     ReportServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ReportServiceClient reportServiceClient = ReportServiceClient.create(reportServiceSettings);
 

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
 ReportServiceSettings reportServiceSettings =
     ReportServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ReportServiceClient reportServiceClient = ReportServiceClient.create(reportServiceSettings);
 

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

Constructs an instance of ReportServiceClient with default settings.

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

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

Constructs an instance of ReportServiceClient, 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.

Initiates the execution and export of a report asynchronously. Users can get the report by polling this operation via OperationsService.GetOperation. Intervals of at least 2 seconds are recommended, with an exponential backoff. Once a report is complete, the operation will contain a ExportSavedReportResponse in its response field.

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 (ReportServiceClient reportServiceClient = ReportServiceClient.create()) {
   ExportSavedReportRequest request =
       ExportSavedReportRequest.newBuilder()
           .setReport(ReportName.of("[NETWORK_CODE]", "[REPORT]").toString())
           .setIncludeReportProperties(true)
           .setIncludeIds(true)
           .setIncludeTotalsRow(true)
           .setFileName("fileName-735721945")
           .build();
   ExportSavedReportResponse response =
       reportServiceClient.exportSavedReportAsync(request).get();
 }
 

Initiates the execution and export of a report asynchronously. Users can get the report by polling this operation via OperationsService.GetOperation. Intervals of at least 2 seconds are recommended, with an exponential backoff. Once a report is complete, the operation will contain a ExportSavedReportResponse in its response field.

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 (ReportServiceClient reportServiceClient = ReportServiceClient.create()) {
   ReportName report = ReportName.of("[NETWORK_CODE]", "[REPORT]");
   ExportSavedReportResponse response = reportServiceClient.exportSavedReportAsync(report).get();
 }
 

Initiates the execution and export of a report asynchronously. Users can get the report by polling this operation via OperationsService.GetOperation. Intervals of at least 2 seconds are recommended, with an exponential backoff. Once a report is complete, the operation will contain a ExportSavedReportResponse in its response field.

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 (ReportServiceClient reportServiceClient = ReportServiceClient.create()) {
   String report = ReportName.of("[NETWORK_CODE]", "[REPORT]").toString();
   ExportSavedReportResponse response = reportServiceClient.exportSavedReportAsync(report).get();
 }
 

Initiates the execution and export of a report asynchronously. Users can get the report by polling this operation via OperationsService.GetOperation. Intervals of at least 2 seconds are recommended, with an exponential backoff. Once a report is complete, the operation will contain a ExportSavedReportResponse in its response field.

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 (ReportServiceClient reportServiceClient = ReportServiceClient.create()) {
   ExportSavedReportRequest request =
       ExportSavedReportRequest.newBuilder()
           .setReport(ReportName.of("[NETWORK_CODE]", "[REPORT]").toString())
           .setIncludeReportProperties(true)
           .setIncludeIds(true)
           .setIncludeTotalsRow(true)
           .setFileName("fileName-735721945")
           .build();
   ApiFuture<Operation> future =
       reportServiceClient.exportSavedReportCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Initiates the execution and export of a report asynchronously. Users can get the report by polling this operation via OperationsService.GetOperation. Intervals of at least 2 seconds are recommended, with an exponential backoff. Once a report is complete, the operation will contain a ExportSavedReportResponse in its response field.

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 (ReportServiceClient reportServiceClient = ReportServiceClient.create()) {
   ExportSavedReportRequest request =
       ExportSavedReportRequest.newBuilder()
           .setReport(ReportName.of("[NETWORK_CODE]", "[REPORT]").toString())
           .setIncludeReportProperties(true)
           .setIncludeIds(true)
           .setIncludeTotalsRow(true)
           .setFileName("fileName-735721945")
           .build();
   OperationFuture<ExportSavedReportResponse, ExportSavedReportMetadata> future =
       reportServiceClient.exportSavedReportOperationCallable().futureCall(request);
   // Do something.
   ExportSavedReportResponse response = future.get();
 }
 

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