Class: Google::Apis::ComposerV1::PrivateEnvironmentConfig

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

The configuration information for configuring a Private IP Cloud Composer environment.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ PrivateEnvironmentConfig

Returns a new instance of PrivateEnvironmentConfig.



1766
1767
1768
 
# File 'lib/google/apis/composer_v1/classes.rb', line 1766

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

Instance Attribute Details

#cloud_composer_connection_subnetwork ⇒ String

Optional. When specified, the environment will use Private Service Connect instead of VPC peerings to connect to Cloud SQL in the Tenant Project, and the PSC endpoint in the Customer Project will use an IP address from this subnetwork. Corresponds to the JSON property cloudComposerConnectionSubnetwork

Returns:

  • (String) 


1688
1689
1690
 
# File 'lib/google/apis/composer_v1/classes.rb', line 1688

def cloud_composer_connection_subnetwork
  @cloud_composer_connection_subnetwork
end

#cloud_composer_network_ipv4_cidr_block ⇒ String

Optional. The CIDR block from which IP range for Cloud Composer Network in tenant project will be reserved. Needs to be disjoint from private_cluster_config.master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block. This field is supported for Cloud Composer environments in versions composer-2. .-airflow-..* and newer. Corresponds to the JSON property cloudComposerNetworkIpv4CidrBlock

Returns:

  • (String) 


1697
1698
1699
 
# File 'lib/google/apis/composer_v1/classes.rb', line 1697

def cloud_composer_network_ipv4_cidr_block
  @cloud_composer_network_ipv4_cidr_block
end

#cloud_composer_network_ipv4_reserved_range ⇒ String

Output only. The IP range reserved for the tenant project's Cloud Composer network. This field is supported for Cloud Composer environments in versions composer-2..-airflow-..* and newer. Corresponds to the JSON property cloudComposerNetworkIpv4ReservedRange

Returns:

  • (String) 


1704
1705
1706
 
# File 'lib/google/apis/composer_v1/classes.rb', line 1704

def cloud_composer_network_ipv4_reserved_range
  @cloud_composer_network_ipv4_reserved_range
end

#cloud_sql_ipv4_cidr_block ⇒ String

Optional. The CIDR block from which IP range in tenant project will be reserved for Cloud SQL. Needs to be disjoint from web_server_ipv4_cidr_block. Corresponds to the JSON property cloudSqlIpv4CidrBlock

Returns:

  • (String) 


1710
1711
1712
 
# File 'lib/google/apis/composer_v1/classes.rb', line 1710

def cloud_sql_ipv4_cidr_block
  @cloud_sql_ipv4_cidr_block
end

#enable_private_builds_only ⇒ Boolean Also known as: enable_private_builds_only?

Optional. If true, builds performed during operations that install Python packages have only private connectivity to Google services (including Artifact Registry) and VPC network (if either NodeConfig.network and NodeConfig. subnetwork fields or NodeConfig.composer_network_attachment field are specified). If false, the builds also have access to the internet. This field is supported for Cloud Composer environments in versions composer-3..- airflow-..* and newer. Corresponds to the JSON property enablePrivateBuildsOnly

Returns:

  • (Boolean) 


1721
1722
1723
 
# File 'lib/google/apis/composer_v1/classes.rb', line 1721

def enable_private_builds_only
  @enable_private_builds_only
end

#enable_private_environment ⇒ Boolean Also known as: enable_private_environment?

Optional. If true, a Private IP Cloud Composer environment is created. If this field is set to true, IPAllocationPolicy.use_ip_aliases must be set to true for Cloud Composer environments in versions composer-1..-airflow-..*. Corresponds to the JSON property enablePrivateEnvironment

Returns:

  • (Boolean) 


1729
1730
1731
 
# File 'lib/google/apis/composer_v1/classes.rb', line 1729

def enable_private_environment
  @enable_private_environment
end

#enable_privately_used_public_ips ⇒ Boolean Also known as: enable_privately_used_public_ips?

