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 AuthConfigResponse(val additionalVariables: List<ConfigVariableResponse>, val authKey: String, val authType: String, val oauth2AuthCodeFlow: Oauth2AuthCodeFlowResponse, val oauth2ClientCredentials: Oauth2ClientCredentialsResponse, val oauth2JwtBearer: Oauth2JwtBearerResponse, val sshPublicKey: SshPublicKeyResponse, val userPassword: UserPasswordResponse)

AuthConfig defines details of a authentication type.

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 ConfigVariableResponse(val boolValue: Boolean, val intValue: String, val key: String, val secretValue: SecretResponse, val stringValue: String)

ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.

Link copied to clipboard
data class ConnectionStatusResponse(val description: String, val state: String, val status: String)

ConnectionStatus indicates the state of the connection.

Link copied to clipboard
data class ConnectorsLogConfigResponse(val enabled: Boolean)

Log configuration for the connection.

Link copied to clipboard
data class DestinationConfigResponse(val destinations: List<DestinationResponse>, val key: String)

Define the Connectors target endpoint.

Link copied to clipboard
data class DestinationResponse(val host: String, val port: Int, val serviceAttachment: String)
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 GetConnectionIamPolicyResult(val auditConfigs: List<AuditConfigResponse>, val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetConnectionResult(val authConfig: AuthConfigResponse, val configVariables: List<ConfigVariableResponse>, val connectorVersion: String, val createTime: String, val description: String, val destinationConfigs: List<DestinationConfigResponse>, val envoyImageLocation: String, val imageLocation: String, val labels: Map<String, String>, val lockConfig: LockConfigResponse, val logConfig: ConnectorsLogConfigResponse, val name: String, val nodeConfig: NodeConfigResponse, val serviceAccount: String, val serviceDirectory: String, val sslConfig: SslConfigResponse, val status: ConnectionStatusResponse, val subscriptionType: String, val suspended: Boolean, val updateTime: String)
Link copied to clipboard
data class GetEndpointAttachmentResult(val createTime: String, val description: String, val endpointIp: String, val labels: Map<String, String>, val name: String, val serviceAttachment: String, val updateTime: String)
Link copied to clipboard
data class GetManagedZoneResult(val createTime: String, val description: String, val dns: String, val labels: Map<String, String>, val name: String, val targetProject: String, val targetVpc: String, val updateTime: String)
Link copied to clipboard
data class GetProviderIamPolicyResult(val auditConfigs: List<AuditConfigResponse>, val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class JwtClaimsResponse(val audience: String, val issuer: String, val subject: String)

JWT claims used for the jwt-bearer authorization grant.

Link copied to clipboard
data class LockConfigResponse(val locked: Boolean, val reason: String)

Determines whether or no a connection is locked. If locked, a reason must be specified.

Link copied to clipboard
data class NodeConfigResponse(val maxNodeCount: Int, val minNodeCount: Int)

Node configuration for the connection.

Link copied to clipboard
data class Oauth2AuthCodeFlowResponse(val authCode: String, val clientId: String, val clientSecret: SecretResponse, val enablePkce: Boolean, val pkceVerifier: String, val redirectUri: String, val scopes: List<String>)

Parameters to support Oauth 2.0 Auth Code Grant Authentication. See https://www.rfc-editor.org/rfc/rfc6749#section-1.3.1 for more details.

Link copied to clipboard
data class Oauth2ClientCredentialsResponse(val clientId: String, val clientSecret: SecretResponse)

Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details.

Link copied to clipboard
data class Oauth2JwtBearerResponse(val clientKey: SecretResponse, val jwtClaims: JwtClaimsResponse)

Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication. See https://tools.ietf.org/html/rfc7523 for more details.

Link copied to clipboard
data class SecretResponse(val secretVersion: String)

Secret provides a reference to entries in Secret Manager.

Link copied to clipboard
data class SshPublicKeyResponse(val certType: String, val sshClientCert: SecretResponse, val sshClientCertPass: SecretResponse, val username: String)

Parameters to support Ssh public key Authentication.

Link copied to clipboard
data class SslConfigResponse(val additionalVariables: List<ConfigVariableResponse>, val clientCertType: String, val clientCertificate: SecretResponse, val clientPrivateKey: SecretResponse, val clientPrivateKeyPass: SecretResponse, val privateServerCertificate: SecretResponse, val serverCertType: String, val trustModel: String, val type: String, val useSsl: Boolean)

SSL Configuration of a connection

Link copied to clipboard
data class UserPasswordResponse(val password: SecretResponse, val username: String)

Parameters to support Username and Password Authentication.