Package Classes (0.1.9)

Infrastructure Manager is a managed service that automates the deployment and management of Google Cloud infrastructure resources.

Infrastructure Manager is a managed service that automates the deployment and management of Google Cloud infrastructure resources.

A pager for iterating through list_deployments requests.

This class thinly wraps an initial ListDeploymentsResponse object, and provides an __aiter__ method to iterate through its deployments field.

If there are more pages, the __aiter__ method will make additional ListDeployments requests and continue to iterate through the deployments field on the corresponding responses.

All the usual ListDeploymentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_deployments requests.

This class thinly wraps an initial ListDeploymentsResponse object, and provides an __iter__ method to iterate through its deployments field.

If there are more pages, the __iter__ method will make additional ListDeployments requests and continue to iterate through the deployments field on the corresponding responses.

All the usual ListDeploymentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_previews requests.

This class thinly wraps an initial ListPreviewsResponse object, and provides an __aiter__ method to iterate through its previews field.

If there are more pages, the __aiter__ method will make additional ListPreviews requests and continue to iterate through the previews field on the corresponding responses.

All the usual ListPreviewsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_previews requests.

This class thinly wraps an initial ListPreviewsResponse object, and provides an __iter__ method to iterate through its previews field.

If there are more pages, the __iter__ method will make additional ListPreviews requests and continue to iterate through the previews field on the corresponding responses.

All the usual ListPreviewsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_resources requests.

This class thinly wraps an initial ListResourcesResponse object, and provides an __aiter__ method to iterate through its resources field.

If there are more pages, the __aiter__ method will make additional ListResources requests and continue to iterate through the resources field on the corresponding responses.

All the usual ListResourcesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_resources requests.

This class thinly wraps an initial ListResourcesResponse object, and provides an __iter__ method to iterate through its resources field.

If there are more pages, the __iter__ method will make additional ListResources requests and continue to iterate through the resources field on the corresponding responses.

All the usual ListResourcesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_revisions requests.

This class thinly wraps an initial ListRevisionsResponse object, and provides an __aiter__ method to iterate through its revisions field.

If there are more pages, the __aiter__ method will make additional ListRevisions requests and continue to iterate through the revisions field on the corresponding responses.

All the usual ListRevisionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_revisions requests.

This class thinly wraps an initial ListRevisionsResponse object, and provides an __iter__ method to iterate through its revisions field.

If there are more pages, the __iter__ method will make additional ListRevisions requests and continue to iterate through the revisions field on the corresponding responses.

All the usual ListRevisionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_terraform_versions requests.

This class thinly wraps an initial ListTerraformVersionsResponse object, and provides an __aiter__ method to iterate through its terraform_versions field.

If there are more pages, the __aiter__ method will make additional ListTerraformVersions requests and continue to iterate through the terraform_versions field on the corresponding responses.

All the usual ListTerraformVersionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_terraform_versions requests.

This class thinly wraps an initial ListTerraformVersionsResponse object, and provides an __iter__ method to iterate through its terraform_versions field.

If there are more pages, the __iter__ method will make additional ListTerraformVersions requests and continue to iterate through the terraform_versions field on the corresponding responses.

All the usual ListTerraformVersionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Outputs and artifacts from applying a deployment.

The abstract base class for a message.

A request to create a preview.

Policy on how resources actuated by the deployment should be deleted.

Values: DELETE_POLICY_UNSPECIFIED (0): Unspecified policy, resources will be deleted. DELETE (1): Deletes resources actuated by the deployment. ABANDON (2): Abandons resources and only deletes the deployment and its metadata.

A request to delete a preview.

A request to delete a state file passed to a 'DeleteStatefile' call.

A Deployment is a group of resources and configs managed and provisioned by Infra Manager.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The abstract base class for a message.

Possible errors that can occur with deployments.

Values: ERROR_CODE_UNSPECIFIED (0): No error code was specified. REVISION_FAILED (1): The revision failed. See Revision for more details. CLOUD_BUILD_PERMISSION_DENIED (3): Cloud Build failed due to a permission issue. DELETE_BUILD_API_FAILED (5): Cloud Build job associated with a deployment deletion could not be started. DELETE_BUILD_RUN_FAILED (6): Cloud Build job associated with a deployment deletion was started but failed. BUCKET_CREATION_PERMISSION_DENIED (7): Cloud Storage bucket creation failed due to a permission issue. BUCKET_CREATION_FAILED (8): Cloud Storage bucket creation failed due to an issue unrelated to permissions.

The abstract base class for a message.

