Class protos.google.cloud.config.v1.Config (0.7.0)

Represents a Config

Inheritance

$protobuf.rpc.Service > protos.google.cloud.config.v1.Config

Package

@google-cloud/config

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new Config service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): Config;

Creates new Config service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited
Returns
Type Description
Config

RPC service. Useful where requests and/or responses are streamed.

createDeployment(request, callback)

public createDeployment(request: google.cloud.config.v1.ICreateDeploymentRequest, callback: google.cloud.config.v1.Config.CreateDeploymentCallback): void;

Calls CreateDeployment.

Parameters
Name Description
request ICreateDeploymentRequest

CreateDeploymentRequest message or plain object
callback CreateDeploymentCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

createDeployment(request)

public createDeployment(request: google.cloud.config.v1.ICreateDeploymentRequest): Promise<google.longrunning.Operation>;

Calls CreateDeployment.

Parameter
Name Description
request ICreateDeploymentRequest

CreateDeploymentRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

createPreview(request, callback)

public createPreview(request: google.cloud.config.v1.ICreatePreviewRequest, callback: google.cloud.config.v1.Config.CreatePreviewCallback): void;

Calls CreatePreview.

Parameters
Name Description
request ICreatePreviewRequest

CreatePreviewRequest message or plain object
callback CreatePreviewCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

createPreview(request)

public createPreview(request: google.cloud.config.v1.ICreatePreviewRequest): Promise<google.longrunning.Operation>;

Calls CreatePreview.

Parameter
Name Description
request ICreatePreviewRequest

CreatePreviewRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

deleteDeployment(request, callback)

public deleteDeployment(request: google.cloud.config.v1.IDeleteDeploymentRequest, callback: google.cloud.config.v1.Config.DeleteDeploymentCallback): void;

Calls DeleteDeployment.

Parameters
Name Description
request IDeleteDeploymentRequest

DeleteDeploymentRequest message or plain object
callback DeleteDeploymentCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

deleteDeployment(request)

public deleteDeployment(request: google.cloud.config.v1.IDeleteDeploymentRequest): Promise<google.longrunning.Operation>;

Calls DeleteDeployment.

Parameter
Name Description
request IDeleteDeploymentRequest

DeleteDeploymentRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

deletePreview(request, callback)

public deletePreview(request: google.cloud.config.v1.IDeletePreviewRequest, callback: google.cloud.config.v1.Config.DeletePreviewCallback): void;

Calls DeletePreview.

Parameters
Name Description
request IDeletePreviewRequest

DeletePreviewRequest message or plain object
callback DeletePreviewCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

deletePreview(request)

public deletePreview(request: google.cloud.config.v1.IDeletePreviewRequest): Promise<google.longrunning.Operation>;

Calls DeletePreview.

Parameter
Name Description
request IDeletePreviewRequest

DeletePreviewRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

deleteStatefile(request, callback)

public deleteStatefile(request: google.cloud.config.v1.IDeleteStatefileRequest, callback: google.cloud.config.v1.Config.DeleteStatefileCallback): void;

Calls DeleteStatefile.

Parameters
Name Description
request IDeleteStatefileRequest

DeleteStatefileRequest message or plain object
callback DeleteStatefileCallback

Node-style callback called with the error, if any, and Empty
Returns
Type Description
void

deleteStatefile(request)

public deleteStatefile(request: google.cloud.config.v1.IDeleteStatefileRequest): Promise<google.protobuf.Empty>;

Calls DeleteStatefile.

Parameter
Name Description
request IDeleteStatefileRequest

DeleteStatefileRequest message or plain object
Returns
Type Description
Promise<google.protobuf.Empty>

Promise

exportDeploymentStatefile(request, callback)

public exportDeploymentStatefile(request: google.cloud.config.v1.IExportDeploymentStatefileRequest, callback: google.cloud.config.v1.Config.ExportDeploymentStatefileCallback): void;

Calls ExportDeploymentStatefile.

Parameters
Name Description
request IExportDeploymentStatefileRequest

ExportDeploymentStatefileRequest message or plain object
callback ExportDeploymentStatefileCallback

Node-style callback called with the error, if any, and Statefile
Returns
Type Description
void

exportDeploymentStatefile(request)

public exportDeploymentStatefile(request: google.cloud.config.v1.IExportDeploymentStatefileRequest): Promise<google.cloud.config.v1.Statefile>;

Calls ExportDeploymentStatefile.

Parameter
Name Description
request IExportDeploymentStatefileRequest

ExportDeploymentStatefileRequest message or plain object
Returns
Type Description
Promise<google.cloud.config.v1.Statefile>

