Infrastructure Manager v1 API - Class Config.ConfigBase (1.3.0)

[BindServiceMethod(typeof(Config), "BindService")]
public abstract class Config.ConfigBase

Reference documentation and code samples for the Infrastructure Manager v1 API class Config.ConfigBase.

Base class for server-side implementations of Config

Inheritance

object > Config.ConfigBase

Namespace

Google.Cloud.Config.V1

Assembly

Google.Cloud.Config.V1.dll

Methods

CreateDeployment(CreateDeploymentRequest, ServerCallContext)

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

Creates a [Deployment][google.cloud.config.v1.Deployment].

Parameters
NameDescription
requestCreateDeploymentRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

CreatePreview(CreatePreviewRequest, ServerCallContext)

public virtual Task<Operation> CreatePreview(CreatePreviewRequest request, ServerCallContext context)

Creates a [Preview][google.cloud.config.v1.Preview].

Parameters
NameDescription
requestCreatePreviewRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

DeleteDeployment(DeleteDeploymentRequest, ServerCallContext)

public virtual Task<Operation> DeleteDeployment(DeleteDeploymentRequest request, ServerCallContext context)

Deletes a [Deployment][google.cloud.config.v1.Deployment].

Parameters
NameDescription
requestDeleteDeploymentRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

DeletePreview(DeletePreviewRequest, ServerCallContext)

public virtual Task<Operation> DeletePreview(DeletePreviewRequest request, ServerCallContext context)

Deletes a [Preview][google.cloud.config.v1.Preview].

Parameters
NameDescription
requestDeletePreviewRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

DeleteStatefile(DeleteStatefileRequest, ServerCallContext)

public virtual Task<Empty> DeleteStatefile(DeleteStatefileRequest request, ServerCallContext context)

Deletes Terraform state file in a given deployment.

Parameters
NameDescription
requestDeleteStatefileRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskEmpty

The response to send back to the client (wrapped by a task).

ExportDeploymentStatefile(ExportDeploymentStatefileRequest, ServerCallContext)

public virtual Task<Statefile> ExportDeploymentStatefile(ExportDeploymentStatefileRequest request, ServerCallContext context)

Exports Terraform state file from a given deployment.

Parameters
NameDescription
requestExportDeploymentStatefileRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskStatefile

The response to send back to the client (wrapped by a task).

ExportLockInfo(ExportLockInfoRequest, ServerCallContext)

public virtual Task<LockInfo> ExportLockInfo(ExportLockInfoRequest request, ServerCallContext context)

Exports the lock info on a locked deployment.

Parameters
NameDescription
requestExportLockInfoRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskLockInfo

The response to send back to the client (wrapped by a task).

ExportPreviewResult(ExportPreviewResultRequest, ServerCallContext)

public virtual Task<ExportPreviewResultResponse> ExportPreviewResult(ExportPreviewResultRequest request, ServerCallContext context)

Export [Preview][google.cloud.config.v1.Preview] results.

Parameters
NameDescription
requestExportPreviewResultRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskExportPreviewResultResponse

The response to send back to the client (wrapped by a task).

ExportRevisionStatefile(ExportRevisionStatefileRequest, ServerCallContext)

public virtual Task<Statefile> ExportRevisionStatefile(ExportRevisionStatefileRequest request, ServerCallContext context)

Exports Terraform state file from a given revision.

Parameters
NameDescription
requestExportRevisionStatefileRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskStatefile

The response to send back to the client (wrapped by a task).

GetDeployment(GetDeploymentRequest, ServerCallContext)

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

Gets details about a [Deployment][google.cloud.config.v1.Deployment].

Parameters
NameDescription
requestGetDeploymentRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskDeployment

The response to send back to the client (wrapped by a task).

GetPreview(GetPreviewRequest, ServerCallContext)

public virtual Task<Preview> GetPreview(GetPreviewRequest request, ServerCallContext context)

Gets details about a [Preview][google.cloud.config.v1.Preview].

Parameters
NameDescription
requestGetPreviewRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskPreview

The response to send back to the client (wrapped by a task).

GetResource(GetResourceRequest, ServerCallContext)

