• Home
• com.google.apis
• google-api-services-sqladmin
• v1-rev20241108-2.0.0
• source code
• IpConfiguration.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.sqladmin.model.IpConfiguration.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.sqladmin.model
Class IpConfiguration



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.sqladmin.model.IpConfiguration













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class IpConfiguration
extends com.google.api.client.json.GenericJson
IP Management configuration.

 
 This is the Java data model class that specifies how to parse/serialize into the JSON that is
 transmitted over HTTP when working with the Cloud SQL Admin API. For a detailed explanation see:
 https://developers.google.com/api-client-library/java/google-http-java-client/json
 

Author:
Google, Inc.












Nested Class Summary




Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags





Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


IpConfiguration() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


IpConfiguration
clone() 


String
getAllocatedIpRange()
The name of the allocated ip range for the private ip Cloud SQL instance.



List<AclEntry>
getAuthorizedNetworks()
The list of external networks that are allowed to connect to the instance using the IP.



Boolean
getEnablePrivatePathForGoogleCloudServices()
Controls connectivity to private IP instances from Google services, such as BigQuery.



Boolean
getIpv4Enabled()
Whether the instance is assigned a public IP address or not.



String
getPrivateNetwork()
The resource link for the VPC network from which the Cloud SQL instance is accessible for
 private IP.



PscConfig
getPscConfig()
PSC settings for this instance.



Boolean
getRequireSsl()
Use `ssl_mode` instead.



String
getServerCaMode()
Specify what type of CA is used for the server certificate.



String
getSslMode()
Specify how SSL/TLS is enforced in database connections.



IpConfiguration
set(String fieldName,
   Object value) 


IpConfiguration
setAllocatedIpRange(String allocatedIpRange)
The name of the allocated ip range for the private ip Cloud SQL instance.



IpConfiguration
setAuthorizedNetworks(List<AclEntry> authorizedNetworks)
The list of external networks that are allowed to connect to the instance using the IP.



IpConfiguration
setEnablePrivatePathForGoogleCloudServices(Boolean enablePrivatePathForGoogleCloudServices)
Controls connectivity to private IP instances from Google services, such as BigQuery.



IpConfiguration
setIpv4Enabled(Boolean ipv4Enabled)
Whether the instance is assigned a public IP address or not.



IpConfiguration
setPrivateNetwork(String privateNetwork)
The resource link for the VPC network from which the Cloud SQL instance is accessible for
 private IP.



IpConfiguration
setPscConfig(PscConfig pscConfig)
PSC settings for this instance.



IpConfiguration
setRequireSsl(Boolean requireSsl)
Use `ssl_mode` instead.



IpConfiguration
setServerCaMode(String serverCaMode)
Specify what type of CA is used for the server certificate.



IpConfiguration
setSslMode(String sslMode)
Specify how SSL/TLS is enforced in database connections.







Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString





Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





IpConfiguration
public IpConfiguration()









Method Detail





