OsConfigZonalServiceClient

OsConfigZonalServiceClient

Zonal OS Config API

The OS Config service is the server-side component that allows users to manage package installations and patch jobs for Compute Engine VM instances.

Constructor

new OsConfigZonalServiceClient(optionsopt)

Construct an instance of OsConfigZonalServiceClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.
keyFilename string <optional>

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.
port number <optional>

The port on which to connect to the remote host.
projectId string <optional>

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.
apiEndpoint string <optional>

The domain name of the API remote host.
clientConfig gax.ClientConfig <optional>

Client configuration override. Follows the structure of gapicConfig.
fallback boolean <optional>

Use HTTP fallback mode. In fallback mode, a special browser-compatible transport implementation is used instead of gRPC transport. In browser context (if the window object is defined) the fallback mode is enabled automatically; set options.fallback to false if you need to override this behavior.

Members

apiEndpoint

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

port

The port for this API service.

scopes

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

The DNS address for this API service.

Methods

(async) checkCreateOSPolicyAssignmentProgress(name) → {Promise}

Check the status of the long running operation returned by createOSPolicyAssignment().

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
Promise
  • The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example
const decodedOperation = await checkCreateOSPolicyAssignmentProgress(name);
console.log(decodedOperation.result);
console.log(decodedOperation.done);
console.log(decodedOperation.metadata);

(async) checkDeleteOSPolicyAssignmentProgress(name) → {Promise}

Check the status of the long running operation returned by deleteOSPolicyAssignment().

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
Promise
  • The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example
const decodedOperation = await checkDeleteOSPolicyAssignmentProgress(name);
console.log(decodedOperation.result);
console.log(decodedOperation.done);
console.log(decodedOperation.metadata);

(async) checkUpdateOSPolicyAssignmentProgress(name) → {Promise}

Check the status of the long running operation returned by updateOSPolicyAssignment().

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
Promise
  • The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example
const decodedOperation = await checkUpdateOSPolicyAssignmentProgress(name);
console.log(decodedOperation.result);
console.log(decodedOperation.done);
console.log(decodedOperation.metadata);

close() → {Promise}

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns:
Type Description
Promise

A promise that resolves when the client is closed.

createOSPolicyAssignment(request, optionsopt) → {Promise}

Create an OS policy assignment.

This method also creates the first revision of the OS policy assignment.

This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO.

For more information, see Method: projects.locations.osPolicyAssignments.operations.cancel.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The parent resource name in the form: projects/{project}/locations/{location}
osPolicyAssignment google.cloud.osconfig.v1alpha.OSPolicyAssignment

Required. The OS policy assignment to be created.
osPolicyAssignmentId string

Required. The logical name of the OS policy assignment in the project with the following restrictions:

  • Must contain only lowercase letters, numbers, and hyphens.
  • Must start with a letter.
  • Must be between 1-63 characters.
  • Must end with a number or a letter.
  • Must be unique within the project.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.
Example
const [operation] = await client.createOSPolicyAssignment(request);
const [response] = await operation.promise();

deleteOSPolicyAssignment(request, optionsopt) → {Promise}

Delete the OS policy assignment.

This method creates a new revision of the OS policy assignment.

This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO.

If the LRO completes and is not cancelled, all revisions associated with the OS policy assignment are deleted.

For more information, see Method: projects.locations.osPolicyAssignments.operations.cancel.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The name of the OS policy assignment to be deleted
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.
Example
const [operation] = await client.deleteOSPolicyAssignment(request);
const [response] = await operation.promise();

getInstanceOSPoliciesCompliance(request, optionsopt) → {Promise}

Get OS policies compliance data for the specified Compute Engine VM instance.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. API resource name for instance OS policies compliance resource.

Format: projects/{project}/locations/{location}/instanceOSPoliciesCompliances/{instance}

