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

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

Credentials object.

Properties

Name	Type	Attributes	Description
`client_email`	string	<optional>
`private_key`	string	<optional>

email

string

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename

string

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

The port on which to connect to the remote host.

projectId

string

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

The domain name of the API remote host.

clientConfig

gax.ClientConfig

Client configuration override. Follows the structure of gapicConfig.

fallback

boolean

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

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.

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.v1.InventoryView

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

options

object

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);

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

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.

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.

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/-` For `{project}`, either `project-number` or `project-id` can be provided.
`view`	google.cloud.osconfig.v1.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

Call options. See CallOptions for more details.

Returns:

Type Description

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.

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/-` For `{project}`, either `project-number` or `project-id` can be provided.
`view`	google.cloud.osconfig.v1.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

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/-` For `{project}`, either `project-number` or `project-id` can be provided.
`view`	google.cloud.osconfig.v1.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

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.

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/-` For `{project}`, either `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 `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

Call options. See CallOptions for more details.

Returns:

Type Description

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.

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/-` For `{project}`, either `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 `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

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/-` For `{project}`, either `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 `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

Call options. See CallOptions for more details.

Returns:

Type Description

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.

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.

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.

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.

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.

matchPatchDeploymentFromPatchDeploymentName(patchDeploymentName) → {string}

Parse the patch_deployment from PatchDeployment resource.

Parameters:

Name	Type	Description
`patchDeploymentName`	string	A fully-qualified path representing PatchDeployment resource.

Returns:

Type	Description
string	A string representing the patch_deployment.

matchPatchJobFromPatchJobName(patchJobName) → {string}

Parse the patch_job from PatchJob resource.

Parameters:

Name	Type	Description
`patchJobName`	string	A fully-qualified path representing PatchJob resource.

Returns:

Type	Description
string	A string representing the patch_job.

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.

matchProjectFromPatchDeploymentName(patchDeploymentName) → {string}

Parse the project from PatchDeployment resource.

Parameters:

Name	Type	Description
`patchDeploymentName`	string	A fully-qualified path representing PatchDeployment resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromPatchJobName(patchJobName) → {string}

Parse the project from PatchJob resource.

Parameters:

Name	Type	Description
`patchJobName`	string	A fully-qualified path representing PatchJob 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.

patchDeploymentPath(project, patch_deployment) → {string}

Return a fully-qualified patchDeployment resource name string.

Parameters:

Name	Type	Description
`project`	string
`patch_deployment`	string

Returns:

Type	Description
string	Resource name string.

patchJobPath(project, patch_job) → {string}

Return a fully-qualified patchJob resource name string.

Parameters:

Name	Type	Description
`project`	string
`patch_job`	string

Returns:

Type	Description
string	Resource name string.

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.