Patch v1+name — datafusion

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13153563.6 KB

projects

Updates a single Data Fusion instance.

patch/v1/{+name}

Path parameters

namestring required

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

Query parameters

updateMaskstring

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, the label field will be overwritten.

Request body

createTimestring google-datetime

Output only. The time the instance was created.

workforceIdentityServiceEndpointstring

Output only. Endpoint on which the Data Fusion UI is accessible to third-party users

namestring

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

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

descriptionstring

Optional. A description of this instance.

zonestring

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

patchRevisionstring

Optional. Current patch revision of the Data Fusion.

tagsobject

Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"

satisfiesPziboolean

Output only. Reserved for future use.

gcsBucketstring

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

serviceAccountstring

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

dataplexDataLineageIntegrationEnabledboolean

Optional. Option to enable the Dataplex Lineage Integration feature.

tenantProjectIdstring

Output only. The name of the tenant project.

satisfiesPzsboolean

Output only. Reserved for future use.

enableStackdriverMonitoringboolean

Optional. Option to enable Stackdriver Monitoring.

enableRbacboolean

Optional. Option to enable granular role-based access control.

updateTimestring google-datetime

Output only. The time the instance was last updated.

stateMessagestring

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

privateInstanceboolean

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.

serviceEndpointstring

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

optionsobject

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

dataprocServiceAccountstring

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.

type'TYPE_UNSPECIFIED' | 'BASIC' | 'ENTERPRISE' | 'DEVELOPER'

Required. Instance type.

labelsobject

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.

enableZoneSeparationboolean

Output only. Option to enable granular zone separation.

enableStackdriverLoggingboolean

Optional. Option to enable Dataproc Stackdriver Logging.

p4ServiceAccountstring

Output only. Service agent for the customer project.

displayNamestring

Optional. Display name for an instance.

apiEndpointstring

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

versionstring

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

disabledReasonstring[]

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

Response

Successful response