For {project}, either Compute Engine project-number or project-id can be provided. For {instance}, either Compute Engine VM instance-id or instance-name can be provided.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
Example
const [response] = await client.getInstanceOSPoliciesCompliance(request);

getInventory(request, optionsopt) → {Promise}

Get inventory data for the specified VM instance. If the VM has no associated inventory, the message NOT_FOUND is returned.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. API resource name for inventory resource.

Format: projects/{project}/locations/{location}/instances/{instance}/inventory

For {project}, either project-number or project-id can be provided. For {instance}, either Compute Engine instance-id or instance-name can be provided.
view google.cloud.osconfig.v1alpha.InventoryView

Inventory view indicating what information should be included in the inventory resource. If unspecified, the default view is BASIC.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Inventory. Please see the documentation for more details and examples.
Example
const [response] = await client.getInventory(request);

getOSPolicyAssignment(request, optionsopt) → {Promise}

Retrieve an existing OS policy assignment.

This method always returns the latest revision. In order to retrieve a previous revision of the assignment, also provide the revision ID in the name parameter.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The resource name of OS policy assignment.

Format: projects/{project}/locations/{location}/osPolicyAssignments/{os_policy_assignment}@{revisionId}
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing OSPolicyAssignment. Please see the documentation for more details and examples.
Example
const [response] = await client.getOSPolicyAssignment(request);

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:
Type Description
Promise

A promise that resolves to string containing the project ID.

getVulnerabilityReport(request, optionsopt) → {Promise}

Gets the vulnerability report for the specified VM instance. Only VMs with inventory data have vulnerability reports associated with them.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. API resource name for vulnerability resource.

Format: projects/{project}/locations/{location}/instances/{instance}/vulnerabilityReport

For {project}, either project-number or project-id can be provided. For {instance}, either Compute Engine instance-id or instance-name can be provided.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing VulnerabilityReport. Please see the documentation for more details and examples.
Example
const [response] = await client.getVulnerabilityReport(request);

initialize() → {Promise}

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns:
Type Description
Promise

A promise that resolves to an authenticated service stub.

instanceOSPoliciesCompliancePath(project, location, instance) → {string}

Return a fully-qualified instanceOSPoliciesCompliance resource name string.

Parameters:
Name Type Description
project string
location string
instance string
Returns:
Type Description
string

Resource name string.

inventoryPath(project, location, instance) → {string}

Return a fully-qualified inventory resource name string.

Parameters:
Name Type Description
project string
location string
instance string
Returns:
Type Description
string

Resource name string.

listInstanceOSPoliciesCompliances(request, optionsopt) → {Promise}

List OS policies compliance data for all Compute Engine VM instances in the specified zone.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The parent resource name.

Format: projects/{project}/locations/{location}

For {project}, either Compute Engine project-number or project-id can be provided.
pageSize number

The maximum number of results to return.
pageToken string

A pagination token returned from a previous call to ListInstanceOSPoliciesCompliances that indicates where this listing should continue from.
filter string

If provided, this field specifies the criteria that must be met by a InstanceOSPoliciesCompliance API resource to be included in the response.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is Array of InstanceOSPoliciesCompliance. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listInstanceOSPoliciesCompliancesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listInstanceOSPoliciesCompliancesAsync(request, optionsopt) → {Object}

Equivalent to listInstanceOSPoliciesCompliances, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The parent resource name.

Format: projects/{project}/locations/{location}

For {project}, either Compute Engine project-number or project-id can be provided.
pageSize number

The maximum number of results to return.
pageToken string

A pagination token returned from a previous call to ListInstanceOSPoliciesCompliances that indicates where this listing should continue from.
filter string

If provided, this field specifies the criteria that must be met by a InstanceOSPoliciesCompliance API resource to be included in the response.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing InstanceOSPoliciesCompliance. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example
const iterable = client.listInstanceOSPoliciesCompliancesAsync(request);
for await (const response of iterable) {
  // process response
}

listInstanceOSPoliciesCompliancesStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The parent resource name.

Format: projects/{project}/locations/{location}

For {project}, either Compute Engine project-number or project-id can be provided.
pageSize number

The maximum number of results to return.
pageToken string

A pagination token returned from a previous call to ListInstanceOSPoliciesCompliances that indicates where this listing should continue from.
filter string

If provided, this field specifies the criteria that must be met by a InstanceOSPoliciesCompliance API resource to be included in the response.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing InstanceOSPoliciesCompliance on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listInstanceOSPoliciesCompliancesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listInventories(request, optionsopt) → {Promise}

List inventory data for all VM instances in the specified zone.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The parent resource name.

Format: projects/{project}/locations/{location}/instances/{instance}

For {project}, either project-number or project-id can be provided. For {instance}, only hyphen or dash character is supported to list inventories across VMs.
view google.cloud.osconfig.v1alpha.InventoryView

Inventory view indicating what information should be included in the inventory resource. If unspecified, the default view is BASIC.
pageSize number

The maximum number of results to return.
pageToken string

A pagination token returned from a previous call to ListInventories that indicates where this listing should continue from.
filter string

If provided, this field specifies the criteria that must be met by a Inventory API resource to be included in the response.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is Array of Inventory. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listInventoriesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listInventoriesAsync(request, optionsopt) → {Object}

Equivalent to listInventories, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The parent resource name.

Format: projects/{project}/locations/{location}/instances/{instance}

For {project}, either project-number or project-id can be provided. For {instance}, only hyphen or dash character is supported to list inventories across VMs.
view google.cloud.osconfig.v1alpha.InventoryView

Inventory view indicating what information should be included in the inventory resource. If unspecified, the default view is BASIC.
pageSize number

The maximum number of results to return.
pageToken string

A pagination token returned from a previous call to ListInventories that indicates where this listing should continue from.
filter string

If provided, this field specifies the criteria that must be met by a Inventory API resource to be included in the response.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Inventory. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example
const iterable = client.listInventoriesAsync(request);
for await (const response of iterable) {
  // process response
}

listInventoriesStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The parent resource name.

Format: projects/{project}/locations/{location}/instances/{instance}

For {project}, either project-number or project-id can be provided. For {instance}, only hyphen or dash character is supported to list inventories across VMs.
view google.cloud.osconfig.v1alpha.InventoryView

Inventory view indicating what information should be included in the inventory resource. If unspecified, the default view is BASIC.
pageSize number

The maximum number of results to return.
pageToken string

A pagination token returned from a previous call to ListInventories that indicates where this listing should continue from.
filter string

If provided, this field specifies the criteria that must be met by a Inventory API resource to be included in the response.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing Inventory on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listInventoriesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listOSPolicyAssignmentRevisions(request, optionsopt) → {Promise}

List the OS policy assignment revisions for a given OS policy assignment.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The name of the OS policy assignment to list revisions for.
pageSize number

The maximum number of revisions to return.
pageToken string

A pagination token returned from a previous call to ListOSPolicyAssignmentRevisions that indicates where this listing should continue from.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is Array of OSPolicyAssignment. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listOSPolicyAssignmentRevisionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listOSPolicyAssignmentRevisionsAsync(request, optionsopt) → {Object}

Equivalent to listOSPolicyAssignmentRevisions, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The name of the OS policy assignment to list revisions for.
pageSize number

The maximum number of revisions to return.
pageToken string

A pagination token returned from a previous call to ListOSPolicyAssignmentRevisions that indicates where this listing should continue from.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing OSPolicyAssignment. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example
const iterable = client.listOSPolicyAssignmentRevisionsAsync(request);
for await (const response of iterable) {
  // process response
}

listOSPolicyAssignmentRevisionsStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The name of the OS policy assignment to list revisions for.
pageSize number

The maximum number of revisions to return.
pageToken string

