Cloud Data Fusion V1 API - Class Google::Cloud::DataFusion::V1::Instance (v2.3.1)
Stay organized with collections
Save and categorize content based on your preferences.
Reference documentation and code samples for the Cloud Data Fusion V1 API class Google::Cloud::DataFusion::V1::Instance.
Represents a Data Fusion instance.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#accelerators
defaccelerators()->::Array<::Google::Cloud::DataFusion::V1::Accelerator>
Returns
- (::Array<::Google::Cloud::DataFusion::V1::Accelerator>) — List of accelerators enabled for this CDF instance.
#accelerators=
defaccelerators=(value)->::Array<::Google::Cloud::DataFusion::V1::Accelerator>
Parameter
- value (::Array<::Google::Cloud::DataFusion::V1::Accelerator>) — List of accelerators enabled for this CDF instance.
Returns
- (::Array<::Google::Cloud::DataFusion::V1::Accelerator>) — List of accelerators enabled for this CDF instance.
#api_endpoint
defapi_endpoint()->::String
Returns
- (::String) — Output only. Endpoint on which the REST APIs is accessible.
#available_version
defavailable_version()->::Array<::Google::Cloud::DataFusion::V1::Version>
Returns
- (::Array<::Google::Cloud::DataFusion::V1::Version>) — Available versions that the instance can be upgraded to using UpdateInstanceRequest.
#available_version=
defavailable_version=(value)->::Array<::Google::Cloud::DataFusion::V1::Version>
Parameter
- value (::Array<::Google::Cloud::DataFusion::V1::Version>) — Available versions that the instance can be upgraded to using UpdateInstanceRequest.
Returns
- (::Array<::Google::Cloud::DataFusion::V1::Version>) — Available versions that the instance can be upgraded to using UpdateInstanceRequest.
#create_time
defcreate_time()->::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time the instance was created.
#crypto_key_config
defcrypto_key_config()->::Google::Cloud::DataFusion::V1::CryptoKeyConfig
Returns
- (::Google::Cloud::DataFusion::V1::CryptoKeyConfig) — The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature.
#crypto_key_config=
defcrypto_key_config=(value)->::Google::Cloud::DataFusion::V1::CryptoKeyConfig
Parameter
- value (::Google::Cloud::DataFusion::V1::CryptoKeyConfig) — The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature.
Returns
- (::Google::Cloud::DataFusion::V1::CryptoKeyConfig) — The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature.
#dataproc_service_account
defdataproc_service_account()->::String
Returns
-
(::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.
#dataproc_service_account=
defdataproc_service_account=(value)->::String
Parameter
-
value (::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.
Returns
-
(::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.
#description
defdescription()->::String
Returns
- (::String) — A description of this instance.
#description=
defdescription=(value)->::String
Parameter
- value (::String) — A description of this instance.
Returns
- (::String) — A description of this instance.
#disabled_reason
defdisabled_reason()->::Array<::Google::Cloud::DataFusion::V1::Instance::DisabledReason>
Returns
- (::Array<::Google::Cloud::DataFusion::V1::Instance::DisabledReason>) — Output only. If the instance state is DISABLED, the reason for disabling the instance.
#display_name
defdisplay_name()->::String
Returns
- (::String) — Display name for an instance.
#display_name=
defdisplay_name=(value)->::String
Parameter
- value (::String) — Display name for an instance.
Returns
- (::String) — Display name for an instance.
#enable_rbac
defenable_rbac()->::Boolean
Returns
- (::Boolean) — Option to enable granular role-based access control.
#enable_rbac=
defenable_rbac=(value)->::Boolean
Parameter
- value (::Boolean) — Option to enable granular role-based access control.
Returns
- (::Boolean) — Option to enable granular role-based access control.
#enable_stackdriver_logging
defenable_stackdriver_logging()->::Boolean
Returns
- (::Boolean) — Option to enable Stackdriver Logging.
#enable_stackdriver_logging=
defenable_stackdriver_logging=(value)->::Boolean
Parameter
- value (::Boolean) — Option to enable Stackdriver Logging.
Returns
- (::Boolean) — Option to enable Stackdriver Logging.
#enable_stackdriver_monitoring
defenable_stackdriver_monitoring()->::Boolean
Returns
- (::Boolean) — Option to enable Stackdriver Monitoring.
#enable_stackdriver_monitoring=
defenable_stackdriver_monitoring=(value)->::Boolean
Parameter
- value (::Boolean) — Option to enable Stackdriver Monitoring.
Returns
- (::Boolean) — Option to enable Stackdriver Monitoring.
#gcs_bucket
defgcs_bucket()->::String
Returns
- (::String) — Output only. Cloud Storage bucket generated by Data Fusion in the customer project.
#labels
deflabels()->::Google::Protobuf::Map{::String=>::String}
Returns
- (::Google::Protobuf::Map{::String => ::String}) — 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.
#labels=
deflabels=(value)->::Google::Protobuf::Map{::String=>::String}
Parameter
- value (::Google::Protobuf::Map{::String => ::String}) — 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
- (::Google::Protobuf::Map{::String => ::String}) — 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.
#name
defname()->::String
Returns
- (::String) — Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}.
#network_config
defnetwork_config()->::Google::Cloud::DataFusion::V1::NetworkConfig
Returns
- (::Google::Cloud::DataFusion::V1::NetworkConfig) — Network configuration options. These are required when a private Data Fusion instance is to be created.
#network_config=
defnetwork_config=(value)->::Google::Cloud::DataFusion::V1::NetworkConfig
Parameter
- value (::Google::Cloud::DataFusion::V1::NetworkConfig) — Network configuration options. These are required when a private Data Fusion instance is to be created.
Returns
- (::Google::Cloud::DataFusion::V1::NetworkConfig) — Network configuration options. These are required when a private Data Fusion instance is to be created.
#options
defoptions()->::Google::Protobuf::Map{::String=>::String}
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Map of additional options used to configure the behavior of Data Fusion instance.
#options=
defoptions=(value)->::Google::Protobuf::Map{::String=>::String}
Parameter
- value (::Google::Protobuf::Map{::String => ::String}) — Map of additional options used to configure the behavior of Data Fusion instance.
Returns
- (::Google::Protobuf::Map{::String => ::String}) — Map of additional options used to configure the behavior of Data Fusion instance.
#p4_service_account
defp4_service_account()->::String
Returns
- (::String) — Output only. P4 service account for the customer project.
#private_instance
defprivate_instance()->::Boolean
Returns
- (::Boolean) — 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.
#private_instance=
defprivate_instance=(value)->::Boolean
Parameter
- value (::Boolean) — 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
- (::Boolean) — 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.
#service_account
defservice_account()->::String
Returns
- (::String) — Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID.
#service_endpoint
defservice_endpoint()->::String
Returns
- (::String) — Output only. Endpoint on which the Data Fusion UI is accessible.
#state
defstate()->::Google::Cloud::DataFusion::V1::Instance::State
Returns
- (::Google::Cloud::DataFusion::V1::Instance::State) — Output only. The current state of this Data Fusion instance.
#state_message
defstate_message()->::String
Returns
- (::String) — Output only. Additional information about the current state of this Data Fusion instance if available.
#tenant_project_id
deftenant_project_id()->::String
Returns
- (::String) — Output only. The name of the tenant project.
#type
deftype()->::Google::Cloud::DataFusion::V1::Instance::Type
Returns
- (::Google::Cloud::DataFusion::V1::Instance::Type) — Required. Instance type.
#type=
deftype=(value)->::Google::Cloud::DataFusion::V1::Instance::Type
Parameter
- value (::Google::Cloud::DataFusion::V1::Instance::Type) — Required. Instance type.
Returns
- (::Google::Cloud::DataFusion::V1::Instance::Type) — Required. Instance type.
#update_time
defupdate_time()->::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time the instance was last updated.
#version
defversion()->::String
Returns
- (::String) — Current version of the Data Fusion. Only specifiable in Update.
#version=
defversion=(value)->::String
Parameter
- value (::String) — Current version of the Data Fusion. Only specifiable in Update.
Returns
- (::String) — Current version of the Data Fusion. Only specifiable in Update.
#zone
defzone()->::String
Returns
- (::String) — Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field.
#zone=
defzone=(value)->::String
Parameter
- value (::String) — Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field.
Returns
- (::String) — Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field.