Optional. When enabled, IPs from public (non-RFC1918) ranges can be used for IPAllocationPolicy.cluster_ipv4_cidr_block and IPAllocationPolicy. service_ipv4_cidr_block. Corresponds to the JSON property enablePrivatelyUsedPublicIps

Returns:

  • (Boolean) 


1737
1738
1739
 
# File 'lib/google/apis/composer_v1/classes.rb', line 1737

def enable_privately_used_public_ips
  @enable_privately_used_public_ips
end

#networking_config ⇒ Google::Apis::ComposerV1::NetworkingConfig

Configuration options for networking connections in the Composer 2 environment. Corresponds to the JSON property networkingConfig

Returns:



1743
1744
1745
 
# File 'lib/google/apis/composer_v1/classes.rb', line 1743

def networking_config
  @networking_config
end

#private_cluster_config ⇒ Google::Apis::ComposerV1::PrivateClusterConfig

Configuration options for the private GKE cluster in a Cloud Composer environment. Corresponds to the JSON property privateClusterConfig

Returns:



1749
1750
1751
 
# File 'lib/google/apis/composer_v1/classes.rb', line 1749

def private_cluster_config
  @private_cluster_config
end

#web_server_ipv4_cidr_block ⇒ String

Optional. The CIDR block from which IP range for web server will be reserved. Needs to be disjoint from private_cluster_config.master_ipv4_cidr_block and cloud_sql_ipv4_cidr_block. This field is supported for Cloud Composer environments in versions composer-1..-airflow-..*. Corresponds to the JSON property webServerIpv4CidrBlock

Returns:

  • (String) 


1757
1758
1759
 
# File 'lib/google/apis/composer_v1/classes.rb', line 1757

def web_server_ipv4_cidr_block
  @web_server_ipv4_cidr_block
end

#web_server_ipv4_reserved_range ⇒ String

Output only. The IP range reserved for the tenant project's App Engine VMs. This field is supported for Cloud Composer environments in versions composer-1. .-airflow-..*. Corresponds to the JSON property webServerIpv4ReservedRange

Returns:

  • (String) 


1764
1765
1766
 
# File 'lib/google/apis/composer_v1/classes.rb', line 1764

def web_server_ipv4_reserved_range
  @web_server_ipv4_reserved_range
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
 
# File 'lib/google/apis/composer_v1/classes.rb', line 1771

def update!(**args)
  @cloud_composer_connection_subnetwork = args[:cloud_composer_connection_subnetwork] if args.key?(:cloud_composer_connection_subnetwork)
  @cloud_composer_network_ipv4_cidr_block = args[:cloud_composer_network_ipv4_cidr_block] if args.key?(:cloud_composer_network_ipv4_cidr_block)
  @cloud_composer_network_ipv4_reserved_range = args[:cloud_composer_network_ipv4_reserved_range] if args.key?(:cloud_composer_network_ipv4_reserved_range)
  @cloud_sql_ipv4_cidr_block = args[:cloud_sql_ipv4_cidr_block] if args.key?(:cloud_sql_ipv4_cidr_block)
  @enable_private_builds_only = args[:enable_private_builds_only] if args.key?(:enable_private_builds_only)
  @enable_private_environment = args[:enable_private_environment] if args.key?(:enable_private_environment)
  @enable_privately_used_public_ips = args[:enable_privately_used_public_ips] if args.key?(:enable_privately_used_public_ips)
  @networking_config = args[:networking_config] if args.key?(:networking_config)
  @private_cluster_config = args[:private_cluster_config] if args.key?(:private_cluster_config)
  @web_server_ipv4_cidr_block = args[:web_server_ipv4_cidr_block] if args.key?(:web_server_ipv4_cidr_block)
  @web_server_ipv4_reserved_range = args[:web_server_ipv4_reserved_range] if args.key?(:web_server_ipv4_reserved_range)
end