Service for managing Generators
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
GeneratorsClient(GeneratorsClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
GeneratorsClient const &
|
GeneratorsClient(GeneratorsClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
GeneratorsClient &&
|
GeneratorsClient(std::shared_ptr< GeneratorsConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< GeneratorsConnection >
|
opts |
Options
|
Operators
operator=(GeneratorsClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
GeneratorsClient const &
|
Returns | |
---|---|
Type | Description |
GeneratorsClient & |
operator=(GeneratorsClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
GeneratorsClient &&
|
Returns | |
---|---|
Type | Description |
GeneratorsClient & |
Functions
ListGenerators(std::string const &, Options)
Returns the list of all generators in the specified agent.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The agent to list all generators for. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::dialogflow::cx::v3::Generator > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListGenerators(google::cloud::dialogflow::cx::v3::ListGeneratorsRequest, Options)
Returns the list of all generators in the specified agent.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::cx::v3::ListGeneratorsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::dialogflow::cx::v3::Generator > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetGenerator(std::string const &, Options)
Retrieves the specified generator.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the generator. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::cx::v3::Generator > |
the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.Generator) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetGenerator(google::cloud::dialogflow::cx::v3::GetGeneratorRequest const &, Options)
Retrieves the specified generator.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::cx::v3::GetGeneratorRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::cx::v3::Generator > |
the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.Generator) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateGenerator(std::string const &, google::cloud::dialogflow::cx::v3::Generator const &, Options)
Creates a generator in the specified agent.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The agent to create a generator for. Format: |
generator |
google::cloud::dialogflow::cx::v3::Generator const &
Required. The generator to create. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::cx::v3::Generator > |
the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.Generator) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateGenerator(google::cloud::dialogflow::cx::v3::CreateGeneratorRequest const &, Options)
Creates a generator in the specified agent.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::cx::v3::CreateGeneratorRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::cx::v3::Generator > |
the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.Generator) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateGenerator(google::cloud::dialogflow::cx::v3::Generator const &, google::protobuf::FieldMask const &, Options)
Update the specified generator.
Parameters | |
---|---|
Name | Description |
generator |
google::cloud::dialogflow::cx::v3::Generator const &
Required. The generator to update. |
update_mask |
google::protobuf::FieldMask const &
The mask to control which fields get updated. If the mask is not present, all fields will be updated. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::cx::v3::Generator > |
the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.Generator) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateGenerator(google::cloud::dialogflow::cx::v3::UpdateGeneratorRequest const &, Options)
Update the specified generator.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::cx::v3::UpdateGeneratorRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::dialogflow::cx::v3::Generator > |
the result of the RPC. The response message type (google.cloud.dialogflow.cx.v3.Generator) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteGenerator(std::string const &, Options)
Deletes the specified generators.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the generator to delete. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
DeleteGenerator(google::cloud::dialogflow::cx::v3::DeleteGeneratorRequest const &, Options)
Deletes the specified generators.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::dialogflow::cx::v3::DeleteGeneratorRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |