Class DataformClient (0.5.12)

DataformClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.dataform_v1beta1.services.dataform.transports.base.DataformTransport, typing.Callable[[...], google.cloud.dataform_v1beta1.services.dataform.transports.base.DataformTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

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

Properties

api_endpoint

Return the API endpoint used by the client instance.

Returns
Type Description
str The API endpoint used by the client instance.

transport

Returns the transport used by the client instance.

Returns
Type Description
DataformTransport The transport used by the client instance.

universe_domain

Return the universe domain used by the client instance.

Returns
Type Description
str The universe domain used by the client instance.

Methods

DataformClient

DataformClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.dataform_v1beta1.services.dataform.transports.base.DataformTransport, typing.Callable[[...], google.cloud.dataform_v1beta1.services.dataform.transports.base.DataformTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the dataform client.

Parameters
Name Description
credentials Optional[google.auth.credentials.Credentials]

The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

transport Optional[Union[str,DataformTransport,Callable[..., DataformTransport]]]

The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the DataformTransport constructor. If set to None, a transport is chosen automatically.

client_options Optional[Union[google.api_core.client_options.ClientOptions, dict]]

Custom options for the client. 1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used. 3. The universe_domain property can be used to override the default "googleapis.com" universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.

client_info google.api_core.gapic_v1.client_info.ClientInfo

The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If mutual TLS transport creation failed for any reason.

__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

cancel_workflow_invocation

cancel_workflow_invocation(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.CancelWorkflowInvocationRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.CancelWorkflowInvocationRequest, dict]

The request object. CancelWorkflowInvocation request message.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

commit_repository_changes

commit_repository_changes(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.CommitRepositoryChangesRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.CommitRepositoryChangesRequest, dict]

The request object. CommitRepositoryChanges request message.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

commit_workspace_changes

commit_workspace_changes(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.CommitWorkspaceChangesRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.CommitWorkspaceChangesRequest, dict]

The request object. CommitWorkspaceChanges request message.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

compilation_result_path

compilation_result_path(
    project: str, location: str, repository: str, compilation_result: str
) -> str

Returns a fully-qualified compilation_result string.

compute_repository_access_token_status

compute_repository_access_token_status(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.ComputeRepositoryAccessTokenStatusRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.dataform_v1beta1.types.dataform.ComputeRepositoryAccessTokenStatusResponse
)

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.ComputeRepositoryAccessTokenStatusRequest, dict]

The request object. ComputeRepositoryAccessTokenStatus request message.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.dataform_v1beta1.types.ComputeRepositoryAccessTokenStatusResponse ComputeRepositoryAccessTokenStatus response message.

create_compilation_result

create_compilation_result(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.CreateCompilationResultRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    compilation_result: typing.Optional[
        google.cloud.dataform_v1beta1.types.dataform.CompilationResult
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dataform_v1beta1.types.dataform.CompilationResult

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.CreateCompilationResultRequest, dict]

The request object. CreateCompilationResult request message.

parent str

Required. The repository in which to create the compilation result. Must be in the format projects//locations//repositories/*. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

compilation_result google.cloud.dataform_v1beta1.types.CompilationResult

Required. The compilation result to create. This corresponds to the compilation_result field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.dataform_v1beta1.types.CompilationResult Represents the result of compiling a Dataform project.

create_release_config

create_release_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.CreateReleaseConfigRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    release_config: typing.Optional[
        google.cloud.dataform_v1beta1.types.dataform.ReleaseConfig
    ] = None,
    release_config_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dataform_v1beta1.types.dataform.ReleaseConfig

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.CreateReleaseConfigRequest, dict]

The request object. CreateReleaseConfig request message.

parent str

Required. The repository in which to create the release config. Must be in the format projects//locations//repositories/*. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

release_config google.cloud.dataform_v1beta1.types.ReleaseConfig

Required. The release config to create. This corresponds to the release_config field on the request instance; if request is provided, this should not be set.

release_config_id str

Required. The ID to use for the release config, which will become the final component of the release config's resource name. This corresponds to the release_config_id field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.dataform_v1beta1.types.ReleaseConfig Represents a Dataform release configuration.

create_repository

create_repository(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.CreateRepositoryRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    repository: typing.Optional[
        google.cloud.dataform_v1beta1.types.dataform.Repository
    ] = None,
    repository_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dataform_v1beta1.types.dataform.Repository

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.CreateRepositoryRequest, dict]

The request object. CreateRepository request message.

parent str

Required. The location in which to create the repository. Must be in the format projects//locations/. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

repository google.cloud.dataform_v1beta1.types.Repository

Required. The repository to create. This corresponds to the repository field on the request instance; if request is provided, this should not be set.

repository_id str

Required. The ID to use for the repository, which will become the final component of the repository's resource name. This corresponds to the repository_id field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.dataform_v1beta1.types.Repository Represents a Dataform Git repository.

create_workflow_config

create_workflow_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.CreateWorkflowConfigRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    workflow_config: typing.Optional[
        google.cloud.dataform_v1beta1.types.dataform.WorkflowConfig
    ] = None,
    workflow_config_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dataform_v1beta1.types.dataform.WorkflowConfig

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.CreateWorkflowConfigRequest, dict]

