Class PrivateEnvironmentConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.orchestration.airflow.service.v1beta1.PrivateEnvironmentConfig
All Implemented Interfaces:
PrivateEnvironmentConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated public final class PrivateEnvironmentConfig extends com.google.protobuf.GeneratedMessage implements PrivateEnvironmentConfigOrBuilder
 The configuration information for configuring a Private IP Cloud Composer
 environment.
 
Protobuf type google.cloud.orchestration.airflow.service.v1beta1.PrivateEnvironmentConfig
See Also:
  • Field Details

    • ENABLE_PRIVATE_ENVIRONMENT_FIELD_NUMBER

      public static final int ENABLE_PRIVATE_ENVIRONMENT_FIELD_NUMBER
      See Also:
    • ENABLE_PRIVATE_BUILDS_ONLY_FIELD_NUMBER

      public static final int ENABLE_PRIVATE_BUILDS_ONLY_FIELD_NUMBER
      See Also:
    • PRIVATE_CLUSTER_CONFIG_FIELD_NUMBER

      public static final int PRIVATE_CLUSTER_CONFIG_FIELD_NUMBER
      See Also:
    • WEB_SERVER_IPV4_CIDR_BLOCK_FIELD_NUMBER

      public static final int WEB_SERVER_IPV4_CIDR_BLOCK_FIELD_NUMBER
      See Also:
    • CLOUD_SQL_IPV4_CIDR_BLOCK_FIELD_NUMBER

      public static final int CLOUD_SQL_IPV4_CIDR_BLOCK_FIELD_NUMBER
      See Also:
    • WEB_SERVER_IPV4_RESERVED_RANGE_FIELD_NUMBER

      public static final int WEB_SERVER_IPV4_RESERVED_RANGE_FIELD_NUMBER
      See Also:
    • CLOUD_COMPOSER_NETWORK_IPV4_CIDR_BLOCK_FIELD_NUMBER

      public static final int CLOUD_COMPOSER_NETWORK_IPV4_CIDR_BLOCK_FIELD_NUMBER
      See Also:
    • CLOUD_COMPOSER_NETWORK_IPV4_RESERVED_RANGE_FIELD_NUMBER

      public static final int CLOUD_COMPOSER_NETWORK_IPV4_RESERVED_RANGE_FIELD_NUMBER
      See Also:
    • ENABLE_PRIVATELY_USED_PUBLIC_IPS_FIELD_NUMBER

      public static final int ENABLE_PRIVATELY_USED_PUBLIC_IPS_FIELD_NUMBER
      See Also:
    • CLOUD_COMPOSER_CONNECTION_SUBNETWORK_FIELD_NUMBER

      public static final int CLOUD_COMPOSER_CONNECTION_SUBNETWORK_FIELD_NUMBER
      See Also:
    • NETWORKING_CONFIG_FIELD_NUMBER

      public static final int NETWORKING_CONFIG_FIELD_NUMBER
      See Also:
  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • getEnablePrivateEnvironment

      public boolean getEnablePrivateEnvironment()
       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-*.*.*.
       
      bool enable_private_environment = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEnablePrivateEnvironment in interface PrivateEnvironmentConfigOrBuilder
      Returns:
      The enablePrivateEnvironment.
    • getEnablePrivateBuildsOnly

      public boolean getEnablePrivateBuildsOnly()
       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.
       
      bool enable_private_builds_only = 11 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEnablePrivateBuildsOnly in interface PrivateEnvironmentConfigOrBuilder
      Returns:
      The enablePrivateBuildsOnly.
    • hasPrivateClusterConfig

      public boolean hasPrivateClusterConfig()
       Optional. Configuration for the private GKE cluster for a Private IP
       Cloud Composer environment.
       
      .google.cloud.orchestration.airflow.service.v1beta1.PrivateClusterConfig private_cluster_config = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasPrivateClusterConfig in interface PrivateEnvironmentConfigOrBuilder
      Returns:
      Whether the privateClusterConfig field is set.
    • getPrivateClusterConfig

      public PrivateClusterConfig getPrivateClusterConfig()
       Optional. Configuration for the private GKE cluster for a Private IP
       Cloud Composer environment.
       
      .google.cloud.orchestration.airflow.service.v1beta1.PrivateClusterConfig private_cluster_config = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPrivateClusterConfig in interface PrivateEnvironmentConfigOrBuilder
      Returns:
      The privateClusterConfig.
    • getPrivateClusterConfigOrBuilder

      public PrivateClusterConfigOrBuilder getPrivateClusterConfigOrBuilder()
       Optional. Configuration for the private GKE cluster for a Private IP
       Cloud Composer environment.
       
      .google.cloud.orchestration.airflow.service.v1beta1.PrivateClusterConfig private_cluster_config = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPrivateClusterConfigOrBuilder in interface PrivateEnvironmentConfigOrBuilder
    • getWebServerIpv4CidrBlock

      public String getWebServerIpv4CidrBlock()
       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-*.*.*.
       
      string web_server_ipv4_cidr_block = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getWebServerIpv4CidrBlock in interface PrivateEnvironmentConfigOrBuilder
      Returns:
      The webServerIpv4CidrBlock.
    • getWebServerIpv4CidrBlockBytes

      public com.google.protobuf.ByteString getWebServerIpv4CidrBlockBytes()
       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-*.*.*.
       
      string web_server_ipv4_cidr_block = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getWebServerIpv4CidrBlockBytes in interface PrivateEnvironmentConfigOrBuilder
      Returns:
      The bytes for webServerIpv4CidrBlock.
    • getCloudSqlIpv4CidrBlock

      public String getCloudSqlIpv4CidrBlock()
       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
       
      string cloud_sql_ipv4_cidr_block = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCloudSqlIpv4CidrBlock in interface PrivateEnvironmentConfigOrBuilder
      Returns:
      The cloudSqlIpv4CidrBlock.
    • getCloudSqlIpv4CidrBlockBytes

      public com.google.protobuf.ByteString getCloudSqlIpv4CidrBlockBytes()
       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
       
      string cloud_sql_ipv4_cidr_block = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCloudSqlIpv4CidrBlockBytes in interface PrivateEnvironmentConfigOrBuilder
      Returns:
      The bytes for cloudSqlIpv4CidrBlock.
    • getWebServerIpv4ReservedRange

      public String getWebServerIpv4ReservedRange()
       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-*.*.*.
       
      string web_server_ipv4_reserved_range = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getWebServerIpv4ReservedRange in interface PrivateEnvironmentConfigOrBuilder
      Returns:
      The webServerIpv4ReservedRange.
    • getWebServerIpv4ReservedRangeBytes

      public com.google.protobuf.ByteString getWebServerIpv4ReservedRangeBytes()
       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-*.*.*.
       
      string web_server_ipv4_reserved_range = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getWebServerIpv4ReservedRangeBytes in interface PrivateEnvironmentConfigOrBuilder
      Returns:
      The bytes for webServerIpv4ReservedRange.
    • getCloudComposerNetworkIpv4CidrBlock

      public String getCloudComposerNetworkIpv4CidrBlock()
       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.
       
      string cloud_composer_network_ipv4_cidr_block = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCloudComposerNetworkIpv4CidrBlock in interface PrivateEnvironmentConfigOrBuilder
      Returns:
      The cloudComposerNetworkIpv4CidrBlock.
    • getCloudComposerNetworkIpv4CidrBlockBytes

      public com.google.protobuf.ByteString getCloudComposerNetworkIpv4CidrBlockBytes()
       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.
       
      string cloud_composer_network_ipv4_cidr_block = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCloudComposerNetworkIpv4CidrBlockBytes in interface PrivateEnvironmentConfigOrBuilder
      Returns:
      The bytes for cloudComposerNetworkIpv4CidrBlock.
    • getCloudComposerNetworkIpv4ReservedRange

      public String getCloudComposerNetworkIpv4ReservedRange()
       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.
       
      string cloud_composer_network_ipv4_reserved_range = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCloudComposerNetworkIpv4ReservedRange in interface PrivateEnvironmentConfigOrBuilder
      Returns:
      The cloudComposerNetworkIpv4ReservedRange.
    • getCloudComposerNetworkIpv4ReservedRangeBytes

      public com.google.protobuf.ByteString getCloudComposerNetworkIpv4ReservedRangeBytes()
       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.
       
      string cloud_composer_network_ipv4_reserved_range = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCloudComposerNetworkIpv4ReservedRangeBytes in interface PrivateEnvironmentConfigOrBuilder
      Returns:
      The bytes for cloudComposerNetworkIpv4ReservedRange.
    • getEnablePrivatelyUsedPublicIps

      public boolean getEnablePrivatelyUsedPublicIps()
       Optional. When enabled, IPs from public (non-RFC1918) ranges can be used
       for `IPAllocationPolicy.cluster_ipv4_cidr_block` and
       `IPAllocationPolicy.service_ipv4_cidr_block`.
       
      bool enable_privately_used_public_ips = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEnablePrivatelyUsedPublicIps in interface PrivateEnvironmentConfigOrBuilder
      Returns:
      The enablePrivatelyUsedPublicIps.
    • getCloudComposerConnectionSubnetwork

      public String getCloudComposerConnectionSubnetwork()
       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.
       
      string cloud_composer_connection_subnetwork = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCloudComposerConnectionSubnetwork in interface PrivateEnvironmentConfigOrBuilder
      Returns:
      The cloudComposerConnectionSubnetwork.
    • getCloudComposerConnectionSubnetworkBytes

      public com.google.protobuf.ByteString getCloudComposerConnectionSubnetworkBytes()
       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.
       
      string cloud_composer_connection_subnetwork = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCloudComposerConnectionSubnetworkBytes in interface PrivateEnvironmentConfigOrBuilder
      Returns:
      The bytes for cloudComposerConnectionSubnetwork.
    • hasNetworkingConfig

      public boolean hasNetworkingConfig()
       Optional. Configuration for the network connections configuration in the
       environment.
       
      .google.cloud.orchestration.airflow.service.v1beta1.NetworkingConfig networking_config = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasNetworkingConfig in interface PrivateEnvironmentConfigOrBuilder
      Returns:
      Whether the networkingConfig field is set.
    • getNetworkingConfig

      public NetworkingConfig getNetworkingConfig()
       Optional. Configuration for the network connections configuration in the
       environment.
       
      .google.cloud.orchestration.airflow.service.v1beta1.NetworkingConfig networking_config = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getNetworkingConfig in interface PrivateEnvironmentConfigOrBuilder
      Returns:
      The networkingConfig.
    • getNetworkingConfigOrBuilder

      public NetworkingConfigOrBuilder getNetworkingConfigOrBuilder()
       Optional. Configuration for the network connections configuration in the
       environment.
       
      .google.cloud.orchestration.airflow.service.v1beta1.NetworkingConfig networking_config = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getNetworkingConfigOrBuilder in interface PrivateEnvironmentConfigOrBuilder
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage
    • parseFrom

      public static PrivateEnvironmentConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static PrivateEnvironmentConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static PrivateEnvironmentConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static PrivateEnvironmentConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static PrivateEnvironmentConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static PrivateEnvironmentConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static PrivateEnvironmentConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static PrivateEnvironmentConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static PrivateEnvironmentConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static PrivateEnvironmentConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static PrivateEnvironmentConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static PrivateEnvironmentConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      public PrivateEnvironmentConfig.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static PrivateEnvironmentConfig.Builder newBuilder()
    • newBuilder

      public static PrivateEnvironmentConfig.Builder newBuilder(PrivateEnvironmentConfig prototype)
    • toBuilder

      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected PrivateEnvironmentConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static PrivateEnvironmentConfig getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<PrivateEnvironmentConfig> parser()
    • getParserForType

      public com.google.protobuf.Parser<PrivateEnvironmentConfig> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage
    • getDefaultInstanceForType

      public PrivateEnvironmentConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder