- locations-backups-create$
- locations-backups-delete$
- locations-backups-get$
- locations-backups-list$
- locations-backups-patch$
- locations-clusters-create$
- locations-clusters-createsecondary$
- locations-clusters-delete$
- locations-clusters-get$
- locations-clusters-instances-create$
- locations-clusters-instances-createsecondary$
- locations-clusters-instances-delete$
- locations-clusters-instances-failover$
- locations-clusters-instances-get$
- locations-clusters-instances-getConnectionInfo$
- locations-clusters-instances-injectFault$
- locations-clusters-instances-list$
- locations-clusters-instances-patch$
- locations-clusters-instances-restart$
- locations-clusters-list$
- locations-clusters-patch$
- locations-clusters-promote$
- locations-clusters-restore$
- locations-clusters-users-create$
- locations-clusters-users-delete$
- locations-clusters-users-get$
- locations-clusters-users-list$
- locations-clusters-users-patch$
- locations-get$
- locations-list$
- locations-operations-cancel$
- locations-operations-delete$
- locations-operations-get$
- locations-operations-list$
- locations-supportedDatabaseFlags-list$
happygapi.alloydb.projects
AlloyDB API: projects. AlloyDB for PostgreSQL is an open source-compatible database service that provides a powerful option for migrating, modernizing, or building commercial-grade applications. It offers full compatibility with standard PostgreSQL, and is more than 4x faster for transactional workloads and up to 100x faster for analytical queries than standard PostgreSQL in our performance tests. AlloyDB for PostgreSQL offers a 99.99 percent availability SLA inclusive of maintenance. AlloyDB is optimized for the most demanding use cases, allowing you to build new applications that require high transaction throughput, large database sizes, or multiple read resources; scale existing PostgreSQL workloads with no application changes; and modernize legacy proprietary databases. See: https://cloud.google.com/alloydb/api/reference/rest/v1/projects
AlloyDB API: projects. AlloyDB for PostgreSQL is an open source-compatible database service that provides a powerful option for migrating, modernizing, or building commercial-grade applications. It offers full compatibility with standard PostgreSQL, and is more than 4x faster for transactional workloads and up to 100x faster for analytical queries than standard PostgreSQL in our performance tests. AlloyDB for PostgreSQL offers a 99.99 percent availability SLA inclusive of maintenance. AlloyDB is optimized for the most demanding use cases, allowing you to build new applications that require high transaction throughput, large database sizes, or multiple read resources; scale existing PostgreSQL workloads with no application changes; and modernize legacy proprietary databases. See: https://cloud.google.com/alloydb/api/reference/rest/v1/projects
locations-backups-create$clj
(locations-backups-create$ auth parameters body)https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/backups/create
Required parameters: parent
Optional parameters: backupId, requestId, validateOnly
Body:
{:description string, :labels {}, :databaseVersion string, :clusterName string, :deleteTime string, :encryptionInfo {:encryptionType string, :kmsKeyVersions [string]}, :displayName string, :uid string, :name string, :sizeBytes string, :createTime string, :type string, :etag string, :state string, :updateTime string, :reconciling boolean, :satisfiesPzs boolean, :expiryQuantity {:retentionCount integer, :totalRetentionCount integer}, :annotations {}, :expiryTime string, :clusterUid string, :encryptionConfig {:kmsKeyName string}}
Creates a new Backup in a given project and location.
https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/backups/create
Required parameters: parent
Optional parameters: backupId, requestId, validateOnly
Body:
{:description string,
:labels {},
:databaseVersion string,
:clusterName string,
:deleteTime string,
:encryptionInfo {:encryptionType string, :kmsKeyVersions [string]},
:displayName string,
:uid string,
:name string,
:sizeBytes string,
:createTime string,
:type string,
:etag string,
:state string,
:updateTime string,
:reconciling boolean,
:satisfiesPzs boolean,
:expiryQuantity {:retentionCount integer,
:totalRetentionCount integer},
:annotations {},
:expiryTime string,
:clusterUid string,
:encryptionConfig {:kmsKeyName string}}
Creates a new Backup in a given project and location.locations-backups-delete$clj
(locations-backups-delete$ auth parameters)https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/backups/delete
Required parameters: name
Optional parameters: requestId, validateOnly, etag
Deletes a single Backup.
https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/backups/delete Required parameters: name Optional parameters: requestId, validateOnly, etag Deletes a single Backup.
locations-backups-get$clj
(locations-backups-get$ auth parameters)https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/backups/get
Required parameters: name
Optional parameters: none
Gets details of a single Backup.
https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/backups/get Required parameters: name Optional parameters: none Gets details of a single Backup.
locations-backups-list$clj
(locations-backups-list$ auth parameters)https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/backups/list
Required parameters: parent
Optional parameters: pageSize, pageToken, filter, orderBy
Lists Backups in a given project and location.
https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/backups/list Required parameters: parent Optional parameters: pageSize, pageToken, filter, orderBy Lists Backups in a given project and location.
locations-backups-patch$clj
(locations-backups-patch$ auth parameters body)https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/backups/patch
Required parameters: name
Optional parameters: updateMask, requestId, validateOnly, allowMissing
Body:
{:description string, :labels {}, :databaseVersion string, :clusterName string, :deleteTime string, :encryptionInfo {:encryptionType string, :kmsKeyVersions [string]}, :displayName string, :uid string, :name string, :sizeBytes string, :createTime string, :type string, :etag string, :state string, :updateTime string, :reconciling boolean, :satisfiesPzs boolean, :expiryQuantity {:retentionCount integer, :totalRetentionCount integer}, :annotations {}, :expiryTime string, :clusterUid string, :encryptionConfig {:kmsKeyName string}}
Updates the parameters of a single Backup.
https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/backups/patch
Required parameters: name
Optional parameters: updateMask, requestId, validateOnly, allowMissing
Body:
{:description string,
:labels {},
:databaseVersion string,
:clusterName string,
:deleteTime string,
:encryptionInfo {:encryptionType string, :kmsKeyVersions [string]},
:displayName string,
:uid string,
:name string,
:sizeBytes string,
:createTime string,
:type string,
:etag string,
:state string,
:updateTime string,
:reconciling boolean,
:satisfiesPzs boolean,
:expiryQuantity {:retentionCount integer,
:totalRetentionCount integer},
:annotations {},
:expiryTime string,
:clusterUid string,
:encryptionConfig {:kmsKeyName string}}
Updates the parameters of a single Backup.locations-clusters-create$clj
(locations-clusters-create$ auth parameters body)https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/create
Required parameters: parent
Optional parameters: clusterId, requestId, validateOnly
Body:
{:labels {}, :continuousBackupConfig {:enabled boolean, :recoveryWindowDays integer, :encryptionConfig EncryptionConfig}, :databaseVersion string, :initialUser {:user string, :password string}, :deleteTime string, :encryptionInfo {:encryptionType string, :kmsKeyVersions [string]}, :displayName string, :uid string, :name string, :primaryConfig {:secondaryClusterNames [string]}, :continuousBackupInfo {:encryptionInfo EncryptionInfo, :enabledTime string, :schedule [string], :earliestRestorableTime string}, :createTime string, :etag string, :state string, :networkConfig {:network string, :allocatedIpRange string}, :updateTime string, :reconciling boolean, :automatedBackupPolicy {:weeklySchedule WeeklySchedule, :timeBasedRetention TimeBasedRetention, :quantityBasedRetention QuantityBasedRetention, :enabled boolean, :backupWindow string, :encryptionConfig EncryptionConfig, :location string, :labels {}}, :satisfiesPzs boolean, :migrationSource {:hostPort string, :referenceId string, :sourceType string}, :annotations {}, :network string, :sslConfig {:sslMode string, :caSource string}, :secondaryConfig {:primaryClusterName string}, :backupSource {:backupUid string, :backupName string}, :clusterType string, :encryptionConfig {:kmsKeyName string}}
Creates a new Cluster in a given project and location.
https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/create
Required parameters: parent
Optional parameters: clusterId, requestId, validateOnly
Body:
{:labels {},
:continuousBackupConfig {:enabled boolean,
:recoveryWindowDays integer,
:encryptionConfig EncryptionConfig},
:databaseVersion string,
:initialUser {:user string, :password string},
:deleteTime string,
:encryptionInfo {:encryptionType string, :kmsKeyVersions [string]},
:displayName string,
:uid string,
:name string,
:primaryConfig {:secondaryClusterNames [string]},
:continuousBackupInfo {:encryptionInfo EncryptionInfo,
:enabledTime string,
:schedule [string],
:earliestRestorableTime string},
:createTime string,
:etag string,
:state string,
:networkConfig {:network string, :allocatedIpRange string},
:updateTime string,
:reconciling boolean,
:automatedBackupPolicy {:weeklySchedule WeeklySchedule,
:timeBasedRetention TimeBasedRetention,
:quantityBasedRetention QuantityBasedRetention,
:enabled boolean,
:backupWindow string,
:encryptionConfig EncryptionConfig,
:location string,
:labels {}},
:satisfiesPzs boolean,
:migrationSource {:hostPort string,
:referenceId string,
:sourceType string},
:annotations {},
:network string,
:sslConfig {:sslMode string, :caSource string},
:secondaryConfig {:primaryClusterName string},
:backupSource {:backupUid string, :backupName string},
:clusterType string,
:encryptionConfig {:kmsKeyName string}}
Creates a new Cluster in a given project and location.locations-clusters-createsecondary$clj
(locations-clusters-createsecondary$ auth parameters body)https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/createsecondary
Required parameters: parent
Optional parameters: clusterId, requestId, validateOnly
Body:
{:labels {}, :continuousBackupConfig {:enabled boolean, :recoveryWindowDays integer, :encryptionConfig EncryptionConfig}, :databaseVersion string, :initialUser {:user string, :password string}, :deleteTime string, :encryptionInfo {:encryptionType string, :kmsKeyVersions [string]}, :displayName string, :uid string, :name string, :primaryConfig {:secondaryClusterNames [string]}, :continuousBackupInfo {:encryptionInfo EncryptionInfo, :enabledTime string, :schedule [string], :earliestRestorableTime string}, :createTime string, :etag string, :state string, :networkConfig {:network string, :allocatedIpRange string}, :updateTime string, :reconciling boolean, :automatedBackupPolicy {:weeklySchedule WeeklySchedule, :timeBasedRetention TimeBasedRetention, :quantityBasedRetention QuantityBasedRetention, :enabled boolean, :backupWindow string, :encryptionConfig EncryptionConfig, :location string, :labels {}}, :satisfiesPzs boolean, :migrationSource {:hostPort string, :referenceId string, :sourceType string}, :annotations {}, :network string, :sslConfig {:sslMode string, :caSource string}, :secondaryConfig {:primaryClusterName string}, :backupSource {:backupUid string, :backupName string}, :clusterType string, :encryptionConfig {:kmsKeyName string}}
Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.
https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/createsecondary
Required parameters: parent
Optional parameters: clusterId, requestId, validateOnly
Body:
{:labels {},
:continuousBackupConfig {:enabled boolean,
:recoveryWindowDays integer,
:encryptionConfig EncryptionConfig},
:databaseVersion string,
:initialUser {:user string, :password string},
:deleteTime string,
:encryptionInfo {:encryptionType string, :kmsKeyVersions [string]},
:displayName string,
:uid string,
:name string,
:primaryConfig {:secondaryClusterNames [string]},
:continuousBackupInfo {:encryptionInfo EncryptionInfo,
:enabledTime string,
:schedule [string],
:earliestRestorableTime string},
:createTime string,
:etag string,
:state string,
:networkConfig {:network string, :allocatedIpRange string},
:updateTime string,
:reconciling boolean,
:automatedBackupPolicy {:weeklySchedule WeeklySchedule,
:timeBasedRetention TimeBasedRetention,
:quantityBasedRetention QuantityBasedRetention,
:enabled boolean,
:backupWindow string,
:encryptionConfig EncryptionConfig,
:location string,
:labels {}},
:satisfiesPzs boolean,
:migrationSource {:hostPort string,
:referenceId string,
:sourceType string},
:annotations {},
:network string,
:sslConfig {:sslMode string, :caSource string},
:secondaryConfig {:primaryClusterName string},
:backupSource {:backupUid string, :backupName string},
:clusterType string,
:encryptionConfig {:kmsKeyName string}}
Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.locations-clusters-delete$clj
(locations-clusters-delete$ auth parameters)https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/delete
Required parameters: name
Optional parameters: requestId, etag, validateOnly, force
Deletes a single Cluster.
https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/delete Required parameters: name Optional parameters: requestId, etag, validateOnly, force Deletes a single Cluster.
locations-clusters-get$clj
(locations-clusters-get$ auth parameters)https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/get
Required parameters: name
Optional parameters: view
Gets details of a single Cluster.
https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/get Required parameters: name Optional parameters: view Gets details of a single Cluster.
locations-clusters-instances-create$clj
(locations-clusters-instances-create$ auth parameters body)https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/instances/create
Required parameters: parent
Optional parameters: instanceId, requestId, validateOnly
Body:
{:availabilityType string, :labels {}, :databaseFlags {}, :deleteTime string, :clientConnectionConfig {:requireConnectors boolean, :sslConfig SslConfig}, :instanceType string, :displayName string, :uid string, :gceZone string, :name string, :createTime string, :etag string, :state string, :machineConfig {:cpuCount integer}, :networkConfig {:authorizedExternalNetworks [AuthorizedNetwork], :enablePublicIp boolean}, :updateTime string, :reconciling boolean, :readPoolConfig {:nodeCount integer}, :publicIpAddress string, :nodes [{:zoneId string, :id string, :ip string, :state string}], :satisfiesPzs boolean, :annotations {}, :ipAddress string, :queryInsightsConfig {:recordApplicationTags boolean, :recordClientAddress boolean, :queryStringLength integer, :queryPlansPerMinute integer}, :writableNode {:zoneId string, :id string, :ip string, :state string}}
Creates a new Instance in a given project and location.
https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/instances/create
Required parameters: parent
Optional parameters: instanceId, requestId, validateOnly
Body:
{:availabilityType string,
:labels {},
:databaseFlags {},
:deleteTime string,
:clientConnectionConfig {:requireConnectors boolean,
:sslConfig SslConfig},
:instanceType string,
:displayName string,
:uid string,
:gceZone string,
:name string,
:createTime string,
:etag string,
:state string,
:machineConfig {:cpuCount integer},
:networkConfig {:authorizedExternalNetworks [AuthorizedNetwork],
:enablePublicIp boolean},
:updateTime string,
:reconciling boolean,
:readPoolConfig {:nodeCount integer},
:publicIpAddress string,
:nodes [{:zoneId string, :id string, :ip string, :state string}],
:satisfiesPzs boolean,
:annotations {},
:ipAddress string,
:queryInsightsConfig {:recordApplicationTags boolean,
:recordClientAddress boolean,
:queryStringLength integer,
:queryPlansPerMinute integer},
:writableNode {:zoneId string, :id string, :ip string, :state string}}
Creates a new Instance in a given project and location.locations-clusters-instances-createsecondary$clj
(locations-clusters-instances-createsecondary$ auth parameters body)Required parameters: parent
Optional parameters: instanceId, requestId, validateOnly
Body:
{:availabilityType string, :labels {}, :databaseFlags {}, :deleteTime string, :clientConnectionConfig {:requireConnectors boolean, :sslConfig SslConfig}, :instanceType string, :displayName string, :uid string, :gceZone string, :name string, :createTime string, :etag string, :state string, :machineConfig {:cpuCount integer}, :networkConfig {:authorizedExternalNetworks [AuthorizedNetwork], :enablePublicIp boolean}, :updateTime string, :reconciling boolean, :readPoolConfig {:nodeCount integer}, :publicIpAddress string, :nodes [{:zoneId string, :id string, :ip string, :state string}], :satisfiesPzs boolean, :annotations {}, :ipAddress string, :queryInsightsConfig {:recordApplicationTags boolean, :recordClientAddress boolean, :queryStringLength integer, :queryPlansPerMinute integer}, :writableNode {:zoneId string, :id string, :ip string, :state string}}
Creates a new SECONDARY Instance in a given project and location.
https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/instances/createsecondary
Required parameters: parent
Optional parameters: instanceId, requestId, validateOnly
Body:
{:availabilityType string,
:labels {},
:databaseFlags {},
:deleteTime string,
:clientConnectionConfig {:requireConnectors boolean,
:sslConfig SslConfig},
:instanceType string,
:displayName string,
:uid string,
:gceZone string,
:name string,
:createTime string,
:etag string,
:state string,
:machineConfig {:cpuCount integer},
:networkConfig {:authorizedExternalNetworks [AuthorizedNetwork],
:enablePublicIp boolean},
:updateTime string,
:reconciling boolean,
:readPoolConfig {:nodeCount integer},
:publicIpAddress string,
:nodes [{:zoneId string, :id string, :ip string, :state string}],
:satisfiesPzs boolean,
:annotations {},
:ipAddress string,
:queryInsightsConfig {:recordApplicationTags boolean,
:recordClientAddress boolean,
:queryStringLength integer,
:queryPlansPerMinute integer},
:writableNode {:zoneId string, :id string, :ip string, :state string}}
Creates a new SECONDARY Instance in a given project and location.locations-clusters-instances-delete$clj
(locations-clusters-instances-delete$ auth parameters)https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/instances/delete
Required parameters: name
Optional parameters: requestId, etag, validateOnly
Deletes a single Instance.
https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/instances/delete Required parameters: name Optional parameters: requestId, etag, validateOnly Deletes a single Instance.
locations-clusters-instances-failover$clj
(locations-clusters-instances-failover$ auth parameters body)Required parameters: name
Optional parameters: none
Body:
{:requestId string, :validateOnly boolean}
Forces a Failover for a highly available instance. Failover promotes the HA standby instance as the new primary. Imperative only.
https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/instances/failover
Required parameters: name
Optional parameters: none
Body:
{:requestId string, :validateOnly boolean}
Forces a Failover for a highly available instance. Failover promotes the HA standby instance as the new primary. Imperative only.locations-clusters-instances-get$clj
(locations-clusters-instances-get$ auth parameters)https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/instances/get
Required parameters: name
Optional parameters: view
Gets details of a single Instance.
https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/instances/get Required parameters: name Optional parameters: view Gets details of a single Instance.
locations-clusters-instances-getConnectionInfo$clj
(locations-clusters-instances-getConnectionInfo$ auth parameters)Required parameters: parent
Optional parameters: requestId
Get instance metadata used for a connection.
https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/instances/getConnectionInfo Required parameters: parent Optional parameters: requestId Get instance metadata used for a connection.
locations-clusters-instances-injectFault$clj
(locations-clusters-instances-injectFault$ auth parameters body)Required parameters: name
Optional parameters: none
Body:
{:faultType string, :requestId string, :validateOnly boolean}
Injects fault in an instance. Imperative only.
https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/instances/injectFault
Required parameters: name
Optional parameters: none
Body:
{:faultType string, :requestId string, :validateOnly boolean}
Injects fault in an instance. Imperative only.locations-clusters-instances-list$clj
(locations-clusters-instances-list$ auth parameters)https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/instances/list
Required parameters: parent
Optional parameters: pageSize, pageToken, filter, orderBy
Lists Instances in a given project and location.
https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/instances/list Required parameters: parent Optional parameters: pageSize, pageToken, filter, orderBy Lists Instances in a given project and location.
locations-clusters-instances-patch$clj
(locations-clusters-instances-patch$ auth parameters body)https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/instances/patch
Required parameters: name
Optional parameters: updateMask, requestId, validateOnly, allowMissing
Body:
{:availabilityType string, :labels {}, :databaseFlags {}, :deleteTime string, :clientConnectionConfig {:requireConnectors boolean, :sslConfig SslConfig}, :instanceType string, :displayName string, :uid string, :gceZone string, :name string, :createTime string, :etag string, :state string, :machineConfig {:cpuCount integer}, :networkConfig {:authorizedExternalNetworks [AuthorizedNetwork], :enablePublicIp boolean}, :updateTime string, :reconciling boolean, :readPoolConfig {:nodeCount integer}, :publicIpAddress string, :nodes [{:zoneId string, :id string, :ip string, :state string}], :satisfiesPzs boolean, :annotations {}, :ipAddress string, :queryInsightsConfig {:recordApplicationTags boolean, :recordClientAddress boolean, :queryStringLength integer, :queryPlansPerMinute integer}, :writableNode {:zoneId string, :id string, :ip string, :state string}}
Updates the parameters of a single Instance.
https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/instances/patch
Required parameters: name
Optional parameters: updateMask, requestId, validateOnly, allowMissing
Body:
{:availabilityType string,
:labels {},
:databaseFlags {},
:deleteTime string,
:clientConnectionConfig {:requireConnectors boolean,
:sslConfig SslConfig},
:instanceType string,
:displayName string,
:uid string,
:gceZone string,
:name string,
:createTime string,
:etag string,
:state string,
:machineConfig {:cpuCount integer},
:networkConfig {:authorizedExternalNetworks [AuthorizedNetwork],
:enablePublicIp boolean},
:updateTime string,
:reconciling boolean,
:readPoolConfig {:nodeCount integer},
:publicIpAddress string,
:nodes [{:zoneId string, :id string, :ip string, :state string}],
:satisfiesPzs boolean,
:annotations {},
:ipAddress string,
:queryInsightsConfig {:recordApplicationTags boolean,
:recordClientAddress boolean,
:queryStringLength integer,
:queryPlansPerMinute integer},
:writableNode {:zoneId string, :id string, :ip string, :state string}}
Updates the parameters of a single Instance.locations-clusters-instances-restart$clj
(locations-clusters-instances-restart$ auth parameters body)https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/instances/restart
Required parameters: name
Optional parameters: none
Body:
{:requestId string, :validateOnly boolean}
Restart an Instance in a cluster. Imperative only.
https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/instances/restart
Required parameters: name
Optional parameters: none
Body:
{:requestId string, :validateOnly boolean}
Restart an Instance in a cluster. Imperative only.locations-clusters-list$clj
(locations-clusters-list$ auth parameters)https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/list
Required parameters: parent
Optional parameters: pageSize, pageToken, filter, orderBy
Lists Clusters in a given project and location.
https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/list Required parameters: parent Optional parameters: pageSize, pageToken, filter, orderBy Lists Clusters in a given project and location.
locations-clusters-patch$clj
(locations-clusters-patch$ auth parameters body)https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/patch
Required parameters: name
Optional parameters: updateMask, requestId, validateOnly, allowMissing
Body:
{:labels {}, :continuousBackupConfig {:enabled boolean, :recoveryWindowDays integer, :encryptionConfig EncryptionConfig}, :databaseVersion string, :initialUser {:user string, :password string}, :deleteTime string, :encryptionInfo {:encryptionType string, :kmsKeyVersions [string]}, :displayName string, :uid string, :name string, :primaryConfig {:secondaryClusterNames [string]}, :continuousBackupInfo {:encryptionInfo EncryptionInfo, :enabledTime string, :schedule [string], :earliestRestorableTime string}, :createTime string, :etag string, :state string, :networkConfig {:network string, :allocatedIpRange string}, :updateTime string, :reconciling boolean, :automatedBackupPolicy {:weeklySchedule WeeklySchedule, :timeBasedRetention TimeBasedRetention, :quantityBasedRetention QuantityBasedRetention, :enabled boolean, :backupWindow string, :encryptionConfig EncryptionConfig, :location string, :labels {}}, :satisfiesPzs boolean, :migrationSource {:hostPort string, :referenceId string, :sourceType string}, :annotations {}, :network string, :sslConfig {:sslMode string, :caSource string}, :secondaryConfig {:primaryClusterName string}, :backupSource {:backupUid string, :backupName string}, :clusterType string, :encryptionConfig {:kmsKeyName string}}
Updates the parameters of a single Cluster.
https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/patch
Required parameters: name
Optional parameters: updateMask, requestId, validateOnly, allowMissing
Body:
{:labels {},
:continuousBackupConfig {:enabled boolean,
:recoveryWindowDays integer,
:encryptionConfig EncryptionConfig},
:databaseVersion string,
:initialUser {:user string, :password string},
:deleteTime string,
:encryptionInfo {:encryptionType string, :kmsKeyVersions [string]},
:displayName string,
:uid string,
:name string,
:primaryConfig {:secondaryClusterNames [string]},
:continuousBackupInfo {:encryptionInfo EncryptionInfo,
:enabledTime string,
:schedule [string],
:earliestRestorableTime string},
:createTime string,
:etag string,
:state string,
:networkConfig {:network string, :allocatedIpRange string},
:updateTime string,
:reconciling boolean,
:automatedBackupPolicy {:weeklySchedule WeeklySchedule,
:timeBasedRetention TimeBasedRetention,
:quantityBasedRetention QuantityBasedRetention,
:enabled boolean,
:backupWindow string,
:encryptionConfig EncryptionConfig,
:location string,
:labels {}},
:satisfiesPzs boolean,
:migrationSource {:hostPort string,
:referenceId string,
:sourceType string},
:annotations {},
:network string,
:sslConfig {:sslMode string, :caSource string},
:secondaryConfig {:primaryClusterName string},
:backupSource {:backupUid string, :backupName string},
:clusterType string,
:encryptionConfig {:kmsKeyName string}}
Updates the parameters of a single Cluster.locations-clusters-promote$clj
(locations-clusters-promote$ auth parameters body)https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/promote
Required parameters: name
Optional parameters: none
Body:
{:requestId string, :etag string, :validateOnly boolean}
Promotes a SECONDARY cluster. This turns down replication from the PRIMARY cluster and promotes a secondary cluster into its own standalone cluster. Imperative only.
https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/promote
Required parameters: name
Optional parameters: none
Body:
{:requestId string, :etag string, :validateOnly boolean}
Promotes a SECONDARY cluster. This turns down replication from the PRIMARY cluster and promotes a secondary cluster into its own standalone cluster. Imperative only.locations-clusters-restore$clj
(locations-clusters-restore$ auth parameters body)https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/restore
Required parameters: parent
Optional parameters: none
Body:
{:backupSource {:backupUid string, :backupName string}, :continuousBackupSource {:cluster string, :pointInTime string}, :clusterId string, :cluster {:labels {}, :continuousBackupConfig ContinuousBackupConfig, :databaseVersion string, :initialUser UserPassword, :deleteTime string, :encryptionInfo EncryptionInfo, :displayName string, :uid string, :name string, :primaryConfig PrimaryConfig, :continuousBackupInfo ContinuousBackupInfo, :createTime string, :etag string, :state string, :networkConfig NetworkConfig, :updateTime string, :reconciling boolean, :automatedBackupPolicy AutomatedBackupPolicy, :satisfiesPzs boolean, :migrationSource MigrationSource, :annotations {}, :network string, :sslConfig SslConfig, :secondaryConfig SecondaryConfig, :backupSource BackupSource, :clusterType string, :encryptionConfig EncryptionConfig}, :requestId string, :validateOnly boolean}
Creates a new Cluster in a given project and location, with a volume restored from the provided source, either a backup ID or a point-in-time and a source cluster.
https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/restore
Required parameters: parent
Optional parameters: none
Body:
{:backupSource {:backupUid string, :backupName string},
:continuousBackupSource {:cluster string, :pointInTime string},
:clusterId string,
:cluster {:labels {},
:continuousBackupConfig ContinuousBackupConfig,
:databaseVersion string,
:initialUser UserPassword,
:deleteTime string,
:encryptionInfo EncryptionInfo,
:displayName string,
:uid string,
:name string,
:primaryConfig PrimaryConfig,
:continuousBackupInfo ContinuousBackupInfo,
:createTime string,
:etag string,
:state string,
:networkConfig NetworkConfig,
:updateTime string,
:reconciling boolean,
:automatedBackupPolicy AutomatedBackupPolicy,
:satisfiesPzs boolean,
:migrationSource MigrationSource,
:annotations {},
:network string,
:sslConfig SslConfig,
:secondaryConfig SecondaryConfig,
:backupSource BackupSource,
:clusterType string,
:encryptionConfig EncryptionConfig},
:requestId string,
:validateOnly boolean}
Creates a new Cluster in a given project and location, with a volume restored from the provided source, either a backup ID or a point-in-time and a source cluster.locations-clusters-users-create$clj
(locations-clusters-users-create$ auth parameters body)https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/users/create
Required parameters: parent
Optional parameters: userId, requestId, validateOnly
Body:
{:name string, :password string, :databaseRoles [string], :userType string}
Creates a new User in a given project, location, and cluster.
https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/users/create
Required parameters: parent
Optional parameters: userId, requestId, validateOnly
Body:
{:name string,
:password string,
:databaseRoles [string],
:userType string}
Creates a new User in a given project, location, and cluster.locations-clusters-users-delete$clj
(locations-clusters-users-delete$ auth parameters)https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/users/delete
Required parameters: name
Optional parameters: requestId, validateOnly
Deletes a single User.
https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/users/delete Required parameters: name Optional parameters: requestId, validateOnly Deletes a single User.
locations-clusters-users-get$clj
(locations-clusters-users-get$ auth parameters)https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/users/get
Required parameters: name
Optional parameters: none
Gets details of a single User.
https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/users/get Required parameters: name Optional parameters: none Gets details of a single User.
locations-clusters-users-list$clj
(locations-clusters-users-list$ auth parameters)https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/users/list
Required parameters: parent
Optional parameters: pageSize, pageToken, filter, orderBy
Lists Users in a given project and location.
https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/users/list Required parameters: parent Optional parameters: pageSize, pageToken, filter, orderBy Lists Users in a given project and location.
locations-clusters-users-patch$clj
(locations-clusters-users-patch$ auth parameters body)https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/users/patch
Required parameters: name
Optional parameters: updateMask, requestId, validateOnly, allowMissing
Body:
{:name string, :password string, :databaseRoles [string], :userType string}
Updates the parameters of a single User.
https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/clusters/users/patch
Required parameters: name
Optional parameters: updateMask, requestId, validateOnly, allowMissing
Body:
{:name string,
:password string,
:databaseRoles [string],
:userType string}
Updates the parameters of a single User.locations-get$clj
(locations-get$ auth parameters)https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/get
Required parameters: name
Optional parameters: none
Gets information about a location.
https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/get Required parameters: name Optional parameters: none Gets information about a location.
locations-list$clj
(locations-list$ auth parameters)https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/list
Required parameters: name
Optional parameters: filter, pageSize, pageToken
Lists information about the supported locations for this service.
https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/list Required parameters: name Optional parameters: filter, pageSize, pageToken Lists information about the supported locations for this service.
locations-operations-cancel$clj
(locations-operations-cancel$ auth parameters body)https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/operations/cancel
Required parameters: name
Optional parameters: none
Body:
{}
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/operations/cancel
Required parameters: name
Optional parameters: none
Body:
{}
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.locations-operations-delete$clj
(locations-operations-delete$ auth parameters)https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/operations/delete
Required parameters: name
Optional parameters: none
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.
https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/operations/delete Required parameters: name Optional parameters: none Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
locations-operations-get$clj
(locations-operations-get$ auth parameters)https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/operations/get
Required parameters: name
Optional parameters: none
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/operations/get Required parameters: name Optional parameters: none Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
locations-operations-list$clj
(locations-operations-list$ auth parameters)https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/operations/list
Required parameters: name
Optional parameters: filter, pageSize, pageToken
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.
https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/operations/list Required parameters: name Optional parameters: filter, pageSize, pageToken Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
locations-supportedDatabaseFlags-list$clj
(locations-supportedDatabaseFlags-list$ auth parameters)Required parameters: parent
Optional parameters: pageSize, pageToken
Lists SupportedDatabaseFlags for a given project and location.
https://cloud.google.com/alloydb/api/reference/rest/v1/projects/locations/supportedDatabaseFlags/list Required parameters: parent Optional parameters: pageSize, pageToken Lists SupportedDatabaseFlags for a given project and location.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close