The request object. CreateWorkflowConfig request message.

parent str

Required. The repository in which to create the workflow config. Must be in the format projects//locations//repositories/*. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

workflow_config google.cloud.dataform_v1beta1.types.WorkflowConfig

Required. The workflow config to create. This corresponds to the workflow_config field on the request instance; if request is provided, this should not be set.

workflow_config_id str

Required. The ID to use for the workflow config, which will become the final component of the workflow config's resource name. This corresponds to the workflow_config_id field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.dataform_v1beta1.types.WorkflowConfig Represents a Dataform workflow configuration.

create_workflow_invocation

create_workflow_invocation(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.CreateWorkflowInvocationRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    workflow_invocation: typing.Optional[
        google.cloud.dataform_v1beta1.types.dataform.WorkflowInvocation
    ] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dataform_v1beta1.types.dataform.WorkflowInvocation

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.CreateWorkflowInvocationRequest, dict]

The request object. CreateWorkflowInvocation request message.

parent str

Required. The repository in which to create the workflow invocation. Must be in the format projects//locations//repositories/*. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

workflow_invocation google.cloud.dataform_v1beta1.types.WorkflowInvocation

Required. The workflow invocation resource to create. This corresponds to the workflow_invocation field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.dataform_v1beta1.types.WorkflowInvocation Represents a single invocation of a compilation result.

create_workspace

create_workspace(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.CreateWorkspaceRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    workspace: typing.Optional[
        google.cloud.dataform_v1beta1.types.dataform.Workspace
    ] = None,
    workspace_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dataform_v1beta1.types.dataform.Workspace

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.CreateWorkspaceRequest, dict]

The request object. CreateWorkspace request message.

parent str

Required. The repository in which to create the workspace. Must be in the format projects//locations//repositories/*. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

workspace google.cloud.dataform_v1beta1.types.Workspace

Required. The workspace to create. This corresponds to the workspace field on the request instance; if request is provided, this should not be set.

workspace_id str

Required. The ID to use for the workspace, which will become the final component of the workspace's resource name. This corresponds to the workspace_id field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.dataform_v1beta1.types.Workspace Represents a Dataform Git workspace.

delete_release_config

delete_release_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.DeleteReleaseConfigRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.DeleteReleaseConfigRequest, dict]

The request object. DeleteReleaseConfig request message.

name str

Required. The release config's name. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

delete_repository

delete_repository(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.DeleteRepositoryRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.DeleteRepositoryRequest, dict]

The request object. DeleteRepository request message.

name str

Required. The repository's name. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

