Instance

import type { Instance } from "https://googleapis.deno.dev/v1/datafusion:v1.ts";

Represents a Data Fusion instance.

interface Instance {

readonly accelerators?: Accelerator[];

readonly apiEndpoint?: string;

readonly availableVersion?: Version[];

readonly createTime?: Date;

cryptoKeyConfig?: CryptoKeyConfig;

dataplexDataLineageIntegrationEnabled?: boolean;

dataprocServiceAccount?: string;

description?: string;

readonly disabledReason?: "DISABLED_REASON_UNSPECIFIED" | "KMS_KEY_ISSUE"[];

displayName?: string;

enableRbac?: boolean;

enableStackdriverLogging?: boolean;

enableStackdriverMonitoring?: boolean;

enableZoneSeparation?: boolean;

eventPublishConfig?: EventPublishConfig;

readonly gcsBucket?: string;

labels?: {

[key: string]: string;

};

readonly name?: string;

networkConfig?: NetworkConfig;

options?: {

[key: string]: string;

};

readonly p4ServiceAccount?: string;

patchRevision?: string;

privateInstance?: boolean;

readonly satisfiesPzs?: boolean;

readonly serviceAccount?: string;

readonly serviceEndpoint?: string;

readonly state?:

| "STATE_UNSPECIFIED"

| "CREATING"

| "ACTIVE"

| "FAILED"

| "DELETING"

| "UPGRADING"

| "RESTARTING"

| "UPDATING"

| "AUTO_UPDATING"

| "AUTO_UPGRADING"

| "DISABLED";

readonly stateMessage?: string;

readonly tenantProjectId?: string;

type?:

| "TYPE_UNSPECIFIED"

| "BASIC"

| "ENTERPRISE"

| "DEVELOPER";

readonly updateTime?: Date;

version?: string;

readonly workforceIdentityServiceEndpoint?: string;

zone?: string;

}

§Properties

readonly accelerators?: Accelerator[]

[src]

Output only. List of accelerators enabled for this CDF instance.

readonly apiEndpoint?: string

[src]

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

readonly availableVersion?: Version[]

[src]

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

readonly createTime?: Date

[src]

Output only. The time the instance was created.

cryptoKeyConfig?: CryptoKeyConfig

[src]

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

dataplexDataLineageIntegrationEnabled?: boolean

[src]

Optional. Option to enable the Dataplex Lineage Integration feature.

dataprocServiceAccount?: string

[src]

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

[src]

A description of this instance.

readonly disabledReason?: "DISABLED_REASON_UNSPECIFIED" | "KMS_KEY_ISSUE"[]

[src]

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

displayName?: string

[src]

Display name for an instance.

enableRbac?: boolean

[src]

Option to enable granular role-based access control.

enableStackdriverLogging?: boolean

[src]

Option to enable Stackdriver Logging.

enableStackdriverMonitoring?: boolean

[src]

Option to enable Stackdriver Monitoring.

enableZoneSeparation?: boolean

[src]

Option to enable granular zone separation.

eventPublishConfig?: EventPublishConfig

[src]

Option to enable and pass metadata for event publishing.

readonly gcsBucket?: string

[src]

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

labels?: {

[key: string]: string;

}

[src]

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.

readonly name?: string

[src]

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

networkConfig?: NetworkConfig

[src]

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

options?: {

[key: string]: string;

}

[src]

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

readonly p4ServiceAccount?: string

[src]

Output only. P4 service account for the customer project.

patchRevision?: string

[src]

Optional. Current patch revision of the Data Fusion.

privateInstance?: boolean

[src]

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.

readonly satisfiesPzs?: boolean

[src]

Output only. Reserved for future use.

readonly serviceAccount?: string

[src]

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

readonly serviceEndpoint?: string

[src]

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