Reference documentation and code samples for the Google Cloud Data Fusion V1 Client class Instance.
Represents a Data Fusion instance.
Generated from protobuf message google.cloud.datafusion.v1.Instance
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ 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
int
Required. Instance type.
↳ enable_stackdriver_logging
bool
Option to enable Stackdriver Logging.
↳ enable_stackdriver_monitoring
bool
Option to enable Stackdriver Monitoring.
↳ private_instance
bool
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.
↳ network_config
Google\Cloud\DataFusion\V1\NetworkConfig
Network configuration options. These are required when a private Data Fusion instance is to be created.
↳ labels
array| Google\Protobuf\Internal\MapField
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.
↳ options
array| Google\Protobuf\Internal\MapField
Map of additional options used to configure the behavior of Data Fusion instance.
↳ create_time
↳ update_time
↳ state
int
Output only. The current state of this Data Fusion instance.
↳ state_message
string
Output only. Additional information about the current state of this Data Fusion instance if available.
↳ service_endpoint
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 the Data Fusion. Only specifiable in Update.
↳ service_account
string
Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID.
↳ display_name
string
Display name for an instance.
↳ available_version
array< Google\Cloud\DataFusion\V1\Version
>
Available versions that the instance can be upgraded to using UpdateInstanceRequest.
↳ api_endpoint
string
Output only. Endpoint on which the REST APIs is accessible.
↳ gcs_bucket
string
Output only. Cloud Storage bucket generated by Data Fusion in the customer project.
↳ accelerators
↳ p4_service_account
string
Output only. P4 service account for the customer project.
↳ tenant_project_id
string
Output only. The name of the tenant project.
↳ dataproc_service_account
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.
↳ enable_rbac
bool
Option to enable granular role-based access control.
↳ crypto_key_config
Google\Cloud\DataFusion\V1\CryptoKeyConfig
The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature.
↳ disabled_reason
array
Output only. If the instance state is DISABLED, the reason for disabling the instance.
getName
Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}.
string
setName
Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}.
var
string
$this
getDescription
A description of this instance.
string
setDescription
A description of this instance.
var
string
$this
getType
Required. Instance type.
int
setType
Required. Instance type.
var
int
$this
getEnableStackdriverLogging
Option to enable Stackdriver Logging.
bool
setEnableStackdriverLogging
Option to enable Stackdriver Logging.
var
bool
$this
getEnableStackdriverMonitoring
Option to enable Stackdriver Monitoring.
bool
setEnableStackdriverMonitoring
Option to enable Stackdriver Monitoring.
var
bool
$this
getPrivateInstance
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.
bool
setPrivateInstance
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.
var
bool
$this
getNetworkConfig
Network configuration options. These are required when a private Data Fusion instance is to be created.
hasNetworkConfig
clearNetworkConfig
setNetworkConfig
Network configuration options. These are required when a private Data Fusion instance is to be created.
$this
getLabels
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.
setLabels
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.
$this
getOptions
Map of additional options used to configure the behavior of Data Fusion instance.
setOptions
Map of additional options used to configure the behavior of Data Fusion instance.
$this
getCreateTime
Output only. The time the instance was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time the instance was created.
$this
getUpdateTime
Output only. The time the instance was last updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time the instance was last updated.
$this
getState
Output only. The current state of this Data Fusion instance.
int
setState
Output only. The current state of this Data Fusion instance.
var
int
$this
getStateMessage
Output only. Additional information about the current state of this Data Fusion instance if available.
string
setStateMessage
Output only. Additional information about the current state of this Data Fusion instance if available.
var
string
$this
getServiceEndpoint
Output only. Endpoint on which the Data Fusion UI is accessible.
string
setServiceEndpoint
Output only. Endpoint on which the Data Fusion UI is accessible.
var
string
$this
getZone
Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field.
string
setZone
Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field.
var
string
$this
getVersion
Current version of the Data Fusion. Only specifiable in Update.
string
setVersion
Current version of the Data Fusion. Only specifiable in Update.
var
string
$this
getServiceAccount
Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID.
string
setServiceAccount
Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID.
var
string
$this
getDisplayName
Display name for an instance.
string
setDisplayName
Display name for an instance.
var
string
$this
getAvailableVersion
Available versions that the instance can be upgraded to using UpdateInstanceRequest.
setAvailableVersion
Available versions that the instance can be upgraded to using UpdateInstanceRequest.
$this
getApiEndpoint
Output only. Endpoint on which the REST APIs is accessible.
string
setApiEndpoint
Output only. Endpoint on which the REST APIs is accessible.
var
string
$this
getGcsBucket
Output only. Cloud Storage bucket generated by Data Fusion in the customer project.
string
setGcsBucket
Output only. Cloud Storage bucket generated by Data Fusion in the customer project.
var
string
$this
getAccelerators
List of accelerators enabled for this CDF instance.
setAccelerators
List of accelerators enabled for this CDF instance.
$this
getP4ServiceAccount
Output only. P4 service account for the customer project.
string
setP4ServiceAccount
Output only. P4 service account for the customer project.
var
string
$this
getTenantProjectId
Output only. The name of the tenant project.
string
setTenantProjectId
Output only. The name of the tenant project.
var
string
$this
getDataprocServiceAccount
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.
string
setDataprocServiceAccount
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.
var
string
$this
getEnableRbac
Option to enable granular role-based access control.
bool
setEnableRbac
Option to enable granular role-based access control.
var
bool
$this
getCryptoKeyConfig
The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature.
hasCryptoKeyConfig
clearCryptoKeyConfig
setCryptoKeyConfig
The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature.
$this
getDisabledReason
Output only. If the instance state is DISABLED, the reason for disabling the instance.
setDisabledReason
Output only. If the instance state is DISABLED, the reason for disabling the instance.
var
int[]
$this
