Class protos.google.cloud.osconfig.v1beta.OsConfigService (2.2.2)

Version latest

• 2.2.2 (latest)
• 2.2.1
• 2.1.2
• 1.12.1
• 1.11.0
• 1.10.0
• 1.9.1
• 1.8.0
• 1.7.0
• 1.6.6

Represents an OsConfigService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.osconfig.v1beta.OsConfigService

Package

@google-cloud/os-config

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new OsConfigService service.

Parameters
Name	Description
rpcImpl	$protobuf.RPCImpl RPC implementation
requestDelimited	boolean Whether requests are length-delimited
responseDelimited	boolean Whether responses are length-delimited

Methods

cancelPatchJob(request, callback)

public cancelPatchJob(request: google.cloud.osconfig.v1beta.ICancelPatchJobRequest, callback: google.cloud.osconfig.v1beta.OsConfigService.CancelPatchJobCallback): void;

Calls CancelPatchJob.

Parameters
Name	Description
request	ICancelPatchJobRequest CancelPatchJobRequest message or plain object
callback	google.cloud.osconfig.v1beta.OsConfigService.CancelPatchJobCallback Node-style callback called with the error, if any, and PatchJob

Returns
Type	Description
void

cancelPatchJob(request)

public cancelPatchJob(request: google.cloud.osconfig.v1beta.ICancelPatchJobRequest): Promise<google.cloud.osconfig.v1beta.PatchJob>;

Calls CancelPatchJob.

Parameter
Name	Description
request	ICancelPatchJobRequest CancelPatchJobRequest message or plain object

Returns
Type	Description
Promise<google.cloud.osconfig.v1beta.PatchJob>	Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): OsConfigService;

Creates new OsConfigService service using the specified rpc implementation.

Parameters
Name	Description
rpcImpl	$protobuf.RPCImpl RPC implementation
requestDelimited	boolean Whether requests are length-delimited
responseDelimited	boolean Whether responses are length-delimited

Returns
Type	Description
OsConfigService	RPC service. Useful where requests and/or responses are streamed.

createGuestPolicy(request, callback)

public createGuestPolicy(request: google.cloud.osconfig.v1beta.ICreateGuestPolicyRequest, callback: google.cloud.osconfig.v1beta.OsConfigService.CreateGuestPolicyCallback): void;

Calls CreateGuestPolicy.

Parameters
Name	Description
request	ICreateGuestPolicyRequest CreateGuestPolicyRequest message or plain object
callback	google.cloud.osconfig.v1beta.OsConfigService.CreateGuestPolicyCallback Node-style callback called with the error, if any, and GuestPolicy

Returns
Type	Description
void

createGuestPolicy(request)

public createGuestPolicy(request: google.cloud.osconfig.v1beta.ICreateGuestPolicyRequest): Promise<google.cloud.osconfig.v1beta.GuestPolicy>;

Calls CreateGuestPolicy.

Parameter
Name	Description
request	ICreateGuestPolicyRequest CreateGuestPolicyRequest message or plain object

Returns
Type	Description
Promise<google.cloud.osconfig.v1beta.GuestPolicy>	Promise

createPatchDeployment(request, callback)

public createPatchDeployment(request: google.cloud.osconfig.v1beta.ICreatePatchDeploymentRequest, callback: google.cloud.osconfig.v1beta.OsConfigService.CreatePatchDeploymentCallback): void;

Calls CreatePatchDeployment.

Parameters
Name	Description
request	google.cloud.osconfig.v1beta.ICreatePatchDeploymentRequest CreatePatchDeploymentRequest message or plain object
callback	google.cloud.osconfig.v1beta.OsConfigService.CreatePatchDeploymentCallback Node-style callback called with the error, if any, and PatchDeployment

Returns
Type	Description
void

createPatchDeployment(request)

public createPatchDeployment(request: google.cloud.osconfig.v1beta.ICreatePatchDeploymentRequest): Promise<google.cloud.osconfig.v1beta.PatchDeployment>;

Calls CreatePatchDeployment.

Parameter
Name	Description
request	google.cloud.osconfig.v1beta.ICreatePatchDeploymentRequest CreatePatchDeploymentRequest message or plain object

Returns
Type	Description
Promise<google.cloud.osconfig.v1beta.PatchDeployment>	Promise