Promise

exportLockInfo(request, callback)

public exportLockInfo(request: google.cloud.config.v1.IExportLockInfoRequest, callback: google.cloud.config.v1.Config.ExportLockInfoCallback): void;

Calls ExportLockInfo.

Parameters
Name Description
request IExportLockInfoRequest

ExportLockInfoRequest message or plain object
callback ExportLockInfoCallback

Node-style callback called with the error, if any, and LockInfo
Returns
Type Description
void

exportLockInfo(request)

public exportLockInfo(request: google.cloud.config.v1.IExportLockInfoRequest): Promise<google.cloud.config.v1.LockInfo>;

Calls ExportLockInfo.

Parameter
Name Description
request IExportLockInfoRequest

ExportLockInfoRequest message or plain object
Returns
Type Description
Promise<google.cloud.config.v1.LockInfo>

Promise

exportPreviewResult(request, callback)

public exportPreviewResult(request: google.cloud.config.v1.IExportPreviewResultRequest, callback: google.cloud.config.v1.Config.ExportPreviewResultCallback): void;

Calls ExportPreviewResult.

Parameters
Name Description
request IExportPreviewResultRequest

ExportPreviewResultRequest message or plain object
callback ExportPreviewResultCallback

Node-style callback called with the error, if any, and ExportPreviewResultResponse
Returns
Type Description
void

exportPreviewResult(request)

public exportPreviewResult(request: google.cloud.config.v1.IExportPreviewResultRequest): Promise<google.cloud.config.v1.ExportPreviewResultResponse>;

Calls ExportPreviewResult.

Parameter
Name Description
request IExportPreviewResultRequest

ExportPreviewResultRequest message or plain object
Returns
Type Description
Promise<google.cloud.config.v1.ExportPreviewResultResponse>

Promise

exportRevisionStatefile(request, callback)

public exportRevisionStatefile(request: google.cloud.config.v1.IExportRevisionStatefileRequest, callback: google.cloud.config.v1.Config.ExportRevisionStatefileCallback): void;

Calls ExportRevisionStatefile.

Parameters
Name Description
request IExportRevisionStatefileRequest

ExportRevisionStatefileRequest message or plain object
callback ExportRevisionStatefileCallback

Node-style callback called with the error, if any, and Statefile
Returns
Type Description
void

exportRevisionStatefile(request)

public exportRevisionStatefile(request: google.cloud.config.v1.IExportRevisionStatefileRequest): Promise<google.cloud.config.v1.Statefile>;

Calls ExportRevisionStatefile.

Parameter
Name Description
request IExportRevisionStatefileRequest

ExportRevisionStatefileRequest message or plain object
Returns
Type Description
Promise<google.cloud.config.v1.Statefile>

Promise

getDeployment(request, callback)

public getDeployment(request: google.cloud.config.v1.IGetDeploymentRequest, callback: google.cloud.config.v1.Config.GetDeploymentCallback): void;

Calls GetDeployment.

Parameters
Name Description
request IGetDeploymentRequest

GetDeploymentRequest message or plain object
callback GetDeploymentCallback

Node-style callback called with the error, if any, and Deployment
Returns
Type Description
void

getDeployment(request)

public getDeployment(request: google.cloud.config.v1.IGetDeploymentRequest): Promise<google.cloud.config.v1.Deployment>;

Calls GetDeployment.

Parameter
Name Description
request IGetDeploymentRequest

GetDeploymentRequest message or plain object
Returns
Type Description
Promise<google.cloud.config.v1.Deployment>

Promise

getPreview(request, callback)

public getPreview(request: google.cloud.config.v1.IGetPreviewRequest, callback: google.cloud.config.v1.Config.GetPreviewCallback): void;

Calls GetPreview.

Parameters
Name Description
request IGetPreviewRequest

GetPreviewRequest message or plain object
callback GetPreviewCallback

Node-style callback called with the error, if any, and Preview
Returns
Type Description
void

getPreview(request)

public getPreview(request: google.cloud.config.v1.IGetPreviewRequest): Promise<google.cloud.config.v1.Preview>;

Calls GetPreview.

Parameter
Name Description
request IGetPreviewRequest

GetPreviewRequest message or plain object
Returns
Type Description
Promise<google.cloud.config.v1.Preview>

Promise

getResource(request, callback)

public getResource(request: google.cloud.config.v1.IGetResourceRequest, callback: google.cloud.config.v1.Config.GetResourceCallback): void;

Calls GetResource.

Parameters
Name Description
request IGetResourceRequest