getAllocatedIpRange
public String getAllocatedIpRange()
The name of the allocated ip range for the private ip Cloud SQL instance. For example: "google-
 managed-services-default". If set, the instance ip will be created in the allocated range. The
 range name must comply with [RFC 1035](https://tools.ietf.org/html/rfc1035). Specifically, the
 name must be 1-63 characters long and match the regular expression
 `[a-z]([-a-z0-9]*[a-z0-9])?.`

Returns:
value or null for none








setAllocatedIpRange
public IpConfiguration setAllocatedIpRange(String allocatedIpRange)
The name of the allocated ip range for the private ip Cloud SQL instance. For example: "google-
 managed-services-default". If set, the instance ip will be created in the allocated range. The
 range name must comply with [RFC 1035](https://tools.ietf.org/html/rfc1035). Specifically, the
 name must be 1-63 characters long and match the regular expression
 `[a-z]([-a-z0-9]*[a-z0-9])?.`

Parameters:
allocatedIpRange - allocatedIpRange or null for none








getAuthorizedNetworks
public List<AclEntry> getAuthorizedNetworks()
The list of external networks that are allowed to connect to the instance using the IP. In
 'CIDR' notation, also known as 'slash' notation (for example: `157.197.200.0/24`).

Returns:
value or null for none








setAuthorizedNetworks
public IpConfiguration setAuthorizedNetworks(List<AclEntry> authorizedNetworks)
The list of external networks that are allowed to connect to the instance using the IP. In
 'CIDR' notation, also known as 'slash' notation (for example: `157.197.200.0/24`).

Parameters:
authorizedNetworks - authorizedNetworks or null for none








getEnablePrivatePathForGoogleCloudServices
public Boolean getEnablePrivatePathForGoogleCloudServices()
Controls connectivity to private IP instances from Google services, such as BigQuery.

Returns:
value or null for none








setEnablePrivatePathForGoogleCloudServices
public IpConfiguration setEnablePrivatePathForGoogleCloudServices(Boolean enablePrivatePathForGoogleCloudServices)
Controls connectivity to private IP instances from Google services, such as BigQuery.

Parameters:
enablePrivatePathForGoogleCloudServices - enablePrivatePathForGoogleCloudServices or null for none








getIpv4Enabled
public Boolean getIpv4Enabled()
Whether the instance is assigned a public IP address or not.

Returns:
value or null for none








setIpv4Enabled
public IpConfiguration setIpv4Enabled(Boolean ipv4Enabled)
Whether the instance is assigned a public IP address or not.

Parameters:
ipv4Enabled - ipv4Enabled or null for none








getPrivateNetwork
public String getPrivateNetwork()
The resource link for the VPC network from which the Cloud SQL instance is accessible for
 private IP. For example, `/projects/myProject/global/networks/default`. This setting can be
 updated, but it cannot be removed after it is set.

Returns:
value or null for none








setPrivateNetwork
public IpConfiguration setPrivateNetwork(String privateNetwork)
The resource link for the VPC network from which the Cloud SQL instance is accessible for
 private IP. For example, `/projects/myProject/global/networks/default`. This setting can be
 updated, but it cannot be removed after it is set.

Parameters:
privateNetwork - privateNetwork or null for none








getPscConfig
public PscConfig getPscConfig()
PSC settings for this instance.

Returns:
value or null for none








setPscConfig
public IpConfiguration setPscConfig(PscConfig pscConfig)
PSC settings for this instance.

Parameters:
pscConfig - pscConfig or null for none








getRequireSsl
public Boolean getRequireSsl()
Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then
 allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client
 certificate won't be verified. If set to true, then only allow connections encrypted with
 SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing
 the requirement for valid client certificates, then use the `ssl_mode` flag instead of the
 `require_ssl` flag.

Returns:
value or null for none








setRequireSsl
public IpConfiguration setRequireSsl(Boolean requireSsl)
Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then
 allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client
 certificate won't be verified. If set to true, then only allow connections encrypted with
 SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing
 the requirement for valid client certificates, then use the `ssl_mode` flag instead of the
 `require_ssl` flag.

Parameters:
requireSsl - requireSsl or null for none








getServerCaMode
public String getServerCaMode()
Specify what type of CA is used for the server certificate.

Returns:
value or null for none








setServerCaMode
public IpConfiguration setServerCaMode(String serverCaMode)
Specify what type of CA is used for the server certificate.

Parameters:
serverCaMode - serverCaMode or null for none








getSslMode
public String getSslMode()
Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag
 for backward compatibility, then only the following value pairs are valid: For PostgreSQL and
 MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` *
 `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` *
 `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: *
 `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY`
 and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`.
 For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`,
 `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means
 accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect
 `ssl_mode` and accepts only SSL connections.

Returns:
value or null for none








setSslMode
public IpConfiguration setSslMode(String sslMode)
Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag
 for backward compatibility, then only the following value pairs are valid: For PostgreSQL and
 MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` *
 `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` *
 `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: *
 `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY`
 and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`.
 For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`,
 `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means
 accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect
 `ssl_mode` and accepts only SSL connections.

Parameters:
sslMode - sslMode or null for none








set
public IpConfiguration set(String fieldName,
                           Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public IpConfiguration clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.