delete_workflow_config

delete_workflow_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.DeleteWorkflowConfigRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.DeleteWorkflowConfigRequest, dict]

The request object. DeleteWorkflowConfig request message.

name str

Required. The workflow config's name. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

delete_workflow_invocation

delete_workflow_invocation(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.DeleteWorkflowInvocationRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.DeleteWorkflowInvocationRequest, dict]

The request object. DeleteWorkflowInvocation request message.

name str

Required. The workflow invocation resource's name. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

delete_workspace

delete_workspace(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.DeleteWorkspaceRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.DeleteWorkspaceRequest, dict]

The request object. DeleteWorkspace request message.

name str

Required. The workspace resource's name. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

fetch_file_diff

fetch_file_diff(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.FetchFileDiffRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dataform_v1beta1.types.dataform.FetchFileDiffResponse

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.FetchFileDiffRequest, dict]

The request object. FetchFileDiff request message.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.dataform_v1beta1.types.FetchFileDiffResponse FetchFileDiff response message.

fetch_file_git_statuses

fetch_file_git_statuses(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.FetchFileGitStatusesRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dataform_v1beta1.types.dataform.FetchFileGitStatusesResponse

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.FetchFileGitStatusesRequest, dict]

The request object. FetchFileGitStatuses request message.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.dataform_v1beta1.types.FetchFileGitStatusesResponse FetchFileGitStatuses response message.

fetch_git_ahead_behind

fetch_git_ahead_behind(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.FetchGitAheadBehindRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dataform_v1beta1.types.dataform.FetchGitAheadBehindResponse

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.FetchGitAheadBehindRequest, dict]

The request object. FetchGitAheadBehind request message.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.dataform_v1beta1.types.FetchGitAheadBehindResponse FetchGitAheadBehind response message.

fetch_remote_branches

fetch_remote_branches(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.FetchRemoteBranchesRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dataform_v1beta1.types.dataform.FetchRemoteBranchesResponse

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.FetchRemoteBranchesRequest, dict]

The request object. FetchRemoteBranches request message.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.dataform_v1beta1.types.FetchRemoteBranchesResponse FetchRemoteBranches response message.

fetch_repository_history

fetch_repository_history(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.FetchRepositoryHistoryRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dataform_v1beta1.services.dataform.pagers.FetchRepositoryHistoryPager

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.FetchRepositoryHistoryRequest, dict]

The request object. FetchRepositoryHistory request message.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.dataform_v1beta1.services.dataform.pagers.FetchRepositoryHistoryPager FetchRepositoryHistory response message. Iterating over this object will yield results and resolve additional pages automatically.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

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

Parameter
Name Description
filename str

The path to the service account private key json file.

Returns
Type Description
DataformClient The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

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

Parameter
Name Description
info dict

The service account private key info.

Returns
Type Description
DataformClient The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

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

Parameter
Name Description
filename str

The path to the service account private key json file.

Returns
Type Description
DataformClient The constructed client.

get_compilation_result

get_compilation_result(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.GetCompilationResultRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dataform_v1beta1.types.dataform.CompilationResult

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.GetCompilationResultRequest, dict]

The request object. GetCompilationResult request message.

name str

Required. The compilation result's name. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.dataform_v1beta1.types.CompilationResult Represents the result of compiling a Dataform project.

get_iam_policy

get_iam_policy(
    request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy

Gets the IAM access control policy for a function.

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

Parameters
Name Description
request .iam_policy_pb2.GetIamPolicyRequest

The request object. Request message for GetIamPolicy method.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
.policy_pb2.Policy Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **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 < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ]="" }="" **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="">< timestamp('2020-10-01t00:00:00.000z')="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the="">IAM developer's guide __.

get_location