A pagination token returned from a previous call to ListOSPolicyAssignmentRevisions that indicates where this listing should continue from.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing OSPolicyAssignment on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listOSPolicyAssignmentRevisionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listOSPolicyAssignments(request, optionsopt) → {Promise}

List the OS policy assignments under the parent resource.

For each OS policy assignment, the latest revision is returned.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The parent resource name.
pageSize number

The maximum number of assignments to return.
pageToken string

A pagination token returned from a previous call to ListOSPolicyAssignments that indicates where this listing should continue from.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is Array of OSPolicyAssignment. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listOSPolicyAssignmentsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listOSPolicyAssignmentsAsync(request, optionsopt) → {Object}

Equivalent to listOSPolicyAssignments, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The parent resource name.
pageSize number

The maximum number of assignments to return.
pageToken string

A pagination token returned from a previous call to ListOSPolicyAssignments that indicates where this listing should continue from.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing OSPolicyAssignment. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example
const iterable = client.listOSPolicyAssignmentsAsync(request);
for await (const response of iterable) {
  // process response
}

listOSPolicyAssignmentsStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The parent resource name.
pageSize number

The maximum number of assignments to return.
pageToken string

A pagination token returned from a previous call to ListOSPolicyAssignments that indicates where this listing should continue from.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing OSPolicyAssignment on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listOSPolicyAssignmentsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listVulnerabilityReports(request, optionsopt) → {Promise}

List vulnerability reports for all VM instances in the specified zone.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The parent resource name.

Format: projects/{project}/locations/{location}/instances/{instance}

For {project}, either project-number or project-id can be provided. For {instance}, only - character is supported to list vulnerability reports across VMs.
pageSize number

The maximum number of results to return.
pageToken string

A pagination token returned from a previous call to ListVulnerabilityReports that indicates where this listing should continue from.
filter string

If provided, this field specifies the criteria that must be met by a vulnerabilityReport API resource to be included in the response.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is Array of VulnerabilityReport. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listVulnerabilityReportsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listVulnerabilityReportsAsync(request, optionsopt) → {Object}

Equivalent to listVulnerabilityReports, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The parent resource name.

Format: projects/{project}/locations/{location}/instances/{instance}

For {project}, either project-number or project-id can be provided. For {instance}, only - character is supported to list vulnerability reports across VMs.
pageSize number

The maximum number of results to return.
pageToken string

A pagination token returned from a previous call to ListVulnerabilityReports that indicates where this listing should continue from.
filter string

If provided, this field specifies the criteria that must be met by a vulnerabilityReport API resource to be included in the response.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing VulnerabilityReport. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example
const iterable = client.listVulnerabilityReportsAsync(request);
for await (const response of iterable) {
  // process response
}

listVulnerabilityReportsStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The parent resource name.

Format: projects/{project}/locations/{location}/instances/{instance}

For {project}, either project-number or project-id can be provided. For {instance}, only - character is supported to list vulnerability reports across VMs.
pageSize number

The maximum number of results to return.
pageToken string

A pagination token returned from a previous call to ListVulnerabilityReports that indicates where this listing should continue from.
filter string

If provided, this field specifies the criteria that must be met by a vulnerabilityReport API resource to be included in the response.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing VulnerabilityReport on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listVulnerabilityReportsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

matchInstanceFromInstanceOSPoliciesComplianceName(instanceOSPoliciesComplianceName) → {string}

Parse the instance from InstanceOSPoliciesCompliance resource.

Parameters:
Name Type Description
instanceOSPoliciesComplianceName string

A fully-qualified path representing InstanceOSPoliciesCompliance resource.
Returns:
Type Description
string

A string representing the instance.

matchInstanceFromInventoryName(inventoryName) → {string}

Parse the instance from Inventory resource.

Parameters:
Name Type Description
inventoryName string

A fully-qualified path representing Inventory resource.
Returns:
Type Description
string

