Class DataSourcesServiceClient (0.1.0)

Service Description: Service to manage primary, supplemental, inventory and other data sources. See more in the Merchant Center help article.

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 (DataSourcesServiceClient dataSourcesServiceClient = DataSourcesServiceClient.create()) {
   DataSourceName name = DataSourceName.of("[ACCOUNT]", "[DATASOURCE]");
   DataSource response = dataSourcesServiceClient.getDataSource(name);
 }
 

Note: close() needs to be called on the DataSourcesServiceClient 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 DataSourcesServiceSettings 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
 DataSourcesServiceSettings dataSourcesServiceSettings =
     DataSourcesServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DataSourcesServiceClient dataSourcesServiceClient =
     DataSourcesServiceClient.create(dataSourcesServiceSettings);
 

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
 DataSourcesServiceSettings dataSourcesServiceSettings =
     DataSourcesServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 DataSourcesServiceClient dataSourcesServiceClient =
     DataSourcesServiceClient.create(dataSourcesServiceSettings);
 

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
 DataSourcesServiceSettings dataSourcesServiceSettings =
     DataSourcesServiceSettings.newHttpJsonBuilder().build();
 DataSourcesServiceClient dataSourcesServiceClient =
     DataSourcesServiceClient.create(dataSourcesServiceSettings);
 

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

Constructs an instance of DataSourcesServiceClient with default settings.

Constructs an instance of DataSourcesServiceClient, 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 DataSourcesServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(DataSourcesServiceSettings).

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

Creates the new data source configuration for the given account.

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 (DataSourcesServiceClient dataSourcesServiceClient = DataSourcesServiceClient.create()) {
   AccountName parent = AccountName.of("[ACCOUNT]");
   DataSource dataSource = DataSource.newBuilder().build();
   DataSource response = dataSourcesServiceClient.createDataSource(parent, dataSource);
 }
 

Creates the new data source configuration for the given account.

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 (DataSourcesServiceClient dataSourcesServiceClient = DataSourcesServiceClient.create()) {
   CreateDataSourceRequest request =
       CreateDataSourceRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setDataSource(DataSource.newBuilder().build())
           .build();
   DataSource response = dataSourcesServiceClient.createDataSource(request);
 }
 

Creates the new data source configuration for the given account.

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 (DataSourcesServiceClient dataSourcesServiceClient = DataSourcesServiceClient.create()) {
   String parent = AccountName.of("[ACCOUNT]").toString();
   DataSource dataSource = DataSource.newBuilder().build();
   DataSource response = dataSourcesServiceClient.createDataSource(parent, dataSource);
 }
 

Creates the new data source configuration for the given account.

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 (DataSourcesServiceClient dataSourcesServiceClient = DataSourcesServiceClient.create()) {
   CreateDataSourceRequest request =
       CreateDataSourceRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setDataSource(DataSource.newBuilder().build())
           .build();
   ApiFuture<DataSource> future =
       dataSourcesServiceClient.createDataSourceCallable().futureCall(request);
   // Do something.
   DataSource response = future.get();
 }
 

Deletes a data source from your Merchant Center account.

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 (DataSourcesServiceClient dataSourcesServiceClient = DataSourcesServiceClient.create()) {
   DataSourceName name = DataSourceName.of("[ACCOUNT]", "[DATASOURCE]");
   dataSourcesServiceClient.deleteDataSource(name);
 }
 

Deletes a data source from your Merchant Center account.

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 (DataSourcesServiceClient dataSourcesServiceClient = DataSourcesServiceClient.create()) {
   DeleteDataSourceRequest request =
       DeleteDataSourceRequest.newBuilder()
           .setName(DataSourceName.of("[ACCOUNT]", "[DATASOURCE]").toString())
           .build();
   dataSourcesServiceClient.deleteDataSource(request);
 }
 

Deletes a data source from your Merchant Center account.

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 (DataSourcesServiceClient dataSourcesServiceClient = DataSourcesServiceClient.create()) {
   String name = DataSourceName.of("[ACCOUNT]", "[DATASOURCE]").toString();
   dataSourcesServiceClient.deleteDataSource(name);
 }
 