get_location(
    request: typing.Optional[
        google.cloud.location.locations_pb2.GetLocationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.Location

Gets information about a location.

Parameters
Name Description
request .location_pb2.GetLocationRequest

The request object. Request message for GetLocation method.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
.location_pb2.Location Location object.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

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.

Parameter
Name Description
client_options google.api_core.client_options.ClientOptions

Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If any errors happen.
Returns
Type Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]] returns the API endpoint and the client cert source to use.

get_release_config

get_release_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.GetReleaseConfigRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dataform_v1beta1.types.dataform.ReleaseConfig

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.GetReleaseConfigRequest, dict]

The request object. GetReleaseConfig request message.

name str

Required. The release config's name. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.dataform_v1beta1.types.ReleaseConfig Represents a Dataform release configuration.

get_repository

get_repository(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.GetRepositoryRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dataform_v1beta1.types.dataform.Repository

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.GetRepositoryRequest, dict]

The request object. GetRepository request message.

name str

Required. The repository's name. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.dataform_v1beta1.types.Repository Represents a Dataform Git repository.

get_workflow_config

get_workflow_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.GetWorkflowConfigRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dataform_v1beta1.types.dataform.WorkflowConfig

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.GetWorkflowConfigRequest, dict]

The request object. GetWorkflowConfig request message.

name str

Required. The workflow config's name. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.dataform_v1beta1.types.WorkflowConfig Represents a Dataform workflow configuration.

get_workflow_invocation

get_workflow_invocation(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.GetWorkflowInvocationRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dataform_v1beta1.types.dataform.WorkflowInvocation

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.GetWorkflowInvocationRequest, dict]

The request object. GetWorkflowInvocation request message.

name str

Required. The workflow invocation resource's name. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.dataform_v1beta1.types.WorkflowInvocation Represents a single invocation of a compilation result.

get_workspace

get_workspace(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.GetWorkspaceRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dataform_v1beta1.types.dataform.Workspace

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.GetWorkspaceRequest, dict]

The request object. GetWorkspace request message.

name str

Required. The workspace's name. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.dataform_v1beta1.types.Workspace Represents a Dataform Git workspace.

install_npm_packages

install_npm_packages(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.InstallNpmPackagesRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dataform_v1beta1.types.dataform.InstallNpmPackagesResponse

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.InstallNpmPackagesRequest, dict]

The request object. InstallNpmPackages request message.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.dataform_v1beta1.types.InstallNpmPackagesResponse InstallNpmPackages response message.

list_compilation_results

list_compilation_results(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.ListCompilationResultsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dataform_v1beta1.services.dataform.pagers.ListCompilationResultsPager

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.ListCompilationResultsRequest, dict]

The request object. ListCompilationResults request message.

parent str

Required. The repository in which to list compilation results. Must be in the format projects//locations//repositories/*. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.dataform_v1beta1.services.dataform.pagers.ListCompilationResultsPager ListCompilationResults response message. Iterating over this object will yield results and resolve additional pages automatically.

list_locations