public virtual Task<Resource> GetResource(GetResourceRequest request, ServerCallContext context)

Gets details about a [Resource][google.cloud.config.v1.Resource] deployed by Infra Manager.

Parameters
NameDescription
requestGetResourceRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskResource

The response to send back to the client (wrapped by a task).

GetRevision(GetRevisionRequest, ServerCallContext)

public virtual Task<Revision> GetRevision(GetRevisionRequest request, ServerCallContext context)

Gets details about a [Revision][google.cloud.config.v1.Revision].

Parameters
NameDescription
requestGetRevisionRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskRevision

The response to send back to the client (wrapped by a task).

GetTerraformVersion(GetTerraformVersionRequest, ServerCallContext)

public virtual Task<TerraformVersion> GetTerraformVersion(GetTerraformVersionRequest request, ServerCallContext context)

Gets details about a [TerraformVersion][google.cloud.config.v1.TerraformVersion].

Parameters
NameDescription
requestGetTerraformVersionRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskTerraformVersion

The response to send back to the client (wrapped by a task).

ImportStatefile(ImportStatefileRequest, ServerCallContext)

public virtual Task<Statefile> ImportStatefile(ImportStatefileRequest request, ServerCallContext context)

Imports Terraform state file in a given deployment. The state file does not take effect until the Deployment has been unlocked.

Parameters
NameDescription
requestImportStatefileRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskStatefile

The response to send back to the client (wrapped by a task).

ListDeployments(ListDeploymentsRequest, ServerCallContext)

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

Lists [Deployment][google.cloud.config.v1.Deployment]s in a given project and location.

Parameters
NameDescription
requestListDeploymentsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListDeploymentsResponse

The response to send back to the client (wrapped by a task).

ListPreviews(ListPreviewsRequest, ServerCallContext)

public virtual Task<ListPreviewsResponse> ListPreviews(ListPreviewsRequest request, ServerCallContext context)

Lists [Preview][google.cloud.config.v1.Preview]s in a given project and location.

Parameters
NameDescription
requestListPreviewsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListPreviewsResponse

The response to send back to the client (wrapped by a task).

ListResources(ListResourcesRequest, ServerCallContext)

public virtual Task<ListResourcesResponse> ListResources(ListResourcesRequest request, ServerCallContext context)

Lists [Resource][google.cloud.config.v1.Resource]s in a given revision.

Parameters
NameDescription
requestListResourcesRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListResourcesResponse

The response to send back to the client (wrapped by a task).

ListRevisions(ListRevisionsRequest, ServerCallContext)

public virtual Task<ListRevisionsResponse> ListRevisions(ListRevisionsRequest request, ServerCallContext context)

Lists [Revision][google.cloud.config.v1.Revision]s of a deployment.

Parameters
NameDescription
requestListRevisionsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListRevisionsResponse

The response to send back to the client (wrapped by a task).

ListTerraformVersions(ListTerraformVersionsRequest, ServerCallContext)

public virtual Task<ListTerraformVersionsResponse> ListTerraformVersions(ListTerraformVersionsRequest request, ServerCallContext context)

Lists [TerraformVersion][google.cloud.config.v1.TerraformVersion]s in a given project and location.

Parameters
NameDescription
requestListTerraformVersionsRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListTerraformVersionsResponse

The response to send back to the client (wrapped by a task).

LockDeployment(LockDeploymentRequest, ServerCallContext)

public virtual Task<Operation> LockDeployment(LockDeploymentRequest request, ServerCallContext context)

Locks a deployment.

Parameters
NameDescription
requestLockDeploymentRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

UnlockDeployment(UnlockDeploymentRequest, ServerCallContext)

public virtual Task<Operation> UnlockDeployment(UnlockDeploymentRequest request, ServerCallContext context)

Unlocks a locked deployment.

Parameters
NameDescription
requestUnlockDeploymentRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).

UpdateDeployment(UpdateDeploymentRequest, ServerCallContext)

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

Updates a [Deployment][google.cloud.config.v1.Deployment].

Parameters
NameDescription
requestUpdateDeploymentRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOperation

The response to send back to the client (wrapped by a task).