Class VersionsClient (0.66.0)

GitHub RepositoryProduct ReferenceREST DocumentationRPC Documentation

Service Description: Service for managing Versions.

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

Methods
Method Description Method Variants

ListVersions

Returns the list of all versions in the specified Flow.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listVersions(ListVersionsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listVersions(FlowName parent)

  • listVersions(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.

  • listVersionsPagedCallable()

  • listVersionsCallable()

GetVersion

Retrieves the specified Version.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getVersion(GetVersionRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getVersion(VersionName name)

  • getVersion(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.

  • getVersionCallable()

CreateVersion

Creates a Version in the specified Flow.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: CreateVersionOperationMetadata - response: Version

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createVersionAsync(CreateVersionRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createVersionAsync(FlowName parent, Version version)

  • createVersionAsync(String parent, Version version)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createVersionOperationCallable()

  • createVersionCallable()

UpdateVersion

Updates the specified Version.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateVersion(UpdateVersionRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateVersion(Version version, 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.

  • updateVersionCallable()

DeleteVersion

Deletes the specified Version.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteVersion(DeleteVersionRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteVersion(VersionName name)

  • deleteVersion(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.

  • deleteVersionCallable()

LoadVersion

Loads resources in the specified version to the draft flow.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message - response: An Empty message

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • loadVersionAsync(LoadVersionRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • loadVersionAsync(VersionName name)

  • loadVersionAsync(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.

  • loadVersionOperationCallable()

  • loadVersionCallable()

CompareVersions

Compares the specified base version with target version.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • compareVersions(CompareVersionsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • compareVersions(VersionName baseVersion)

  • compareVersions(String baseVersion)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • compareVersionsCallable()

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

Inheritance

java.lang.Object > VersionsClient

Static Methods

create()

public static final VersionsClient create()

Constructs an instance of VersionsClient with default settings.

Returns
Type Description
VersionsClient
Exceptions
Type Description
IOException

create(VersionsSettings settings)

public static final VersionsClient create(VersionsSettings settings)

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.

Parameter
Name Description
settings VersionsSettings
Returns
Type Description
VersionsClient
Exceptions
Type Description
IOException

create(VersionsStub stub)

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).

Parameter
Name Description
stub VersionsStub
Returns
Type Description
VersionsClient

Constructors

VersionsClient(VersionsSettings settings)

protected VersionsClient(VersionsSettings settings)

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.

Parameter
Name Description
settings VersionsSettings

VersionsClient(VersionsStub stub)

protected VersionsClient(VersionsStub stub)
Parameter
Name Description
stub VersionsStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

public final void close()

compareVersions(CompareVersionsRequest request)

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);
 }
Parameter
Name Description
request CompareVersionsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
CompareVersionsResponse

compareVersions(VersionName baseVersion)

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);
 }
Parameter
Name Description
baseVersion VersionName

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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>.
Returns
Type Description
CompareVersionsResponse

compareVersions(String baseVersion)

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);
 }
Parameter
Name Description
baseVersion String

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/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>.
Returns
Type Description
CompareVersionsResponse

compareVersionsCallable()

public final 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();
 }
Returns
Type Description
UnaryCallable<CompareVersionsRequest,CompareVersionsResponse>

createVersionAsync(CreateVersionRequest request)

public final OperationFuture<Version,CreateVersionOperationMetadata> createVersionAsync(CreateVersionRequest request)

Creates a Version in the specified Flow.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: CreateVersionOperationMetadata

  • response: 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();
}
Parameter
Name Description
request CreateVersionRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Version,CreateVersionOperationMetadata>

createVersionAsync(FlowName parent, Version version)

public final OperationFuture<Version,CreateVersionOperationMetadata> createVersionAsync(FlowName parent, Version version)

Creates a Version in the specified Flow.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: CreateVersionOperationMetadata

  • response: 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
Name Description
parent FlowName

Required. The Flow to create an Version for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.
version Version

Required. The version to create.
Returns
Type Description
OperationFuture<Version,CreateVersionOperationMetadata>

createVersionAsync(String parent, Version version)

public final OperationFuture<Version,CreateVersionOperationMetadata> createVersionAsync(String parent, Version version)

Creates a Version in the specified Flow.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: CreateVersionOperationMetadata

  • response: 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
Name Description
parent String

Required. The Flow to create an Version for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.
version Version

Required. The version to create.
Returns
Type Description
OperationFuture<Version,CreateVersionOperationMetadata>

createVersionCallable()

public final UnaryCallable<CreateVersionRequest,Operation> createVersionCallable()

Creates a Version in the specified Flow.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: CreateVersionOperationMetadata

  • response: 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();
}
Returns
Type Description
UnaryCallable<CreateVersionRequest,Operation>

createVersionOperationCallable()

public final OperationCallable<CreateVersionRequest,Version,CreateVersionOperationMetadata> createVersionOperationCallable()

Creates a Version in the specified Flow.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: CreateVersionOperationMetadata

  • response: 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();
}
Returns
Type Description
OperationCallable<CreateVersionRequest,Version,CreateVersionOperationMetadata>

deleteVersion(DeleteVersionRequest request)

public final void deleteVersion(DeleteVersionRequest request)

Deletes the specified 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);
 }
Parameter
Name Description
request DeleteVersionRequest

The request object containing all of the parameters for the API call.

deleteVersion(VersionName name)

public final void deleteVersion(VersionName name)

Deletes the specified 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);
 }
Parameter
Name Description
name VersionName

Required. The name of the Version to delete. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>.

deleteVersion(String name)

public final void deleteVersion(String name)

Deletes the specified 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);
 }
Parameter
Name Description
name String

Required. The name of the Version to delete. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>.

deleteVersionCallable()