list_locations(
    request: typing.Optional[
        google.cloud.location.locations_pb2.ListLocationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse

Lists information about the supported locations for this service.

Parameters
Name Description
request .location_pb2.ListLocationsRequest

The request object. Request message for ListLocations method.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
.location_pb2.ListLocationsResponse Response message for ListLocations method.

list_release_configs

list_release_configs(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.ListReleaseConfigsRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dataform_v1beta1.services.dataform.pagers.ListReleaseConfigsPager

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.ListReleaseConfigsRequest, dict]

The request object. ListReleaseConfigs request message.

parent str

Required. The repository in which to list release configs. Must be in the format projects//locations//repositories/*. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.dataform_v1beta1.services.dataform.pagers.ListReleaseConfigsPager ListReleaseConfigs response message. Iterating over this object will yield results and resolve additional pages automatically.

list_repositories

list_repositories(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.ListRepositoriesRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dataform_v1beta1.services.dataform.pagers.ListRepositoriesPager

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.ListRepositoriesRequest, dict]

The request object. ListRepositories request message.

parent str

Required. The location in which to list repositories. Must be in the format projects//locations/. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.dataform_v1beta1.services.dataform.pagers.ListRepositoriesPager ListRepositories response message. Iterating over this object will yield results and resolve additional pages automatically.

list_workflow_configs

list_workflow_configs(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.ListWorkflowConfigsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dataform_v1beta1.services.dataform.pagers.ListWorkflowConfigsPager

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.ListWorkflowConfigsRequest, dict]

The request object. ListWorkflowConfigs request message.

parent str

Required. The repository in which to list workflow configs. Must be in the format projects//locations//repositories/*. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.dataform_v1beta1.services.dataform.pagers.ListWorkflowConfigsPager ListWorkflowConfigs response message. Iterating over this object will yield results and resolve additional pages automatically.

list_workflow_invocations

list_workflow_invocations(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.ListWorkflowInvocationsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.dataform_v1beta1.services.dataform.pagers.ListWorkflowInvocationsPager
)

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.ListWorkflowInvocationsRequest, dict]

The request object. ListWorkflowInvocations request message.

parent str

Required. The parent resource of the WorkflowInvocation type. Must be in the format projects//locations//repositories/*. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.dataform_v1beta1.services.dataform.pagers.ListWorkflowInvocationsPager ListWorkflowInvocations response message. Iterating over this object will yield results and resolve additional pages automatically.

list_workspaces

list_workspaces(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.ListWorkspacesRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dataform_v1beta1.services.dataform.pagers.ListWorkspacesPager

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.ListWorkspacesRequest, dict]

The request object. ListWorkspaces request message.

parent str

Required. The repository in which to list workspaces. Must be in the format projects//locations//repositories/*. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.dataform_v1beta1.services.dataform.pagers.ListWorkspacesPager ListWorkspaces response message. Iterating over this object will yield results and resolve additional pages automatically.

make_directory

make_directory(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.MakeDirectoryRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dataform_v1beta1.types.dataform.MakeDirectoryResponse

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.MakeDirectoryRequest, dict]

The request object. MakeDirectory request message.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.dataform_v1beta1.types.MakeDirectoryResponse MakeDirectory response message.

move_directory

move_directory(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.MoveDirectoryRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dataform_v1beta1.types.dataform.MoveDirectoryResponse

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.MoveDirectoryRequest, dict]

The request object. MoveDirectory request message.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.dataform_v1beta1.types.MoveDirectoryResponse MoveDirectory response message.

move_file

move_file(
    request: typing.Optional[
        typing.Union[google.cloud.dataform_v1beta1.types.dataform.MoveFileRequest, dict]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dataform_v1beta1.types.dataform.MoveFileResponse

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.MoveFileRequest, dict]

The request object. MoveFile request message.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.dataform_v1beta1.types.MoveFileResponse MoveFile response message.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

parse_compilation_result_path

parse_compilation_result_path(path: str) -> typing.Dict[str, str]

Parses a compilation_result path into its component segments.

parse_release_config_path

parse_release_config_path(path: str) -> typing.Dict[str, str]

Parses a release_config path into its component segments.

parse_repository_path

parse_repository_path(path: str) -> typing.Dict[str, str]

Parses a repository path into its component segments.

parse_secret_version_path

parse_secret_version_path(path: str) -> typing.Dict[str, str]

Parses a secret_version path into its component segments.

parse_workflow_config_path

parse_workflow_config_path(path: str) -> typing.Dict[str, str]

Parses a workflow_config path into its component segments.

parse_workflow_invocation_path

parse_workflow_invocation_path(path: str) -> typing.Dict[str, str]

Parses a workflow_invocation path into its component segments.

parse_workspace_path

parse_workspace_path(path: str) -> typing.Dict[str, str]

Parses a workspace path into its component segments.

pull_git_commits

pull_git_commits(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.PullGitCommitsRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.PullGitCommitsRequest, dict]

The request object. PullGitCommits request message.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

push_git_commits

push_git_commits(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.PushGitCommitsRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.PushGitCommitsRequest, dict]

The request object. PushGitCommits request message.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

query_compilation_result_actions

query_compilation_result_actions(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.QueryCompilationResultActionsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.dataform_v1beta1.services.dataform.pagers.QueryCompilationResultActionsPager
)

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.QueryCompilationResultActionsRequest, dict]

The request object. QueryCompilationResultActions request message.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.dataform_v1beta1.services.dataform.pagers.QueryCompilationResultActionsPager QueryCompilationResultActions response message. Iterating over this object will yield results and resolve additional pages automatically.

query_directory_contents

query_directory_contents(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.QueryDirectoryContentsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dataform_v1beta1.services.dataform.pagers.QueryDirectoryContentsPager

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.QueryDirectoryContentsRequest, dict]

The request object. QueryDirectoryContents request message.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.dataform_v1beta1.services.dataform.pagers.QueryDirectoryContentsPager QueryDirectoryContents response message. Iterating over this object will yield results and resolve additional pages automatically.

query_repository_directory_contents

query_repository_directory_contents(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.QueryRepositoryDirectoryContentsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.dataform_v1beta1.services.dataform.pagers.QueryRepositoryDirectoryContentsPager
)

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.QueryRepositoryDirectoryContentsRequest, dict]

