OsConfigZonalService

google.cloud.osconfig.v1. OsConfigZonalService

Represents an OsConfigZonalService

Constructor

new OsConfigZonalService(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new OsConfigZonalService 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

createOSPolicyAssignment(request, callback) → {undefined}

Calls CreateOSPolicyAssignment.

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

CreateOSPolicyAssignmentRequest message or plain object

callback google.cloud.osconfig.v1.OsConfigZonalService.CreateOSPolicyAssignmentCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

createOSPolicyAssignment(request) → {Promise.<google.longrunning.Operation>}

Calls CreateOSPolicyAssignment.

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

CreateOSPolicyAssignmentRequest message or plain object

Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

deleteOSPolicyAssignment(request, callback) → {undefined}

Calls DeleteOSPolicyAssignment.

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

DeleteOSPolicyAssignmentRequest message or plain object

callback google.cloud.osconfig.v1.OsConfigZonalService.DeleteOSPolicyAssignmentCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

deleteOSPolicyAssignment(request) → {Promise.<google.longrunning.Operation>}

Calls DeleteOSPolicyAssignment.

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

DeleteOSPolicyAssignmentRequest message or plain object

Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

getInventory(request, callback) → {undefined}

Calls GetInventory.

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

GetInventoryRequest message or plain object

callback google.cloud.osconfig.v1.OsConfigZonalService.GetInventoryCallback

Node-style callback called with the error, if any, and Inventory

Returns:
Type Description
undefined

getInventory(request) → {Promise.<google.cloud.osconfig.v1.Inventory>}

Calls GetInventory.

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

GetInventoryRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.osconfig.v1.Inventory>

Promise

getOSPolicyAssignment(request, callback) → {undefined}

Calls GetOSPolicyAssignment.

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

GetOSPolicyAssignmentRequest message or plain object

callback google.cloud.osconfig.v1.OsConfigZonalService.GetOSPolicyAssignmentCallback

Node-style callback called with the error, if any, and OSPolicyAssignment

Returns:
Type Description
undefined

getOSPolicyAssignment(request) → {Promise.<google.cloud.osconfig.v1.OSPolicyAssignment>}

Calls GetOSPolicyAssignment.

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

GetOSPolicyAssignmentRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.osconfig.v1.OSPolicyAssignment>

Promise

getOSPolicyAssignmentReport(request, callback) → {undefined}

Calls GetOSPolicyAssignmentReport.

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

GetOSPolicyAssignmentReportRequest message or plain object

callback google.cloud.osconfig.v1.OsConfigZonalService.GetOSPolicyAssignmentReportCallback

Node-style callback called with the error, if any, and OSPolicyAssignmentReport

Returns:
Type Description
undefined

getOSPolicyAssignmentReport(request) → {Promise.<google.cloud.osconfig.v1.OSPolicyAssignmentReport>}

Calls GetOSPolicyAssignmentReport.

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

GetOSPolicyAssignmentReportRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.osconfig.v1.OSPolicyAssignmentReport>

Promise

getVulnerabilityReport(request, callback) → {undefined}

Calls GetVulnerabilityReport.

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

GetVulnerabilityReportRequest message or plain object

callback google.cloud.osconfig.v1.OsConfigZonalService.GetVulnerabilityReportCallback

Node-style callback called with the error, if any, and VulnerabilityReport

Returns:
Type Description
undefined

getVulnerabilityReport(request) → {Promise.<google.cloud.osconfig.v1.VulnerabilityReport>}

Calls GetVulnerabilityReport.

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

GetVulnerabilityReportRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.osconfig.v1.VulnerabilityReport>

Promise

listInventories(request, callback) → {undefined}

Calls ListInventories.

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

ListInventoriesRequest message or plain object

callback google.cloud.osconfig.v1.OsConfigZonalService.ListInventoriesCallback

Node-style callback called with the error, if any, and ListInventoriesResponse

Returns:
Type Description
undefined

listInventories(request) → {Promise.<google.cloud.osconfig.v1.ListInventoriesResponse>}

Calls ListInventories.

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

ListInventoriesRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.osconfig.v1.ListInventoriesResponse>

Promise

listOSPolicyAssignmentReports(request, callback) → {undefined}

Calls ListOSPolicyAssignmentReports.

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

ListOSPolicyAssignmentReportsRequest message or plain object

callback google.cloud.osconfig.v1.OsConfigZonalService.ListOSPolicyAssignmentReportsCallback

Node-style callback called with the error, if any, and ListOSPolicyAssignmentReportsResponse

Returns:
Type Description
undefined

listOSPolicyAssignmentReports(request) → {Promise.<google.cloud.osconfig.v1.ListOSPolicyAssignmentReportsResponse>}

Calls ListOSPolicyAssignmentReports.

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

ListOSPolicyAssignmentReportsRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.osconfig.v1.ListOSPolicyAssignmentReportsResponse>

Promise

listOSPolicyAssignmentRevisions(request, callback) → {undefined}

Calls ListOSPolicyAssignmentRevisions.

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

ListOSPolicyAssignmentRevisionsRequest message or plain object

callback google.cloud.osconfig.v1.OsConfigZonalService.ListOSPolicyAssignmentRevisionsCallback

Node-style callback called with the error, if any, and ListOSPolicyAssignmentRevisionsResponse

Returns:
Type Description
undefined

listOSPolicyAssignmentRevisions(request) → {Promise.<google.cloud.osconfig.v1.ListOSPolicyAssignmentRevisionsResponse>}

Calls ListOSPolicyAssignmentRevisions.

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

ListOSPolicyAssignmentRevisionsRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.osconfig.v1.ListOSPolicyAssignmentRevisionsResponse>

Promise

listOSPolicyAssignments(request, callback) → {undefined}

Calls ListOSPolicyAssignments.

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

ListOSPolicyAssignmentsRequest message or plain object

callback google.cloud.osconfig.v1.OsConfigZonalService.ListOSPolicyAssignmentsCallback

Node-style callback called with the error, if any, and ListOSPolicyAssignmentsResponse

Returns:
Type Description
undefined

listOSPolicyAssignments(request) → {Promise.<google.cloud.osconfig.v1.ListOSPolicyAssignmentsResponse>}

Calls ListOSPolicyAssignments.

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

ListOSPolicyAssignmentsRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.osconfig.v1.ListOSPolicyAssignmentsResponse>

Promise

listVulnerabilityReports(request, callback) → {undefined}

Calls ListVulnerabilityReports.

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

ListVulnerabilityReportsRequest message or plain object

callback google.cloud.osconfig.v1.OsConfigZonalService.ListVulnerabilityReportsCallback

Node-style callback called with the error, if any, and ListVulnerabilityReportsResponse

Returns:
Type Description
undefined

listVulnerabilityReports(request) → {Promise.<google.cloud.osconfig.v1.ListVulnerabilityReportsResponse>}

Calls ListVulnerabilityReports.

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

ListVulnerabilityReportsRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.osconfig.v1.ListVulnerabilityReportsResponse>

Promise

updateOSPolicyAssignment(request, callback) → {undefined}

Calls UpdateOSPolicyAssignment.

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

UpdateOSPolicyAssignmentRequest message or plain object

callback google.cloud.osconfig.v1.OsConfigZonalService.UpdateOSPolicyAssignmentCallback

Node-style callback called with the error, if any, and Operation

Returns:
Type Description
undefined

updateOSPolicyAssignment(request) → {Promise.<google.longrunning.Operation>}

Calls UpdateOSPolicyAssignment.

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

UpdateOSPolicyAssignmentRequest message or plain object

Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

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

Creates new OsConfigZonalService 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
OsConfigZonalService

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

Type Definitions

CreateOSPolicyAssignmentCallback(error, responseopt)

Callback as used by createOSPolicyAssignment.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation

DeleteOSPolicyAssignmentCallback(error, responseopt)

Callback as used by deleteOSPolicyAssignment.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation

GetInventoryCallback(error, responseopt)

Callback as used by getInventory.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.osconfig.v1.Inventory <optional>

Inventory

GetOSPolicyAssignmentCallback(error, responseopt)

Callback as used by getOSPolicyAssignment.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.osconfig.v1.OSPolicyAssignment <optional>

OSPolicyAssignment

GetOSPolicyAssignmentReportCallback(error, responseopt)

Callback as used by getOSPolicyAssignmentReport.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.osconfig.v1.OSPolicyAssignmentReport <optional>

OSPolicyAssignmentReport

GetVulnerabilityReportCallback(error, responseopt)

Callback as used by getVulnerabilityReport.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.osconfig.v1.VulnerabilityReport <optional>

VulnerabilityReport

ListInventoriesCallback(error, responseopt)

Callback as used by listInventories.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.osconfig.v1.ListInventoriesResponse <optional>

ListInventoriesResponse

ListOSPolicyAssignmentReportsCallback(error, responseopt)

Callback as used by listOSPolicyAssignmentReports.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.osconfig.v1.ListOSPolicyAssignmentReportsResponse <optional>

ListOSPolicyAssignmentReportsResponse

ListOSPolicyAssignmentRevisionsCallback(error, responseopt)

Callback as used by listOSPolicyAssignmentRevisions.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.osconfig.v1.ListOSPolicyAssignmentRevisionsResponse <optional>

ListOSPolicyAssignmentRevisionsResponse

ListOSPolicyAssignmentsCallback(error, responseopt)

Callback as used by listOSPolicyAssignments.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.osconfig.v1.ListOSPolicyAssignmentsResponse <optional>

ListOSPolicyAssignmentsResponse

ListVulnerabilityReportsCallback(error, responseopt)

Callback as used by listVulnerabilityReports.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.osconfig.v1.ListVulnerabilityReportsResponse <optional>

ListVulnerabilityReportsResponse

UpdateOSPolicyAssignmentCallback(error, responseopt)

Callback as used by updateOSPolicyAssignment.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation