Class: Google::Apis::ComposerV1::EnvironmentConfig

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/composer_v1/classes.rb,
lib/google/apis/composer_v1/representations.rb,
lib/google/apis/composer_v1/representations.rb

Overview

Configuration information for an environment.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ EnvironmentConfig

Returns a new instance of EnvironmentConfig.



318
319
320
 
# File 'lib/google/apis/composer_v1/classes.rb', line 318

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#airflow_uri ⇒ String

Output only. The URI of the Apache Airflow Web UI hosted within this environment (see Airflow web interface). Corresponds to the JSON property airflowUri

Returns:

  • (String) 


259
260
261
 
# File 'lib/google/apis/composer_v1/classes.rb', line 259

def airflow_uri
  @airflow_uri
end

#dag_gcs_prefix ⇒ String

Output only. The Cloud Storage prefix of the DAGs for this environment. Although Cloud Storage objects reside in a flat namespace, a hierarchical file tree can be simulated using "/"-delimited object name prefixes. DAG objects for this environment reside in a simulated directory with the given prefix. Corresponds to the JSON property dagGcsPrefix

Returns:

  • (String) 


267
268
269
 
# File 'lib/google/apis/composer_v1/classes.rb', line 267

def dag_gcs_prefix
  @dag_gcs_prefix
end

#database_config ⇒ Google::Apis::ComposerV1::DatabaseConfig

The configuration of Cloud SQL instance that is used by the Apache Airflow software. Corresponds to the JSON property databaseConfig

Returns:



273
274
275
 
# File 'lib/google/apis/composer_v1/classes.rb', line 273

def database_config
  @database_config
end

#encryption_config ⇒ Google::Apis::ComposerV1::EncryptionConfig

The encryption options for the Cloud Composer environment and its dependencies. Corresponds to the JSON property encryptionConfig

Returns:



278
279
280
 
# File 'lib/google/apis/composer_v1/classes.rb', line 278

def encryption_config
  @encryption_config
end

#gke_cluster ⇒ String

Output only. The Kubernetes Engine cluster used to run this environment. Corresponds to the JSON property gkeCluster

Returns:

  • (String) 


283
284
285
 
# File 'lib/google/apis/composer_v1/classes.rb', line 283

def gke_cluster
  @gke_cluster
end

#node_config ⇒ Google::Apis::ComposerV1::NodeConfig

The configuration information for the Kubernetes Engine nodes running the Apache Airflow software. Corresponds to the JSON property nodeConfig

Returns:



289
290
291
 
# File 'lib/google/apis/composer_v1/classes.rb', line 289

def node_config
  @node_config
end

#node_count ⇒ Fixnum

The number of nodes in the Kubernetes Engine cluster that will be used to run this environment. Corresponds to the JSON property nodeCount

Returns:

  • (Fixnum) 


295
296
297
 
# File 'lib/google/apis/composer_v1/classes.rb', line 295

def node_count
  @node_count
end

#private_environment_config ⇒ Google::Apis::ComposerV1::PrivateEnvironmentConfig

The configuration information for configuring a Private IP Cloud Composer environment. Corresponds to the JSON property privateEnvironmentConfig

Returns:



301
302
303
 
# File 'lib/google/apis/composer_v1/classes.rb', line 301

def private_environment_config
  @private_environment_config
end

#software_config ⇒ Google::Apis::ComposerV1::SoftwareConfig

Specifies the selection and configuration of software inside the environment. Corresponds to the JSON property softwareConfig

Returns:



306
307
308
 
# File 'lib/google/apis/composer_v1/classes.rb', line 306

def software_config
  @software_config
end

#web_server_config ⇒ Google::Apis::ComposerV1::WebServerConfig

The configuration settings for the Airflow web server App Engine instance. Corresponds to the JSON property webServerConfig

Returns:



311
312
313
 
# File 'lib/google/apis/composer_v1/classes.rb', line 311

def web_server_config
  @web_server_config
end

#web_server_network_access_control ⇒ Google::Apis::ComposerV1::WebServerNetworkAccessControl

Network-level access control policy for the Airflow web server. Corresponds to the JSON property webServerNetworkAccessControl

Returns:



316
317
318
 
# File 'lib/google/apis/composer_v1/classes.rb', line 316

def web_server_network_access_control
  @web_server_network_access_control
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/google/apis/composer_v1/classes.rb', line 323

def update!(**args)
  @airflow_uri = args[:airflow_uri] if args.key?(:airflow_uri)
  @dag_gcs_prefix = args[:dag_gcs_prefix] if args.key?(:dag_gcs_prefix)
  @database_config = args[:database_config] if args.key?(:database_config)
  @encryption_config = args[:encryption_config] if args.key?(:encryption_config)
  @gke_cluster = args[:gke_cluster] if args.key?(:gke_cluster)
  @node_config = args[:node_config] if args.key?(:node_config)
  @node_count = args[:node_count] if args.key?(:node_count)
  @private_environment_config = args[:private_environment_config] if args.key?(:private_environment_config)
  @software_config = args[:software_config] if args.key?(:software_config)
  @web_server_config = args[:web_server_config] if args.key?(:web_server_config)
  @web_server_network_access_control = args[:web_server_network_access_control] if args.key?(:web_server_network_access_control)
end