Package com.google.cloud.dialogflow.cx.v3beta1

Class VersionsClient

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, AutoCloseable
    @BetaApi
@Generated("by gapic-generator-java")
public class VersionsClient
extends Object
implements com.google.api.gax.core.BackgroundResource
    Service Description: Service for managing [Versions][google.cloud.dialogflow.cx.v3beta1.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.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[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:

    1. 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.
    2. 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.
    3. 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.newHttpJsonBuilder().build();
 VersionsClient versionsClient = VersionsClient.create(versionsSettings);

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

    • 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​(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).

      • getOperationsClient

        public final com.google.longrunning.OperationsClient getOperationsClient()
        Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

      • getHttpJsonOperationsClient

        @BetaApi
public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()
        Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

      • listVersions

        public final VersionsClient.ListVersionsPagedResponse listVersions​(FlowName parent)
        Returns the list of all versions in the specified [Flow][google.cloud.dialogflow.cx.v3beta1.Flow].

        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 (VersionsClient versionsClient = VersionsClient.create()) {
   FlowName parent = FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]");
   for (Version element : versionsClient.listVersions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
        Parameters:
        parent - Required. The [Flow][google.cloud.dialogflow.cx.v3beta1.Flow] to list all versions for. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listVersions

        public final VersionsClient.ListVersionsPagedResponse listVersions​(String parent)
        Returns the list of all versions in the specified [Flow][google.cloud.dialogflow.cx.v3beta1.Flow].

        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 (VersionsClient versionsClient = VersionsClient.create()) {
   String parent = FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString();
   for (Version element : versionsClient.listVersions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
        Parameters:
        parent - Required. The [Flow][google.cloud.dialogflow.cx.v3beta1.Flow] to list all versions for. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • listVersions

        public final VersionsClient.ListVersionsPagedResponse listVersions​(ListVersionsRequest request)
        Returns the list of all versions in the specified [Flow][google.cloud.dialogflow.cx.v3beta1.Flow].

        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 (VersionsClient versionsClient = VersionsClient.create()) {
   ListVersionsRequest request =
       ListVersionsRequest.newBuilder()
           .setParent(FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Version element : versionsClient.listVersions(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
        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

      • listVersionsPagedCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListVersionsRequest,​VersionsClient.ListVersionsPagedResponse> listVersionsPagedCallable()
        Returns the list of all versions in the specified [Flow][google.cloud.dialogflow.cx.v3beta1.Flow].

        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 (VersionsClient versionsClient = VersionsClient.create()) {
   ListVersionsRequest request =
       ListVersionsRequest.newBuilder()
           .setParent(FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Version> future = versionsClient.listVersionsPagedCallable().futureCall(request);
   // Do something.
   for (Version element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

      • listVersionsCallable

        public final com.google.api.gax.rpc.UnaryCallable<ListVersionsRequest,​ListVersionsResponse> listVersionsCallable()
        Returns the list of all versions in the specified [Flow][google.cloud.dialogflow.cx.v3beta1.Flow].

        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 (VersionsClient versionsClient = VersionsClient.create()) {
   ListVersionsRequest request =
       ListVersionsRequest.newBuilder()
           .setParent(FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListVersionsResponse response = versionsClient.listVersionsCallable().call(request);
     for (Version element : response.getVersionsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

      • getVersion

        public final Version getVersion​(VersionName name)
        Retrieves the specified [Version][google.cloud.dialogflow.cx.v3beta1.Version].

        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 (VersionsClient versionsClient = VersionsClient.create()) {
   VersionName name =
       VersionName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[VERSION]");
   Version response = versionsClient.getVersion(name);
 }
        Parameters:
        name - Required. The name of the [Version][google.cloud.dialogflow.cx.v3beta1.Version]. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getVersion

        public final Version getVersion​(String name)
        Retrieves the specified [Version][google.cloud.dialogflow.cx.v3beta1.Version].

        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 (VersionsClient versionsClient = VersionsClient.create()) {
   String name =
       VersionName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[VERSION]").toString();
   Version response = versionsClient.getVersion(name);
 }
        Parameters:
        name - Required. The name of the [Version][google.cloud.dialogflow.cx.v3beta1.Version]. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • getVersion

        public final Version getVersion​(GetVersionRequest request)
        Retrieves the specified [Version][google.cloud.dialogflow.cx.v3beta1.Version].

        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 (VersionsClient versionsClient = VersionsClient.create()) {
   GetVersionRequest request =
       GetVersionRequest.newBuilder()
           .setName(
               VersionName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[VERSION]")
                   .toString())
           .build();
   Version response = versionsClient.getVersion(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

      • getVersionCallable

        public final com.google.api.gax.rpc.UnaryCallable<GetVersionRequest,​Version> getVersionCallable()
        Retrieves the specified [Version][google.cloud.dialogflow.cx.v3beta1.Version].

        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 (VersionsClient versionsClient = VersionsClient.create()) {
   GetVersionRequest request =
       GetVersionRequest.newBuilder()
           .setName(
               VersionName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[VERSION]")
                   .toString())
           .build();
   ApiFuture<Version> future = versionsClient.getVersionCallable().futureCall(request);
   // Do something.
   Version response = future.get();
 }

      • createVersionAsync

        public final com.google.api.gax.longrunning.OperationFuture<Version,​CreateVersionOperationMetadata> createVersionAsync​(FlowName parent,
                                                                                                                             Version version)
        Creates a [Version][google.cloud.dialogflow.cx.v3beta1.Version] in the specified [Flow][google.cloud.dialogflow.cx.v3beta1.Flow].

        This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:

        - `metadata`: [CreateVersionOperationMetadata][google.cloud.dialogflow.cx.v3beta1.CreateVersionOperationMetadata] - `response`: [Version][google.cloud.dialogflow.cx.v3beta1.Version]

        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 (VersionsClient versionsClient = VersionsClient.create()) {
   FlowName parent = FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]");
   Version version = Version.newBuilder().build();
   Version response = versionsClient.createVersionAsync(parent, version).get();
 }
        Parameters:
        parent - Required. The [Flow][google.cloud.dialogflow.cx.v3beta1.Flow] to create an [Version][google.cloud.dialogflow.cx.v3beta1.Version] for. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>`.
        version - Required. The version to create.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • createVersionAsync

        public final com.google.api.gax.longrunning.OperationFuture<Version,​CreateVersionOperationMetadata> createVersionAsync​(String parent,
                                                                                                                             Version version)
        Creates a [Version][google.cloud.dialogflow.cx.v3beta1.Version] in the specified [Flow][google.cloud.dialogflow.cx.v3beta1.Flow].

        This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:

        - `metadata`: [CreateVersionOperationMetadata][google.cloud.dialogflow.cx.v3beta1.CreateVersionOperationMetadata] - `response`: [Version][google.cloud.dialogflow.cx.v3beta1.Version]

        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 (VersionsClient versionsClient = VersionsClient.create()) {
   String parent = FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString();
   Version version = Version.newBuilder().build();
   Version response = versionsClient.createVersionAsync(parent, version).get();
 }
        Parameters:
        parent - Required. The [Flow][google.cloud.dialogflow.cx.v3beta1.Flow] to create an [Version][google.cloud.dialogflow.cx.v3beta1.Version] for. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>`.
        version - Required. The version to create.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • createVersionAsync

        public final com.google.api.gax.longrunning.OperationFuture<Version,​CreateVersionOperationMetadata> createVersionAsync​(CreateVersionRequest request)
        Creates a [Version][google.cloud.dialogflow.cx.v3beta1.Version] in the specified [Flow][google.cloud.dialogflow.cx.v3beta1.Flow].

        This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:

        - `metadata`: [CreateVersionOperationMetadata][google.cloud.dialogflow.cx.v3beta1.CreateVersionOperationMetadata] - `response`: [Version][google.cloud.dialogflow.cx.v3beta1.Version]

        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 (VersionsClient versionsClient = VersionsClient.create()) {
   CreateVersionRequest request =
       CreateVersionRequest.newBuilder()
           .setParent(FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString())
           .setVersion(Version.newBuilder().build())
           .build();
   Version response = versionsClient.createVersionAsync(request).get();
 }
        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

      • createVersionOperationCallable

        public final com.google.api.gax.rpc.OperationCallable<CreateVersionRequest,​Version,​CreateVersionOperationMetadata> createVersionOperationCallable()
        Creates a [Version][google.cloud.dialogflow.cx.v3beta1.Version] in the specified [Flow][google.cloud.dialogflow.cx.v3beta1.Flow].

        This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:

        - `metadata`: [CreateVersionOperationMetadata][google.cloud.dialogflow.cx.v3beta1.CreateVersionOperationMetadata] - `response`: [Version][google.cloud.dialogflow.cx.v3beta1.Version]

        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 (VersionsClient versionsClient = VersionsClient.create()) {
   CreateVersionRequest request =
       CreateVersionRequest.newBuilder()
           .setParent(FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString())
           .setVersion(Version.newBuilder().build())
           .build();
   OperationFuture<Version, CreateVersionOperationMetadata> future =
       versionsClient.createVersionOperationCallable().futureCall(request);
   // Do something.
   Version response = future.get();
 }

      • createVersionCallable

        public final com.google.api.gax.rpc.UnaryCallable<CreateVersionRequest,​com.google.longrunning.Operation> createVersionCallable()
        Creates a [Version][google.cloud.dialogflow.cx.v3beta1.Version] in the specified [Flow][google.cloud.dialogflow.cx.v3beta1.Flow].

        This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:

        - `metadata`: [CreateVersionOperationMetadata][google.cloud.dialogflow.cx.v3beta1.CreateVersionOperationMetadata] - `response`: [Version][google.cloud.dialogflow.cx.v3beta1.Version]

        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 (VersionsClient versionsClient = VersionsClient.create()) {
   CreateVersionRequest request =
       CreateVersionRequest.newBuilder()
           .setParent(FlowName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]").toString())
           .setVersion(Version.newBuilder().build())
           .build();
   ApiFuture<Operation> future = versionsClient.createVersionCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

      • updateVersion

        public final Version updateVersion​(Version version,
                                   com.google.protobuf.FieldMask updateMask)
        Updates the specified [Version][google.cloud.dialogflow.cx.v3beta1.Version].

        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 (VersionsClient versionsClient = VersionsClient.create()) {
   Version version = Version.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Version response = versionsClient.updateVersion(version, updateMask);
 }
        Parameters:
        version - Required. The version to update.
        updateMask - Required. The mask to control which fields get updated. Currently only `description` and `display_name` can be updated.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • updateVersion

        public final Version updateVersion​(UpdateVersionRequest request)
        Updates the specified [Version][google.cloud.dialogflow.cx.v3beta1.Version].

        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 (VersionsClient versionsClient = VersionsClient.create()) {
   UpdateVersionRequest request =
       UpdateVersionRequest.newBuilder()
           .setVersion(Version.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Version response = versionsClient.updateVersion(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

      • updateVersionCallable

        public final com.google.api.gax.rpc.UnaryCallable<UpdateVersionRequest,​Version> updateVersionCallable()
        Updates the specified [Version][google.cloud.dialogflow.cx.v3beta1.Version].

        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 (VersionsClient versionsClient = VersionsClient.create()) {
   UpdateVersionRequest request =
       UpdateVersionRequest.newBuilder()
           .setVersion(Version.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Version> future = versionsClient.updateVersionCallable().futureCall(request);
   // Do something.
   Version response = future.get();
 }

      • deleteVersion

        public final void deleteVersion​(VersionName name)
        Deletes the specified [Version][google.cloud.dialogflow.cx.v3beta1.Version].

        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 (VersionsClient versionsClient = VersionsClient.create()) {
   VersionName name =
       VersionName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[VERSION]");
   versionsClient.deleteVersion(name);
 }
        Parameters:
        name - Required. The name of the [Version][google.cloud.dialogflow.cx.v3beta1.Version] to delete. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • deleteVersion

        public final void deleteVersion​(String name)
        Deletes the specified [Version][google.cloud.dialogflow.cx.v3beta1.Version].

        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 (VersionsClient versionsClient = VersionsClient.create()) {
   String name =
       VersionName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[VERSION]").toString();
   versionsClient.deleteVersion(name);
 }
        Parameters:
        name - Required. The name of the [Version][google.cloud.dialogflow.cx.v3beta1.Version] to delete. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • deleteVersion

        public final void deleteVersion​(DeleteVersionRequest request)
        Deletes the specified [Version][google.cloud.dialogflow.cx.v3beta1.Version].

        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 (VersionsClient versionsClient = VersionsClient.create()) {
   DeleteVersionRequest request =
       DeleteVersionRequest.newBuilder()
           .setName(
               VersionName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[VERSION]")
                   .toString())
           .build();
   versionsClient.deleteVersion(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

      • deleteVersionCallable

        public final com.google.api.gax.rpc.UnaryCallable<DeleteVersionRequest,​com.google.protobuf.Empty> deleteVersionCallable()
        Deletes the specified [Version][google.cloud.dialogflow.cx.v3beta1.Version].

        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 (VersionsClient versionsClient = VersionsClient.create()) {
   DeleteVersionRequest request =
       DeleteVersionRequest.newBuilder()
           .setName(
               VersionName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[VERSION]")
                   .toString())
           .build();
   ApiFuture<Empty> future = versionsClient.deleteVersionCallable().futureCall(request);
   // Do something.
   future.get();
 }

      • loadVersionAsync

        public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,​com.google.protobuf.Struct> loadVersionAsync​(VersionName name)
        Loads resources in the specified version to the draft flow.

        This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:

        - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)

        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 (VersionsClient versionsClient = VersionsClient.create()) {
   VersionName name =
       VersionName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[VERSION]");
   versionsClient.loadVersionAsync(name).get();
 }
        Parameters:
        name - Required. The [Version][google.cloud.dialogflow.cx.v3beta1.Version] to be loaded to draft flow. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • loadVersionAsync

        public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,​com.google.protobuf.Struct> loadVersionAsync​(String name)
        Loads resources in the specified version to the draft flow.

        This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:

        - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)

        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 (VersionsClient versionsClient = VersionsClient.create()) {
   String name =
       VersionName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[VERSION]").toString();
   versionsClient.loadVersionAsync(name).get();
 }
        Parameters:
        name - Required. The [Version][google.cloud.dialogflow.cx.v3beta1.Version] to be loaded to draft flow. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/versions/<Version ID>`.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • loadVersionAsync

        public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,​com.google.protobuf.Struct> loadVersionAsync​(LoadVersionRequest request)
        Loads resources in the specified version to the draft flow.

        This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:

        - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)

        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 (VersionsClient versionsClient = VersionsClient.create()) {
   LoadVersionRequest request =
       LoadVersionRequest.newBuilder()
           .setName(
               VersionName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[VERSION]")
                   .toString())
           .setAllowOverrideAgentResources(true)
           .build();
   versionsClient.loadVersionAsync(request).get();
 }
        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

      • loadVersionOperationCallable

        public final com.google.api.gax.rpc.OperationCallable<LoadVersionRequest,​com.google.protobuf.Empty,​com.google.protobuf.Struct> loadVersionOperationCallable()
        Loads resources in the specified version to the draft flow.

        This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:

        - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)

        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 (VersionsClient versionsClient = VersionsClient.create()) {
   LoadVersionRequest request =
       LoadVersionRequest.newBuilder()
           .setName(
               VersionName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[VERSION]")
                   .toString())
           .setAllowOverrideAgentResources(true)
           .build();
   OperationFuture<Empty, Struct> future =
       versionsClient.loadVersionOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

      • loadVersionCallable

        public final com.google.api.gax.rpc.UnaryCallable<LoadVersionRequest,​com.google.longrunning.Operation> loadVersionCallable()
        Loads resources in the specified version to the draft flow.

        This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields:

        - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)

        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 (VersionsClient versionsClient = VersionsClient.create()) {
   LoadVersionRequest request =
       LoadVersionRequest.newBuilder()
           .setName(
               VersionName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[VERSION]")
                   .toString())
           .setAllowOverrideAgentResources(true)
           .build();
   ApiFuture<Operation> future = versionsClient.loadVersionCallable().futureCall(request);
   // Do something.
   future.get();
 }

      • compareVersions

        public final CompareVersionsResponse compareVersions​(VersionName baseVersion)
        Compares the specified base version with target version.

        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 (VersionsClient versionsClient = VersionsClient.create()) {
   VersionName baseVersion =
       VersionName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[VERSION]");
   CompareVersionsResponse response = versionsClient.compareVersions(baseVersion);
 }
        Parameters:
        baseVersion - Required. Name of the base flow version to compare with the target version. Use version ID `0` to indicate the draft version of the specified flow.

        Format: `projects/<Project ID>/locations/<Location ID>/agents/ <Agent ID>/flows/<Flow ID>/versions/<Version ID>`.

        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • compareVersions

        public final CompareVersionsResponse compareVersions​(String baseVersion)
        Compares the specified base version with target version.

        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 (VersionsClient versionsClient = VersionsClient.create()) {
   String baseVersion =
       VersionName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[VERSION]").toString();
   CompareVersionsResponse response = versionsClient.compareVersions(baseVersion);
 }
        Parameters:
        baseVersion - Required. Name of the base flow version to compare with the target version. Use version ID `0` to indicate the draft version of the specified flow.

        Format: `projects/<Project ID>/locations/<Location ID>/agents/ <Agent ID>/flows/<Flow ID>/versions/<Version ID>`.

        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • compareVersions

        public final CompareVersionsResponse compareVersions​(CompareVersionsRequest request)
        Compares the specified base version with target version.

        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 (VersionsClient versionsClient = VersionsClient.create()) {
   CompareVersionsRequest request =
       CompareVersionsRequest.newBuilder()
           .setBaseVersion(
               VersionName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[VERSION]")
                   .toString())
           .setTargetVersion(
               VersionName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[VERSION]")
                   .toString())
           .setLanguageCode("languageCode-2092349083")
           .build();
   CompareVersionsResponse response = versionsClient.compareVersions(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

      • compareVersionsCallable

        public final com.google.api.gax.rpc.UnaryCallable<CompareVersionsRequest,​CompareVersionsResponse> compareVersionsCallable()
        Compares the specified base version with target version.

        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 (VersionsClient versionsClient = VersionsClient.create()) {
   CompareVersionsRequest request =
       CompareVersionsRequest.newBuilder()
           .setBaseVersion(
               VersionName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[VERSION]")
                   .toString())
           .setTargetVersion(
               VersionName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[VERSION]")
                   .toString())
           .setLanguageCode("languageCode-2092349083")
           .build();
   ApiFuture<CompareVersionsResponse> future =
       versionsClient.compareVersionsCallable().futureCall(request);
   // Do something.
   CompareVersionsResponse response = future.get();
 }

      • listLocations

        public final VersionsClient.ListLocationsPagedResponse listLocations​(com.google.cloud.location.ListLocationsRequest request)
        Lists information about the supported locations for this service.

        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 (VersionsClient versionsClient = VersionsClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : versionsClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
        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

      • listLocationsPagedCallable

        public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,​VersionsClient.ListLocationsPagedResponse> listLocationsPagedCallable()
        Lists information about the supported locations for this service.

        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 (VersionsClient versionsClient = VersionsClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future = versionsClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

      • listLocationsCallable

        public final 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.

        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 (VersionsClient versionsClient = VersionsClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response = versionsClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

      • getLocation

        public final com.google.cloud.location.Location getLocation​(com.google.cloud.location.GetLocationRequest request)
        Gets information about a location.

        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 (VersionsClient versionsClient = VersionsClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = versionsClient.getLocation(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

      • getLocationCallable

        public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,​com.google.cloud.location.Location> getLocationCallable()
        Gets information about a location.

        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 (VersionsClient versionsClient = VersionsClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future = versionsClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }

      • shutdown

        public void shutdown()
        Specified by:
        shutdown in interface com.google.api.gax.core.BackgroundResource

      • isShutdown

        public boolean isShutdown()
        Specified by:
        isShutdown in interface com.google.api.gax.core.BackgroundResource

      • isTerminated

        public boolean isTerminated()
        Specified by:
        isTerminated in interface com.google.api.gax.core.BackgroundResource

      • shutdownNow

        public void shutdownNow()
        Specified by:
        shutdownNow in interface com.google.api.gax.core.BackgroundResource