Package-level declarations

Types

Link copied to clipboard
data class AuditConfigResponse(val auditLogConfigs: List<AuditLogConfigResponse>, val service: String)

Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": "user:aliya@example.com" } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

Link copied to clipboard
data class AuditLogConfigResponse(val exemptedMembers: List<String>, val logType: String)

Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

Link copied to clipboard
data class AutoscalingLimitsResponse(val maxServeNodes: Int, val minServeNodes: Int)

Limits for the number of nodes a Cluster can autoscale up/down to.

Link copied to clipboard
data class AutoscalingTargetsResponse(val cpuUtilizationPercent: Int, val storageUtilizationGibPerNode: Int)

The Autoscaling targets for a Cluster. These determine the recommended nodes.

Link copied to clipboard
data class BackupInfoResponse(val backup: String, val endTime: String, val sourceBackup: String, val sourceTable: String, val startTime: String)

Information about a backup.

Link copied to clipboard
data class BindingResponse(val condition: ExprResponse, val members: List<String>, val role: String)

Associates members, or principals, with a role.

Link copied to clipboard
data class ClusterAutoscalingConfigResponse(val autoscalingLimits: AutoscalingLimitsResponse, val autoscalingTargets: AutoscalingTargetsResponse)

Autoscaling config for a cluster.

Link copied to clipboard
data class ClusterConfigResponse(val clusterAutoscalingConfig: ClusterAutoscalingConfigResponse)

Configuration for a cluster.

Link copied to clipboard
data class EncryptionConfigResponse(val kmsKeyName: String)

Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster.

Link copied to clipboard
data class EncryptionInfoResponse(val encryptionStatus: StatusResponse, val encryptionType: String, val kmsKeyVersion: String)

Encryption information for a given resource. If this resource is protected with customer managed encryption, the in-use Cloud Key Management Service (Cloud KMS) key version is specified along with its status.

Link copied to clipboard
data class ExprResponse(val description: String, val expression: String, val location: String, val title: String)

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

Link copied to clipboard
data class GetAppProfileResult(val description: String, val etag: String, val multiClusterRoutingUseAny: MultiClusterRoutingUseAnyResponse, val name: String, val singleClusterRouting: SingleClusterRoutingResponse)
Link copied to clipboard
data class GetBackupResult(val encryptionInfo: EncryptionInfoResponse, val endTime: String, val expireTime: String, val name: String, val sizeBytes: String, val sourceBackup: String, val sourceTable: String, val startTime: String, val state: String)
Link copied to clipboard
data class GetClusterResult(val clusterConfig: ClusterConfigResponse, val defaultStorageType: String, val encryptionConfig: EncryptionConfigResponse, val location: String, val name: String, val serveNodes: Int, val state: String)
Link copied to clipboard
data class GetInstanceClusterBackupIamPolicyResult(val auditConfigs: List<AuditConfigResponse>, val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetInstanceIamPolicyResult(val auditConfigs: List<AuditConfigResponse>, val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetInstanceResult(val createTime: String, val displayName: String, val labels: Map<String, String>, val name: String, val satisfiesPzs: Boolean, val state: String, val type: String)
Link copied to clipboard
data class GetInstanceTableIamPolicyResult(val auditConfigs: List<AuditConfigResponse>, val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetTableResult(val clusterStates: Map<String, String>, val columnFamilies: Map<String, String>, val deletionProtection: Boolean, val granularity: String, val name: String, val restoreInfo: RestoreInfoResponse, val stats: TableStatsResponse)
Link copied to clipboard
data class MultiClusterRoutingUseAnyResponse(val clusterIds: List<String>)

Read/write requests are routed to the nearest cluster in the instance, and will fail over to the nearest cluster that is available in the event of transient errors or delays. Clusters in a region are considered equidistant. Choosing this option sacrifices read-your-writes consistency to improve availability.

Link copied to clipboard
data class RestoreInfoResponse(val backupInfo: BackupInfoResponse, val sourceType: String)

Information about a table restore.

Link copied to clipboard
data class SingleClusterRoutingResponse(val allowTransactionalWrites: Boolean, val clusterId: String)

Unconditionally routes all read/write requests to a specific cluster. This option preserves read-your-writes consistency but does not improve availability.

Link copied to clipboard
data class StatusResponse(val code: Int, val details: List<Map<String, String>>, val message: String)

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. 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.

Link copied to clipboard
data class TableStatsResponse(val averageCellsPerColumn: Double, val averageColumnsPerRow: Double, val logicalDataBytes: String, val rowCount: String)

Approximate statistics related to a table. These statistics are calculated infrequently, while simultaneously, data in the table can change rapidly. Thus the values reported here (e.g. row count) are very likely out-of date, even the instant they are received in this API. Thus, only treat these values as approximate. IMPORTANT: Everything below is approximate, unless otherwise specified.