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

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.

Parameters
NameDescription
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
TypeDescription
string

setName

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDescription

A description of this instance.

Returns
TypeDescription
string

setDescription

A description of this instance.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getType

Required. Instance type.

Returns
TypeDescription
int

setType

Required. Instance type.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getEnableStackdriverLogging

Option to enable Stackdriver Logging.

Returns
TypeDescription
bool

setEnableStackdriverLogging

Option to enable Stackdriver Logging.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getEnableStackdriverMonitoring

Option to enable Stackdriver Monitoring.

Returns
TypeDescription
bool

setEnableStackdriverMonitoring

Option to enable Stackdriver Monitoring.

Parameter
NameDescription
var bool
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var bool
Returns
TypeDescription
$this

getNetworkConfig

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

Returns
TypeDescription
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
NameDescription
var Google\Cloud\DataFusion\V1\NetworkConfig
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getOptions

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

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setOptions

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

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getCreateTime

Output only. The time the instance was created.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time the instance was created.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getUpdateTime

Output only. The time the instance was last updated.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time the instance was last updated.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getState

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

Returns
TypeDescription
int

setState

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

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getStateMessage

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

Returns
TypeDescription
string

setStateMessage

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getServiceEndpoint

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

Returns
TypeDescription
string

setServiceEndpoint

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getZone

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

Returns
TypeDescription
string

setZone

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getVersion

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

Returns
TypeDescription
string

setVersion

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getServiceAccount

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

Returns
TypeDescription
string

setServiceAccount

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDisplayName

Display name for an instance.

Returns
TypeDescription
string

setDisplayName

Display name for an instance.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAvailableVersion

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

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setAvailableVersion

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

Parameter
NameDescription
var array<Google\Cloud\DataFusion\V1\Version>
Returns
TypeDescription
$this

getApiEndpoint

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

Returns
TypeDescription
string

setApiEndpoint

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getGcsBucket

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

Returns
TypeDescription
string

setGcsBucket

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAccelerators

List of accelerators enabled for this CDF instance.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setAccelerators

List of accelerators enabled for this CDF instance.

Parameter
NameDescription
var array<Google\Cloud\DataFusion\V1\Accelerator>
Returns
TypeDescription
$this

getP4ServiceAccount

Output only. P4 service account for the customer project.

Returns
TypeDescription
string

setP4ServiceAccount

Output only. P4 service account for the customer project.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTenantProjectId

Output only. The name of the tenant project.

Returns
TypeDescription
string

setTenantProjectId

Output only. The name of the tenant project.

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getEnableRbac

Option to enable granular role-based access control.

Returns
TypeDescription
bool

setEnableRbac

Option to enable granular role-based access control.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getCryptoKeyConfig

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

Returns
TypeDescription
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
NameDescription
var Google\Cloud\DataFusion\V1\CryptoKeyConfig
Returns
TypeDescription
$this

getDisabledReason

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

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setDisabledReason

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

Parameter
NameDescription
var int[]
Returns
TypeDescription
$this