The request object. QueryRepositoryDirectoryContents request message.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.dataform_v1beta1.services.dataform.pagers.QueryRepositoryDirectoryContentsPager QueryRepositoryDirectoryContents response message. Iterating over this object will yield results and resolve additional pages automatically.

query_workflow_invocation_actions

query_workflow_invocation_actions(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.QueryWorkflowInvocationActionsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.dataform_v1beta1.services.dataform.pagers.QueryWorkflowInvocationActionsPager
)

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.QueryWorkflowInvocationActionsRequest, dict]

The request object. QueryWorkflowInvocationActions request message.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.dataform_v1beta1.services.dataform.pagers.QueryWorkflowInvocationActionsPager QueryWorkflowInvocationActions response message. Iterating over this object will yield results and resolve additional pages automatically.

read_file

read_file(
    request: typing.Optional[
        typing.Union[google.cloud.dataform_v1beta1.types.dataform.ReadFileRequest, dict]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dataform_v1beta1.types.dataform.ReadFileResponse

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.ReadFileRequest, dict]

The request object. ReadFile request message.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.dataform_v1beta1.types.ReadFileResponse ReadFile response message.

read_repository_file

read_repository_file(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.ReadRepositoryFileRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dataform_v1beta1.types.dataform.ReadRepositoryFileResponse

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.ReadRepositoryFileRequest, dict]

The request object. ReadRepositoryFile request message.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.dataform_v1beta1.types.ReadRepositoryFileResponse ReadRepositoryFile response message.

release_config_path

release_config_path(
    project: str, location: str, repository: str, release_config: str
) -> str

Returns a fully-qualified release_config string.

remove_directory

remove_directory(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.RemoveDirectoryRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.RemoveDirectoryRequest, dict]

The request object. RemoveDirectory request message.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

remove_file

remove_file(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.RemoveFileRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.RemoveFileRequest, dict]

The request object. RemoveFile request message.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

repository_path

repository_path(project: str, location: str, repository: str) -> str

Returns a fully-qualified repository string.

reset_workspace_changes

reset_workspace_changes(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.ResetWorkspaceChangesRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.ResetWorkspaceChangesRequest, dict]

The request object. ResetWorkspaceChanges request message.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

secret_version_path

secret_version_path(project: str, secret: str, version: str) -> str

Returns a fully-qualified secret_version string.

set_iam_policy

set_iam_policy(
    request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.policy_pb2.Policy

Sets the IAM access control policy on the specified function.

Replaces any existing policy.

Parameters
Name Description
request .iam_policy_pb2.SetIamPolicyRequest

The request object. Request message for SetIamPolicy method.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
.policy_pb2.Policy Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **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 < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ]="" }="" **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="">< timestamp('2020-10-01t00:00:00.000z')="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the="">IAM developer's guide __.

