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

config

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

Creates and manages Google Cloud Platform resources and infrastructure.

class config {
constructor(client?: CredentialsClient, baseUrl?: string);
async projectsLocationsDeploymentsCreate(
parent: string,
): Promise<Operation>;
async projectsLocationsDeploymentsDelete(name: string, opts?: ProjectsLocationsDeploymentsDeleteOptions): Promise<Operation>;
async projectsLocationsDeploymentsDeleteState(name: string, req: DeleteStatefileRequest): Promise<Empty>;
async projectsLocationsDeploymentsExportLock(name: string): Promise<LockInfo>;
async projectsLocationsDeploymentsExportState(parent: string, req: ExportDeploymentStatefileRequest): Promise<Statefile>;
async projectsLocationsDeploymentsGet(name: string): Promise<Deployment>;
async projectsLocationsDeploymentsGetIamPolicy(resource: string, opts?: ProjectsLocationsDeploymentsGetIamPolicyOptions): Promise<Policy>;
async projectsLocationsDeploymentsImportState(parent: string, req: ImportStatefileRequest): Promise<Statefile>;
async projectsLocationsDeploymentsList(parent: string, opts?: ProjectsLocationsDeploymentsListOptions): Promise<ListDeploymentsResponse>;
async projectsLocationsDeploymentsLock(name: string, req: LockDeploymentRequest): Promise<Operation>;
async projectsLocationsDeploymentsPatch(
name: string,
): Promise<Operation>;
async projectsLocationsDeploymentsRevisionsExportState(parent: string, req: ExportRevisionStatefileRequest): Promise<Statefile>;
async projectsLocationsDeploymentsRevisionsGet(name: string): Promise<Revision>;
async projectsLocationsDeploymentsRevisionsList(parent: string, opts?: ProjectsLocationsDeploymentsRevisionsListOptions): Promise<ListRevisionsResponse>;
async projectsLocationsDeploymentsRevisionsResourcesGet(name: string): Promise<Resource>;
async projectsLocationsDeploymentsRevisionsResourcesList(parent: string, opts?: ProjectsLocationsDeploymentsRevisionsResourcesListOptions): Promise<ListResourcesResponse>;
async projectsLocationsDeploymentsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;
async projectsLocationsDeploymentsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;
async projectsLocationsDeploymentsUnlock(name: string, req: UnlockDeploymentRequest): Promise<Operation>;
async projectsLocationsGet(name: string): Promise<Location>;
async projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>;
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>;
async projectsLocationsPreviewsCreate(
parent: string,
req: Preview,
): Promise<Operation>;
async projectsLocationsPreviewsDelete(name: string, opts?: ProjectsLocationsPreviewsDeleteOptions): Promise<Operation>;
async projectsLocationsPreviewsExport(parent: string, req: ExportPreviewResultRequest): Promise<ExportPreviewResultResponse>;
async projectsLocationsPreviewsGet(name: string): Promise<Preview>;
async projectsLocationsPreviewsList(parent: string, opts?: ProjectsLocationsPreviewsListOptions): Promise<ListPreviewsResponse>;
async projectsLocationsTerraformVersionsGet(name: string): Promise<TerraformVersion>;
async projectsLocationsTerraformVersionsList(parent: string, opts?: ProjectsLocationsTerraformVersionsListOptions): Promise<ListTerraformVersionsResponse>;
}

§Constructors

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

§Methods

§
projectsLocationsDeploymentsCreate(parent: string, req: Deployment, opts?: ProjectsLocationsDeploymentsCreateOptions): Promise<Operation>
[src]

Creates a Deployment.

@param parent

Required. The parent in whose context the Deployment is created. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

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

Deletes a Deployment.

@param name

Required. The name of the Deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

§
projectsLocationsDeploymentsDeleteState(name: string, req: DeleteStatefileRequest): Promise<Empty>
[src]

Deletes Terraform state file in a given deployment.

@param name

Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

§
projectsLocationsDeploymentsExportLock(name: string): Promise<LockInfo>
[src]

Exports the lock info on a locked deployment.

@param name

Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

§
projectsLocationsDeploymentsExportState(parent: string, req: ExportDeploymentStatefileRequest): Promise<Statefile>
[src]

Exports Terraform state file from a given deployment.

@param parent

Required. The parent in whose context the statefile is listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

§
projectsLocationsDeploymentsGet(name: string): Promise<Deployment>
[src]

Gets details about a Deployment.

@param name

Required. The name of the deployment. Format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