deleteGuestPolicy(request, callback)

public deleteGuestPolicy(request: google.cloud.osconfig.v1beta.IDeleteGuestPolicyRequest, callback: google.cloud.osconfig.v1beta.OsConfigService.DeleteGuestPolicyCallback): void;

Calls DeleteGuestPolicy.

Parameters
Name	Description
request	IDeleteGuestPolicyRequest DeleteGuestPolicyRequest message or plain object
callback	google.cloud.osconfig.v1beta.OsConfigService.DeleteGuestPolicyCallback Node-style callback called with the error, if any, and Empty

Returns
Type	Description
void

deleteGuestPolicy(request)

public deleteGuestPolicy(request: google.cloud.osconfig.v1beta.IDeleteGuestPolicyRequest): Promise<google.protobuf.Empty>;

Calls DeleteGuestPolicy.

Parameter
Name	Description
request	IDeleteGuestPolicyRequest DeleteGuestPolicyRequest message or plain object

Returns
Type	Description
Promise<google.protobuf.Empty>	Promise

deletePatchDeployment(request, callback)

public deletePatchDeployment(request: google.cloud.osconfig.v1beta.IDeletePatchDeploymentRequest, callback: google.cloud.osconfig.v1beta.OsConfigService.DeletePatchDeploymentCallback): void;

Calls DeletePatchDeployment.

Parameters
Name	Description
request	google.cloud.osconfig.v1beta.IDeletePatchDeploymentRequest DeletePatchDeploymentRequest message or plain object
callback	google.cloud.osconfig.v1beta.OsConfigService.DeletePatchDeploymentCallback Node-style callback called with the error, if any, and Empty

Returns
Type	Description
void

deletePatchDeployment(request)

public deletePatchDeployment(request: google.cloud.osconfig.v1beta.IDeletePatchDeploymentRequest): Promise<google.protobuf.Empty>;

Calls DeletePatchDeployment.

Parameter
Name	Description
request	google.cloud.osconfig.v1beta.IDeletePatchDeploymentRequest DeletePatchDeploymentRequest message or plain object

Returns
Type	Description
Promise<google.protobuf.Empty>	Promise

executePatchJob(request, callback)

public executePatchJob(request: google.cloud.osconfig.v1beta.IExecutePatchJobRequest, callback: google.cloud.osconfig.v1beta.OsConfigService.ExecutePatchJobCallback): void;

Calls ExecutePatchJob.

Parameters
Name	Description
request	IExecutePatchJobRequest ExecutePatchJobRequest message or plain object
callback	google.cloud.osconfig.v1beta.OsConfigService.ExecutePatchJobCallback Node-style callback called with the error, if any, and PatchJob

Returns
Type	Description
void

executePatchJob(request)

public executePatchJob(request: google.cloud.osconfig.v1beta.IExecutePatchJobRequest): Promise<google.cloud.osconfig.v1beta.PatchJob>;

Calls ExecutePatchJob.

Parameter
Name	Description
request	IExecutePatchJobRequest ExecutePatchJobRequest message or plain object

Returns
Type	Description
Promise<google.cloud.osconfig.v1beta.PatchJob>	Promise

getGuestPolicy(request, callback)

public getGuestPolicy(request: google.cloud.osconfig.v1beta.IGetGuestPolicyRequest, callback: google.cloud.osconfig.v1beta.OsConfigService.GetGuestPolicyCallback): void;

Calls GetGuestPolicy.

Parameters
Name	Description
request	google.cloud.osconfig.v1beta.IGetGuestPolicyRequest GetGuestPolicyRequest message or plain object
callback	google.cloud.osconfig.v1beta.OsConfigService.GetGuestPolicyCallback Node-style callback called with the error, if any, and GuestPolicy

Returns
Type	Description
void

getGuestPolicy(request)

public getGuestPolicy(request: google.cloud.osconfig.v1beta.IGetGuestPolicyRequest): Promise<google.cloud.osconfig.v1beta.GuestPolicy>;

Calls GetGuestPolicy.

Parameter
Name	Description
request	google.cloud.osconfig.v1beta.IGetGuestPolicyRequest GetGuestPolicyRequest message or plain object

Returns
Type	Description
Promise<google.cloud.osconfig.v1beta.GuestPolicy>	Promise

