As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Cloud Data Fusion v1 API

class google.cloud.data_fusion_v1.types.Accelerator(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Identifies Data Fusion accelerators for an instance.

accelerator_type

The type of an accelator for a CDF instance.

Type

google.cloud.data_fusion_v1.types.Accelerator.AcceleratorType

state

The state of the accelerator

Type

google.cloud.data_fusion_v1.types.Accelerator.State

class AcceleratorType(value)

Bases: proto.enums.Enum

Each type represents an Accelerator (Add-On) supported by Cloud Data Fusion service.

Values:

ACCELERATOR_TYPE_UNSPECIFIED (0):

Default value, if unspecified.

CDC (1):

Change Data Capture accelerator for CDF.

HEALTHCARE (2):

Cloud Healthcare accelerator for CDF. This accelerator is to enable Cloud Healthcare specific CDF plugins developed by Healthcare team.

CCAI_INSIGHTS (3):

Contact Center AI Insights This accelerator is used to enable import and export pipelines custom built to streamline CCAI Insights processing.

class State(value)

Bases: proto.enums.Enum

Different values possible for the state of an accelerator

Values:

STATE_UNSPECIFIED (0):

Default value, do not use

ENABLED (1):

Indicates that the accelerator is enabled and available to use

DISABLED (2):

Indicates that the accelerator is disabled and not available to use

UNKNOWN (3):

Indicates that accelerator state is currently unknown. Requests for enable, disable could be retried while in this state

class google.cloud.data_fusion_v1.types.CreateInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for creating a Data Fusion instance.

parent

Required. The instance’s project and location in the format projects/{project}/locations/{location}.

Type

str

instance_id

Required. The name of the instance to create.

Type

str

instance

An instance resource.

Type

google.cloud.data_fusion_v1.types.Instance

class google.cloud.data_fusion_v1.types.CryptoKeyConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The crypto key configuration. This field is used by the Customer-managed encryption keys (CMEK) feature.

key_reference

The name of the key which is used to encrypt/decrypt customer data. For key in Cloud KMS, the key should be in the format of projects/*/locations/*/keyRings/*/cryptoKeys/*.

Type

str

class google.cloud.data_fusion_v1.types.DeleteInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for deleting a Data Fusion instance.

name

Required. The instance resource name in the format projects/{project}/locations/{location}/instances/{instance}

Type

str

class google.cloud.data_fusion_v1.types.GetInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for getting details about a Data Fusion instance.

name

Required. The instance resource name in the format projects/{project}/locations/{location}/instances/{instance}.

Type

str

class google.cloud.data_fusion_v1.types.Instance(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a Data Fusion instance.

name

Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}.

Type

str

description

A description of this instance.

Type

str

type_

Required. Instance type.

Type

google.cloud.data_fusion_v1.types.Instance.Type

enable_stackdriver_logging

Option to enable Stackdriver Logging.

Type

bool

enable_stackdriver_monitoring

Option to enable Stackdriver Monitoring.

Type

bool

private_instance

Specifies whether the Data Fusion instance should be private. If set to true, all Data Fusion nodes will have private IP addresses and will not be able to access the public internet.

Type

bool

network_config

Network configuration options. These are required when a private Data Fusion instance is to be created.

Type

google.cloud.data_fusion_v1.types.NetworkConfig

labels

The resource labels for instance to use to annotate any related underlying resources such as Compute Engine VMs. The character ‘=’ is not allowed to be used within the labels.

Type

MutableMapping[str, str]

options

Map of additional options used to configure the behavior of Data Fusion instance.

Type

MutableMapping[str, str]

create_time

Output only. The time the instance was created.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

Output only. The time the instance was last updated.

Type

google.protobuf.timestamp_pb2.Timestamp

state

Output only. The current state of this Data Fusion instance.

Type

google.cloud.data_fusion_v1.types.Instance.State

state_message

Output only. Additional information about the current state of this Data Fusion instance if available.

Type

str

service_endpoint

Output only. Endpoint on which the Data Fusion UI is accessible.

Type

str

zone

Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field.

Type

str

version

Current version of the Data Fusion. Only specifiable in Update.

Type

str

service_account

Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID.

Type

str

display_name

Display name for an instance.

Type

str

available_version

Available versions that the instance can be upgraded to using UpdateInstanceRequest.

Type

MutableSequence[google.cloud.data_fusion_v1.types.Version]

api_endpoint

Output only. Endpoint on which the REST APIs is accessible.

Type

str

gcs_bucket

Output only. Cloud Storage bucket generated by Data Fusion in the customer project.

Type

str

accelerators

List of accelerators enabled for this CDF instance.

Type

MutableSequence[google.cloud.data_fusion_v1.types.Accelerator]

p4_service_account

Output only. P4 service account for the customer project.

Type

str

tenant_project_id

Output only. The name of the tenant project.

Type

str

dataproc_service_account

User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines.

This allows users to have fine-grained access control on Dataproc’s accesses to cloud resources.

Type

str

enable_rbac

Option to enable granular role-based access control.

Type

bool

crypto_key_config

The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature.

Type

google.cloud.data_fusion_v1.types.CryptoKeyConfig

disabled_reason

Output only. If the instance state is DISABLED, the reason for disabling the instance.

Type

MutableSequence[google.cloud.data_fusion_v1.types.Instance.DisabledReason]

class DisabledReason(value)

Bases: proto.enums.Enum

The reason for disabling the instance if the state is DISABLED.

Values:

DISABLED_REASON_UNSPECIFIED (0):

This is an unknown reason for disabling.

KMS_KEY_ISSUE (1):

The KMS key used by the instance is either revoked or denied access to

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class OptionsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class State(value)

Bases: proto.enums.Enum

Represents the state of a Data Fusion instance

Values:

STATE_UNSPECIFIED (0):

Instance does not have a state yet

CREATING (1):

Instance is being created

ACTIVE (2):

Instance is active and ready for requests. This corresponds to ‘RUNNING’ in datafusion.v1beta1.

FAILED (3):

Instance creation failed

DELETING (4):

Instance is being deleted

UPGRADING (5):

Instance is being upgraded

RESTARTING (6):

Instance is being restarted

UPDATING (7):

Instance is being updated on customer request

AUTO_UPDATING (8):

Instance is being auto-updated

AUTO_UPGRADING (9):

Instance is being auto-upgraded

DISABLED (10):

Instance is disabled

class Type(value)

Bases: proto.enums.Enum

Represents the type of Data Fusion instance. Each type is configured with the default settings for processing and memory.

Values:

TYPE_UNSPECIFIED (0):

No type specified. The instance creation will fail.

BASIC (1):

Basic Data Fusion instance. In Basic type, the user will be able to create data pipelines using point and click UI. However, there are certain limitations, such as fewer number of concurrent pipelines, no support for streaming pipelines, etc.

ENTERPRISE (2):

Enterprise Data Fusion instance. In Enterprise type, the user will have all features available, such as support for streaming pipelines, higher number of concurrent pipelines, etc.

DEVELOPER (3):

Developer Data Fusion instance. In Developer type, the user will have all features available but with restrictive capabilities. This is to help enterprises design and develop their data ingestion and integration pipelines at low cost.

class google.cloud.data_fusion_v1.types.ListAvailableVersionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for the list available versions request.

parent

Required. The project and location for which to retrieve instance information in the format projects/{project}/locations/{location}.

Type

str

page_size

The maximum number of items to return.

Type

int

page_token

The next_page_token value to use if there are additional results to retrieve for this list request.

Type

str

latest_patch_only

Whether or not to return the latest patch of every available minor version. If true, only the latest patch will be returned. Ex. if allowed versions is [6.1.1, 6.1.2, 6.2.0] then response will be [6.1.2, 6.2.0]

Type

bool

class google.cloud.data_fusion_v1.types.ListAvailableVersionsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for the list available versions request.

available_versions

Represents a list of versions that are supported.

Type

MutableSequence[google.cloud.data_fusion_v1.types.Version]

next_page_token

Token to retrieve the next page of results or empty if there are no more results in the list.

Type

str

class google.cloud.data_fusion_v1.types.ListInstancesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for listing Data Fusion instances.

parent

Required. The project and location for which to retrieve instance information in the format projects/{project}/locations/{location}. If the location is specified as ‘-’ (wildcard), then all regions available to the project are queried, and the results are aggregated.

Type

str

page_size

The maximum number of items to return.

Type

int

page_token

The next_page_token value to use if there are additional results to retrieve for this list request.

Type

str

filter

List filter.

Type

str

order_by

Sort results. Supported values are “name”, “name desc”, or “” (unsorted).

Type

str

class google.cloud.data_fusion_v1.types.ListInstancesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for the list instance request.

instances

Represents a list of Data Fusion instances.

Type

MutableSequence[google.cloud.data_fusion_v1.types.Instance]

next_page_token

Token to retrieve the next page of results or empty if there are no more results in the list.

Type

str

unreachable

Locations that could not be reached.

Type

MutableSequence[str]

class google.cloud.data_fusion_v1.types.NetworkConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Network configuration for a Data Fusion instance. These configurations are used for peering with the customer network. Configurations are optional when a public Data Fusion instance is to be created. However, providing these configurations allows several benefits, such as reduced network latency while accessing the customer resources from managed Data Fusion instance nodes, as well as access to the customer on-prem resources.

network

Name of the network in the customer project with which the Tenant Project will be peered for executing pipelines. In case of shared VPC where the network resides in another host project the network should specified in the form of projects/{host-project-id}/global/networks/{network}

Type

str

ip_allocation

The IP range in CIDR notation to use for the managed Data Fusion instance nodes. This range must not overlap with any other ranges used in the customer network.

Type

str

class google.cloud.data_fusion_v1.types.OperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents the metadata of a long-running operation.

create_time

The time the operation was created.

Type

google.protobuf.timestamp_pb2.Timestamp

end_time

The time the operation finished running.

Type

google.protobuf.timestamp_pb2.Timestamp

target

Server-defined resource path for the target of the operation.

Type

str

verb

Name of the verb executed by the operation.

Type

str

status_detail

Human-readable status of the operation if any.

Type

str

requested_cancellation

Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have [Operation.error][] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to Code.CANCELLED.

Type

bool

api_version

API version used to start the operation.

Type

str

additional_status

Map to hold any additional status info for the operation If there is an accelerator being enabled/disabled/deleted, this will be populated with accelerator name as key and status as ENABLING, DISABLING or DELETING

Type

MutableMapping[str, str]

class AdditionalStatusEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.data_fusion_v1.types.RestartInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for restarting a Data Fusion instance.

name

Required. Name of the Data Fusion instance which need to be restarted in the form of projects/{project}/locations/{location}/instances/{instance}

Type

str

class google.cloud.data_fusion_v1.types.UpdateInstanceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

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.

Type

google.cloud.data_fusion_v1.types.Instance

update_mask

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.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.data_fusion_v1.types.Version(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The Data Fusion version. This proto message stores information about certain Data Fusion version, which is used for Data Fusion version upgrade.

version_number

The version number of the Data Fusion instance, such as ‘6.0.1.0’.

Type

str

default_version

Whether this is currently the default version for Cloud Data Fusion

Type

bool

available_features

Represents a list of available feature names for a given version.

Type

MutableSequence[str]

type_

Type represents the release availability of the version

Type

google.cloud.data_fusion_v1.types.Version.Type

class Type(value)

Bases: proto.enums.Enum

Each type represents the release availability of a CDF version

Values:

TYPE_UNSPECIFIED (0):

Version does not have availability yet

TYPE_PREVIEW (1):

Version is under development and not considered stable

TYPE_GENERAL_AVAILABILITY (2):

Version is available for public use