Skip to main content

instances

Overview

Nameinstances
TypeResource
Idgoogle.datafusion.instances

Fields

NameDatatypeDescription
namestringOutput only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}.
descriptionstringA description of this instance.
createTimestringOutput only. The time the instance was created.
enableZoneSeparationbooleanOption to enable granular zone separation.
enableStackdriverLoggingbooleanOption to enable Stackdriver Logging.
labelsobjectThe 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.
typestringRequired. Instance type.
networkConfigobjectNetwork 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.
tenantProjectIdstringOutput only. The name of the tenant project.
apiEndpointstringOutput only. Endpoint on which the REST APIs is accessible.
zonestringName of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field.
cryptoKeyConfigobjectThe crypto key configuration. This field is used by the Customer-managed encryption keys (CMEK) feature.
enableRbacbooleanOption to enable granular role-based access control.
stateMessagestringOutput only. Additional information about the current state of this Data Fusion instance if available.
acceleratorsarrayOutput only. List of accelerators enabled for this CDF instance.
p4ServiceAccountstringOutput only. P4 service account for the customer project.
disabledReasonarrayOutput only. If the instance state is DISABLED, the reason for disabling the instance.
displayNamestringDisplay name for an instance.
serviceEndpointstringOutput only. Endpoint on which the Data Fusion UI is accessible.
optionsobjectMap of additional options used to configure the behavior of Data Fusion instance.
privateInstancebooleanSpecifies 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.
updateTimestringOutput only. The time the instance was last updated.
statestringOutput only. The current state of this Data Fusion instance.
serviceAccountstringOutput only. Deprecated. Use tenant_project_id instead to extract the tenant project ID.
versionstringCurrent version of the Data Fusion. Only specifiable in Update.
dataprocServiceAccountstringUser-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.
eventPublishConfigobjectConfirguration of PubSubEventWriter.
gcsBucketstringOutput only. Cloud Storage bucket generated by Data Fusion in the customer project.
satisfiesPzsbooleanOutput only. Reserved for future use.
availableVersionarrayOutput only. Available versions that the instance can be upgraded to using UpdateInstanceRequest.
enableStackdriverMonitoringbooleanOption to enable Stackdriver Monitoring.

Methods

NameAccessible byRequired ParamsDescription
getSELECTinstancesId, locationsId, projectsIdGets details of a single Data Fusion instance.
listSELECTlocationsId, projectsIdLists Data Fusion instances in the specified project and location.
createINSERTlocationsId, projectsIdCreates a new Data Fusion instance in the specified project and location.
deleteDELETEinstancesId, locationsId, projectsIdDeletes a single Date Fusion instance.
_listEXEClocationsId, projectsIdLists Data Fusion instances in the specified project and location.
patchEXECinstancesId, locationsId, projectsIdUpdates a single Data Fusion instance.
restartEXECinstancesId, locationsId, projectsIdRestart a single Data Fusion instance. At the end of an operation instance is fully restarted.