getPatchDeployment(request, callback)

public getPatchDeployment(request: google.cloud.osconfig.v1beta.IGetPatchDeploymentRequest, callback: google.cloud.osconfig.v1beta.OsConfigService.GetPatchDeploymentCallback): void;

Calls GetPatchDeployment.

Parameters
Name	Description
request	IGetPatchDeploymentRequest GetPatchDeploymentRequest message or plain object
callback	google.cloud.osconfig.v1beta.OsConfigService.GetPatchDeploymentCallback Node-style callback called with the error, if any, and PatchDeployment

Returns
Type	Description
void

getPatchDeployment(request)

public getPatchDeployment(request: google.cloud.osconfig.v1beta.IGetPatchDeploymentRequest): Promise<google.cloud.osconfig.v1beta.PatchDeployment>;

Calls GetPatchDeployment.

Parameter
Name	Description
request	IGetPatchDeploymentRequest GetPatchDeploymentRequest message or plain object

Returns
Type	Description
Promise<google.cloud.osconfig.v1beta.PatchDeployment>	Promise

getPatchJob(request, callback)

public getPatchJob(request: google.cloud.osconfig.v1beta.IGetPatchJobRequest, callback: google.cloud.osconfig.v1beta.OsConfigService.GetPatchJobCallback): void;

Calls GetPatchJob.

Parameters
Name	Description
request	google.cloud.osconfig.v1beta.IGetPatchJobRequest GetPatchJobRequest message or plain object
callback	google.cloud.osconfig.v1beta.OsConfigService.GetPatchJobCallback Node-style callback called with the error, if any, and PatchJob

Returns
Type	Description
void

getPatchJob(request)

public getPatchJob(request: google.cloud.osconfig.v1beta.IGetPatchJobRequest): Promise<google.cloud.osconfig.v1beta.PatchJob>;

Calls GetPatchJob.

Parameter
Name	Description
request	google.cloud.osconfig.v1beta.IGetPatchJobRequest GetPatchJobRequest message or plain object

Returns
Type	Description
Promise<google.cloud.osconfig.v1beta.PatchJob>	Promise

listGuestPolicies(request, callback)

public listGuestPolicies(request: google.cloud.osconfig.v1beta.IListGuestPoliciesRequest, callback: google.cloud.osconfig.v1beta.OsConfigService.ListGuestPoliciesCallback): void;

Calls ListGuestPolicies.

Parameters
Name	Description
request	google.cloud.osconfig.v1beta.IListGuestPoliciesRequest ListGuestPoliciesRequest message or plain object
callback	google.cloud.osconfig.v1beta.OsConfigService.ListGuestPoliciesCallback Node-style callback called with the error, if any, and ListGuestPoliciesResponse

Returns
Type	Description
void

listGuestPolicies(request)

public listGuestPolicies(request: google.cloud.osconfig.v1beta.IListGuestPoliciesRequest): Promise<google.cloud.osconfig.v1beta.ListGuestPoliciesResponse>;

Calls ListGuestPolicies.

Parameter
Name	Description
request	google.cloud.osconfig.v1beta.IListGuestPoliciesRequest ListGuestPoliciesRequest message or plain object

Returns
Type	Description
Promise<google.cloud.osconfig.v1beta.ListGuestPoliciesResponse>	Promise

listPatchDeployments(request, callback)

public listPatchDeployments(request: google.cloud.osconfig.v1beta.IListPatchDeploymentsRequest, callback: google.cloud.osconfig.v1beta.OsConfigService.ListPatchDeploymentsCallback): void;

Calls ListPatchDeployments.

Parameters
Name	Description
request	google.cloud.osconfig.v1beta.IListPatchDeploymentsRequest ListPatchDeploymentsRequest message or plain object
callback	google.cloud.osconfig.v1beta.OsConfigService.ListPatchDeploymentsCallback Node-style callback called with the error, if any, and ListPatchDeploymentsResponse

Returns
Type	Description
void

listPatchDeployments(request)

public listPatchDeployments(request: google.cloud.osconfig.v1beta.IListPatchDeploymentsRequest): Promise<google.cloud.osconfig.v1beta.ListPatchDeploymentsResponse>;

Calls ListPatchDeployments.

Parameter
Name	Description
request	google.cloud.osconfig.v1beta.IListPatchDeploymentsRequest ListPatchDeploymentsRequest message or plain object

