OsConfigService

google.cloud.osconfig.v1beta. 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.v1beta.ICancelPatchJobRequest

CancelPatchJobRequest message or plain object
callback google.cloud.osconfig.v1beta.OsConfigService.CancelPatchJobCallback

Node-style callback called with the error, if any, and PatchJob
Returns:
Type Description
undefined

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

Calls CancelPatchJob.

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

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

Promise

createGuestPolicy(request, callback) → {undefined}

Calls CreateGuestPolicy.

Parameters:
Name Type Description
request google.cloud.osconfig.v1beta.ICreateGuestPolicyRequest

CreateGuestPolicyRequest message or plain object
callback google.cloud.osconfig.v1beta.OsConfigService.CreateGuestPolicyCallback

Node-style callback called with the error, if any, and GuestPolicy
Returns:
Type Description
undefined

createGuestPolicy(request) → {Promise.<google.cloud.osconfig.v1beta.GuestPolicy>}

Calls CreateGuestPolicy.

Parameters:
Name Type Description
request google.cloud.osconfig.v1beta.ICreateGuestPolicyRequest

CreateGuestPolicyRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.osconfig.v1beta.GuestPolicy>

Promise

createPatchDeployment(request, callback) → {undefined}

Calls CreatePatchDeployment.

Parameters:
Name Type Description
request google.cloud.osconfig.v1beta.ICreatePatchDeploymentRequest

CreatePatchDeploymentRequest message or plain object
callback google.cloud.osconfig.v1beta.OsConfigService.CreatePatchDeploymentCallback

Node-style callback called with the error, if any, and PatchDeployment
Returns:
Type Description
undefined

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

Calls CreatePatchDeployment.

Parameters:
Name Type Description
request google.cloud.osconfig.v1beta.ICreatePatchDeploymentRequest

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

Promise

deleteGuestPolicy(request, callback) → {undefined}

Calls DeleteGuestPolicy.

Parameters:
Name Type Description
request google.cloud.osconfig.v1beta.IDeleteGuestPolicyRequest

DeleteGuestPolicyRequest message or plain object
callback google.cloud.osconfig.v1beta.OsConfigService.DeleteGuestPolicyCallback

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

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

Calls DeleteGuestPolicy.

Parameters:
Name Type Description
request google.cloud.osconfig.v1beta.IDeleteGuestPolicyRequest

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

Promise

deletePatchDeployment(request, callback) → {undefined}

Calls DeletePatchDeployment.

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

DeletePatchDeploymentRequest message or plain object
callback google.cloud.osconfig.v1beta.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.v1beta.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.v1beta.IExecutePatchJobRequest

ExecutePatchJobRequest message or plain object
callback google.cloud.osconfig.v1beta.OsConfigService.ExecutePatchJobCallback

Node-style callback called with the error, if any, and PatchJob
Returns:
Type Description
undefined

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

Calls ExecutePatchJob.

Parameters:
Name Type Description
request google.cloud.osconfig.v1beta.IExecutePatchJobRequest

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

Promise

getGuestPolicy(request, callback) → {undefined}

Calls GetGuestPolicy.

Parameters:
Name Type Description
request google.cloud.osconfig.v1beta.IGetGuestPolicyRequest

GetGuestPolicyRequest message or plain object
callback google.cloud.osconfig.v1beta.OsConfigService.GetGuestPolicyCallback

Node-style callback called with the error, if any, and GuestPolicy
Returns:
Type Description
undefined

getGuestPolicy(request) → {Promise.<google.cloud.osconfig.v1beta.GuestPolicy>}

Calls GetGuestPolicy.

Parameters:
Name Type Description
request google.cloud.osconfig.v1beta.IGetGuestPolicyRequest

GetGuestPolicyRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.osconfig.v1beta.GuestPolicy>

Promise

getPatchDeployment(request, callback) → {undefined}

Calls GetPatchDeployment.

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

GetPatchDeploymentRequest message or plain object
callback google.cloud.osconfig.v1beta.OsConfigService.GetPatchDeploymentCallback

Node-style callback called with the error, if any, and PatchDeployment
Returns:
Type Description
undefined

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

Calls GetPatchDeployment.

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

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

Promise

getPatchJob(request, callback) → {undefined}

Calls GetPatchJob.

Parameters:
Name Type Description
request google.cloud.osconfig.v1beta.IGetPatchJobRequest

