Close httplib2 connections.
create(parent, body=None, instanceId=None, requestId=None, validateOnly=None, x__xgafv=None)
Creates a new Instance in a given project and location.
Creates a new SECONDARY Instance in a given project and location.
delete(name, etag=None, requestId=None, validateOnly=None, x__xgafv=None)
Deletes a single Instance.
failover(name, body=None, x__xgafv=None)
Forces a Failover for a highly available instance. Failover promotes the HA standby instance as the new primary. Imperative only.
get(name, view=None, x__xgafv=None)
Gets details of a single Instance.
getConnectionInfo(parent, requestId=None, x__xgafv=None)
Get instance metadata used for a connection.
injectFault(name, body=None, x__xgafv=None)
Injects fault in an instance. Imperative only.
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists Instances in a given project and location.
Retrieves the next page of results.
Updates the parameters of a single Instance.
restart(name, body=None, x__xgafv=None)
Restart an Instance in a cluster. Imperative only.
close()
Close httplib2 connections.
create(parent, body=None, instanceId=None, requestId=None, validateOnly=None, x__xgafv=None)
Creates a new Instance in a given project and location.
Args:
parent: string, Required. The name of the parent resource. For the required format, see the comment on the Instance.name field. (required)
body: object, The request body.
The object takes the form of:
{ # An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB.
"annotations": { # Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
"a_key": "A String",
},
"availabilityType": "A 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).
"clientConnectionConfig": { # Client connection configuration # Optional. Client connection specific configurations
"requireConnectors": True or False, # Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
"sslConfig": { # SSL configuration. # Optional. SSL configuration option for this instance.
"caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
"sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
},
},
"createTime": "A String", # Output only. Create time stamp
"databaseFlags": { # Database flags. Set at the instance level. They are copied from the primary instance on secondary instance creation. Flags that have restrictions default to the value at primary instance on read instances during creation. Read instances can set new flags or override existing flags that are relevant for reads, for example, for enabling columnar cache on a read instance. Flags set on read instance might or might not be present on the primary instance. 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.
"a_key": "A String",
},
"deleteTime": "A String", # Output only. Delete time stamp
"displayName": "A String", # User-settable and human-readable display name for the Instance.
"etag": "A String", # For Resource freshness validation (https://google.aip.dev/154)
"gceZone": "A 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.
"instanceType": "A String", # Required. The type of the instance. Specified at creation time.
"ipAddress": "A String", # Output only. The IP address for the Instance. This is the connection endpoint for an end-user application.
"labels": { # Labels as key value pairs
"a_key": "A String",
},
"machineConfig": { # MachineConfig describes the configuration of a machine. # Configurations for the machines that host the underlying database engine.
"cpuCount": 42, # The number of CPU's in the VM instance.
},
"name": "A 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}
"networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration.
"authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance.
{ # AuthorizedNetwork contains metadata for an authorized network.
"cidrRange": "A String", # CIDR range for one authorzied network of the instance.
},
],
"enableOutboundPublicIp": True or False, # Optional. Enabling an outbound public IP address to support a database server sending requests out into the internet.
"enablePublicIp": True or False, # Optional. Enabling public ip for the instance.
},
"nodes": [ # Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
{ # 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.
"id": "A String", # The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
"ip": "A String", # The private IP address of the VM e.g. "10.57.0.34".
"state": "A String", # Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.
"zoneId": "A String", # The Compute Engine zone of the VM e.g. "us-central1-b".
},
],
"outboundPublicIpAddresses": [ # Output only. All outbound public IP addresses configured for the instance.
"A String",
],
"pscInstanceConfig": { # PscInstanceConfig contains PSC related configuration at an instance level. # Optional. The configuration for Private Service Connect (PSC) for the instance.
"allowedConsumerProjects": [ # Optional. List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance.
"A String",
],
"pscDnsName": "A String", # Output only. The DNS name of the instance for PSC connectivity. Name convention: ...alloydb-psc.goog
"serviceAttachmentLink": "A String", # Output only. The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of `projects//regions//serviceAttachments/`
},
"publicIpAddress": "A String", # Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application.
"queryInsightsConfig": { # QueryInsights Instance specific configuration. # Configuration for query insights.
"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid.
"queryStringLength": 42, # Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
"recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "on" by default.
"recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default.
},
"readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL.
"nodeCount": 42, # Read capacity, i.e. number of nodes in a read pool instance.
},
"reconciling": True or False, # 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.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"state": "A String", # Output only. The current serving state of the instance.
"uid": "A 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.
"updateTime": "A String", # Output only. Update time stamp
"writableNode": { # 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. # Output only. This is set for the read-write VM of the PRIMARY instance only.
"id": "A String", # The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
"ip": "A String", # The private IP address of the VM e.g. "10.57.0.34".
"state": "A String", # Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.
"zoneId": "A String", # The Compute Engine zone of the VM e.g. "us-central1-b".
},
}
instanceId: string, Required. ID of the requesting object.
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
validateOnly: boolean, Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
createsecondary(parent, body=None, instanceId=None, requestId=None, validateOnly=None, x__xgafv=None)
Creates a new SECONDARY Instance in a given project and location.
Args:
parent: string, Required. The name of the parent resource. For the required format, see the comment on the Instance.name field. (required)
body: object, The request body.
The object takes the form of:
{ # An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB.
"annotations": { # Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
"a_key": "A String",
},
"availabilityType": "A 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).
"clientConnectionConfig": { # Client connection configuration # Optional. Client connection specific configurations
"requireConnectors": True or False, # Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
"sslConfig": { # SSL configuration. # Optional. SSL configuration option for this instance.
"caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
"sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
},
},
"createTime": "A String", # Output only. Create time stamp
"databaseFlags": { # Database flags. Set at the instance level. They are copied from the primary instance on secondary instance creation. Flags that have restrictions default to the value at primary instance on read instances during creation. Read instances can set new flags or override existing flags that are relevant for reads, for example, for enabling columnar cache on a read instance. Flags set on read instance might or might not be present on the primary instance. 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.
"a_key": "A String",
},
"deleteTime": "A String", # Output only. Delete time stamp
"displayName": "A String", # User-settable and human-readable display name for the Instance.
"etag": "A String", # For Resource freshness validation (https://google.aip.dev/154)
"gceZone": "A 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.
"instanceType": "A String", # Required. The type of the instance. Specified at creation time.
"ipAddress": "A String", # Output only. The IP address for the Instance. This is the connection endpoint for an end-user application.
"labels": { # Labels as key value pairs
"a_key": "A String",
},
"machineConfig": { # MachineConfig describes the configuration of a machine. # Configurations for the machines that host the underlying database engine.
"cpuCount": 42, # The number of CPU's in the VM instance.
},
"name": "A 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}
"networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration.
"authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance.
{ # AuthorizedNetwork contains metadata for an authorized network.
"cidrRange": "A String", # CIDR range for one authorzied network of the instance.
},
],
"enableOutboundPublicIp": True or False, # Optional. Enabling an outbound public IP address to support a database server sending requests out into the internet.
"enablePublicIp": True or False, # Optional. Enabling public ip for the instance.
},
"nodes": [ # Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
{ # 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.
"id": "A String", # The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
"ip": "A String", # The private IP address of the VM e.g. "10.57.0.34".
"state": "A String", # Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.
"zoneId": "A String", # The Compute Engine zone of the VM e.g. "us-central1-b".
},
],
"outboundPublicIpAddresses": [ # Output only. All outbound public IP addresses configured for the instance.
"A String",
],
"pscInstanceConfig": { # PscInstanceConfig contains PSC related configuration at an instance level. # Optional. The configuration for Private Service Connect (PSC) for the instance.
"allowedConsumerProjects": [ # Optional. List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance.
"A String",
],
"pscDnsName": "A String", # Output only. The DNS name of the instance for PSC connectivity. Name convention: ...alloydb-psc.goog
"serviceAttachmentLink": "A String", # Output only. The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of `projects//regions//serviceAttachments/`
},
"publicIpAddress": "A String", # Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application.
"queryInsightsConfig": { # QueryInsights Instance specific configuration. # Configuration for query insights.
"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid.
"queryStringLength": 42, # Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
"recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "on" by default.
"recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default.
},
"readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL.
"nodeCount": 42, # Read capacity, i.e. number of nodes in a read pool instance.
},
"reconciling": True or False, # 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.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"state": "A String", # Output only. The current serving state of the instance.
"uid": "A 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.
"updateTime": "A String", # Output only. Update time stamp
"writableNode": { # 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. # Output only. This is set for the read-write VM of the PRIMARY instance only.
"id": "A String", # The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
"ip": "A String", # The private IP address of the VM e.g. "10.57.0.34".
"state": "A String", # Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.
"zoneId": "A String", # The Compute Engine zone of the VM e.g. "us-central1-b".
},
}
instanceId: string, Required. ID of the requesting object.
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
validateOnly: boolean, Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
delete(name, etag=None, requestId=None, validateOnly=None, x__xgafv=None)
Deletes a single Instance.
Args:
name: string, Required. The name of the resource. For the required format, see the comment on the Instance.name field. (required)
etag: string, Optional. The current etag of the Instance. If an etag is provided and does not match the current etag of the Instance, deletion will be blocked and an ABORTED error will be returned.
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
validateOnly: boolean, Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
failover(name, body=None, x__xgafv=None)
Forces a Failover for a highly available instance. Failover promotes the HA standby instance as the new primary. Imperative only.
Args:
name: string, Required. The name of the resource. For the required format, see the comment on the Instance.name field. (required)
body: object, The request body.
The object takes the form of:
{ # Message for triggering failover on an Instance
"requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
"validateOnly": True or False, # Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
get(name, view=None, x__xgafv=None)
Gets details of a single Instance.
Args:
name: string, Required. The name of the resource. For the required format, see the comment on the Instance.name field. (required)
view: string, The view of the instance to return.
Allowed values
INSTANCE_VIEW_UNSPECIFIED - INSTANCE_VIEW_UNSPECIFIED Not specified, equivalent to BASIC.
INSTANCE_VIEW_BASIC - BASIC server responses for a primary or read instance include all the relevant instance details, excluding the details of each node in the instance. The default value.
INSTANCE_VIEW_FULL - FULL response is equivalent to BASIC for primary instance (for now). For read pool instance, this includes details of each node in the pool.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB.
"annotations": { # Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
"a_key": "A String",
},
"availabilityType": "A 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).
"clientConnectionConfig": { # Client connection configuration # Optional. Client connection specific configurations
"requireConnectors": True or False, # Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
"sslConfig": { # SSL configuration. # Optional. SSL configuration option for this instance.
"caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
"sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
},
},
"createTime": "A String", # Output only. Create time stamp
"databaseFlags": { # Database flags. Set at the instance level. They are copied from the primary instance on secondary instance creation. Flags that have restrictions default to the value at primary instance on read instances during creation. Read instances can set new flags or override existing flags that are relevant for reads, for example, for enabling columnar cache on a read instance. Flags set on read instance might or might not be present on the primary instance. 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.
"a_key": "A String",
},
"deleteTime": "A String", # Output only. Delete time stamp
"displayName": "A String", # User-settable and human-readable display name for the Instance.
"etag": "A String", # For Resource freshness validation (https://google.aip.dev/154)
"gceZone": "A 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.
"instanceType": "A String", # Required. The type of the instance. Specified at creation time.
"ipAddress": "A String", # Output only. The IP address for the Instance. This is the connection endpoint for an end-user application.
"labels": { # Labels as key value pairs
"a_key": "A String",
},
"machineConfig": { # MachineConfig describes the configuration of a machine. # Configurations for the machines that host the underlying database engine.
"cpuCount": 42, # The number of CPU's in the VM instance.
},
"name": "A 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}
"networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration.
"authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance.
{ # AuthorizedNetwork contains metadata for an authorized network.
"cidrRange": "A String", # CIDR range for one authorzied network of the instance.
},
],
"enableOutboundPublicIp": True or False, # Optional. Enabling an outbound public IP address to support a database server sending requests out into the internet.
"enablePublicIp": True or False, # Optional. Enabling public ip for the instance.
},
"nodes": [ # Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
{ # 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.
"id": "A String", # The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
"ip": "A String", # The private IP address of the VM e.g. "10.57.0.34".
"state": "A String", # Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.
"zoneId": "A String", # The Compute Engine zone of the VM e.g. "us-central1-b".
},
],
"outboundPublicIpAddresses": [ # Output only. All outbound public IP addresses configured for the instance.
"A String",
],
"pscInstanceConfig": { # PscInstanceConfig contains PSC related configuration at an instance level. # Optional. The configuration for Private Service Connect (PSC) for the instance.
"allowedConsumerProjects": [ # Optional. List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance.
"A String",
],
"pscDnsName": "A String", # Output only. The DNS name of the instance for PSC connectivity. Name convention: ...alloydb-psc.goog
"serviceAttachmentLink": "A String", # Output only. The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of `projects//regions//serviceAttachments/`
},
"publicIpAddress": "A String", # Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application.
"queryInsightsConfig": { # QueryInsights Instance specific configuration. # Configuration for query insights.
"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid.
"queryStringLength": 42, # Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
"recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "on" by default.
"recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default.
},
"readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL.
"nodeCount": 42, # Read capacity, i.e. number of nodes in a read pool instance.
},
"reconciling": True or False, # 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.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"state": "A String", # Output only. The current serving state of the instance.
"uid": "A 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.
"updateTime": "A String", # Output only. Update time stamp
"writableNode": { # 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. # Output only. This is set for the read-write VM of the PRIMARY instance only.
"id": "A String", # The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
"ip": "A String", # The private IP address of the VM e.g. "10.57.0.34".
"state": "A String", # Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.
"zoneId": "A String", # The Compute Engine zone of the VM e.g. "us-central1-b".
},
}
getConnectionInfo(parent, requestId=None, x__xgafv=None)
Get instance metadata used for a connection.
Args:
parent: string, Required. The name of the parent resource. The required format is: projects/{project}/locations/{location}/clusters/{cluster}/instances/{instance} (required)
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # ConnectionInfo singleton resource. https://google.aip.dev/156
"instanceUid": "A String", # Output only. The unique ID of the Instance.
"ipAddress": "A String", # Output only. The private network IP address for the Instance. This is the default IP for the instance and is always created (even if enable_public_ip is set). This is the connection endpoint for an end-user application.
"name": "A String", # The name of the ConnectionInfo singleton resource, e.g.: projects/{project}/locations/{location}/clusters/*/instances/*/connectionInfo This field currently has no semantic meaning.
"publicIpAddress": "A String", # Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application.
}
injectFault(name, body=None, x__xgafv=None)
Injects fault in an instance. Imperative only.
Args:
name: string, Required. The name of the resource. For the required format, see the comment on the Instance.name field. (required)
body: object, The request body.
The object takes the form of:
{ # Message for triggering fault injection on an instance
"faultType": "A String", # Required. The type of fault to be injected in an instance.
"requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
"validateOnly": True or False, # Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists Instances in a given project and location.
Args:
parent: string, Required. The name of the parent resource. For the required format, see the comment on the Instance.name field. Additionally, you can perform an aggregated list operation by specifying a value with one of the following formats: * projects/{project}/locations/-/clusters/- * projects/{project}/locations/{region}/clusters/- (required)
filter: string, Optional. Filtering results
orderBy: string, Optional. Hint for how to order the results
pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
pageToken: string, A token identifying a page of results the server should return.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Message for response to listing Instances
"instances": [ # The list of Instance
{ # An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB.
"annotations": { # Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
"a_key": "A String",
},
"availabilityType": "A 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).
"clientConnectionConfig": { # Client connection configuration # Optional. Client connection specific configurations
"requireConnectors": True or False, # Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
"sslConfig": { # SSL configuration. # Optional. SSL configuration option for this instance.
"caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
"sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
},
},
"createTime": "A String", # Output only. Create time stamp
"databaseFlags": { # Database flags. Set at the instance level. They are copied from the primary instance on secondary instance creation. Flags that have restrictions default to the value at primary instance on read instances during creation. Read instances can set new flags or override existing flags that are relevant for reads, for example, for enabling columnar cache on a read instance. Flags set on read instance might or might not be present on the primary instance. 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.
"a_key": "A String",
},
"deleteTime": "A String", # Output only. Delete time stamp
"displayName": "A String", # User-settable and human-readable display name for the Instance.
"etag": "A String", # For Resource freshness validation (https://google.aip.dev/154)
"gceZone": "A 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.
"instanceType": "A String", # Required. The type of the instance. Specified at creation time.
"ipAddress": "A String", # Output only. The IP address for the Instance. This is the connection endpoint for an end-user application.
"labels": { # Labels as key value pairs
"a_key": "A String",
},
"machineConfig": { # MachineConfig describes the configuration of a machine. # Configurations for the machines that host the underlying database engine.
"cpuCount": 42, # The number of CPU's in the VM instance.
},
"name": "A 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}
"networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration.
"authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance.
{ # AuthorizedNetwork contains metadata for an authorized network.
"cidrRange": "A String", # CIDR range for one authorzied network of the instance.
},
],
"enableOutboundPublicIp": True or False, # Optional. Enabling an outbound public IP address to support a database server sending requests out into the internet.
"enablePublicIp": True or False, # Optional. Enabling public ip for the instance.
},
"nodes": [ # Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
{ # 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.
"id": "A String", # The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
"ip": "A String", # The private IP address of the VM e.g. "10.57.0.34".
"state": "A String", # Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.
"zoneId": "A String", # The Compute Engine zone of the VM e.g. "us-central1-b".
},
],
"outboundPublicIpAddresses": [ # Output only. All outbound public IP addresses configured for the instance.
"A String",
],
"pscInstanceConfig": { # PscInstanceConfig contains PSC related configuration at an instance level. # Optional. The configuration for Private Service Connect (PSC) for the instance.
"allowedConsumerProjects": [ # Optional. List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance.
"A String",
],
"pscDnsName": "A String", # Output only. The DNS name of the instance for PSC connectivity. Name convention: ...alloydb-psc.goog
"serviceAttachmentLink": "A String", # Output only. The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of `projects//regions//serviceAttachments/`
},
"publicIpAddress": "A String", # Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application.
"queryInsightsConfig": { # QueryInsights Instance specific configuration. # Configuration for query insights.
"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid.
"queryStringLength": 42, # Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
"recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "on" by default.
"recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default.
},
"readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL.
"nodeCount": 42, # Read capacity, i.e. number of nodes in a read pool instance.
},
"reconciling": True or False, # 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.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"state": "A String", # Output only. The current serving state of the instance.
"uid": "A 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.
"updateTime": "A String", # Output only. Update time stamp
"writableNode": { # 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. # Output only. This is set for the read-write VM of the PRIMARY instance only.
"id": "A String", # The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
"ip": "A String", # The private IP address of the VM e.g. "10.57.0.34".
"state": "A String", # Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.
"zoneId": "A String", # The Compute Engine zone of the VM e.g. "us-central1-b".
},
},
],
"nextPageToken": "A String", # A token identifying a page of results the server should return.
"unreachable": [ # Locations that could not be reached.
"A String",
],
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(name, allowMissing=None, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)
Updates the parameters of a single Instance.
Args:
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} (required)
body: object, The request body.
The object takes the form of:
{ # An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB.
"annotations": { # Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
"a_key": "A String",
},
"availabilityType": "A 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).
"clientConnectionConfig": { # Client connection configuration # Optional. Client connection specific configurations
"requireConnectors": True or False, # Optional. Configuration to enforce connectors only (ex: AuthProxy) connections to the database.
"sslConfig": { # SSL configuration. # Optional. SSL configuration option for this instance.
"caSource": "A String", # Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.
"sslMode": "A String", # Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
},
},
"createTime": "A String", # Output only. Create time stamp
"databaseFlags": { # Database flags. Set at the instance level. They are copied from the primary instance on secondary instance creation. Flags that have restrictions default to the value at primary instance on read instances during creation. Read instances can set new flags or override existing flags that are relevant for reads, for example, for enabling columnar cache on a read instance. Flags set on read instance might or might not be present on the primary instance. 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.
"a_key": "A String",
},
"deleteTime": "A String", # Output only. Delete time stamp
"displayName": "A String", # User-settable and human-readable display name for the Instance.
"etag": "A String", # For Resource freshness validation (https://google.aip.dev/154)
"gceZone": "A 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.
"instanceType": "A String", # Required. The type of the instance. Specified at creation time.
"ipAddress": "A String", # Output only. The IP address for the Instance. This is the connection endpoint for an end-user application.
"labels": { # Labels as key value pairs
"a_key": "A String",
},
"machineConfig": { # MachineConfig describes the configuration of a machine. # Configurations for the machines that host the underlying database engine.
"cpuCount": 42, # The number of CPU's in the VM instance.
},
"name": "A 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}
"networkConfig": { # Metadata related to instance-level network configuration. # Optional. Instance-level network configuration.
"authorizedExternalNetworks": [ # Optional. A list of external network authorized to access this instance.
{ # AuthorizedNetwork contains metadata for an authorized network.
"cidrRange": "A String", # CIDR range for one authorzied network of the instance.
},
],
"enableOutboundPublicIp": True or False, # Optional. Enabling an outbound public IP address to support a database server sending requests out into the internet.
"enablePublicIp": True or False, # Optional. Enabling public ip for the instance.
},
"nodes": [ # Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
{ # 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.
"id": "A String", # The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
"ip": "A String", # The private IP address of the VM e.g. "10.57.0.34".
"state": "A String", # Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.
"zoneId": "A String", # The Compute Engine zone of the VM e.g. "us-central1-b".
},
],
"outboundPublicIpAddresses": [ # Output only. All outbound public IP addresses configured for the instance.
"A String",
],
"pscInstanceConfig": { # PscInstanceConfig contains PSC related configuration at an instance level. # Optional. The configuration for Private Service Connect (PSC) for the instance.
"allowedConsumerProjects": [ # Optional. List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance.
"A String",
],
"pscDnsName": "A String", # Output only. The DNS name of the instance for PSC connectivity. Name convention: ...alloydb-psc.goog
"serviceAttachmentLink": "A String", # Output only. The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of `projects//regions//serviceAttachments/`
},
"publicIpAddress": "A String", # Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application.
"queryInsightsConfig": { # QueryInsights Instance specific configuration. # Configuration for query insights.
"queryPlansPerMinute": 42, # Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 and 20 is considered valid.
"queryStringLength": 42, # Query string length. The default value is 1024. Any integer between 256 and 4500 is considered valid.
"recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "on" by default.
"recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default.
},
"readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL.
"nodeCount": 42, # Read capacity, i.e. number of nodes in a read pool instance.
},
"reconciling": True or False, # 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.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"state": "A String", # Output only. The current serving state of the instance.
"uid": "A 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.
"updateTime": "A String", # Output only. Update time stamp
"writableNode": { # 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. # Output only. This is set for the read-write VM of the PRIMARY instance only.
"id": "A String", # The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
"ip": "A String", # The private IP address of the VM e.g. "10.57.0.34".
"state": "A String", # Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.
"zoneId": "A String", # The Compute Engine zone of the VM e.g. "us-central1-b".
},
}
allowMissing: boolean, Optional. If set to true, update succeeds even if instance is not found. In that case, a new instance is created and `update_mask` is ignored.
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the Instance resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
validateOnly: boolean, Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
restart(name, body=None, x__xgafv=None)
Restart an Instance in a cluster. Imperative only.
Args:
name: string, Required. The name of the resource. For the required format, see the comment on the Instance.name field. (required)
body: object, The request body.
The object takes the form of:
{
"nodeIds": [ # Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to restart upon. Applicable only to read instances.
"A String",
],
"requestId": "A String", # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
"validateOnly": True or False, # Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}