§
projectsLocationsDeploymentsGetIamPolicy(resource: string, opts?: ProjectsLocationsDeploymentsGetIamPolicyOptions): Promise<Policy>
[src]

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

§
projectsLocationsDeploymentsImportState(parent: string, req: ImportStatefileRequest): Promise<Statefile>
[src]

Imports Terraform state file in a given deployment. The state file does not take effect until the Deployment has been unlocked.

@param parent

Required. The parent in whose context the statefile is listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

§
projectsLocationsDeploymentsList(parent: string, opts?: ProjectsLocationsDeploymentsListOptions): Promise<ListDeploymentsResponse>
[src]

Lists Deployments in a given project and location.

@param parent

Required. The parent in whose context the Deployments are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

§
projectsLocationsDeploymentsLock(name: string, req: LockDeploymentRequest): Promise<Operation>
[src]

Locks a deployment.

@param name

Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

§
projectsLocationsDeploymentsPatch(name: string, req: Deployment, opts?: ProjectsLocationsDeploymentsPatchOptions): Promise<Operation>
[src]

Updates a Deployment.

@param name

Resource name of the deployment. Format: projects/{project}/locations/{location}/deployments/{deployment}

§
projectsLocationsDeploymentsRevisionsExportState(parent: string, req: ExportRevisionStatefileRequest): Promise<Statefile>
[src]

Exports Terraform state file from a given revision.

@param parent

Required. The parent in whose context the statefile is listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}'.

§
projectsLocationsDeploymentsRevisionsGet(name: string): Promise<Revision>
[src]

Gets details about a Revision.

@param name

Required. The name of the Revision in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}'.

§
projectsLocationsDeploymentsRevisionsList(parent: string, opts?: ProjectsLocationsDeploymentsRevisionsListOptions): Promise<ListRevisionsResponse>
[src]

Lists Revisions of a deployment.

@param parent

Required. The parent in whose context the Revisions are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

§
projectsLocationsDeploymentsRevisionsResourcesGet(name: string): Promise<Resource>
[src]

Gets details about a Resource deployed by Infra Manager.

@param name

Required. The name of the Resource in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}/resource/{resource}'.

§
projectsLocationsDeploymentsRevisionsResourcesList(parent: string, opts?: ProjectsLocationsDeploymentsRevisionsResourcesListOptions): Promise<ListResourcesResponse>
[src]

Lists Resources in a given revision.

@param parent

Required. The parent in whose context the Resources are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}'.

§
projectsLocationsDeploymentsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>
[src]

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

§
projectsLocationsDeploymentsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>
[src]

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

§
projectsLocationsDeploymentsUnlock(name: string, req: UnlockDeploymentRequest): Promise<Operation>
[src]

Unlocks a locked deployment.

@param name

Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.

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

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

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

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

§
projectsLocationsPreviewsCreate(parent: string, req: Preview, opts?: ProjectsLocationsPreviewsCreateOptions): Promise<Operation>
[src]

Creates a Preview.

@param parent

Required. The parent in whose context the Preview is created. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

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

Deletes a Preview.

@param name

Required. The name of the Preview in the format: 'projects/{project_id}/locations/{location}/previews/{preview}'.

§
projectsLocationsPreviewsExport(parent: string, req: ExportPreviewResultRequest): Promise<ExportPreviewResultResponse>
[src]

Export Preview results.

@param parent

Required. The preview whose results should be exported. The preview value is in the format: 'projects/{project_id}/locations/{location}/previews/{preview}'.

§
projectsLocationsPreviewsGet(name: string): Promise<Preview>
[src]

Gets details about a Preview.

@param name

Required. The name of the preview. Format: 'projects/{project_id}/locations/{location}/previews/{preview}'.

§
projectsLocationsPreviewsList(parent: string, opts?: ProjectsLocationsPreviewsListOptions): Promise<ListPreviewsResponse>
[src]

Lists Previews in a given project and location.

@param parent

Required. The parent in whose context the Previews are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'.

§
projectsLocationsTerraformVersionsGet(name: string): Promise<TerraformVersion>
[src]

Gets details about a TerraformVersion.

@param name

Required. The name of the TerraformVersion. Format: 'projects/{project_id}/locations/{location}/terraformVersions/{terraform_version}'

§
projectsLocationsTerraformVersionsList(parent: string, opts?: ProjectsLocationsTerraformVersionsListOptions): Promise<ListTerraformVersionsResponse>
[src]

Lists TerraformVersions in a given project and location.

@param parent

Required. The parent in whose context the TerraformVersions are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'.