instances

Creates, updates, deletes, gets or lists an instances resource.

Overview

Name	instances
Type	Resource
Id	google.datafusion.instances

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}.
accelerators	array	Output only. List of accelerators enabled for this CDF instance.
apiEndpoint	string	Output only. Endpoint on which the REST APIs is accessible.
availableVersion	array	Output only. Available versions that the instance can be upgraded to using UpdateInstanceRequest.
createTime	string (google-datetime)	Output only. The time the instance was created.
cryptoKeyConfig	object	Optional. The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature. (id: CryptoKeyConfig)
dataplexDataLineageIntegrationEnabled	boolean	Optional. Option to enable the Dataplex Lineage Integration feature.
dataprocServiceAccount	string	Optional. 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.
description	string	Optional. A description of this instance.
disabledReason	array	Output only. If the instance state is DISABLED, the reason for disabling the instance.
displayName	string	Optional. Display name for an instance.
enableRbac	boolean	Optional. Option to enable granular role-based access control.
enableStackdriverLogging	boolean	Optional. Option to enable Dataproc Stackdriver Logging.
enableStackdriverMonitoring	boolean	Optional. Option to enable Stackdriver Monitoring.
enableZoneSeparation	boolean	Output only. Option to enable granular zone separation.
eventPublishConfig	object	Optional. Option to enable and pass metadata for event publishing. (id: EventPublishConfig)
gcsBucket	string	Output only. Cloud Storage bucket generated by Data Fusion in the customer project.
labels	object	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.
loggingConfig	object	Optional. The logging configuration for this instance. This field is supported only in CDF versions 6.11.0 and above. (id: LoggingConfig)
maintenanceEvents	array	Output only. The maintenance events for this instance.
maintenancePolicy	object	Optional. Configure the maintenance policy for this instance. (id: MaintenancePolicy)
networkConfig	object	Optional. Network configuration options. These are required when a private Data Fusion instance is to be created. (id: NetworkConfig)
options	object	Optional. Map of additional options used to configure the behavior of Data Fusion instance.
p4ServiceAccount	string	Output only. Service agent for the customer project.
patchRevision	string	Optional. Current patch revision of the Data Fusion.
privateInstance	boolean	Optional. 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.
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
serviceAccount	string	Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID.
serviceEndpoint	string	Output only. Endpoint on which the Data Fusion UI is accessible.
state	string	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.
tags	object	Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"
tenantProjectId	string	Output only. The name of the tenant project.
type	string	Required. Instance type.
updateTime	string (google-datetime)	Output only. The time the instance was last updated.
version	string	Optional. Current version of the Data Fusion. Only specifiable in Update.
workforceIdentityServiceEndpoint	string	Output only. Endpoint on which the Data Fusion UI is accessible to third-party users
zone	string	Optional. Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field.

list

Successful response

Name	Datatype	Description
name	string	Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}.
accelerators	array	Output only. List of accelerators enabled for this CDF instance.
apiEndpoint	string	Output only. Endpoint on which the REST APIs is accessible.
availableVersion	array	Output only. Available versions that the instance can be upgraded to using UpdateInstanceRequest.
createTime	string (google-datetime)	Output only. The time the instance was created.
cryptoKeyConfig	object	Optional. The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature. (id: CryptoKeyConfig)
dataplexDataLineageIntegrationEnabled	boolean	Optional. Option to enable the Dataplex Lineage Integration feature.
dataprocServiceAccount	string	Optional. 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.
description	string	Optional. A description of this instance.
disabledReason	array	Output only. If the instance state is DISABLED, the reason for disabling the instance.
displayName	string	Optional. Display name for an instance.
enableRbac	boolean	Optional. Option to enable granular role-based access control.
enableStackdriverLogging	boolean	Optional. Option to enable Dataproc Stackdriver Logging.
enableStackdriverMonitoring	boolean	Optional. Option to enable Stackdriver Monitoring.
enableZoneSeparation	boolean	Output only. Option to enable granular zone separation.
eventPublishConfig	object	Optional. Option to enable and pass metadata for event publishing. (id: EventPublishConfig)
gcsBucket	string	Output only. Cloud Storage bucket generated by Data Fusion in the customer project.
labels	object	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.
loggingConfig	object	Optional. The logging configuration for this instance. This field is supported only in CDF versions 6.11.0 and above. (id: LoggingConfig)
maintenanceEvents	array	Output only. The maintenance events for this instance.
maintenancePolicy	object	Optional. Configure the maintenance policy for this instance. (id: MaintenancePolicy)
networkConfig	object	Optional. Network configuration options. These are required when a private Data Fusion instance is to be created. (id: NetworkConfig)
options	object	Optional. Map of additional options used to configure the behavior of Data Fusion instance.
p4ServiceAccount	string	Output only. Service agent for the customer project.
patchRevision	string	Optional. Current patch revision of the Data Fusion.
privateInstance	boolean	Optional. 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.
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
serviceAccount	string	Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID.
serviceEndpoint	string	Output only. Endpoint on which the Data Fusion UI is accessible.
state	string	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.
tags	object	Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"
tenantProjectId	string	Output only. The name of the tenant project.
type	string	Required. Instance type.
updateTime	string (google-datetime)	Output only. The time the instance was last updated.
version	string	Optional. Current version of the Data Fusion. Only specifiable in Update.
workforceIdentityServiceEndpoint	string	Output only. Endpoint on which the Data Fusion UI is accessible to third-party users
zone	string	Optional. Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, instancesId		Gets details of a single Data Fusion instance.
list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists Data Fusion instances in the specified project and location.
create	insert	projectsId, locationsId	instanceId	Creates a new Data Fusion instance in the specified project and location.
patch	update	projectsId, locationsId, instancesId	updateMask	Updates a single Data Fusion instance.
delete	delete	projectsId, locationsId, instancesId	force	Deletes a single Date Fusion instance.
restart	exec	projectsId, locationsId, instancesId		Restart a single Data Fusion instance. At the end of an operation instance is fully restarted.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
instancesId	string
locationsId	string
projectsId	string
filter	string
force	boolean
instanceId	string
orderBy	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets details of a single Data Fusion instance.

SELECT
name,
accelerators,
apiEndpoint,
availableVersion,
createTime,
cryptoKeyConfig,
dataplexDataLineageIntegrationEnabled,
dataprocServiceAccount,
description,
disabledReason,
displayName,
enableRbac,
enableStackdriverLogging,
enableStackdriverMonitoring,
enableZoneSeparation,
eventPublishConfig,
gcsBucket,
labels,
loggingConfig,
maintenanceEvents,
maintenancePolicy,
networkConfig,
options,
p4ServiceAccount,
patchRevision,
privateInstance,
satisfiesPzi,
satisfiesPzs,
serviceAccount,
serviceEndpoint,
state,
stateMessage,
tags,
tenantProjectId,
type,
updateTime,
version,
workforceIdentityServiceEndpoint,
zone
FROM google.datafusion.instances
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND instancesId = '{{ instancesId }}' -- required;

list

Lists Data Fusion instances in the specified project and location.

SELECT
name,
accelerators,
apiEndpoint,
availableVersion,
createTime,
cryptoKeyConfig,
dataplexDataLineageIntegrationEnabled,
dataprocServiceAccount,
description,
disabledReason,
displayName,
enableRbac,
enableStackdriverLogging,
enableStackdriverMonitoring,
enableZoneSeparation,
eventPublishConfig,
gcsBucket,
labels,
loggingConfig,
maintenanceEvents,
maintenancePolicy,
networkConfig,
options,
p4ServiceAccount,
patchRevision,
privateInstance,
satisfiesPzi,
satisfiesPzs,
serviceAccount,
serviceEndpoint,
state,
stateMessage,
tags,
tenantProjectId,
type,
updateTime,
version,
workforceIdentityServiceEndpoint,
zone
FROM google.datafusion.instances
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

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

