Class DataFusionClient (1.11.1)

DataFusionClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.data_fusion_v1.services.data_fusion.transports.base.DataFusionTransport, typing.Callable[[...], google.cloud.data_fusion_v1.services.data_fusion.transports.base.DataFusionTransport]]] = 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>)

Service for creating and managing Data Fusion instances. Data Fusion enables ETL developers to build code-free, data integration pipelines via a point-and-click UI.

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
`DataFusionTransport`	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

DataFusionClient

DataFusionClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.data_fusion_v1.services.data_fusion.transports.base.DataFusionTransport, typing.Callable[[...], google.cloud.data_fusion_v1.services.data_fusion.transports.base.DataFusionTransport]]] = 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 data fusion 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,DataFusionTransport,Callable[..., DataFusionTransport]]]` 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 DataFusionTransport 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.

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.

create_instance

create_instance(
    request: typing.Optional[
        typing.Union[
            google.cloud.data_fusion_v1.types.datafusion.CreateInstanceRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    instance: typing.Optional[
        google.cloud.data_fusion_v1.types.datafusion.Instance
    ] = None,
    instance_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.api_core.operation.Operation

Creates a new Data Fusion instance in the specified 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 data_fusion_v1

def sample_create_instance():
    # Create a client
    client = data_fusion_v1.DataFusionClient()

    # Initialize request argument(s)
    request = data_fusion_v1.CreateInstanceRequest(
        parent="parent_value",
        instance_id="instance_id_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.data_fusion_v1.types.CreateInstanceRequest, dict]` The request object. Request message for creating a Data Fusion instance.
`parent`	`str` Required. The instance's project and location in the format projects/{project}/locations/{location}. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`instance`	`google.cloud.data_fusion_v1.types.Instance` An instance resource. This corresponds to the `instance` field on the `request` instance; if `request` is provided, this should not be set.
`instance_id`	`str` Required. The name of the instance to create. This corresponds to the `instance_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.api_core.operation.Operation`	An object representing a long-running operation. The result type for the operation will be Instance Represents a Data Fusion instance.

crypto_key_path

crypto_key_path(project: str, location: str, key_ring: str, crypto_key: str) -> str

Returns a fully-qualified crypto_key string.

delete_instance

