PlaybooksClient (Google Dialogflow CX 0.71.0 API)

java.lang.Object
- com.google.cloud.dialogflow.cx.v3beta1.PlaybooksClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@BetaApi
 @Generated(value="by gapic-generator-java")
public class PlaybooksClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: Service for managing [Playbooks][google.cloud.dialogflow.cx.v3beta1.Playbook].

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 (PlaybooksClient playbooksClient = PlaybooksClient.create()) {
   AgentName parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]");
   Playbook playbook = Playbook.newBuilder().build();
   Playbook response = playbooksClient.createPlaybook(parent, playbook);
 }

Note: close() needs to be called on the PlaybooksClient 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
CreatePlaybook	Creates a playbook in a specified agent.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createPlaybook(CreatePlaybookRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createPlaybook(AgentName parent, Playbook playbook) createPlaybook(String parent, Playbook playbook) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createPlaybookCallable()
DeletePlaybook	Deletes a specified playbook.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deletePlaybook(DeletePlaybookRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deletePlaybook(PlaybookName name) deletePlaybook(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. deletePlaybookCallable()
ListPlaybooks	Returns a list of playbooks in the specified agent.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listPlaybooks(ListPlaybooksRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listPlaybooks(AgentName parent) listPlaybooks(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. listPlaybooksPagedCallable() listPlaybooksCallable()
GetPlaybook	Retrieves the specified Playbook.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getPlaybook(GetPlaybookRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getPlaybook(PlaybookName name) getPlaybook(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. getPlaybookCallable()
UpdatePlaybook	Updates the specified Playbook.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updatePlaybook(UpdatePlaybookRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updatePlaybook(Playbook playbook, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updatePlaybookCallable()
CreatePlaybookVersion	Creates a version for the specified Playbook.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createPlaybookVersion(CreatePlaybookVersionRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createPlaybookVersion(PlaybookName parent, PlaybookVersion playbookVersion) createPlaybookVersion(String parent, PlaybookVersion playbookVersion) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createPlaybookVersionCallable()
GetPlaybookVersion	Retrieves the specified version of the Playbook.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getPlaybookVersion(GetPlaybookVersionRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getPlaybookVersion(PlaybookVersionName name) getPlaybookVersion(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. getPlaybookVersionCallable()
ListPlaybookVersions	Lists versions for the specified Playbook.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listPlaybookVersions(ListPlaybookVersionsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listPlaybookVersions(PlaybookName parent) listPlaybookVersions(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. listPlaybookVersionsPagedCallable() listPlaybookVersionsCallable()
DeletePlaybookVersion	Deletes the specified version of the Playbook.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deletePlaybookVersion(DeletePlaybookVersionRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deletePlaybookVersion(PlaybookVersionName name) deletePlaybookVersion(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. deletePlaybookVersionCallable()
ListLocations	Lists information about the supported locations for this service.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listLocations(ListLocationsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listLocationsPagedCallable() listLocationsCallable()
GetLocation	Gets information about a location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getLocation(GetLocationRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getLocationCallable()

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 PlaybooksSettings 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
 PlaybooksSettings playbooksSettings =
     PlaybooksSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 PlaybooksClient playbooksClient = PlaybooksClient.create(playbooksSettings);

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
 PlaybooksSettings playbooksSettings =
     PlaybooksSettings.newBuilder().setEndpoint(myEndpoint).build();
 PlaybooksClient playbooksClient = PlaybooksClient.create(playbooksSettings);

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
 PlaybooksSettings playbooksSettings = PlaybooksSettings.newHttpJsonBuilder().build();
 PlaybooksClient playbooksClient = PlaybooksClient.create(playbooksSettings);

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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PlaybooksClient.ListLocationsFixedSizeCollection`
`static class`	`PlaybooksClient.ListLocationsPage`
`static class`	`PlaybooksClient.ListLocationsPagedResponse`
`static class`	`PlaybooksClient.ListPlaybooksFixedSizeCollection`
`static class`	`PlaybooksClient.ListPlaybooksPage`
`static class`	`PlaybooksClient.ListPlaybooksPagedResponse`
`static class`	`PlaybooksClient.ListPlaybookVersionsFixedSizeCollection`
`static class`	`PlaybooksClient.ListPlaybookVersionsPage`
`static class`	`PlaybooksClient.ListPlaybookVersionsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`PlaybooksClient(PlaybooksSettings settings)` Constructs an instance of PlaybooksClient, using the given settings.
`protected`	`PlaybooksClient(PlaybooksStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static PlaybooksClient`	`create()` Constructs an instance of PlaybooksClient with default settings.
`static PlaybooksClient`	`create(PlaybooksSettings settings)` Constructs an instance of PlaybooksClient, using the given settings.
`static PlaybooksClient`	`create(PlaybooksStub stub)` Constructs an instance of PlaybooksClient, using the given stub for making calls.
`Playbook`	`createPlaybook(AgentName parent, Playbook playbook)` Creates a playbook in a specified agent.
`Playbook`	`createPlaybook(CreatePlaybookRequest request)` Creates a playbook in a specified agent.
`Playbook`	`createPlaybook(String parent, Playbook playbook)` Creates a playbook in a specified agent.
`com.google.api.gax.rpc.UnaryCallable<CreatePlaybookRequest,Playbook>`	`createPlaybookCallable()` Creates a playbook in a specified agent.
`PlaybookVersion`	`createPlaybookVersion(CreatePlaybookVersionRequest request)` Creates a version for the specified Playbook.
`PlaybookVersion`	`createPlaybookVersion(PlaybookName parent, PlaybookVersion playbookVersion)` Creates a version for the specified Playbook.
`PlaybookVersion`	`createPlaybookVersion(String parent, PlaybookVersion playbookVersion)` Creates a version for the specified Playbook.
`com.google.api.gax.rpc.UnaryCallable<CreatePlaybookVersionRequest,PlaybookVersion>`	`createPlaybookVersionCallable()` Creates a version for the specified Playbook.
`void`	`deletePlaybook(DeletePlaybookRequest request)` Deletes a specified playbook.
`void`	`deletePlaybook(PlaybookName name)` Deletes a specified playbook.
`void`	`deletePlaybook(String name)` Deletes a specified playbook.
`com.google.api.gax.rpc.UnaryCallable<DeletePlaybookRequest,com.google.protobuf.Empty>`	`deletePlaybookCallable()` Deletes a specified playbook.
`void`	`deletePlaybookVersion(DeletePlaybookVersionRequest request)` Deletes the specified version of the Playbook.
`void`	`deletePlaybookVersion(PlaybookVersionName name)` Deletes the specified version of the Playbook.
`void`	`deletePlaybookVersion(String name)` Deletes the specified version of the Playbook.
`com.google.api.gax.rpc.UnaryCallable<DeletePlaybookVersionRequest,com.google.protobuf.Empty>`	`deletePlaybookVersionCallable()` Deletes the specified version of the Playbook.
`com.google.cloud.location.Location`	`getLocation(com.google.cloud.location.GetLocationRequest request)` Gets information about a location.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`	`getLocationCallable()` Gets information about a location.
`Playbook`	`getPlaybook(GetPlaybookRequest request)` Retrieves the specified Playbook.
`Playbook`	`getPlaybook(PlaybookName name)` Retrieves the specified Playbook.
`Playbook`	`getPlaybook(String name)` Retrieves the specified Playbook.
`com.google.api.gax.rpc.UnaryCallable<GetPlaybookRequest,Playbook>`	`getPlaybookCallable()` Retrieves the specified Playbook.
`PlaybookVersion`	`getPlaybookVersion(GetPlaybookVersionRequest request)` Retrieves the specified version of the Playbook.
`PlaybookVersion`	`getPlaybookVersion(PlaybookVersionName name)` Retrieves the specified version of the Playbook.
`PlaybookVersion`	`getPlaybookVersion(String name)` Retrieves the specified version of the Playbook.
`com.google.api.gax.rpc.UnaryCallable<GetPlaybookVersionRequest,PlaybookVersion>`	`getPlaybookVersionCallable()` Retrieves the specified version of the Playbook.
`PlaybooksSettings`	`getSettings()`
`PlaybooksStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`PlaybooksClient.ListLocationsPagedResponse`	`listLocations(com.google.cloud.location.ListLocationsRequest request)` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>`	`listLocationsCallable()` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,PlaybooksClient.ListLocationsPagedResponse>`	`listLocationsPagedCallable()` Lists information about the supported locations for this service.
`PlaybooksClient.ListPlaybooksPagedResponse`	`listPlaybooks(AgentName parent)` Returns a list of playbooks in the specified agent.
`PlaybooksClient.ListPlaybooksPagedResponse`	`listPlaybooks(ListPlaybooksRequest request)` Returns a list of playbooks in the specified agent.
`PlaybooksClient.ListPlaybooksPagedResponse`	`listPlaybooks(String parent)` Returns a list of playbooks in the specified agent.
`com.google.api.gax.rpc.UnaryCallable<ListPlaybooksRequest,ListPlaybooksResponse>`	`listPlaybooksCallable()` Returns a list of playbooks in the specified agent.
`com.google.api.gax.rpc.UnaryCallable<ListPlaybooksRequest,PlaybooksClient.ListPlaybooksPagedResponse>`	`listPlaybooksPagedCallable()` Returns a list of playbooks in the specified agent.
`PlaybooksClient.ListPlaybookVersionsPagedResponse`	`listPlaybookVersions(ListPlaybookVersionsRequest request)` Lists versions for the specified Playbook.
`PlaybooksClient.ListPlaybookVersionsPagedResponse`	`listPlaybookVersions(PlaybookName parent)` Lists versions for the specified Playbook.
`PlaybooksClient.ListPlaybookVersionsPagedResponse`	`listPlaybookVersions(String parent)` Lists versions for the specified Playbook.
`com.google.api.gax.rpc.UnaryCallable<ListPlaybookVersionsRequest,ListPlaybookVersionsResponse>`	`listPlaybookVersionsCallable()` Lists versions for the specified Playbook.
`com.google.api.gax.rpc.UnaryCallable<ListPlaybookVersionsRequest,PlaybooksClient.ListPlaybookVersionsPagedResponse>`	`listPlaybookVersionsPagedCallable()` Lists versions for the specified Playbook.
`void`	`shutdown()`
`void`	`shutdownNow()`
`Playbook`	`updatePlaybook(Playbook playbook, com.google.protobuf.FieldMask updateMask)` Updates the specified Playbook.
`Playbook`	`updatePlaybook(UpdatePlaybookRequest request)` Updates the specified Playbook.
`com.google.api.gax.rpc.UnaryCallable<UpdatePlaybookRequest,Playbook>`	`updatePlaybookCallable()` Updates the specified Playbook.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- PlaybooksClient
```
protected PlaybooksClient(PlaybooksSettings settings)
                   throws IOException
```
  Constructs an instance of PlaybooksClient, 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
- PlaybooksClient
```
protected PlaybooksClient(PlaybooksStub stub)
```

Method Detail

create

public static final PlaybooksClient create()
                                    throws IOException

Constructs an instance of PlaybooksClient with default settings.

Throws:: IOException

create
```
public static final PlaybooksClient create(PlaybooksSettings settings)
                                    throws IOException
```
Constructs an instance of PlaybooksClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create
```
public static final PlaybooksClient create(PlaybooksStub stub)
```
Constructs an instance of PlaybooksClient, using the given stub for making calls. This is for advanced usage - prefer using create(PlaybooksSettings).

getSettings

public final PlaybooksSettings getSettings()

getStub
```
public PlaybooksStub getStub()
```

createPlaybook

public final Playbook createPlaybook(AgentName parent,
                                     Playbook playbook)

Creates a playbook in a specified agent.

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 (PlaybooksClient playbooksClient = PlaybooksClient.create()) {
   AgentName parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]");
   Playbook playbook = Playbook.newBuilder().build();
   Playbook response = playbooksClient.createPlaybook(parent, playbook);
 }

Parameters:: parent - Required. The agent to create a playbook for. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.; playbook - Required. The playbook to create.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createPlaybook

public final Playbook createPlaybook(String parent,
                                     Playbook playbook)

Creates a playbook in a specified agent.

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 (PlaybooksClient playbooksClient = PlaybooksClient.create()) {
   String parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString();
   Playbook playbook = Playbook.newBuilder().build();
   Playbook response = playbooksClient.createPlaybook(parent, playbook);
 }

Parameters:: parent - Required. The agent to create a playbook for. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.; playbook - Required. The playbook to create.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createPlaybook

public final Playbook createPlaybook(CreatePlaybookRequest request)

Creates a playbook in a specified agent.

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 (PlaybooksClient playbooksClient = PlaybooksClient.create()) {
   CreatePlaybookRequest request =
       CreatePlaybookRequest.newBuilder()
           .setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
           .setPlaybook(Playbook.newBuilder().build())
           .build();
   Playbook response = playbooksClient.createPlaybook(request);
 }

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

createPlaybookCallable

public final com.google.api.gax.rpc.UnaryCallable<CreatePlaybookRequest,Playbook> createPlaybookCallable()

Creates a playbook in a specified agent.

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 (PlaybooksClient playbooksClient = PlaybooksClient.create()) {
   CreatePlaybookRequest request =
       CreatePlaybookRequest.newBuilder()
           .setParent(AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]").toString())
           .setPlaybook(Playbook.newBuilder().build())
           .build();
   ApiFuture<Playbook> future = playbooksClient.createPlaybookCallable().futureCall(request);
   // Do something.
   Playbook response = future.get();
 }

deletePlaybook

public final void deletePlaybook(PlaybookName name)

Deletes a specified playbook.

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 (PlaybooksClient playbooksClient = PlaybooksClient.create()) {
   PlaybookName name = PlaybookName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]");
   playbooksClient.deletePlaybook(name);
 }

Parameters:: name - Required. The name of the playbook to delete. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deletePlaybook

public final void deletePlaybook(String name)

Deletes a specified playbook.

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 (PlaybooksClient playbooksClient = PlaybooksClient.create()) {
   String name = PlaybookName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]").toString();
   playbooksClient.deletePlaybook(name);
 }

Parameters:: name - Required. The name of the playbook to delete. Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/playbooks/<PlaybookID>`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deletePlaybook

public final void deletePlaybook(DeletePlaybookRequest request)

Deletes a specified playbook.

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 (PlaybooksClient playbooksClient = PlaybooksClient.create()) {
   DeletePlaybookRequest request =
       DeletePlaybookRequest.newBuilder()
           .setName(
               PlaybookName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]").toString())
           .build();
   playbooksClient.deletePlaybook(request);
 }

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

deletePlaybookCallable

public final com.google.api.gax.rpc.UnaryCallable<DeletePlaybookRequest,com.google.protobuf.Empty> deletePlaybookCallable()

Deletes a specified playbook.

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 (PlaybooksClient playbooksClient = PlaybooksClient.create()) {
   DeletePlaybookRequest request =
       DeletePlaybookRequest.newBuilder()
           .setName(
               PlaybookName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[PLAYBOOK]").toString())
           .build();
   ApiFuture<Empty> future = playbooksClient.deletePlaybookCallable().futureCall(request);
   // Do something.
   future.get();
 }