Class DataformClient (0.5.13)

Dataform is a service to develop, create, document, test, and update curated tables in BigQuery.

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 dataform client.

Releases underlying transport's resources.

Requests cancellation of a running WorkflowInvocation.

# 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 dataform_v1beta1

def sample_cancel_workflow_invocation():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.CancelWorkflowInvocationRequest(
        name="name_value",
    )

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

Applies a Git commit to a Repository. The Repository must not have a value for git_remote_settings.url.

# 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 dataform_v1beta1

def sample_commit_repository_changes():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    commit_metadata = dataform_v1beta1.CommitMetadata()
    commit_metadata.author.name = "name_value"
    commit_metadata.author.email_address = "email_address_value"

    request = dataform_v1beta1.CommitRepositoryChangesRequest(
        name="name_value",
        commit_metadata=commit_metadata,
    )

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

Applies a Git commit for uncommitted files in a Workspace.

# 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 dataform_v1beta1

def sample_commit_workspace_changes():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    author = dataform_v1beta1.CommitAuthor()
    author.name = "name_value"
    author.email_address = "email_address_value"

    request = dataform_v1beta1.CommitWorkspaceChangesRequest(
        name="name_value",
        author=author,
    )

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

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.

Returns a fully-qualified compilation_result string.

Computes a Repository's Git access token status.

# 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 dataform_v1beta1

def sample_compute_repository_access_token_status():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.ComputeRepositoryAccessTokenStatusRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Creates a new CompilationResult 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 dataform_v1beta1

def sample_create_compilation_result():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    compilation_result = dataform_v1beta1.CompilationResult()
    compilation_result.git_commitish = "git_commitish_value"

    request = dataform_v1beta1.CreateCompilationResultRequest(
        parent="parent_value",
        compilation_result=compilation_result,
    )

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

    # Handle the response
    print(response)

Creates a new ReleaseConfig in a given Repository.

# 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 dataform_v1beta1

def sample_create_release_config():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    release_config = dataform_v1beta1.ReleaseConfig()
    release_config.git_commitish = "git_commitish_value"

    request = dataform_v1beta1.CreateReleaseConfigRequest(
        parent="parent_value",
        release_config=release_config,
        release_config_id="release_config_id_value",
    )

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

    # Handle the response
    print(response)

Creates a new Repository 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 dataform_v1beta1

def sample_create_repository():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.CreateRepositoryRequest(
        parent="parent_value",
        repository_id="repository_id_value",
    )

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

    # Handle the response
    print(response)

Creates a new WorkflowConfig in a given Repository.

# 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 dataform_v1beta1

def sample_create_workflow_config():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    workflow_config = dataform_v1beta1.WorkflowConfig()
    workflow_config.release_config = "release_config_value"

    request = dataform_v1beta1.CreateWorkflowConfigRequest(
        parent="parent_value",
        workflow_config=workflow_config,
        workflow_config_id="workflow_config_id_value",
    )

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

    # Handle the response
    print(response)

Creates a new WorkflowInvocation in a given Repository.

# 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 dataform_v1beta1

def sample_create_workflow_invocation():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    workflow_invocation = dataform_v1beta1.WorkflowInvocation()
    workflow_invocation.compilation_result = "compilation_result_value"

    request = dataform_v1beta1.CreateWorkflowInvocationRequest(
        parent="parent_value",
        workflow_invocation=workflow_invocation,
    )

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

    # Handle the response
    print(response)

Creates a new Workspace in a given Repository.

# 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 dataform_v1beta1

def sample_create_workspace():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.CreateWorkspaceRequest(
        parent="parent_value",
        workspace_id="workspace_id_value",
    )

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

    # Handle the response
    print(response)

Deletes a single ReleaseConfig.

# 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 dataform_v1beta1

def sample_delete_release_config():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.DeleteReleaseConfigRequest(
        name="name_value",
    )

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

Deletes a single Repository.

# 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 dataform_v1beta1

def sample_delete_repository():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.DeleteRepositoryRequest(
        name="name_value",
    )

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

Deletes a single WorkflowConfig.

# 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 dataform_v1beta1

def sample_delete_workflow_config():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.DeleteWorkflowConfigRequest(
        name="name_value",
    )

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

Deletes a single WorkflowInvocation.

# 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 dataform_v1beta1

def sample_delete_workflow_invocation():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.DeleteWorkflowInvocationRequest(
        name="name_value",
    )

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

