OsConfigService

google.cloud.osconfig.v1. OsConfigService

Represents an OsConfigService

Constructor

new OsConfigService(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new OsConfigService service.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean <optional>
 false

Whether requests are length-delimited
responseDelimited boolean <optional>
 false

Whether responses are length-delimited

Extends

  • $protobuf.rpc.Service

Methods

cancelPatchJob(request, callback) → {undefined}

Calls CancelPatchJob.

Parameters:
Name Type Description
request google.cloud.osconfig.v1.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
undefined

cancelPatchJob(request) → {Promise.<google.cloud.osconfig.v1.PatchJob>}

Calls CancelPatchJob.

Parameters:
Name Type Description
request google.cloud.osconfig.v1.ICancelPatchJobRequest

CancelPatchJobRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.osconfig.v1.PatchJob>

Promise

createPatchDeployment(request, callback) → {undefined}

Calls CreatePatchDeployment.

Parameters:
Name Type 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
undefined

createPatchDeployment(request) → {Promise.<google.cloud.osconfig.v1.PatchDeployment>}

Calls CreatePatchDeployment.

Parameters:
Name Type 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) → {undefined}

Calls DeletePatchDeployment.

Parameters:
Name Type Description
request google.cloud.osconfig.v1.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
undefined

deletePatchDeployment(request) → {Promise.<google.protobuf.Empty>}

Calls DeletePatchDeployment.

Parameters:
Name Type Description
request google.cloud.osconfig.v1.IDeletePatchDeploymentRequest

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

Promise

executePatchJob(request, callback) → {undefined}

Calls ExecutePatchJob.

Parameters:
Name Type 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
undefined

executePatchJob(request) → {Promise.<google.cloud.osconfig.v1.PatchJob>}

Calls ExecutePatchJob.

Parameters:
Name Type 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) → {undefined}

Calls GetPatchDeployment.

Parameters:
Name Type Description
request google.cloud.osconfig.v1.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
undefined

getPatchDeployment(request) → {Promise.<google.cloud.osconfig.v1.PatchDeployment>}

Calls GetPatchDeployment.

Parameters:
Name Type Description
request google.cloud.osconfig.v1.IGetPatchDeploymentRequest

GetPatchDeploymentRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.osconfig.v1.PatchDeployment>

Promise

getPatchJob(request, callback) → {undefined}

Calls GetPatchJob.

Parameters:
Name Type 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
undefined

getPatchJob(request) → {Promise.<google.cloud.osconfig.v1.PatchJob>}

Calls GetPatchJob.

Parameters:
Name Type 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) → {undefined}

Calls ListPatchDeployments.

Parameters:
Name Type 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
undefined

listPatchDeployments(request) → {Promise.<google.cloud.osconfig.v1.ListPatchDeploymentsResponse>}

Calls ListPatchDeployments.

Parameters:
Name Type 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) → {undefined}

Calls ListPatchJobInstanceDetails.

Parameters:
Name Type 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
undefined

listPatchJobInstanceDetails(request) → {Promise.<google.cloud.osconfig.v1.ListPatchJobInstanceDetailsResponse>}

Calls ListPatchJobInstanceDetails.

Parameters:
Name Type 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) → {undefined}

Calls ListPatchJobs.

Parameters:
Name Type Description
request google.cloud.osconfig.v1.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
undefined

listPatchJobs(request) → {Promise.<google.cloud.osconfig.v1.ListPatchJobsResponse>}

Calls ListPatchJobs.

Parameters:
Name Type Description
request google.cloud.osconfig.v1.IListPatchJobsRequest

ListPatchJobsRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.osconfig.v1.ListPatchJobsResponse>

Promise

pausePatchDeployment(request, callback) → {undefined}

Calls PausePatchDeployment.

Parameters:
Name Type Description
request google.cloud.osconfig.v1.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
undefined

pausePatchDeployment(request) → {Promise.<google.cloud.osconfig.v1.PatchDeployment>}

Calls PausePatchDeployment.

Parameters:
Name Type Description
request google.cloud.osconfig.v1.IPausePatchDeploymentRequest

PausePatchDeploymentRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.osconfig.v1.PatchDeployment>

Promise

resumePatchDeployment(request, callback) → {undefined}

Calls ResumePatchDeployment.

Parameters:
Name Type 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
undefined

resumePatchDeployment(request) → {Promise.<google.cloud.osconfig.v1.PatchDeployment>}

Calls ResumePatchDeployment.

Parameters:
Name Type 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) → {undefined}

Calls UpdatePatchDeployment.

Parameters:
Name Type 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
undefined

updatePatchDeployment(request) → {Promise.<google.cloud.osconfig.v1.PatchDeployment>}

Calls UpdatePatchDeployment.

Parameters:
Name Type Description
request google.cloud.osconfig.v1.IUpdatePatchDeploymentRequest

UpdatePatchDeploymentRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.osconfig.v1.PatchDeployment>

Promise

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {OsConfigService}

Creates new OsConfigService service using the specified rpc implementation.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean <optional>
 false

Whether requests are length-delimited
responseDelimited boolean <optional>
 false

Whether responses are length-delimited
Returns:
Type Description
OsConfigService

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

Type Definitions

CancelPatchJobCallback(error, responseopt)

Callback as used by cancelPatchJob.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.osconfig.v1.PatchJob <optional>

PatchJob

CreatePatchDeploymentCallback(error, responseopt)

Callback as used by createPatchDeployment.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.osconfig.v1.PatchDeployment <optional>

PatchDeployment

DeletePatchDeploymentCallback(error, responseopt)

Callback as used by deletePatchDeployment.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.protobuf.Empty <optional>

Empty

ExecutePatchJobCallback(error, responseopt)

Callback as used by executePatchJob.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.osconfig.v1.PatchJob <optional>

PatchJob

GetPatchDeploymentCallback(error, responseopt)

Callback as used by getPatchDeployment.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.osconfig.v1.PatchDeployment <optional>

PatchDeployment

GetPatchJobCallback(error, responseopt)

Callback as used by getPatchJob.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.osconfig.v1.PatchJob <optional>

PatchJob

ListPatchDeploymentsCallback(error, responseopt)

Callback as used by listPatchDeployments.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.osconfig.v1.ListPatchDeploymentsResponse <optional>

ListPatchDeploymentsResponse

ListPatchJobInstanceDetailsCallback(error, responseopt)

Callback as used by listPatchJobInstanceDetails.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.osconfig.v1.ListPatchJobInstanceDetailsResponse <optional>

ListPatchJobInstanceDetailsResponse

ListPatchJobsCallback(error, responseopt)

Callback as used by listPatchJobs.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.osconfig.v1.ListPatchJobsResponse <optional>

ListPatchJobsResponse

PausePatchDeploymentCallback(error, responseopt)

Callback as used by pausePatchDeployment.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.osconfig.v1.PatchDeployment <optional>

PatchDeployment

ResumePatchDeploymentCallback(error, responseopt)

Callback as used by resumePatchDeployment.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.osconfig.v1.PatchDeployment <optional>

PatchDeployment

UpdatePatchDeploymentCallback(error, responseopt)

Callback as used by updatePatchDeployment.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.osconfig.v1.PatchDeployment <optional>

PatchDeployment