AssuredWorkloads

import { AssuredWorkloads } from "https://googleapis.deno.dev/v1/assuredworkloads:v1.ts";

class AssuredWorkloads {

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

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

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

async organizationsLocationsWorkloadsAnalyzeWorkloadMove(target: string, opts?: OrganizationsLocationsWorkloadsAnalyzeWorkloadMoveOptions): Promise<GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse>;

async organizationsLocationsWorkloadsCreate(

parent: string,

req: GoogleCloudAssuredworkloadsV1Workload,

opts?: OrganizationsLocationsWorkloadsCreateOptions,

): Promise<GoogleLongrunningOperation>;

async organizationsLocationsWorkloadsDelete(name: string, opts?: OrganizationsLocationsWorkloadsDeleteOptions): Promise<GoogleProtobufEmpty>;

async organizationsLocationsWorkloadsEnableResourceMonitoring(name: string): Promise<GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse>;

async organizationsLocationsWorkloadsGet(name: string): Promise<GoogleCloudAssuredworkloadsV1Workload>;

async organizationsLocationsWorkloadsList(parent: string, opts?: OrganizationsLocationsWorkloadsListOptions): Promise<GoogleCloudAssuredworkloadsV1ListWorkloadsResponse>;

async organizationsLocationsWorkloadsMutatePartnerPermissions(name: string, req: GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest): Promise<GoogleCloudAssuredworkloadsV1Workload>;

async organizationsLocationsWorkloadsPatch(

name: string,

req: GoogleCloudAssuredworkloadsV1Workload,

opts?: OrganizationsLocationsWorkloadsPatchOptions,

): Promise<GoogleCloudAssuredworkloadsV1Workload>;

async organizationsLocationsWorkloadsRestrictAllowedResources(name: string, req: GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest): Promise<GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse>;

async organizationsLocationsWorkloadsViolationsAcknowledge(name: string, req: GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest): Promise<GoogleCloudAssuredworkloadsV1AcknowledgeViolationResponse>;

async organizationsLocationsWorkloadsViolationsGet(name: string): Promise<GoogleCloudAssuredworkloadsV1Violation>;

async organizationsLocationsWorkloadsViolationsList(parent: string, opts?: OrganizationsLocationsWorkloadsViolationsListOptions): Promise<GoogleCloudAssuredworkloadsV1ListViolationsResponse>;

}

§Constructors

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

[src]

§Methods

organizationsLocationsOperationsGet(name: string): Promise<GoogleLongrunningOperation>

[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<GoogleLongrunningListOperationsResponse>

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

organizationsLocationsWorkloadsAnalyzeWorkloadMove(target: string, opts?: OrganizationsLocationsWorkloadsAnalyzeWorkloadMoveOptions): Promise<GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse>

[src]

Analyzes a hypothetical move of a source resource to a target workload to surface compliance risks. The analysis is best effort and is not guaranteed to be exhaustive.

@param target

Required. The resource ID of the folder-based destination workload. This workload is where the source resource will hypothetically be moved to. Specify the workload's relative resource name, formatted as: "organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}" For example: "organizations/123/locations/us-east1/workloads/assured-workload-2"

organizationsLocationsWorkloadsCreate(parent: string, req: GoogleCloudAssuredworkloadsV1Workload, opts?: OrganizationsLocationsWorkloadsCreateOptions): Promise<GoogleLongrunningOperation>

[src]

Creates Assured Workload.

@param parent

Required. The resource name of the new Workload's parent. Must be of the form organizations/{org_id}/locations/{location_id}.

organizationsLocationsWorkloadsDelete(name: string, opts?: OrganizationsLocationsWorkloadsDeleteOptions): Promise<GoogleProtobufEmpty>

[src]

Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error. In addition to assuredworkloads.workload.delete permission, the user should also have orgpolicy.policy.set permission on the deleted folder to remove Assured Workloads OrgPolicies.

@param name

Required. The name field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}

organizationsLocationsWorkloadsEnableResourceMonitoring(name: string): Promise<GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse>

[src]

Enable resource violation monitoring for a workload.

@param name

Required. The name field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}

organizationsLocationsWorkloadsGet(name: string): Promise<GoogleCloudAssuredworkloadsV1Workload>

[src]

Gets Assured Workload associated with a CRM Node

@param name

Required. The resource name of the Workload to fetch. This is the workloads's relative path in the API, formatted as "organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}". For example, "organizations/123/locations/us-east1/workloads/assured-workload-1".

organizationsLocationsWorkloadsList(parent: string, opts?: OrganizationsLocationsWorkloadsListOptions): Promise<GoogleCloudAssuredworkloadsV1ListWorkloadsResponse>

[src]

Lists Assured Workloads under a CRM Node.

@param parent

Required. Parent Resource to list workloads from. Must be of the form organizations/{org_id}/locations/{location}.

organizationsLocationsWorkloadsMutatePartnerPermissions(name: string, req: GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest): Promise<GoogleCloudAssuredworkloadsV1Workload>

[src]

Update the permissions settings for an existing partner workload. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.

@param name

Required. The name field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}

organizationsLocationsWorkloadsPatch(name: string, req: GoogleCloudAssuredworkloadsV1Workload, opts?: OrganizationsLocationsWorkloadsPatchOptions): Promise<GoogleCloudAssuredworkloadsV1Workload>

[src]

Updates an existing workload. Currently allows updating of workload display_name and labels. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.

@param name

Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.

organizationsLocationsWorkloadsRestrictAllowedResources(name: string, req: GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest): Promise<GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse>

[src]

Restrict the list of resources allowed in the Workload environment. The current list of allowed products can be found at https://cloud.google.com/assured-workloads/docs/supported-products In addition to assuredworkloads.workload.update permission, the user should also have orgpolicy.policy.set permission on the folder resource to use this functionality.

@param name

Required. The resource name of the Workload. This is the workloads's relative path in the API, formatted as "organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}". For example, "organizations/123/locations/us-east1/workloads/assured-workload-1".

organizationsLocationsWorkloadsViolationsAcknowledge(name: string, req: GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest): Promise<GoogleCloudAssuredworkloadsV1AcknowledgeViolationResponse>

[src]

Acknowledges an existing violation. By acknowledging a violation, users acknowledge the existence of a compliance violation in their workload and decide to ignore it due to a valid business justification. Acknowledgement is a permanent operation and it cannot be reverted.

@param name

Required. The resource name of the Violation to acknowledge. Format: organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}

organizationsLocationsWorkloadsViolationsGet(name: string): Promise<GoogleCloudAssuredworkloadsV1Violation>

[src]

Retrieves Assured Workload Violation based on ID.

@param name

Required. The resource name of the Violation to fetch (ie. Violation.name). Format: organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}

organizationsLocationsWorkloadsViolationsList(parent: string, opts?: OrganizationsLocationsWorkloadsViolationsListOptions): Promise<GoogleCloudAssuredworkloadsV1ListViolationsResponse>

[src]

Lists the Violations in the AssuredWorkload Environment. Callers may also choose to read across multiple Workloads as per AIP-159 by using '-' (the hyphen or dash character) as a wildcard character instead of workload-id in the parent. Format organizations/{org_id}/locations/{location}/workloads/-

@param parent

Required. The Workload name. Format organizations/{org_id}/locations/{location}/workloads/{workload}.