Class: Google::Apis::SqladminV1::ConnectSettings

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/sqladmin_v1/classes.rb,
lib/google/apis/sqladmin_v1/representations.rb,
lib/google/apis/sqladmin_v1/representations.rb

Overview

Connect settings retrieval response.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ConnectSettings

Returns a new instance of ConnectSettings.



988
989
990
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 988

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

Instance Attribute Details

#backend_type ⇒ String

SECOND_GEN: Cloud SQL database instance. EXTERNAL: A database server that is not managed by Google. This property is read-only; use the tier property in the settings object to determine the database type. Corresponds to the JSON property backendType

Returns:

  • (String) 


901
902
903
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 901

def backend_type
  @backend_type
end

#connection_name ⇒ String

Optional. Output only. Connection name of the Cloud SQL instance used in connection strings, in the format project:region:instance. Corresponds to the JSON property connectionName

Returns:

  • (String) 


907
908
909
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 907

def connection_name
  @connection_name
end

#custom_subject_alternative_names ⇒ Array<String>

Custom subject alternative names for the server certificate. Corresponds to the JSON property customSubjectAlternativeNames

Returns:

  • (Array<String>) 


912
913
914
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 912

def custom_subject_alternative_names
  @custom_subject_alternative_names
end

#database_version ⇒ String

The database engine type and version. The databaseVersion field cannot be changed after instance creation. MySQL instances: MYSQL_8_0, MYSQL_5_7 ( default), or MYSQL_5_6. PostgreSQL instances: POSTGRES_9_6, POSTGRES_10, POSTGRES_11, POSTGRES_12 (default), POSTGRES_13, or POSTGRES_14. SQL Server instances: SQLSERVER_2017_STANDARD (default), SQLSERVER_2017_ENTERPRISE, SQLSERVER_2017_EXPRESS, SQLSERVER_2017_WEB, SQLSERVER_2019_STANDARD, SQLSERVER_2019_ENTERPRISE, SQLSERVER_2019_EXPRESS , or SQLSERVER_2019_WEB. Corresponds to the JSON property databaseVersion

Returns:

  • (String) 


924
925
926
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 924

def database_version
  @database_version
end

#dns_name ⇒ String

The dns name of the instance. Corresponds to the JSON property dnsName

Returns:

  • (String) 


929
930
931
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 929

def dns_name
  @dns_name
end

#dns_names ⇒ Array<Google::Apis::SqladminV1::DnsNameMapping>

Output only. The list of DNS names used by this instance. Corresponds to the JSON property dnsNames

Returns:



934
935
936
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 934

def dns_names
  @dns_names
end

#ip_addresses ⇒ Array<Google::Apis::SqladminV1::IpMapping>

The assigned IP addresses for the instance. Corresponds to the JSON property ipAddresses

Returns:



939
940
941
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 939

def ip_addresses
  @ip_addresses
end

#kind ⇒ String

This is always sql#connectSettings. Corresponds to the JSON property kind

Returns:

  • (String) 


944
945
946
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 944

def kind
  @kind
end

#mdx_protocol_support ⇒ Array<String>

Optional. Output only. mdx_protocol_support controls how the client uses metadata exchange when connecting to the instance. The values in the list representing parts of the MDX protocol that are supported by this instance. When the list is empty, the instance does not support MDX, so the client must not send an MDX request. The default is empty. Corresponds to the JSON property mdxProtocolSupport

Returns:

  • (Array<String>) 


953
954
955
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 953

def mdx_protocol_support
  @mdx_protocol_support
end

#node_count ⇒ Fixnum

The number of read pool nodes in a read pool. Corresponds to the JSON property nodeCount

Returns:

  • (Fixnum) 


958
959
960
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 958

def node_count
  @node_count
end

#nodes ⇒ Array<Google::Apis::SqladminV1::ConnectPoolNodeConfig>

Output only. Entries containing information about each read pool node of the read pool. Corresponds to the JSON property nodes

Returns:



964
965
966
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 964

def nodes
  @nodes
end

#psc_enabled ⇒ Boolean Also known as: psc_enabled?

Whether PSC connectivity is enabled for this instance. Corresponds to the JSON property pscEnabled

Returns:

  • (Boolean) 


969
970
971
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 969

def psc_enabled
  @psc_enabled
end

#region ⇒ String

The cloud region for the instance. For example, us-central1, europe-west1. The region cannot be changed after instance creation. Corresponds to the JSON property region

Returns:

  • (String) 


976
977
978
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 976

def region
  @region
end

#server_ca_cert ⇒ Google::Apis::SqladminV1::SslCert

SslCerts Resource Corresponds to the JSON property serverCaCert

Returns:



981
982
983
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 981

def server_ca_cert
  @server_ca_cert
end

#server_ca_mode ⇒ String

Specify what type of CA is used for the server certificate. Corresponds to the JSON property serverCaMode

Returns:

  • (String) 


986
987
988
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 986

def server_ca_mode
  @server_ca_mode
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
 
# File 'lib/google/apis/sqladmin_v1/classes.rb', line 993

def update!(**args)
  @backend_type = args[:backend_type] if args.key?(:backend_type)
  @connection_name = args[:connection_name] if args.key?(:connection_name)
  @custom_subject_alternative_names = args[:custom_subject_alternative_names] if args.key?(:custom_subject_alternative_names)
  @database_version = args[:database_version] if args.key?(:database_version)
  @dns_name = args[:dns_name] if args.key?(:dns_name)
  @dns_names = args[:dns_names] if args.key?(:dns_names)
  @ip_addresses = args[:ip_addresses] if args.key?(:ip_addresses)
  @kind = args[:kind] if args.key?(:kind)
  @mdx_protocol_support = args[:mdx_protocol_support] if args.key?(:mdx_protocol_support)
  @node_count = args[:node_count] if args.key?(:node_count)
  @nodes = args[:nodes] if args.key?(:nodes)
  @psc_enabled = args[:psc_enabled] if args.key?(:psc_enabled)
  @region = args[:region] if args.key?(:region)
  @server_ca_cert = args[:server_ca_cert] if args.key?(:server_ca_cert)
  @server_ca_mode = args[:server_ca_mode] if args.key?(:server_ca_mode)
end