GetResourceRequest message or plain object
callback GetResourceCallback

Node-style callback called with the error, if any, and Resource
Returns
Type Description
void

getResource(request)

public getResource(request: google.cloud.config.v1.IGetResourceRequest): Promise<google.cloud.config.v1.Resource>;

Calls GetResource.

Parameter
Name Description
request IGetResourceRequest

GetResourceRequest message or plain object
Returns
Type Description
Promise<google.cloud.config.v1.Resource>

Promise

getRevision(request, callback)

public getRevision(request: google.cloud.config.v1.IGetRevisionRequest, callback: google.cloud.config.v1.Config.GetRevisionCallback): void;

Calls GetRevision.

Parameters
Name Description
request IGetRevisionRequest

GetRevisionRequest message or plain object
callback GetRevisionCallback

Node-style callback called with the error, if any, and Revision
Returns
Type Description
void

getRevision(request)

public getRevision(request: google.cloud.config.v1.IGetRevisionRequest): Promise<google.cloud.config.v1.Revision>;

Calls GetRevision.

Parameter
Name Description
request IGetRevisionRequest

GetRevisionRequest message or plain object
Returns
Type Description
Promise<google.cloud.config.v1.Revision>

Promise

getTerraformVersion(request, callback)

public getTerraformVersion(request: google.cloud.config.v1.IGetTerraformVersionRequest, callback: google.cloud.config.v1.Config.GetTerraformVersionCallback): void;

Calls GetTerraformVersion.

Parameters
Name Description
request IGetTerraformVersionRequest

GetTerraformVersionRequest message or plain object
callback GetTerraformVersionCallback

Node-style callback called with the error, if any, and TerraformVersion
Returns
Type Description
void

getTerraformVersion(request)

public getTerraformVersion(request: google.cloud.config.v1.IGetTerraformVersionRequest): Promise<google.cloud.config.v1.TerraformVersion>;

Calls GetTerraformVersion.

Parameter
Name Description
request IGetTerraformVersionRequest

GetTerraformVersionRequest message or plain object
Returns
Type Description
Promise<google.cloud.config.v1.TerraformVersion>

Promise

importStatefile(request, callback)

public importStatefile(request: google.cloud.config.v1.IImportStatefileRequest, callback: google.cloud.config.v1.Config.ImportStatefileCallback): void;

Calls ImportStatefile.

Parameters
Name Description
request IImportStatefileRequest

ImportStatefileRequest message or plain object
callback ImportStatefileCallback

Node-style callback called with the error, if any, and Statefile
Returns
Type Description
void

importStatefile(request)

public importStatefile(request: google.cloud.config.v1.IImportStatefileRequest): Promise<google.cloud.config.v1.Statefile>;

Calls ImportStatefile.

Parameter
Name Description
request IImportStatefileRequest

ImportStatefileRequest message or plain object
Returns
Type Description
Promise<google.cloud.config.v1.Statefile>

Promise

listDeployments(request, callback)

public listDeployments(request: google.cloud.config.v1.IListDeploymentsRequest, callback: google.cloud.config.v1.Config.ListDeploymentsCallback): void;

Calls ListDeployments.

Parameters
Name Description
request IListDeploymentsRequest

ListDeploymentsRequest message or plain object
callback ListDeploymentsCallback

Node-style callback called with the error, if any, and ListDeploymentsResponse
Returns
Type Description
void

listDeployments(request)

public listDeployments(request: google.cloud.config.v1.IListDeploymentsRequest): Promise<google.cloud.config.v1.ListDeploymentsResponse>;

Calls ListDeployments.

Parameter
Name Description
request IListDeploymentsRequest

ListDeploymentsRequest message or plain object
Returns
Type Description
Promise<google.cloud.config.v1.ListDeploymentsResponse>

Promise

listPreviews(request, callback)

public listPreviews(request: google.cloud.config.v1.IListPreviewsRequest, callback: google.cloud.config.v1.Config.ListPreviewsCallback): void;

Calls ListPreviews.

Parameters
Name Description
request IListPreviewsRequest

ListPreviewsRequest message or plain object
callback ListPreviewsCallback

Node-style callback called with the error, if any, and ListPreviewsResponse
Returns
Type Description
void

listPreviews(request)

public listPreviews(request: google.cloud.config.v1.IListPreviewsRequest): Promise<google.cloud.config.v1.ListPreviewsResponse>;

Calls ListPreviews.

Parameter
Name Description
request IListPreviewsRequest

ListPreviewsRequest message or plain object
Returns
Type Description
Promise<google.cloud.config.v1.ListPreviewsResponse>