delete_instance(
    request: typing.Optional[
        typing.Union[
            google.cloud.data_fusion_v1.types.datafusion.DeleteInstanceRequest, 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.api_core.operation.Operation

Deletes a single Date Fusion instance.

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

def sample_delete_instance():
    # Create a client
    client = data_fusion_v1.DataFusionClient()

    # Initialize request argument(s)
    request = data_fusion_v1.DeleteInstanceRequest(
        name="name_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.data_fusion_v1.types.DeleteInstanceRequest, dict]` The request object. Request message for deleting a Data Fusion instance.
`name`	`str` Required. The instance resource name in the format projects/{project}/locations/{location}/instances/{instance} 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.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

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
`DataFusionClient`	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
`DataFusionClient`	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
`DataFusionClient`	The constructed client.

get_instance

get_instance(
    request: typing.Optional[
        typing.Union[
            google.cloud.data_fusion_v1.types.datafusion.GetInstanceRequest, 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.data_fusion_v1.types.datafusion.Instance

Gets details of a single Data Fusion instance.

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

def sample_get_instance():
    # Create a client
    client = data_fusion_v1.DataFusionClient()

    # Initialize request argument(s)
    request = data_fusion_v1.GetInstanceRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.data_fusion_v1.types.GetInstanceRequest, dict]` The request object. Request message for getting details about a Data Fusion instance.
`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.data_fusion_v1.types.Instance`	Represents a Data Fusion instance.

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.

instance_path

instance_path(project: str, location: str, instance: str) -> str

Returns a fully-qualified instance string.

list_available_versions

list_available_versions(
    request: typing.Optional[
        typing.Union[
            google.cloud.data_fusion_v1.types.datafusion.ListAvailableVersionsRequest,
            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.data_fusion_v1.services.data_fusion.pagers.ListAvailableVersionsPager

Lists possible versions for Data Fusion instances in the specified 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 data_fusion_v1

def sample_list_available_versions():
    # Create a client
    client = data_fusion_v1.DataFusionClient()

    # Initialize request argument(s)
    request = data_fusion_v1.ListAvailableVersionsRequest(
        parent="parent_value",
    )

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

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

Parameters
Name	Description
`request`	`Union[google.cloud.data_fusion_v1.types.ListAvailableVersionsRequest, dict]` The request object. Request message for the list available versions request.
`parent`	`str` Required. The project and location for which to retrieve instance information in the format projects/{project}/locations/{location}. 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.data_fusion_v1.services.data_fusion.pagers.ListAvailableVersionsPager`	Response message for the list available versions request. Iterating over this object will yield results and resolve additional pages automatically.

list_instances

list_instances(
    request: typing.Optional[
        typing.Union[
            google.cloud.data_fusion_v1.types.datafusion.ListInstancesRequest, 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.data_fusion_v1.services.data_fusion.pagers.ListInstancesPager

Lists Data Fusion instances in the specified 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 data_fusion_v1

def sample_list_instances():
    # Create a client
    client = data_fusion_v1.DataFusionClient()

    # Initialize request argument(s)
    request = data_fusion_v1.ListInstancesRequest(
        parent="parent_value",
    )

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

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

Parameters
Name	Description
`request`	`Union[google.cloud.data_fusion_v1.types.ListInstancesRequest, dict]` The request object. Request message for listing Data Fusion instances.
`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.data_fusion_v1.services.data_fusion.pagers.ListInstancesPager`	Response message for the list instance request. Iterating over this object will yield results and resolve additional pages automatically.

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_crypto_key_path

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

Parses a crypto_key path into its component segments.

parse_instance_path

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

Parses a instance path into its component segments.

restart_instance

restart_instance(
    request: typing.Optional[
        typing.Union[
            google.cloud.data_fusion_v1.types.datafusion.RestartInstanceRequest, 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.api_core.operation.Operation

Restart a single Data Fusion instance. At the end of an operation instance is fully restarted.

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

def sample_restart_instance():
    # Create a client
    client = data_fusion_v1.DataFusionClient()

    # Initialize request argument(s)
    request = data_fusion_v1.RestartInstanceRequest(
        name="name_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.data_fusion_v1.types.RestartInstanceRequest, dict]` The request object. Request message for restarting a Data Fusion instance.
`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.api_core.operation.Operation`	An object representing a long-running operation. The result type for the operation will be Instance Represents a Data Fusion instance.

update_instance

update_instance(
    request: typing.Optional[
        typing.Union[
            google.cloud.data_fusion_v1.types.datafusion.UpdateInstanceRequest, dict
        ]
    ] = None,
    *,
    instance: typing.Optional[
        google.cloud.data_fusion_v1.types.datafusion.Instance
    ] = 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.api_core.operation.Operation

Updates a single Data Fusion instance.

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

def sample_update_instance():
    # Create a client
    client = data_fusion_v1.DataFusionClient()

    # Initialize request argument(s)
    instance = data_fusion_v1.Instance()
    instance.type_ = "DEVELOPER"

    request = data_fusion_v1.UpdateInstanceRequest(
        instance=instance,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.data_fusion_v1.types.UpdateInstanceRequest, dict]` The request object. Request message for updating a Data Fusion instance. Data Fusion allows updating the labels, options, and stack driver settings. This is also used for CDF version upgrade.
`instance`	`google.cloud.data_fusion_v1.types.Instance` Required. The instance resource that replaces the resource on the server. Currently, Data Fusion only allows replacing labels, options, and stack driver settings. All other fields will be ignored. This corresponds to the `instance` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` Field mask is used to specify the fields that the update will overwrite in an instance resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask, all the supported fields (labels, options, and version currently) will be overwritten. 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.api_core.operation.Operation`	An object representing a long-running operation. The result type for the operation will be Instance Represents a Data Fusion instance.