INSERT INTO google.datafusion.instances (
data__description,
data__type,
data__enableStackdriverLogging,
data__enableStackdriverMonitoring,
data__privateInstance,
data__networkConfig,
data__labels,
data__options,
data__zone,
data__version,
data__displayName,
data__dataprocServiceAccount,
data__enableRbac,
data__cryptoKeyConfig,
data__eventPublishConfig,
data__patchRevision,
data__dataplexDataLineageIntegrationEnabled,
data__maintenancePolicy,
data__tags,
data__loggingConfig,
projectsId,
locationsId,
instanceId
)
SELECT 
'{{ description }}',
'{{ type }}',
{{ enableStackdriverLogging }},
{{ enableStackdriverMonitoring }},
{{ privateInstance }},
'{{ networkConfig }}',
'{{ labels }}',
'{{ options }}',
'{{ zone }}',
'{{ version }}',
'{{ displayName }}',
'{{ dataprocServiceAccount }}',
{{ enableRbac }},
'{{ cryptoKeyConfig }}',
'{{ eventPublishConfig }}',
'{{ patchRevision }}',
{{ dataplexDataLineageIntegrationEnabled }},
'{{ maintenancePolicy }}',
'{{ tags }}',
'{{ loggingConfig }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ instanceId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: instances
  props:
    - name: projectsId
      value: string
      description: Required parameter for the instances resource.
    - name: locationsId
      value: string
      description: Required parameter for the instances resource.
    - name: description
      value: string
      description: >
        Optional. A description of this instance.
        
    - name: type
      value: string
      description: >
        Required. Instance type.
        
      valid_values: ['TYPE_UNSPECIFIED', 'BASIC', 'ENTERPRISE', 'DEVELOPER']
    - name: enableStackdriverLogging
      value: boolean
      description: >
        Optional. Option to enable Dataproc Stackdriver Logging.
        
    - name: enableStackdriverMonitoring
      value: boolean
      description: >
        Optional. Option to enable Stackdriver Monitoring.
        
    - name: privateInstance
      value: boolean
      description: >
        Optional. 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.
        
    - name: networkConfig
      value: object
      description: >
        Optional. Network configuration options. These are required when a private Data Fusion instance is to be created.
        
    - name: labels
      value: object
      description: >
        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.
        
    - name: options
      value: object
      description: >
        Optional. Map of additional options used to configure the behavior of Data Fusion instance.
        
    - name: zone
      value: string
      description: >
        Optional. Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field.
        
    - name: version
      value: string
      description: >
        Optional. Current version of the Data Fusion. Only specifiable in Update.
        
    - name: displayName
      value: string
      description: >
        Optional. Display name for an instance.
        
    - name: dataprocServiceAccount
      value: string
      description: >
        Optional. 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.
        
    - name: enableRbac
      value: boolean
      description: >
        Optional. Option to enable granular role-based access control.
        
    - name: cryptoKeyConfig
      value: object
      description: >
        Optional. The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature.
        
    - name: eventPublishConfig
      value: object
      description: >
        Optional. Option to enable and pass metadata for event publishing.
        
    - name: patchRevision
      value: string
      description: >
        Optional. Current patch revision of the Data Fusion.
        
    - name: dataplexDataLineageIntegrationEnabled
      value: boolean
      description: >
        Optional. Option to enable the Dataplex Lineage Integration feature.
        
    - name: maintenancePolicy
      value: object
      description: >
        Optional. Configure the maintenance policy for this instance.
        
    - name: tags
      value: object
      description: >
        Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"
        
    - name: loggingConfig
      value: object
      description: >
        Optional. The logging configuration for this instance. This field is supported only in CDF versions 6.11.0 and above.
        
    - name: instanceId
      value: string

UPDATE examples

patch

Updates a single Data Fusion instance.

UPDATE google.datafusion.instances
SET 
data__description = '{{ description }}',
data__type = '{{ type }}',
data__enableStackdriverLogging = {{ enableStackdriverLogging }},
data__enableStackdriverMonitoring = {{ enableStackdriverMonitoring }},
data__privateInstance = {{ privateInstance }},
data__networkConfig = '{{ networkConfig }}',
data__labels = '{{ labels }}',
data__options = '{{ options }}',
data__zone = '{{ zone }}',
data__version = '{{ version }}',
data__displayName = '{{ displayName }}',
data__dataprocServiceAccount = '{{ dataprocServiceAccount }}',
data__enableRbac = {{ enableRbac }},
data__cryptoKeyConfig = '{{ cryptoKeyConfig }}',
data__eventPublishConfig = '{{ eventPublishConfig }}',
data__patchRevision = '{{ patchRevision }}',
data__dataplexDataLineageIntegrationEnabled = {{ dataplexDataLineageIntegrationEnabled }},
data__maintenancePolicy = '{{ maintenancePolicy }}',
data__tags = '{{ tags }}',
data__loggingConfig = '{{ loggingConfig }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND instancesId = '{{ instancesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a single Date Fusion instance.

DELETE FROM google.datafusion.instances
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND instancesId = '{{ instancesId }}' --required
AND force = '{{ force }}';

Lifecycle Methods

restart

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

EXEC google.datafusion.instances.restart 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@instancesId='{{ instancesId }}' --required;