Class: Google::Apis::ComposerV1beta1::EnvironmentConfig

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/composer_v1beta1/classes.rb,
generated/google/apis/composer_v1beta1/representations.rb,
generated/google/apis/composer_v1beta1/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.



295
296
297
 
# File 'generated/google/apis/composer_v1beta1/classes.rb', line 295

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) 


227
228
229
 
# File 'generated/google/apis/composer_v1beta1/classes.rb', line 227

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) 


235
236
237
 
# File 'generated/google/apis/composer_v1beta1/classes.rb', line 235

def dag_gcs_prefix
  @dag_gcs_prefix
end

#database_config ⇒ Google::Apis::ComposerV1beta1::DatabaseConfig

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

Returns:



241
242
243
 
# File 'generated/google/apis/composer_v1beta1/classes.rb', line 241

def database_config
  @database_config
end

#encryption_config ⇒ Google::Apis::ComposerV1beta1::EncryptionConfig

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

Returns:



246
247
248
 
# File 'generated/google/apis/composer_v1beta1/classes.rb', line 246

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) 


251
252
253
 
# File 'generated/google/apis/composer_v1beta1/classes.rb', line 251

def gke_cluster
  @gke_cluster
end

#maintenance_window ⇒ Google::Apis::ComposerV1beta1::MaintenanceWindow

The configuration settings for Cloud Composer maintenance window. The following example: "startTime":"2019-08-01T01:00:00Z" "endTime":"2019-08- 01T07:00:00Z" "recurrence":"FREQ=WEEKLY;BYDAY=TU,WE" would define a maintenance window between 01 and 07 hours UTC during each Tuesday and Wednesday. Corresponds to the JSON property maintenanceWindow

Returns:



260
261
262
 
# File 'generated/google/apis/composer_v1beta1/classes.rb', line 260

def maintenance_window
  @maintenance_window
end

#node_config ⇒ Google::Apis::ComposerV1beta1::NodeConfig

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

Returns:



266
267
268
 
# File 'generated/google/apis/composer_v1beta1/classes.rb', line 266

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) 


272
273
274
 
# File 'generated/google/apis/composer_v1beta1/classes.rb', line 272

def node_count
  @node_count
end

#private_environment_config ⇒ Google::Apis::ComposerV1beta1::PrivateEnvironmentConfig

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

Returns:



278
279
280
 
# File 'generated/google/apis/composer_v1beta1/classes.rb', line 278

def private_environment_config
  @private_environment_config
end

#software_config ⇒ Google::Apis::ComposerV1beta1::SoftwareConfig

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

Returns:



283
284
285
 
# File 'generated/google/apis/composer_v1beta1/classes.rb', line 283

def software_config
  @software_config
end

#web_server_config ⇒ Google::Apis::ComposerV1beta1::WebServerConfig

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

Returns:



288
289
290
 
# File 'generated/google/apis/composer_v1beta1/classes.rb', line 288

def web_server_config
  @web_server_config
end

#web_server_network_access_control ⇒ Google::Apis::ComposerV1beta1::WebServerNetworkAccessControl

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

Returns:



293
294
295
 
# File 'generated/google/apis/composer_v1beta1/classes.rb', line 293

def web_server_network_access_control
  @web_server_network_access_control
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'generated/google/apis/composer_v1beta1/classes.rb', line 300

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