Class ConfigClient (0.1.9)

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

Return the API endpoint used by the client instance.

Returns the transport used by the client instance.

Return the universe domain used by the client instance.

Instantiates the config client.

Releases underlying transport's resources.

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.

Returns a fully-qualified billing_account string.

Returns a fully-qualified folder string.

Returns a fully-qualified location string.

Returns a fully-qualified organization string.

Returns a fully-qualified project string.

Creates a xref_Deployment.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1

def sample_create_deployment():
    # Create a client
    client = config_v1.ConfigClient()

    # Initialize request argument(s)
    deployment = config_v1.Deployment()
    deployment.terraform_blueprint.gcs_source = "gcs_source_value"

    request = config_v1.CreateDeploymentRequest(
        parent="parent_value",
        deployment_id="deployment_id_value",
        deployment=deployment,
    )

    # Make the request
    operation = client.create_deployment(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Creates a xref_Preview.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1

def sample_create_preview():
    # Create a client
    client = config_v1.ConfigClient()

    # Initialize request argument(s)
    preview = config_v1.Preview()
    preview.terraform_blueprint.gcs_source = "gcs_source_value"

    request = config_v1.CreatePreviewRequest(
        parent="parent_value",
        preview=preview,
    )

    # Make the request
    operation = client.create_preview(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Deletes a xref_Deployment.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1

def sample_delete_deployment():
    # Create a client
    client = config_v1.ConfigClient()

    # Initialize request argument(s)
    request = config_v1.DeleteDeploymentRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_deployment(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

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.

Deletes a xref_Preview.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1

def sample_delete_preview():
    # Create a client
    client = config_v1.ConfigClient()

    # Initialize request argument(s)
    request = config_v1.DeletePreviewRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_preview(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Deletes Terraform state file in a given deployment.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1

def sample_delete_statefile():
    # Create a client
    client = config_v1.ConfigClient()

    # Initialize request argument(s)
    request = config_v1.DeleteStatefileRequest(
        name="name_value",
        lock_id=725,
    )

    # Make the request
    client.delete_statefile(request=request)

Returns a fully-qualified deployment string.

Exports Terraform state file from a given deployment.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1

def sample_export_deployment_statefile():
    # Create a client
    client = config_v1.ConfigClient()

    # Initialize request argument(s)
    request = config_v1.ExportDeploymentStatefileRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.export_deployment_statefile(request=request)

    # Handle the response
    print(response)

Exports the lock info on a locked deployment.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1

def sample_export_lock_info():
    # Create a client
    client = config_v1.ConfigClient()

    # Initialize request argument(s)
    request = config_v1.ExportLockInfoRequest(
        name="name_value",
    )

    # Make the request
    response = client.export_lock_info(request=request)

    # Handle the response
    print(response)

Export xref_Preview results.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1

def sample_export_preview_result():
    # Create a client
    client = config_v1.ConfigClient()

    # Initialize request argument(s)
    request = config_v1.ExportPreviewResultRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.export_preview_result(request=request)

    # Handle the response
    print(response)

Exports Terraform state file from a given revision.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1

def sample_export_revision_statefile():
    # Create a client
    client = config_v1.ConfigClient()

    # Initialize request argument(s)
    request = config_v1.ExportRevisionStatefileRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.export_revision_statefile(request=request)

    # Handle the response
    print(response)

Creates an instance of this client using the provided credentials file.

Creates an instance of this client using the provided credentials info.

Creates an instance of this client using the provided credentials file.

Gets details about a xref_Deployment.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1

def sample_get_deployment():
    # Create a client
    client = config_v1.ConfigClient()

    # Initialize request argument(s)
    request = config_v1.GetDeploymentRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_deployment(request=request)

    # Handle the response
    print(response)

Gets the IAM access control policy for a function.

Returns an empty policy if the function exists and does not have a policy set.

Gets information about a location.

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Gets the latest state of a long-running operation.

Gets details about a xref_Preview.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1

def sample_get_preview():
    # Create a client
    client = config_v1.ConfigClient()

    # Initialize request argument(s)
    request = config_v1.GetPreviewRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_preview(request=request)

    # Handle the response
    print(response)

Gets details about a xref_Resource deployed by Infra Manager.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1

def sample_get_resource():
    # Create a client
    client = config_v1.ConfigClient()

    # Initialize request argument(s)
    request = config_v1.GetResourceRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_resource(request=request)

    # Handle the response
    print(response)

Gets details about a xref_Revision.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1

def sample_get_revision():
    # Create a client
    client = config_v1.ConfigClient()

    # Initialize request argument(s)
    request = config_v1.GetRevisionRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_revision(request=request)

    # Handle the response
    print(response)

Gets details about a xref_TerraformVersion.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1

def sample_get_terraform_version():
    # Create a client
    client = config_v1.ConfigClient()

    # Initialize request argument(s)
    request = config_v1.GetTerraformVersionRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_terraform_version(request=request)

    # Handle the response
    print(response)

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1

def sample_import_statefile():
    # Create a client
    client = config_v1.ConfigClient()

    # Initialize request argument(s)
    request = config_v1.ImportStatefileRequest(
        parent="parent_value",
        lock_id=725,
    )

    # Make the request
    response = client.import_statefile(request=request)

    # Handle the response
    print(response)

Lists xref_Deployments in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1

def sample_list_deployments():
    # Create a client
    client = config_v1.ConfigClient()

    # Initialize request argument(s)
    request = config_v1.ListDeploymentsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_deployments(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Lists information about the supported locations for this service.

Lists operations that match the specified filter in the request.

Lists xref_Previews in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1

def sample_list_previews():
    # Create a client
    client = config_v1.ConfigClient()

    # Initialize request argument(s)
    request = config_v1.ListPreviewsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_previews(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Lists xref_Resources in a given revision.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1

def sample_list_resources():
    # Create a client
    client = config_v1.ConfigClient()

    # Initialize request argument(s)
    request = config_v1.ListResourcesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_resources(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Lists xref_Revisions of a deployment.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1

def sample_list_revisions():
    # Create a client
    client = config_v1.ConfigClient()

    # Initialize request argument(s)
    request = config_v1.ListRevisionsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_revisions(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Lists xref_TerraformVersions in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1

def sample_list_terraform_versions():
    # Create a client
    client = config_v1.ConfigClient()

    # Initialize request argument(s)
    request = config_v1.ListTerraformVersionsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_terraform_versions(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Locks a deployment.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1

def sample_lock_deployment():
    # Create a client
    client = config_v1.ConfigClient()

    # Initialize request argument(s)
    request = config_v1.LockDeploymentRequest(
        name="name_value",
    )

    # Make the request
    operation = client.lock_deployment(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parse a billing_account path into its component segments.

Parse a folder path into its component segments.

Parse a location path into its component segments.

Parse a organization path into its component segments.

Parse a project path into its component segments.

Parses a deployment path into its component segments.

Parses a preview path into its component segments.

Parses a resource path into its component segments.

Parses a revision path into its component segments.

Parses a service_account path into its component segments.

Parses a terraform_version path into its component segments.

Parses a worker_pool path into its component segments.

Returns a fully-qualified preview string.

Returns a fully-qualified resource string.

Returns a fully-qualified revision string.

Returns a fully-qualified service_account string.

Sets the IAM access control policy on the specified function.

Replaces any existing policy.

Returns a fully-qualified terraform_version string.

Tests the specified IAM permissions against the IAM access control policy for a function.

If the function does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Unlocks a locked deployment.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1

def sample_unlock_deployment():
    # Create a client
    client = config_v1.ConfigClient()

    # Initialize request argument(s)
    request = config_v1.UnlockDeploymentRequest(
        name="name_value",
        lock_id=725,
    )

    # Make the request
    operation = client.unlock_deployment(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Updates a xref_Deployment.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import config_v1

def sample_update_deployment():
    # Create a client
    client = config_v1.ConfigClient()

    # Initialize request argument(s)
    deployment = config_v1.Deployment()
    deployment.terraform_blueprint.gcs_source = "gcs_source_value"

    request = config_v1.UpdateDeploymentRequest(
        deployment=deployment,
    )

    # Make the request
    operation = client.update_deployment(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Returns a fully-qualified worker_pool string.