OsConfigServiceClient

OsConfigServiceClient

OS Config API

The OS Config service is a server-side component that you can use to manage package installations and patch jobs for virtual machine instances.

Constructor

new OsConfigServiceClient(optionsopt)

Construct an instance of OsConfigServiceClient.

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

cancelPatchJob(request, optionsopt) → {Promise}

Cancel a patch job. The patch job must be active. Canceled patch jobs cannot be restarted.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. Name of the patch in the form projects/* /patchJobs/*
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 PatchJob. Please see the documentation for more details and examples.
Example
const [response] = await client.cancelPatchJob(request);

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.

createPatchDeployment(request, optionsopt) → {Promise}

Create an OS Config patch deployment.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The project to apply this patch deployment to in the form projects/*.
patchDeploymentId string

Required. A name for the patch deployment in the project. When creating a name the following rules apply:

  • 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.
patchDeployment google.cloud.osconfig.v1.PatchDeployment

Required. The patch deployment to create.
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 PatchDeployment. Please see the documentation for more details and examples.
Example
const [response] = await client.createPatchDeployment(request);

deletePatchDeployment(request, optionsopt) → {Promise}

Delete an OS Config patch deployment.

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 the patch deployment in the form projects/* /patchDeployments/*.
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 Empty. Please see the documentation for more details and examples.
Example
const [response] = await client.deletePatchDeployment(request);

executePatchJob(request, optionsopt) → {Promise}

Patch VM instances by creating and running a patch job.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The project in which to run this patch in the form projects/*
description string

Description of the patch job. Length of the description is limited to 1024 characters.
instanceFilter google.cloud.osconfig.v1.PatchInstanceFilter

Required. Instances to patch, either explicitly or filtered by some criteria such as zone or labels.
patchConfig google.cloud.osconfig.v1.PatchConfig

Patch configuration being applied. If omitted, instances are patched using the default configurations.
duration google.protobuf.Duration

Duration of the patch job. After the duration ends, the patch job times out.
dryRun boolean

If this patch is a dry-run only, instances are contacted but will do nothing.
displayName string

Display name for this patch job. This does not have to be unique.
rollout google.cloud.osconfig.v1.PatchRollout

Rollout strategy of the patch job.
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 PatchJob. Please see the documentation for more details and examples.
Example
const [response] = await client.executePatchJob(request);

getPatchDeployment(request, optionsopt) → {Promise}

Get an OS Config patch deployment.

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 the patch deployment in the form projects/* /patchDeployments/*.
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 PatchDeployment. Please see the documentation for more details and examples.
Example
const [response] = await client.getPatchDeployment(request);

getPatchJob(request, optionsopt) → {Promise}

Get the patch job. This can be used to track the progress of an ongoing patch job or review the details of completed jobs.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. Name of the patch in the form projects/* /patchJobs/*
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 PatchJob. Please see the documentation for more details and examples.
Example
const [response] = await client.getPatchJob(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.

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.

listPatchDeployments(request, optionsopt) → {Promise}

Get a page of OS Config patch deployments.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

Required. The resource name of the parent in the form projects/*.
pageSize number <optional>

Optional. The maximum number of patch deployments to return. Default is 100.
pageToken string <optional>

Optional. A pagination token returned from a previous call to ListPatchDeployments 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 PatchDeployment. 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 listPatchDeploymentsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listPatchDeploymentsAsync(request, optionsopt) → {Object}

Equivalent to listPatchDeployments, 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 Attributes Description
parent string

Required. The resource name of the parent in the form projects/*.
pageSize number <optional>

Optional. The maximum number of patch deployments to return. Default is 100.
pageToken string <optional>

Optional. A pagination token returned from a previous call to ListPatchDeployments 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 PatchDeployment. 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.listPatchDeploymentsAsync(request);
for await (const response of iterable) {
  // process response
}

listPatchDeploymentsStream(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 Attributes Description
parent string

Required. The resource name of the parent in the form projects/*.
pageSize number <optional>

Optional. The maximum number of patch deployments to return. Default is 100.
pageToken string <optional>

Optional. A pagination token returned from a previous call to ListPatchDeployments 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 PatchDeployment 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 listPatchDeploymentsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listPatchJobInstanceDetails(request, optionsopt) → {Promise}

Get a list of instance details for a given patch job.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The parent for the instances are in the form of projects/* /patchJobs/*.
pageSize number

The maximum number of instance details records to return. Default is 100.
pageToken string

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

A filter expression that filters results listed in the response. This field supports filtering results by instance zone, name, state, or failure_reason.
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 PatchJobInstanceDetails. 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 listPatchJobInstanceDetailsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listPatchJobInstanceDetailsAsync(request, optionsopt) → {Object}

Equivalent to listPatchJobInstanceDetails, 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 for the instances are in the form of projects/* /patchJobs/*.
pageSize number

The maximum number of instance details records to return. Default is 100.
pageToken string

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

A filter expression that filters results listed in the response. This field supports filtering results by instance zone, name, state, or failure_reason.
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 PatchJobInstanceDetails. 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.listPatchJobInstanceDetailsAsync(request);
for await (const response of iterable) {
  // process response
}

listPatchJobInstanceDetailsStream(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 for the instances are in the form of projects/* /patchJobs/*.
pageSize number

The maximum number of instance details records to return. Default is 100.
pageToken string

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

A filter expression that filters results listed in the response. This field supports filtering results by instance zone, name, state, or failure_reason.
options object <optional>

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

An object stream which emits an object representing PatchJobInstanceDetails 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 listPatchJobInstanceDetailsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listPatchJobs(request, optionsopt) → {Promise}

Get a list of patch jobs.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. In the form of projects/*
pageSize number

The maximum number of instance status to return.
pageToken string

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

If provided, this field specifies the criteria that must be met by patch jobs to be included in the response. Currently, filtering is only available on the patch_deployment field.
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 PatchJob. 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 listPatchJobsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listPatchJobsAsync(request, optionsopt) → {Object}

Equivalent to listPatchJobs, 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. In the form of projects/*
pageSize number

The maximum number of instance status to return.
pageToken string

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

If provided, this field specifies the criteria that must be met by patch jobs to be included in the response. Currently, filtering is only available on the patch_deployment field.
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 PatchJob. 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.listPatchJobsAsync(request);
for await (const response of iterable) {
  // process response
}

listPatchJobsStream(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. In the form of projects/*
pageSize number

The maximum number of instance status to return.
pageToken string

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

If provided, this field specifies the criteria that must be met by patch jobs to be included in the response. Currently, filtering is only available on the patch_deployment field.
options object <optional>

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

An object stream which emits an object representing PatchJob 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 listPatchJobsAsync() 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.