Promise

listResources(request, callback)

public listResources(request: google.cloud.config.v1.IListResourcesRequest, callback: google.cloud.config.v1.Config.ListResourcesCallback): void;

Calls ListResources.

Parameters
Name Description
request IListResourcesRequest

ListResourcesRequest message or plain object
callback ListResourcesCallback

Node-style callback called with the error, if any, and ListResourcesResponse
Returns
Type Description
void

listResources(request)

public listResources(request: google.cloud.config.v1.IListResourcesRequest): Promise<google.cloud.config.v1.ListResourcesResponse>;

Calls ListResources.

Parameter
Name Description
request IListResourcesRequest

ListResourcesRequest message or plain object
Returns
Type Description
Promise<google.cloud.config.v1.ListResourcesResponse>

Promise

listRevisions(request, callback)

public listRevisions(request: google.cloud.config.v1.IListRevisionsRequest, callback: google.cloud.config.v1.Config.ListRevisionsCallback): void;

Calls ListRevisions.

Parameters
Name Description
request IListRevisionsRequest

ListRevisionsRequest message or plain object
callback ListRevisionsCallback

Node-style callback called with the error, if any, and ListRevisionsResponse
Returns
Type Description
void

listRevisions(request)

public listRevisions(request: google.cloud.config.v1.IListRevisionsRequest): Promise<google.cloud.config.v1.ListRevisionsResponse>;

Calls ListRevisions.

Parameter
Name Description
request IListRevisionsRequest

ListRevisionsRequest message or plain object
Returns
Type Description
Promise<google.cloud.config.v1.ListRevisionsResponse>

Promise

listTerraformVersions(request, callback)

public listTerraformVersions(request: google.cloud.config.v1.IListTerraformVersionsRequest, callback: google.cloud.config.v1.Config.ListTerraformVersionsCallback): void;

Calls ListTerraformVersions.

Parameters
Name Description
request IListTerraformVersionsRequest

ListTerraformVersionsRequest message or plain object
callback ListTerraformVersionsCallback

Node-style callback called with the error, if any, and ListTerraformVersionsResponse
Returns
Type Description
void

listTerraformVersions(request)

public listTerraformVersions(request: google.cloud.config.v1.IListTerraformVersionsRequest): Promise<google.cloud.config.v1.ListTerraformVersionsResponse>;

Calls ListTerraformVersions.

Parameter
Name Description
request IListTerraformVersionsRequest

ListTerraformVersionsRequest message or plain object
Returns
Type Description
Promise<google.cloud.config.v1.ListTerraformVersionsResponse>

Promise

lockDeployment(request, callback)

public lockDeployment(request: google.cloud.config.v1.ILockDeploymentRequest, callback: google.cloud.config.v1.Config.LockDeploymentCallback): void;

Calls LockDeployment.

Parameters
Name Description
request ILockDeploymentRequest

LockDeploymentRequest message or plain object
callback LockDeploymentCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

lockDeployment(request)

public lockDeployment(request: google.cloud.config.v1.ILockDeploymentRequest): Promise<google.longrunning.Operation>;

Calls LockDeployment.

Parameter
Name Description
request ILockDeploymentRequest

LockDeploymentRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

unlockDeployment(request, callback)

public unlockDeployment(request: google.cloud.config.v1.IUnlockDeploymentRequest, callback: google.cloud.config.v1.Config.UnlockDeploymentCallback): void;

Calls UnlockDeployment.

Parameters
Name Description
request IUnlockDeploymentRequest

UnlockDeploymentRequest message or plain object
callback UnlockDeploymentCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

unlockDeployment(request)

public unlockDeployment(request: google.cloud.config.v1.IUnlockDeploymentRequest): Promise<google.longrunning.Operation>;

Calls UnlockDeployment.

Parameter
Name Description
request IUnlockDeploymentRequest

UnlockDeploymentRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

updateDeployment(request, callback)

public updateDeployment(request: google.cloud.config.v1.IUpdateDeploymentRequest, callback: google.cloud.config.v1.Config.UpdateDeploymentCallback): void;

Calls UpdateDeployment.

Parameters
Name Description
request IUpdateDeploymentRequest

UpdateDeploymentRequest message or plain object
callback UpdateDeploymentCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

updateDeployment(request)

public updateDeployment(request: google.cloud.config.v1.IUpdateDeploymentRequest): Promise<google.longrunning.Operation>;

Calls UpdateDeployment.

Parameter
Name Description
request IUpdateDeploymentRequest

UpdateDeploymentRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise