The service that manages agent-related resources in Gemini Enterprise for Customer Engagement (CES).
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
AgentServiceClient(AgentServiceClient const &)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
AgentServiceClient const &
|
AgentServiceClient(AgentServiceClient &&)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
AgentServiceClient &&
|
AgentServiceClient(std::shared_ptr< AgentServiceConnection >, Options)
| Parameters | |
|---|---|
| Name | Description |
connection |
std::shared_ptr< AgentServiceConnection >
|
opts |
Options
|
Operators
operator=(AgentServiceClient const &)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
AgentServiceClient const &
|
| Returns | |
|---|---|
| Type | Description |
AgentServiceClient & |
|
operator=(AgentServiceClient &&)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
AgentServiceClient &&
|
| Returns | |
|---|---|
| Type | Description |
AgentServiceClient & |
|
Functions
ListApps(std::string const &, Options)
Lists apps in the given project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The resource name of the location to list apps from. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::ces::v1::App > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListApps(google::cloud::ces::v1::ListAppsRequest, Options)
Lists apps in the given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::ListAppsRequest
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::ces::v1::App > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetApp(std::string const &, Options)
Gets details of the specified app.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The resource name of the app to retrieve. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::ces::v1::App > |
the result of the RPC. The response message type (google.cloud.ces.v1.App) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetApp(google::cloud::ces::v1::GetAppRequest const &, Options)
Gets details of the specified app.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::GetAppRequest 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::ces::v1::App > |
the result of the RPC. The response message type (google.cloud.ces.v1.App) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateApp(std::string const &, google::cloud::ces::v1::App const &, std::string const &, Options)
Creates a new app in the given project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The resource name of the location to create an app in. |
app |
google::cloud::ces::v1::App const &
Required. The app to create. |
app_id |
std::string const &
Optional. The ID to use for the app, which will become the final component of the app's resource name. If not provided, a unique ID will be automatically assigned for the app. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::ces::v1::App > > |
A |
CreateApp(NoAwaitTag, std::string const &, google::cloud::ces::v1::App const &, std::string const &, Options)
Creates a new app in the given project and location.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
app |
google::cloud::ces::v1::App const &
|
app_id |
std::string const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
CreateApp(std::string const &, google::cloud::ces::v1::App const &, Options)
Creates a new app in the given project and location.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The resource name of the location to create an app in. |
app |
google::cloud::ces::v1::App const &
Required. The app to create. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::ces::v1::App > > |
A |
CreateApp(NoAwaitTag, std::string const &, google::cloud::ces::v1::App const &, Options)
Creates a new app in the given project and location.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
app |
google::cloud::ces::v1::App const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
CreateApp(google::cloud::ces::v1::CreateAppRequest const &, Options)
Creates a new app in the given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::CreateAppRequest 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 |
future< StatusOr< google::cloud::ces::v1::App > > |
A |
CreateApp(NoAwaitTag, google::cloud::ces::v1::CreateAppRequest const &, Options)
Creates a new app in the given project and location.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
request |
google::cloud::ces::v1::CreateAppRequest const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
CreateApp(google::longrunning::Operation const &, Options)
Creates a new app in the given project and location.
This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
| Parameters | |
|---|---|
| Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::ces::v1::App > > |
|
UpdateApp(google::cloud::ces::v1::App const &, google::protobuf::FieldMask const &, Options)
Updates the specified app.
| Parameters | |
|---|---|
| Name | Description |
app |
google::cloud::ces::v1::App const &
Required. The app to update. |
update_mask |
google::protobuf::FieldMask const &
Optional. Field mask is used 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::ces::v1::App > |
the result of the RPC. The response message type (google.cloud.ces.v1.App) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateApp(google::cloud::ces::v1::UpdateAppRequest const &, Options)
Updates the specified app.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::UpdateAppRequest 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::ces::v1::App > |
the result of the RPC. The response message type (google.cloud.ces.v1.App) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteApp(std::string const &, Options)
Deletes the specified app.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The resource name of the app to delete. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::ces::v1::OperationMetadata > > |
A |
DeleteApp(NoAwaitTag, std::string const &, Options)
Deletes the specified app.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
DeleteApp(google::cloud::ces::v1::DeleteAppRequest const &, Options)
Deletes the specified app.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::DeleteAppRequest 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 |
future< StatusOr< google::cloud::ces::v1::OperationMetadata > > |
A |
DeleteApp(NoAwaitTag, google::cloud::ces::v1::DeleteAppRequest const &, Options)
Deletes the specified app.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
request |
google::cloud::ces::v1::DeleteAppRequest const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
DeleteApp(google::longrunning::Operation const &, Options)
Deletes the specified app.
This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
| Parameters | |
|---|---|
| Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::ces::v1::OperationMetadata > > |
|
ExportApp(std::string const &, Options)
Exports the specified app.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The resource name of the app to export. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::ces::v1::ExportAppResponse > > |
A |
ExportApp(NoAwaitTag, std::string const &, Options)
Exports the specified app.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
ExportApp(google::cloud::ces::v1::ExportAppRequest const &, Options)
Exports the specified app.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::ExportAppRequest 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 |
future< StatusOr< google::cloud::ces::v1::ExportAppResponse > > |
A |
ExportApp(NoAwaitTag, google::cloud::ces::v1::ExportAppRequest const &, Options)
Exports the specified app.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
request |
google::cloud::ces::v1::ExportAppRequest const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
ExportApp(google::longrunning::Operation const &, Options)
Exports the specified app.
This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
| Parameters | |
|---|---|
| Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::ces::v1::ExportAppResponse > > |
|
ImportApp(std::string const &, std::string const &, std::string const &, Options)
Imports the specified app.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The parent resource name with the location of the app to import. |
display_name |
std::string const &
Optional. The display name of the app to import.
|
app_id |
std::string const &
Optional. The ID to use for the imported app.
|
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::ces::v1::ImportAppResponse > > |
A |
ImportApp(NoAwaitTag, std::string const &, std::string const &, std::string const &, Options)
Imports the specified app.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
display_name |
std::string const &
|
app_id |
std::string const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
ImportApp(google::cloud::ces::v1::ImportAppRequest const &, Options)
Imports the specified app.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::ImportAppRequest 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 |
future< StatusOr< google::cloud::ces::v1::ImportAppResponse > > |
A |
ImportApp(NoAwaitTag, google::cloud::ces::v1::ImportAppRequest const &, Options)
Imports the specified app.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
request |
google::cloud::ces::v1::ImportAppRequest const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
ImportApp(google::longrunning::Operation const &, Options)
Imports the specified app.
This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
| Parameters | |
|---|---|
| Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::ces::v1::ImportAppResponse > > |
|
ListAgents(std::string const &, Options)
Lists agents in the given app.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The resource name of the app to list agents from. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::ces::v1::Agent > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListAgents(google::cloud::ces::v1::ListAgentsRequest, Options)
Lists agents in the given app.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::ListAgentsRequest
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::ces::v1::Agent > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetAgent(std::string const &, Options)
Gets details of the specified agent.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The resource name of the agent to retrieve. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::ces::v1::Agent > |
the result of the RPC. The response message type (google.cloud.ces.v1.Agent) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetAgent(google::cloud::ces::v1::GetAgentRequest const &, Options)
Gets details of the specified agent.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::GetAgentRequest 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::ces::v1::Agent > |
the result of the RPC. The response message type (google.cloud.ces.v1.Agent) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateAgent(std::string const &, google::cloud::ces::v1::Agent const &, std::string const &, Options)
Creates a new agent in the given app.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The resource name of the app to create an agent in. |
agent |
google::cloud::ces::v1::Agent const &
Required. The agent to create. |
agent_id |
std::string const &
Optional. The ID to use for the agent, which will become the final component of the agent's resource name. If not provided, a unique ID will be automatically assigned for the agent. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::ces::v1::Agent > |
the result of the RPC. The response message type (google.cloud.ces.v1.Agent) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateAgent(std::string const &, google::cloud::ces::v1::Agent const &, Options)
Creates a new agent in the given app.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The resource name of the app to create an agent in. |
agent |
google::cloud::ces::v1::Agent const &
Required. The agent to create. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::ces::v1::Agent > |
the result of the RPC. The response message type (google.cloud.ces.v1.Agent) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateAgent(google::cloud::ces::v1::CreateAgentRequest const &, Options)
Creates a new agent in the given app.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::CreateAgentRequest 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::ces::v1::Agent > |
the result of the RPC. The response message type (google.cloud.ces.v1.Agent) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateAgent(google::cloud::ces::v1::Agent const &, google::protobuf::FieldMask const &, Options)
Updates the specified agent.
| Parameters | |
|---|---|
| Name | Description |
agent |
google::cloud::ces::v1::Agent const &
Required. The agent to update. |
update_mask |
google::protobuf::FieldMask const &
Optional. Field mask is used 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::ces::v1::Agent > |
the result of the RPC. The response message type (google.cloud.ces.v1.Agent) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateAgent(google::cloud::ces::v1::UpdateAgentRequest const &, Options)
Updates the specified agent.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::UpdateAgentRequest 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::ces::v1::Agent > |
the result of the RPC. The response message type (google.cloud.ces.v1.Agent) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteAgent(std::string const &, Options)
Deletes the specified agent.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The resource name of the agent to delete. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
DeleteAgent(google::cloud::ces::v1::DeleteAgentRequest const &, Options)
Deletes the specified agent.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::DeleteAgentRequest 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 |
ListExamples(std::string const &, Options)
Lists examples in the given app.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The resource name of the app to list examples from. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::ces::v1::Example > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListExamples(google::cloud::ces::v1::ListExamplesRequest, Options)
Lists examples in the given app.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::ListExamplesRequest
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::ces::v1::Example > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetExample(std::string const &, Options)
Gets details of the specified example.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The resource name of the example to retrieve. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::ces::v1::Example > |
the result of the RPC. The response message type (google.cloud.ces.v1.Example) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetExample(google::cloud::ces::v1::GetExampleRequest const &, Options)
Gets details of the specified example.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::GetExampleRequest 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::ces::v1::Example > |
the result of the RPC. The response message type (google.cloud.ces.v1.Example) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateExample(std::string const &, google::cloud::ces::v1::Example const &, std::string const &, Options)
Creates a new example in the given app.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The resource name of the app to create an example in. |
example |
google::cloud::ces::v1::Example const &
Required. The example to create. |
example_id |
std::string const &
Optional. The ID to use for the example, which will become the final component of the example's resource name. If not provided, a unique ID will be automatically assigned for the example. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::ces::v1::Example > |
the result of the RPC. The response message type (google.cloud.ces.v1.Example) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateExample(std::string const &, google::cloud::ces::v1::Example const &, Options)
Creates a new example in the given app.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The resource name of the app to create an example in. |
example |
google::cloud::ces::v1::Example const &
Required. The example to create. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::ces::v1::Example > |
the result of the RPC. The response message type (google.cloud.ces.v1.Example) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateExample(google::cloud::ces::v1::CreateExampleRequest const &, Options)
Creates a new example in the given app.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::CreateExampleRequest 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::ces::v1::Example > |
the result of the RPC. The response message type (google.cloud.ces.v1.Example) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateExample(google::cloud::ces::v1::Example const &, google::protobuf::FieldMask const &, Options)
Updates the specified example.
| Parameters | |
|---|---|
| Name | Description |
example |
google::cloud::ces::v1::Example const &
Required. The example to update. |
update_mask |
google::protobuf::FieldMask const &
Optional. Field mask is used 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::ces::v1::Example > |
the result of the RPC. The response message type (google.cloud.ces.v1.Example) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateExample(google::cloud::ces::v1::UpdateExampleRequest const &, Options)
Updates the specified example.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::UpdateExampleRequest 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::ces::v1::Example > |
the result of the RPC. The response message type (google.cloud.ces.v1.Example) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteExample(std::string const &, Options)
Deletes the specified example.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The resource name of the example to delete. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
DeleteExample(google::cloud::ces::v1::DeleteExampleRequest const &, Options)
Deletes the specified example.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::DeleteExampleRequest 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 |
ListTools(std::string const &, Options)
Lists tools in the given app.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The resource name of the app to list tools from. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::ces::v1::Tool > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListTools(google::cloud::ces::v1::ListToolsRequest, Options)
Lists tools in the given app.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::ListToolsRequest
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::ces::v1::Tool > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetTool(std::string const &, Options)
Gets details of the specified tool.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The resource name of the tool to retrieve. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::ces::v1::Tool > |
the result of the RPC. The response message type (google.cloud.ces.v1.Tool) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetTool(google::cloud::ces::v1::GetToolRequest const &, Options)
Gets details of the specified tool.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::GetToolRequest 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::ces::v1::Tool > |
the result of the RPC. The response message type (google.cloud.ces.v1.Tool) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListConversations(std::string const &, Options)
Lists conversations in the given app.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The resource name of the app to list conversations from. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::ces::v1::Conversation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListConversations(google::cloud::ces::v1::ListConversationsRequest, Options)
Lists conversations in the given app.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::ListConversationsRequest
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::ces::v1::Conversation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetConversation(std::string const &, Options)
Gets details of the specified conversation.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The resource name of the conversation to retrieve. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::ces::v1::Conversation > |
the result of the RPC. The response message type (google.cloud.ces.v1.Conversation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetConversation(google::cloud::ces::v1::GetConversationRequest const &, Options)
Gets details of the specified conversation.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::GetConversationRequest 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::ces::v1::Conversation > |
the result of the RPC. The response message type (google.cloud.ces.v1.Conversation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteConversation(std::string const &, Options)
Deletes the specified conversation.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The resource name of the conversation to delete. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
DeleteConversation(google::cloud::ces::v1::DeleteConversationRequest const &, Options)
Deletes the specified conversation.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::DeleteConversationRequest 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 |
BatchDeleteConversations(std::string const &, Options)
Batch deletes the specified conversations.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The resource name of the app to delete conversations from. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::ces::v1::BatchDeleteConversationsResponse > > |
A |
BatchDeleteConversations(NoAwaitTag, std::string const &, Options)
Batch deletes the specified conversations.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
BatchDeleteConversations(google::cloud::ces::v1::BatchDeleteConversationsRequest const &, Options)
Batch deletes the specified conversations.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::BatchDeleteConversationsRequest 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 |
future< StatusOr< google::cloud::ces::v1::BatchDeleteConversationsResponse > > |
A |
BatchDeleteConversations(NoAwaitTag, google::cloud::ces::v1::BatchDeleteConversationsRequest const &, Options)
Batch deletes the specified conversations.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
request |
google::cloud::ces::v1::BatchDeleteConversationsRequest const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
BatchDeleteConversations(google::longrunning::Operation const &, Options)
Batch deletes the specified conversations.
This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
| Parameters | |
|---|---|
| Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::ces::v1::BatchDeleteConversationsResponse > > |
|
CreateTool(std::string const &, google::cloud::ces::v1::Tool const &, std::string const &, Options)
Creates a new tool in the given app.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The resource name of the app to create a tool in. |
tool |
google::cloud::ces::v1::Tool const &
Required. The tool to create. |
tool_id |
std::string const &
Optional. The ID to use for the tool, which will become the final component of the tool's resource name. If not provided, a unique ID will be automatically assigned for the tool. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::ces::v1::Tool > |
the result of the RPC. The response message type (google.cloud.ces.v1.Tool) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateTool(std::string const &, google::cloud::ces::v1::Tool const &, Options)
Creates a new tool in the given app.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The resource name of the app to create a tool in. |
tool |
google::cloud::ces::v1::Tool const &
Required. The tool to create. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::ces::v1::Tool > |
the result of the RPC. The response message type (google.cloud.ces.v1.Tool) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateTool(google::cloud::ces::v1::CreateToolRequest const &, Options)
Creates a new tool in the given app.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::CreateToolRequest 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::ces::v1::Tool > |
the result of the RPC. The response message type (google.cloud.ces.v1.Tool) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateTool(google::cloud::ces::v1::Tool const &, google::protobuf::FieldMask const &, Options)
Updates the specified tool.
| Parameters | |
|---|---|
| Name | Description |
tool |
google::cloud::ces::v1::Tool const &
Required. The tool to update. |
update_mask |
google::protobuf::FieldMask const &
Optional. Field mask is used 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::ces::v1::Tool > |
the result of the RPC. The response message type (google.cloud.ces.v1.Tool) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateTool(google::cloud::ces::v1::UpdateToolRequest const &, Options)
Updates the specified tool.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::UpdateToolRequest 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::ces::v1::Tool > |
the result of the RPC. The response message type (google.cloud.ces.v1.Tool) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteTool(std::string const &, Options)
Deletes the specified tool.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The resource name of the tool to delete. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
DeleteTool(google::cloud::ces::v1::DeleteToolRequest const &, Options)
Deletes the specified tool.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::DeleteToolRequest 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 |
ListGuardrails(std::string const &, Options)
Lists guardrails in the given app.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The resource name of the app to list guardrails from. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::ces::v1::Guardrail > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListGuardrails(google::cloud::ces::v1::ListGuardrailsRequest, Options)
Lists guardrails in the given app.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::ListGuardrailsRequest
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::ces::v1::Guardrail > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetGuardrail(std::string const &, Options)
Gets details of the specified guardrail.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The resource name of the guardrail to retrieve. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::ces::v1::Guardrail > |
the result of the RPC. The response message type (google.cloud.ces.v1.Guardrail) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetGuardrail(google::cloud::ces::v1::GetGuardrailRequest const &, Options)
Gets details of the specified guardrail.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::GetGuardrailRequest 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::ces::v1::Guardrail > |
the result of the RPC. The response message type (google.cloud.ces.v1.Guardrail) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateGuardrail(std::string const &, google::cloud::ces::v1::Guardrail const &, std::string const &, Options)
Creates a new guardrail in the given app.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The resource name of the app to create a guardrail in. |
guardrail |
google::cloud::ces::v1::Guardrail const &
Required. The guardrail to create. |
guardrail_id |
std::string const &
Optional. The ID to use for the guardrail, which will become the final component of the guardrail's resource name. If not provided, a unique ID will be automatically assigned for the guardrail. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::ces::v1::Guardrail > |
the result of the RPC. The response message type (google.cloud.ces.v1.Guardrail) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateGuardrail(std::string const &, google::cloud::ces::v1::Guardrail const &, Options)
Creates a new guardrail in the given app.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The resource name of the app to create a guardrail in. |
guardrail |
google::cloud::ces::v1::Guardrail const &
Required. The guardrail to create. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::ces::v1::Guardrail > |
the result of the RPC. The response message type (google.cloud.ces.v1.Guardrail) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateGuardrail(google::cloud::ces::v1::CreateGuardrailRequest const &, Options)
Creates a new guardrail in the given app.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::CreateGuardrailRequest 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::ces::v1::Guardrail > |
the result of the RPC. The response message type (google.cloud.ces.v1.Guardrail) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateGuardrail(google::cloud::ces::v1::Guardrail const &, google::protobuf::FieldMask const &, Options)
Updates the specified guardrail.
| Parameters | |
|---|---|
| Name | Description |
guardrail |
google::cloud::ces::v1::Guardrail const &
Required. The guardrail to update. |
update_mask |
google::protobuf::FieldMask const &
Optional. Field mask is used 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::ces::v1::Guardrail > |
the result of the RPC. The response message type (google.cloud.ces.v1.Guardrail) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateGuardrail(google::cloud::ces::v1::UpdateGuardrailRequest const &, Options)
Updates the specified guardrail.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::UpdateGuardrailRequest 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::ces::v1::Guardrail > |
the result of the RPC. The response message type (google.cloud.ces.v1.Guardrail) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteGuardrail(std::string const &, Options)
Deletes the specified guardrail.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The resource name of the guardrail to delete. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
DeleteGuardrail(google::cloud::ces::v1::DeleteGuardrailRequest const &, Options)
Deletes the specified guardrail.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::DeleteGuardrailRequest 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 |
ListDeployments(std::string const &, Options)
Lists deployments in the given app.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The parent app. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::ces::v1::Deployment > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListDeployments(google::cloud::ces::v1::ListDeploymentsRequest, Options)
Lists deployments in the given app.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::ListDeploymentsRequest
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::ces::v1::Deployment > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetDeployment(std::string const &, Options)
Gets details of the specified deployment.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The name of the deployment. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::ces::v1::Deployment > |
the result of the RPC. The response message type (google.cloud.ces.v1.Deployment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetDeployment(google::cloud::ces::v1::GetDeploymentRequest const &, Options)
Gets details of the specified deployment.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::GetDeploymentRequest 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::ces::v1::Deployment > |
the result of the RPC. The response message type (google.cloud.ces.v1.Deployment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateDeployment(std::string const &, google::cloud::ces::v1::Deployment const &, std::string const &, Options)
Creates a new deployment in the given app.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The parent app. Format: |
deployment |
google::cloud::ces::v1::Deployment const &
Required. The deployment to create. |
deployment_id |
std::string const &
Optional. The ID to use for the deployment, which will become the final component of the deployment's resource name. If not provided, a unique ID will be automatically assigned for the deployment. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::ces::v1::Deployment > |
the result of the RPC. The response message type (google.cloud.ces.v1.Deployment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateDeployment(std::string const &, google::cloud::ces::v1::Deployment const &, Options)
Creates a new deployment in the given app.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The parent app. Format: |
deployment |
google::cloud::ces::v1::Deployment const &
Required. The deployment to create. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::ces::v1::Deployment > |
the result of the RPC. The response message type (google.cloud.ces.v1.Deployment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateDeployment(google::cloud::ces::v1::CreateDeploymentRequest const &, Options)
Creates a new deployment in the given app.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::CreateDeploymentRequest 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::ces::v1::Deployment > |
the result of the RPC. The response message type (google.cloud.ces.v1.Deployment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateDeployment(google::cloud::ces::v1::Deployment const &, google::protobuf::FieldMask const &, Options)
Updates the specified deployment.
| Parameters | |
|---|---|
| Name | Description |
deployment |
google::cloud::ces::v1::Deployment const &
Required. The deployment to update. |
update_mask |
google::protobuf::FieldMask const &
Optional. The list of fields to update. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::ces::v1::Deployment > |
the result of the RPC. The response message type (google.cloud.ces.v1.Deployment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateDeployment(google::cloud::ces::v1::UpdateDeploymentRequest const &, Options)
Updates the specified deployment.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::UpdateDeploymentRequest 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::ces::v1::Deployment > |
the result of the RPC. The response message type (google.cloud.ces.v1.Deployment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteDeployment(std::string const &, Options)
Deletes the specified deployment.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The name of the deployment to delete. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
DeleteDeployment(google::cloud::ces::v1::DeleteDeploymentRequest const &, Options)
Deletes the specified deployment.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::DeleteDeploymentRequest 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 |
ListToolsets(std::string const &, Options)
Lists toolsets in the given app.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The resource name of the app to list toolsets from. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::ces::v1::Toolset > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListToolsets(google::cloud::ces::v1::ListToolsetsRequest, Options)
Lists toolsets in the given app.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::ListToolsetsRequest
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::ces::v1::Toolset > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetToolset(std::string const &, Options)
Gets details of the specified toolset.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The resource name of the toolset to retrieve. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::ces::v1::Toolset > |
the result of the RPC. The response message type (google.cloud.ces.v1.Toolset) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetToolset(google::cloud::ces::v1::GetToolsetRequest const &, Options)
Gets details of the specified toolset.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::GetToolsetRequest 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::ces::v1::Toolset > |
the result of the RPC. The response message type (google.cloud.ces.v1.Toolset) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateToolset(std::string const &, google::cloud::ces::v1::Toolset const &, std::string const &, Options)
Creates a new toolset in the given app.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The resource name of the app to create a toolset in. |
toolset |
google::cloud::ces::v1::Toolset const &
Required. The toolset to create. |
toolset_id |
std::string const &
Optional. The ID to use for the toolset, which will become the final component of the toolset's resource name. If not provided, a unique ID will be automatically assigned for the toolset. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::ces::v1::Toolset > |
the result of the RPC. The response message type (google.cloud.ces.v1.Toolset) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateToolset(std::string const &, google::cloud::ces::v1::Toolset const &, Options)
Creates a new toolset in the given app.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The resource name of the app to create a toolset in. |
toolset |
google::cloud::ces::v1::Toolset const &
Required. The toolset to create. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::ces::v1::Toolset > |
the result of the RPC. The response message type (google.cloud.ces.v1.Toolset) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateToolset(google::cloud::ces::v1::CreateToolsetRequest const &, Options)
Creates a new toolset in the given app.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::CreateToolsetRequest 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::ces::v1::Toolset > |
the result of the RPC. The response message type (google.cloud.ces.v1.Toolset) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateToolset(google::cloud::ces::v1::Toolset const &, google::protobuf::FieldMask const &, Options)
Updates the specified toolset.
| Parameters | |
|---|---|
| Name | Description |
toolset |
google::cloud::ces::v1::Toolset const &
Required. The toolset to update. |
update_mask |
google::protobuf::FieldMask const &
Optional. Field mask is used 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::ces::v1::Toolset > |
the result of the RPC. The response message type (google.cloud.ces.v1.Toolset) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateToolset(google::cloud::ces::v1::UpdateToolsetRequest const &, Options)
Updates the specified toolset.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::UpdateToolsetRequest 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::ces::v1::Toolset > |
the result of the RPC. The response message type (google.cloud.ces.v1.Toolset) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteToolset(std::string const &, Options)
Deletes the specified toolset.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The resource name of the toolset to delete. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
DeleteToolset(google::cloud::ces::v1::DeleteToolsetRequest const &, Options)
Deletes the specified toolset.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::DeleteToolsetRequest 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 |
ListAppVersions(std::string const &, Options)
Lists all app versions in the given app.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The resource name of the app to list app versions from. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::ces::v1::AppVersion > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListAppVersions(google::cloud::ces::v1::ListAppVersionsRequest, Options)
Lists all app versions in the given app.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::ListAppVersionsRequest
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::ces::v1::AppVersion > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetAppVersion(std::string const &, Options)
Gets details of the specified app version.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The resource name of the app version to retrieve. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::ces::v1::AppVersion > |
the result of the RPC. The response message type (google.cloud.ces.v1.AppVersion) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetAppVersion(google::cloud::ces::v1::GetAppVersionRequest const &, Options)
Gets details of the specified app version.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::GetAppVersionRequest 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::ces::v1::AppVersion > |
the result of the RPC. The response message type (google.cloud.ces.v1.AppVersion) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateAppVersion(std::string const &, google::cloud::ces::v1::AppVersion const &, std::string const &, Options)
Creates a new app version in the given app.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The resource name of the app to create an app version in. |
app_version |
google::cloud::ces::v1::AppVersion const &
Required. The app version to create. |
app_version_id |
std::string const &
Optional. The ID to use for the app version, which will become the final component of the app version's resource name. If not provided, a unique ID will be automatically assigned for the app version. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::ces::v1::AppVersion > |
the result of the RPC. The response message type (google.cloud.ces.v1.AppVersion) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateAppVersion(std::string const &, google::cloud::ces::v1::AppVersion const &, Options)
Creates a new app version in the given app.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The resource name of the app to create an app version in. |
app_version |
google::cloud::ces::v1::AppVersion const &
Required. The app version to create. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::ces::v1::AppVersion > |
the result of the RPC. The response message type (google.cloud.ces.v1.AppVersion) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateAppVersion(google::cloud::ces::v1::CreateAppVersionRequest const &, Options)
Creates a new app version in the given app.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::CreateAppVersionRequest 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::ces::v1::AppVersion > |
the result of the RPC. The response message type (google.cloud.ces.v1.AppVersion) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteAppVersion(std::string const &, Options)
Deletes the specified app version.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The resource name of the app version to delete. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
DeleteAppVersion(google::cloud::ces::v1::DeleteAppVersionRequest const &, Options)
Deletes the specified app version.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::DeleteAppVersionRequest 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 |
RestoreAppVersion(std::string const &, Options)
Restores the specified app version.
This will create a new app version from the current draft app and overwrite the current draft with the specified app version.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The resource name of the app version to restore. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::ces::v1::RestoreAppVersionResponse > > |
A |
RestoreAppVersion(NoAwaitTag, std::string const &, Options)
Restores the specified app version.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
RestoreAppVersion(google::cloud::ces::v1::RestoreAppVersionRequest const &, Options)
Restores the specified app version.
This will create a new app version from the current draft app and overwrite the current draft with the specified app version.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::RestoreAppVersionRequest 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 |
future< StatusOr< google::cloud::ces::v1::RestoreAppVersionResponse > > |
A |
RestoreAppVersion(NoAwaitTag, google::cloud::ces::v1::RestoreAppVersionRequest const &, Options)
Restores the specified app version.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
NoAwaitTag
|
request |
google::cloud::ces::v1::RestoreAppVersionRequest const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
RestoreAppVersion(google::longrunning::Operation const &, Options)
Restores the specified app version.
This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
| Parameters | |
|---|---|
| Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::ces::v1::RestoreAppVersionResponse > > |
|
ListChangelogs(std::string const &, Options)
Lists the changelogs of the specified app.
| Parameters | |
|---|---|
| Name | Description |
parent |
std::string const &
Required. The resource name of the app to list changelogs from. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::cloud::ces::v1::Changelog > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListChangelogs(google::cloud::ces::v1::ListChangelogsRequest, Options)
Lists the changelogs of the specified app.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::ListChangelogsRequest
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::ces::v1::Changelog > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetChangelog(std::string const &, Options)
Gets the specified changelog.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
Required. The resource name of the changelog to retrieve. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::cloud::ces::v1::Changelog > |
the result of the RPC. The response message type (google.cloud.ces.v1.Changelog) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetChangelog(google::cloud::ces::v1::GetChangelogRequest const &, Options)
Gets the specified changelog.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::ces::v1::GetChangelogRequest 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::ces::v1::Changelog > |
the result of the RPC. The response message type (google.cloud.ces.v1.Changelog) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListLocations(google::cloud::location::ListLocationsRequest, Options)
Lists information about the supported locations for this service.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::location::ListLocationsRequest
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::location::Location > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetLocation(google::cloud::location::GetLocationRequest const &, Options)
Gets information about a location.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::location::GetLocationRequest 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::location::Location > |
the result of the RPC. The response message type (google.cloud.location.Location) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListOperations(std::string const &, std::string const &, Options)
Lists operations that match the specified filter in the request.
If the server doesn't support this method, it returns UNIMPLEMENTED.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
The name of the operation's parent resource. |
filter |
std::string const &
The standard list filter. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StreamRange< google::longrunning::Operation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListOperations(google::longrunning::ListOperationsRequest, Options)
Lists operations that match the specified filter in the request.
If the server doesn't support this method, it returns UNIMPLEMENTED.
| Parameters | |
|---|---|
| Name | Description |
request |
google::longrunning::ListOperationsRequest
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::longrunning::Operation > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetOperation(std::string const &, Options)
Gets the latest state of a long-running operation.
Clients can use this method to poll the operation result at intervals as recommended by the API service.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
The name of the operation resource. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetOperation(google::longrunning::GetOperationRequest const &, Options)
Gets the latest state of a long-running operation.
Clients can use this method to poll the operation result at intervals as recommended by the API service.
| Parameters | |
|---|---|
| Name | Description |
request |
google::longrunning::GetOperationRequest 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::longrunning::Operation > |
the result of the RPC. The response message type (google.longrunning.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteOperation(std::string const &, Options)
Deletes a long-running operation.
This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
The name of the operation resource to be deleted. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
DeleteOperation(google::longrunning::DeleteOperationRequest const &, Options)
Deletes a long-running operation.
This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.
| Parameters | |
|---|---|
| Name | Description |
request |
google::longrunning::DeleteOperationRequest 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 |
CancelOperation(std::string const &, Options)
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
| Parameters | |
|---|---|
| Name | Description |
name |
std::string const &
The name of the operation resource to be cancelled. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
Status |
a |
CancelOperation(google::longrunning::CancelOperationRequest const &, Options)
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
| Parameters | |
|---|---|
| Name | Description |
request |
google::longrunning::CancelOperationRequest 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 |