Telco Automation v1 API - Class TelcoAutomation.TelcoAutomationBase (1.2.0)

[BindServiceMethod(typeof(TelcoAutomation), "BindService")]
public abstract class TelcoAutomation.TelcoAutomationBase

Reference documentation and code samples for the Telco Automation v1 API class TelcoAutomation.TelcoAutomationBase.

Base class for server-side implementations of TelcoAutomation

Inheritance

object > TelcoAutomation.TelcoAutomationBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.TelcoAutomation.V1

Assembly

Google.Cloud.TelcoAutomation.V1.dll

Methods

ApplyDeployment(ApplyDeploymentRequest, ServerCallContext)

public virtual Task<Deployment> ApplyDeployment(ApplyDeploymentRequest request, ServerCallContext context)

Applies the deployment's YAML files to the parent orchestration cluster.

Parameters
Name	Description
`request`	`ApplyDeploymentRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskDeployment`	The response to send back to the client (wrapped by a task).

ApplyHydratedDeployment(ApplyHydratedDeploymentRequest, ServerCallContext)

public virtual Task<HydratedDeployment> ApplyHydratedDeployment(ApplyHydratedDeploymentRequest request, ServerCallContext context)

Applies a hydrated deployment to a workload cluster.

Parameters
Name	Description
`request`	`ApplyHydratedDeploymentRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskHydratedDeployment`	The response to send back to the client (wrapped by a task).

ApproveBlueprint(ApproveBlueprintRequest, ServerCallContext)

public virtual Task<Blueprint> ApproveBlueprint(ApproveBlueprintRequest request, ServerCallContext context)

Approves a blueprint and commits a new revision.

Parameters
Name	Description
`request`	`ApproveBlueprintRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskBlueprint`	The response to send back to the client (wrapped by a task).

ComputeDeploymentStatus(ComputeDeploymentStatusRequest, ServerCallContext)

public virtual Task<ComputeDeploymentStatusResponse> ComputeDeploymentStatus(ComputeDeploymentStatusRequest request, ServerCallContext context)

Returns the requested deployment status.

Parameters
Name	Description
`request`	`ComputeDeploymentStatusRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskComputeDeploymentStatusResponse`	The response to send back to the client (wrapped by a task).

CreateBlueprint(CreateBlueprintRequest, ServerCallContext)

public virtual Task<Blueprint> CreateBlueprint(CreateBlueprintRequest request, ServerCallContext context)

Creates a blueprint.

Parameters
Name	Description
`request`	`CreateBlueprintRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskBlueprint`	The response to send back to the client (wrapped by a task).

CreateDeployment(CreateDeploymentRequest, ServerCallContext)

public virtual Task<Deployment> CreateDeployment(CreateDeploymentRequest request, ServerCallContext context)

Creates a deployment.

Parameters
Name	Description
`request`	`CreateDeploymentRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskDeployment`	The response to send back to the client (wrapped by a task).

CreateEdgeSlm(CreateEdgeSlmRequest, ServerCallContext)

public virtual Task<Operation> CreateEdgeSlm(CreateEdgeSlmRequest request, ServerCallContext context)

Creates a new EdgeSlm in a given project and location.

Parameters
Name	Description
`request`	`CreateEdgeSlmRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

CreateOrchestrationCluster(CreateOrchestrationClusterRequest, ServerCallContext)

public virtual Task<Operation> CreateOrchestrationCluster(CreateOrchestrationClusterRequest request, ServerCallContext context)

Creates a new OrchestrationCluster in a given project and location.

Parameters
Name	Description
`request`	`CreateOrchestrationClusterRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

DeleteBlueprint(DeleteBlueprintRequest, ServerCallContext)

public virtual Task<Empty> DeleteBlueprint(DeleteBlueprintRequest request, ServerCallContext context)

Deletes a blueprint and all its revisions.

Parameters
Name	Description
`request`	`DeleteBlueprintRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskEmpty`	The response to send back to the client (wrapped by a task).

DeleteEdgeSlm(DeleteEdgeSlmRequest, ServerCallContext)

public virtual Task<Operation> DeleteEdgeSlm(DeleteEdgeSlmRequest request, ServerCallContext context)

Deletes a single EdgeSlm.

Parameters
Name	Description
`request`	`DeleteEdgeSlmRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

DeleteOrchestrationCluster(DeleteOrchestrationClusterRequest, ServerCallContext)

public virtual Task<Operation> DeleteOrchestrationCluster(DeleteOrchestrationClusterRequest request, ServerCallContext context)

Deletes a single OrchestrationCluster.

Parameters
Name	Description
`request`	`DeleteOrchestrationClusterRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

DiscardBlueprintChanges(DiscardBlueprintChangesRequest, ServerCallContext)

