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.



354
355
356
 
# File 'lib/google/apis/composer_v1/classes.rb', line 354

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) 


275
276
277
 
# File 'lib/google/apis/composer_v1/classes.rb', line 275

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) 


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

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. Supported for Cloud Composer environments in versions composer-1..- airflow-..*. Corresponds to the JSON property databaseConfig

Returns:



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

def database_config
  @database_config
end

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

The encryption options for the Cloud Composer environment and its dependencies. Supported for Cloud Composer environments in versions composer-1..-airflow-. *.. Corresponds to the JSON property encryptionConfig

Returns:



297
298
299
 
# File 'lib/google/apis/composer_v1/classes.rb', line 297

def encryption_config
  @encryption_config
end

#environment_size ⇒ String

Optional. The size of the Cloud Composer environment. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer. Corresponds to the JSON property environmentSize

Returns:

  • (String) 


304
305
306
 
# File 'lib/google/apis/composer_v1/classes.rb', line 304

def environment_size
  @environment_size
end

#gke_cluster ⇒ String

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

Returns:

  • (String) 


309
310
311
 
# File 'lib/google/apis/composer_v1/classes.rb', line 309

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:



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

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. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*. Corresponds to the JSON property nodeCount

Returns:

  • (Fixnum) 


322
323
324
 
# File 'lib/google/apis/composer_v1/classes.rb', line 322

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:



328
329
330
 
# File 'lib/google/apis/composer_v1/classes.rb', line 328

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:



333
334
335
 
# File 'lib/google/apis/composer_v1/classes.rb', line 333

def software_config
  @software_config
end

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

The configuration settings for the Airflow web server App Engine instance. Supported for Cloud Composer environments in versions composer-1..-airflow-. *. Corresponds to the JSON property webServerConfig

Returns:



340
341
342
 
# File 'lib/google/apis/composer_v1/classes.rb', line 340

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:



345
346
347
 
# File 'lib/google/apis/composer_v1/classes.rb', line 345

def web_server_network_access_control
  @web_server_network_access_control
end

#workloads_config ⇒ Google::Apis::ComposerV1::WorkloadsConfig

The Kubernetes workloads configuration for GKE cluster associated with the Cloud Composer environment. Supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer. Corresponds to the JSON property workloadsConfig

Returns:



352
353
354
 
# File 'lib/google/apis/composer_v1/classes.rb', line 352

def workloads_config
  @workloads_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/google/apis/composer_v1/classes.rb', line 359

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)
  @environment_size = args[:environment_size] if args.key?(:environment_size)
  @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)
  @workloads_config = args[:workloads_config] if args.key?(:workloads_config)
end