Class v1.OsConfigServiceClient (1.7.0)

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

Package

@google-cloud/os-config!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of OsConfigServiceClient.

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

osConfigServiceStub

osConfigServiceStub?: 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

cancelPatchJob(request, options)

cancelPatchJob(request?: protos.google.cloud.osconfig.v1.ICancelPatchJobRequest, options?: CallOptions): Promise<[protos.google.cloud.osconfig.v1.IPatchJob, protos.google.cloud.osconfig.v1.ICancelPatchJobRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.osconfig.v1.ICancelPatchJobRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.osconfig.v1.IPatchJob, protos.google.cloud.osconfig.v1.ICancelPatchJobRequest | undefined, {} | undefined]>

cancelPatchJob(request, options, callback)

cancelPatchJob(request: protos.google.cloud.osconfig.v1.ICancelPatchJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.osconfig.v1.IPatchJob, protos.google.cloud.osconfig.v1.ICancelPatchJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1.ICancelPatchJobRequest
options CallOptions
callback Callback<protos.google.cloud.osconfig.v1.IPatchJob, protos.google.cloud.osconfig.v1.ICancelPatchJobRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

cancelPatchJob(request, callback)

cancelPatchJob(request: protos.google.cloud.osconfig.v1.ICancelPatchJobRequest, callback: Callback<protos.google.cloud.osconfig.v1.IPatchJob, protos.google.cloud.osconfig.v1.ICancelPatchJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1.ICancelPatchJobRequest
callback Callback<protos.google.cloud.osconfig.v1.IPatchJob, protos.google.cloud.osconfig.v1.ICancelPatchJobRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

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.

createPatchDeployment(request, options)

createPatchDeployment(request?: protos.google.cloud.osconfig.v1.ICreatePatchDeploymentRequest, options?: CallOptions): Promise<[protos.google.cloud.osconfig.v1.IPatchDeployment, protos.google.cloud.osconfig.v1.ICreatePatchDeploymentRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.osconfig.v1.ICreatePatchDeploymentRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.osconfig.v1.IPatchDeployment, protos.google.cloud.osconfig.v1.ICreatePatchDeploymentRequest | undefined, {} | undefined]>

createPatchDeployment(request, options, callback)

createPatchDeployment(request: protos.google.cloud.osconfig.v1.ICreatePatchDeploymentRequest, options: CallOptions, callback: Callback<protos.google.cloud.osconfig.v1.IPatchDeployment, protos.google.cloud.osconfig.v1.ICreatePatchDeploymentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1.ICreatePatchDeploymentRequest
options CallOptions
callback Callback<protos.google.cloud.osconfig.v1.IPatchDeployment, protos.google.cloud.osconfig.v1.ICreatePatchDeploymentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createPatchDeployment(request, callback)

createPatchDeployment(request: protos.google.cloud.osconfig.v1.ICreatePatchDeploymentRequest, callback: Callback<protos.google.cloud.osconfig.v1.IPatchDeployment, protos.google.cloud.osconfig.v1.ICreatePatchDeploymentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1.ICreatePatchDeploymentRequest
callback Callback<protos.google.cloud.osconfig.v1.IPatchDeployment, protos.google.cloud.osconfig.v1.ICreatePatchDeploymentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deletePatchDeployment(request, options)

deletePatchDeployment(request?: protos.google.cloud.osconfig.v1.IDeletePatchDeploymentRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.osconfig.v1.IDeletePatchDeploymentRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.osconfig.v1.IDeletePatchDeploymentRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.osconfig.v1.IDeletePatchDeploymentRequest | undefined, {} | undefined]>

deletePatchDeployment(request, options, callback)

deletePatchDeployment(request: protos.google.cloud.osconfig.v1.IDeletePatchDeploymentRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.osconfig.v1.IDeletePatchDeploymentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1.IDeletePatchDeploymentRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.osconfig.v1.IDeletePatchDeploymentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deletePatchDeployment(request, callback)

deletePatchDeployment(request: protos.google.cloud.osconfig.v1.IDeletePatchDeploymentRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.osconfig.v1.IDeletePatchDeploymentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1.IDeletePatchDeploymentRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.osconfig.v1.IDeletePatchDeploymentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

executePatchJob(request, options)

executePatchJob(request?: protos.google.cloud.osconfig.v1.IExecutePatchJobRequest, options?: CallOptions): Promise<[protos.google.cloud.osconfig.v1.IPatchJob, protos.google.cloud.osconfig.v1.IExecutePatchJobRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.osconfig.v1.IExecutePatchJobRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.osconfig.v1.IPatchJob, protos.google.cloud.osconfig.v1.IExecutePatchJobRequest | undefined, {} | undefined]>

executePatchJob(request, options, callback)

executePatchJob(request: protos.google.cloud.osconfig.v1.IExecutePatchJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.osconfig.v1.IPatchJob, protos.google.cloud.osconfig.v1.IExecutePatchJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1.IExecutePatchJobRequest
options CallOptions
callback Callback<protos.google.cloud.osconfig.v1.IPatchJob, protos.google.cloud.osconfig.v1.IExecutePatchJobRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

executePatchJob(request, callback)

executePatchJob(request: protos.google.cloud.osconfig.v1.IExecutePatchJobRequest, callback: Callback<protos.google.cloud.osconfig.v1.IPatchJob, protos.google.cloud.osconfig.v1.IExecutePatchJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1.IExecutePatchJobRequest
callback Callback<protos.google.cloud.osconfig.v1.IPatchJob, protos.google.cloud.osconfig.v1.IExecutePatchJobRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getPatchDeployment(request, options)

getPatchDeployment(request?: protos.google.cloud.osconfig.v1.IGetPatchDeploymentRequest, options?: CallOptions): Promise<[protos.google.cloud.osconfig.v1.IPatchDeployment, protos.google.cloud.osconfig.v1.IGetPatchDeploymentRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.osconfig.v1.IGetPatchDeploymentRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.osconfig.v1.IPatchDeployment, protos.google.cloud.osconfig.v1.IGetPatchDeploymentRequest | undefined, {} | undefined]>

getPatchDeployment(request, options, callback)

getPatchDeployment(request: protos.google.cloud.osconfig.v1.IGetPatchDeploymentRequest, options: CallOptions, callback: Callback<protos.google.cloud.osconfig.v1.IPatchDeployment, protos.google.cloud.osconfig.v1.IGetPatchDeploymentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1.IGetPatchDeploymentRequest
options CallOptions
callback Callback<protos.google.cloud.osconfig.v1.IPatchDeployment, protos.google.cloud.osconfig.v1.IGetPatchDeploymentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getPatchDeployment(request, callback)

getPatchDeployment(request: protos.google.cloud.osconfig.v1.IGetPatchDeploymentRequest, callback: Callback<protos.google.cloud.osconfig.v1.IPatchDeployment, protos.google.cloud.osconfig.v1.IGetPatchDeploymentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1.IGetPatchDeploymentRequest
callback Callback<protos.google.cloud.osconfig.v1.IPatchDeployment, protos.google.cloud.osconfig.v1.IGetPatchDeploymentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getPatchJob(request, options)

getPatchJob(request?: protos.google.cloud.osconfig.v1.IGetPatchJobRequest, options?: CallOptions): Promise<[protos.google.cloud.osconfig.v1.IPatchJob, protos.google.cloud.osconfig.v1.IGetPatchJobRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.cloud.osconfig.v1.IGetPatchJobRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.osconfig.v1.IPatchJob, protos.google.cloud.osconfig.v1.IGetPatchJobRequest | undefined, {} | undefined]>

getPatchJob(request, options, callback)

getPatchJob(request: protos.google.cloud.osconfig.v1.IGetPatchJobRequest, options: CallOptions, callback: Callback<protos.google.cloud.osconfig.v1.IPatchJob, protos.google.cloud.osconfig.v1.IGetPatchJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1.IGetPatchJobRequest
options CallOptions
callback Callback<protos.google.cloud.osconfig.v1.IPatchJob, protos.google.cloud.osconfig.v1.IGetPatchJobRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getPatchJob(request, callback)

getPatchJob(request: protos.google.cloud.osconfig.v1.IGetPatchJobRequest, callback: Callback<protos.google.cloud.osconfig.v1.IPatchJob, protos.google.cloud.osconfig.v1.IGetPatchJobRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1.IGetPatchJobRequest
callback Callback<protos.google.cloud.osconfig.v1.IPatchJob, protos.google.cloud.osconfig.v1.IGetPatchJobRequest | 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

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.

listPatchDeployments(request, options)

listPatchDeployments(request?: protos.google.cloud.osconfig.v1.IListPatchDeploymentsRequest, options?: CallOptions): Promise<[protos.google.cloud.osconfig.v1.IPatchDeployment[], protos.google.cloud.osconfig.v1.IListPatchDeploymentsRequest | null, protos.google.cloud.osconfig.v1.IListPatchDeploymentsResponse]>;
Parameters
Name Description
request protos.google.cloud.osconfig.v1.IListPatchDeploymentsRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.osconfig.v1.IPatchDeployment[], protos.google.cloud.osconfig.v1.IListPatchDeploymentsRequest | null, protos.google.cloud.osconfig.v1.IListPatchDeploymentsResponse]>

listPatchDeployments(request, options, callback)

listPatchDeployments(request: protos.google.cloud.osconfig.v1.IListPatchDeploymentsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.osconfig.v1.IListPatchDeploymentsRequest, protos.google.cloud.osconfig.v1.IListPatchDeploymentsResponse | null | undefined, protos.google.cloud.osconfig.v1.IPatchDeployment>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1.IListPatchDeploymentsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.osconfig.v1.IListPatchDeploymentsRequest, protos.google.cloud.osconfig.v1.IListPatchDeploymentsResponse | null | undefined, protos.google.cloud.osconfig.v1.IPatchDeployment>
Returns
Type Description
void

listPatchDeployments(request, callback)

listPatchDeployments(request: protos.google.cloud.osconfig.v1.IListPatchDeploymentsRequest, callback: PaginationCallback<protos.google.cloud.osconfig.v1.IListPatchDeploymentsRequest, protos.google.cloud.osconfig.v1.IListPatchDeploymentsResponse | null | undefined, protos.google.cloud.osconfig.v1.IPatchDeployment>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1.IListPatchDeploymentsRequest
callback PaginationCallback<protos.google.cloud.osconfig.v1.IListPatchDeploymentsRequest, protos.google.cloud.osconfig.v1.IListPatchDeploymentsResponse | null | undefined, protos.google.cloud.osconfig.v1.IPatchDeployment>
Returns
Type Description
void

listPatchDeploymentsAsync(request, options)

listPatchDeploymentsAsync(request?: protos.google.cloud.osconfig.v1.IListPatchDeploymentsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.osconfig.v1.IPatchDeployment>;

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 Description
request protos.google.cloud.osconfig.v1.IListPatchDeploymentsRequest

The request object that will be sent.
options CallOptions

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

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

listPatchDeploymentsStream(request, options)

listPatchDeploymentsStream(request?: protos.google.cloud.osconfig.v1.IListPatchDeploymentsRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request protos.google.cloud.osconfig.v1.IListPatchDeploymentsRequest

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

listPatchJobInstanceDetails(request, options)

listPatchJobInstanceDetails(request?: protos.google.cloud.osconfig.v1.IListPatchJobInstanceDetailsRequest, options?: CallOptions): Promise<[protos.google.cloud.osconfig.v1.IPatchJobInstanceDetails[], protos.google.cloud.osconfig.v1.IListPatchJobInstanceDetailsRequest | null, protos.google.cloud.osconfig.v1.IListPatchJobInstanceDetailsResponse]>;
Parameters
Name Description
request protos.google.cloud.osconfig.v1.IListPatchJobInstanceDetailsRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.osconfig.v1.IPatchJobInstanceDetails[], protos.google.cloud.osconfig.v1.IListPatchJobInstanceDetailsRequest | null, protos.google.cloud.osconfig.v1.IListPatchJobInstanceDetailsResponse]>

listPatchJobInstanceDetails(request, options, callback)

listPatchJobInstanceDetails(request: protos.google.cloud.osconfig.v1.IListPatchJobInstanceDetailsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.osconfig.v1.IListPatchJobInstanceDetailsRequest, protos.google.cloud.osconfig.v1.IListPatchJobInstanceDetailsResponse | null | undefined, protos.google.cloud.osconfig.v1.IPatchJobInstanceDetails>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1.IListPatchJobInstanceDetailsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.osconfig.v1.IListPatchJobInstanceDetailsRequest, protos.google.cloud.osconfig.v1.IListPatchJobInstanceDetailsResponse | null | undefined, protos.google.cloud.osconfig.v1.IPatchJobInstanceDetails>
Returns
Type Description
void

listPatchJobInstanceDetails(request, callback)

listPatchJobInstanceDetails(request: protos.google.cloud.osconfig.v1.IListPatchJobInstanceDetailsRequest, callback: PaginationCallback<protos.google.cloud.osconfig.v1.IListPatchJobInstanceDetailsRequest, protos.google.cloud.osconfig.v1.IListPatchJobInstanceDetailsResponse | null | undefined, protos.google.cloud.osconfig.v1.IPatchJobInstanceDetails>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1.IListPatchJobInstanceDetailsRequest
callback PaginationCallback<protos.google.cloud.osconfig.v1.IListPatchJobInstanceDetailsRequest, protos.google.cloud.osconfig.v1.IListPatchJobInstanceDetailsResponse | null | undefined, protos.google.cloud.osconfig.v1.IPatchJobInstanceDetails>
Returns
Type Description
void

listPatchJobInstanceDetailsAsync(request, options)

listPatchJobInstanceDetailsAsync(request?: protos.google.cloud.osconfig.v1.IListPatchJobInstanceDetailsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.osconfig.v1.IPatchJobInstanceDetails>;

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 Description
request protos.google.cloud.osconfig.v1.IListPatchJobInstanceDetailsRequest

The request object that will be sent.
options CallOptions

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

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

listPatchJobInstanceDetailsStream(request, options)

listPatchJobInstanceDetailsStream(request?: protos.google.cloud.osconfig.v1.IListPatchJobInstanceDetailsRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request protos.google.cloud.osconfig.v1.IListPatchJobInstanceDetailsRequest

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

listPatchJobs(request, options)

listPatchJobs(request?: protos.google.cloud.osconfig.v1.IListPatchJobsRequest, options?: CallOptions): Promise<[protos.google.cloud.osconfig.v1.IPatchJob[], protos.google.cloud.osconfig.v1.IListPatchJobsRequest | null, protos.google.cloud.osconfig.v1.IListPatchJobsResponse]>;
Parameters
Name Description
request protos.google.cloud.osconfig.v1.IListPatchJobsRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.cloud.osconfig.v1.IPatchJob[], protos.google.cloud.osconfig.v1.IListPatchJobsRequest | null, protos.google.cloud.osconfig.v1.IListPatchJobsResponse]>

listPatchJobs(request, options, callback)

listPatchJobs(request: protos.google.cloud.osconfig.v1.IListPatchJobsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.osconfig.v1.IListPatchJobsRequest, protos.google.cloud.osconfig.v1.IListPatchJobsResponse | null | undefined, protos.google.cloud.osconfig.v1.IPatchJob>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1.IListPatchJobsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.osconfig.v1.IListPatchJobsRequest, protos.google.cloud.osconfig.v1.IListPatchJobsResponse | null | undefined, protos.google.cloud.osconfig.v1.IPatchJob>
Returns
Type Description
void

listPatchJobs(request, callback)

listPatchJobs(request: protos.google.cloud.osconfig.v1.IListPatchJobsRequest, callback: PaginationCallback<protos.google.cloud.osconfig.v1.IListPatchJobsRequest, protos.google.cloud.osconfig.v1.IListPatchJobsResponse | null | undefined, protos.google.cloud.osconfig.v1.IPatchJob>): void;
Parameters
Name Description
request protos.google.cloud.osconfig.v1.IListPatchJobsRequest
callback PaginationCallback<protos.google.cloud.osconfig.v1.IListPatchJobsRequest, protos.google.cloud.osconfig.v1.IListPatchJobsResponse | null | undefined, protos.google.cloud.osconfig.v1.IPatchJob>
Returns
Type Description
void

listPatchJobsAsync(request, options)

listPatchJobsAsync(request?: protos.google.cloud.osconfig.v1.IListPatchJobsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.osconfig.v1.IPatchJob>;

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 Description
request protos.google.cloud.osconfig.v1.IListPatchJobsRequest

The request object that will be sent.
options CallOptions

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

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

listPatchJobsStream(request, options)

listPatchJobsStream(request?: protos.google.cloud.osconfig.v1.IListPatchJobsRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request protos.google.cloud.osconfig.v1.IListPatchJobsRequest

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

matchPatchDeploymentFromPatchDeploymentName(patchDeploymentName)

matchPatchDeploymentFromPatchDeploymentName(patchDeploymentName: string): string | number;

Parse the patch_deployment from PatchDeployment resource.

Parameter
Name Description
patchDeploymentName string

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

{string} A string representing the patch_deployment.

matchPatchJobFromPatchJobName(patchJobName)

matchPatchJobFromPatchJobName(patchJobName: string): string | number;

Parse the patch_job from PatchJob resource.

Parameter
Name Description
patchJobName string

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

{string} A string representing the patch_job.

matchProjectFromPatchDeploymentName(patchDeploymentName)

matchProjectFromPatchDeploymentName(patchDeploymentName: string): string | number;

Parse the project from PatchDeployment resource.

Parameter
Name Description
patchDeploymentName string

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

{string} A string representing the project.

matchProjectFromPatchJobName(patchJobName)

matchProjectFromPatchJobName(patchJobName: string): string | number;

Parse the project from PatchJob resource.

Parameter
Name Description
patchJobName string

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

{string} A string representing the project.

patchDeploymentPath(project, patchDeployment)

patchDeploymentPath(project: string, patchDeployment: string): string;

Return a fully-qualified patchDeployment resource name string.

Parameters
Name Description
project string
patchDeployment string
Returns
Type Description
string

{string} Resource name string.

patchJobPath(project, patchJob)

patchJobPath(project: string, patchJob: string): string;

Return a fully-qualified patchJob resource name string.

Parameters
Name Description
project string
patchJob string
Returns
Type Description
string

{string} Resource name string.