Class PlacementServiceClient (0.4.0)

Service Description: Provides methods for handling Placement objects.

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 (PlacementServiceClient placementServiceClient = PlacementServiceClient.create()) {
   PlacementName name = PlacementName.of("[NETWORK_CODE]", "[PLACEMENT]");
   Placement response = placementServiceClient.getPlacement(name);
 }
 

Note: close() needs to be called on the PlacementServiceClient 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 PlacementServiceSettings 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
 PlacementServiceSettings placementServiceSettings =
     PlacementServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 PlacementServiceClient placementServiceClient =
     PlacementServiceClient.create(placementServiceSettings);
 

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
 PlacementServiceSettings placementServiceSettings =
     PlacementServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 PlacementServiceClient placementServiceClient =
     PlacementServiceClient.create(placementServiceSettings);
 

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

Constructs an instance of PlacementServiceClient with default settings.

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

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

API to retrieve a Placement object.

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 (PlacementServiceClient placementServiceClient = PlacementServiceClient.create()) {
   GetPlacementRequest request =
       GetPlacementRequest.newBuilder()
           .setName(PlacementName.of("[NETWORK_CODE]", "[PLACEMENT]").toString())
           .build();
   Placement response = placementServiceClient.getPlacement(request);
 }
 

API to retrieve a Placement object.

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 (PlacementServiceClient placementServiceClient = PlacementServiceClient.create()) {
   PlacementName name = PlacementName.of("[NETWORK_CODE]", "[PLACEMENT]");
   Placement response = placementServiceClient.getPlacement(name);
 }
 

API to retrieve a Placement object.

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 (PlacementServiceClient placementServiceClient = PlacementServiceClient.create()) {
   String name = PlacementName.of("[NETWORK_CODE]", "[PLACEMENT]").toString();
   Placement response = placementServiceClient.getPlacement(name);
 }
 

API to retrieve a Placement object.

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 (PlacementServiceClient placementServiceClient = PlacementServiceClient.create()) {
   GetPlacementRequest request =
       GetPlacementRequest.newBuilder()
           .setName(PlacementName.of("[NETWORK_CODE]", "[PLACEMENT]").toString())
           .build();
   ApiFuture<Placement> future =
       placementServiceClient.getPlacementCallable().futureCall(request);
   // Do something.
   Placement response = future.get();
 }
 

API to retrieve a list of Placement objects.

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 (PlacementServiceClient placementServiceClient = PlacementServiceClient.create()) {
   ListPlacementsRequest request =
       ListPlacementsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   for (Placement element : placementServiceClient.listPlacements(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

API to retrieve a list of Placement objects.

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 (PlacementServiceClient placementServiceClient = PlacementServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   for (Placement element : placementServiceClient.listPlacements(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

API to retrieve a list of Placement objects.

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 (PlacementServiceClient placementServiceClient = PlacementServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   for (Placement element : placementServiceClient.listPlacements(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

API to retrieve a list of Placement objects.

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 (PlacementServiceClient placementServiceClient = PlacementServiceClient.create()) {
   ListPlacementsRequest request =
       ListPlacementsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   while (true) {
     ListPlacementsResponse response =
         placementServiceClient.listPlacementsCallable().call(request);
     for (Placement element : response.getPlacementsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

API to retrieve a list of Placement objects.

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 (PlacementServiceClient placementServiceClient = PlacementServiceClient.create()) {
   ListPlacementsRequest request =
       ListPlacementsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   ApiFuture<Placement> future =
       placementServiceClient.listPlacementsPagedCallable().futureCall(request);
   // Do something.
   for (Placement element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }