- Resource: Instance
- Type
- NetworkConfig
- State
- Version
- Type
- Accelerator
- AcceleratorType
- CryptoKeyConfig
- DisabledReason
- EventPublishConfig
- Methods
Resource: Instance
Represents a Data Fusion instance.
JSON representation |
---|
{ "name": string, "description": string, "type": enum ( |
Fields | |
---|---|
name |
Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}. |
description |
A description of this instance. |
type |
Required. Instance type. |
enableStackdriverLogging |
Option to enable Stackdriver Logging. |
enableStackdriverMonitoring |
Option to enable Stackdriver Monitoring. |
privateInstance |
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. |
networkConfig |
Network configuration options. These are required when a private Data Fusion instance is to be created. |
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. An object containing a list of |
options |
Map of additional options used to configure the behavior of Data Fusion instance. An object containing a list of |
createTime |
Output only. The time the instance was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Output only. The time the instance was last updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
state |
Output only. The current state of this Data Fusion instance. |
stateMessage |
Output only. Additional information about the current state of this Data Fusion instance if available. |
serviceEndpoint |
Output only. Endpoint on which the Data Fusion UI is accessible. |
zone |
Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field. |
version |
Current version of Data Fusion. |
serviceAccount |
Output only. Deprecated. Use tenantProjectId instead to extract the tenant project ID. |
displayName |
Display name for an instance. |
availableVersion[] |
Available versions that the instance can be upgraded to using UpdateInstanceRequest. |
apiEndpoint |
Output only. Endpoint on which the REST APIs is accessible. |
gcsBucket |
Output only. Cloud Storage bucket generated by Data Fusion in the customer project. |
accelerators[] |
List of accelerators enabled for this CDF instance. |
p4ServiceAccount |
Output only. P4 service account for the customer project. |
tenantProjectId |
Output only. The name of the tenant project. |
dataprocServiceAccount |
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. |
enableRbac |
Option to enable granular role-based access control. |
cryptoKeyConfig |
The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature. |
disabledReason[] |
Output only. If the instance state is DISABLED, the reason for disabling the instance. |
eventPublishConfig |
Option to enable and pass metadata for event publishing. |
Type
Represents the type of Data Fusion instance. Each type is configured with the default settings for processing and memory.
Enums | |
---|---|
TYPE_UNSPECIFIED |
No type specified. The instance creation will fail. |
BASIC |
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 |
Enterprise Data Fusion instance. In Enterprise type, the user will have all features available, such as support for streaming pipelines, unlimited number of concurrent pipelines, etc. |
DEVELOPER |
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. |
NetworkConfig
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.
JSON representation |
---|
{ "network": string, "ipAllocation": string } |
Fields | |
---|---|
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} |
ipAllocation |
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 Data Fusion instance network. |
State
Represents the state of a Data Fusion instance
Enums | |
---|---|
STATE_UNSPECIFIED |
Instance does not have a state yet |
CREATING |
Instance is being created |
RUNNING |
Instance is running and ready for requests |
FAILED |
Instance creation failed |
DELETING |
Instance is being deleted |
UPGRADING |
Instance is being upgraded |
RESTARTING |
Instance is being restarted |
UPDATING |
Instance is being updated on customer request |
AUTO_UPDATING |
Instance is being auto-updated |
AUTO_UPGRADING |
Instance is being auto-upgraded |
DISABLED |
Instance is disabled |
Version
The Data Fusion version.
JSON representation |
---|
{
"versionNumber": string,
"defaultVersion": boolean,
"availableFeatures": [
string
],
"type": enum ( |
Fields | |
---|---|
versionNumber |
The version number of the Data Fusion instance, such as '6.0.1.0'. |
defaultVersion |
Whether this is currently the default version for Cloud Data Fusion |
availableFeatures[] |
Represents a list of available feature names for a given version. |
type |
Type represents the release availability of the version |
Type
Each type represents the release availability of a CDF version
Enums | |
---|---|
TYPE_UNSPECIFIED |
Version does not have availability yet |
TYPE_PREVIEW |
Version is under development and not considered stable |
TYPE_GENERAL_AVAILABILITY |
Version is available for public use |
Accelerator
Identifies Data Fusion accelerators for an instance.
JSON representation |
---|
{
"acceleratorType": enum ( |
Fields | |
---|---|
acceleratorType |
The type of an accelator for a CDF instance. |
AcceleratorType
Each type represents an Accelerator (Add-On) supported by Cloud Data Fusion service.
Enums | |
---|---|
ACCELERATOR_TYPE_UNSPECIFIED |
Default value, if unspecified. |
CDC |
Change Data Capture accelerator for CDF. |
HEALTHCARE |
Cloud Healthcare accelerator for CDF. This accelerator is to enable Cloud Healthcare specific CDF plugins developed by Healthcare team. |
CryptoKeyConfig
The crypto key configuration. This field is used by the Customer-managed encryption keys (CMEK) feature.
JSON representation |
---|
{ "keyReference": string } |
Fields | |
---|---|
keyReference |
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 |
DisabledReason
The reason for disabling the instance if the state is DISABLED.
Enums | |
---|---|
DISABLED_REASON_UNSPECIFIED |
This is an unknown reason for disabling. |
KMS_KEY_ISSUE |
The KMS key used by the instance is either revoked or denied access to |
EventPublishConfig
Confirguration of PubSubEventWriter.
JSON representation |
---|
{ "enabled": boolean, "topic": string } |
Fields | |
---|---|
enabled |
Required. Option to enable Event Publishing. |
topic |
Required. The resource name of the Pub/Sub topic. Format: projects/{projectId}/topics/{topic_id} |
Methods |
|
---|---|
|
Creates a new Data Fusion instance in the specified project and location. |
|
Deletes a single Data Fusion instance. |
|
Gets details of a single Data Fusion instance. |
|
Gets the access control policy for a resource. |
|
Lists Data Fusion instances in the specified project and location. |
|
Updates a single Data Fusion instance. |
|
Restart a single Data Fusion instance. |
|
Sets the access control policy on the specified resource. |
|
Returns permissions that a caller has on the specified resource. |
|
Upgrade a single Data Fusion instance. |