Class protos.google.cloud.osconfig.v1.OsConfigService (2.1.2)

Represents an OsConfigService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.osconfig.v1.OsConfigService

Package

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

Constructs a new OsConfigService service.

Parameters

Name	Description
rpcImpl	`$protobuf.RPCImpl` RPC implementation
requestDelimited	`boolean` Whether requests are length-delimited
responseDelimited	`boolean` Whether responses are length-delimited

Methods

cancelPatchJob(request, callback)

public cancelPatchJob(request: google.cloud.osconfig.v1.ICancelPatchJobRequest, callback: google.cloud.osconfig.v1.OsConfigService.CancelPatchJobCallback): void;

Calls CancelPatchJob.

Parameters

Name	Description
request	`ICancelPatchJobRequest` CancelPatchJobRequest message or plain object
callback	`google.cloud.osconfig.v1.OsConfigService.CancelPatchJobCallback` Node-style callback called with the error, if any, and PatchJob

Returns

Type	Description
void

cancelPatchJob(request)

public cancelPatchJob(request: google.cloud.osconfig.v1.ICancelPatchJobRequest): Promise<google.cloud.osconfig.v1.PatchJob>;

Calls CancelPatchJob.

Parameter

Name	Description
request	`ICancelPatchJobRequest` CancelPatchJobRequest message or plain object

Returns

Type	Description
Promise<google.cloud.osconfig.v1.PatchJob>	Promise

create(rpcImpl, requestDelimited, responseDelimited)

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

Creates new OsConfigService 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
OsConfigService	RPC service. Useful where requests and/or responses are streamed.

createPatchDeployment(request, callback)

public createPatchDeployment(request: google.cloud.osconfig.v1.ICreatePatchDeploymentRequest, callback: google.cloud.osconfig.v1.OsConfigService.CreatePatchDeploymentCallback): void;

Calls CreatePatchDeployment.

Parameters

Name	Description
request	`google.cloud.osconfig.v1.ICreatePatchDeploymentRequest` CreatePatchDeploymentRequest message or plain object
callback	`google.cloud.osconfig.v1.OsConfigService.CreatePatchDeploymentCallback` Node-style callback called with the error, if any, and PatchDeployment

Returns

Type	Description
void

createPatchDeployment(request)

public createPatchDeployment(request: google.cloud.osconfig.v1.ICreatePatchDeploymentRequest): Promise<google.cloud.osconfig.v1.PatchDeployment>;

Calls CreatePatchDeployment.

Parameter

Name	Description
request	`google.cloud.osconfig.v1.ICreatePatchDeploymentRequest` CreatePatchDeploymentRequest message or plain object

Returns

Type	Description
Promise<google.cloud.osconfig.v1.PatchDeployment>	Promise

deletePatchDeployment(request, callback)

public deletePatchDeployment(request: google.cloud.osconfig.v1.IDeletePatchDeploymentRequest, callback: google.cloud.osconfig.v1.OsConfigService.DeletePatchDeploymentCallback): void;

Calls DeletePatchDeployment.

Parameters

Name	Description
request	`IDeletePatchDeploymentRequest` DeletePatchDeploymentRequest message or plain object
callback	`google.cloud.osconfig.v1.OsConfigService.DeletePatchDeploymentCallback` Node-style callback called with the error, if any, and Empty

Returns

Type	Description
void

deletePatchDeployment(request)

public deletePatchDeployment(request: google.cloud.osconfig.v1.IDeletePatchDeploymentRequest): Promise<google.protobuf.Empty>;

Calls DeletePatchDeployment.

Parameter

Name	Description
request	`IDeletePatchDeploymentRequest` DeletePatchDeploymentRequest message or plain object

Returns

Type	Description
Promise<google.protobuf.Empty>	Promise

executePatchJob(request, callback)

public executePatchJob(request: google.cloud.osconfig.v1.IExecutePatchJobRequest, callback: google.cloud.osconfig.v1.OsConfigService.ExecutePatchJobCallback): void;

Calls ExecutePatchJob.

Parameters

Name	Description
request	`google.cloud.osconfig.v1.IExecutePatchJobRequest` ExecutePatchJobRequest message or plain object
callback	`google.cloud.osconfig.v1.OsConfigService.ExecutePatchJobCallback` Node-style callback called with the error, if any, and PatchJob

Returns

Type	Description
void

executePatchJob(request)

public executePatchJob(request: google.cloud.osconfig.v1.IExecutePatchJobRequest): Promise<google.cloud.osconfig.v1.PatchJob>;

Calls ExecutePatchJob.

Parameter

