Cloud Bigtable Admin API: projects. Administer your Cloud Bigtable tables and instances. See: https://cloud.google.com/bigtable/api/reference/rest/v2/projects
Cloud Bigtable Admin API: projects. Administer your Cloud Bigtable tables and instances. See: https://cloud.google.com/bigtable/api/reference/rest/v2/projects
(instances-appProfiles-create$ auth parameters body)
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/appProfiles/create
Required parameters: parent
Optional parameters: ignoreWarnings, appProfileId
Body:
{:singleClusterRouting {:allowTransactionalWrites boolean, :clusterId string}, :name string, :etag string, :multiClusterRoutingUseAny {}, :description string}
Creates an app profile within an instance.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/appProfiles/create Required parameters: parent Optional parameters: ignoreWarnings, appProfileId Body: {:singleClusterRouting {:allowTransactionalWrites boolean, :clusterId string}, :name string, :etag string, :multiClusterRoutingUseAny {}, :description string} Creates an app profile within an instance.
(instances-appProfiles-delete$ auth parameters)
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/appProfiles/delete
Required parameters: name
Optional parameters: ignoreWarnings
Deletes an app profile from an instance.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/appProfiles/delete Required parameters: name Optional parameters: ignoreWarnings Deletes an app profile from an instance.
(instances-appProfiles-get$ auth parameters)
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/appProfiles/get
Required parameters: name
Optional parameters: none
Gets information about an app profile.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/appProfiles/get Required parameters: name Optional parameters: none Gets information about an app profile.
(instances-appProfiles-list$ auth parameters)
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/appProfiles/list
Required parameters: parent
Optional parameters: pageSize, pageToken
Lists information about app profiles in an instance.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/appProfiles/list Required parameters: parent Optional parameters: pageSize, pageToken Lists information about app profiles in an instance.
(instances-appProfiles-patch$ auth parameters body)
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/appProfiles/patch
Required parameters: name
Optional parameters: updateMask, ignoreWarnings
Body:
{:singleClusterRouting {:allowTransactionalWrites boolean, :clusterId string}, :name string, :etag string, :multiClusterRoutingUseAny {}, :description string}
Updates an app profile within an instance.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/appProfiles/patch Required parameters: name Optional parameters: updateMask, ignoreWarnings Body: {:singleClusterRouting {:allowTransactionalWrites boolean, :clusterId string}, :name string, :etag string, :multiClusterRoutingUseAny {}, :description string} Updates an app profile within an instance.
(instances-clusters-backups-create$ auth parameters body)
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/clusters/backups/create
Required parameters: parent
Optional parameters: backupId
Body:
{:startTime string, :encryptionInfo {:encryptionType string, :encryptionStatus Status, :kmsKeyVersion string}, :sourceTable string, :state string, :endTime string, :name string, :expireTime string, :sizeBytes string}
Starts creating a new Cloud Bigtable Backup. The returned backup long-running operation can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/clusters/backups/create Required parameters: parent Optional parameters: backupId Body: {:startTime string, :encryptionInfo {:encryptionType string, :encryptionStatus Status, :kmsKeyVersion string}, :sourceTable string, :state string, :endTime string, :name string, :expireTime string, :sizeBytes string} Starts creating a new Cloud Bigtable Backup. The returned backup long-running operation can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup.
(instances-clusters-backups-delete$ auth parameters)
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/clusters/backups/delete
Required parameters: name
Optional parameters: none
Deletes a pending or completed Cloud Bigtable backup.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/clusters/backups/delete Required parameters: name Optional parameters: none Deletes a pending or completed Cloud Bigtable backup.
(instances-clusters-backups-get$ auth parameters)
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/clusters/backups/get
Required parameters: name
Optional parameters: none
Gets metadata on a pending or completed Cloud Bigtable Backup.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/clusters/backups/get Required parameters: name Optional parameters: none Gets metadata on a pending or completed Cloud Bigtable Backup.
(instances-clusters-backups-getIamPolicy$ auth parameters body)
Required parameters: resource
Optional parameters: none
Body:
{:options {:requestedPolicyVersion integer}}
Gets the access control policy for a Table resource. Returns an empty policy if the resource exists but does not have a policy set.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/clusters/backups/getIamPolicy Required parameters: resource Optional parameters: none Body: {:options {:requestedPolicyVersion integer}} Gets the access control policy for a Table resource. Returns an empty policy if the resource exists but does not have a policy set.
(instances-clusters-backups-list$ auth parameters)
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/clusters/backups/list
Required parameters: parent
Optional parameters: pageToken, orderBy, pageSize, filter
Lists Cloud Bigtable backups. Returns both completed and pending backups.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/clusters/backups/list Required parameters: parent Optional parameters: pageToken, orderBy, pageSize, filter Lists Cloud Bigtable backups. Returns both completed and pending backups.
(instances-clusters-backups-patch$ auth parameters body)
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/clusters/backups/patch
Required parameters: name
Optional parameters: updateMask
Body:
{:startTime string, :encryptionInfo {:encryptionType string, :encryptionStatus Status, :kmsKeyVersion string}, :sourceTable string, :state string, :endTime string, :name string, :expireTime string, :sizeBytes string}
Updates a pending or completed Cloud Bigtable Backup.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/clusters/backups/patch Required parameters: name Optional parameters: updateMask Body: {:startTime string, :encryptionInfo {:encryptionType string, :encryptionStatus Status, :kmsKeyVersion string}, :sourceTable string, :state string, :endTime string, :name string, :expireTime string, :sizeBytes string} Updates a pending or completed Cloud Bigtable Backup.
(instances-clusters-backups-setIamPolicy$ auth parameters body)
Required parameters: resource
Optional parameters: none
Body:
{:updateMask string, :policy {:etag string, :auditConfigs [AuditConfig], :bindings [Binding], :version integer}}
Sets the access control policy on a Table resource. Replaces any existing policy.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/clusters/backups/setIamPolicy Required parameters: resource Optional parameters: none Body: {:updateMask string, :policy {:etag string, :auditConfigs [AuditConfig], :bindings [Binding], :version integer}} Sets the access control policy on a Table resource. Replaces any existing policy.
(instances-clusters-backups-testIamPermissions$ auth parameters body)
Required parameters: resource
Optional parameters: none
Body:
{:permissions [string]}
Returns permissions that the caller has on the specified table resource.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/clusters/backups/testIamPermissions Required parameters: resource Optional parameters: none Body: {:permissions [string]} Returns permissions that the caller has on the specified table resource.
(instances-clusters-create$ auth parameters body)
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/clusters/create
Required parameters: parent
Optional parameters: clusterId
Body:
{:name string, :defaultStorageType string, :serveNodes integer, :location string, :state string, :encryptionConfig {:kmsKeyName string}}
Creates a cluster within an instance.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/clusters/create Required parameters: parent Optional parameters: clusterId Body: {:name string, :defaultStorageType string, :serveNodes integer, :location string, :state string, :encryptionConfig {:kmsKeyName string}} Creates a cluster within an instance.
(instances-clusters-delete$ auth parameters)
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/clusters/delete
Required parameters: name
Optional parameters: none
Deletes a cluster from an instance.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/clusters/delete Required parameters: name Optional parameters: none Deletes a cluster from an instance.
(instances-clusters-get$ auth parameters)
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/clusters/get
Required parameters: name
Optional parameters: none
Gets information about a cluster.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/clusters/get Required parameters: name Optional parameters: none Gets information about a cluster.
(instances-clusters-list$ auth parameters)
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/clusters/list
Required parameters: parent
Optional parameters: pageToken
Lists information about clusters in an instance.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/clusters/list Required parameters: parent Optional parameters: pageToken Lists information about clusters in an instance.
(instances-clusters-partialUpdateCluster$ auth parameters body)
Required parameters: name
Optional parameters: updateMask
Body:
{:name string, :defaultStorageType string, :serveNodes integer, :location string, :state string, :encryptionConfig {:kmsKeyName string}}
Partially updates a cluster within a project. This method is the preferred way to update a Cluster.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/clusters/partialUpdateCluster Required parameters: name Optional parameters: updateMask Body: {:name string, :defaultStorageType string, :serveNodes integer, :location string, :state string, :encryptionConfig {:kmsKeyName string}} Partially updates a cluster within a project. This method is the preferred way to update a Cluster.
(instances-clusters-update$ auth parameters body)
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/clusters/update
Required parameters: name
Optional parameters: none
Body:
{:name string, :defaultStorageType string, :serveNodes integer, :location string, :state string, :encryptionConfig {:kmsKeyName string}}
Updates a cluster within an instance. UpdateCluster is deprecated. Please use PartialUpdateCluster instead.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/clusters/update Required parameters: name Optional parameters: none Body: {:name string, :defaultStorageType string, :serveNodes integer, :location string, :state string, :encryptionConfig {:kmsKeyName string}} Updates a cluster within an instance. UpdateCluster is deprecated. Please use PartialUpdateCluster instead.
(instances-create$ auth parameters body)
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/create
Required parameters: parent
Optional parameters: none
Body:
{:instanceId string, :instance {:createTime string, :name string, :state string, :labels {}, :displayName string, :type string}, :parent string, :clusters {}}
Create an instance within a project.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/create Required parameters: parent Optional parameters: none Body: {:instanceId string, :instance {:createTime string, :name string, :state string, :labels {}, :displayName string, :type string}, :parent string, :clusters {}} Create an instance within a project.
(instances-delete$ auth parameters)
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/delete
Required parameters: name
Optional parameters: none
Delete an instance from a project.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/delete Required parameters: name Optional parameters: none Delete an instance from a project.
(instances-get$ auth parameters)
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/get
Required parameters: name
Optional parameters: none
Gets information about an instance.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/get Required parameters: name Optional parameters: none Gets information about an instance.
(instances-getIamPolicy$ auth parameters body)
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/getIamPolicy
Required parameters: resource
Optional parameters: none
Body:
{:options {:requestedPolicyVersion integer}}
Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/getIamPolicy Required parameters: resource Optional parameters: none Body: {:options {:requestedPolicyVersion integer}} Gets the access control policy for an instance resource. Returns an empty policy if an instance exists but does not have a policy set.
(instances-list$ auth parameters)
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/list
Required parameters: parent
Optional parameters: pageToken
Lists information about instances in a project.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/list Required parameters: parent Optional parameters: pageToken Lists information about instances in a project.
(instances-partialUpdateInstance$ auth parameters body)
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/partialUpdateInstance
Required parameters: name
Optional parameters: updateMask
Body:
{:createTime string, :name string, :state string, :labels {}, :displayName string, :type string}
Partially updates an instance within a project. This method can modify all fields of an Instance and is the preferred way to update an Instance.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/partialUpdateInstance Required parameters: name Optional parameters: updateMask Body: {:createTime string, :name string, :state string, :labels {}, :displayName string, :type string} Partially updates an instance within a project. This method can modify all fields of an Instance and is the preferred way to update an Instance.
(instances-setIamPolicy$ auth parameters body)
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/setIamPolicy
Required parameters: resource
Optional parameters: none
Body:
{:updateMask string, :policy {:etag string, :auditConfigs [AuditConfig], :bindings [Binding], :version integer}}
Sets the access control policy on an instance resource. Replaces any existing policy.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/setIamPolicy Required parameters: resource Optional parameters: none Body: {:updateMask string, :policy {:etag string, :auditConfigs [AuditConfig], :bindings [Binding], :version integer}} Sets the access control policy on an instance resource. Replaces any existing policy.
(instances-tables-checkConsistency$ auth parameters body)
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/tables/checkConsistency
Required parameters: name
Optional parameters: none
Body:
{:consistencyToken string}
Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/tables/checkConsistency Required parameters: name Optional parameters: none Body: {:consistencyToken string} Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request.
(instances-tables-create$ auth parameters body)
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/tables/create
Required parameters: parent
Optional parameters: none
Body:
{:table {:granularity string, :columnFamilies {}, :name string, :restoreInfo RestoreInfo, :clusterStates {}}, :tableId string, :initialSplits [{:key string}]}
Creates a new table in the specified instance. The table can be created with a full set of initial column families, specified in the request.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/tables/create Required parameters: parent Optional parameters: none Body: {:table {:granularity string, :columnFamilies {}, :name string, :restoreInfo RestoreInfo, :clusterStates {}}, :tableId string, :initialSplits [{:key string}]} Creates a new table in the specified instance. The table can be created with a full set of initial column families, specified in the request.
(instances-tables-delete$ auth parameters)
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/tables/delete
Required parameters: name
Optional parameters: none
Permanently deletes a specified table and all of its data.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/tables/delete Required parameters: name Optional parameters: none Permanently deletes a specified table and all of its data.
(instances-tables-dropRowRange$ auth parameters body)
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/tables/dropRowRange
Required parameters: name
Optional parameters: none
Body:
{:deleteAllDataFromTable boolean, :rowKeyPrefix string}
Permanently drop/delete a row range from a specified table. The request can specify whether to delete all rows in a table, or only those that match a particular prefix.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/tables/dropRowRange Required parameters: name Optional parameters: none Body: {:deleteAllDataFromTable boolean, :rowKeyPrefix string} Permanently drop/delete a row range from a specified table. The request can specify whether to delete all rows in a table, or only those that match a particular prefix.
(instances-tables-generateConsistencyToken$ auth parameters body)
Required parameters: name
Optional parameters: none
Body:
{}
Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated. The tokens will be available for 90 days.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/tables/generateConsistencyToken Required parameters: name Optional parameters: none Body: {} Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated. The tokens will be available for 90 days.
(instances-tables-get$ auth parameters)
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/tables/get
Required parameters: name
Optional parameters: view
Gets metadata information about the specified table.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/tables/get Required parameters: name Optional parameters: view Gets metadata information about the specified table.
(instances-tables-getIamPolicy$ auth parameters body)
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/tables/getIamPolicy
Required parameters: resource
Optional parameters: none
Body:
{:options {:requestedPolicyVersion integer}}
Gets the access control policy for a Table resource. Returns an empty policy if the resource exists but does not have a policy set.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/tables/getIamPolicy Required parameters: resource Optional parameters: none Body: {:options {:requestedPolicyVersion integer}} Gets the access control policy for a Table resource. Returns an empty policy if the resource exists but does not have a policy set.
(instances-tables-list$ auth parameters)
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/tables/list
Required parameters: parent
Optional parameters: pageSize, view, pageToken
Lists all tables served from a specified instance.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/tables/list Required parameters: parent Optional parameters: pageSize, view, pageToken Lists all tables served from a specified instance.
(instances-tables-modifyColumnFamilies$ auth parameters body)
Required parameters: name
Optional parameters: none
Body:
{:modifications [{:id string, :create ColumnFamily, :drop boolean, :update ColumnFamily}]}
Performs a series of column family modifications on the specified table. Either all or none of the modifications will occur before this method returns, but data requests received prior to that point may see a table where only some modifications have taken effect.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/tables/modifyColumnFamilies Required parameters: name Optional parameters: none Body: {:modifications [{:id string, :create ColumnFamily, :drop boolean, :update ColumnFamily}]} Performs a series of column family modifications on the specified table. Either all or none of the modifications will occur before this method returns, but data requests received prior to that point may see a table where only some modifications have taken effect.
(instances-tables-restore$ auth parameters body)
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/tables/restore
Required parameters: parent
Optional parameters: none
Body:
{:tableId string, :backup string}
Create a new table by restoring from a completed backup. The new table must be in the same project as the instance containing the backup. The returned table long-running operation can be used to track the progress of the operation, and to cancel it. The metadata field type is RestoreTableMetadata. The response type is Table, if successful.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/tables/restore Required parameters: parent Optional parameters: none Body: {:tableId string, :backup string} Create a new table by restoring from a completed backup. The new table must be in the same project as the instance containing the backup. The returned table long-running operation can be used to track the progress of the operation, and to cancel it. The metadata field type is RestoreTableMetadata. The response type is Table, if successful.
(instances-tables-setIamPolicy$ auth parameters body)
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/tables/setIamPolicy
Required parameters: resource
Optional parameters: none
Body:
{:updateMask string, :policy {:etag string, :auditConfigs [AuditConfig], :bindings [Binding], :version integer}}
Sets the access control policy on a Table resource. Replaces any existing policy.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/tables/setIamPolicy Required parameters: resource Optional parameters: none Body: {:updateMask string, :policy {:etag string, :auditConfigs [AuditConfig], :bindings [Binding], :version integer}} Sets the access control policy on a Table resource. Replaces any existing policy.
(instances-tables-testIamPermissions$ auth parameters body)
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/tables/testIamPermissions
Required parameters: resource
Optional parameters: none
Body:
{:permissions [string]}
Returns permissions that the caller has on the specified table resource.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/tables/testIamPermissions Required parameters: resource Optional parameters: none Body: {:permissions [string]} Returns permissions that the caller has on the specified table resource.
(instances-testIamPermissions$ auth parameters body)
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/testIamPermissions
Required parameters: resource
Optional parameters: none
Body:
{:permissions [string]}
Returns permissions that the caller has on the specified instance resource.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/testIamPermissions Required parameters: resource Optional parameters: none Body: {:permissions [string]} Returns permissions that the caller has on the specified instance resource.
(instances-update$ auth parameters body)
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/update
Required parameters: name
Optional parameters: none
Body:
{:createTime string, :name string, :state string, :labels {}, :displayName string, :type string}
Updates an instance within a project. This method updates only the display name and type for an Instance. To update other Instance properties, such as labels, use PartialUpdateInstance.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/instances/update Required parameters: name Optional parameters: none Body: {:createTime string, :name string, :state string, :labels {}, :displayName string, :type string} Updates an instance within a project. This method updates only the display name and type for an Instance. To update other Instance properties, such as labels, use PartialUpdateInstance.
(locations-get$ auth parameters)
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/locations/get
Required parameters: name
Optional parameters: none
Gets information about a location.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/locations/get Required parameters: name Optional parameters: none Gets information about a location.
(locations-list$ auth parameters)
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/locations/list
Required parameters: name
Optional parameters: pageToken, filter, pageSize
Lists information about the supported locations for this service.
https://cloud.google.com/bigtable/api/reference/rest/v2/projects/locations/list Required parameters: name Optional parameters: pageToken, filter, pageSize Lists information about the supported locations for this service.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close