public virtual Task<DiscardBlueprintChangesResponse> DiscardBlueprintChanges(DiscardBlueprintChangesRequest request, ServerCallContext context)

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`	`DiscardBlueprintChangesRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskDiscardBlueprintChangesResponse`	The response to send back to the client (wrapped by a task).

DiscardDeploymentChanges(DiscardDeploymentChangesRequest, ServerCallContext)

public virtual Task<DiscardDeploymentChangesResponse> DiscardDeploymentChanges(DiscardDeploymentChangesRequest request, ServerCallContext context)

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`	`DiscardDeploymentChangesRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskDiscardDeploymentChangesResponse`	The response to send back to the client (wrapped by a task).

GetBlueprint(GetBlueprintRequest, ServerCallContext)

public virtual Task<Blueprint> GetBlueprint(GetBlueprintRequest request, ServerCallContext context)

Returns the requested blueprint.

Parameters
Name	Description
`request`	`GetBlueprintRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskBlueprint`	The response to send back to the client (wrapped by a task).

GetDeployment(GetDeploymentRequest, ServerCallContext)

public virtual Task<Deployment> GetDeployment(GetDeploymentRequest request, ServerCallContext context)

Returns the requested deployment.

Parameters
Name	Description
`request`	`GetDeploymentRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskDeployment`	The response to send back to the client (wrapped by a task).

GetEdgeSlm(GetEdgeSlmRequest, ServerCallContext)

public virtual Task<EdgeSlm> GetEdgeSlm(GetEdgeSlmRequest request, ServerCallContext context)

Gets details of a single EdgeSlm.

Parameters
Name	Description
`request`	`GetEdgeSlmRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskEdgeSlm`	The response to send back to the client (wrapped by a task).

GetHydratedDeployment(GetHydratedDeploymentRequest, ServerCallContext)

public virtual Task<HydratedDeployment> GetHydratedDeployment(GetHydratedDeploymentRequest request, ServerCallContext context)

Returns the requested hydrated deployment.

Parameters
Name	Description
`request`	`GetHydratedDeploymentRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskHydratedDeployment`	The response to send back to the client (wrapped by a task).

GetOrchestrationCluster(GetOrchestrationClusterRequest, ServerCallContext)

public virtual Task<OrchestrationCluster> GetOrchestrationCluster(GetOrchestrationClusterRequest request, ServerCallContext context)

Gets details of a single OrchestrationCluster.

Parameters
Name	Description
`request`	`GetOrchestrationClusterRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOrchestrationCluster`	The response to send back to the client (wrapped by a task).

GetPublicBlueprint(GetPublicBlueprintRequest, ServerCallContext)

public virtual Task<PublicBlueprint> GetPublicBlueprint(GetPublicBlueprintRequest request, ServerCallContext context)

Returns the requested public blueprint.

Parameters
Name	Description
`request`	`GetPublicBlueprintRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskPublicBlueprint`	The response to send back to the client (wrapped by a task).

ListBlueprintRevisions(ListBlueprintRevisionsRequest, ServerCallContext)

public virtual Task<ListBlueprintRevisionsResponse> ListBlueprintRevisions(ListBlueprintRevisionsRequest request, ServerCallContext context)

List blueprint revisions of a given blueprint.

Parameters
Name	Description
`request`	`ListBlueprintRevisionsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListBlueprintRevisionsResponse`	The response to send back to the client (wrapped by a task).

ListBlueprints(ListBlueprintsRequest, ServerCallContext)

public virtual Task<ListBlueprintsResponse> ListBlueprints(ListBlueprintsRequest request, ServerCallContext context)

List all blueprints.

Parameters
Name	Description
`request`	`ListBlueprintsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListBlueprintsResponse`	The response to send back to the client (wrapped by a task).

ListDeploymentRevisions(ListDeploymentRevisionsRequest, ServerCallContext)

public virtual Task<ListDeploymentRevisionsResponse> ListDeploymentRevisions(ListDeploymentRevisionsRequest request, ServerCallContext context)

List deployment revisions of a given deployment.

Parameters
Name	Description
`request`	`ListDeploymentRevisionsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListDeploymentRevisionsResponse`	The response to send back to the client (wrapped by a task).

ListDeployments(ListDeploymentsRequest, ServerCallContext)

public virtual Task<ListDeploymentsResponse> ListDeployments(ListDeploymentsRequest request, ServerCallContext context)

List all deployments.

Parameters
Name	Description
`request`	`ListDeploymentsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListDeploymentsResponse`	The response to send back to the client (wrapped by a task).

ListEdgeSlms(ListEdgeSlmsRequest, ServerCallContext)

public virtual Task<ListEdgeSlmsResponse> ListEdgeSlms(ListEdgeSlmsRequest request, ServerCallContext context)

Lists EdgeSlms in a given project and location.

Parameters
Name	Description
`request`	`ListEdgeSlmsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListEdgeSlmsResponse`	The response to send back to the client (wrapped by a task).

ListHydratedDeployments(ListHydratedDeploymentsRequest, ServerCallContext)