Name	Description
request	`google.cloud.osconfig.v1.IExecutePatchJobRequest` ExecutePatchJobRequest message or plain object

Returns

Type	Description
Promise<google.cloud.osconfig.v1.PatchJob>	Promise

getPatchDeployment(request, callback)

public getPatchDeployment(request: google.cloud.osconfig.v1.IGetPatchDeploymentRequest, callback: google.cloud.osconfig.v1.OsConfigService.GetPatchDeploymentCallback): void;

Calls GetPatchDeployment.

Parameters

Name	Description
request	`IGetPatchDeploymentRequest` GetPatchDeploymentRequest message or plain object
callback	`google.cloud.osconfig.v1.OsConfigService.GetPatchDeploymentCallback` Node-style callback called with the error, if any, and PatchDeployment

Returns

Type	Description
void

getPatchDeployment(request)

public getPatchDeployment(request: google.cloud.osconfig.v1.IGetPatchDeploymentRequest): Promise<google.cloud.osconfig.v1.PatchDeployment>;

Calls GetPatchDeployment.

Parameter

Name	Description
request	`IGetPatchDeploymentRequest` GetPatchDeploymentRequest message or plain object

Returns

Type	Description
Promise<google.cloud.osconfig.v1.PatchDeployment>	Promise

getPatchJob(request, callback)

public getPatchJob(request: google.cloud.osconfig.v1.IGetPatchJobRequest, callback: google.cloud.osconfig.v1.OsConfigService.GetPatchJobCallback): void;

Calls GetPatchJob.

Parameters

Name	Description
request	`google.cloud.osconfig.v1.IGetPatchJobRequest` GetPatchJobRequest message or plain object
callback	`google.cloud.osconfig.v1.OsConfigService.GetPatchJobCallback` Node-style callback called with the error, if any, and PatchJob

Returns

Type	Description
void

getPatchJob(request)

public getPatchJob(request: google.cloud.osconfig.v1.IGetPatchJobRequest): Promise<google.cloud.osconfig.v1.PatchJob>;

Calls GetPatchJob.

Parameter

Name	Description
request	`google.cloud.osconfig.v1.IGetPatchJobRequest` GetPatchJobRequest message or plain object

Returns

Type	Description
Promise<google.cloud.osconfig.v1.PatchJob>	Promise

listPatchDeployments(request, callback)

public listPatchDeployments(request: google.cloud.osconfig.v1.IListPatchDeploymentsRequest, callback: google.cloud.osconfig.v1.OsConfigService.ListPatchDeploymentsCallback): void;

Calls ListPatchDeployments.

Parameters

Name	Description
request	`google.cloud.osconfig.v1.IListPatchDeploymentsRequest` ListPatchDeploymentsRequest message or plain object
callback	`google.cloud.osconfig.v1.OsConfigService.ListPatchDeploymentsCallback` Node-style callback called with the error, if any, and ListPatchDeploymentsResponse

Returns

Type	Description
void

listPatchDeployments(request)

public listPatchDeployments(request: google.cloud.osconfig.v1.IListPatchDeploymentsRequest): Promise<google.cloud.osconfig.v1.ListPatchDeploymentsResponse>;

Calls ListPatchDeployments.

Parameter

Name	Description
request	`google.cloud.osconfig.v1.IListPatchDeploymentsRequest` ListPatchDeploymentsRequest message or plain object

Returns

Type	Description
Promise<google.cloud.osconfig.v1.ListPatchDeploymentsResponse>	Promise

listPatchJobInstanceDetails(request, callback)

public listPatchJobInstanceDetails(request: google.cloud.osconfig.v1.IListPatchJobInstanceDetailsRequest, callback: google.cloud.osconfig.v1.OsConfigService.ListPatchJobInstanceDetailsCallback): void;

Calls ListPatchJobInstanceDetails.

Parameters

Name	Description
request	`google.cloud.osconfig.v1.IListPatchJobInstanceDetailsRequest` ListPatchJobInstanceDetailsRequest message or plain object
callback	`google.cloud.osconfig.v1.OsConfigService.ListPatchJobInstanceDetailsCallback` Node-style callback called with the error, if any, and ListPatchJobInstanceDetailsResponse

Returns

Type	Description
void

listPatchJobInstanceDetails(request)

public listPatchJobInstanceDetails(request: google.cloud.osconfig.v1.IListPatchJobInstanceDetailsRequest): Promise<google.cloud.osconfig.v1.ListPatchJobInstanceDetailsResponse>;

Calls ListPatchJobInstanceDetails.

Parameter

Name	Description
request	`google.cloud.osconfig.v1.IListPatchJobInstanceDetailsRequest` ListPatchJobInstanceDetailsRequest message or plain object