GetPatchJobRequest message or plain object
callback google.cloud.osconfig.v1beta.OsConfigService.GetPatchJobCallback

Node-style callback called with the error, if any, and PatchJob
Returns:
Type Description
undefined

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

Calls GetPatchJob.

Parameters:
Name Type Description
request google.cloud.osconfig.v1beta.IGetPatchJobRequest

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

Promise

listGuestPolicies(request, callback) → {undefined}

Calls ListGuestPolicies.

Parameters:
Name Type Description
request google.cloud.osconfig.v1beta.IListGuestPoliciesRequest

ListGuestPoliciesRequest message or plain object
callback google.cloud.osconfig.v1beta.OsConfigService.ListGuestPoliciesCallback

Node-style callback called with the error, if any, and ListGuestPoliciesResponse
Returns:
Type Description
undefined

listGuestPolicies(request) → {Promise.<google.cloud.osconfig.v1beta.ListGuestPoliciesResponse>}

Calls ListGuestPolicies.

Parameters:
Name Type Description
request google.cloud.osconfig.v1beta.IListGuestPoliciesRequest

ListGuestPoliciesRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.osconfig.v1beta.ListGuestPoliciesResponse>

Promise

listPatchDeployments(request, callback) → {undefined}

Calls ListPatchDeployments.

Parameters:
Name Type Description
request google.cloud.osconfig.v1beta.IListPatchDeploymentsRequest

ListPatchDeploymentsRequest message or plain object
callback google.cloud.osconfig.v1beta.OsConfigService.ListPatchDeploymentsCallback

Node-style callback called with the error, if any, and ListPatchDeploymentsResponse
Returns:
Type Description
undefined

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

Calls ListPatchDeployments.

Parameters:
Name Type Description
request google.cloud.osconfig.v1beta.IListPatchDeploymentsRequest

ListPatchDeploymentsRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.osconfig.v1beta.ListPatchDeploymentsResponse>

Promise

listPatchJobInstanceDetails(request, callback) → {undefined}

Calls ListPatchJobInstanceDetails.

Parameters:
Name Type Description
request google.cloud.osconfig.v1beta.IListPatchJobInstanceDetailsRequest

ListPatchJobInstanceDetailsRequest message or plain object
callback google.cloud.osconfig.v1beta.OsConfigService.ListPatchJobInstanceDetailsCallback

Node-style callback called with the error, if any, and ListPatchJobInstanceDetailsResponse
Returns:
Type Description
undefined

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

Calls ListPatchJobInstanceDetails.

Parameters:
Name Type Description
request google.cloud.osconfig.v1beta.IListPatchJobInstanceDetailsRequest

ListPatchJobInstanceDetailsRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.osconfig.v1beta.ListPatchJobInstanceDetailsResponse>

Promise

listPatchJobs(request, callback) → {undefined}

Calls ListPatchJobs.

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

ListPatchJobsRequest message or plain object
callback google.cloud.osconfig.v1beta.OsConfigService.ListPatchJobsCallback

Node-style callback called with the error, if any, and ListPatchJobsResponse
Returns:
Type Description
undefined

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

Calls ListPatchJobs.

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

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

Promise

lookupEffectiveGuestPolicy(request, callback) → {undefined}

Calls LookupEffectiveGuestPolicy.

Parameters:
Name Type Description
request google.cloud.osconfig.v1beta.ILookupEffectiveGuestPolicyRequest

LookupEffectiveGuestPolicyRequest message or plain object
callback google.cloud.osconfig.v1beta.OsConfigService.LookupEffectiveGuestPolicyCallback

Node-style callback called with the error, if any, and EffectiveGuestPolicy
Returns:
Type Description
undefined

lookupEffectiveGuestPolicy(request) → {Promise.<google.cloud.osconfig.v1beta.EffectiveGuestPolicy>}

Calls LookupEffectiveGuestPolicy.

Parameters:
Name Type Description
request google.cloud.osconfig.v1beta.ILookupEffectiveGuestPolicyRequest

LookupEffectiveGuestPolicyRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.osconfig.v1beta.EffectiveGuestPolicy>

Promise

pausePatchDeployment(request, callback) → {undefined}

Calls PausePatchDeployment.

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

PausePatchDeploymentRequest message or plain object
callback google.cloud.osconfig.v1beta.OsConfigService.PausePatchDeploymentCallback

