TelcoAutomation Service manages the control plane cluster a.k.a.
Orchestration Cluster (GKE cluster with config controller) of TNA. It also exposes blueprint APIs which manages the lifecycle of blueprints that control the infrastructure setup (e.g GDCE clusters) and deployment of network functions.
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
TelcoAutomationClient(TelcoAutomationClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
TelcoAutomationClient const &
|
TelcoAutomationClient(TelcoAutomationClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
TelcoAutomationClient &&
|
TelcoAutomationClient(std::shared_ptr< TelcoAutomationConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< TelcoAutomationConnection >
|
opts |
Options
|
Operators
operator=(TelcoAutomationClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
TelcoAutomationClient const &
|
Returns | |
---|---|
Type | Description |
TelcoAutomationClient & |
operator=(TelcoAutomationClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
TelcoAutomationClient &&
|
Returns | |
---|---|
Type | Description |
TelcoAutomationClient & |
Functions
GetBlueprint(std::string const &, Options)
Returns the requested blueprint.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the blueprint. Case 1: If the name provided in the request is {blueprint_id}revision_id}, then the revision with revision_id will be returned. Case 2: If the name provided in the request is {blueprint}, then the current state of the blueprint is returned. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::telcoautomation::v1::Blueprint > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.Blueprint) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetBlueprint(google::cloud::telcoautomation::v1::GetBlueprintRequest const &, Options)
Returns the requested blueprint.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::telcoautomation::v1::GetBlueprintRequest 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::telcoautomation::v1::Blueprint > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.Blueprint) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteBlueprint(std::string const &, Options)
Deletes a blueprint and all its revisions.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of blueprint to delete. Blueprint name should be in the format {blueprint_id}, if {blueprint_id}revision_id} is passed then the API throws invalid argument. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
DeleteBlueprint(google::cloud::telcoautomation::v1::DeleteBlueprintRequest const &, Options)
Deletes a blueprint and all its revisions.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::telcoautomation::v1::DeleteBlueprintRequest 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 |
ListBlueprints(std::string const &, Options)
List all blueprints.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The name of parent orchestration cluster resource. Format should be - "projects/{project_id}/locations/{location_name}/orchestrationClusters/{orchestration_cluster}". |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::telcoautomation::v1::Blueprint > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListBlueprints(google::cloud::telcoautomation::v1::ListBlueprintsRequest, Options)
List all blueprints.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::telcoautomation::v1::ListBlueprintsRequest
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::telcoautomation::v1::Blueprint > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ApproveBlueprint(std::string const &, Options)
Approves a blueprint and commits a new revision.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the blueprint to approve. The blueprint must be in Proposed state. A new revision is committed on approval. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::telcoautomation::v1::Blueprint > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.Blueprint) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ApproveBlueprint(google::cloud::telcoautomation::v1::ApproveBlueprintRequest const &, Options)
Approves a blueprint and commits a new revision.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::telcoautomation::v1::ApproveBlueprintRequest 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::telcoautomation::v1::Blueprint > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.Blueprint) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ProposeBlueprint(std::string const &, Options)
Proposes a blueprint for approval of changes.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the blueprint being proposed. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::telcoautomation::v1::Blueprint > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.Blueprint) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ProposeBlueprint(google::cloud::telcoautomation::v1::ProposeBlueprintRequest const &, Options)
Proposes a blueprint for approval of changes.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::telcoautomation::v1::ProposeBlueprintRequest 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::telcoautomation::v1::Blueprint > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.Blueprint) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
RejectBlueprint(std::string const &, Options)
Rejects a blueprint revision proposal and flips it back to Draft state.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the blueprint being rejected. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::telcoautomation::v1::Blueprint > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.Blueprint) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
RejectBlueprint(google::cloud::telcoautomation::v1::RejectBlueprintRequest const &, Options)
Rejects a blueprint revision proposal and flips it back to Draft state.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::telcoautomation::v1::RejectBlueprintRequest 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::telcoautomation::v1::Blueprint > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.Blueprint) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListBlueprintRevisions(std::string const &, Options)
List blueprint revisions of a given blueprint.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the blueprint to list revisions for. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::telcoautomation::v1::Blueprint > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListBlueprintRevisions(google::cloud::telcoautomation::v1::ListBlueprintRevisionsRequest, Options)
List blueprint revisions of a given blueprint.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::telcoautomation::v1::ListBlueprintRevisionsRequest
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::telcoautomation::v1::Blueprint > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
SearchBlueprintRevisions(std::string const &, std::string const &, Options)
Searches across blueprint revisions.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The name of parent orchestration cluster resource. Format should be - "projects/{project_id}/locations/{location_name}/orchestrationClusters/{orchestration_cluster}". |
query |
std::string const &
Required. Supported queries:
|
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::telcoautomation::v1::Blueprint > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
SearchBlueprintRevisions(google::cloud::telcoautomation::v1::SearchBlueprintRevisionsRequest, Options)
Searches across blueprint revisions.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::telcoautomation::v1::SearchBlueprintRevisionsRequest
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::telcoautomation::v1::Blueprint > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
SearchDeploymentRevisions(std::string const &, std::string const &, Options)
Searches across deployment revisions.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The name of parent orchestration cluster resource. Format should be - "projects/{project_id}/locations/{location_name}/orchestrationClusters/{orchestration_cluster}". |
query |
std::string const &
Required. Supported queries:
|
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::telcoautomation::v1::Deployment > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
SearchDeploymentRevisions(google::cloud::telcoautomation::v1::SearchDeploymentRevisionsRequest, Options)
Searches across deployment revisions.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::telcoautomation::v1::SearchDeploymentRevisionsRequest
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::telcoautomation::v1::Deployment > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DiscardBlueprintChanges(std::string const &, Options)
Discards the changes in a blueprint and reverts the blueprint to the last approved blueprint revision.
No changes take place if a blueprint does not have revisions.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the blueprint of which changes are being discarded. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::telcoautomation::v1::DiscardBlueprintChangesResponse > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.DiscardBlueprintChangesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DiscardBlueprintChanges(google::cloud::telcoautomation::v1::DiscardBlueprintChangesRequest const &, Options)
Discards the changes in a blueprint and reverts the blueprint to the last approved blueprint revision.
No changes take place if a blueprint does not have revisions.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::telcoautomation::v1::DiscardBlueprintChangesRequest 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::telcoautomation::v1::DiscardBlueprintChangesResponse > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.DiscardBlueprintChangesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListPublicBlueprints(std::string const &, Options)
Lists the blueprints in TNA's public catalog.
Default page size = 20, Max Page Size = 100.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Parent value of public blueprint. Format should be - "projects/{project_id}/locations/{location_name}". |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::telcoautomation::v1::PublicBlueprint > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListPublicBlueprints(google::cloud::telcoautomation::v1::ListPublicBlueprintsRequest, Options)
Lists the blueprints in TNA's public catalog.
Default page size = 20, Max Page Size = 100.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::telcoautomation::v1::ListPublicBlueprintsRequest
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::telcoautomation::v1::PublicBlueprint > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetPublicBlueprint(std::string const &, Options)
Returns the requested public blueprint.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the public blueprint. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::telcoautomation::v1::PublicBlueprint > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.PublicBlueprint) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetPublicBlueprint(google::cloud::telcoautomation::v1::GetPublicBlueprintRequest const &, Options)
Returns the requested public blueprint.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::telcoautomation::v1::GetPublicBlueprintRequest 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::telcoautomation::v1::PublicBlueprint > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.PublicBlueprint) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateDeployment(std::string const &, google::cloud::telcoautomation::v1::Deployment const &, std::string const &, Options)
Creates a deployment.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The name of parent resource. Format should be - "projects/{project_id}/locations/{location_name}/orchestrationClusters/{orchestration_cluster}". |
deployment |
google::cloud::telcoautomation::v1::Deployment const &
Required. The |
deployment_id |
std::string const &
Optional. The name of the deployment. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::telcoautomation::v1::Deployment > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.Deployment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateDeployment(google::cloud::telcoautomation::v1::CreateDeploymentRequest const &, Options)
Creates a deployment.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::telcoautomation::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::telcoautomation::v1::Deployment > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.Deployment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateDeployment(google::cloud::telcoautomation::v1::Deployment const &, google::protobuf::FieldMask const &, Options)
Updates a deployment.
Parameters | |
---|---|
Name | Description |
deployment |
google::cloud::telcoautomation::v1::Deployment const &
Required. The |
update_mask |
google::protobuf::FieldMask const &
Required. Update mask is used to specify the fields to be overwritten in the |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::telcoautomation::v1::Deployment > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.Deployment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateDeployment(google::cloud::telcoautomation::v1::UpdateDeploymentRequest const &, Options)
Updates a deployment.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::telcoautomation::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::telcoautomation::v1::Deployment > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.Deployment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetDeployment(std::string const &, Options)
Returns the requested deployment.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the deployment. Case 1: If the name provided in the request is {deployment_id}revision_id}, then the revision with revision_id will be returned. Case 2: If the name provided in the request is {deployment}, then the current state of the deployment is returned. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::telcoautomation::v1::Deployment > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.Deployment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetDeployment(google::cloud::telcoautomation::v1::GetDeploymentRequest const &, Options)
Returns the requested deployment.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::telcoautomation::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::telcoautomation::v1::Deployment > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.Deployment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
RemoveDeployment(std::string const &, Options)
Removes the deployment by marking it as DELETING.
Post which deployment and it's revisions gets deleted.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of deployment to initiate delete. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
RemoveDeployment(google::cloud::telcoautomation::v1::RemoveDeploymentRequest const &, Options)
Removes the deployment by marking it as DELETING.
Post which deployment and it's revisions gets deleted.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::telcoautomation::v1::RemoveDeploymentRequest 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)
List all deployments.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The name of parent orchestration cluster resource. Format should be - "projects/{project_id}/locations/{location_name}/orchestrationClusters/{orchestration_cluster}". |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::telcoautomation::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::telcoautomation::v1::ListDeploymentsRequest, Options)
List all deployments.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::telcoautomation::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::telcoautomation::v1::Deployment > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListDeploymentRevisions(std::string const &, Options)
List deployment revisions of a given deployment.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the deployment to list revisions for. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::telcoautomation::v1::Deployment > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListDeploymentRevisions(google::cloud::telcoautomation::v1::ListDeploymentRevisionsRequest, Options)
List deployment revisions of a given deployment.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::telcoautomation::v1::ListDeploymentRevisionsRequest
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::telcoautomation::v1::Deployment > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
DiscardDeploymentChanges(std::string const &, Options)
Discards the changes in a deployment and reverts the deployment to the last approved deployment revision.
No changes take place if a deployment does not have revisions.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the deployment of which changes are being discarded. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::telcoautomation::v1::DiscardDeploymentChangesResponse > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.DiscardDeploymentChangesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DiscardDeploymentChanges(google::cloud::telcoautomation::v1::DiscardDeploymentChangesRequest const &, Options)
Discards the changes in a deployment and reverts the deployment to the last approved deployment revision.
No changes take place if a deployment does not have revisions.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::telcoautomation::v1::DiscardDeploymentChangesRequest 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::telcoautomation::v1::DiscardDeploymentChangesResponse > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.DiscardDeploymentChangesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ApplyDeployment(std::string const &, Options)
Applies the deployment's YAML files to the parent orchestration cluster.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the deployment to apply to orchestration cluster. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::telcoautomation::v1::Deployment > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.Deployment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ApplyDeployment(google::cloud::telcoautomation::v1::ApplyDeploymentRequest const &, Options)
Applies the deployment's YAML files to the parent orchestration cluster.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::telcoautomation::v1::ApplyDeploymentRequest 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::telcoautomation::v1::Deployment > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.Deployment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ComputeDeploymentStatus(std::string const &, Options)
Returns the requested deployment status.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the deployment without revisionID. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::telcoautomation::v1::ComputeDeploymentStatusResponse > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.ComputeDeploymentStatusResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ComputeDeploymentStatus(google::cloud::telcoautomation::v1::ComputeDeploymentStatusRequest const &, Options)
Returns the requested deployment status.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::telcoautomation::v1::ComputeDeploymentStatusRequest 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::telcoautomation::v1::ComputeDeploymentStatusResponse > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.ComputeDeploymentStatusResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
RollbackDeployment(std::string const &, std::string const &, Options)
Rollback the active deployment to the given past approved deployment revision.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the deployment. |
revision_id |
std::string const &
Required. The revision id of deployment to roll back to. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::telcoautomation::v1::Deployment > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.Deployment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
RollbackDeployment(google::cloud::telcoautomation::v1::RollbackDeploymentRequest const &, Options)
Rollback the active deployment to the given past approved deployment revision.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::telcoautomation::v1::RollbackDeploymentRequest 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::telcoautomation::v1::Deployment > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.Deployment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetHydratedDeployment(std::string const &, Options)
Returns the requested hydrated deployment.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the hydrated deployment. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::telcoautomation::v1::HydratedDeployment > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.HydratedDeployment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetHydratedDeployment(google::cloud::telcoautomation::v1::GetHydratedDeploymentRequest const &, Options)
Returns the requested hydrated deployment.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::telcoautomation::v1::GetHydratedDeploymentRequest 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::telcoautomation::v1::HydratedDeployment > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.HydratedDeployment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListHydratedDeployments(std::string const &, Options)
List all hydrated deployments present under a deployment.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The deployment managing the hydrated deployments. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::telcoautomation::v1::HydratedDeployment > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListHydratedDeployments(google::cloud::telcoautomation::v1::ListHydratedDeploymentsRequest, Options)
List all hydrated deployments present under a deployment.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::telcoautomation::v1::ListHydratedDeploymentsRequest
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::telcoautomation::v1::HydratedDeployment > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
UpdateHydratedDeployment(google::cloud::telcoautomation::v1::HydratedDeployment const &, google::protobuf::FieldMask const &, Options)
Updates a hydrated deployment.
Parameters | |
---|---|
Name | Description |
hydrated_deployment |
google::cloud::telcoautomation::v1::HydratedDeployment const &
Required. The hydrated deployment to update. |
update_mask |
google::protobuf::FieldMask const &
Required. The list of fields to update. Update mask supports a special value |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::telcoautomation::v1::HydratedDeployment > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.HydratedDeployment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateHydratedDeployment(google::cloud::telcoautomation::v1::UpdateHydratedDeploymentRequest const &, Options)
Updates a hydrated deployment.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::telcoautomation::v1::UpdateHydratedDeploymentRequest 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::telcoautomation::v1::HydratedDeployment > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.HydratedDeployment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ApplyHydratedDeployment(std::string const &, Options)
Applies a hydrated deployment to a workload cluster.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the hydrated deployment to apply. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::telcoautomation::v1::HydratedDeployment > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.HydratedDeployment) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ApplyHydratedDeployment(google::cloud::telcoautomation::v1::ApplyHydratedDeploymentRequest const &, Options)
Applies a hydrated deployment to a workload cluster.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::telcoautomation::v1::ApplyHydratedDeploymentRequest 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::telcoautomation::v1::HydratedDeployment > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.HydratedDeployment) 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
.
NOTE: the name
binding allows API services to override the binding to use different resource name schemes, such as users/*/operations
. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations"
to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
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
.
NOTE: the name
binding allows API services to override the binding to use different resource name schemes, such as users/*/operations
. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations"
to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
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 |
ListOrchestrationClusters(std::string const &, Options)
Lists OrchestrationClusters in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Parent value for ListOrchestrationClustersRequest |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::telcoautomation::v1::OrchestrationCluster > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListOrchestrationClusters(google::cloud::telcoautomation::v1::ListOrchestrationClustersRequest, Options)
Lists OrchestrationClusters in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::telcoautomation::v1::ListOrchestrationClustersRequest
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::telcoautomation::v1::OrchestrationCluster > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetOrchestrationCluster(std::string const &, Options)
Gets details of a single OrchestrationCluster.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the resource |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::telcoautomation::v1::OrchestrationCluster > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.OrchestrationCluster) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetOrchestrationCluster(google::cloud::telcoautomation::v1::GetOrchestrationClusterRequest const &, Options)
Gets details of a single OrchestrationCluster.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::telcoautomation::v1::GetOrchestrationClusterRequest 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::telcoautomation::v1::OrchestrationCluster > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.OrchestrationCluster) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateOrchestrationCluster(std::string const &, google::cloud::telcoautomation::v1::OrchestrationCluster const &, std::string const &, Options)
Creates a new OrchestrationCluster in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Value for parent. |
orchestration_cluster |
google::cloud::telcoautomation::v1::OrchestrationCluster const &
Required. The resource being created |
orchestration_cluster_id |
std::string const &
Required. Id of the requesting object If auto-generating Id server-side, remove this field and orchestration_cluster_id from the method_signature of Create RPC |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::telcoautomation::v1::OrchestrationCluster > > |
A |
CreateOrchestrationCluster(NoAwaitTag, std::string const &, google::cloud::telcoautomation::v1::OrchestrationCluster const &, std::string const &, Options)
Creates a new OrchestrationCluster in a 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 &
|
orchestration_cluster |
google::cloud::telcoautomation::v1::OrchestrationCluster const &
|
orchestration_cluster_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateOrchestrationCluster(google::cloud::telcoautomation::v1::CreateOrchestrationClusterRequest const &, Options)
Creates a new OrchestrationCluster in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::telcoautomation::v1::CreateOrchestrationClusterRequest 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::telcoautomation::v1::OrchestrationCluster > > |
A |
CreateOrchestrationCluster(NoAwaitTag, google::cloud::telcoautomation::v1::CreateOrchestrationClusterRequest const &, Options)
Creates a new OrchestrationCluster in a 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::telcoautomation::v1::CreateOrchestrationClusterRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateOrchestrationCluster(google::longrunning::Operation const &, Options)
Creates a new OrchestrationCluster in a 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::telcoautomation::v1::OrchestrationCluster > > |
DeleteOrchestrationCluster(std::string const &, Options)
Deletes a single OrchestrationCluster.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the resource |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::telcoautomation::v1::OperationMetadata > > |
A |
DeleteOrchestrationCluster(NoAwaitTag, std::string const &, Options)
Deletes a single OrchestrationCluster.
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 > |
DeleteOrchestrationCluster(google::cloud::telcoautomation::v1::DeleteOrchestrationClusterRequest const &, Options)
Deletes a single OrchestrationCluster.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::telcoautomation::v1::DeleteOrchestrationClusterRequest 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::telcoautomation::v1::OperationMetadata > > |
A |
DeleteOrchestrationCluster(NoAwaitTag, google::cloud::telcoautomation::v1::DeleteOrchestrationClusterRequest const &, Options)
Deletes a single OrchestrationCluster.
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::telcoautomation::v1::DeleteOrchestrationClusterRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteOrchestrationCluster(google::longrunning::Operation const &, Options)
Deletes a single OrchestrationCluster.
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::telcoautomation::v1::OperationMetadata > > |
ListEdgeSlms(std::string const &, Options)
Lists EdgeSlms in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Parent value for ListEdgeSlmsRequest |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::telcoautomation::v1::EdgeSlm > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListEdgeSlms(google::cloud::telcoautomation::v1::ListEdgeSlmsRequest, Options)
Lists EdgeSlms in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::telcoautomation::v1::ListEdgeSlmsRequest
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::telcoautomation::v1::EdgeSlm > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetEdgeSlm(std::string const &, Options)
Gets details of a single EdgeSlm.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the resource |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::telcoautomation::v1::EdgeSlm > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.EdgeSlm) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetEdgeSlm(google::cloud::telcoautomation::v1::GetEdgeSlmRequest const &, Options)
Gets details of a single EdgeSlm.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::telcoautomation::v1::GetEdgeSlmRequest 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::telcoautomation::v1::EdgeSlm > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.EdgeSlm) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateEdgeSlm(std::string const &, google::cloud::telcoautomation::v1::EdgeSlm const &, std::string const &, Options)
Creates a new EdgeSlm in a given project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. Value for parent. |
edge_slm |
google::cloud::telcoautomation::v1::EdgeSlm const &
Required. The resource being created |
edge_slm_id |
std::string const &
Required. Id of the requesting object If auto-generating Id server-side, remove this field and edge_slm_id from the method_signature of Create RPC |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::telcoautomation::v1::EdgeSlm > > |
A |
CreateEdgeSlm(NoAwaitTag, std::string const &, google::cloud::telcoautomation::v1::EdgeSlm const &, std::string const &, Options)
Creates a new EdgeSlm in a 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 &
|
edge_slm |
google::cloud::telcoautomation::v1::EdgeSlm const &
|
edge_slm_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateEdgeSlm(google::cloud::telcoautomation::v1::CreateEdgeSlmRequest const &, Options)
Creates a new EdgeSlm in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::telcoautomation::v1::CreateEdgeSlmRequest 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::telcoautomation::v1::EdgeSlm > > |
A |
CreateEdgeSlm(NoAwaitTag, google::cloud::telcoautomation::v1::CreateEdgeSlmRequest const &, Options)
Creates a new EdgeSlm in a 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::telcoautomation::v1::CreateEdgeSlmRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateEdgeSlm(google::longrunning::Operation const &, Options)
Creates a new EdgeSlm in a 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::telcoautomation::v1::EdgeSlm > > |
DeleteEdgeSlm(std::string const &, Options)
Deletes a single EdgeSlm.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. Name of the resource |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::telcoautomation::v1::OperationMetadata > > |
A |
DeleteEdgeSlm(NoAwaitTag, std::string const &, Options)
Deletes a single EdgeSlm.
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 > |
DeleteEdgeSlm(google::cloud::telcoautomation::v1::DeleteEdgeSlmRequest const &, Options)
Deletes a single EdgeSlm.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::telcoautomation::v1::DeleteEdgeSlmRequest 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::telcoautomation::v1::OperationMetadata > > |
A |
DeleteEdgeSlm(NoAwaitTag, google::cloud::telcoautomation::v1::DeleteEdgeSlmRequest const &, Options)
Deletes a single EdgeSlm.
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::telcoautomation::v1::DeleteEdgeSlmRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteEdgeSlm(google::longrunning::Operation const &, Options)
Deletes a single EdgeSlm.
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::telcoautomation::v1::OperationMetadata > > |
CreateBlueprint(std::string const &, google::cloud::telcoautomation::v1::Blueprint const &, std::string const &, Options)
Creates a blueprint.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The name of parent resource. Format should be - "projects/{project_id}/locations/{location_name}/orchestrationClusters/{orchestration_cluster}". |
blueprint |
google::cloud::telcoautomation::v1::Blueprint const &
Required. The |
blueprint_id |
std::string const &
Optional. The name of the blueprint. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::telcoautomation::v1::Blueprint > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.Blueprint) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateBlueprint(google::cloud::telcoautomation::v1::CreateBlueprintRequest const &, Options)
Creates a blueprint.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::telcoautomation::v1::CreateBlueprintRequest 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::telcoautomation::v1::Blueprint > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.Blueprint) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateBlueprint(google::cloud::telcoautomation::v1::Blueprint const &, google::protobuf::FieldMask const &, Options)
Updates a blueprint.
Parameters | |
---|---|
Name | Description |
blueprint |
google::cloud::telcoautomation::v1::Blueprint const &
Required. The |
update_mask |
google::protobuf::FieldMask const &
Required. Update mask is used to specify the fields to be overwritten in the |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::telcoautomation::v1::Blueprint > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.Blueprint) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateBlueprint(google::cloud::telcoautomation::v1::UpdateBlueprintRequest const &, Options)
Updates a blueprint.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::telcoautomation::v1::UpdateBlueprintRequest 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::telcoautomation::v1::Blueprint > |
the result of the RPC. The response message type (google.cloud.telcoautomation.v1.Blueprint) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |