Class v1alpha.OsConfigZonalServiceClient (1.6.6)

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. v1alpha

Package

@google-cloud/os-config!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of OsConfigZonalServiceClient.

Parameter
Name Description
opts ClientOptions

Properties

apiEndpoint

static get apiEndpoint(): string;

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

Property Value
Type Description
string

auth

auth: gax.GoogleAuth;
Property Value
Type Description
gax.GoogleAuth

descriptors

descriptors: Descriptors;
Property Value
Type Description
Descriptors

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };
Property Value
Type Description
{ [name: string]: Function; }

operationsClient

operationsClient: gax.OperationsClient;
Property Value
Type Description
gax.OperationsClient

osConfigZonalServiceStub

osConfigZonalServiceStub?: Promise<{
        [name: string]: Function;
    }>;
Property Value
Type Description
Promise<{ [name: string]: Function; }>

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };
Property Value
Type Description
{ [name: string]: gax.PathTemplate; }

port

static get port(): number;

The port for this API service.

Property Value
Type Description
number

scopes

static get scopes(): string[];

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

Property Value
Type Description
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value
Type Description
string

warn

warn: (code: string, message: string, warnType?: string) => void;
Property Value
Type Description
(code: string, message: string, warnType?: string) => void

Methods

checkCreateOSPolicyAssignmentProgress(name)

checkCreateOSPolicyAssignmentProgress(name: string): Promise<LROperation<protos.google.cloud.osconfig.v1alpha.OSPolicyAssignment, protos.google.cloud.osconfig.v1alpha.OSPolicyAssignmentOperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.osconfig.v1alpha.OSPolicyAssignment, protos.google.cloud.osconfig.v1alpha.OSPolicyAssignmentOperationMetadata>>

