Class DataFusionAsyncClient (1.2.1)

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

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.

Inheritance

builtins.object > DataFusionAsyncClient

Properties

transport

Returns the transport used by the client instance.

Returns
TypeDescription
DataFusionTransportThe transport used by the client instance.

Methods

DataFusionAsyncClient

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

Parameters
NameDescription
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, `.DataFusionTransport`]

The transport to use. If set to None, a transport is chosen automatically.

client_options ClientOptions

Custom options for the client. It won't take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "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). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide client certificate for mutual TLS 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.

Exceptions
TypeDescription
google.auth.exceptions.MutualTlsChannelErrorIf mutual TLS transport creation failed for any reason.

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.

create_instance

create_instance(request: Optional[Union[google.cloud.data_fusion_v1.types.datafusion.CreateInstanceRequest, dict]] = None, *, parent: Optional[str] = None, instance: Optional[google.cloud.data_fusion_v1.types.datafusion.Instance] = None, instance_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a new Data Fusion instance in the specified project and location.

Parameters
NameDescription
request Union[google.cloud.data_fusion_v1.types.CreateInstanceRequest, dict]

The request object. Request message for creating a Data Fusion instance.

parent `str`

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

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
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be Instance Represents a Data Fusion instance.

delete_instance

delete_instance(request: Optional[Union[google.cloud.data_fusion_v1.types.datafusion.DeleteInstanceRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a single Date Fusion instance.

Parameters
NameDescription
request Union[google.cloud.data_fusion_v1.types.DeleteInstanceRequest, dict]

The request object. Request message for deleting a Data Fusion instance.

name `str`

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
TypeDescription
google.api_core.operation_async.AsyncOperationAn 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); } The JSON representation for Empty is empty JSON object {}.

from_service_account_file

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

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

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
DataFusionAsyncClientThe 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
NameDescription
info dict

The service account private key info.

Returns
TypeDescription
DataFusionAsyncClientThe 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
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
DataFusionAsyncClientThe constructed client.

get_instance

get_instance(request: Optional[Union[google.cloud.data_fusion_v1.types.datafusion.GetInstanceRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets details of a single Data Fusion instance.

Parameters
NameDescription
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
TypeDescription
google.cloud.data_fusion_v1.types.InstanceRepresents a Data Fusion instance.

get_transport_class

get_transport_class()

Returns an appropriate transport class.

instance_path

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

Returns a fully-qualified instance string.

list_available_versions

list_available_versions(request: Optional[Union[google.cloud.data_fusion_v1.types.datafusion.ListAvailableVersionsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists possible versions for Data Fusion instances in the specified project and location.

Parameters
NameDescription
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
TypeDescription
google.cloud.data_fusion_v1.services.data_fusion.pagers.ListAvailableVersionsAsyncPagerResponse message for the list available versions request. Iterating over this object will yield results and resolve additional pages automatically.

list_instances

list_instances(request: Optional[Union[google.cloud.data_fusion_v1.types.datafusion.ListInstancesRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists Data Fusion instances in the specified project and location.

Parameters
NameDescription
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
TypeDescription
google.cloud.data_fusion_v1.services.data_fusion.pagers.ListInstancesAsyncPagerResponse 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)

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_instance_path

parse_instance_path(path: str)

Parses a instance path into its component segments.

restart_instance

restart_instance(request: Optional[Union[google.cloud.data_fusion_v1.types.datafusion.RestartInstanceRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
NameDescription
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
TypeDescription
google.api_core.operation_async.AsyncOperationAn 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: Optional[Union[google.cloud.data_fusion_v1.types.datafusion.UpdateInstanceRequest, dict]] = None, *, instance: Optional[google.cloud.data_fusion_v1.types.datafusion.Instance] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates a single Data Fusion instance.

Parameters
NameDescription
request Union[google.cloud.data_fusion_v1.types.UpdateInstanceRequest, dict]

The request object.

instance Instance

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
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be Instance Represents a Data Fusion instance.