Deletes a data source from your Merchant Center account.

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 (DataSourcesServiceClient dataSourcesServiceClient = DataSourcesServiceClient.create()) {
   DeleteDataSourceRequest request =
       DeleteDataSourceRequest.newBuilder()
           .setName(DataSourceName.of("[ACCOUNT]", "[DATASOURCE]").toString())
           .build();
   ApiFuture<Empty> future =
       dataSourcesServiceClient.deleteDataSourceCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Performs the data fetch immediately (even outside fetch schedule) on a data source from your Merchant Center Account. If you need to call this method more than once per day, you should use the Products service to update your product data instead. This method only works on data sources with a file input set.

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 (DataSourcesServiceClient dataSourcesServiceClient = DataSourcesServiceClient.create()) {
   FetchDataSourceRequest request =
       FetchDataSourceRequest.newBuilder()
           .setName(DataSourceName.of("[ACCOUNT]", "[DATASOURCE]").toString())
           .build();
   dataSourcesServiceClient.fetchDataSource(request);
 }
 

Performs the data fetch immediately (even outside fetch schedule) on a data source from your Merchant Center Account. If you need to call this method more than once per day, you should use the Products service to update your product data instead. This method only works on data sources with a file input set.

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 (DataSourcesServiceClient dataSourcesServiceClient = DataSourcesServiceClient.create()) {
   FetchDataSourceRequest request =
       FetchDataSourceRequest.newBuilder()
           .setName(DataSourceName.of("[ACCOUNT]", "[DATASOURCE]").toString())
           .build();
   ApiFuture<Empty> future =
       dataSourcesServiceClient.fetchDataSourceCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Retrieves the data source configuration for the given account.

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 (DataSourcesServiceClient dataSourcesServiceClient = DataSourcesServiceClient.create()) {
   DataSourceName name = DataSourceName.of("[ACCOUNT]", "[DATASOURCE]");
   DataSource response = dataSourcesServiceClient.getDataSource(name);
 }
 

Retrieves the data source configuration for the given account.

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 (DataSourcesServiceClient dataSourcesServiceClient = DataSourcesServiceClient.create()) {
   GetDataSourceRequest request =
       GetDataSourceRequest.newBuilder()
           .setName(DataSourceName.of("[ACCOUNT]", "[DATASOURCE]").toString())
           .build();
   DataSource response = dataSourcesServiceClient.getDataSource(request);
 }
 

Retrieves the data source configuration for the given account.

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 (DataSourcesServiceClient dataSourcesServiceClient = DataSourcesServiceClient.create()) {
   String name = DataSourceName.of("[ACCOUNT]", "[DATASOURCE]").toString();
   DataSource response = dataSourcesServiceClient.getDataSource(name);
 }
 

Retrieves the data source configuration for the given account.

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 (DataSourcesServiceClient dataSourcesServiceClient = DataSourcesServiceClient.create()) {
   GetDataSourceRequest request =
       GetDataSourceRequest.newBuilder()
           .setName(DataSourceName.of("[ACCOUNT]", "[DATASOURCE]").toString())
           .build();
   ApiFuture<DataSource> future =
       dataSourcesServiceClient.getDataSourceCallable().futureCall(request);
   // Do something.
   DataSource response = future.get();
 }
 

Lists the configurations for data sources for the given account.

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 (DataSourcesServiceClient dataSourcesServiceClient = DataSourcesServiceClient.create()) {
   AccountName parent = AccountName.of("[ACCOUNT]");
   for (DataSource element : dataSourcesServiceClient.listDataSources(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Lists the configurations for data sources for the given account.

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 (DataSourcesServiceClient dataSourcesServiceClient = DataSourcesServiceClient.create()) {
   ListDataSourcesRequest request =
       ListDataSourcesRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (DataSource element : dataSourcesServiceClient.listDataSources(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Lists the configurations for data sources for the given account.

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 (DataSourcesServiceClient dataSourcesServiceClient = DataSourcesServiceClient.create()) {
   String parent = AccountName.of("[ACCOUNT]").toString();
   for (DataSource element : dataSourcesServiceClient.listDataSources(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Lists the configurations for data sources for the given account.

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 (DataSourcesServiceClient dataSourcesServiceClient = DataSourcesServiceClient.create()) {
   ListDataSourcesRequest request =
       ListDataSourcesRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListDataSourcesResponse response =
         dataSourcesServiceClient.listDataSourcesCallable().call(request);
     for (DataSource element : response.getDataSourcesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Lists the configurations for data sources for the given account.

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 (DataSourcesServiceClient dataSourcesServiceClient = DataSourcesServiceClient.create()) {
   ListDataSourcesRequest request =
       ListDataSourcesRequest.newBuilder()
           .setParent(AccountName.of("[ACCOUNT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<DataSource> future =
       dataSourcesServiceClient.listDataSourcesPagedCallable().futureCall(request);
   // Do something.
   for (DataSource element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Updates the existing data source configuration. The fields that are set in the update mask but not provided in the resource will be deleted.

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 (DataSourcesServiceClient dataSourcesServiceClient = DataSourcesServiceClient.create()) {
   DataSource dataSource = DataSource.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   DataSource response = dataSourcesServiceClient.updateDataSource(dataSource, updateMask);
 }
 

Updates the existing data source configuration. The fields that are set in the update mask but not provided in the resource will be deleted.

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 (DataSourcesServiceClient dataSourcesServiceClient = DataSourcesServiceClient.create()) {
   UpdateDataSourceRequest request =
       UpdateDataSourceRequest.newBuilder()
           .setDataSource(DataSource.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   DataSource response = dataSourcesServiceClient.updateDataSource(request);
 }
 

Updates the existing data source configuration. The fields that are set in the update mask but not provided in the resource will be deleted.

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 (DataSourcesServiceClient dataSourcesServiceClient = DataSourcesServiceClient.create()) {
   UpdateDataSourceRequest request =
       UpdateDataSourceRequest.newBuilder()
           .setDataSource(DataSource.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<DataSource> future =
       dataSourcesServiceClient.updateDataSourceCallable().futureCall(request);
   // Do something.
   DataSource response = future.get();
 }