Constructor
new OsConfigServiceClient(optionsopt, gaxInstanceopt)
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
|
||||||||||||||||||||||||||||||||||||||||||||||||
gaxInstance |
gax |
<optional> |
loaded instance of |
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. |
getProjectId() → {Promise}
Return the project ID used by this class.
Returns:
Type | Description |
---|---|
Promise |
A promise that resolves to string containing the project ID. |
guestPolicyPath(project, guest_policy) → {string}
Return a fully-qualified guestPolicy resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
guest_policy |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
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. |
listGuestPoliciesAsync(request, optionsopt) → {Object}
Equivalent to listGuestPolicies
, 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
|
|||||||||||||
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 GuestPolicy. 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
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the parent using one of the following forms:
* `projects/{project_number}`.
*/
// const parent = 'abc123'
/**
* The maximum number of guest policies to return.
*/
// const pageSize = 1234
/**
* A pagination token returned from a previous call to `ListGuestPolicies`
* that indicates where this listing should continue from.
*/
// const pageToken = 'abc123'
// Imports the Osconfig library
const {OsConfigServiceClient} = require('@google-cloud/osconfig').v1beta;
// Instantiates a client
const osconfigClient = new OsConfigServiceClient();
async function callListGuestPolicies() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = await osconfigClient.listGuestPoliciesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListGuestPolicies();
listGuestPoliciesStream(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
|
|||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Stream |
An object stream which emits an object representing GuestPolicy 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(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
|
|||||||||||||||||
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
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the parent in the form `projects/*`.
*/
// const parent = 'abc123'
/**
* Optional. The maximum number of patch deployments to return. Default is 100.
*/
// const pageSize = 1234
/**
* Optional. A pagination token returned from a previous call to ListPatchDeployments
* that indicates where this listing should continue from.
*/
// const pageToken = 'abc123'
// Imports the Osconfig library
const {OsConfigServiceClient} = require('@google-cloud/osconfig').v1beta;
// Instantiates a client
const osconfigClient = new OsConfigServiceClient();
async function callListPatchDeployments() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = await osconfigClient.listPatchDeploymentsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListPatchDeployments();
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
|
|||||||||||||||||
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 |
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
|
||||||||||||||||
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
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent for the instances are in the form of `projects/* /patchJobs/*`.
*/
// const parent = 'abc123'
/**
* The maximum number of instance details records to return. Default is 100.
*/
// const pageSize = 1234
/**
* A pagination token returned from a previous call
* that indicates where this listing should continue from.
*/
// const pageToken = 'abc123'
/**
* A filter expression that filters results listed in the response. This
* field supports filtering results by instance zone, name, state, or
* `failure_reason`.
*/
// const filter = 'abc123'
// Imports the Osconfig library
const {OsConfigServiceClient} = require('@google-cloud/osconfig').v1beta;
// Instantiates a client
const osconfigClient = new OsConfigServiceClient();
async function callListPatchJobInstanceDetails() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = await osconfigClient.listPatchJobInstanceDetailsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListPatchJobInstanceDetails();
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
|
||||||||||||||||
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 |
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
|
||||||||||||||||
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
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. In the form of `projects/*`
*/
// const parent = 'abc123'
/**
* The maximum number of instance status to return.
*/
// const pageSize = 1234
/**
* A pagination token returned from a previous call
* that indicates where this listing should continue from.
*/
// const pageToken = 'abc123'
/**
* 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.
*/
// const filter = 'abc123'
// Imports the Osconfig library
const {OsConfigServiceClient} = require('@google-cloud/osconfig').v1beta;
// Instantiates a client
const osconfigClient = new OsConfigServiceClient();
async function callListPatchJobs() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = await osconfigClient.listPatchJobsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListPatchJobs();
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
|
||||||||||||||||
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 |
matchGuestPolicyFromGuestPolicyName(guestPolicyName) → {string}
Parse the guest_policy from GuestPolicy resource.
Parameters:
Name | Type | Description |
---|---|---|
guestPolicyName |
string |
A fully-qualified path representing GuestPolicy resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the guest_policy. |
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. |
matchProjectFromGuestPolicyName(guestPolicyName) → {string}
Parse the project from GuestPolicy resource.
Parameters:
Name | Type | Description |
---|---|---|
guestPolicyName |
string |
A fully-qualified path representing GuestPolicy 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. |
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. |