DataformClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dataform_v1alpha2.services.dataform.transports.base.DataformTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = 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
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
DataformTransport | The transport used by the client instance. |
Methods
DataformClient
DataformClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.dataform_v1alpha2.services.dataform.transports.base.DataformTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = 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 |
Union[str, DataformTransport]
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. It won't take effect if a |
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 |
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: Optional[Union[google.cloud.dataform_v1alpha2.types.dataform.CancelWorkflowInvocationRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Requests cancellation of a running WorkflowInvocation.
from google.cloud import dataform_v1alpha2
def sample_cancel_workflow_invocation():
# Create a client
client = dataform_v1alpha2.DataformClient()
# Initialize request argument(s)
request = dataform_v1alpha2.CancelWorkflowInvocationRequest(
name="name_value",
)
# Make the request
client.cancel_workflow_invocation(request=request)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dataform_v1alpha2.types.CancelWorkflowInvocationRequest, dict]
The request object. |
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: Optional[Union[google.cloud.dataform_v1alpha2.types.dataform.CommitWorkspaceChangesRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Applies a Git commit for uncommitted files in a Workspace.
from google.cloud import dataform_v1alpha2
def sample_commit_workspace_changes():
# Create a client
client = dataform_v1alpha2.DataformClient()
# Initialize request argument(s)
author = dataform_v1alpha2.CommitAuthor()
author.name = "name_value"
author.email_address = "email_address_value"
request = dataform_v1alpha2.CommitWorkspaceChangesRequest(
name="name_value",
author=author,
)
# Make the request
client.commit_workspace_changes(request=request)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dataform_v1alpha2.types.CommitWorkspaceChangesRequest, dict]
The request object. |
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)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
compilation_result_path
compilation_result_path(
project: str, location: str, repository: str, compilation_result: str
)
Returns a fully-qualified compilation_result string.
create_compilation_result
create_compilation_result(request: Optional[Union[google.cloud.dataform_v1alpha2.types.dataform.CreateCompilationResultRequest, dict]] = None, *, parent: Optional[str] = None, compilation_result: Optional[google.cloud.dataform_v1alpha2.types.dataform.CompilationResult] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a new CompilationResult in a given project and location.
from google.cloud import dataform_v1alpha2
def sample_create_compilation_result():
# Create a client
client = dataform_v1alpha2.DataformClient()
# Initialize request argument(s)
compilation_result = dataform_v1alpha2.CompilationResult()
compilation_result.git_commitish = "git_commitish_value"
request = dataform_v1alpha2.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_v1alpha2.types.CreateCompilationResultRequest, dict]
The request object. |
parent |
str
Required. The repository in which to create the compilation result. Must be in the format |
compilation_result |
google.cloud.dataform_v1alpha2.types.CompilationResult
Required. The compilation result to create. This corresponds to the |
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_v1alpha2.types.CompilationResult | Represents the result of compiling a Dataform project. |
create_repository
create_repository(request: Optional[Union[google.cloud.dataform_v1alpha2.types.dataform.CreateRepositoryRequest, dict]] = None, *, parent: Optional[str] = None, repository: Optional[google.cloud.dataform_v1alpha2.types.dataform.Repository] = None, repository_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a new Repository in a given project and location.
from google.cloud import dataform_v1alpha2
def sample_create_repository():
# Create a client
client = dataform_v1alpha2.DataformClient()
# Initialize request argument(s)
request = dataform_v1alpha2.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_v1alpha2.types.CreateRepositoryRequest, dict]
The request object. |
parent |
str
Required. The location in which to create the repository. Must be in the format |
repository |
google.cloud.dataform_v1alpha2.types.Repository
Required. The repository to create. This corresponds to the |
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 |
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_v1alpha2.types.Repository | Represents a Dataform Git repository. |
create_workflow_invocation
create_workflow_invocation(request: Optional[Union[google.cloud.dataform_v1alpha2.types.dataform.CreateWorkflowInvocationRequest, dict]] = None, *, parent: Optional[str] = None, workflow_invocation: Optional[google.cloud.dataform_v1alpha2.types.dataform.WorkflowInvocation] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a new WorkflowInvocation in a given Repository.
from google.cloud import dataform_v1alpha2
def sample_create_workflow_invocation():
# Create a client
client = dataform_v1alpha2.DataformClient()
# Initialize request argument(s)
request = dataform_v1alpha2.CreateWorkflowInvocationRequest(
parent="parent_value",
)
# Make the request
response = client.create_workflow_invocation(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dataform_v1alpha2.types.CreateWorkflowInvocationRequest, dict]
The request object. |
parent |
str
Required. The parent resource of the WorkflowInvocation type. This corresponds to the |
workflow_invocation |
google.cloud.dataform_v1alpha2.types.WorkflowInvocation
Required. The workflow invocation resource to create. This corresponds to the |
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_v1alpha2.types.WorkflowInvocation | Represents a single invocation of a compilation result. |
create_workspace
create_workspace(request: Optional[Union[google.cloud.dataform_v1alpha2.types.dataform.CreateWorkspaceRequest, dict]] = None, *, parent: Optional[str] = None, workspace: Optional[google.cloud.dataform_v1alpha2.types.dataform.Workspace] = None, workspace_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a new Workspace in a given Repository.
from google.cloud import dataform_v1alpha2
def sample_create_workspace():
# Create a client
client = dataform_v1alpha2.DataformClient()
# Initialize request argument(s)
request = dataform_v1alpha2.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_v1alpha2.types.CreateWorkspaceRequest, dict]
The request object. |
parent |
str
Required. The repository in which to create the workspace. Must be in the format |
workspace |
google.cloud.dataform_v1alpha2.types.Workspace
Required. The workspace to create. This corresponds to the |
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 |
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_v1alpha2.types.Workspace | Represents a Dataform Git workspace. |
delete_repository
delete_repository(request: Optional[Union[google.cloud.dataform_v1alpha2.types.dataform.DeleteRepositoryRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes a single Repository.
from google.cloud import dataform_v1alpha2
def sample_delete_repository():
# Create a client
client = dataform_v1alpha2.DataformClient()
# Initialize request argument(s)
request = dataform_v1alpha2.DeleteRepositoryRequest(
name="name_value",
)
# Make the request
client.delete_repository(request=request)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dataform_v1alpha2.types.DeleteRepositoryRequest, dict]
The request object. |
name |
str
Required. The repository's name. This corresponds to the |
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: Optional[Union[google.cloud.dataform_v1alpha2.types.dataform.DeleteWorkflowInvocationRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes a single WorkflowInvocation.
from google.cloud import dataform_v1alpha2
def sample_delete_workflow_invocation():
# Create a client
client = dataform_v1alpha2.DataformClient()
# Initialize request argument(s)
request = dataform_v1alpha2.DeleteWorkflowInvocationRequest(
name="name_value",
)
# Make the request
client.delete_workflow_invocation(request=request)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dataform_v1alpha2.types.DeleteWorkflowInvocationRequest, dict]
The request object. |
name |
str
Required. The workflow invocation resource's name. This corresponds to the |
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: Optional[Union[google.cloud.dataform_v1alpha2.types.dataform.DeleteWorkspaceRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes a single Workspace.
from google.cloud import dataform_v1alpha2
def sample_delete_workspace():
# Create a client
client = dataform_v1alpha2.DataformClient()
# Initialize request argument(s)
request = dataform_v1alpha2.DeleteWorkspaceRequest(
name="name_value",
)
# Make the request
client.delete_workspace(request=request)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dataform_v1alpha2.types.DeleteWorkspaceRequest, dict]
The request object. |
name |
str
Required. The workspace resource's name. This corresponds to the |
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: Optional[Union[google.cloud.dataform_v1alpha2.types.dataform.FetchFileDiffRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Fetches Git diff for an uncommitted file in a Workspace.
from google.cloud import dataform_v1alpha2
def sample_fetch_file_diff():
# Create a client
client = dataform_v1alpha2.DataformClient()
# Initialize request argument(s)
request = dataform_v1alpha2.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_v1alpha2.types.FetchFileDiffRequest, dict]
The request object. |
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_v1alpha2.types.FetchFileDiffResponse | FetchFileDiff response message. |
fetch_file_git_statuses
fetch_file_git_statuses(request: Optional[Union[google.cloud.dataform_v1alpha2.types.dataform.FetchFileGitStatusesRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Fetches Git statuses for the files in a Workspace.
from google.cloud import dataform_v1alpha2
def sample_fetch_file_git_statuses():
# Create a client
client = dataform_v1alpha2.DataformClient()
# Initialize request argument(s)
request = dataform_v1alpha2.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_v1alpha2.types.FetchFileGitStatusesRequest, dict]
The request object. |
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_v1alpha2.types.FetchFileGitStatusesResponse | FetchFileGitStatuses response message. |
fetch_git_ahead_behind
fetch_git_ahead_behind(request: Optional[Union[google.cloud.dataform_v1alpha2.types.dataform.FetchGitAheadBehindRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Fetches Git ahead/behind against a remote branch.
from google.cloud import dataform_v1alpha2
def sample_fetch_git_ahead_behind():
# Create a client
client = dataform_v1alpha2.DataformClient()
# Initialize request argument(s)
request = dataform_v1alpha2.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_v1alpha2.types.FetchGitAheadBehindRequest, dict]
The request object. |
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_v1alpha2.types.FetchGitAheadBehindResponse | FetchGitAheadBehind response message. |
fetch_remote_branches
fetch_remote_branches(request: Optional[Union[google.cloud.dataform_v1alpha2.types.dataform.FetchRemoteBranchesRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Fetches a Repository's remote branches.
from google.cloud import dataform_v1alpha2
def sample_fetch_remote_branches():
# Create a client
client = dataform_v1alpha2.DataformClient()
# Initialize request argument(s)
request = dataform_v1alpha2.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_v1alpha2.types.FetchRemoteBranchesRequest, dict]
The request object. |
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_v1alpha2.types.FetchRemoteBranchesResponse | FetchRemoteBranches response message. |
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: Optional[Union[google.cloud.dataform_v1alpha2.types.dataform.GetCompilationResultRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Fetches a single CompilationResult.
from google.cloud import dataform_v1alpha2
def sample_get_compilation_result():
# Create a client
client = dataform_v1alpha2.DataformClient()
# Initialize request argument(s)
request = dataform_v1alpha2.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_v1alpha2.types.GetCompilationResultRequest, dict]
The request object. |
name |
str
Required. The compilation result's name. This corresponds to the |
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_v1alpha2.types.CompilationResult | Represents the result of compiling a Dataform project. |
get_iam_policy
get_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
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 |
The request object. Request message for |
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 |
| 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** .. code-block:: python { "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: Optional[google.cloud.location.locations_pb2.GetLocationRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Gets information about a location.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
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 object. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)
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 variabel 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 |
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_repository
get_repository(request: Optional[Union[google.cloud.dataform_v1alpha2.types.dataform.GetRepositoryRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Fetches a single Repository.
from google.cloud import dataform_v1alpha2
def sample_get_repository():
# Create a client
client = dataform_v1alpha2.DataformClient()
# Initialize request argument(s)
request = dataform_v1alpha2.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_v1alpha2.types.GetRepositoryRequest, dict]
The request object. |
name |
str
Required. The repository's name. This corresponds to the |
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_v1alpha2.types.Repository | Represents a Dataform Git repository. |
get_workflow_invocation
get_workflow_invocation(request: Optional[Union[google.cloud.dataform_v1alpha2.types.dataform.GetWorkflowInvocationRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Fetches a single WorkflowInvocation.
from google.cloud import dataform_v1alpha2
def sample_get_workflow_invocation():
# Create a client
client = dataform_v1alpha2.DataformClient()
# Initialize request argument(s)
request = dataform_v1alpha2.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_v1alpha2.types.GetWorkflowInvocationRequest, dict]
The request object. |
name |
str
Required. The workflow invocation resource's name. This corresponds to the |
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_v1alpha2.types.WorkflowInvocation | Represents a single invocation of a compilation result. |
get_workspace
get_workspace(request: Optional[Union[google.cloud.dataform_v1alpha2.types.dataform.GetWorkspaceRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Fetches a single Workspace.
from google.cloud import dataform_v1alpha2
def sample_get_workspace():
# Create a client
client = dataform_v1alpha2.DataformClient()
# Initialize request argument(s)
request = dataform_v1alpha2.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_v1alpha2.types.GetWorkspaceRequest, dict]
The request object. |
name |
str
Required. The workspace's name. This corresponds to the |
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_v1alpha2.types.Workspace | Represents a Dataform Git workspace. |
install_npm_packages
install_npm_packages(request: Optional[Union[google.cloud.dataform_v1alpha2.types.dataform.InstallNpmPackagesRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Installs dependency NPM packages (inside a Workspace).
from google.cloud import dataform_v1alpha2
def sample_install_npm_packages():
# Create a client
client = dataform_v1alpha2.DataformClient()
# Initialize request argument(s)
request = dataform_v1alpha2.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_v1alpha2.types.InstallNpmPackagesRequest, dict]
The request object. |
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_v1alpha2.types.InstallNpmPackagesResponse | InstallNpmPackages response message. |
list_compilation_results
list_compilation_results(request: Optional[Union[google.cloud.dataform_v1alpha2.types.dataform.ListCompilationResultsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists CompilationResults in a given Repository.
from google.cloud import dataform_v1alpha2
def sample_list_compilation_results():
# Create a client
client = dataform_v1alpha2.DataformClient()
# Initialize request argument(s)
request = dataform_v1alpha2.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_v1alpha2.types.ListCompilationResultsRequest, dict]
The request object. |
parent |
str
Required. The repository in which to list compilation results. Must be in the format |
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_v1alpha2.services.dataform.pagers.ListCompilationResultsPager | ListCompilationResults response message. Iterating over this object will yield results and resolve additional pages automatically. |
list_locations
list_locations(request: Optional[google.cloud.location.locations_pb2.ListLocationsRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists information about the supported locations for this service.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
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 |
| Response message for ListLocations method. |
list_repositories
list_repositories(request: Optional[Union[google.cloud.dataform_v1alpha2.types.dataform.ListRepositoriesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists Repositories in a given project and location.
from google.cloud import dataform_v1alpha2
def sample_list_repositories():
# Create a client
client = dataform_v1alpha2.DataformClient()
# Initialize request argument(s)
request = dataform_v1alpha2.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_v1alpha2.types.ListRepositoriesRequest, dict]
The request object. |
parent |
str
Required. The location in which to list repositories. Must be in the format |
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_v1alpha2.services.dataform.pagers.ListRepositoriesPager | ListRepositories response message. Iterating over this object will yield results and resolve additional pages automatically. |
list_workflow_invocations
list_workflow_invocations(request: Optional[Union[google.cloud.dataform_v1alpha2.types.dataform.ListWorkflowInvocationsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists WorkflowInvocations in a given Repository.
from google.cloud import dataform_v1alpha2
def sample_list_workflow_invocations():
# Create a client
client = dataform_v1alpha2.DataformClient()
# Initialize request argument(s)
request = dataform_v1alpha2.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_v1alpha2.types.ListWorkflowInvocationsRequest, dict]
The request object. |
parent |
str
Required. The parent resource of the WorkflowInvocation type. Must be in the format |
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_v1alpha2.services.dataform.pagers.ListWorkflowInvocationsPager | ListWorkflowInvocations response message. Iterating over this object will yield results and resolve additional pages automatically. |
list_workspaces
list_workspaces(request: Optional[Union[google.cloud.dataform_v1alpha2.types.dataform.ListWorkspacesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists Workspaces in a given Repository.
from google.cloud import dataform_v1alpha2
def sample_list_workspaces():
# Create a client
client = dataform_v1alpha2.DataformClient()
# Initialize request argument(s)
request = dataform_v1alpha2.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_v1alpha2.types.ListWorkspacesRequest, dict]
The request object. |
parent |
str
Required. The repository in which to list workspaces. Must be in the format |
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_v1alpha2.services.dataform.pagers.ListWorkspacesPager | ListWorkspaces response message. Iterating over this object will yield results and resolve additional pages automatically. |
make_directory
make_directory(request: Optional[Union[google.cloud.dataform_v1alpha2.types.dataform.MakeDirectoryRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a directory inside a Workspace.
from google.cloud import dataform_v1alpha2
def sample_make_directory():
# Create a client
client = dataform_v1alpha2.DataformClient()
# Initialize request argument(s)
request = dataform_v1alpha2.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_v1alpha2.types.MakeDirectoryRequest, dict]
The request object. |
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_v1alpha2.types.MakeDirectoryResponse | MakeDirectory response message. |
move_directory
move_directory(request: Optional[Union[google.cloud.dataform_v1alpha2.types.dataform.MoveDirectoryRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Moves a directory (inside a Workspace), and all of its contents, to a new location.
from google.cloud import dataform_v1alpha2
def sample_move_directory():
# Create a client
client = dataform_v1alpha2.DataformClient()
# Initialize request argument(s)
request = dataform_v1alpha2.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_v1alpha2.types.MoveDirectoryRequest, dict]
The request object. |
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_v1alpha2.types.MoveDirectoryResponse | MoveDirectory response message. |
move_file
move_file(request: Optional[Union[google.cloud.dataform_v1alpha2.types.dataform.MoveFileRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Moves a file (inside a Workspace) to a new location.
from google.cloud import dataform_v1alpha2
def sample_move_file():
# Create a client
client = dataform_v1alpha2.DataformClient()
# Initialize request argument(s)
request = dataform_v1alpha2.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_v1alpha2.types.MoveFileRequest, dict]
The request object. |
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_v1alpha2.types.MoveFileResponse | MoveFile response message. |
parse_common_billing_account_path
parse_common_billing_account_path(path: str)
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
parse_compilation_result_path
parse_compilation_result_path(path: str)
Parses a compilation_result path into its component segments.
parse_repository_path
parse_repository_path(path: str)
Parses a repository path into its component segments.
parse_secret_version_path
parse_secret_version_path(path: str)
Parses a secret_version path into its component segments.
parse_workflow_invocation_path
parse_workflow_invocation_path(path: str)
Parses a workflow_invocation path into its component segments.
parse_workspace_path
parse_workspace_path(path: str)
Parses a workspace path into its component segments.
pull_git_commits
pull_git_commits(request: Optional[Union[google.cloud.dataform_v1alpha2.types.dataform.PullGitCommitsRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Pulls Git commits from the Repository's remote into a Workspace.
from google.cloud import dataform_v1alpha2
def sample_pull_git_commits():
# Create a client
client = dataform_v1alpha2.DataformClient()
# Initialize request argument(s)
author = dataform_v1alpha2.CommitAuthor()
author.name = "name_value"
author.email_address = "email_address_value"
request = dataform_v1alpha2.PullGitCommitsRequest(
name="name_value",
author=author,
)
# Make the request
client.pull_git_commits(request=request)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dataform_v1alpha2.types.PullGitCommitsRequest, dict]
The request object. |
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: Optional[Union[google.cloud.dataform_v1alpha2.types.dataform.PushGitCommitsRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Pushes Git commits from a Workspace to the Repository's remote.
from google.cloud import dataform_v1alpha2
def sample_push_git_commits():
# Create a client
client = dataform_v1alpha2.DataformClient()
# Initialize request argument(s)
request = dataform_v1alpha2.PushGitCommitsRequest(
name="name_value",
)
# Make the request
client.push_git_commits(request=request)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dataform_v1alpha2.types.PushGitCommitsRequest, dict]
The request object. |
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: Optional[Union[google.cloud.dataform_v1alpha2.types.dataform.QueryCompilationResultActionsRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Returns CompilationResultActions in a given CompilationResult.
from google.cloud import dataform_v1alpha2
def sample_query_compilation_result_actions():
# Create a client
client = dataform_v1alpha2.DataformClient()
# Initialize request argument(s)
request = dataform_v1alpha2.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_v1alpha2.types.QueryCompilationResultActionsRequest, dict]
The request object. |
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_v1alpha2.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: Optional[Union[google.cloud.dataform_v1alpha2.types.dataform.QueryDirectoryContentsRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Returns the contents of a given Workspace directory.
from google.cloud import dataform_v1alpha2
def sample_query_directory_contents():
# Create a client
client = dataform_v1alpha2.DataformClient()
# Initialize request argument(s)
request = dataform_v1alpha2.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_v1alpha2.types.QueryDirectoryContentsRequest, dict]
The request object. |
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_v1alpha2.services.dataform.pagers.QueryDirectoryContentsPager | QueryDirectoryContents response message. Iterating over this object will yield results and resolve additional pages automatically. |
query_workflow_invocation_actions
query_workflow_invocation_actions(request: Optional[Union[google.cloud.dataform_v1alpha2.types.dataform.QueryWorkflowInvocationActionsRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Returns WorkflowInvocationActions in a given WorkflowInvocation.
from google.cloud import dataform_v1alpha2
def sample_query_workflow_invocation_actions():
# Create a client
client = dataform_v1alpha2.DataformClient()
# Initialize request argument(s)
request = dataform_v1alpha2.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_v1alpha2.types.QueryWorkflowInvocationActionsRequest, dict]
The request object. |
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_v1alpha2.services.dataform.pagers.QueryWorkflowInvocationActionsPager | QueryWorkflowInvocationActions response message. Iterating over this object will yield results and resolve additional pages automatically. |
read_file
read_file(request: Optional[Union[google.cloud.dataform_v1alpha2.types.dataform.ReadFileRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Returns the contents of a file (inside a Workspace).
from google.cloud import dataform_v1alpha2
def sample_read_file():
# Create a client
client = dataform_v1alpha2.DataformClient()
# Initialize request argument(s)
request = dataform_v1alpha2.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_v1alpha2.types.ReadFileRequest, dict]
The request object. |
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_v1alpha2.types.ReadFileResponse | ReadFile response message. |
remove_directory
remove_directory(request: Optional[Union[google.cloud.dataform_v1alpha2.types.dataform.RemoveDirectoryRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes a directory (inside a Workspace) and all of its contents.
from google.cloud import dataform_v1alpha2
def sample_remove_directory():
# Create a client
client = dataform_v1alpha2.DataformClient()
# Initialize request argument(s)
request = dataform_v1alpha2.RemoveDirectoryRequest(
workspace="workspace_value",
path="path_value",
)
# Make the request
client.remove_directory(request=request)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dataform_v1alpha2.types.RemoveDirectoryRequest, dict]
The request object. |
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: Optional[Union[google.cloud.dataform_v1alpha2.types.dataform.RemoveFileRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes a file (inside a Workspace).
from google.cloud import dataform_v1alpha2
def sample_remove_file():
# Create a client
client = dataform_v1alpha2.DataformClient()
# Initialize request argument(s)
request = dataform_v1alpha2.RemoveFileRequest(
workspace="workspace_value",
path="path_value",
)
# Make the request
client.remove_file(request=request)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dataform_v1alpha2.types.RemoveFileRequest, dict]
The request object. |
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)
Returns a fully-qualified repository string.
reset_workspace_changes
reset_workspace_changes(request: Optional[Union[google.cloud.dataform_v1alpha2.types.dataform.ResetWorkspaceChangesRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Performs a Git reset for uncommitted files in a Workspace.
from google.cloud import dataform_v1alpha2
def sample_reset_workspace_changes():
# Create a client
client = dataform_v1alpha2.DataformClient()
# Initialize request argument(s)
request = dataform_v1alpha2.ResetWorkspaceChangesRequest(
name="name_value",
)
# Make the request
client.reset_workspace_changes(request=request)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dataform_v1alpha2.types.ResetWorkspaceChangesRequest, dict]
The request object. |
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)
Returns a fully-qualified secret_version string.
set_iam_policy
set_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Sets the IAM access control policy on the specified function.
Replaces any existing policy.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
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 |
| 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** .. code-block:: python { "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: Optional[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
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 |
The request object. Request message for |
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 |
| Response message for TestIamPermissions method. |
update_repository
update_repository(request: Optional[Union[google.cloud.dataform_v1alpha2.types.dataform.UpdateRepositoryRequest, dict]] = None, *, repository: Optional[google.cloud.dataform_v1alpha2.types.dataform.Repository] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Updates a single Repository.
from google.cloud import dataform_v1alpha2
def sample_update_repository():
# Create a client
client = dataform_v1alpha2.DataformClient()
# Initialize request argument(s)
request = dataform_v1alpha2.UpdateRepositoryRequest(
)
# Make the request
response = client.update_repository(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.dataform_v1alpha2.types.UpdateRepositoryRequest, dict]
The request object. |
repository |
google.cloud.dataform_v1alpha2.types.Repository
Required. The repository to update. This corresponds to the |
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 |
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_v1alpha2.types.Repository | Represents a Dataform Git repository. |
workflow_invocation_path
workflow_invocation_path(
project: str, location: str, repository: str, workflow_invocation: str
)
Returns a fully-qualified workflow_invocation string.
workspace_path
workspace_path(project: str, location: str, repository: str, workspace: str)
Returns a fully-qualified workspace string.
write_file
write_file(request: Optional[Union[google.cloud.dataform_v1alpha2.types.dataform.WriteFileRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Writes to a file (inside a Workspace).
from google.cloud import dataform_v1alpha2
def sample_write_file():
# Create a client
client = dataform_v1alpha2.DataformClient()
# Initialize request argument(s)
request = dataform_v1alpha2.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_v1alpha2.types.WriteFileRequest, dict]
The request object. |
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_v1alpha2.types.WriteFileResponse | WriteFile response message. |