Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

SecurityPosture

import { SecurityPosture } from "https://googleapis.deno.dev/v1/securityposture:v1.ts";

Defines, assesses, and monitors the overall status of your security in Google Cloud. You can use security postures to evaluate your current cloud security against defined benchmarks and help maintain the level of security that your organization requires.

class SecurityPosture {
constructor(client?: CredentialsClient, baseUrl?: string);
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 organizationsLocationsPostureDeploymentsCreate(
parent: string,
req: PostureDeployment,
opts?: OrganizationsLocationsPostureDeploymentsCreateOptions,
): Promise<Operation>;
async organizationsLocationsPostureDeploymentsDelete(name: string, opts?: OrganizationsLocationsPostureDeploymentsDeleteOptions): Promise<Operation>;
async organizationsLocationsPostureDeploymentsGet(name: string): Promise<PostureDeployment>;
async organizationsLocationsPostureDeploymentsList(parent: string, opts?: OrganizationsLocationsPostureDeploymentsListOptions): Promise<ListPostureDeploymentsResponse>;
async organizationsLocationsPostureDeploymentsPatch(
name: string,
req: PostureDeployment,
opts?: OrganizationsLocationsPostureDeploymentsPatchOptions,
): Promise<Operation>;
async organizationsLocationsPosturesCreate(
parent: string,
req: Posture,
opts?: OrganizationsLocationsPosturesCreateOptions,
): Promise<Operation>;
async organizationsLocationsPosturesDelete(name: string, opts?: OrganizationsLocationsPosturesDeleteOptions): Promise<Operation>;
async organizationsLocationsPosturesExtract(parent: string, req: ExtractPostureRequest): Promise<Operation>;
async organizationsLocationsPosturesGet(name: string, opts?: OrganizationsLocationsPosturesGetOptions): Promise<Posture>;
async organizationsLocationsPosturesList(parent: string, opts?: OrganizationsLocationsPosturesListOptions): Promise<ListPosturesResponse>;
async organizationsLocationsPosturesListRevisions(name: string, opts?: OrganizationsLocationsPosturesListRevisionsOptions): Promise<ListPostureRevisionsResponse>;
async organizationsLocationsPosturesPatch(
name: string,
req: Posture,
opts?: OrganizationsLocationsPosturesPatchOptions,
): Promise<Operation>;
async organizationsLocationsPostureTemplatesGet(name: string, opts?: OrganizationsLocationsPostureTemplatesGetOptions): Promise<PostureTemplate>;
async organizationsLocationsPostureTemplatesList(parent: string, opts?: OrganizationsLocationsPostureTemplatesListOptions): Promise<ListPostureTemplatesResponse>;
async organizationsLocationsReportsCreateIaCValidationReport(parent: string, req: CreateIaCValidationReportRequest): Promise<Operation>;
async organizationsLocationsReportsGet(name: string): Promise<Report>;
async organizationsLocationsReportsList(parent: string, opts?: OrganizationsLocationsReportsListOptions): Promise<ListReportsResponse>;
async projectsLocationsGet(name: string): Promise<Location>;
async projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>;
}

§Constructors

§
new SecurityPosture(client?: CredentialsClient, baseUrl?: string)
[src]

§Methods