public virtual Task<ListHydratedDeploymentsResponse> ListHydratedDeployments(ListHydratedDeploymentsRequest request, ServerCallContext context)

List all hydrated deployments present under a deployment.

Parameters
Name	Description
`request`	`ListHydratedDeploymentsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListHydratedDeploymentsResponse`	The response to send back to the client (wrapped by a task).

ListOrchestrationClusters(ListOrchestrationClustersRequest, ServerCallContext)

public virtual Task<ListOrchestrationClustersResponse> ListOrchestrationClusters(ListOrchestrationClustersRequest request, ServerCallContext context)

Lists OrchestrationClusters in a given project and location.

Parameters
Name	Description
`request`	`ListOrchestrationClustersRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListOrchestrationClustersResponse`	The response to send back to the client (wrapped by a task).

ListPublicBlueprints(ListPublicBlueprintsRequest, ServerCallContext)

public virtual Task<ListPublicBlueprintsResponse> ListPublicBlueprints(ListPublicBlueprintsRequest request, ServerCallContext context)

Lists the blueprints in TNA's public catalog. Default page size = 20, Max Page Size = 100.

Parameters
Name	Description
`request`	`ListPublicBlueprintsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListPublicBlueprintsResponse`	The response to send back to the client (wrapped by a task).

ProposeBlueprint(ProposeBlueprintRequest, ServerCallContext)

public virtual Task<Blueprint> ProposeBlueprint(ProposeBlueprintRequest request, ServerCallContext context)

Proposes a blueprint for approval of changes.

Parameters
Name	Description
`request`	`ProposeBlueprintRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskBlueprint`	The response to send back to the client (wrapped by a task).

RejectBlueprint(RejectBlueprintRequest, ServerCallContext)

public virtual Task<Blueprint> RejectBlueprint(RejectBlueprintRequest request, ServerCallContext context)

Rejects a blueprint revision proposal and flips it back to Draft state.

Parameters
Name	Description
`request`	`RejectBlueprintRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskBlueprint`	The response to send back to the client (wrapped by a task).

RemoveDeployment(RemoveDeploymentRequest, ServerCallContext)

public virtual Task<Empty> RemoveDeployment(RemoveDeploymentRequest request, ServerCallContext context)

Removes the deployment by marking it as DELETING. Post which deployment and it's revisions gets deleted.

Parameters
Name	Description
`request`	`RemoveDeploymentRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskEmpty`	The response to send back to the client (wrapped by a task).

RollbackDeployment(RollbackDeploymentRequest, ServerCallContext)

public virtual Task<Deployment> RollbackDeployment(RollbackDeploymentRequest request, ServerCallContext context)

Rollback the active deployment to the given past approved deployment revision.

Parameters
Name	Description
`request`	`RollbackDeploymentRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskDeployment`	The response to send back to the client (wrapped by a task).

SearchBlueprintRevisions(SearchBlueprintRevisionsRequest, ServerCallContext)

public virtual Task<SearchBlueprintRevisionsResponse> SearchBlueprintRevisions(SearchBlueprintRevisionsRequest request, ServerCallContext context)

Searches across blueprint revisions.

Parameters
Name	Description
`request`	`SearchBlueprintRevisionsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskSearchBlueprintRevisionsResponse`	The response to send back to the client (wrapped by a task).

SearchDeploymentRevisions(SearchDeploymentRevisionsRequest, ServerCallContext)

public virtual Task<SearchDeploymentRevisionsResponse> SearchDeploymentRevisions(SearchDeploymentRevisionsRequest request, ServerCallContext context)

Searches across deployment revisions.

Parameters
Name	Description
`request`	`SearchDeploymentRevisionsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskSearchDeploymentRevisionsResponse`	The response to send back to the client (wrapped by a task).

UpdateBlueprint(UpdateBlueprintRequest, ServerCallContext)

public virtual Task<Blueprint> UpdateBlueprint(UpdateBlueprintRequest request, ServerCallContext context)

Updates a blueprint.

Parameters
Name	Description
`request`	`UpdateBlueprintRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskBlueprint`	The response to send back to the client (wrapped by a task).

UpdateDeployment(UpdateDeploymentRequest, ServerCallContext)

public virtual Task<Deployment> UpdateDeployment(UpdateDeploymentRequest request, ServerCallContext context)

Updates a deployment.

Parameters
Name	Description
`request`	`UpdateDeploymentRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskDeployment`	The response to send back to the client (wrapped by a task).

UpdateHydratedDeployment(UpdateHydratedDeploymentRequest, ServerCallContext)

public virtual Task<HydratedDeployment> UpdateHydratedDeployment(UpdateHydratedDeploymentRequest request, ServerCallContext context)

Updates a hydrated deployment.

Parameters
Name	Description
`request`	`UpdateHydratedDeploymentRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskHydratedDeployment`	The response to send back to the client (wrapped by a task).