Class: Google::Apis::AlloydbV1alpha::Instance

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

Overview

An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Instance

Returns a new instance of Instance.



1226
1227
1228
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 1226

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

Instance Attribute Details

#annotations ⇒ Hash<String,String>

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128 Corresponds to the JSON property annotations

Returns:

  • (Hash<String,String>) 


1074
1075
1076
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 1074

def annotations
  @annotations
end

#availability_type ⇒ String

Availability type of an Instance. If empty, defaults to REGIONAL for primary instances. For read pools, availability_type is always UNSPECIFIED. Instances in the read pools are evenly distributed across available zones within the region (i.e. read pools with more than one node will have a node in at least two zones). Corresponds to the JSON property availabilityType

Returns:

  • (String) 


1083
1084
1085
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 1083

def availability_type
  @availability_type
end

#client_connection_config ⇒ Google::Apis::AlloydbV1alpha::ClientConnectionConfig

Client connection configuration Corresponds to the JSON property clientConnectionConfig

Returns:



1088
1089
1090
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 1088

def client_connection_config
  @client_connection_config
end

#create_time ⇒ String

Output only. Create time stamp Corresponds to the JSON property createTime

Returns:

  • (String) 


1093
1094
1095
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 1093

def create_time
  @create_time
end

#database_flags ⇒ Hash<String,String>

Database flags. Set at instance level. * They are copied from primary instance on read instance creation. * Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary. This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to on for true and off for false. This field must be omitted if the flag doesn't take a value. Corresponds to the JSON property databaseFlags

Returns:

  • (Hash<String,String>) 


1107
1108
1109
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 1107

def database_flags
  @database_flags
end

#delete_time ⇒ String

Output only. Delete time stamp Corresponds to the JSON property deleteTime

Returns:

  • (String) 


1112
1113
1114
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 1112

def delete_time
  @delete_time
end

#display_name ⇒ String

User-settable and human-readable display name for the Instance. Corresponds to the JSON property displayName

Returns:

  • (String) 


1117
1118
1119
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 1117

def display_name
  @display_name
end

#etag ⇒ String

For Resource freshness validation (https://google.aip.dev/154) Corresponds to the JSON property etag

Returns:

  • (String) 


1122
1123
1124
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 1122

def etag
  @etag
end

#gce_zone ⇒ String

The Compute Engine zone that the instance should serve from, per https://cloud. google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity. Corresponds to the JSON property gceZone

Returns:

  • (String) 


1131
1132
1133
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 1131

def gce_zone
  @gce_zone
end

#instance_type ⇒ String

Required. The type of the instance. Specified at creation time. Corresponds to the JSON property instanceType

Returns:

  • (String) 


1136
1137
1138
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 1136

def instance_type
  @instance_type
end

#ip_address ⇒ String

Output only. The IP address for the Instance. This is the connection endpoint for an end-user application. Corresponds to the JSON property ipAddress

Returns:

  • (String) 


1142
1143
1144
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 1142

def ip_address
  @ip_address
end

#labels ⇒ Hash<String,String>

Labels as key value pairs Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


1147
1148
1149
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 1147

def labels
  @labels
end

#machine_config ⇒ Google::Apis::AlloydbV1alpha::MachineConfig

MachineConfig describes the configuration of a machine. Corresponds to the JSON property machineConfig

Returns:



1152
1153
1154
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 1152

def machine_config
  @machine_config
end

#name ⇒ String

Output only. The name of the instance resource with the format: * projects/ project/locations/region/clusters/cluster_id/instances/instance_id where the cluster and instance ID segments should satisfy the regex expression [a-z]([a-z0-9-]0,61[a-z0-9])?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/project /locations/region/clusters/cluster_id Corresponds to the JSON property name

Returns:

  • (String) 


1164
1165
1166
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 1164

def name
  @name
end

#nodes ⇒ Array<Google::Apis::AlloydbV1alpha::Node>

Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance. Corresponds to the JSON property nodes

Returns:



1170
1171
1172
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 1170

def nodes
  @nodes
end

#query_insights_config ⇒ Google::Apis::AlloydbV1alpha::QueryInsightsInstanceConfig

QueryInsights Instance specific configuration. Corresponds to the JSON property queryInsightsConfig

Returns:



1175
1176
1177
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 1175

def query_insights_config
  @query_insights_config
end

#read_pool_config ⇒ Google::Apis::AlloydbV1alpha::ReadPoolConfig

Configuration for a read pool instance. Corresponds to the JSON property readPoolConfig

Returns:



1180
1181
1182
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 1180

def read_pool_config
  @read_pool_config
end

#reconciling ⇒ Boolean Also known as: reconciling?

Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance. Corresponds to the JSON property reconciling

Returns:

  • (Boolean) 


1189
1190
1191
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 1189

def reconciling
  @reconciling
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


1195
1196
1197
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 1195

def satisfies_pzs
  @satisfies_pzs
end

#state ⇒ String

Output only. The current serving state of the instance. Corresponds to the JSON property state

Returns:

  • (String) 


1201
1202
1203
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 1201

def state
  @state
end

#uid ⇒ String

Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted. Corresponds to the JSON property uid

Returns:

  • (String) 


1207
1208
1209
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 1207

def uid
  @uid
end

#update_policy ⇒ Google::Apis::AlloydbV1alpha::UpdatePolicy

Policy to be used while updating the instance. Corresponds to the JSON property updatePolicy

Returns:



1212
1213
1214
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 1212

def update_policy
  @update_policy
end

#update_time ⇒ String

Output only. Update time stamp Corresponds to the JSON property updateTime

Returns:

  • (String) 


1217
1218
1219
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 1217

def update_time
  @update_time
end

#writable_node ⇒ Google::Apis::AlloydbV1alpha::Node

Details of a single node in the instance. Nodes in an AlloyDB instance are ephemereal, they can change during update, failover, autohealing and resize operations. Corresponds to the JSON property writableNode

Returns:



1224
1225
1226
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 1224

def writable_node
  @writable_node
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
 
# File 'lib/google/apis/alloydb_v1alpha/classes.rb', line 1231

def update!(**args)
  @annotations = args[:annotations] if args.key?(:annotations)
  @availability_type = args[:availability_type] if args.key?(:availability_type)
  @client_connection_config = args[:client_connection_config] if args.key?(:client_connection_config)
  @create_time = args[:create_time] if args.key?(:create_time)
  @database_flags = args[:database_flags] if args.key?(:database_flags)
  @delete_time = args[:delete_time] if args.key?(:delete_time)
  @display_name = args[:display_name] if args.key?(:display_name)
  @etag = args[:etag] if args.key?(:etag)
  @gce_zone = args[:gce_zone] if args.key?(:gce_zone)
  @instance_type = args[:instance_type] if args.key?(:instance_type)
  @ip_address = args[:ip_address] if args.key?(:ip_address)
  @labels = args[:labels] if args.key?(:labels)
  @machine_config = args[:machine_config] if args.key?(:machine_config)
  @name = args[:name] if args.key?(:name)
  @nodes = args[:nodes] if args.key?(:nodes)
  @query_insights_config = args[:query_insights_config] if args.key?(:query_insights_config)
  @read_pool_config = args[:read_pool_config] if args.key?(:read_pool_config)
  @reconciling = args[:reconciling] if args.key?(:reconciling)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @state = args[:state] if args.key?(:state)
  @uid = args[:uid] if args.key?(:uid)
  @update_policy = args[:update_policy] if args.key?(:update_policy)
  @update_time = args[:update_time] if args.key?(:update_time)
  @writable_node = args[:writable_node] if args.key?(:writable_node)
end