Returns

Type	Description
Promise<google.cloud.osconfig.v1.ListPatchJobInstanceDetailsResponse>	Promise

listPatchJobs(request, callback)

public listPatchJobs(request: google.cloud.osconfig.v1.IListPatchJobsRequest, callback: google.cloud.osconfig.v1.OsConfigService.ListPatchJobsCallback): void;

Calls ListPatchJobs.

Parameters

Name	Description
request	`IListPatchJobsRequest` ListPatchJobsRequest message or plain object
callback	`google.cloud.osconfig.v1.OsConfigService.ListPatchJobsCallback` Node-style callback called with the error, if any, and ListPatchJobsResponse

Returns

Type	Description
void

listPatchJobs(request)

public listPatchJobs(request: google.cloud.osconfig.v1.IListPatchJobsRequest): Promise<google.cloud.osconfig.v1.ListPatchJobsResponse>;

Calls ListPatchJobs.

Parameter

Name	Description
request	`IListPatchJobsRequest` ListPatchJobsRequest message or plain object

Returns

Type	Description
Promise<google.cloud.osconfig.v1.ListPatchJobsResponse>	Promise

pausePatchDeployment(request, callback)

public pausePatchDeployment(request: google.cloud.osconfig.v1.IPausePatchDeploymentRequest, callback: google.cloud.osconfig.v1.OsConfigService.PausePatchDeploymentCallback): void;

Calls PausePatchDeployment.

Parameters

Name	Description
request	`IPausePatchDeploymentRequest` PausePatchDeploymentRequest message or plain object
callback	`google.cloud.osconfig.v1.OsConfigService.PausePatchDeploymentCallback` Node-style callback called with the error, if any, and PatchDeployment

Returns

Type	Description
void

pausePatchDeployment(request)

public pausePatchDeployment(request: google.cloud.osconfig.v1.IPausePatchDeploymentRequest): Promise<google.cloud.osconfig.v1.PatchDeployment>;

Calls PausePatchDeployment.

Parameter

Name	Description
request	`IPausePatchDeploymentRequest` PausePatchDeploymentRequest message or plain object

Returns

Type	Description
Promise<google.cloud.osconfig.v1.PatchDeployment>	Promise

resumePatchDeployment(request, callback)

public resumePatchDeployment(request: google.cloud.osconfig.v1.IResumePatchDeploymentRequest, callback: google.cloud.osconfig.v1.OsConfigService.ResumePatchDeploymentCallback): void;

Calls ResumePatchDeployment.

Parameters

Name	Description
request	`google.cloud.osconfig.v1.IResumePatchDeploymentRequest` ResumePatchDeploymentRequest message or plain object
callback	`google.cloud.osconfig.v1.OsConfigService.ResumePatchDeploymentCallback` Node-style callback called with the error, if any, and PatchDeployment

Returns

Type	Description
void

resumePatchDeployment(request)

public resumePatchDeployment(request: google.cloud.osconfig.v1.IResumePatchDeploymentRequest): Promise<google.cloud.osconfig.v1.PatchDeployment>;

Calls ResumePatchDeployment.

Parameter

Name	Description
request	`google.cloud.osconfig.v1.IResumePatchDeploymentRequest` ResumePatchDeploymentRequest message or plain object

Returns

Type	Description
Promise<google.cloud.osconfig.v1.PatchDeployment>	Promise

updatePatchDeployment(request, callback)

public updatePatchDeployment(request: google.cloud.osconfig.v1.IUpdatePatchDeploymentRequest, callback: google.cloud.osconfig.v1.OsConfigService.UpdatePatchDeploymentCallback): void;

Calls UpdatePatchDeployment.

Parameters

Name	Description
request	`google.cloud.osconfig.v1.IUpdatePatchDeploymentRequest` UpdatePatchDeploymentRequest message or plain object
callback	`google.cloud.osconfig.v1.OsConfigService.UpdatePatchDeploymentCallback` Node-style callback called with the error, if any, and PatchDeployment

Returns

Type	Description
void

updatePatchDeployment(request)

public updatePatchDeployment(request: google.cloud.osconfig.v1.IUpdatePatchDeploymentRequest): Promise<google.cloud.osconfig.v1.PatchDeployment>;

Calls UpdatePatchDeployment.

Parameter

Name	Description
request	`google.cloud.osconfig.v1.IUpdatePatchDeploymentRequest` UpdatePatchDeploymentRequest message or plain object

Returns

Type	Description
Promise<google.cloud.osconfig.v1.PatchDeployment>	Promise