Possible lock states of a deployment.

Values: LOCK_STATE_UNSPECIFIED (0): The default value. This value is used if the lock state is omitted. LOCKED (1): The deployment is locked. UNLOCKED (2): The deployment is unlocked. LOCKING (3): The deployment is being locked. UNLOCKING (4): The deployment is being unlocked. LOCK_FAILED (5): The deployment has failed to lock. UNLOCK_FAILED (6): The deployment has failed to unlock.

Possible states of a deployment.

Values: STATE_UNSPECIFIED (0): The default value. This value is used if the state is omitted. CREATING (1): The deployment is being created. ACTIVE (2): The deployment is healthy. UPDATING (3): The deployment is being updated. DELETING (4): The deployment is being deleted. FAILED (5): The deployment has encountered an unexpected error. SUSPENDED (6): The deployment is no longer being actively reconciled. This may be the result of recovering the project after deletion. DELETED (7): The deployment has been deleted.

Ephemeral metadata content describing the state of a deployment operation.

The possible steps a deployment may be running.

Values: DEPLOYMENT_STEP_UNSPECIFIED (0): Unspecified deployment step PREPARING_STORAGE_BUCKET (1): Infra Manager is creating a Google Cloud Storage bucket to store artifacts and metadata about the deployment and revision DOWNLOADING_BLUEPRINT (2): Downloading the blueprint onto the Google Cloud Storage bucket RUNNING_TF_INIT (3): Initializing Terraform using terraform init RUNNING_TF_PLAN (4): Running terraform plan RUNNING_TF_APPLY (5): Actuating resources using Terraform using terraform apply RUNNING_TF_DESTROY (6): Destroying resources using Terraform using terraform destroy RUNNING_TF_VALIDATE (7): Validating the uploaded TF state file when unlocking a deployment UNLOCKING_DEPLOYMENT (8): Unlocking a deployment SUCCEEDED (9): Operation was successful FAILED (10): Operation failed VALIDATING_REPOSITORY (11): Validating the provided repository. RUNNING_QUOTA_VALIDATION (12): Running quota validation

A request to export a state file passed to a 'ExportDeploymentStatefile' call.

A request to get a state file lock info passed to a 'ExportLockInfo' call.

A request to export preview results.

A response to ExportPreviewResult call. Contains preview results.

A request to export a state file passed to a 'ExportRevisionStatefile' call.

A request to get details about a preview.

A request to get a Resource from a 'GetResource' call.

A request to get a Revision from a 'GetRevision' call.

The request message for the GetTerraformVersion method.

A set of files in a Git repository.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A request to import a state file passed to a 'ImportStatefile' call.

A request to list all previews for a given project and location.

A response to a ListPreviews call. Contains a list of Previews.

A request to list Resources passed to a 'ListResources' call.

A response to a 'ListResources' call. Contains a list of Resources.

A request to list Revisions passed to a 'ListRevisions' call.

A response to a 'ListRevisions' call. Contains a list of Revisions.

The request message for the ListTerraformVersions method.

The response message for the ListTerraformVersions method.

A request to lock a deployment passed to a 'LockDeployment' call.

Details about the lock which locked the deployment.

Represents the metadata of the long-running operation.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

A preview represents a set of actions Infra Manager would perform to move the resources towards the desired state as specified in the configuration.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Possible errors that can occur with previews.

Values: ERROR_CODE_UNSPECIFIED (0): No error code was specified. CLOUD_BUILD_PERMISSION_DENIED (1): Cloud Build failed due to a permissions issue. BUCKET_CREATION_PERMISSION_DENIED (2): Cloud Storage bucket failed to create due to a permissions issue. BUCKET_CREATION_FAILED (3): Cloud Storage bucket failed for a non-permissions-related issue. DEPLOYMENT_LOCK_ACQUIRE_FAILED (4): Acquiring lock on provided deployment reference failed. PREVIEW_BUILD_API_FAILED (5): Preview encountered an error when trying to access Cloud Build API. PREVIEW_BUILD_RUN_FAILED (6): Preview created a build but build failed and logs were generated.

The abstract base class for a message.

Preview mode provides options for customizing preview operations.

Values: PREVIEW_MODE_UNSPECIFIED (0): Unspecified policy, default mode will be used. DEFAULT (1): DEFAULT mode generates an execution plan for reconciling current resource state into expected resource state. DELETE (2): DELETE mode generates as execution plan for destroying current resources.

Possible states of a preview.

