VersionsClient (Google Cloud Dialog Flow API Parent 4.9.1 API)

java.lang.Object
- com.google.cloud.dialogflow.v2.VersionsClient

All Implemented Interfaces:: BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class VersionsClient
extends Object
implements BackgroundResource

Service Description: Service for managing [Versions][google.cloud.dialogflow.v2.Version].

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 (VersionsClient versionsClient = VersionsClient.create()) {
   VersionName name = VersionName.ofProjectVersionName("[PROJECT]", "[VERSION]");
   Version response = versionsClient.getVersion(name);
 }

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

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

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 VersionsSettings 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
 VersionsSettings versionsSettings =
     VersionsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 VersionsClient versionsClient = VersionsClient.create(versionsSettings);

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
 VersionsSettings versionsSettings =
     VersionsSettings.newBuilder().setEndpoint(myEndpoint).build();
 VersionsClient versionsClient = VersionsClient.create(versionsSettings);

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
 VersionsSettings versionsSettings =
     VersionsSettings.newBuilder()
         .setTransportChannelProvider(
             VersionsSettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 VersionsClient versionsClient = VersionsClient.create(versionsSettings);

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`	`VersionsClient.ListLocationsFixedSizeCollection`
`static class`	`VersionsClient.ListLocationsPage`
`static class`	`VersionsClient.ListLocationsPagedResponse`
`static class`	`VersionsClient.ListVersionsFixedSizeCollection`
`static class`	`VersionsClient.ListVersionsPage`
`static class`	`VersionsClient.ListVersionsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`VersionsClient(VersionsSettings settings)` Constructs an instance of VersionsClient, using the given settings.
`protected`	`VersionsClient(VersionsStub 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 VersionsClient`	`create()` Constructs an instance of VersionsClient with default settings.
`static VersionsClient`	`create(VersionsSettings settings)` Constructs an instance of VersionsClient, using the given settings.
`static VersionsClient`	`create(VersionsStub stub)` Constructs an instance of VersionsClient, using the given stub for making calls.
`Version`	`createVersion(AgentName parent, Version version)` Creates an agent version.
`Version`	`createVersion(CreateVersionRequest request)` Creates an agent version.
`Version`	`createVersion(String parent, Version version)` Creates an agent version.
`UnaryCallable<CreateVersionRequest,Version>`	`createVersionCallable()` Creates an agent version.
`void`	`deleteVersion(DeleteVersionRequest request)` Delete the specified agent version.
`void`	`deleteVersion(String name)` Delete the specified agent version.
`void`	`deleteVersion(VersionName name)` Delete the specified agent version.
`UnaryCallable<DeleteVersionRequest,Empty>`	`deleteVersionCallable()` Delete the specified agent version.
`com.google.cloud.location.Location`	`getLocation(com.google.cloud.location.GetLocationRequest request)` Gets information about a location.
`UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`	`getLocationCallable()` Gets information about a location.
`VersionsSettings`	`getSettings()`
`VersionsStub`	`getStub()`
`Version`	`getVersion(GetVersionRequest request)` Retrieves the specified agent version.
`Version`	`getVersion(String name)` Retrieves the specified agent version.
`Version`	`getVersion(VersionName name)` Retrieves the specified agent version.
`UnaryCallable<GetVersionRequest,Version>`	`getVersionCallable()` Retrieves the specified agent version.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`VersionsClient.ListLocationsPagedResponse`	`listLocations(com.google.cloud.location.ListLocationsRequest request)` Lists information about the supported locations for this service.
`UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>`	`listLocationsCallable()` Lists information about the supported locations for this service.
`UnaryCallable<com.google.cloud.location.ListLocationsRequest,VersionsClient.ListLocationsPagedResponse>`	`listLocationsPagedCallable()` Lists information about the supported locations for this service.
`VersionsClient.ListVersionsPagedResponse`	`listVersions(AgentName parent)` Returns the list of all versions of the specified agent.
`VersionsClient.ListVersionsPagedResponse`	`listVersions(ListVersionsRequest request)` Returns the list of all versions of the specified agent.
`VersionsClient.ListVersionsPagedResponse`	`listVersions(String parent)` Returns the list of all versions of the specified agent.
`UnaryCallable<ListVersionsRequest,ListVersionsResponse>`	`listVersionsCallable()` Returns the list of all versions of the specified agent.
`UnaryCallable<ListVersionsRequest,VersionsClient.ListVersionsPagedResponse>`	`listVersionsPagedCallable()` Returns the list of all versions of the specified agent.
`void`	`shutdown()`
`void`	`shutdownNow()`
`Version`	`updateVersion(UpdateVersionRequest request)` Updates the specified agent version.
`Version`	`updateVersion(Version version, FieldMask updateMask)` Updates the specified agent version.
`UnaryCallable<UpdateVersionRequest,Version>`	`updateVersionCallable()` Updates the specified agent version.

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

Constructor Detail
- VersionsClient
```
protected VersionsClient(VersionsSettings settings)
                  throws IOException
```
  Constructs an instance of VersionsClient, 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
- VersionsClient
```
protected VersionsClient(VersionsStub stub)
```

Method Detail

create

public static final VersionsClient create()
                                   throws IOException

Constructs an instance of VersionsClient with default settings.

Throws:: IOException

create
```
public static final VersionsClient create(VersionsSettings settings)
                                   throws IOException
```
Constructs an instance of VersionsClient, 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 VersionsClient create(VersionsStub stub)
```
Constructs an instance of VersionsClient, using the given stub for making calls. This is for advanced usage - prefer using create(VersionsSettings).

getSettings

public final VersionsSettings getSettings()

getStub
```
public VersionsStub getStub()
```