test_iam_permissions

test_iam_permissions(
    request: typing.Optional[
        google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse

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.

Parameters
Name Description
request .iam_policy_pb2.TestIamPermissionsRequest

The request object. Request message for TestIamPermissions method.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
.iam_policy_pb2.TestIamPermissionsResponse Response message for TestIamPermissions method.

update_release_config

update_release_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.UpdateReleaseConfigRequest,
            dict,
        ]
    ] = None,
    *,
    release_config: typing.Optional[
        google.cloud.dataform_v1beta1.types.dataform.ReleaseConfig
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dataform_v1beta1.types.dataform.ReleaseConfig

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.UpdateReleaseConfigRequest, dict]

The request object. UpdateReleaseConfig request message.

release_config google.cloud.dataform_v1beta1.types.ReleaseConfig

Required. The release config to update. This corresponds to the release_config field on the request instance; if request is provided, this should not be set.

update_mask google.protobuf.field_mask_pb2.FieldMask

Optional. Specifies the fields to be updated in the release config. If left unset, all fields will be updated. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.dataform_v1beta1.types.ReleaseConfig Represents a Dataform release configuration.

update_repository

update_repository(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.UpdateRepositoryRequest, dict
        ]
    ] = None,
    *,
    repository: typing.Optional[
        google.cloud.dataform_v1beta1.types.dataform.Repository
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dataform_v1beta1.types.dataform.Repository

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.UpdateRepositoryRequest, dict]

The request object. UpdateRepository request message.

repository google.cloud.dataform_v1beta1.types.Repository

Required. The repository to update. This corresponds to the repository field on the request instance; if request is provided, this should not be set.

update_mask google.protobuf.field_mask_pb2.FieldMask

Optional. Specifies the fields to be updated in the repository. If left unset, all fields will be updated. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.dataform_v1beta1.types.Repository Represents a Dataform Git repository.

update_workflow_config

update_workflow_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.UpdateWorkflowConfigRequest,
            dict,
        ]
    ] = None,
    *,
    workflow_config: typing.Optional[
        google.cloud.dataform_v1beta1.types.dataform.WorkflowConfig
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dataform_v1beta1.types.dataform.WorkflowConfig

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.UpdateWorkflowConfigRequest, dict]

The request object. UpdateWorkflowConfig request message.

workflow_config google.cloud.dataform_v1beta1.types.WorkflowConfig

Required. The workflow config to update. This corresponds to the workflow_config field on the request instance; if request is provided, this should not be set.

update_mask google.protobuf.field_mask_pb2.FieldMask

Optional. Specifies the fields to be updated in the workflow config. If left unset, all fields will be updated. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.dataform_v1beta1.types.WorkflowConfig Represents a Dataform workflow configuration.

workflow_config_path

workflow_config_path(
    project: str, location: str, repository: str, workflow_config: str
) -> str

Returns a fully-qualified workflow_config string.

workflow_invocation_path

workflow_invocation_path(
    project: str, location: str, repository: str, workflow_invocation: str
) -> str

Returns a fully-qualified workflow_invocation string.

workspace_path

workspace_path(project: str, location: str, repository: str, workspace: str) -> str

Returns a fully-qualified workspace string.

write_file

write_file(
    request: typing.Optional[
        typing.Union[
            google.cloud.dataform_v1beta1.types.dataform.WriteFileRequest, dict
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.dataform_v1beta1.types.dataform.WriteFileResponse

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)
Parameters
Name Description
request Union[google.cloud.dataform_v1beta1.types.WriteFileRequest, dict]

The request object. WriteFile request message.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.dataform_v1beta1.types.WriteFileResponse WriteFile response message.