Returns
Type	Description
Promise<google.cloud.osconfig.v1beta.ListPatchDeploymentsResponse>	Promise

listPatchJobInstanceDetails(request, callback)

public listPatchJobInstanceDetails(request: google.cloud.osconfig.v1beta.IListPatchJobInstanceDetailsRequest, callback: google.cloud.osconfig.v1beta.OsConfigService.ListPatchJobInstanceDetailsCallback): void;

Calls ListPatchJobInstanceDetails.

Parameters
Name	Description
request	google.cloud.osconfig.v1beta.IListPatchJobInstanceDetailsRequest ListPatchJobInstanceDetailsRequest message or plain object
callback	google.cloud.osconfig.v1beta.OsConfigService.ListPatchJobInstanceDetailsCallback Node-style callback called with the error, if any, and ListPatchJobInstanceDetailsResponse

Returns
Type	Description
void

listPatchJobInstanceDetails(request)

public listPatchJobInstanceDetails(request: google.cloud.osconfig.v1beta.IListPatchJobInstanceDetailsRequest): Promise<google.cloud.osconfig.v1beta.ListPatchJobInstanceDetailsResponse>;

Calls ListPatchJobInstanceDetails.

Parameter
Name	Description
request	google.cloud.osconfig.v1beta.IListPatchJobInstanceDetailsRequest ListPatchJobInstanceDetailsRequest message or plain object

Returns
Type	Description
Promise<google.cloud.osconfig.v1beta.ListPatchJobInstanceDetailsResponse>	Promise

listPatchJobs(request, callback)

public listPatchJobs(request: google.cloud.osconfig.v1beta.IListPatchJobsRequest, callback: google.cloud.osconfig.v1beta.OsConfigService.ListPatchJobsCallback): void;

Calls ListPatchJobs.

Parameters
Name	Description
request	IListPatchJobsRequest ListPatchJobsRequest message or plain object
callback	google.cloud.osconfig.v1beta.OsConfigService.ListPatchJobsCallback Node-style callback called with the error, if any, and ListPatchJobsResponse

Returns
Type	Description
void

listPatchJobs(request)

public listPatchJobs(request: google.cloud.osconfig.v1beta.IListPatchJobsRequest): Promise<google.cloud.osconfig.v1beta.ListPatchJobsResponse>;

Calls ListPatchJobs.

Parameter
Name	Description
request	IListPatchJobsRequest ListPatchJobsRequest message or plain object

Returns
Type	Description
Promise<google.cloud.osconfig.v1beta.ListPatchJobsResponse>	Promise

lookupEffectiveGuestPolicy(request, callback)

public lookupEffectiveGuestPolicy(request: google.cloud.osconfig.v1beta.ILookupEffectiveGuestPolicyRequest, callback: google.cloud.osconfig.v1beta.OsConfigService.LookupEffectiveGuestPolicyCallback): void;

Calls LookupEffectiveGuestPolicy.

Parameters
Name	Description
request	google.cloud.osconfig.v1beta.ILookupEffectiveGuestPolicyRequest LookupEffectiveGuestPolicyRequest message or plain object
callback	google.cloud.osconfig.v1beta.OsConfigService.LookupEffectiveGuestPolicyCallback Node-style callback called with the error, if any, and EffectiveGuestPolicy

Returns
Type	Description
void

lookupEffectiveGuestPolicy(request)

public lookupEffectiveGuestPolicy(request: google.cloud.osconfig.v1beta.ILookupEffectiveGuestPolicyRequest): Promise<google.cloud.osconfig.v1beta.EffectiveGuestPolicy>;

Calls LookupEffectiveGuestPolicy.

Parameter
Name	Description
request	google.cloud.osconfig.v1beta.ILookupEffectiveGuestPolicyRequest LookupEffectiveGuestPolicyRequest message or plain object

Returns
Type	Description
Promise<google.cloud.osconfig.v1beta.EffectiveGuestPolicy>	Promise

pausePatchDeployment(request, callback)

public pausePatchDeployment(request: google.cloud.osconfig.v1beta.IPausePatchDeploymentRequest, callback: google.cloud.osconfig.v1beta.OsConfigService.PausePatchDeploymentCallback): void;

