REST Resource: projects.locations.instances

Resource: Instance

Represents a Data Fusion instance.

JSON representation 
{
  "name": string,
  "description": string,
  "type": enum (Type),
  "enableStackdriverLogging": boolean,
  "enableStackdriverMonitoring": boolean,
  "privateInstance": boolean,
  "networkConfig": {
    object (NetworkConfig)
  },
  "labels": {
    string: string,
    ...
  },
  "options": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "state": enum (State),
  "stateMessage": string,
  "serviceEndpoint": string,
  "zone": string,
  "version": string,
  "serviceAccount": string,
  "displayName": string,
  "availableVersion": [
    {
      object (Version)
    }
  ],
  "apiEndpoint": string,
  "gcsBucket": string,
  "accelerators": [
    {
      object (Accelerator)
    }
  ],
  "p4ServiceAccount": string,
  "tenantProjectId": string,
  "dataprocServiceAccount": string,
  "enableRbac": boolean,
  "cryptoKeyConfig": {
    object (CryptoKeyConfig)
  },
  "disabledReason": [
    enum (DisabledReason)
  ],
  "eventPublishConfig": {
    object (EventPublishConfig)
  }
}
Fields
name

string

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

string

A description of this instance.
type

enum (Type)

Required. Instance type.
enableStackdriverLogging

boolean

Option to enable Stackdriver Logging.
enableStackdriverMonitoring

boolean

Option to enable Stackdriver Monitoring.
privateInstance

boolean

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

object (NetworkConfig)

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

map (key: string, value: string)

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 "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
options

map (key: string, value: string)

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

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

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: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

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: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
state

enum (State)

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

string

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

string

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

string

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

string

Current version of Data Fusion.
serviceAccount
(deprecated)

string

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

string

Display name for an instance.
availableVersion[]

object (Version)

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

string

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

string

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

object (Accelerator)

List of accelerators enabled for this CDF instance.
p4ServiceAccount

string

Output only. P4 service account for the customer project.
tenantProjectId

string

Output only. The name of the tenant project.
dataprocServiceAccount

string

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

boolean

Option to enable granular role-based access control.
cryptoKeyConfig

object (CryptoKeyConfig)

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

enum (DisabledReason)

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

object (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

string

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

string

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 (Type)
}
Fields
versionNumber

string

The version number of the Data Fusion instance, such as '6.0.1.0'.
defaultVersion

boolean

Whether this is currently the default version for Cloud Data Fusion
availableFeatures[]

string

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

enum (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 (AcceleratorType)
}
Fields
acceleratorType

enum (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

string

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/*.

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

boolean

Required. Option to enable Event Publishing.
topic

string

Required. The resource name of the Pub/Sub topic. Format: projects/{projectId}/topics/{topic_id}

Methods

create

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

delete

 Deletes a single Data Fusion instance.

get

 Gets details of a single Data Fusion instance.

getIamPolicy

 Gets the access control policy for a resource.

list

 Lists Data Fusion instances in the specified project and location.

patch

 Updates a single Data Fusion instance.

restart

 Restart a single Data Fusion instance.

setIamPolicy

 Sets the access control policy on the specified resource.

testIamPermissions

 Returns permissions that a caller has on the specified resource.

upgrade

 Upgrade a single Data Fusion instance.