Class PlacementServiceClient (0.12.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().

Methods
Method	Description	Method Variants
GetPlacement	API to retrieve a `Placement` object.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getPlacement(GetPlacementRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getPlacement(PlacementName name) getPlacement(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getPlacementCallable()
ListPlacements	API to retrieve a list of `Placement` objects.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listPlacements(ListPlacementsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listPlacements(NetworkName parent) listPlacements(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listPlacementsPagedCallable() listPlacementsCallable()

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.

Inheritance

java.lang.Object > PlacementServiceClient

Static Methods

create()

public static final PlacementServiceClient create()

Constructs an instance of PlacementServiceClient with default settings.

Returns
Type	Description
`PlacementServiceClient`

Exceptions
Type	Description
`IOException`

create(PlacementServiceSettings settings)

public static final PlacementServiceClient create(PlacementServiceSettings 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.

Parameter
Name	Description
`settings`	`PlacementServiceSettings`

Returns
Type	Description
`PlacementServiceClient`

Exceptions
Type	Description
`IOException`

create(PlacementServiceStub stub)

public static final PlacementServiceClient create(PlacementServiceStub stub)

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

Parameter
Name	Description
`stub`	`PlacementServiceStub`

Returns
Type	Description
`PlacementServiceClient`

Constructors

PlacementServiceClient(PlacementServiceSettings settings)

protected PlacementServiceClient(PlacementServiceSettings settings)

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.

Parameter
Name	Description
`settings`	`PlacementServiceSettings`

PlacementServiceClient(PlacementServiceStub stub)

protected PlacementServiceClient(PlacementServiceStub stub)

Parameter
Name	Description
`stub`	`PlacementServiceStub`

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
`duration`	`long`
`unit`	`TimeUnit`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`InterruptedException`

close()

public final void close()

getPlacement(GetPlacementRequest request)

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

Parameter
Name	Description
`request`	`GetPlacementRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Placement`

getPlacement(PlacementName name)

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

Parameter
Name	Description
`name`	`PlacementName` Required. The resource name of the Placement. Format: `networks/{network_code}/placements/{placement_id}`

Returns
Type	Description
`Placement`

getPlacement(String name)

public final Placement getPlacement(String 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);
 }

Parameter
Name	Description
`name`	`String` Required. The resource name of the Placement. Format: `networks/{network_code}/placements/{placement_id}`

Returns
Type	Description
`Placement`

getPlacementCallable()

public final UnaryCallable<GetPlacementRequest,Placement> getPlacementCallable()

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

Returns
Type	Description
`UnaryCallable<GetPlacementRequest,Placement>`

getSettings()

public final PlacementServiceSettings getSettings()

Returns
Type	Description
`PlacementServiceSettings`

getStub()

public PlacementServiceStub getStub()

Returns
Type	Description
`PlacementServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listPlacements(ListPlacementsRequest request)

public final PlacementServiceClient.ListPlacementsPagedResponse listPlacements(ListPlacementsRequest request)

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

Parameter
Name	Description
`request`	`ListPlacementsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`PlacementServiceClient.ListPlacementsPagedResponse`

listPlacements(NetworkName parent)

public final PlacementServiceClient.ListPlacementsPagedResponse listPlacements(NetworkName parent)

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

Parameter
Name	Description
`parent`	`NetworkName` Required. The parent, which owns this collection of Placements. Format: `networks/{network_code}`

Returns
Type	Description
`PlacementServiceClient.ListPlacementsPagedResponse`

listPlacements(String parent)

public final PlacementServiceClient.ListPlacementsPagedResponse listPlacements(String parent)

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

Parameter
Name	Description
`parent`	`String` Required. The parent, which owns this collection of Placements. Format: `networks/{network_code}`

Returns
Type	Description
`PlacementServiceClient.ListPlacementsPagedResponse`

listPlacementsCallable()

public final UnaryCallable<ListPlacementsRequest,ListPlacementsResponse> listPlacementsCallable()

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

Returns
Type	Description
`UnaryCallable<ListPlacementsRequest,ListPlacementsResponse>`

listPlacementsPagedCallable()

public final UnaryCallable<ListPlacementsRequest,PlacementServiceClient.ListPlacementsPagedResponse> listPlacementsPagedCallable()

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

Returns
Type	Description
`UnaryCallable<ListPlacementsRequest,ListPlacementsPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()