OSConfig

import { OSConfig } from "https://googleapis.deno.dev/v1/osconfig:v2.ts";

OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances.

class OSConfig {

constructor(client?: CredentialsClient, baseUrl?: string);

async foldersLocationsGlobalPolicyOrchestratorsCreate(

parent: string,

req: GoogleCloudOsconfigV2__PolicyOrchestrator,

opts?: FoldersLocationsGlobalPolicyOrchestratorsCreateOptions,

): Promise<Operation>;

async foldersLocationsGlobalPolicyOrchestratorsDelete(name: string, opts?: FoldersLocationsGlobalPolicyOrchestratorsDeleteOptions): Promise<Operation>;

async foldersLocationsGlobalPolicyOrchestratorsGet(name: string): Promise<GoogleCloudOsconfigV2__PolicyOrchestrator>;

async foldersLocationsGlobalPolicyOrchestratorsList(parent: string, opts?: FoldersLocationsGlobalPolicyOrchestratorsListOptions): Promise<GoogleCloudOsconfigV2__ListPolicyOrchestratorsResponse>;

async foldersLocationsGlobalPolicyOrchestratorsPatch(

req: GoogleCloudOsconfigV2__PolicyOrchestrator,

opts?: FoldersLocationsGlobalPolicyOrchestratorsPatchOptions,

): Promise<Operation>;

async foldersLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>;

async foldersLocationsOperationsDelete(name: string): Promise<Empty>;

async foldersLocationsOperationsGet(name: string): Promise<Operation>;

async foldersLocationsOperationsList(name: string, opts?: FoldersLocationsOperationsListOptions): Promise<ListOperationsResponse>;

async organizationsLocationsGlobalPolicyOrchestratorsCreate(

parent: string,

req: GoogleCloudOsconfigV2__PolicyOrchestrator,

opts?: OrganizationsLocationsGlobalPolicyOrchestratorsCreateOptions,

): Promise<Operation>;

async organizationsLocationsGlobalPolicyOrchestratorsDelete(name: string, opts?: OrganizationsLocationsGlobalPolicyOrchestratorsDeleteOptions): Promise<Operation>;

async organizationsLocationsGlobalPolicyOrchestratorsGet(name: string): Promise<GoogleCloudOsconfigV2__PolicyOrchestrator>;

async organizationsLocationsGlobalPolicyOrchestratorsList(parent: string, opts?: OrganizationsLocationsGlobalPolicyOrchestratorsListOptions): Promise<GoogleCloudOsconfigV2__ListPolicyOrchestratorsResponse>;

async organizationsLocationsGlobalPolicyOrchestratorsPatch(

req: GoogleCloudOsconfigV2__PolicyOrchestrator,

opts?: OrganizationsLocationsGlobalPolicyOrchestratorsPatchOptions,

): Promise<Operation>;

async organizationsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>;

async organizationsLocationsOperationsDelete(name: string): Promise<Empty>;

async organizationsLocationsOperationsGet(name: string): Promise<Operation>;

async organizationsLocationsOperationsList(name: string, opts?: OrganizationsLocationsOperationsListOptions): Promise<ListOperationsResponse>;

async projectsLocationsGlobalPolicyOrchestratorsCreate(

parent: string,

req: GoogleCloudOsconfigV2__PolicyOrchestrator,

opts?: ProjectsLocationsGlobalPolicyOrchestratorsCreateOptions,

): Promise<Operation>;

async projectsLocationsGlobalPolicyOrchestratorsDelete(name: string, opts?: ProjectsLocationsGlobalPolicyOrchestratorsDeleteOptions): Promise<Operation>;

async projectsLocationsGlobalPolicyOrchestratorsGet(name: string): Promise<GoogleCloudOsconfigV2__PolicyOrchestrator>;

async projectsLocationsGlobalPolicyOrchestratorsList(parent: string, opts?: ProjectsLocationsGlobalPolicyOrchestratorsListOptions): Promise<GoogleCloudOsconfigV2__ListPolicyOrchestratorsResponse>;

async projectsLocationsGlobalPolicyOrchestratorsPatch(

req: GoogleCloudOsconfigV2__PolicyOrchestrator,

opts?: ProjectsLocationsGlobalPolicyOrchestratorsPatchOptions,

): Promise<Operation>;

async projectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>;

async projectsLocationsOperationsDelete(name: string): Promise<Empty>;

async projectsLocationsOperationsGet(name: string): Promise<Operation>;

async projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>;

}

