Google Cloud Data Fusion V1 Client - Class Instance (0.5.2)

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

Namespace

Google \ Cloud \ DataFusion \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`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`	`Google\Protobuf\Timestamp` Output only. The time the instance was created.
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. The time the instance was last updated.
`↳ 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`	`array<Google\Cloud\DataFusion\V1\Accelerator>` List of accelerators enabled for this CDF instance.
`↳ 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}.

Returns
Type	Description
`string`

setName

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDescription

A description of this instance.

Returns
Type	Description
`string`

setDescription

A description of this instance.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getType

Required. Instance type.

Returns
Type	Description
`int`

setType

Required. Instance type.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getEnableStackdriverLogging

Option to enable Stackdriver Logging.

Returns
Type	Description
`bool`

setEnableStackdriverLogging

Option to enable Stackdriver Logging.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getEnableStackdriverMonitoring

Option to enable Stackdriver Monitoring.

Returns
Type	Description
`bool`

setEnableStackdriverMonitoring

Option to enable Stackdriver Monitoring.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$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.

Returns
Type	Description
`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.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getNetworkConfig

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

Returns
Type	Description
`Google\Cloud\DataFusion\V1\NetworkConfig\|null`

hasNetworkConfig

clearNetworkConfig

setNetworkConfig

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

Parameter
Name	Description
`var`	`Google\Cloud\DataFusion\V1\NetworkConfig`

Returns
Type	Description
`$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.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

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.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getOptions

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

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setOptions

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

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getCreateTime

Output only. The time the instance was created.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time the instance was created.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getUpdateTime

Output only. The time the instance was last updated.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time the instance was last updated.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getState

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

Returns
Type	Description
`int`

setState

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

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getStateMessage

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

Returns
Type	Description
`string`

setStateMessage

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getServiceEndpoint

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

Returns
Type	Description
`string`

setServiceEndpoint

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getZone

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

Returns
Type	Description
`string`

setZone

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getVersion

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

Returns
Type	Description
`string`

setVersion

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getServiceAccount

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

Returns
Type	Description
`string`

setServiceAccount

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDisplayName

Display name for an instance.

Returns
Type	Description
`string`

setDisplayName

Display name for an instance.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAvailableVersion

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

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setAvailableVersion

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

Parameter
Name	Description
`var`	`array<Google\Cloud\DataFusion\V1\Version>`

Returns
Type	Description
`$this`

getApiEndpoint

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

Returns
Type	Description
`string`

setApiEndpoint

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getGcsBucket

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

Returns
Type	Description
`string`

setGcsBucket

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAccelerators

List of accelerators enabled for this CDF instance.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setAccelerators

List of accelerators enabled for this CDF instance.

Parameter
Name	Description
`var`	`array<Google\Cloud\DataFusion\V1\Accelerator>`

Returns
Type	Description
`$this`

getP4ServiceAccount

Output only. P4 service account for the customer project.

Returns
Type	Description
`string`

setP4ServiceAccount

Output only. P4 service account for the customer project.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getTenantProjectId

Output only. The name of the tenant project.

Returns
Type	Description
`string`

setTenantProjectId

Output only. The name of the tenant project.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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.

Returns
Type	Description
`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.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getEnableRbac

Option to enable granular role-based access control.

Returns
Type	Description
`bool`

setEnableRbac

Option to enable granular role-based access control.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getCryptoKeyConfig

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

Returns
Type	Description
`Google\Cloud\DataFusion\V1\CryptoKeyConfig\|null`

hasCryptoKeyConfig

clearCryptoKeyConfig

setCryptoKeyConfig

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

Parameter
Name	Description
`var`	`Google\Cloud\DataFusion\V1\CryptoKeyConfig`

Returns
Type	Description
`$this`

getDisabledReason

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

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setDisabledReason

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

Parameter
Name	Description
`var`	`int[]`

Returns
Type	Description
`$this`