Class VersionsClient (2.11.0)

Service for managing Versions.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

VersionsClient(VersionsClient const &)

Copy and move support

Parameter
Name Description
VersionsClient const &

VersionsClient(VersionsClient &&)

Copy and move support

Parameter
Name Description
VersionsClient &&

VersionsClient(std::shared_ptr< VersionsConnection >, Options)

Parameters
Name Description
connection std::shared_ptr< VersionsConnection >
opts Options

Operators

operator=(VersionsClient const &)

Copy and move support

Parameter
Name Description
VersionsClient const &
Returns
Type Description
VersionsClient &

operator=(VersionsClient &&)

Copy and move support

Parameter
Name Description
VersionsClient &&
Returns
Type Description
VersionsClient &

Functions

ListVersions(std::string const &, Options)

Returns the list of all versions of the specified agent.

Parameters
Name Description
parent std::string const &

Required. The agent to list all versions from. Supported formats:

  • projects/<ProjectID>/agent
  • projects/<ProjectID>/locations/<Location ID>/agent
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::dialogflow::v2::Version >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dialogflow.v2.Version, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListVersions(google::cloud::dialogflow::v2::ListVersionsRequest, Options)

Returns the list of all versions of the specified agent.

Parameters
Name Description
request google::cloud::dialogflow::v2::ListVersionsRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.v2.ListVersionsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::dialogflow::v2::Version >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.dialogflow.v2.Version, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetVersion(std::string const &, Options)

Retrieves the specified agent version.

Parameters
Name Description
name std::string const &

Required. The name of the version. Supported formats:

  • projects/<ProjectID>/agent/versions/<Version ID>
  • projects/<ProjectID>/locations/<Location ID>/agent/versions/<Version ID>
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::dialogflow::v2::Version >

the result of the RPC. The response message type (google.cloud.dialogflow.v2.Version) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetVersion(google::cloud::dialogflow::v2::GetVersionRequest const &, Options)

Retrieves the specified agent version.

Parameters
Name Description
request google::cloud::dialogflow::v2::GetVersionRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.v2.GetVersionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::dialogflow::v2::Version >

the result of the RPC. The response message type (google.cloud.dialogflow.v2.Version) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateVersion(std::string const &, google::cloud::dialogflow::v2::Version const &, Options)

Creates an agent version.

The new version points to the agent instance in the "default" environment.

Parameters
Name Description
parent std::string const &

Required. The agent to create a version for. Supported formats:

  • projects/<ProjectID>/agent
  • projects/<ProjectID>/locations/<Location ID>/agent
version google::cloud::dialogflow::v2::Version const &

Required. The version to create.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::dialogflow::v2::Version >

the result of the RPC. The response message type (google.cloud.dialogflow.v2.Version) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateVersion(google::cloud::dialogflow::v2::CreateVersionRequest const &, Options)

Creates an agent version.

The new version points to the agent instance in the "default" environment.

Parameters
Name Description
request google::cloud::dialogflow::v2::CreateVersionRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.v2.CreateVersionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::dialogflow::v2::Version >

the result of the RPC. The response message type (google.cloud.dialogflow.v2.Version) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateVersion(google::cloud::dialogflow::v2::Version const &, google::protobuf::FieldMask const &, Options)

Updates the specified agent version.

Note that this method does not allow you to update the state of the agent the given version points to. It allows you to update only mutable properties of the version resource.

Parameters
Name Description
version google::cloud::dialogflow::v2::Version const &

Required. The version to update. Supported formats:

  • projects/<ProjectID>/agent/versions/<Version ID>
  • projects/<ProjectID>/locations/<Location ID>/agent/versions/<Version ID>
update_mask google::protobuf::FieldMask const &

Required. The mask to control which fields get updated.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::dialogflow::v2::Version >

the result of the RPC. The response message type (google.cloud.dialogflow.v2.Version) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdateVersion(google::cloud::dialogflow::v2::UpdateVersionRequest const &, Options)

Updates the specified agent version.

Note that this method does not allow you to update the state of the agent the given version points to. It allows you to update only mutable properties of the version resource.

Parameters
Name Description
request google::cloud::dialogflow::v2::UpdateVersionRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.v2.UpdateVersionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::dialogflow::v2::Version >

the result of the RPC. The response message type (google.cloud.dialogflow.v2.Version) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteVersion(std::string const &, Options)

Delete the specified agent version.

Parameters
Name Description
name std::string const &

Required. The name of the version to delete. Supported formats:

  • projects/<ProjectID>/agent/versions/<Version ID>
  • projects/<ProjectID>/locations/<Location ID>/agent/versions/<Version ID>
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.

DeleteVersion(google::cloud::dialogflow::v2::DeleteVersionRequest const &, Options)

Delete the specified agent version.

Parameters
Name Description
request google::cloud::dialogflow::v2::DeleteVersionRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.dialogflow.v2.DeleteVersionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.