Values: STATE_UNSPECIFIED (0): The default value. This value is used if the state is unknown. CREATING (1): The preview is being created. SUCCEEDED (2): The preview has succeeded. APPLYING (3): The preview is being applied. STALE (4): The preview is stale. A preview can become stale if a revision has been applied after this preview was created. DELETING (5): The preview is being deleted. FAILED (6): The preview has encountered an unexpected error. DELETED (7): The preview has been deleted.

Artifacts created by preview.

Ephemeral metadata content describing the state of a preview operation.

The possible steps a preview may be running.

Values: PREVIEW_STEP_UNSPECIFIED (0): Unspecified preview step. PREPARING_STORAGE_BUCKET (1): Infra Manager is creating a Google Cloud Storage bucket to store artifacts and metadata about the preview. DOWNLOADING_BLUEPRINT (2): Downloading the blueprint onto the Google Cloud Storage bucket. RUNNING_TF_INIT (3): Initializing Terraform using terraform init. RUNNING_TF_PLAN (4): Running terraform plan. FETCHING_DEPLOYMENT (5): Fetching a deployment. LOCKING_DEPLOYMENT (6): Locking a deployment. UNLOCKING_DEPLOYMENT (7): Unlocking a deployment. SUCCEEDED (8): Operation was successful. FAILED (9): Operation failed. VALIDATING_REPOSITORY (10): Validating the provided repository.

Contains a signed Cloud Storage URLs.

Enum values to control quota checks for resources in terraform configuration files.

Values: QUOTA_VALIDATION_UNSPECIFIED (0): The default value. QuotaValidation on terraform configuration files will be disabled in this case. ENABLED (1): Enable computing quotas for resources in terraform configuration files to get visibility on resources with insufficient quotas. ENFORCED (2): Enforce quota checks so deployment fails if there isn't sufficient quotas available to deploy resources in terraform configuration files.

Resource represents a Google Cloud Platform resource actuated by IM. Resources are child resources of Revisions.

The abstract base class for a message.

Possible intent of the resource.

Values: INTENT_UNSPECIFIED (0): The default value. This value is used if the intent is omitted. CREATE (1): Infra Manager will create this Resource. UPDATE (2): Infra Manager will update this Resource. DELETE (3): Infra Manager will delete this Resource. RECREATE (4): Infra Manager will destroy and recreate this Resource. UNCHANGED (5): Infra Manager will leave this Resource untouched.

Possible states of a resource.

Values: STATE_UNSPECIFIED (0): The default value. This value is used if the state is omitted. PLANNED (1): Resource has been planned for reconcile. IN_PROGRESS (2): Resource is actively reconciling into the intended state. RECONCILED (3): Resource has reconciled to intended state. FAILED (4): Resource failed to reconcile.

CAI info of a Resource.

Terraform info of a Resource.

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Actions that generate a revision.

Values: ACTION_UNSPECIFIED (0): The default value. This value is used if the action is omitted. CREATE (1): The revision was generated by creating a deployment. UPDATE (2): The revision was generated by updating a deployment. DELETE (3): The revision was deleted.

Possible errors if Revision could not be created or updated successfully.

Values: ERROR_CODE_UNSPECIFIED (0): No error code was specified. CLOUD_BUILD_PERMISSION_DENIED (1): Cloud Build failed due to a permission issue. APPLY_BUILD_API_FAILED (4): Cloud Build job associated with creating or updating a deployment could not be started. APPLY_BUILD_RUN_FAILED (5): Cloud Build job associated with creating or updating a deployment was started but failed. QUOTA_VALIDATION_FAILED (7): quota validation failed for one or more resources in terraform configuration files.

Possible states of a revision.

Values: STATE_UNSPECIFIED (0): The default value. This value is used if the state is omitted. APPLYING (1): The revision is being applied. APPLIED (2): The revision was applied successfully. FAILED (3): The revision could not be applied successfully.

Contains info about a Terraform state file

TerraformBlueprint describes the source of a Terraform root module which describes the resources and configs to be deployed.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The abstract base class for a message.

Errors encountered during actuation using Terraform

Describes a Terraform output.

A Terraform input variable.

A TerraformVersion represents the support state the corresponding Terraform version.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Possible states of a TerraformVersion.

Values: STATE_UNSPECIFIED (0): The default value. This value is used if the state is omitted. ACTIVE (1): The version is actively supported. DEPRECATED (2): The version is deprecated. OBSOLETE (3): The version is obsolete.

A request to unlock a state file passed to a 'UnlockDeployment' call.

API documentation for config_v1.services.config.pagers module.