Deletes a single Workspace.

# 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 dataform_v1beta1

def sample_delete_workspace():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.DeleteWorkspaceRequest(
        name="name_value",
    )

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

Fetches Git diff for an uncommitted file in a Workspace.

# 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 dataform_v1beta1

def sample_fetch_file_diff():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.FetchFileDiffRequest(
        workspace="workspace_value",
        path="path_value",
    )

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

    # Handle the response
    print(response)

Fetches Git statuses for the files in a Workspace.

# 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 dataform_v1beta1

def sample_fetch_file_git_statuses():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.FetchFileGitStatusesRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Fetches Git ahead/behind against a remote branch.

# 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 dataform_v1beta1

def sample_fetch_git_ahead_behind():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.FetchGitAheadBehindRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Fetches a Repository's remote branches.

# 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 dataform_v1beta1

def sample_fetch_remote_branches():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.FetchRemoteBranchesRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Fetches a Repository's history of commits. The Repository must not have a value for git_remote_settings.url.

# 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 dataform_v1beta1

def sample_fetch_repository_history():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.FetchRepositoryHistoryRequest(
        name="name_value",
    )

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

    # Handle the response
    for response in page_result:
        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.

Fetches a single CompilationResult.

# 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 dataform_v1beta1

def sample_get_compilation_result():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.GetCompilationResultRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_compilation_result(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.

Fetches a single ReleaseConfig.

# 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 dataform_v1beta1

def sample_get_release_config():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.GetReleaseConfigRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Fetches a single Repository.

# 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 dataform_v1beta1

def sample_get_repository():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.GetRepositoryRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Fetches a single WorkflowConfig.

# 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 dataform_v1beta1

def sample_get_workflow_config():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.GetWorkflowConfigRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Fetches a single WorkflowInvocation.

# 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 dataform_v1beta1

def sample_get_workflow_invocation():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.GetWorkflowInvocationRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Fetches a single Workspace.

# 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 dataform_v1beta1

def sample_get_workspace():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.GetWorkspaceRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Installs dependency NPM packages (inside a Workspace).

# 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 dataform_v1beta1

def sample_install_npm_packages():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.InstallNpmPackagesRequest(
        workspace="workspace_value",
    )

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

    # Handle the response
    print(response)

Lists CompilationResults in a given Repository.

# 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 dataform_v1beta1

def sample_list_compilation_results():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.ListCompilationResultsRequest(
        parent="parent_value",
    )

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

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

Lists information about the supported locations for this service.

Lists ReleaseConfigs in a given Repository.

# 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 dataform_v1beta1

def sample_list_release_configs():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.ListReleaseConfigsRequest(
        parent="parent_value",
    )

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

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

Lists Repositories 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 dataform_v1beta1

def sample_list_repositories():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.ListRepositoriesRequest(
        parent="parent_value",
    )

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

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

Lists WorkflowConfigs in a given Repository.

# 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 dataform_v1beta1

def sample_list_workflow_configs():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.ListWorkflowConfigsRequest(
        parent="parent_value",
    )

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

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

Lists WorkflowInvocations in a given Repository.

# 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 dataform_v1beta1

def sample_list_workflow_invocations():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.ListWorkflowInvocationsRequest(
        parent="parent_value",
    )

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

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

Lists Workspaces in a given Repository.

# 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 dataform_v1beta1

def sample_list_workspaces():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.ListWorkspacesRequest(
        parent="parent_value",
    )

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

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

Creates a directory inside a Workspace.

# 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 dataform_v1beta1

def sample_make_directory():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.MakeDirectoryRequest(
        workspace="workspace_value",
        path="path_value",
    )

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

    # Handle the response
    print(response)

Moves a directory (inside a Workspace), and all of its contents, to a new 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 dataform_v1beta1

def sample_move_directory():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.MoveDirectoryRequest(
        workspace="workspace_value",
        path="path_value",
        new_path="new_path_value",
    )

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

    # Handle the response
    print(response)

Moves a file (inside a Workspace) to a new 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 dataform_v1beta1

def sample_move_file():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.MoveFileRequest(
        workspace="workspace_value",
        path="path_value",
        new_path="new_path_value",
    )

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

    # 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 compilation_result path into its component segments.

Parses a release_config path into its component segments.

Parses a repository path into its component segments.

Parses a secret_version path into its component segments.

Parses a workflow_config path into its component segments.

Parses a workflow_invocation path into its component segments.

Parses a workspace path into its component segments.

Pulls Git commits from the Repository's remote into a Workspace.

# 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 dataform_v1beta1

def sample_pull_git_commits():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    author = dataform_v1beta1.CommitAuthor()
    author.name = "name_value"
    author.email_address = "email_address_value"

    request = dataform_v1beta1.PullGitCommitsRequest(
        name="name_value",
        author=author,
    )

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

Pushes Git commits from a Workspace to the Repository's remote.

# 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 dataform_v1beta1

def sample_push_git_commits():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.PushGitCommitsRequest(
        name="name_value",
    )

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

Returns CompilationResultActions in a given CompilationResult.

# 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 dataform_v1beta1

def sample_query_compilation_result_actions():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.QueryCompilationResultActionsRequest(
        name="name_value",
    )

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

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

Returns the contents of a given Workspace directory.

# 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 dataform_v1beta1

def sample_query_directory_contents():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.QueryDirectoryContentsRequest(
        workspace="workspace_value",
    )

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

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

Returns the contents of a given Repository directory. The Repository must not have a value for git_remote_settings.url.

# 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 dataform_v1beta1

def sample_query_repository_directory_contents():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.QueryRepositoryDirectoryContentsRequest(
        name="name_value",
    )

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

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

Returns WorkflowInvocationActions in a given WorkflowInvocation.

# 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 dataform_v1beta1

def sample_query_workflow_invocation_actions():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.QueryWorkflowInvocationActionsRequest(
        name="name_value",
    )

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

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

Returns the contents of a file (inside a Workspace).

# 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 dataform_v1beta1

def sample_read_file():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.ReadFileRequest(
        workspace="workspace_value",
        path="path_value",
    )

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

    # Handle the response
    print(response)

Returns the contents of a file (inside a Repository). The Repository must not have a value for git_remote_settings.url.

# 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 dataform_v1beta1

def sample_read_repository_file():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.ReadRepositoryFileRequest(
        name="name_value",
        path="path_value",
    )

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

    # Handle the response
    print(response)

Returns a fully-qualified release_config string.

Deletes a directory (inside a Workspace) and all of its contents.

# 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 dataform_v1beta1

def sample_remove_directory():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.RemoveDirectoryRequest(
        workspace="workspace_value",
        path="path_value",
    )

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

Deletes a file (inside a Workspace).

# 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 dataform_v1beta1

def sample_remove_file():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.RemoveFileRequest(
        workspace="workspace_value",
        path="path_value",
    )

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

Returns a fully-qualified repository string.

Performs a Git reset for uncommitted files in a Workspace.

# 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 dataform_v1beta1

def sample_reset_workspace_changes():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.ResetWorkspaceChangesRequest(
        name="name_value",
    )

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

Returns a fully-qualified secret_version string.

Sets the IAM access control policy on the specified function.

Replaces any existing policy.

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.

Updates a single ReleaseConfig.

# 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 dataform_v1beta1

def sample_update_release_config():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    release_config = dataform_v1beta1.ReleaseConfig()
    release_config.git_commitish = "git_commitish_value"

    request = dataform_v1beta1.UpdateReleaseConfigRequest(
        release_config=release_config,
    )

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

    # Handle the response
    print(response)

Updates a single Repository.

# 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 dataform_v1beta1

def sample_update_repository():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.UpdateRepositoryRequest(
    )

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

    # Handle the response
    print(response)

Updates a single WorkflowConfig.

# 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 dataform_v1beta1

def sample_update_workflow_config():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    workflow_config = dataform_v1beta1.WorkflowConfig()
    workflow_config.release_config = "release_config_value"

    request = dataform_v1beta1.UpdateWorkflowConfigRequest(
        workflow_config=workflow_config,
    )

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

    # Handle the response
    print(response)

Returns a fully-qualified workflow_config string.

Returns a fully-qualified workflow_invocation string.

Returns a fully-qualified workspace string.

Writes to a file (inside a Workspace).

# 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 dataform_v1beta1

def sample_write_file():
    # Create a client
    client = dataform_v1beta1.DataformClient()

    # Initialize request argument(s)
    request = dataform_v1beta1.WriteFileRequest(
        workspace="workspace_value",
        path="path_value",
        contents=b'contents_blob',
    )

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

    # Handle the response
    print(response)