public final UnaryCallable<DeleteVersionRequest,Empty> deleteVersionCallable()

Deletes the specified 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();
 }
Returns
Type Description
UnaryCallable<DeleteVersionRequest,Empty>

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type Description
OperationsClient

getLocation(GetLocationRequest request)

public final Location getLocation(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);
 }
Parameter
Name Description
request com.google.cloud.location.GetLocationRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
com.google.cloud.location.Location

getLocationCallable()

public final UnaryCallable<GetLocationRequest,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();
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type Description
OperationsClient

getSettings()

public final VersionsSettings getSettings()
Returns
Type Description
VersionsSettings

getStub()

public VersionsStub getStub()
Returns
Type Description
VersionsStub

getVersion(GetVersionRequest request)

public final Version getVersion(GetVersionRequest request)

Retrieves the specified 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);
 }
Parameter
Name Description
request GetVersionRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Version

getVersion(VersionName name)

public final Version getVersion(VersionName name)

Retrieves the specified 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);
 }
Parameter
Name Description
name VersionName

Required. The name of the Version. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>.
Returns
Type Description
Version

getVersion(String name)

public final Version getVersion(String name)

Retrieves the specified 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);
 }
Parameter
Name Description
name String

Required. The name of the Version. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>.
Returns
Type Description
Version

getVersionCallable()

public final UnaryCallable<GetVersionRequest,Version> getVersionCallable()

Retrieves the specified 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();
 }
Returns
Type Description
UnaryCallable<GetVersionRequest,Version>

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listLocations(ListLocationsRequest request)

public final VersionsClient.ListLocationsPagedResponse listLocations(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);
   }
 }
Parameter
Name Description
request com.google.cloud.location.ListLocationsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
VersionsClient.ListLocationsPagedResponse

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,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;
     }
   }
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>

listLocationsPagedCallable()

public final UnaryCallable<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);
   }
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>

listVersions(FlowName parent)

public final VersionsClient.ListVersionsPagedResponse listVersions(FlowName parent)

Returns the list of all versions in the specified 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);
   }
 }
Parameter
Name Description
parent FlowName

Required. The Flow to list all versions for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.
Returns
Type Description
VersionsClient.ListVersionsPagedResponse

listVersions(ListVersionsRequest request)

public final VersionsClient.ListVersionsPagedResponse listVersions(ListVersionsRequest request)

Returns the list of all versions in the specified 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);
   }
 }
Parameter
Name Description
request ListVersionsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
VersionsClient.ListVersionsPagedResponse

listVersions(String parent)

public final VersionsClient.ListVersionsPagedResponse listVersions(String parent)

Returns the list of all versions in the specified 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);
   }
 }
Parameter
Name Description
parent String

Required. The Flow to list all versions for. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.
Returns
Type Description
VersionsClient.ListVersionsPagedResponse

listVersionsCallable()

public final UnaryCallable<ListVersionsRequest,ListVersionsResponse> listVersionsCallable()

Returns the list of all versions in the specified 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;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListVersionsRequest,ListVersionsResponse>

listVersionsPagedCallable()

public final UnaryCallable<ListVersionsRequest,VersionsClient.ListVersionsPagedResponse> listVersionsPagedCallable()

Returns the list of all versions in the specified 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);
   }
 }
Returns
Type Description
UnaryCallable<ListVersionsRequest,ListVersionsPagedResponse>

loadVersionAsync(LoadVersionRequest request)

public final OperationFuture<Empty,Struct> loadVersionAsync(LoadVersionRequest request)

Loads resources in the specified version to the draft flow.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

  • response: An Empty message

    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();
}
Parameter
Name Description
request LoadVersionRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Empty,Struct>

loadVersionAsync(VersionName name)

public final OperationFuture<Empty,Struct> loadVersionAsync(VersionName name)

Loads resources in the specified version to the draft flow.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

  • response: An Empty message

    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();
}
Parameter
Name Description
name VersionName

Required. The Version to be loaded to draft flow. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>.
Returns
Type Description
OperationFuture<Empty,Struct>

loadVersionAsync(String name)

public final OperationFuture<Empty,Struct> loadVersionAsync(String name)

Loads resources in the specified version to the draft flow.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

  • response: An Empty message

    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();
}
Parameter
Name Description
name String

Required. The Version to be loaded to draft flow. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/versions/<VersionID>.
Returns
Type Description
OperationFuture<Empty,Struct>

loadVersionCallable()

public final UnaryCallable<LoadVersionRequest,Operation> loadVersionCallable()

Loads resources in the specified version to the draft flow.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

  • response: An Empty message

    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();
}
Returns
Type Description
UnaryCallable<LoadVersionRequest,Operation>

loadVersionOperationCallable()

public final OperationCallable<LoadVersionRequest,Empty,Struct> loadVersionOperationCallable()

Loads resources in the specified version to the draft flow.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

  • response: An Empty message

    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();
}
Returns
Type Description
OperationCallable<LoadVersionRequest,Empty,Struct>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateVersion(UpdateVersionRequest request)

public final Version updateVersion(UpdateVersionRequest request)

Updates the specified 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);
 }
Parameter
Name Description
request UpdateVersionRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Version

updateVersion(Version version, FieldMask updateMask)

public final Version updateVersion(Version version, FieldMask updateMask)

Updates the specified 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
Name Description
version Version

Required. The version to update.
updateMask FieldMask

Required. The mask to control which fields get updated. Currently only description and display_name can be updated.
Returns
Type Description
Version

updateVersionCallable()

public final UnaryCallable<UpdateVersionRequest,Version> updateVersionCallable()

Updates the specified 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();
 }
Returns
Type Description
UnaryCallable<UpdateVersionRequest,Version>