§
organizationsLocationsOperationsCancel(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.

§
organizationsLocationsOperationsDelete(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.

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

§
organizationsLocationsPostureDeploymentsCreate(parent: string, req: PostureDeployment, opts?: OrganizationsLocationsPostureDeploymentsCreateOptions): Promise<Operation>
[src]

Creates a new PostureDeployment in a given project and location.

@param parent

Required. The parent resource name, in the format organizations/{organization}/locations/global.

§
organizationsLocationsPostureDeploymentsDelete(name: string, opts?: OrganizationsLocationsPostureDeploymentsDeleteOptions): Promise<Operation>
[src]

Deletes a PostureDeployment.

@param name

Required. The name of the posture deployment, in the format organizations/{organization}/locations/global/postureDeployments/{posture_id}.

§
organizationsLocationsPostureDeploymentsGet(name: string): Promise<PostureDeployment>
[src]

Gets details for a PostureDeployment.

@param name

Required. The name of the PostureDeployment, in the format organizations/{organization}/locations/global/postureDeployments/{posture_deployment_id}.

§
organizationsLocationsPostureDeploymentsList(parent: string, opts?: OrganizationsLocationsPostureDeploymentsListOptions): Promise<ListPostureDeploymentsResponse>
[src]

Lists every PostureDeployment in a project and location.

@param parent

Required. The parent resource name, in the format organizations/{organization}/locations/global.

§
organizationsLocationsPostureDeploymentsPatch(name: string, req: PostureDeployment, opts?: OrganizationsLocationsPostureDeploymentsPatchOptions): Promise<Operation>
[src]

Updates an existing PostureDeployment. To prevent concurrent updates from overwriting each other, always follow the read-modify-write pattern when you update a posture deployment: 1. Call GetPostureDeployment to get the current version of the deployment. 2. Update the fields in the deployment as needed. 3. Call UpdatePostureDeployment to update the deployment. Ensure that your request includes the etag value from the GetPostureDeployment response. Important: If you omit the etag when you call UpdatePostureDeployment, then the updated deployment unconditionally overwrites the existing deployment.

@param name

Required. Identifier. The name of the posture deployment, in the format organizations/{organization}/locations/global/postureDeployments/{deployment_id}.

§
organizationsLocationsPosturesCreate(parent: string, req: Posture, opts?: OrganizationsLocationsPosturesCreateOptions): Promise<Operation>
[src]

Creates a new Posture.

@param parent

Required. The parent resource name, in the format organizations/{organization}/locations/global.

§
organizationsLocationsPosturesDelete(name: string, opts?: OrganizationsLocationsPosturesDeleteOptions): Promise<Operation>
[src]

Deletes all revisions of a Posture. You can only delete a posture if none of its revisions are deployed.

@param name

Required. The name of the Posture, in the format organizations/{organization}/locations/global/postures/{posture_id}.

§
organizationsLocationsPosturesExtract(parent: string, req: ExtractPostureRequest): Promise<Operation>
[src]

Extracts existing policies from an organization, folder, or project, and applies them to another organization, folder, or project as a Posture. If the other organization, folder, or project already has a posture, then the result of the long-running operation is an ALREADY_EXISTS error.

@param parent

Required. The parent resource name, in the format organizations/{organization}/locations/global.

§
organizationsLocationsPosturesGet(name: string, opts?: OrganizationsLocationsPosturesGetOptions): Promise<Posture>
[src]

Gets a single revision of a Posture.

@param name

Required. The name of the Posture, in the format organizations/{organization}/locations/global/postures/{posture_id}.

§
organizationsLocationsPosturesList(parent: string, opts?: OrganizationsLocationsPosturesListOptions): Promise<ListPosturesResponse>
[src]

Lists the most recent revisions of all Posture resources in a specified organization and location.

@param parent

Required. The parent resource name, in the format organizations/{organization}/locations/global.

§
organizationsLocationsPosturesListRevisions(name: string, opts?: OrganizationsLocationsPosturesListRevisionsOptions): Promise<ListPostureRevisionsResponse>
[src]

Lists all revisions of a single Posture.

@param name

Required. The name of the Posture, in the format organizations/{organization}/locations/global/postures/{posture_id}.

§
organizationsLocationsPosturesPatch(name: string, req: Posture, opts?: OrganizationsLocationsPosturesPatchOptions): Promise<Operation>
[src]

Updates a revision of an existing Posture. If the posture revision that you update is currently deployed, then a new revision of the posture is created. To prevent concurrent updates from overwriting each other, always follow the read-modify-write pattern when you update a posture: 1. Call GetPosture to get the current version of the posture. 2. Update the fields in the posture as needed. 3. Call UpdatePosture to update the posture. Ensure that your request includes the etag value from the GetPosture response. Important: If you omit the etag when you call UpdatePosture, then the updated posture unconditionally overwrites the existing posture.

@param name

Required. Identifier. The name of the posture, in the format organizations/{organization}/locations/global/postures/{posture_id}.

§
organizationsLocationsPostureTemplatesGet(name: string, opts?: OrganizationsLocationsPostureTemplatesGetOptions): Promise<PostureTemplate>
[src]

Gets a single revision of a PostureTemplate.

@param name

Required. The name of the PostureTemplate, in the format organizations/{organization}/locations/global/postureTemplates/{posture_template}.

§
organizationsLocationsPostureTemplatesList(parent: string, opts?: OrganizationsLocationsPostureTemplatesListOptions): Promise<ListPostureTemplatesResponse>
[src]

Lists every PostureTemplate in a given organization and location.

@param parent

Required. The parent resource name, in the format organizations/{organization}/locations/global.

§
organizationsLocationsReportsCreateIaCValidationReport(parent: string, req: CreateIaCValidationReportRequest): Promise<Operation>
[src]

Validates a specified infrastructure-as-code (IaC) configuration, and creates a Report with the validation results. Only Terraform configurations are supported. Only modified assets are validated.

@param parent

Required. The parent resource name, in the format organizations/{organization}/locations/global.

§
organizationsLocationsReportsGet(name: string): Promise<Report>
[src]

Gets details for a Report.

@param name

Required. The name of the report, in the format organizations/{organization}/locations/global/reports/{report_id}.

§
organizationsLocationsReportsList(parent: string, opts?: OrganizationsLocationsReportsListOptions): Promise<ListReportsResponse>
[src]

Lists every Report in a given organization and location.

@param parent

Required. The parent resource name, in the format organizations/{organization}/locations/global.

§
projectsLocationsGet(name: string): Promise<Location>
[src]

Gets information about a location.

@param name

Resource name for the location.

§
projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>
[src]

Lists information about the supported locations for this service.

@param name

The resource that owns the locations collection, if applicable.