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.



1814
1815
1816
 
# File 'lib/google/apis/composer_v1/classes.rb', line 1814

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) 


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

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) 


1739
1740
1741
 
# File 'lib/google/apis/composer_v1/classes.rb', line 1739

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) 


1746
1747
1748
 
# File 'lib/google/apis/composer_v1/classes.rb', line 1746

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) 


1752
1753
1754
 
# File 'lib/google/apis/composer_v1/classes.rb', line 1752

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-..-build. and newer. Corresponds to the JSON property enablePrivateBuildsOnly

Returns:

  • (Boolean) 


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

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-..*. This field is going to be deprecated. Use networking_type instead. Corresponds to the JSON property enablePrivateEnvironment

Returns:

  • (Boolean) 


1772
1773
1774
 
# File 'lib/google/apis/composer_v1/classes.rb', line 1772

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) 


1780
1781
1782
 
# File 'lib/google/apis/composer_v1/classes.rb', line 1780

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:



1786
1787
1788
 
# File 'lib/google/apis/composer_v1/classes.rb', line 1786

def networking_config
  @networking_config
end

#networking_type ⇒ String

Optional. Networking type for the environment, either private or public. Corresponds to the JSON property networkingType

Returns:

  • (String) 


1791
1792
1793
 
# File 'lib/google/apis/composer_v1/classes.rb', line 1791

def networking_type
  @networking_type
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:



1797
1798
1799
 
# File 'lib/google/apis/composer_v1/classes.rb', line 1797

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) 


1805
1806
1807
 
# File 'lib/google/apis/composer_v1/classes.rb', line 1805

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) 


1812
1813
1814
 
# File 'lib/google/apis/composer_v1/classes.rb', line 1812

def web_server_ipv4_reserved_range
  @web_server_ipv4_reserved_range
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
 
# File 'lib/google/apis/composer_v1/classes.rb', line 1819

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