§Constructors

new OSConfig(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

foldersLocationsGlobalPolicyOrchestratorsCreate(parent: string, req: GoogleCloudOsconfigV2__PolicyOrchestrator, opts?: FoldersLocationsGlobalPolicyOrchestratorsCreateOptions): Promise<Operation>

[src]

Creates a new policy orchestrator under the given folder resource. name field of the given orchestrator are ignored and instead replaced by a product of parent and policy_orchestrator_id. Orchestrator state field might be only set to ACTIVE, STOPPED or omitted (in which case, the created resource will be in ACTIVE state anyway).

@param parent

Required. The parent resource name in the form of: * organizations/{organization_id}/locations/global * folders/{folder_id}/locations/global * projects/{project_id_or_number}/locations/global

foldersLocationsGlobalPolicyOrchestratorsDelete(name: string, opts?: FoldersLocationsGlobalPolicyOrchestratorsDeleteOptions): Promise<Operation>

[src]

Deletes an existing policy orchestrator resource, parented by a folder.

@param name

Required. Name of the resource to be deleted.

foldersLocationsGlobalPolicyOrchestratorsGet(name: string): Promise<GoogleCloudOsconfigV2__PolicyOrchestrator>

[src]

Retrieves an existing policy orchestrator, parented by a folder.

@param name

Required. The resource name.

foldersLocationsGlobalPolicyOrchestratorsList(parent: string, opts?: FoldersLocationsGlobalPolicyOrchestratorsListOptions): Promise<GoogleCloudOsconfigV2__ListPolicyOrchestratorsResponse>

[src]

Lists the policy orchestrators under the given parent folder resource.

@param parent

Required. The parent resource name.

foldersLocationsGlobalPolicyOrchestratorsPatch(name: string, req: GoogleCloudOsconfigV2__PolicyOrchestrator, opts?: FoldersLocationsGlobalPolicyOrchestratorsPatchOptions): Promise<Operation>

[src]

Updates an existing policy orchestrator, parented by a folder.

@param name

Immutable. Identifier. In form of * organizations/{organization_id}/locations/global/policyOrchestrators/{orchestrator_id} * folders/{folder_id}/locations/global/policyOrchestrators/{orchestrator_id} * projects/{project_id_or_number}/locations/global/policyOrchestrators/{orchestrator_id}

foldersLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>

[src]

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

foldersLocationsOperationsDelete(name: string): Promise<Empty>

[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

foldersLocationsOperationsGet(name: string): Promise<Operation>

[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

foldersLocationsOperationsList(name: string, opts?: FoldersLocationsOperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

organizationsLocationsGlobalPolicyOrchestratorsCreate(parent: string, req: GoogleCloudOsconfigV2__PolicyOrchestrator, opts?: OrganizationsLocationsGlobalPolicyOrchestratorsCreateOptions): Promise<Operation>

[src]

Creates a new policy orchestrator under the given organizations resource. name field of the given orchestrator are ignored and instead replaced by a product of parent and policy_orchestrator_id. Orchestrator state field might be only set to ACTIVE, STOPPED or omitted (in which case, the created resource will be in ACTIVE state anyway).

@param parent

Required. The parent resource name in the form of: * organizations/{organization_id}/locations/global * folders/{folder_id}/locations/global * projects/{project_id_or_number}/locations/global

organizationsLocationsGlobalPolicyOrchestratorsDelete(name: string, opts?: OrganizationsLocationsGlobalPolicyOrchestratorsDeleteOptions): Promise<Operation>

[src]

Deletes an existing policy orchestrator resource, parented by an organization.

@param name

Required. Name of the resource to be deleted.

organizationsLocationsGlobalPolicyOrchestratorsGet(name: string): Promise<GoogleCloudOsconfigV2__PolicyOrchestrator>

[src]

Retrieves an existing policy orchestrator, parented by an organization.

@param name

Required. The resource name.

organizationsLocationsGlobalPolicyOrchestratorsList(parent: string, opts?: OrganizationsLocationsGlobalPolicyOrchestratorsListOptions): Promise<GoogleCloudOsconfigV2__ListPolicyOrchestratorsResponse>

[src]

Lists the policy orchestrators under the given parent organization resource.

@param parent

Required. The parent resource name.

organizationsLocationsGlobalPolicyOrchestratorsPatch(name: string, req: GoogleCloudOsconfigV2__PolicyOrchestrator, opts?: OrganizationsLocationsGlobalPolicyOrchestratorsPatchOptions): Promise<Operation>

[src]

Updates an existing policy orchestrator, parented by an organization.

@param name

organizationsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>

[src]

@param name

The name of the operation resource to be cancelled.

organizationsLocationsOperationsDelete(name: string): Promise<Empty>

[src]

@param name

The name of the operation resource to be deleted.

organizationsLocationsOperationsGet(name: string): Promise<Operation>

[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

organizationsLocationsOperationsList(name: string, opts?: OrganizationsLocationsOperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

projectsLocationsGlobalPolicyOrchestratorsCreate(parent: string, req: GoogleCloudOsconfigV2__PolicyOrchestrator, opts?: ProjectsLocationsGlobalPolicyOrchestratorsCreateOptions): Promise<Operation>

[src]

Creates a new policy orchestrator under the given project resource. name field of the given orchestrator are ignored and instead replaced by a product of parent and policy_orchestrator_id. Orchestrator state field might be only set to ACTIVE, STOPPED or omitted (in which case, the created resource will be in ACTIVE state anyway).

@param parent

Required. The parent resource name in the form of: * organizations/{organization_id}/locations/global * folders/{folder_id}/locations/global * projects/{project_id_or_number}/locations/global

projectsLocationsGlobalPolicyOrchestratorsDelete(name: string, opts?: ProjectsLocationsGlobalPolicyOrchestratorsDeleteOptions): Promise<Operation>

[src]

Deletes an existing policy orchestrator resource, parented by a project.

@param name

Required. Name of the resource to be deleted.

projectsLocationsGlobalPolicyOrchestratorsGet(name: string): Promise<GoogleCloudOsconfigV2__PolicyOrchestrator>

[src]

Retrieves an existing policy orchestrator, parented by a project.

@param name

Required. The resource name.

projectsLocationsGlobalPolicyOrchestratorsList(parent: string, opts?: ProjectsLocationsGlobalPolicyOrchestratorsListOptions): Promise<GoogleCloudOsconfigV2__ListPolicyOrchestratorsResponse>

[src]

Lists the policy orchestrators under the given parent project resource.

@param parent

Required. The parent resource name.

projectsLocationsGlobalPolicyOrchestratorsPatch(name: string, req: GoogleCloudOsconfigV2__PolicyOrchestrator, opts?: ProjectsLocationsGlobalPolicyOrchestratorsPatchOptions): Promise<Operation>

[src]

Updates an existing policy orchestrator, parented by a project.

@param name

projectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>

[src]

@param name

The name of the operation resource to be cancelled.

projectsLocationsOperationsDelete(name: string): Promise<Empty>

[src]

@param name

The name of the operation resource to be deleted.

projectsLocationsOperationsGet(name: string): Promise<Operation>

[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.