{ "id": "config:v1", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "servicePath": "", "version": "v1", "version_module": true, "description": "Creates and manages Google Cloud Platform resources and infrastructure.", "batchPath": "batch", "mtlsRootUrl": "https://config.mtls.googleapis.com/", "fullyEncodeReservedExpansion": true, "parameters": { "access_token": { "type": "string", "description": "OAuth access token.", "location": "query" }, "alt": { "type": "string", "description": "Data format for response.", "default": "json", "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query" }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "key": { "type": "string", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "location": "query" }, "oauth_token": { "type": "string", "description": "OAuth 2.0 token for the current user.", "location": "query" }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query" }, "quotaUser": { "type": "string", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query" }, "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "uploadType": { "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "location": "query" }, "$.xgafv": { "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query" } }, "revision": "20260406", "documentationLink": "https://cloud.google.com/infrastructure-manager/docs", "name": "config", "kind": "discovery#restDescription", "schemas": { "ListOperationsResponse": { "id": "ListOperationsResponse", "description": "The response message for Operations.ListOperations.", "type": "object", "properties": { "operations": { "description": "A list of operations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "Operation" } }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" }, "unreachable": { "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "type": "array", "items": { "type": "string" } } } }, "Operation": { "id": "Operation", "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object", "properties": { "name": { "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" }, "metadata": { "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "done": { "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" }, "response": { "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } }, "Status": { "id": "Status", "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "type": "object", "properties": { "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer", "format": "int32" }, "message": { "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", "type": "string" }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } } }, "Empty": { "id": "Empty", "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "type": "object", "properties": {} }, "CancelOperationRequest": { "id": "CancelOperationRequest", "description": "The request message for Operations.CancelOperation.", "type": "object", "properties": {} }, "ListDeploymentsResponse": { "id": "ListDeploymentsResponse", "type": "object", "properties": { "deployments": { "description": "List of Deployments.", "type": "array", "items": { "$ref": "Deployment" } }, "nextPageToken": { "description": "Token to be supplied to the next ListDeployments request via `page_token` to obtain the next set of results.", "type": "string" }, "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } } } }, "Deployment": { "id": "Deployment", "description": "A Deployment is a group of resources and configs managed and provisioned by Infra Manager.", "type": "object", "properties": { "terraformBlueprint": { "description": "A blueprint described using Terraform's HashiCorp Configuration Language as a root module.", "$ref": "TerraformBlueprint" }, "name": { "description": "Identifier. Resource name of the deployment. Format: `projects/{project}/locations/{location}/deployments/{deployment}`", "type": "string" }, "createTime": { "description": "Output only. Time when the deployment was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. Time when the deployment was last modified.", "readOnly": true, "type": "string", "format": "google-datetime" }, "labels": { "description": "Optional. User-defined metadata for the deployment.", "type": "object", "additionalProperties": { "type": "string" } }, "state": { "description": "Output only. Current state of the deployment.", "readOnly": true, "type": "string", "enumDescriptions": [ "The default value. This value is used if the state is omitted.", "The deployment is being created.", "The deployment is healthy.", "The deployment is being updated.", "The deployment is being deleted.", "The deployment has encountered an unexpected error.", "The deployment is no longer being actively reconciled. This may be the result of recovering the project after deletion.", "The deployment has been deleted." ], "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED", "SUSPENDED", "DELETED" ] }, "latestRevision": { "description": "Output only. Revision name that was most recently applied. Format: `projects/{project}/locations/{location}/deployments/{deployment}/ revisions/{revision}`", "readOnly": true, "type": "string" }, "stateDetail": { "description": "Output only. Additional information regarding the current state.", "readOnly": true, "type": "string" }, "errorCode": { "description": "Output only. Error code describing errors that may have occurred.", "readOnly": true, "type": "string", "enumDescriptions": [ "No error code was specified.", "The revision failed. See Revision for more details.", "Cloud Build failed due to a permission issue.", "Cloud Build job associated with a deployment deletion could not be started.", "Cloud Build job associated with a deployment deletion was started but failed.", "Cloud Storage bucket creation failed due to a permission issue.", "Cloud Storage bucket creation failed due to an issue unrelated to permissions.", "Failed to import values from an external source." ], "enum": [ "ERROR_CODE_UNSPECIFIED", "REVISION_FAILED", "CLOUD_BUILD_PERMISSION_DENIED", "DELETE_BUILD_API_FAILED", "DELETE_BUILD_RUN_FAILED", "BUCKET_CREATION_PERMISSION_DENIED", "BUCKET_CREATION_FAILED", "EXTERNAL_VALUE_SOURCE_IMPORT_FAILED" ] }, "deleteResults": { "description": "Output only. Location of artifacts from a DeleteDeployment operation.", "readOnly": true, "$ref": "ApplyResults" }, "deleteBuild": { "description": "Output only. Cloud Build instance UUID associated with deleting this deployment.", "readOnly": true, "type": "string" }, "deleteLogs": { "description": "Output only. Location of Cloud Build logs in Google Cloud Storage, populated when deleting this deployment. Format: `gs://{bucket}/{object}`.", "readOnly": true, "type": "string" }, "tfErrors": { "description": "Output only. Errors encountered when deleting this deployment. Errors are truncated to 10 entries, see `delete_results` and `error_logs` for full details.", "readOnly": true, "type": "array", "items": { "$ref": "TerraformError" } }, "errorLogs": { "description": "Output only. Location of Terraform error logs in Google Cloud Storage. Format: `gs://{bucket}/{object}`.", "readOnly": true, "type": "string" }, "artifactsGcsBucket": { "description": "Optional. User-defined location of Cloud Build logs and artifacts in Google Cloud Storage. Format: `gs://{bucket}/{folder}` A default bucket will be bootstrapped if the field is not set or empty. Default bucket format: `gs://--blueprint-config` Constraints: - The bucket needs to be in the same project as the deployment - The path cannot be within the path of `gcs_source` - The field cannot be updated, including changing its presence", "type": "string" }, "serviceAccount": { "description": "Required. User-specified Service Account (SA) credentials to be used when actuating resources. Format: `projects/{projectID}/serviceAccounts/{serviceAccount}`", "type": "string" }, "importExistingResources": { "description": "By default, Infra Manager will return a failure when Terraform encounters a 409 code (resource conflict error) during actuation. If this flag is set to true, Infra Manager will instead attempt to automatically import the resource into the Terraform state (for supported resource types) and continue actuation. Not all resource types are supported, refer to documentation.", "type": "boolean" }, "workerPool": { "description": "Optional. The user-specified Cloud Build worker pool resource in which the Cloud Build job will execute. Format: `projects/{project}/locations/{location}/workerPools/{workerPoolId}`. If this field is unspecified, the default Cloud Build worker pool will be used.", "type": "string" }, "lockState": { "description": "Output only. Current lock state of the deployment.", "readOnly": true, "type": "string", "enumDescriptions": [ "The default value. This value is used if the lock state is omitted.", "The deployment is locked.", "The deployment is unlocked.", "The deployment is being locked.", "The deployment is being unlocked.", "The deployment has failed to lock.", "The deployment has failed to unlock." ], "enum": [ "LOCK_STATE_UNSPECIFIED", "LOCKED", "UNLOCKED", "LOCKING", "UNLOCKING", "LOCK_FAILED", "UNLOCK_FAILED" ] }, "tfVersionConstraint": { "description": "Optional. The user-specified Terraform version constraint. Example: \"=1.3.10\".", "type": "string" }, "tfVersion": { "description": "Output only. The current Terraform version set on the deployment. It is in the format of \"Major.Minor.Patch\", for example, \"1.3.10\".", "readOnly": true, "type": "string" }, "quotaValidation": { "description": "Optional. Input to control quota checks for resources in terraform configuration files. There are limited resources on which quota validation applies.", "type": "string", "enumDescriptions": [ "The default value. QuotaValidation on terraform configuration files will be disabled in this case.", "Enable computing quotas for resources in terraform configuration files to get visibility on resources with insufficient quotas.", "Enforce quota checks so deployment fails if there isn't sufficient quotas available to deploy resources in terraform configuration files." ], "enum": [ "QUOTA_VALIDATION_UNSPECIFIED", "ENABLED", "ENFORCED" ] }, "annotations": { "description": "Optional. Arbitrary key-value metadata storage e.g. to help client tools identify deployments during automation. See https://google.aip.dev/148#annotations for details on format and size limitations.", "type": "object", "additionalProperties": { "type": "string" } }, "providerConfig": { "description": "Optional. This field specifies the provider configurations.", "$ref": "ProviderConfig" } } }, "TerraformBlueprint": { "id": "TerraformBlueprint", "description": "TerraformBlueprint describes the source of a Terraform root module which describes the resources and configs to be deployed.", "type": "object", "properties": { "gcsSource": { "description": "URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}`", "type": "string" }, "gitSource": { "description": "URI of a public Git repo.", "$ref": "GitSource" }, "inputValues": { "description": "Optional. Input variable values for the Terraform blueprint.", "type": "object", "additionalProperties": { "$ref": "TerraformVariable" } }, "externalValues": { "description": "Optional. Map of input variable names in this blueprint to configurations for importing values from external sources.", "type": "object", "additionalProperties": { "$ref": "ExternalValueSource" } } } }, "GitSource": { "id": "GitSource", "description": "A set of files in a Git repository.", "type": "object", "properties": { "repo": { "description": "Optional. Repository URL. Example: 'https://github.com/kubernetes/examples.git'", "type": "string" }, "directory": { "description": "Optional. Subdirectory inside the repository. Example: 'staging/my-package'", "type": "string" }, "ref": { "description": "Optional. Git reference (e.g. branch or tag).", "type": "string" } } }, "TerraformVariable": { "id": "TerraformVariable", "description": "A Terraform input variable.", "type": "object", "properties": { "inputValue": { "description": "Optional. Input variable value.", "type": "any" } } }, "ExternalValueSource": { "id": "ExternalValueSource", "description": "Configuration for a source of an external value.", "type": "object", "properties": { "deploymentSource": { "description": "A source from a Deployment.", "$ref": "DeploymentSource" } } }, "DeploymentSource": { "id": "DeploymentSource", "description": "Configuration for a value sourced from a Deployment.", "type": "object", "properties": { "deployment": { "description": "Required. The resource name of the source Deployment to import the output from. Format: projects/{project}/locations/{location}/deployments/{deployment} The source deployment must be in the same project and location.", "type": "string" }, "outputName": { "description": "Required. The name of the output variable in the source deployment's latest successfully applied revision.", "type": "string" } } }, "ApplyResults": { "id": "ApplyResults", "description": "Outputs and artifacts from applying a deployment.", "type": "object", "properties": { "content": { "description": "Location of a blueprint copy and other manifests in Google Cloud Storage. Format: `gs://{bucket}/{object}`", "type": "string" }, "artifacts": { "description": "Location of artifacts (e.g. logs) in Google Cloud Storage. Format: `gs://{bucket}/{object}`", "type": "string" }, "outputs": { "description": "Map of output name to output info.", "type": "object", "additionalProperties": { "$ref": "TerraformOutput" } } } }, "TerraformOutput": { "id": "TerraformOutput", "description": "Describes a Terraform output.", "type": "object", "properties": { "sensitive": { "description": "Identifies whether Terraform has set this output as a potential sensitive value.", "type": "boolean" }, "value": { "description": "Value of output.", "type": "any" } } }, "TerraformError": { "id": "TerraformError", "description": "Errors encountered during actuation using Terraform", "type": "object", "properties": { "resourceAddress": { "description": "Address of the resource associated with the error, e.g. `google_compute_network.vpc_network`.", "type": "string" }, "httpResponseCode": { "description": "HTTP response code returned from Google Cloud Platform APIs when Terraform fails to provision the resource. If unset or 0, no HTTP response code was returned by Terraform.", "type": "integer", "format": "int32" }, "errorDescription": { "description": "A human-readable error description.", "type": "string" }, "error": { "description": "Output only. Original error response from underlying Google API, if available.", "readOnly": true, "$ref": "Status" } } }, "ProviderConfig": { "id": "ProviderConfig", "description": "ProviderConfig contains the provider configurations.", "type": "object", "properties": { "sourceType": { "description": "Optional. ProviderSource specifies the source type of the provider.", "type": "string", "enumDescriptions": [ "Unspecified source type, default to public sources.", "Service maintained provider source type." ], "enum": [ "PROVIDER_SOURCE_UNSPECIFIED", "SERVICE_MAINTAINED" ] } } }, "ListRevisionsResponse": { "id": "ListRevisionsResponse", "description": "A response to a 'ListRevisions' call. Contains a list of Revisions.", "type": "object", "properties": { "revisions": { "description": "List of Revisions.", "type": "array", "items": { "$ref": "Revision" } }, "nextPageToken": { "description": "A token to request the next page of resources from the 'ListRevisions' method. The value of an empty string means that there are no more resources to return.", "type": "string" }, "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } } } }, "Revision": { "id": "Revision", "description": "A child resource of a Deployment generated by a 'CreateDeployment' or 'UpdateDeployment' call. Each Revision contains metadata pertaining to a snapshot of a particular Deployment.", "type": "object", "properties": { "terraformBlueprint": { "description": "Output only. A blueprint described using Terraform's HashiCorp Configuration Language as a root module.", "readOnly": true, "$ref": "TerraformBlueprint" }, "name": { "description": "Revision name. Format: `projects/{project}/locations/{location}/deployments/{deployment}/ revisions/{revision}`", "type": "string" }, "createTime": { "description": "Output only. Time when the revision was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. Time when the revision was last modified.", "readOnly": true, "type": "string", "format": "google-datetime" }, "action": { "description": "Output only. The action which created this revision", "readOnly": true, "type": "string", "enumDescriptions": [ "The default value. This value is used if the action is omitted.", "The revision was generated by creating a deployment.", "The revision was generated by updating a deployment.", "The revision was deleted." ], "enum": [ "ACTION_UNSPECIFIED", "CREATE", "UPDATE", "DELETE" ] }, "state": { "description": "Output only. Current state of the revision.", "readOnly": true, "type": "string", "enumDescriptions": [ "The default value. This value is used if the state is omitted.", "The revision is being applied.", "The revision was applied successfully.", "The revision could not be applied successfully." ], "enum": [ "STATE_UNSPECIFIED", "APPLYING", "APPLIED", "FAILED" ] }, "applyResults": { "description": "Output only. Outputs and artifacts from applying a deployment.", "readOnly": true, "$ref": "ApplyResults" }, "stateDetail": { "description": "Output only. Additional info regarding the current state.", "readOnly": true, "type": "string" }, "errorCode": { "description": "Output only. Code describing any errors that may have occurred.", "readOnly": true, "type": "string", "enumDescriptions": [ "No error code was specified.", "Cloud Build failed due to a permission issue.", "Cloud Build job associated with creating or updating a deployment could not be started.", "Cloud Build job associated with creating or updating a deployment was started but failed.", "quota validation failed for one or more resources in terraform configuration files.", "Failed to import values from an external source." ], "enum": [ "ERROR_CODE_UNSPECIFIED", "CLOUD_BUILD_PERMISSION_DENIED", "APPLY_BUILD_API_FAILED", "APPLY_BUILD_RUN_FAILED", "QUOTA_VALIDATION_FAILED", "EXTERNAL_VALUE_SOURCE_IMPORT_FAILED" ] }, "build": { "description": "Output only. Cloud Build instance UUID associated with this revision.", "readOnly": true, "type": "string" }, "logs": { "description": "Output only. Location of Revision operation logs in `gs://{bucket}/{object}` format.", "readOnly": true, "type": "string" }, "tfErrors": { "description": "Output only. Errors encountered when creating or updating this deployment. Errors are truncated to 10 entries, see `delete_results` and `error_logs` for full details.", "readOnly": true, "type": "array", "items": { "$ref": "TerraformError" } }, "errorLogs": { "description": "Output only. Location of Terraform error logs in Google Cloud Storage. Format: `gs://{bucket}/{object}`.", "readOnly": true, "type": "string" }, "serviceAccount": { "description": "Output only. User-specified Service Account (SA) to be used as credential to manage resources. Format: `projects/{projectID}/serviceAccounts/{serviceAccount}`", "readOnly": true, "type": "string" }, "importExistingResources": { "description": "Output only. By default, Infra Manager will return a failure when Terraform encounters a 409 code (resource conflict error) during actuation. If this flag is set to true, Infra Manager will instead attempt to automatically import the resource into the Terraform state (for supported resource types) and continue actuation. Not all resource types are supported, refer to documentation.", "readOnly": true, "type": "boolean" }, "workerPool": { "description": "Output only. The user-specified Cloud Build worker pool resource in which the Cloud Build job will execute. Format: `projects/{project}/locations/{location}/workerPools/{workerPoolId}`. If this field is unspecified, the default Cloud Build worker pool will be used.", "readOnly": true, "type": "string" }, "tfVersionConstraint": { "description": "Output only. The user-specified Terraform version constraint. Example: \"=1.3.10\".", "readOnly": true, "type": "string" }, "tfVersion": { "description": "Output only. The version of Terraform used to create the Revision. It is in the format of \"Major.Minor.Patch\", for example, \"1.3.10\".", "readOnly": true, "type": "string" }, "quotaValidationResults": { "description": "Output only. Cloud Storage path containing quota validation results. This field is set when a user sets Deployment.quota_validation field to ENABLED or ENFORCED. Format: `gs://{bucket}/{object}`.", "readOnly": true, "type": "string" }, "quotaValidation": { "description": "Optional. Input to control quota checks for resources in terraform configuration files. There are limited resources on which quota validation applies.", "type": "string", "enumDescriptions": [ "The default value. QuotaValidation on terraform configuration files will be disabled in this case.", "Enable computing quotas for resources in terraform configuration files to get visibility on resources with insufficient quotas.", "Enforce quota checks so deployment fails if there isn't sufficient quotas available to deploy resources in terraform configuration files." ], "enum": [ "QUOTA_VALIDATION_UNSPECIFIED", "ENABLED", "ENFORCED" ] }, "providerConfig": { "description": "Output only. This field specifies the provider configurations.", "readOnly": true, "$ref": "ProviderConfig" } } }, "Resource": { "id": "Resource", "description": "Resource represents a Google Cloud Platform resource actuated by IM. Resources are child resources of Revisions.", "type": "object", "properties": { "name": { "description": "Output only. Resource name. Format: `projects/{project}/locations/{location}/deployments/{deployment}/revisions/{revision}/resources/{resource}`", "readOnly": true, "type": "string" }, "terraformInfo": { "description": "Output only. Terraform-specific info if this resource was created using Terraform.", "readOnly": true, "$ref": "ResourceTerraformInfo" }, "caiAssets": { "description": "Output only. Map of Cloud Asset Inventory (CAI) type to CAI info (e.g. CAI ID). CAI type format follows https://cloud.google.com/asset-inventory/docs/supported-asset-types", "readOnly": true, "type": "object", "additionalProperties": { "$ref": "ResourceCAIInfo" } }, "intent": { "description": "Output only. Intent of the resource.", "readOnly": true, "type": "string", "enumDescriptions": [ "The default value. This value is used if the intent is omitted.", "Infra Manager will create this Resource.", "Infra Manager will update this Resource.", "Infra Manager will delete this Resource.", "Infra Manager will destroy and recreate this Resource.", "Infra Manager will leave this Resource untouched." ], "enum": [ "INTENT_UNSPECIFIED", "CREATE", "UPDATE", "DELETE", "RECREATE", "UNCHANGED" ] }, "state": { "description": "Output only. Current state of the resource.", "readOnly": true, "type": "string", "enumDescriptions": [ "The default value. This value is used if the state is omitted.", "Resource has been planned for reconcile.", "Resource is actively reconciling into the intended state.", "Resource has reconciled to intended state.", "Resource failed to reconcile." ], "enum": [ "STATE_UNSPECIFIED", "PLANNED", "IN_PROGRESS", "RECONCILED", "FAILED" ] } } }, "ResourceTerraformInfo": { "id": "ResourceTerraformInfo", "description": "Terraform info of a Resource.", "type": "object", "properties": { "address": { "description": "TF resource address that uniquely identifies this resource within this deployment.", "type": "string" }, "type": { "description": "TF resource type", "type": "string" }, "id": { "description": "ID attribute of the TF resource", "type": "string" } } }, "ResourceCAIInfo": { "id": "ResourceCAIInfo", "description": "CAI info of a Resource.", "type": "object", "properties": { "fullResourceName": { "description": "CAI resource name in the format following https://cloud.google.com/apis/design/resource_names#full_resource_name", "type": "string" } } }, "ListResourcesResponse": { "id": "ListResourcesResponse", "description": "A response to a 'ListResources' call. Contains a list of Resources.", "type": "object", "properties": { "resources": { "description": "List of Resources.", "type": "array", "items": { "$ref": "Resource" } }, "nextPageToken": { "description": "A token to request the next page of resources from the 'ListResources' method. The value of an empty string means that there are no more resources to return.", "type": "string" }, "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } } } }, "ExportDeploymentStatefileRequest": { "id": "ExportDeploymentStatefileRequest", "description": "A request to export a state file passed to a 'ExportDeploymentStatefile' call.", "type": "object", "properties": { "draft": { "description": "Optional. If this flag is set to true, the exported deployment state file will be the draft state. This will enable the draft file to be validated before copying it over to the working state on unlock.", "type": "boolean" } } }, "Statefile": { "id": "Statefile", "description": "Contains info about a Terraform state file", "type": "object", "properties": { "signedUri": { "description": "Output only. Cloud Storage signed URI used for downloading or uploading the state file.", "readOnly": true, "type": "string" } } }, "ExportRevisionStatefileRequest": { "id": "ExportRevisionStatefileRequest", "description": "A request to export a state file passed to a 'ExportRevisionStatefile' call.", "type": "object", "properties": {} }, "ImportStatefileRequest": { "id": "ImportStatefileRequest", "description": "A request to import a state file passed to a 'ImportStatefile' call.", "type": "object", "properties": { "lockId": { "description": "Required. Lock ID of the lock file to verify that the user who is importing the state file previously locked the Deployment.", "type": "string", "format": "int64" } } }, "DeleteStatefileRequest": { "id": "DeleteStatefileRequest", "description": "A request to delete a state file passed to a 'DeleteStatefile' call.", "type": "object", "properties": { "lockId": { "description": "Required. Lock ID of the lock file to verify that the user who is deleting the state file previously locked the Deployment.", "type": "string", "format": "int64" } } }, "LockDeploymentRequest": { "id": "LockDeploymentRequest", "description": "A request to lock a deployment passed to a 'LockDeployment' call.", "type": "object", "properties": {} }, "UnlockDeploymentRequest": { "id": "UnlockDeploymentRequest", "description": "A request to unlock a state file passed to a 'UnlockDeployment' call.", "type": "object", "properties": { "lockId": { "description": "Required. Lock ID of the lock file to be unlocked.", "type": "string", "format": "int64" } } }, "LockInfo": { "id": "LockInfo", "description": "Details about the lock which locked the deployment.", "type": "object", "properties": { "lockId": { "description": "Unique ID for the lock to be overridden with generation ID in the backend.", "type": "string", "format": "int64" }, "operation": { "description": "Terraform operation, provided by the caller.", "type": "string" }, "info": { "description": "Extra information to store with the lock, provided by the caller.", "type": "string" }, "who": { "description": "user@hostname when available", "type": "string" }, "version": { "description": "Terraform version", "type": "string" }, "createTime": { "description": "Time that the lock was taken.", "type": "string", "format": "google-datetime" } } }, "Preview": { "id": "Preview", "description": "A preview represents a set of actions Infra Manager would perform to move the resources towards the desired state as specified in the configuration.", "type": "object", "properties": { "terraformBlueprint": { "description": "The terraform blueprint to preview.", "$ref": "TerraformBlueprint" }, "name": { "description": "Identifier. Resource name of the preview. Resource name can be user provided or server generated ID if unspecified. Format: `projects/{project}/locations/{location}/previews/{preview}`", "type": "string" }, "createTime": { "description": "Output only. Time the preview was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "labels": { "description": "Optional. User-defined labels for the preview.", "type": "object", "additionalProperties": { "type": "string" } }, "state": { "description": "Output only. Current state of the preview.", "readOnly": true, "type": "string", "enumDescriptions": [ "The default value. This value is used if the state is unknown.", "The preview is being created.", "The preview has succeeded.", "The preview is being applied.", "The preview is stale. A preview can become stale if a revision has been applied after this preview was created.", "The preview is being deleted.", "The preview has encountered an unexpected error.", "The preview has been deleted." ], "enum": [ "STATE_UNSPECIFIED", "CREATING", "SUCCEEDED", "APPLYING", "STALE", "DELETING", "FAILED", "DELETED" ] }, "deployment": { "description": "Optional. Optional deployment reference. If specified, the preview will be performed using the provided deployment's current state and use any relevant fields from the deployment unless explicitly specified in the preview create request.", "type": "string" }, "previewMode": { "description": "Optional. Current mode of preview.", "type": "string", "enumDescriptions": [ "Unspecified policy, default mode will be used.", "DEFAULT mode generates an execution plan for reconciling current resource state into expected resource state.", "DELETE mode generates as execution plan for destroying current resources." ], "enum": [ "PREVIEW_MODE_UNSPECIFIED", "DEFAULT", "DELETE" ] }, "serviceAccount": { "description": "Required. User-specified Service Account (SA) credentials to be used when previewing resources. Format: `projects/{projectID}/serviceAccounts/{serviceAccount}`", "type": "string" }, "artifactsGcsBucket": { "description": "Optional. User-defined location of Cloud Build logs, artifacts, and in Google Cloud Storage. Format: `gs://{bucket}/{folder}` A default bucket will be bootstrapped if the field is not set or empty Default Bucket Format: `gs://--blueprint-config` Constraints: - The bucket needs to be in the same project as the deployment - The path cannot be within the path of `gcs_source` If omitted and deployment resource ref provided has artifacts_gcs_bucket defined, that artifact bucket is used.", "type": "string" }, "workerPool": { "description": "Optional. The user-specified Worker Pool resource in which the Cloud Build job will execute. Format projects/{project}/locations/{location}/workerPools/{workerPoolId} If this field is unspecified, the default Cloud Build worker pool will be used. If omitted and deployment resource ref provided has worker_pool defined, that worker pool is used.", "type": "string" }, "errorCode": { "description": "Output only. Code describing any errors that may have occurred.", "readOnly": true, "type": "string", "enumDescriptions": [ "No error code was specified.", "Cloud Build failed due to a permissions issue.", "Cloud Storage bucket failed to create due to a permissions issue.", "Cloud Storage bucket failed for a non-permissions-related issue.", "Acquiring lock on provided deployment reference failed.", "Preview encountered an error when trying to access Cloud Build API.", "Preview created a build but build failed and logs were generated.", "Failed to import values from an external source." ], "enum": [ "ERROR_CODE_UNSPECIFIED", "CLOUD_BUILD_PERMISSION_DENIED", "BUCKET_CREATION_PERMISSION_DENIED", "BUCKET_CREATION_FAILED", "DEPLOYMENT_LOCK_ACQUIRE_FAILED", "PREVIEW_BUILD_API_FAILED", "PREVIEW_BUILD_RUN_FAILED", "EXTERNAL_VALUE_SOURCE_IMPORT_FAILED" ] }, "errorStatus": { "description": "Output only. Additional information regarding the current state.", "readOnly": true, "$ref": "Status" }, "build": { "description": "Output only. Cloud Build instance UUID associated with this preview.", "readOnly": true, "type": "string" }, "tfErrors": { "description": "Output only. Summary of errors encountered during Terraform preview. It has a size limit of 10, i.e. only top 10 errors will be summarized here.", "readOnly": true, "type": "array", "items": { "$ref": "TerraformError" } }, "errorLogs": { "description": "Output only. Link to tf-error.ndjson file, which contains the full list of the errors encountered during a Terraform preview. Format: `gs://{bucket}/{object}`.", "readOnly": true, "type": "string" }, "previewArtifacts": { "description": "Output only. Artifacts from preview.", "readOnly": true, "$ref": "PreviewArtifacts" }, "logs": { "description": "Output only. Location of preview logs in `gs://{bucket}/{object}` format.", "readOnly": true, "type": "string" }, "tfVersion": { "description": "Output only. The current Terraform version set on the preview. It is in the format of \"Major.Minor.Patch\", for example, \"1.3.10\".", "readOnly": true, "type": "string" }, "tfVersionConstraint": { "description": "Optional. The user-specified Terraform version constraint. Example: \"=1.3.10\".", "type": "string" }, "annotations": { "description": "Optional. Arbitrary key-value metadata storage e.g. to help client tools identify preview during automation. See https://google.aip.dev/148#annotations for details on format and size limitations.", "type": "object", "additionalProperties": { "type": "string" } }, "providerConfig": { "description": "Optional. This field specifies the provider configurations.", "$ref": "ProviderConfig" } } }, "PreviewArtifacts": { "id": "PreviewArtifacts", "description": "Artifacts created by preview.", "type": "object", "properties": { "content": { "description": "Output only. Location of a blueprint copy and other content in Google Cloud Storage. Format: `gs://{bucket}/{object}`", "readOnly": true, "type": "string" }, "artifacts": { "description": "Output only. Location of artifacts in Google Cloud Storage. Format: `gs://{bucket}/{object}`", "readOnly": true, "type": "string" } } }, "ListPreviewsResponse": { "id": "ListPreviewsResponse", "description": "A response to a `ListPreviews` call. Contains a list of Previews.", "type": "object", "properties": { "previews": { "description": "List of Previews.", "type": "array", "items": { "$ref": "Preview" } }, "nextPageToken": { "description": "Token to be supplied to the next ListPreviews request via `page_token` to obtain the next set of results.", "type": "string" }, "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } } } }, "ExportPreviewResultRequest": { "id": "ExportPreviewResultRequest", "description": "A request to export preview results.", "type": "object", "properties": {} }, "ExportPreviewResultResponse": { "id": "ExportPreviewResultResponse", "description": "A response to `ExportPreviewResult` call. Contains preview results.", "type": "object", "properties": { "result": { "description": "Output only. Signed URLs for accessing the plan files.", "readOnly": true, "$ref": "PreviewResult" } } }, "PreviewResult": { "id": "PreviewResult", "description": "Contains a signed Cloud Storage URLs.", "type": "object", "properties": { "binarySignedUri": { "description": "Output only. Plan binary signed URL", "readOnly": true, "type": "string" }, "jsonSignedUri": { "description": "Output only. Plan JSON signed URL", "readOnly": true, "type": "string" } } }, "ListTerraformVersionsResponse": { "id": "ListTerraformVersionsResponse", "description": "The response message for the `ListTerraformVersions` method.", "type": "object", "properties": { "terraformVersions": { "description": "List of TerraformVersions.", "type": "array", "items": { "$ref": "TerraformVersion" } }, "nextPageToken": { "description": "Token to be supplied to the next ListTerraformVersions request via `page_token` to obtain the next set of results.", "type": "string" }, "unreachable": { "description": "Unreachable resources, if any.", "type": "array", "items": { "type": "string" } } } }, "TerraformVersion": { "id": "TerraformVersion", "description": "A TerraformVersion represents the support state the corresponding Terraform version.", "type": "object", "properties": { "name": { "description": "Identifier. The version name is in the format: 'projects/{project_id}/locations/{location}/terraformVersions/{terraform_version}'.", "type": "string" }, "state": { "description": "Output only. The state of the version, ACTIVE, DEPRECATED or OBSOLETE.", "readOnly": true, "type": "string", "enumDescriptions": [ "The default value. This value is used if the state is omitted.", "The version is actively supported.", "The version is deprecated.", "The version is obsolete." ], "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "DEPRECATED", "OBSOLETE" ] }, "supportTime": { "description": "Output only. When the version is supported.", "readOnly": true, "type": "string", "format": "google-datetime" }, "deprecateTime": { "description": "Output only. When the version is deprecated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "obsoleteTime": { "description": "Output only. When the version is obsolete.", "readOnly": true, "type": "string", "format": "google-datetime" } } }, "ListResourceChangesResponse": { "id": "ListResourceChangesResponse", "description": "A response to a 'ListResourceChanges' call. Contains a list of ResourceChanges.", "type": "object", "properties": { "resourceChanges": { "description": "List of ResourceChanges.", "type": "array", "items": { "$ref": "ResourceChange" } }, "nextPageToken": { "description": "A token to request the next page of resources from the 'ListResourceChanges' method. The value of an empty string means that there are no more resources to return.", "type": "string" }, "unreachable": { "description": "Unreachable resources, if any.", "type": "array", "items": { "type": "string" } } } }, "ResourceChange": { "id": "ResourceChange", "description": "A resource change represents a change to a resource in the state file.", "type": "object", "properties": { "name": { "description": "Identifier. The name of the resource change. Format: 'projects/{project_id}/locations/{location}/previews/{preview}/resourceChanges/{resource_change}'.", "type": "string" }, "terraformInfo": { "description": "Output only. Terraform info of the resource change.", "readOnly": true, "$ref": "ResourceChangeTerraformInfo" }, "intent": { "description": "Output only. The intent of the resource change.", "readOnly": true, "type": "string", "enumDescriptions": [ "The default value.", "The resource will be created.", "The resource will be updated.", "The resource will be deleted.", "The resource will be recreated.", "The resource will be untouched." ], "enum": [ "INTENT_UNSPECIFIED", "CREATE", "UPDATE", "DELETE", "RECREATE", "UNCHANGED" ] }, "propertyChanges": { "description": "Output only. The property changes of the resource change.", "readOnly": true, "type": "array", "items": { "$ref": "PropertyChange" } } } }, "ResourceChangeTerraformInfo": { "id": "ResourceChangeTerraformInfo", "description": "Terraform info of a ResourceChange.", "type": "object", "properties": { "address": { "description": "Output only. TF resource address that uniquely identifies the resource.", "readOnly": true, "type": "string" }, "type": { "description": "Output only. TF resource type.", "readOnly": true, "type": "string" }, "resourceName": { "description": "Output only. TF resource name.", "readOnly": true, "type": "string" }, "provider": { "description": "Output only. TF resource provider.", "readOnly": true, "type": "string" }, "actions": { "description": "Output only. TF resource actions.", "readOnly": true, "type": "array", "items": { "type": "string" } } } }, "PropertyChange": { "id": "PropertyChange", "description": "A property change represents a change to a property in the state file.", "type": "object", "properties": { "path": { "description": "Output only. The path of the property change.", "readOnly": true, "type": "string" }, "beforeSensitivePaths": { "description": "Output only. The paths of sensitive fields in `before`. Paths are relative to `path`.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "before": { "description": "Output only. Representations of the object value before the actions.", "readOnly": true, "type": "any" }, "afterSensitivePaths": { "description": "Output only. The paths of sensitive fields in `after`. Paths are relative to `path`.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "after": { "description": "Output only. Representations of the object value after the actions.", "readOnly": true, "type": "any" } } }, "ListResourceDriftsResponse": { "id": "ListResourceDriftsResponse", "description": "A response to a 'ListResourceDrifts' call. Contains a list of ResourceDrifts.", "type": "object", "properties": { "resourceDrifts": { "description": "List of ResourceDrifts.", "type": "array", "items": { "$ref": "ResourceDrift" } }, "nextPageToken": { "description": "A token to request the next page of resources from the 'ListResourceDrifts' method. The value of an empty string means that there are no more resources to return.", "type": "string" }, "unreachable": { "description": "Unreachable resources, if any.", "type": "array", "items": { "type": "string" } } } }, "ResourceDrift": { "id": "ResourceDrift", "description": "A resource drift represents a drift to a resource in the state file.", "type": "object", "properties": { "name": { "description": "Identifier. The name of the resource drift. Format: 'projects/{project_id}/locations/{location}/previews/{preview}/resourceDrifts/{resource_drift}'.", "type": "string" }, "terraformInfo": { "description": "Output only. Terraform info of the resource drift.", "readOnly": true, "$ref": "ResourceDriftTerraformInfo" }, "propertyDrifts": { "description": "Output only. The property drifts of the resource drift.", "readOnly": true, "type": "array", "items": { "$ref": "PropertyDrift" } } } }, "ResourceDriftTerraformInfo": { "id": "ResourceDriftTerraformInfo", "description": "Terraform info of a ResourceChange.", "type": "object", "properties": { "address": { "description": "Output only. The address of the drifted resource.", "readOnly": true, "type": "string" }, "type": { "description": "Output only. The type of the drifted resource.", "readOnly": true, "type": "string" }, "resourceName": { "description": "Output only. TF resource name.", "readOnly": true, "type": "string" }, "provider": { "description": "Output only. The provider of the drifted resource.", "readOnly": true, "type": "string" } } }, "PropertyDrift": { "id": "PropertyDrift", "description": "A property drift represents a drift to a property in the state file.", "type": "object", "properties": { "path": { "description": "Output only. The path of the property drift.", "readOnly": true, "type": "string" }, "beforeSensitivePaths": { "description": "Output only. The paths of sensitive fields in `before`. Paths are relative to `path`.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "before": { "description": "Output only. Representations of the object value before the actions.", "readOnly": true, "type": "any" }, "afterSensitivePaths": { "description": "Output only. The paths of sensitive fields in `after`. Paths are relative to `path`.", "readOnly": true, "type": "array", "items": { "type": "string" } }, "after": { "description": "Output only. Representations of the object value after the actions.", "readOnly": true, "type": "any" } } }, "AutoMigrationConfig": { "id": "AutoMigrationConfig", "description": "AutoMigrationConfig contains the automigration configuration for a project.", "type": "object", "properties": { "name": { "description": "Identifier. The name of the AutoMigrationConfig. Format: 'projects/{project_id}/locations/{location}/AutoMigrationConfig'.", "type": "string" }, "updateTime": { "description": "Output only. Time the AutoMigrationConfig was last updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "autoMigrationEnabled": { "description": "Optional. Whether the auto migration is enabled for the project.", "type": "boolean" } } }, "DeploymentGroup": { "id": "DeploymentGroup", "description": "A DeploymentGroup is a collection of DeploymentUnits that in a DAG-like structure.", "type": "object", "properties": { "name": { "description": "Identifier. The name of the deployment group. Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'.", "type": "string" }, "createTime": { "description": "Output only. Time when the deployment group was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "updateTime": { "description": "Output only. Time when the deployment group was last updated.", "readOnly": true, "type": "string", "format": "google-datetime" }, "labels": { "description": "Optional. User-defined metadata for the deployment group.", "type": "object", "additionalProperties": { "type": "string" } }, "annotations": { "description": "Optional. Arbitrary key-value metadata storage e.g. to help client tools identify deployment group during automation. See https://google.aip.dev/148#annotations for details on format and size limitations.", "type": "object", "additionalProperties": { "type": "string" } }, "state": { "description": "Output only. Current state of the deployment group.", "readOnly": true, "type": "string", "enumDescriptions": [ "The default value. This value is used if the state is omitted.", "The deployment group is being created.", "The deployment group is healthy.", "The deployment group is being updated.", "The deployment group is being deleted.", "The deployment group has encountered an unexpected error.", "The deployment group is no longer being actively reconciled. This may be the result of recovering the project after deletion.", "The deployment group has been deleted." ], "enum": [ "STATE_UNSPECIFIED", "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED", "SUSPENDED", "DELETED" ] }, "stateDescription": { "description": "Output only. Additional information regarding the current state.", "readOnly": true, "type": "string" }, "deploymentUnits": { "description": "The deployment units of the deployment group in a DAG like structure. When a deployment group is being provisioned, the deployment units are deployed in a DAG order. The provided units must be in a DAG order, otherwise an error will be returned.", "type": "array", "items": { "$ref": "DeploymentUnit" } }, "provisioningState": { "description": "Output only. The provisioning state of the deployment group.", "readOnly": true, "type": "string", "enumDescriptions": [ "Unspecified provisioning state.", "The deployment group is being provisioned.", "The deployment group is provisioned.", "The deployment group failed to be provisioned.", "The deployment group is being deprovisioned.", "The deployment group is deprovisioned.", "The deployment group failed to be deprovisioned." ], "enum": [ "PROVISIONING_STATE_UNSPECIFIED", "PROVISIONING", "PROVISIONED", "FAILED_TO_PROVISION", "DEPROVISIONING", "DEPROVISIONED", "FAILED_TO_DEPROVISION" ] }, "provisioningStateDescription": { "description": "Output only. Additional information regarding the current provisioning state.", "readOnly": true, "type": "string" }, "provisioningError": { "description": "Output only. The error status of the deployment group provisioning or deprovisioning.", "readOnly": true, "$ref": "Status" } } }, "DeploymentUnit": { "id": "DeploymentUnit", "description": "A DeploymentUnit is a container for a deployment and its dependencies. An existing deployment can be provided directly in the unit, or the unit can act as a placeholder to define the DAG, with the deployment specs supplied in a `provisionDeploymentRequest`.", "type": "object", "properties": { "id": { "description": "The id of the deployment unit. Must be unique within the deployment group.", "type": "string" }, "deployment": { "description": "Optional. The name of the deployment to be provisioned. Format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.", "type": "string" }, "dependencies": { "description": "Required. The IDs of the deployment units within the deployment group that this unit depends on.", "type": "array", "items": { "type": "string" } } } }, "ListDeploymentGroupsResponse": { "id": "ListDeploymentGroupsResponse", "description": "The response message for the ListDeploymentGroups method.", "type": "object", "properties": { "deploymentGroups": { "description": "The deployment groups from the specified collection.", "type": "array", "items": { "$ref": "DeploymentGroup" } }, "nextPageToken": { "description": "Token to be supplied to the next ListDeploymentGroups request via `page_token` to obtain the next set of results.", "type": "string" }, "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } } } }, "ProvisionDeploymentGroupRequest": { "id": "ProvisionDeploymentGroupRequest", "description": "The request message for the ProvisionDeploymentGroup method.", "type": "object", "properties": { "deploymentSpecs": { "description": "Optional. The deployment specs of the deployment units to be created within the same project and location of the deployment group. The key is the unit ID, and the value is the `DeploymentSpec`. Provisioning will fail if a `deployment_spec` has a `deployment_id` that matches an existing deployment in the same project and location. If an existing deployment was part of the last successful revision but is no longer in the current DeploymentGroup's `deployment_units`, it will be recreated if included in `deployment_specs`.", "type": "object", "additionalProperties": { "$ref": "DeploymentSpec" } } } }, "DeploymentSpec": { "id": "DeploymentSpec", "description": "Spec for a deployment to be created.", "type": "object", "properties": { "deploymentId": { "description": "Required. The id of the deployment to be created which doesn't include the project id and location.", "type": "string" }, "deployment": { "description": "Required. The deployment to be created.", "$ref": "Deployment" } } }, "DeprovisionDeploymentGroupRequest": { "id": "DeprovisionDeploymentGroupRequest", "description": "The request message for the DeprovisionDeploymentGroup method.", "type": "object", "properties": { "force": { "description": "Optional. If set to true, this option is propagated to the deletion of each deployment in the group. This corresponds to the 'force' field in DeleteDeploymentRequest.", "type": "boolean" }, "deletePolicy": { "description": "Optional. Policy on how resources within each deployment should be handled during deletion. This policy is applied globally to the deletion of all deployments in this group. This corresponds to the 'delete_policy' field in DeleteDeploymentRequest.", "type": "string", "enumDescriptions": [ "Unspecified policy, resources will be deleted.", "Deletes resources actuated by the deployment.", "Abandons resources and only deletes the deployment and its metadata." ], "enum": [ "DELETE_POLICY_UNSPECIFIED", "DELETE", "ABANDON" ] } } }, "DeploymentGroupRevision": { "id": "DeploymentGroupRevision", "description": "A DeploymentGroupRevision represents a snapshot of a DeploymentGroup at a given point in time, created when a DeploymentGroup is provisioned or deprovisioned.", "type": "object", "properties": { "name": { "description": "Identifier. The name of the deployment group revision. Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}/revisions/{revision}'.", "type": "string" }, "snapshot": { "description": "Output only. The snapshot of the deployment group at this revision.", "readOnly": true, "$ref": "DeploymentGroup" }, "createTime": { "description": "Output only. Time when the deployment group revision was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "alternativeIds": { "description": "Output only. The alternative IDs of the deployment group revision.", "readOnly": true, "type": "array", "items": { "type": "string" } } } }, "ListDeploymentGroupRevisionsResponse": { "id": "ListDeploymentGroupRevisionsResponse", "description": "The response message for the ListDeploymentGroupRevisions method.", "type": "object", "properties": { "deploymentGroupRevisions": { "description": "The deployment group revisions from the specified collection.", "type": "array", "items": { "$ref": "DeploymentGroupRevision" } }, "nextPageToken": { "description": "Token to be supplied to the next ListDeploymentGroupRevisions request via `page_token` to obtain the next set of results.", "type": "string" }, "unreachable": { "description": "Unordered list. Locations that could not be reached.", "type": "array", "items": { "type": "string" } } } }, "ListLocationsResponse": { "id": "ListLocationsResponse", "description": "The response message for Locations.ListLocations.", "type": "object", "properties": { "locations": { "description": "A list of locations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "Location" } }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } } }, "Location": { "id": "Location", "description": "A resource that represents a Google Cloud location.", "type": "object", "properties": { "name": { "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", "type": "string" }, "locationId": { "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" }, "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, "labels": { "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "type": "object", "additionalProperties": { "type": "string" } }, "metadata": { "description": "Service-specific metadata. For example the available capacity at the given location.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } }, "SetIamPolicyRequest": { "id": "SetIamPolicyRequest", "description": "Request message for `SetIamPolicy` method.", "type": "object", "properties": { "policy": { "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.", "$ref": "Policy" }, "updateMask": { "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`", "type": "string", "format": "google-fieldmask" } } }, "Policy": { "id": "Policy", "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time \u003c timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time \u003c timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", "type": "object", "properties": { "version": { "description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "type": "integer", "format": "int32" }, "bindings": { "description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.", "type": "array", "items": { "$ref": "Binding" } }, "auditConfigs": { "description": "Specifies cloud audit logging configuration for this policy.", "type": "array", "items": { "$ref": "AuditConfig" } }, "etag": { "description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", "type": "string", "format": "byte" } } }, "Binding": { "id": "Binding", "description": "Associates `members`, or principals, with a `role`.", "type": "object", "properties": { "role": { "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).", "type": "string" }, "members": { "description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", "type": "array", "items": { "type": "string" } }, "condition": { "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "$ref": "Expr" } } }, "Expr": { "id": "Expr", "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() \u003c 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", "type": "object", "properties": { "expression": { "description": "Textual representation of an expression in Common Expression Language syntax.", "type": "string" }, "title": { "description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", "type": "string" }, "description": { "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", "type": "string" }, "location": { "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", "type": "string" } } }, "AuditConfig": { "id": "AuditConfig", "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.", "type": "object", "properties": { "service": { "description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.", "type": "string" }, "auditLogConfigs": { "description": "The configuration for logging of each type of permission.", "type": "array", "items": { "$ref": "AuditLogConfig" } } } }, "AuditLogConfig": { "id": "AuditLogConfig", "description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.", "type": "object", "properties": { "logType": { "description": "The log type that this config enables.", "type": "string", "enumDescriptions": [ "Default case. Should never be this.", "Admin reads. Example: CloudIAM getIamPolicy", "Data writes. Example: CloudSQL Users create", "Data reads. Example: CloudSQL Users list" ], "enum": [ "LOG_TYPE_UNSPECIFIED", "ADMIN_READ", "DATA_WRITE", "DATA_READ" ] }, "exemptedMembers": { "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", "type": "array", "items": { "type": "string" } } } }, "TestIamPermissionsRequest": { "id": "TestIamPermissionsRequest", "description": "Request message for `TestIamPermissions` method.", "type": "object", "properties": { "permissions": { "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", "type": "array", "items": { "type": "string" } } } }, "TestIamPermissionsResponse": { "id": "TestIamPermissionsResponse", "description": "Response message for `TestIamPermissions` method.", "type": "object", "properties": { "permissions": { "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", "type": "array", "items": { "type": "string" } } } }, "OperationMetadata": { "id": "OperationMetadata", "description": "Represents the metadata of the long-running operation.", "type": "object", "properties": { "deploymentMetadata": { "description": "Output only. Metadata about the deployment operation state.", "readOnly": true, "$ref": "DeploymentOperationMetadata" }, "previewMetadata": { "description": "Output only. Metadata about the preview operation state.", "readOnly": true, "$ref": "PreviewOperationMetadata" }, "provisionDeploymentGroupMetadata": { "description": "Output only. Metadata about ProvisionDeploymentGroup operation state.", "readOnly": true, "$ref": "ProvisionDeploymentGroupOperationMetadata" }, "createTime": { "description": "Output only. Time when the operation was created.", "readOnly": true, "type": "string", "format": "google-datetime" }, "endTime": { "description": "Output only. Time when the operation finished running.", "readOnly": true, "type": "string", "format": "google-datetime" }, "target": { "description": "Output only. Server-defined resource path for the target of the operation.", "readOnly": true, "type": "string" }, "verb": { "description": "Output only. Name of the verb executed by the operation.", "readOnly": true, "type": "string" }, "statusMessage": { "description": "Output only. Human-readable status of the operation, if any.", "readOnly": true, "type": "string" }, "requestedCancellation": { "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "readOnly": true, "type": "boolean" }, "apiVersion": { "description": "Output only. API version used to start the operation.", "readOnly": true, "type": "string" } } }, "DeploymentOperationMetadata": { "id": "DeploymentOperationMetadata", "description": "Ephemeral metadata content describing the state of a deployment operation.", "type": "object", "properties": { "step": { "description": "The current step the deployment operation is running.", "type": "string", "enumDescriptions": [ "Unspecified deployment step", "Infra Manager is creating a Google Cloud Storage bucket to store artifacts and metadata about the deployment and revision", "Downloading the blueprint onto the Google Cloud Storage bucket", "Initializing Terraform using `terraform init`", "Running `terraform plan`", "Actuating resources using Terraform using `terraform apply`", "Destroying resources using Terraform using `terraform destroy`", "Validating the uploaded TF state file when unlocking a deployment", "Unlocking a deployment", "Operation was successful", "Operation failed", "Validating the provided repository.", "Running quota validation" ], "enum": [ "DEPLOYMENT_STEP_UNSPECIFIED", "PREPARING_STORAGE_BUCKET", "DOWNLOADING_BLUEPRINT", "RUNNING_TF_INIT", "RUNNING_TF_PLAN", "RUNNING_TF_APPLY", "RUNNING_TF_DESTROY", "RUNNING_TF_VALIDATE", "UNLOCKING_DEPLOYMENT", "SUCCEEDED", "FAILED", "VALIDATING_REPOSITORY", "RUNNING_QUOTA_VALIDATION" ] }, "applyResults": { "description": "Outputs and artifacts from applying a deployment.", "$ref": "ApplyResults" }, "build": { "description": "Output only. Cloud Build instance UUID associated with this operation.", "readOnly": true, "type": "string" }, "logs": { "description": "Output only. Location of Deployment operations logs in `gs://{bucket}/{object}` format.", "readOnly": true, "type": "string" } } }, "PreviewOperationMetadata": { "id": "PreviewOperationMetadata", "description": "Ephemeral metadata content describing the state of a preview operation.", "type": "object", "properties": { "step": { "description": "The current step the preview operation is running.", "type": "string", "enumDescriptions": [ "Unspecified preview step.", "Infra Manager is creating a Google Cloud Storage bucket to store artifacts and metadata about the preview.", "Downloading the blueprint onto the Google Cloud Storage bucket.", "Initializing Terraform using `terraform init`.", "Running `terraform plan`.", "Fetching a deployment.", "Locking a deployment.", "Unlocking a deployment.", "Operation was successful.", "Operation failed.", "Validating the provided repository." ], "enum": [ "PREVIEW_STEP_UNSPECIFIED", "PREPARING_STORAGE_BUCKET", "DOWNLOADING_BLUEPRINT", "RUNNING_TF_INIT", "RUNNING_TF_PLAN", "FETCHING_DEPLOYMENT", "LOCKING_DEPLOYMENT", "UNLOCKING_DEPLOYMENT", "SUCCEEDED", "FAILED", "VALIDATING_REPOSITORY" ] }, "previewArtifacts": { "description": "Artifacts from preview.", "$ref": "PreviewArtifacts" }, "logs": { "description": "Output only. Location of preview logs in `gs://{bucket}/{object}` format.", "readOnly": true, "type": "string" }, "build": { "description": "Output only. Cloud Build instance UUID associated with this preview.", "readOnly": true, "type": "string" } } }, "ProvisionDeploymentGroupOperationMetadata": { "id": "ProvisionDeploymentGroupOperationMetadata", "description": "Operation metadata for `ProvisionDeploymentGroup` and `DeprovisionDeploymentGroup` long-running operations.", "type": "object", "properties": { "step": { "description": "Output only. The current step of the deployment group operation.", "readOnly": true, "type": "string", "enumDescriptions": [ "Unspecified step.", "Validating the deployment group.", "Locking the deployments to the deployment group for atomic actuation.", "Provisioning the deployment units.", "Unlocking the deployments from the deployment group after actuation.", "The operation has succeeded.", "The operation has failed.", "Deprovisioning the deployment units." ], "enum": [ "PROVISION_DEPLOYMENT_GROUP_STEP_UNSPECIFIED", "VALIDATING_DEPLOYMENT_GROUP", "ASSOCIATING_DEPLOYMENTS_TO_DEPLOYMENT_GROUP", "PROVISIONING_DEPLOYMENT_UNITS", "DISASSOCIATING_DEPLOYMENTS_FROM_DEPLOYMENT_GROUP", "SUCCEEDED", "FAILED", "DEPROVISIONING_DEPLOYMENT_UNITS" ] }, "deploymentUnitProgresses": { "description": "Output only. Progress information for each deployment unit within the operation.", "readOnly": true, "type": "array", "items": { "$ref": "DeploymentUnitProgress" } } } }, "DeploymentUnitProgress": { "id": "DeploymentUnitProgress", "description": "The progress of a deployment unit provisioning or deprovisioning.", "type": "object", "properties": { "unitId": { "description": "Output only. The unit id of the deployment unit to be provisioned.", "readOnly": true, "type": "string" }, "deployment": { "description": "Output only. The name of the deployment to be provisioned. Format: 'projects/{project}/locations/{location}/deployments/{deployment}'.", "readOnly": true, "type": "string" }, "state": { "description": "Output only. The current step of the deployment unit provisioning.", "readOnly": true, "type": "string", "enumDescriptions": [ "The default value. This value is unused.", "The deployment unit is queued for deployment creation or update.", "The underlying deployment of the unit is being created or updated.", "The underlying deployment operation of the unit has succeeded.", "The underlying deployment operation of the unit has failed.", "The deployment unit was aborted, likely due to failures in other dependent deployment units.", "The deployment unit was skipped because there were no changes to apply.", "The deployment is being deleted.", "The deployment is being previewed." ], "enum": [ "STATE_UNSPECIFIED", "QUEUED", "APPLYING_DEPLOYMENT", "SUCCEEDED", "FAILED", "ABORTED", "SKIPPED", "DELETING_DEPLOYMENT", "PREVIEWING_DEPLOYMENT" ] }, "stateDescription": { "description": "Output only. Additional information regarding the current state.", "readOnly": true, "type": "string" }, "deploymentOperationSummary": { "description": "Output only. The summary of the deployment operation.", "readOnly": true, "$ref": "DeploymentOperationSummary" }, "error": { "description": "Output only. Holds the error status of the deployment unit provisioning.", "readOnly": true, "$ref": "Status" }, "intent": { "description": "Output only. The intent of the deployment unit.", "readOnly": true, "type": "string", "enumDescriptions": [ "Unspecified intent.", "Create deployment in the unit from the deployment spec.", "Update deployment in the unit.", "Delete deployment in the unit.", "Recreate deployment in the unit.", "Delete deployment in latest successful revision while no longer referenced in any deployment unit in the current deployment group.", "Expected to be unchanged." ], "enum": [ "INTENT_UNSPECIFIED", "CREATE_DEPLOYMENT", "UPDATE_DEPLOYMENT", "DELETE_DEPLOYMENT", "RECREATE_DEPLOYMENT", "CLEAN_UP", "UNCHANGED" ] } } }, "DeploymentOperationSummary": { "id": "DeploymentOperationSummary", "description": "The summary of the deployment operation.", "type": "object", "properties": { "deploymentStep": { "description": "Output only. The current step the deployment operation is running.", "readOnly": true, "type": "string", "enumDescriptions": [ "Unspecified deployment step", "Infra Manager is creating a Google Cloud Storage bucket to store artifacts and metadata about the deployment and revision", "Downloading the blueprint onto the Google Cloud Storage bucket", "Initializing Terraform using `terraform init`", "Running `terraform plan`", "Actuating resources using Terraform using `terraform apply`", "Destroying resources using Terraform using `terraform destroy`", "Validating the uploaded TF state file when unlocking a deployment", "Unlocking a deployment", "Operation was successful", "Operation failed", "Validating the provided repository.", "Running quota validation" ], "enum": [ "DEPLOYMENT_STEP_UNSPECIFIED", "PREPARING_STORAGE_BUCKET", "DOWNLOADING_BLUEPRINT", "RUNNING_TF_INIT", "RUNNING_TF_PLAN", "RUNNING_TF_APPLY", "RUNNING_TF_DESTROY", "RUNNING_TF_VALIDATE", "UNLOCKING_DEPLOYMENT", "SUCCEEDED", "FAILED", "VALIDATING_REPOSITORY", "RUNNING_QUOTA_VALIDATION" ] }, "build": { "description": "Output only. Cloud Build instance UUID associated with this operation.", "readOnly": true, "type": "string" }, "logs": { "description": "Output only. Location of Deployment operations logs in `gs://{bucket}/{object}` format.", "readOnly": true, "type": "string" }, "content": { "description": "Output only. Location of Deployment operations content in `gs://{bucket}/{object}` format.", "readOnly": true, "type": "string" }, "artifacts": { "description": "Output only. Location of Deployment operations artifacts in `gs://{bucket}/{object}` format.", "readOnly": true, "type": "string" } } } }, "protocol": "rest", "baseUrl": "https://config.googleapis.com/", "ownerName": "Google", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "discoveryVersion": "v1", "basePath": "", "ownerDomain": "google.com", "title": "Infrastructure Manager API", "resources": { "projects": { "resources": { "locations": { "methods": { "getAutoMigrationConfig": { "id": "config.projects.locations.getAutoMigrationConfig", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autoMigrationConfig", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the AutoMigrationConfig. Format: 'projects/{project_id}/locations/{location}/AutoMigrationConfig'.", "pattern": "^projects/[^/]+/locations/[^/]+/autoMigrationConfig$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "AutoMigrationConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Get the AutoMigrationConfig for a given project and location." }, "updateAutoMigrationConfig": { "id": "config.projects.locations.updateAutoMigrationConfig", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autoMigrationConfig", "httpMethod": "PATCH", "parameters": { "name": { "description": "Identifier. The name of the AutoMigrationConfig. Format: 'projects/{project_id}/locations/{location}/AutoMigrationConfig'.", "pattern": "^projects/[^/]+/locations/[^/]+/autoMigrationConfig$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Optional. The update mask applies to the resource. See google.protobuf.FieldMask.", "location": "query", "type": "string", "format": "google-fieldmask" } }, "parameterOrder": [ "name" ], "request": { "$ref": "AutoMigrationConfig" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the AutoMigrationConfig for a given project and location." }, "list": { "id": "config.projects.locations.list", "path": "v1/{+name}/locations", "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "parameters": { "name": { "description": "The resource that owns the locations collection, if applicable.", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "location": "query", "type": "string" }, "pageSize": { "description": "The maximum number of results to return. If not set, the service selects a default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "location": "query", "type": "string" }, "extraLocationTypes": { "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "ListLocationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the [ListLocationsRequest.name] field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version." }, "get": { "id": "config.projects.locations.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Resource name for the location.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Location" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets information about a location." } }, "resources": { "operations": { "methods": { "list": { "id": "config.projects.locations.operations.list", "path": "v1/{+name}/operations", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation's parent resource.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "filter": { "description": "The standard list filter.", "location": "query", "type": "string" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "The standard list page token.", "location": "query", "type": "string" }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } }, "parameterOrder": [ "name" ], "response": { "$ref": "ListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "get": { "id": "config.projects.locations.operations.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "GET", "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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." }, "delete": { "id": "config.projects.locations.operations.delete", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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`." }, "cancel": { "id": "config.projects.locations.operations.cancel", "path": "v1/{+name}:cancel", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "httpMethod": "POST", "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "CancelOperationRequest" }, "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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`." } } }, "deployments": { "methods": { "list": { "id": "config.projects.locations.deployments.list", "path": "v1/{+parent}/deployments", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent in whose context the Deployments are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "When requesting a page of resources, 'page_size' specifies number of resources to return. If unspecified, at most 500 will be returned. The maximum value is 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Token returned by previous call to 'ListDeployments' which specifies the position in the list from where to continue listing the resources.", "location": "query", "type": "string" }, "filter": { "description": "Lists the Deployments that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '\u003c', '\u003e', '\u003c=', '\u003e=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name = \"projects/foo/locations/us-central1/deployments/bar - Filter by labels: - Resources that have a key called 'foo' labels.foo:* - Resources that have a key called 'foo' whose value is 'bar' labels.foo = bar - Filter by state: - Deployments in CREATING state. state=CREATING", "location": "query", "type": "string" }, "orderBy": { "description": "Field to use to sort the list.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListDeploymentsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists Deployments in a given project and location." }, "get": { "id": "config.projects.locations.deployments.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the deployment. Format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.", "pattern": "^projects/[^/]+/locations/[^/]+/deployments/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Deployment" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details about a Deployment." }, "create": { "id": "config.projects.locations.deployments.create", "path": "v1/{+parent}/deployments", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent in whose context the Deployment is created. The parent value is in the format: 'projects/{project_id}/locations/{location}'.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "deploymentId": { "description": "Required. The Deployment ID.", "location": "query", "type": "string" }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "Deployment" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a Deployment." }, "patch": { "id": "config.projects.locations.deployments.patch", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Identifier. Resource name of the deployment. Format: `projects/{project}/locations/{location}/deployments/{deployment}`", "pattern": "^projects/[^/]+/locations/[^/]+/deployments/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Optional. Field mask used to specify the fields to be overwritten in the Deployment resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", "location": "query", "type": "string", "format": "google-fieldmask" }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "Deployment" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates a Deployment." }, "delete": { "id": "config.projects.locations.deployments.delete", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the Deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.", "pattern": "^projects/[^/]+/locations/[^/]+/deployments/[^/]+$", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "force": { "description": "Optional. If set to true, any revisions for this deployment will also be deleted. (Otherwise, the request will only work if the deployment has no revisions.)", "location": "query", "type": "boolean" }, "deletePolicy": { "description": "Optional. Policy on how resources actuated by the deployment should be deleted. If unspecified, the default behavior is to delete the underlying resources.", "location": "query", "type": "string", "enumDescriptions": [ "Unspecified policy, resources will be deleted.", "Deletes resources actuated by the deployment.", "Abandons resources and only deletes the deployment and its metadata." ], "enum": [ "DELETE_POLICY_UNSPECIFIED", "DELETE", "ABANDON" ] } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a Deployment." }, "exportState": { "id": "config.projects.locations.deployments.exportState", "path": "v1/{+parent}:exportState", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}:exportState", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent in whose context the statefile is listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.", "pattern": "^projects/[^/]+/locations/[^/]+/deployments/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "ExportDeploymentStatefileRequest" }, "response": { "$ref": "Statefile" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Exports Terraform state file from a given deployment." }, "importState": { "id": "config.projects.locations.deployments.importState", "path": "v1/{+parent}:importState", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}:importState", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent in whose context the statefile is listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.", "pattern": "^projects/[^/]+/locations/[^/]+/deployments/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "ImportStatefileRequest" }, "response": { "$ref": "Statefile" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Imports Terraform state file in a given deployment. The state file does not take effect until the Deployment has been unlocked." }, "deleteState": { "id": "config.projects.locations.deployments.deleteState", "path": "v1/{+name}:deleteState", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}:deleteState", "httpMethod": "POST", "parameters": { "name": { "description": "Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.", "pattern": "^projects/[^/]+/locations/[^/]+/deployments/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "DeleteStatefileRequest" }, "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes Terraform state file in a given deployment." }, "lock": { "id": "config.projects.locations.deployments.lock", "path": "v1/{+name}:lock", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}:lock", "httpMethod": "POST", "parameters": { "name": { "description": "Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.", "pattern": "^projects/[^/]+/locations/[^/]+/deployments/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "LockDeploymentRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Locks a deployment." }, "unlock": { "id": "config.projects.locations.deployments.unlock", "path": "v1/{+name}:unlock", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}:unlock", "httpMethod": "POST", "parameters": { "name": { "description": "Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.", "pattern": "^projects/[^/]+/locations/[^/]+/deployments/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "UnlockDeploymentRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Unlocks a locked deployment." }, "exportLock": { "id": "config.projects.locations.deployments.exportLock", "path": "v1/{+name}:exportLock", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}:exportLock", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the deployment in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.", "pattern": "^projects/[^/]+/locations/[^/]+/deployments/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "LockInfo" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Exports the lock info on a locked deployment." }, "setIamPolicy": { "id": "config.projects.locations.deployments.setIamPolicy", "path": "v1/{+resource}:setIamPolicy", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}:setIamPolicy", "httpMethod": "POST", "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "pattern": "^projects/[^/]+/locations/[^/]+/deployments/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "resource" ], "request": { "$ref": "SetIamPolicyRequest" }, "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors." }, "getIamPolicy": { "id": "config.projects.locations.deployments.getIamPolicy", "path": "v1/{+resource}:getIamPolicy", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}:getIamPolicy", "httpMethod": "GET", "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "pattern": "^projects/[^/]+/locations/[^/]+/deployments/[^/]+$", "location": "path", "required": true, "type": "string" }, "options.requestedPolicyVersion": { "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", "location": "query", "type": "integer", "format": "int32" } }, "parameterOrder": [ "resource" ], "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set." }, "testIamPermissions": { "id": "config.projects.locations.deployments.testIamPermissions", "path": "v1/{+resource}:testIamPermissions", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}:testIamPermissions", "httpMethod": "POST", "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "pattern": "^projects/[^/]+/locations/[^/]+/deployments/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "resource" ], "request": { "$ref": "TestIamPermissionsRequest" }, "response": { "$ref": "TestIamPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "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." } }, "resources": { "revisions": { "methods": { "list": { "id": "config.projects.locations.deployments.revisions.list", "path": "v1/{+parent}/revisions", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}/revisions", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent in whose context the Revisions are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}'.", "pattern": "^projects/[^/]+/locations/[^/]+/deployments/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "When requesting a page of resources, `page_size` specifies number of resources to return. If unspecified, at most 500 will be returned. The maximum value is 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Token returned by previous call to 'ListRevisions' which specifies the position in the list from where to continue listing the resources.", "location": "query", "type": "string" }, "filter": { "description": "Lists the Revisions that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '\u003c', '\u003e', '\u003c=', '\u003e=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name = \"projects/foo/locations/us-central1/deployments/dep/revisions/bar - Filter by labels: - Resources that have a key called 'foo' labels.foo:* - Resources that have a key called 'foo' whose value is 'bar' labels.foo = bar - Filter by state: - Revisions in CREATING state. state=CREATING", "location": "query", "type": "string" }, "orderBy": { "description": "Field to use to sort the list.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListRevisionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists Revisions of a deployment." }, "get": { "id": "config.projects.locations.deployments.revisions.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}/revisions/{revisionsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the Revision in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}'.", "pattern": "^projects/[^/]+/locations/[^/]+/deployments/[^/]+/revisions/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Revision" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details about a Revision." }, "exportState": { "id": "config.projects.locations.deployments.revisions.exportState", "path": "v1/{+parent}:exportState", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}/revisions/{revisionsId}:exportState", "httpMethod": "POST", "parameters": { "parent": { "description": "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}'.", "pattern": "^projects/[^/]+/locations/[^/]+/deployments/[^/]+/revisions/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "ExportRevisionStatefileRequest" }, "response": { "$ref": "Statefile" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Exports Terraform state file from a given revision." } }, "resources": { "resources": { "methods": { "get": { "id": "config.projects.locations.deployments.revisions.resources.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}/revisions/{revisionsId}/resources/{resourcesId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the Resource in the format: 'projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}/resource/{resource}'.", "pattern": "^projects/[^/]+/locations/[^/]+/deployments/[^/]+/revisions/[^/]+/resources/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Resource" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details about a Resource deployed by Infra Manager." }, "list": { "id": "config.projects.locations.deployments.revisions.resources.list", "path": "v1/{+parent}/resources", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployments/{deploymentsId}/revisions/{revisionsId}/resources", "httpMethod": "GET", "parameters": { "parent": { "description": "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}'.", "pattern": "^projects/[^/]+/locations/[^/]+/deployments/[^/]+/revisions/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "When requesting a page of resources, 'page_size' specifies number of resources to return. If unspecified, at most 500 will be returned. The maximum value is 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Token returned by previous call to 'ListResources' which specifies the position in the list from where to continue listing the resources.", "location": "query", "type": "string" }, "filter": { "description": "Lists the Resources that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '\u003c', '\u003e', '\u003c=', '\u003e=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name = \"projects/foo/locations/us-central1/deployments/dep/revisions/bar/resources/baz", "location": "query", "type": "string" }, "orderBy": { "description": "Field to use to sort the list.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListResourcesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists Resources in a given revision." } } } } } } }, "previews": { "methods": { "create": { "id": "config.projects.locations.previews.create", "path": "v1/{+parent}/previews", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/previews", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent in whose context the Preview is created. The parent value is in the format: 'projects/{project_id}/locations/{location}'.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "previewId": { "description": "Optional. The preview ID.", "location": "query", "type": "string" }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "Preview" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a Preview." }, "get": { "id": "config.projects.locations.previews.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/previews/{previewsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the preview. Format: 'projects/{project_id}/locations/{location}/previews/{preview}'.", "pattern": "^projects/[^/]+/locations/[^/]+/previews/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Preview" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details about a Preview." }, "list": { "id": "config.projects.locations.previews.list", "path": "v1/{+parent}/previews", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/previews", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent in whose context the Previews are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. When requesting a page of resources, 'page_size' specifies number of resources to return. If unspecified, at most 500 will be returned. The maximum value is 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. Token returned by previous call to 'ListDeployments' which specifies the position in the list from where to continue listing the resources.", "location": "query", "type": "string" }, "filter": { "description": "Optional. Lists the Deployments that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '\u003c', '\u003e', '\u003c=', '\u003e=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name = \"projects/foo/locations/us-central1/deployments/bar - Filter by labels: - Resources that have a key called 'foo' labels.foo:* - Resources that have a key called 'foo' whose value is 'bar' labels.foo = bar - Filter by state: - Deployments in CREATING state. state=CREATING", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. Field to use to sort the list.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListPreviewsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists Previews in a given project and location." }, "delete": { "id": "config.projects.locations.previews.delete", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/previews/{previewsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of the Preview in the format: 'projects/{project_id}/locations/{location}/previews/{preview}'.", "pattern": "^projects/[^/]+/locations/[^/]+/previews/[^/]+$", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a Preview." }, "export": { "id": "config.projects.locations.previews.export", "path": "v1/{+parent}:export", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/previews/{previewsId}:export", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The preview whose results should be exported. The preview value is in the format: 'projects/{project_id}/locations/{location}/previews/{preview}'.", "pattern": "^projects/[^/]+/locations/[^/]+/previews/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "ExportPreviewResultRequest" }, "response": { "$ref": "ExportPreviewResultResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Export Preview results." } }, "resources": { "resourceChanges": { "methods": { "list": { "id": "config.projects.locations.previews.resourceChanges.list", "path": "v1/{+parent}/resourceChanges", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/previews/{previewsId}/resourceChanges", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent in whose context the ResourceChanges are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/previews/{preview}'.", "pattern": "^projects/[^/]+/locations/[^/]+/previews/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. When requesting a page of resource changes, 'page_size' specifies number of resource changes to return. If unspecified, at most 500 will be returned. The maximum value is 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. Token returned by previous call to 'ListResourceChanges' which specifies the position in the list from where to continue listing the resource changes.", "location": "query", "type": "string" }, "filter": { "description": "Optional. Lists the resource changes that match the filter expression. A filter expression filters the resource changes listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '\u003c', '\u003e', '\u003c=', '\u003e=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name = \"projects/foo/locations/us-central1/previews/dep/resourceChanges/baz", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. Field to use to sort the list.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListResourceChangesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists ResourceChanges for a given preview." }, "get": { "id": "config.projects.locations.previews.resourceChanges.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/previews/{previewsId}/resourceChanges/{resourceChangesId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the resource change to retrieve. Format: 'projects/{project_id}/locations/{location}/previews/{preview}/resourceChanges/{resource_change}'.", "pattern": "^projects/[^/]+/locations/[^/]+/previews/[^/]+/resourceChanges/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "ResourceChange" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Get a ResourceChange for a given preview." } } }, "resourceDrifts": { "methods": { "list": { "id": "config.projects.locations.previews.resourceDrifts.list", "path": "v1/{+parent}/resourceDrifts", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/previews/{previewsId}/resourceDrifts", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent in whose context the ResourceDrifts are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}/previews/{preview}'.", "pattern": "^projects/[^/]+/locations/[^/]+/previews/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. When requesting a page of resource drifts, 'page_size' specifies number of resource drifts to return. If unspecified, at most 500 will be returned. The maximum value is 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. Token returned by previous call to 'ListResourceDrifts' which specifies the position in the list from where to continue listing the resource drifts.", "location": "query", "type": "string" }, "filter": { "description": "Optional. Lists the resource drifts that match the filter expression. A filter expression filters the resource drifts listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '\u003c', '\u003e', '\u003c=', '\u003e=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name = \"projects/foo/locations/us-central1/previews/dep/resourceDrifts/baz", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. Field to use to sort the list.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListResourceDriftsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "List ResourceDrifts for a given preview." }, "get": { "id": "config.projects.locations.previews.resourceDrifts.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/previews/{previewsId}/resourceDrifts/{resourceDriftsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the resource drift to retrieve. Format: 'projects/{project_id}/locations/{location}/previews/{preview}/resourceDrifts/{resource_drift}'.", "pattern": "^projects/[^/]+/locations/[^/]+/previews/[^/]+/resourceDrifts/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "ResourceDrift" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Get a ResourceDrift for a given preview." } } } } }, "terraformVersions": { "methods": { "list": { "id": "config.projects.locations.terraformVersions.list", "path": "v1/{+parent}/terraformVersions", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/terraformVersions", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent in whose context the TerraformVersions are listed. The parent value is in the format: 'projects/{project_id}/locations/{location}'.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. When requesting a page of terraform versions, 'page_size' specifies number of terraform versions to return. If unspecified, at most 500 will be returned. The maximum value is 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. Token returned by previous call to 'ListTerraformVersions' which specifies the position in the list from where to continue listing the terraform versions.", "location": "query", "type": "string" }, "filter": { "description": "Optional. Lists the TerraformVersions that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '\u003c', '\u003e', '\u003c=', '\u003e=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case.", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. Field to use to sort the list.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListTerraformVersionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists TerraformVersions in a given project and location." }, "get": { "id": "config.projects.locations.terraformVersions.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/terraformVersions/{terraformVersionsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the TerraformVersion. Format: 'projects/{project_id}/locations/{location}/terraformVersions/{terraform_version}'", "pattern": "^projects/[^/]+/locations/[^/]+/terraformVersions/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "TerraformVersion" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details about a TerraformVersion." } } }, "deploymentGroups": { "methods": { "get": { "id": "config.projects.locations.deploymentGroups.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentGroups/{deploymentGroupsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the deployment group to retrieve. Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'.", "pattern": "^projects/[^/]+/locations/[^/]+/deploymentGroups/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "DeploymentGroup" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Get a DeploymentGroup for a given project and location." }, "create": { "id": "config.projects.locations.deploymentGroups.create", "path": "v1/{+parent}/deploymentGroups", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentGroups", "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The parent in whose context the Deployment Group is created. The parent value is in the format: 'projects/{project_id}/locations/{location}'", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "deploymentGroupId": { "description": "Required. The deployment group ID.", "location": "query", "type": "string" }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "DeploymentGroup" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a DeploymentGroup The newly created DeploymentGroup will be in the `CREATING` state and can be retrieved via Get and List calls." }, "patch": { "id": "config.projects.locations.deploymentGroups.patch", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentGroups/{deploymentGroupsId}", "httpMethod": "PATCH", "parameters": { "name": { "description": "Identifier. The name of the deployment group. Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'.", "pattern": "^projects/[^/]+/locations/[^/]+/deploymentGroups/[^/]+$", "location": "path", "required": true, "type": "string" }, "updateMask": { "description": "Optional. Field mask used to specify the fields to be overwritten in the Deployment Group resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", "location": "query", "type": "string", "format": "google-fieldmask" }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "DeploymentGroup" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates a DeploymentGroup" }, "delete": { "id": "config.projects.locations.deploymentGroups.delete", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentGroups/{deploymentGroupsId}", "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The name of DeploymentGroup in the format projects/{project_id}/locations/{location_id}/deploymentGroups/{deploymentGroup}", "pattern": "^projects/[^/]+/locations/[^/]+/deploymentGroups/[^/]+$", "location": "path", "required": true, "type": "string" }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "force": { "description": "Optional. If set to true, any revisions for this deployment group will also be deleted. (Otherwise, the request will only work if the deployment group has no revisions.)", "location": "query", "type": "boolean" }, "deploymentReferencePolicy": { "description": "Optional. Policy on how to handle referenced deployments when deleting the DeploymentGroup. If unspecified, the default behavior is to fail the deletion if any deployments currently referenced in the `deployment_units` of the DeploymentGroup or in the latest revision are not deleted.", "location": "query", "type": "string", "enumDescriptions": [ "The default behavior. If unspecified, the system will act as if `FAIL_IF_ANY_REFERENCES_EXIST` is specified.", "Fail the deletion if any deployments currently referenced in the `deployment_units` of the DeploymentGroup or in the latest revision are not deleted.", "Fail the deletion only if any deployments currently referenced in the `deployment_units` of the DeploymentGroup are not deleted. The deletion will proceed even if the deployments in the latest revision of the DeploymentGroup are not deleted.", "Ignore any deployments currently referenced in the `deployment_units` of the DeploymentGroup or in the latest revision." ], "enum": [ "DEPLOYMENT_REFERENCE_POLICY_UNSPECIFIED", "FAIL_IF_ANY_REFERENCES_EXIST", "FAIL_IF_METADATA_REFERENCES_EXIST", "IGNORE_DEPLOYMENT_REFERENCES" ] } }, "parameterOrder": [ "name" ], "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a DeploymentGroup" }, "list": { "id": "config.projects.locations.deploymentGroups.list", "path": "v1/{+parent}/deploymentGroups", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentGroups", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent, which owns this collection of deployment groups. Format: 'projects/{project_id}/locations/{location}'.", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. When requesting a page of resources, 'page_size' specifies number of resources to return. If unspecified, at most 500 will be returned. The maximum value is 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. Token returned by previous call to 'ListDeploymentGroups' which specifies the position in the list from where to continue listing the deployment groups.", "location": "query", "type": "string" }, "filter": { "description": "Optional. Lists the DeploymentGroups that match the filter expression. A filter expression filters the deployment groups listed in the response. The expression must be of the form '{field} {operator} {value}' where operators: '\u003c', '\u003e', '\u003c=', '\u003e=', '!=', '=', ':' are supported (colon ':' represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name = \"projects/foo/locations/us-central1/deploymentGroups/bar\" - Filter by labels: - Resources that have a key called 'foo' labels.foo:* - Resources that have a key called 'foo' whose value is 'bar' labels.foo = bar - Filter by state: - DeploymentGroups in CREATING state. state=CREATING", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. Field to use to sort the list.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListDeploymentGroupsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "List DeploymentGroups for a given project and location." }, "provision": { "id": "config.projects.locations.deploymentGroups.provision", "path": "v1/{+name}:provision", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentGroups/{deploymentGroupsId}:provision", "httpMethod": "POST", "parameters": { "name": { "description": "Required. The name of the deployment group to provision. Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'.", "pattern": "^projects/[^/]+/locations/[^/]+/deploymentGroups/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "ProvisionDeploymentGroupRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Provisions a deployment group. NOTE: As a first step of this operation, Infra Manager will automatically delete any Deployments that were part of the *last successful* DeploymentGroupRevision but are *no longer* included in the *current* DeploymentGroup definition (e.g., following an `UpdateDeploymentGroup` call), along with their actuated resources." }, "deprovision": { "id": "config.projects.locations.deploymentGroups.deprovision", "path": "v1/{+name}:deprovision", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentGroups/{deploymentGroupsId}:deprovision", "httpMethod": "POST", "parameters": { "name": { "description": "Required. The name of the deployment group to deprovision. Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'.", "pattern": "^projects/[^/]+/locations/[^/]+/deploymentGroups/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "request": { "$ref": "DeprovisionDeploymentGroupRequest" }, "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deprovisions a deployment group. NOTE: As a first step of this operation, Infra Manager will automatically delete any Deployments that were part of the *last successful* DeploymentGroupRevision but are *no longer* included in the *current* DeploymentGroup definition (e.g., following an `UpdateDeploymentGroup` call), along with their actuated resources." } }, "resources": { "revisions": { "methods": { "get": { "id": "config.projects.locations.deploymentGroups.revisions.get", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentGroups/{deploymentGroupsId}/revisions/{revisionsId}", "httpMethod": "GET", "parameters": { "name": { "description": "Required. The name of the deployment group revision to retrieve. Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}/revisions/{revision}'.", "pattern": "^projects/[^/]+/locations/[^/]+/deploymentGroups/[^/]+/revisions/[^/]+$", "location": "path", "required": true, "type": "string" } }, "parameterOrder": [ "name" ], "response": { "$ref": "DeploymentGroupRevision" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details about a DeploymentGroupRevision." }, "list": { "id": "config.projects.locations.deploymentGroups.revisions.list", "path": "v1/{+parent}/revisions", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentGroups/{deploymentGroupsId}/revisions", "httpMethod": "GET", "parameters": { "parent": { "description": "Required. The parent, which owns this collection of deployment group revisions. Format: 'projects/{project_id}/locations/{location}/deploymentGroups/{deployment_group}'.", "pattern": "^projects/[^/]+/locations/[^/]+/deploymentGroups/[^/]+$", "location": "path", "required": true, "type": "string" }, "pageSize": { "description": "Optional. When requesting a page of resources, 'page_size' specifies number of resources to return. If unspecified, a sensible default will be used by the server. The maximum value is 1000; values above 1000 will be coerced to 1000.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "description": "Optional. Token returned by previous call to 'ListDeploymentGroupRevisions' which specifies the position in the list from where to continue listing the deployment group revisions. All other parameters provided to `ListDeploymentGroupRevisions` must match the call that provided the page token.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListDeploymentGroupRevisionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists DeploymentGroupRevisions in a given DeploymentGroup." } } } } } } } } } }, "canonicalName": "Config", "rootUrl": "https://config.googleapis.com/" }