A string representing the instance.

matchInstanceFromVulnerabilityReportName(vulnerabilityReportName) → {string}

Parse the instance from VulnerabilityReport resource.

Parameters:
Name Type Description
vulnerabilityReportName string

A fully-qualified path representing VulnerabilityReport resource.
Returns:
Type Description
string

A string representing the instance.

matchLocationFromInstanceOSPoliciesComplianceName(instanceOSPoliciesComplianceName) → {string}

Parse the location from InstanceOSPoliciesCompliance resource.

Parameters:
Name Type Description
instanceOSPoliciesComplianceName string

A fully-qualified path representing InstanceOSPoliciesCompliance resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromInventoryName(inventoryName) → {string}

Parse the location from Inventory resource.

Parameters:
Name Type Description
inventoryName string

A fully-qualified path representing Inventory resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromOSPolicyAssignmentName(oSPolicyAssignmentName) → {string}

Parse the location from OSPolicyAssignment resource.

Parameters:
Name Type Description
oSPolicyAssignmentName string

A fully-qualified path representing OSPolicyAssignment resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromVulnerabilityReportName(vulnerabilityReportName) → {string}

Parse the location from VulnerabilityReport resource.

Parameters:
Name Type Description
vulnerabilityReportName string

A fully-qualified path representing VulnerabilityReport resource.
Returns:
Type Description
string

A string representing the location.

matchOsPolicyAssignmentFromOSPolicyAssignmentName(oSPolicyAssignmentName) → {string}

Parse the os_policy_assignment from OSPolicyAssignment resource.

Parameters:
Name Type Description
oSPolicyAssignmentName string

A fully-qualified path representing OSPolicyAssignment resource.
Returns:
Type Description
string

A string representing the os_policy_assignment.

matchProjectFromInstanceOSPoliciesComplianceName(instanceOSPoliciesComplianceName) → {string}

Parse the project from InstanceOSPoliciesCompliance resource.

Parameters:
Name Type Description
instanceOSPoliciesComplianceName string

A fully-qualified path representing InstanceOSPoliciesCompliance resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromInventoryName(inventoryName) → {string}

Parse the project from Inventory resource.

Parameters:
Name Type Description
inventoryName string

A fully-qualified path representing Inventory resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromOSPolicyAssignmentName(oSPolicyAssignmentName) → {string}

Parse the project from OSPolicyAssignment resource.

Parameters:
Name Type Description
oSPolicyAssignmentName string

A fully-qualified path representing OSPolicyAssignment resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromVulnerabilityReportName(vulnerabilityReportName) → {string}

Parse the project from VulnerabilityReport resource.

Parameters:
Name Type Description
vulnerabilityReportName string

A fully-qualified path representing VulnerabilityReport resource.
Returns:
Type Description
string

A string representing the project.

oSPolicyAssignmentPath(project, location, os_policy_assignment) → {string}

Return a fully-qualified oSPolicyAssignment resource name string.

Parameters:
Name Type Description
project string
location string
os_policy_assignment string
Returns:
Type Description
string

Resource name string.

updateOSPolicyAssignment(request, optionsopt) → {Promise}

Update an existing OS policy assignment.

This method creates a new revision of the OS policy assignment.

This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO.

For more information, see Method: projects.locations.osPolicyAssignments.operations.cancel.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
osPolicyAssignment google.cloud.osconfig.v1alpha.OSPolicyAssignment

Required. The updated OS policy assignment.
updateMask google.protobuf.FieldMask <optional>

Optional. Field mask that controls which fields of the assignment should be updated.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.
Example
const [operation] = await client.updateOSPolicyAssignment(request);
const [response] = await operation.promise();

vulnerabilityReportPath(project, location, instance) → {string}

Return a fully-qualified vulnerabilityReport resource name string.

Parameters:
Name Type Description
project string
location string
instance string
Returns:
Type Description
string

Resource name string.