Node-style callback called with the error, if any, and PatchDeployment
Returns:
Type Description
undefined

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

Calls PausePatchDeployment.

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

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

Promise

resumePatchDeployment(request, callback) → {undefined}

Calls ResumePatchDeployment.

Parameters:
Name Type Description
request google.cloud.osconfig.v1beta.IResumePatchDeploymentRequest

ResumePatchDeploymentRequest message or plain object
callback google.cloud.osconfig.v1beta.OsConfigService.ResumePatchDeploymentCallback

Node-style callback called with the error, if any, and PatchDeployment
Returns:
Type Description
undefined

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

Calls ResumePatchDeployment.

Parameters:
Name Type Description
request google.cloud.osconfig.v1beta.IResumePatchDeploymentRequest

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

Promise

updateGuestPolicy(request, callback) → {undefined}

Calls UpdateGuestPolicy.

Parameters:
Name Type Description
request google.cloud.osconfig.v1beta.IUpdateGuestPolicyRequest

UpdateGuestPolicyRequest message or plain object
callback google.cloud.osconfig.v1beta.OsConfigService.UpdateGuestPolicyCallback

Node-style callback called with the error, if any, and GuestPolicy
Returns:
Type Description
undefined

updateGuestPolicy(request) → {Promise.<google.cloud.osconfig.v1beta.GuestPolicy>}

Calls UpdateGuestPolicy.

Parameters:
Name Type Description
request google.cloud.osconfig.v1beta.IUpdateGuestPolicyRequest

UpdateGuestPolicyRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.osconfig.v1beta.GuestPolicy>

Promise

updatePatchDeployment(request, callback) → {undefined}

Calls UpdatePatchDeployment.

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

UpdatePatchDeploymentRequest message or plain object
callback google.cloud.osconfig.v1beta.OsConfigService.UpdatePatchDeploymentCallback

Node-style callback called with the error, if any, and PatchDeployment
Returns:
Type Description
undefined

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

Calls UpdatePatchDeployment.

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

UpdatePatchDeploymentRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.osconfig.v1beta.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.v1beta.PatchJob <optional>

PatchJob

CreateGuestPolicyCallback(error, responseopt)

Callback as used by createGuestPolicy.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.osconfig.v1beta.GuestPolicy <optional>

GuestPolicy

CreatePatchDeploymentCallback(error, responseopt)

Callback as used by createPatchDeployment.

Parameters:
Name Type Attributes Description
error Error | null

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

PatchDeployment

DeleteGuestPolicyCallback(error, responseopt)

Callback as used by deleteGuestPolicy.

Parameters:
Name Type Attributes Description
error Error | null

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

Empty

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.v1beta.PatchJob <optional>

PatchJob

GetGuestPolicyCallback(error, responseopt)

Callback as used by getGuestPolicy.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.osconfig.v1beta.GuestPolicy <optional>

GuestPolicy

GetPatchDeploymentCallback(error, responseopt)

Callback as used by getPatchDeployment.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.osconfig.v1beta.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.v1beta.PatchJob <optional>

PatchJob

ListGuestPoliciesCallback(error, responseopt)

Callback as used by listGuestPolicies.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.osconfig.v1beta.ListGuestPoliciesResponse <optional>

ListGuestPoliciesResponse

ListPatchDeploymentsCallback(error, responseopt)

Callback as used by listPatchDeployments.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.osconfig.v1beta.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.v1beta.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.v1beta.ListPatchJobsResponse <optional>

ListPatchJobsResponse

LookupEffectiveGuestPolicyCallback(error, responseopt)

Callback as used by lookupEffectiveGuestPolicy.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.osconfig.v1beta.EffectiveGuestPolicy <optional>

EffectiveGuestPolicy

PausePatchDeploymentCallback(error, responseopt)

Callback as used by pausePatchDeployment.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.osconfig.v1beta.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.v1beta.PatchDeployment <optional>

PatchDeployment

UpdateGuestPolicyCallback(error, responseopt)

Callback as used by updateGuestPolicy.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.osconfig.v1beta.GuestPolicy <optional>

GuestPolicy

UpdatePatchDeploymentCallback(error, responseopt)

Callback as used by updatePatchDeployment.

Parameters:
Name Type Attributes Description
error Error | null

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

PatchDeployment