{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkDeleteOSPolicyAssignmentProgress(name)

checkDeleteOSPolicyAssignmentProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.osconfig.v1alpha.OSPolicyAssignmentOperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.osconfig.v1alpha.OSPolicyAssignmentOperationMetadata>>

{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkUpdateOSPolicyAssignmentProgress(name)

checkUpdateOSPolicyAssignmentProgress(name: string): Promise<LROperation<protos.google.cloud.osconfig.v1alpha.OSPolicyAssignment, protos.google.cloud.osconfig.v1alpha.OSPolicyAssignmentOperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.osconfig.v1alpha.OSPolicyAssignment, protos.google.cloud.osconfig.v1alpha.OSPolicyAssignmentOperationMetadata>>

{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

close()

close(): Promise<void>;

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<void>

{Promise} A promise that resolves when the client is closed.

createOSPolicyAssignment(request, options)

createOSPolicyAssignment(request?: protos.google.cloud.osconfig.v1alpha.ICreateOSPolicyAssignmentRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignment, protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignmentOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.ICreateOSPolicyAssignmentRequest
options CallOptions
Returns
Type Description
Promise<[LROperation<protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignment, protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignmentOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

createOSPolicyAssignment(request, options, callback)

createOSPolicyAssignment(request: protos.google.cloud.osconfig.v1alpha.ICreateOSPolicyAssignmentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignment, protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignmentOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.ICreateOSPolicyAssignmentRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignment, protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignmentOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createOSPolicyAssignment(request, callback)

createOSPolicyAssignment(request: protos.google.cloud.osconfig.v1alpha.ICreateOSPolicyAssignmentRequest, callback: Callback<LROperation<protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignment, protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignmentOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.ICreateOSPolicyAssignmentRequest
callback Callback<LROperation<protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignment, protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignmentOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteOSPolicyAssignment(request, options)

deleteOSPolicyAssignment(request?: protos.google.cloud.osconfig.v1alpha.IDeleteOSPolicyAssignmentRequest, options?: CallOptions): Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignmentOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.IDeleteOSPolicyAssignmentRequest
options CallOptions
Returns
Type Description
Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignmentOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

deleteOSPolicyAssignment(request, options, callback)

deleteOSPolicyAssignment(request: protos.google.cloud.osconfig.v1alpha.IDeleteOSPolicyAssignmentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignmentOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.IDeleteOSPolicyAssignmentRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignmentOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteOSPolicyAssignment(request, callback)

deleteOSPolicyAssignment(request: protos.google.cloud.osconfig.v1alpha.IDeleteOSPolicyAssignmentRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignmentOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.IDeleteOSPolicyAssignmentRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignmentOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

getInstanceOSPoliciesCompliance(request, options)

getInstanceOSPoliciesCompliance(request?: protos.google.cloud.osconfig.v1alpha.IGetInstanceOSPoliciesComplianceRequest, options?: CallOptions): Promise<[protos.google.cloud.osconfig.v1alpha.IInstanceOSPoliciesCompliance, (protos.google.cloud.osconfig.v1alpha.IGetInstanceOSPoliciesComplianceRequest | undefined), {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.IGetInstanceOSPoliciesComplianceRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.osconfig.v1alpha.IInstanceOSPoliciesCompliance, (protos.google.cloud.osconfig.v1alpha.IGetInstanceOSPoliciesComplianceRequest | undefined), {} | undefined]>

getInstanceOSPoliciesCompliance(request, options, callback)

getInstanceOSPoliciesCompliance(request: protos.google.cloud.osconfig.v1alpha.IGetInstanceOSPoliciesComplianceRequest, options: CallOptions, callback: Callback<protos.google.cloud.osconfig.v1alpha.IInstanceOSPoliciesCompliance, protos.google.cloud.osconfig.v1alpha.IGetInstanceOSPoliciesComplianceRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.IGetInstanceOSPoliciesComplianceRequest
options CallOptions
callback Callback<protos.google.cloud.osconfig.v1alpha.IInstanceOSPoliciesCompliance, protos.google.cloud.osconfig.v1alpha.IGetInstanceOSPoliciesComplianceRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getInstanceOSPoliciesCompliance(request, callback)

getInstanceOSPoliciesCompliance(request: protos.google.cloud.osconfig.v1alpha.IGetInstanceOSPoliciesComplianceRequest, callback: Callback<protos.google.cloud.osconfig.v1alpha.IInstanceOSPoliciesCompliance, protos.google.cloud.osconfig.v1alpha.IGetInstanceOSPoliciesComplianceRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.IGetInstanceOSPoliciesComplianceRequest
callback Callback<protos.google.cloud.osconfig.v1alpha.IInstanceOSPoliciesCompliance, protos.google.cloud.osconfig.v1alpha.IGetInstanceOSPoliciesComplianceRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getInventory(request, options)

getInventory(request?: protos.google.cloud.osconfig.v1alpha.IGetInventoryRequest, options?: CallOptions): Promise<[protos.google.cloud.osconfig.v1alpha.IInventory, protos.google.cloud.osconfig.v1alpha.IGetInventoryRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.IGetInventoryRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.osconfig.v1alpha.IInventory, protos.google.cloud.osconfig.v1alpha.IGetInventoryRequest | undefined, {} | undefined]>

getInventory(request, options, callback)

getInventory(request: protos.google.cloud.osconfig.v1alpha.IGetInventoryRequest, options: CallOptions, callback: Callback<protos.google.cloud.osconfig.v1alpha.IInventory, protos.google.cloud.osconfig.v1alpha.IGetInventoryRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.IGetInventoryRequest
options CallOptions
callback Callback<protos.google.cloud.osconfig.v1alpha.IInventory, protos.google.cloud.osconfig.v1alpha.IGetInventoryRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getInventory(request, callback)

getInventory(request: protos.google.cloud.osconfig.v1alpha.IGetInventoryRequest, callback: Callback<protos.google.cloud.osconfig.v1alpha.IInventory, protos.google.cloud.osconfig.v1alpha.IGetInventoryRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.IGetInventoryRequest
callback Callback<protos.google.cloud.osconfig.v1alpha.IInventory, protos.google.cloud.osconfig.v1alpha.IGetInventoryRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getOSPolicyAssignment(request, options)

getOSPolicyAssignment(request?: protos.google.cloud.osconfig.v1alpha.IGetOSPolicyAssignmentRequest, options?: CallOptions): Promise<[protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignment, (protos.google.cloud.osconfig.v1alpha.IGetOSPolicyAssignmentRequest | undefined), {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.IGetOSPolicyAssignmentRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignment, (protos.google.cloud.osconfig.v1alpha.IGetOSPolicyAssignmentRequest | undefined), {} | undefined]>

getOSPolicyAssignment(request, options, callback)

getOSPolicyAssignment(request: protos.google.cloud.osconfig.v1alpha.IGetOSPolicyAssignmentRequest, options: CallOptions, callback: Callback<protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignment, protos.google.cloud.osconfig.v1alpha.IGetOSPolicyAssignmentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.IGetOSPolicyAssignmentRequest
options CallOptions
callback Callback<protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignment, protos.google.cloud.osconfig.v1alpha.IGetOSPolicyAssignmentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getOSPolicyAssignment(request, callback)

getOSPolicyAssignment(request: protos.google.cloud.osconfig.v1alpha.IGetOSPolicyAssignmentRequest, callback: Callback<protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignment, protos.google.cloud.osconfig.v1alpha.IGetOSPolicyAssignmentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.IGetOSPolicyAssignmentRequest
callback Callback<protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignment, protos.google.cloud.osconfig.v1alpha.IGetOSPolicyAssignmentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getProjectId()

getProjectId(): Promise<string>;
Returns
Type Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Name Description
callback Callback<string, undefined, undefined>
Returns
Type Description
void

getVulnerabilityReport(request, options)

getVulnerabilityReport(request?: protos.google.cloud.osconfig.v1alpha.IGetVulnerabilityReportRequest, options?: CallOptions): Promise<[protos.google.cloud.osconfig.v1alpha.IVulnerabilityReport, (protos.google.cloud.osconfig.v1alpha.IGetVulnerabilityReportRequest | undefined), {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.IGetVulnerabilityReportRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.osconfig.v1alpha.IVulnerabilityReport, (protos.google.cloud.osconfig.v1alpha.IGetVulnerabilityReportRequest | undefined), {} | undefined]>

getVulnerabilityReport(request, options, callback)

getVulnerabilityReport(request: protos.google.cloud.osconfig.v1alpha.IGetVulnerabilityReportRequest, options: CallOptions, callback: Callback<protos.google.cloud.osconfig.v1alpha.IVulnerabilityReport, protos.google.cloud.osconfig.v1alpha.IGetVulnerabilityReportRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.IGetVulnerabilityReportRequest
options CallOptions
callback Callback<protos.google.cloud.osconfig.v1alpha.IVulnerabilityReport, protos.google.cloud.osconfig.v1alpha.IGetVulnerabilityReportRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getVulnerabilityReport(request, callback)

getVulnerabilityReport(request: protos.google.cloud.osconfig.v1alpha.IGetVulnerabilityReportRequest, callback: Callback<protos.google.cloud.osconfig.v1alpha.IVulnerabilityReport, protos.google.cloud.osconfig.v1alpha.IGetVulnerabilityReportRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.IGetVulnerabilityReportRequest
callback Callback<protos.google.cloud.osconfig.v1alpha.IVulnerabilityReport, protos.google.cloud.osconfig.v1alpha.IGetVulnerabilityReportRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

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<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

instanceOSPoliciesCompliancePath(project, location, instance)

instanceOSPoliciesCompliancePath(project: string, location: string, instance: string): string;

Return a fully-qualified instanceOSPoliciesCompliance resource name string.

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

{string} Resource name string.

inventoryPath(project, location, instance)

inventoryPath(project: string, location: string, instance: string): string;

Return a fully-qualified inventory resource name string.

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

{string} Resource name string.

listInstanceOSPoliciesCompliances(request, options)

listInstanceOSPoliciesCompliances(request?: protos.google.cloud.osconfig.v1alpha.IListInstanceOSPoliciesCompliancesRequest, options?: CallOptions): Promise<[protos.google.cloud.osconfig.v1alpha.IInstanceOSPoliciesCompliance[], protos.google.cloud.osconfig.v1alpha.IListInstanceOSPoliciesCompliancesRequest | null, protos.google.cloud.osconfig.v1alpha.IListInstanceOSPoliciesCompliancesResponse]>;
Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.IListInstanceOSPoliciesCompliancesRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.osconfig.v1alpha.IInstanceOSPoliciesCompliance[], protos.google.cloud.osconfig.v1alpha.IListInstanceOSPoliciesCompliancesRequest | null, protos.google.cloud.osconfig.v1alpha.IListInstanceOSPoliciesCompliancesResponse]>

listInstanceOSPoliciesCompliances(request, options, callback)

listInstanceOSPoliciesCompliances(request: protos.google.cloud.osconfig.v1alpha.IListInstanceOSPoliciesCompliancesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.osconfig.v1alpha.IListInstanceOSPoliciesCompliancesRequest, protos.google.cloud.osconfig.v1alpha.IListInstanceOSPoliciesCompliancesResponse | null | undefined, protos.google.cloud.osconfig.v1alpha.IInstanceOSPoliciesCompliance>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.IListInstanceOSPoliciesCompliancesRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.osconfig.v1alpha.IListInstanceOSPoliciesCompliancesRequest, protos.google.cloud.osconfig.v1alpha.IListInstanceOSPoliciesCompliancesResponse | null | undefined, protos.google.cloud.osconfig.v1alpha.IInstanceOSPoliciesCompliance>
Returns
Type Description
void

listInstanceOSPoliciesCompliances(request, callback)

listInstanceOSPoliciesCompliances(request: protos.google.cloud.osconfig.v1alpha.IListInstanceOSPoliciesCompliancesRequest, callback: PaginationCallback<protos.google.cloud.osconfig.v1alpha.IListInstanceOSPoliciesCompliancesRequest, protos.google.cloud.osconfig.v1alpha.IListInstanceOSPoliciesCompliancesResponse | null | undefined, protos.google.cloud.osconfig.v1alpha.IInstanceOSPoliciesCompliance>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.IListInstanceOSPoliciesCompliancesRequest
callback PaginationCallback<protos.google.cloud.osconfig.v1alpha.IListInstanceOSPoliciesCompliancesRequest, protos.google.cloud.osconfig.v1alpha.IListInstanceOSPoliciesCompliancesResponse | null | undefined, protos.google.cloud.osconfig.v1alpha.IInstanceOSPoliciesCompliance>
Returns
Type Description
void

listInstanceOSPoliciesCompliancesAsync(request, options)

listInstanceOSPoliciesCompliancesAsync(request?: protos.google.cloud.osconfig.v1alpha.IListInstanceOSPoliciesCompliancesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.osconfig.v1alpha.IInstanceOSPoliciesCompliance>;

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 Description
request protos.google.cloud.osconfig.v1alpha.IListInstanceOSPoliciesCompliancesRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.osconfig.v1alpha.IInstanceOSPoliciesCompliance>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listInstanceOSPoliciesCompliancesStream(request, options)

listInstanceOSPoliciesCompliancesStream(request?: protos.google.cloud.osconfig.v1alpha.IListInstanceOSPoliciesCompliancesRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.IListInstanceOSPoliciesCompliancesRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listInventories(request, options)

listInventories(request?: protos.google.cloud.osconfig.v1alpha.IListInventoriesRequest, options?: CallOptions): Promise<[protos.google.cloud.osconfig.v1alpha.IInventory[], protos.google.cloud.osconfig.v1alpha.IListInventoriesRequest | null, protos.google.cloud.osconfig.v1alpha.IListInventoriesResponse]>;
Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.IListInventoriesRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.osconfig.v1alpha.IInventory[], protos.google.cloud.osconfig.v1alpha.IListInventoriesRequest | null, protos.google.cloud.osconfig.v1alpha.IListInventoriesResponse]>

listInventories(request, options, callback)

listInventories(request: protos.google.cloud.osconfig.v1alpha.IListInventoriesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.osconfig.v1alpha.IListInventoriesRequest, protos.google.cloud.osconfig.v1alpha.IListInventoriesResponse | null | undefined, protos.google.cloud.osconfig.v1alpha.IInventory>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.IListInventoriesRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.osconfig.v1alpha.IListInventoriesRequest, protos.google.cloud.osconfig.v1alpha.IListInventoriesResponse | null | undefined, protos.google.cloud.osconfig.v1alpha.IInventory>
Returns
Type Description
void

listInventories(request, callback)

listInventories(request: protos.google.cloud.osconfig.v1alpha.IListInventoriesRequest, callback: PaginationCallback<protos.google.cloud.osconfig.v1alpha.IListInventoriesRequest, protos.google.cloud.osconfig.v1alpha.IListInventoriesResponse | null | undefined, protos.google.cloud.osconfig.v1alpha.IInventory>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.IListInventoriesRequest
callback PaginationCallback<protos.google.cloud.osconfig.v1alpha.IListInventoriesRequest, protos.google.cloud.osconfig.v1alpha.IListInventoriesResponse | null | undefined, protos.google.cloud.osconfig.v1alpha.IInventory>
Returns
Type Description
void

listInventoriesAsync(request, options)

listInventoriesAsync(request?: protos.google.cloud.osconfig.v1alpha.IListInventoriesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.osconfig.v1alpha.IInventory>;

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 Description
request protos.google.cloud.osconfig.v1alpha.IListInventoriesRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.osconfig.v1alpha.IInventory>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listInventoriesStream(request, options)

listInventoriesStream(request?: protos.google.cloud.osconfig.v1alpha.IListInventoriesRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.IListInventoriesRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listOSPolicyAssignmentRevisions(request, options)

listOSPolicyAssignmentRevisions(request?: protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentRevisionsRequest, options?: CallOptions): Promise<[protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignment[], protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentRevisionsRequest | null, protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentRevisionsResponse]>;
Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentRevisionsRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignment[], protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentRevisionsRequest | null, protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentRevisionsResponse]>

listOSPolicyAssignmentRevisions(request, options, callback)

listOSPolicyAssignmentRevisions(request: protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentRevisionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentRevisionsRequest, protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentRevisionsResponse | null | undefined, protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignment>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentRevisionsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentRevisionsRequest, protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentRevisionsResponse | null | undefined, protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignment>
Returns
Type Description
void

listOSPolicyAssignmentRevisions(request, callback)

listOSPolicyAssignmentRevisions(request: protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentRevisionsRequest, callback: PaginationCallback<protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentRevisionsRequest, protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentRevisionsResponse | null | undefined, protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignment>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentRevisionsRequest
callback PaginationCallback<protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentRevisionsRequest, protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentRevisionsResponse | null | undefined, protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignment>
Returns
Type Description
void

listOSPolicyAssignmentRevisionsAsync(request, options)

listOSPolicyAssignmentRevisionsAsync(request?: protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentRevisionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignment>;

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 Description
request protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentRevisionsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignment>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listOSPolicyAssignmentRevisionsStream(request, options)

listOSPolicyAssignmentRevisionsStream(request?: protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentRevisionsRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentRevisionsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listOSPolicyAssignments(request, options)

listOSPolicyAssignments(request?: protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentsRequest, options?: CallOptions): Promise<[protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignment[], protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentsRequest | null, protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentsResponse]>;
Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentsRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignment[], protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentsRequest | null, protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentsResponse]>

listOSPolicyAssignments(request, options, callback)

listOSPolicyAssignments(request: protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentsRequest, protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentsResponse | null | undefined, protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignment>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentsRequest, protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentsResponse | null | undefined, protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignment>
Returns
Type Description
void

listOSPolicyAssignments(request, callback)

listOSPolicyAssignments(request: protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentsRequest, callback: PaginationCallback<protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentsRequest, protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentsResponse | null | undefined, protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignment>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentsRequest
callback PaginationCallback<protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentsRequest, protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentsResponse | null | undefined, protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignment>
Returns
Type Description
void

listOSPolicyAssignmentsAsync(request, options)

listOSPolicyAssignmentsAsync(request?: protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignment>;

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 Description
request protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignment>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listOSPolicyAssignmentsStream(request, options)

listOSPolicyAssignmentsStream(request?: protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentsRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.IListOSPolicyAssignmentsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listVulnerabilityReports(request, options)

listVulnerabilityReports(request?: protos.google.cloud.osconfig.v1alpha.IListVulnerabilityReportsRequest, options?: CallOptions): Promise<[protos.google.cloud.osconfig.v1alpha.IVulnerabilityReport[], protos.google.cloud.osconfig.v1alpha.IListVulnerabilityReportsRequest | null, protos.google.cloud.osconfig.v1alpha.IListVulnerabilityReportsResponse]>;
Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.IListVulnerabilityReportsRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.osconfig.v1alpha.IVulnerabilityReport[], protos.google.cloud.osconfig.v1alpha.IListVulnerabilityReportsRequest | null, protos.google.cloud.osconfig.v1alpha.IListVulnerabilityReportsResponse]>

listVulnerabilityReports(request, options, callback)

listVulnerabilityReports(request: protos.google.cloud.osconfig.v1alpha.IListVulnerabilityReportsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.osconfig.v1alpha.IListVulnerabilityReportsRequest, protos.google.cloud.osconfig.v1alpha.IListVulnerabilityReportsResponse | null | undefined, protos.google.cloud.osconfig.v1alpha.IVulnerabilityReport>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.IListVulnerabilityReportsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.osconfig.v1alpha.IListVulnerabilityReportsRequest, protos.google.cloud.osconfig.v1alpha.IListVulnerabilityReportsResponse | null | undefined, protos.google.cloud.osconfig.v1alpha.IVulnerabilityReport>
Returns
Type Description
void

listVulnerabilityReports(request, callback)

listVulnerabilityReports(request: protos.google.cloud.osconfig.v1alpha.IListVulnerabilityReportsRequest, callback: PaginationCallback<protos.google.cloud.osconfig.v1alpha.IListVulnerabilityReportsRequest, protos.google.cloud.osconfig.v1alpha.IListVulnerabilityReportsResponse | null | undefined, protos.google.cloud.osconfig.v1alpha.IVulnerabilityReport>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.IListVulnerabilityReportsRequest
callback PaginationCallback<protos.google.cloud.osconfig.v1alpha.IListVulnerabilityReportsRequest, protos.google.cloud.osconfig.v1alpha.IListVulnerabilityReportsResponse | null | undefined, protos.google.cloud.osconfig.v1alpha.IVulnerabilityReport>
Returns
Type Description
void

listVulnerabilityReportsAsync(request, options)

listVulnerabilityReportsAsync(request?: protos.google.cloud.osconfig.v1alpha.IListVulnerabilityReportsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.osconfig.v1alpha.IVulnerabilityReport>;

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 Description
request protos.google.cloud.osconfig.v1alpha.IListVulnerabilityReportsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.osconfig.v1alpha.IVulnerabilityReport>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listVulnerabilityReportsStream(request, options)

listVulnerabilityReportsStream(request?: protos.google.cloud.osconfig.v1alpha.IListVulnerabilityReportsRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.IListVulnerabilityReportsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

matchInstanceFromInstanceOSPoliciesComplianceName(instanceOSPoliciesComplianceName)

matchInstanceFromInstanceOSPoliciesComplianceName(instanceOSPoliciesComplianceName: string): string | number;

Parse the instance from InstanceOSPoliciesCompliance resource.

Parameter
Name Description
instanceOSPoliciesComplianceName string

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

{string} A string representing the instance.

matchInstanceFromInventoryName(inventoryName)

matchInstanceFromInventoryName(inventoryName: string): string | number;

Parse the instance from Inventory resource.

Parameter
Name Description
inventoryName string

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

{string} A string representing the instance.

matchInstanceFromVulnerabilityReportName(vulnerabilityReportName)

matchInstanceFromVulnerabilityReportName(vulnerabilityReportName: string): string | number;

Parse the instance from VulnerabilityReport resource.

Parameter
Name Description
vulnerabilityReportName string

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

{string} A string representing the instance.

matchLocationFromInstanceOSPoliciesComplianceName(instanceOSPoliciesComplianceName)

matchLocationFromInstanceOSPoliciesComplianceName(instanceOSPoliciesComplianceName: string): string | number;

Parse the location from InstanceOSPoliciesCompliance resource.

Parameter
Name Description
instanceOSPoliciesComplianceName string

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

{string} A string representing the location.

matchLocationFromInventoryName(inventoryName)

matchLocationFromInventoryName(inventoryName: string): string | number;

Parse the location from Inventory resource.

Parameter
Name Description
inventoryName string

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

{string} A string representing the location.

matchLocationFromOSPolicyAssignmentName(oSPolicyAssignmentName)

matchLocationFromOSPolicyAssignmentName(oSPolicyAssignmentName: string): string | number;

Parse the location from OSPolicyAssignment resource.

Parameter
Name Description
oSPolicyAssignmentName string

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

{string} A string representing the location.

matchLocationFromVulnerabilityReportName(vulnerabilityReportName)

matchLocationFromVulnerabilityReportName(vulnerabilityReportName: string): string | number;

Parse the location from VulnerabilityReport resource.

Parameter
Name Description
vulnerabilityReportName string

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

{string} A string representing the location.

matchOsPolicyAssignmentFromOSPolicyAssignmentName(oSPolicyAssignmentName)

matchOsPolicyAssignmentFromOSPolicyAssignmentName(oSPolicyAssignmentName: string): string | number;

Parse the os_policy_assignment from OSPolicyAssignment resource.

Parameter
Name Description
oSPolicyAssignmentName string

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

{string} A string representing the os_policy_assignment.

matchProjectFromInstanceOSPoliciesComplianceName(instanceOSPoliciesComplianceName)

matchProjectFromInstanceOSPoliciesComplianceName(instanceOSPoliciesComplianceName: string): string | number;

Parse the project from InstanceOSPoliciesCompliance resource.

Parameter
Name Description
instanceOSPoliciesComplianceName string

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

{string} A string representing the project.

matchProjectFromInventoryName(inventoryName)

matchProjectFromInventoryName(inventoryName: string): string | number;

Parse the project from Inventory resource.

Parameter
Name Description
inventoryName string

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

{string} A string representing the project.

matchProjectFromOSPolicyAssignmentName(oSPolicyAssignmentName)

matchProjectFromOSPolicyAssignmentName(oSPolicyAssignmentName: string): string | number;

Parse the project from OSPolicyAssignment resource.

Parameter
Name Description
oSPolicyAssignmentName string

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

{string} A string representing the project.

matchProjectFromVulnerabilityReportName(vulnerabilityReportName)

matchProjectFromVulnerabilityReportName(vulnerabilityReportName: string): string | number;

Parse the project from VulnerabilityReport resource.

Parameter
Name Description
vulnerabilityReportName string

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

{string} A string representing the project.

oSPolicyAssignmentPath(project, location, osPolicyAssignment)

oSPolicyAssignmentPath(project: string, location: string, osPolicyAssignment: string): string;

Return a fully-qualified oSPolicyAssignment resource name string.

Parameters
Name Description
project string
location string
osPolicyAssignment string
Returns
Type Description
string

{string} Resource name string.

updateOSPolicyAssignment(request, options)

updateOSPolicyAssignment(request?: protos.google.cloud.osconfig.v1alpha.IUpdateOSPolicyAssignmentRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignment, protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignmentOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.IUpdateOSPolicyAssignmentRequest
options CallOptions
Returns
Type Description
Promise<[LROperation<protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignment, protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignmentOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

updateOSPolicyAssignment(request, options, callback)

updateOSPolicyAssignment(request: protos.google.cloud.osconfig.v1alpha.IUpdateOSPolicyAssignmentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignment, protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignmentOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.IUpdateOSPolicyAssignmentRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignment, protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignmentOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateOSPolicyAssignment(request, callback)

updateOSPolicyAssignment(request: protos.google.cloud.osconfig.v1alpha.IUpdateOSPolicyAssignmentRequest, callback: Callback<LROperation<protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignment, protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignmentOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1alpha.IUpdateOSPolicyAssignmentRequest
callback Callback<LROperation<protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignment, protos.google.cloud.osconfig.v1alpha.IOSPolicyAssignmentOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

vulnerabilityReportPath(project, location, instance)

vulnerabilityReportPath(project: string, location: string, instance: string): string;

Return a fully-qualified vulnerabilityReport resource name string.

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

{string} Resource name string.