Calls PausePatchDeployment.

Parameters
Name	Description
request	google.cloud.osconfig.v1beta.IPausePatchDeploymentRequest PausePatchDeploymentRequest message or plain object
callback	google.cloud.osconfig.v1beta.OsConfigService.PausePatchDeploymentCallback Node-style callback called with the error, if any, and PatchDeployment

Returns
Type	Description
void

pausePatchDeployment(request)

public pausePatchDeployment(request: google.cloud.osconfig.v1beta.IPausePatchDeploymentRequest): Promise<google.cloud.osconfig.v1beta.PatchDeployment>;

Calls PausePatchDeployment.

Parameter
Name	Description
request	google.cloud.osconfig.v1beta.IPausePatchDeploymentRequest PausePatchDeploymentRequest message or plain object

Returns
Type	Description
Promise<google.cloud.osconfig.v1beta.PatchDeployment>	Promise

resumePatchDeployment(request, callback)

public resumePatchDeployment(request: google.cloud.osconfig.v1beta.IResumePatchDeploymentRequest, callback: google.cloud.osconfig.v1beta.OsConfigService.ResumePatchDeploymentCallback): void;

Calls ResumePatchDeployment.

Parameters
Name	Description
request	IResumePatchDeploymentRequest ResumePatchDeploymentRequest message or plain object
callback	google.cloud.osconfig.v1beta.OsConfigService.ResumePatchDeploymentCallback Node-style callback called with the error, if any, and PatchDeployment

Returns
Type	Description
void

resumePatchDeployment(request)

public resumePatchDeployment(request: google.cloud.osconfig.v1beta.IResumePatchDeploymentRequest): Promise<google.cloud.osconfig.v1beta.PatchDeployment>;

Calls ResumePatchDeployment.

Parameter
Name	Description
request	IResumePatchDeploymentRequest ResumePatchDeploymentRequest message or plain object

Returns
Type	Description
Promise<google.cloud.osconfig.v1beta.PatchDeployment>	Promise

updateGuestPolicy(request, callback)

public updateGuestPolicy(request: google.cloud.osconfig.v1beta.IUpdateGuestPolicyRequest, callback: google.cloud.osconfig.v1beta.OsConfigService.UpdateGuestPolicyCallback): void;

Calls UpdateGuestPolicy.

Parameters
Name	Description
request	IUpdateGuestPolicyRequest UpdateGuestPolicyRequest message or plain object
callback	google.cloud.osconfig.v1beta.OsConfigService.UpdateGuestPolicyCallback Node-style callback called with the error, if any, and GuestPolicy

Returns
Type	Description
void

updateGuestPolicy(request)

public updateGuestPolicy(request: google.cloud.osconfig.v1beta.IUpdateGuestPolicyRequest): Promise<google.cloud.osconfig.v1beta.GuestPolicy>;

Calls UpdateGuestPolicy.

Parameter
Name	Description
request	IUpdateGuestPolicyRequest UpdateGuestPolicyRequest message or plain object

Returns
Type	Description
Promise<google.cloud.osconfig.v1beta.GuestPolicy>	Promise

updatePatchDeployment(request, callback)

public updatePatchDeployment(request: google.cloud.osconfig.v1beta.IUpdatePatchDeploymentRequest, callback: google.cloud.osconfig.v1beta.OsConfigService.UpdatePatchDeploymentCallback): void;

Calls UpdatePatchDeployment.

Parameters
Name	Description
request	google.cloud.osconfig.v1beta.IUpdatePatchDeploymentRequest UpdatePatchDeploymentRequest message or plain object
callback	google.cloud.osconfig.v1beta.OsConfigService.UpdatePatchDeploymentCallback Node-style callback called with the error, if any, and PatchDeployment

Returns
Type	Description
void

updatePatchDeployment(request)

public updatePatchDeployment(request: google.cloud.osconfig.v1beta.IUpdatePatchDeploymentRequest): Promise<google.cloud.osconfig.v1beta.PatchDeployment>;

Calls UpdatePatchDeployment.

Parameter
Name	Description
request	google.cloud.osconfig.v1beta.IUpdatePatchDeploymentRequest UpdatePatchDeploymentRequest message or plain object

Returns
Type	Description
Promise<google.cloud.osconfig.v1beta.PatchDeployment>	Promise