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 BindingResponse(val condition: ExprResponse, val members: List<String>, val role: String)

Associates members, or principals, with a role.

data class EndpointMatcherMetadataLabelMatcherMetadataLabelsResponse(val labelName: String, val labelValue: String)

Defines a name-pair value for a single label.

The matcher that is based on node metadata presented by xDS clients.

Link copied to clipboard

A definition of a matcher that selects endpoints to which the policies should be applied.

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 GetEdgeCacheKeysetIamPolicyResult(val auditConfigs: List<AuditConfigResponse>, val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetEdgeCacheOriginIamPolicyResult(val auditConfigs: List<AuditConfigResponse>, val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetEdgeCacheServiceIamPolicyResult(val auditConfigs: List<AuditConfigResponse>, val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetEndpointPolicyIamPolicyResult(val auditConfigs: List<AuditConfigResponse>, val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetEndpointPolicyResult(val authorizationPolicy: String, val clientTlsPolicy: String, val createTime: String, val description: String, val endpointMatcher: EndpointMatcherResponse, val labels: Map<String, String>, val name: String, val serverTlsPolicy: String, val trafficPortSelector: TrafficPortSelectorResponse, val type: String, val updateTime: String)
Link copied to clipboard
data class GetGatewayIamPolicyResult(val auditConfigs: List<AuditConfigResponse>, val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetGatewayResult(val addresses: List<String>, val certificateUrls: List<String>, val createTime: String, val description: String, val gatewaySecurityPolicy: String, val labels: Map<String, String>, val name: String, val network: String, val ports: List<Int>, val scope: String, val selfLink: String, val serverTlsPolicy: String, val subnetwork: String, val type: String, val updateTime: String)
Link copied to clipboard
data class GetGrpcRouteResult(val createTime: String, val description: String, val gateways: List<String>, val hostnames: List<String>, val labels: Map<String, String>, val meshes: List<String>, val name: String, val rules: List<GrpcRouteRouteRuleResponse>, val selfLink: String, val updateTime: String)
Link copied to clipboard
data class GetHttpRouteResult(val createTime: String, val description: String, val gateways: List<String>, val hostnames: List<String>, val labels: Map<String, String>, val meshes: List<String>, val name: String, val rules: List<HttpRouteRouteRuleResponse>, val selfLink: String, val updateTime: String)
Link copied to clipboard
data class GetMeshIamPolicyResult(val auditConfigs: List<AuditConfigResponse>, val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetMeshResult(val createTime: String, val description: String, val interceptionPort: Int, val labels: Map<String, String>, val name: String, val selfLink: String, val updateTime: String)
Link copied to clipboard
data class GetServiceBindingIamPolicyResult(val auditConfigs: List<AuditConfigResponse>, val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetServiceBindingResult(val createTime: String, val description: String, val labels: Map<String, String>, val name: String, val service: String, val updateTime: String)
Link copied to clipboard
data class GetTcpRouteResult(val createTime: String, val description: String, val gateways: List<String>, val labels: Map<String, String>, val meshes: List<String>, val name: String, val rules: List<TcpRouteRouteRuleResponse>, val selfLink: String, val updateTime: String)
Link copied to clipboard
data class GetTlsRouteResult(val createTime: String, val description: String, val gateways: List<String>, val meshes: List<String>, val name: String, val rules: List<TlsRouteRouteRuleResponse>, val selfLink: String, val updateTime: String)
Link copied to clipboard
data class GrpcRouteDestinationResponse(val serviceName: String, val weight: Int)

The destination to which traffic will be routed.

data class GrpcRouteFaultInjectionPolicyAbortResponse(val httpStatus: Int, val percentage: Int)

Specification of how client requests are aborted as part of fault injection before being sent to a destination.

data class GrpcRouteFaultInjectionPolicyDelayResponse(val fixedDelay: String, val percentage: Int)

Specification of how client requests are delayed as part of fault injection before being sent to a destination.

Link copied to clipboard

The specification for fault injection introduced into traffic to test the resiliency of clients to destination service failure. As part of fault injection, when clients send requests to a destination, delays can be introduced on a percentage of requests before sending those requests to the destination service. Similarly requests from clients can be aborted by for a percentage of requests.

Link copied to clipboard
data class GrpcRouteHeaderMatchResponse(val key: String, val type: String, val value: String)

A match against a collection of headers.

Link copied to clipboard
data class GrpcRouteMethodMatchResponse(val caseSensitive: Boolean, val grpcMethod: String, val grpcService: String, val type: String)

Specifies a match against a method.

Link copied to clipboard
data class GrpcRouteRetryPolicyResponse(val numRetries: Int, val retryConditions: List<String>)

The specifications for retries.

Link copied to clipboard
data class GrpcRouteRouteActionResponse(val destinations: List<GrpcRouteDestinationResponse>, val faultInjectionPolicy: GrpcRouteFaultInjectionPolicyResponse, val retryPolicy: GrpcRouteRetryPolicyResponse, val timeout: String)

Specifies how to route matched traffic.

Link copied to clipboard

Criteria for matching traffic. A RouteMatch will be considered to match when all supplied fields match.

Link copied to clipboard

Describes how to route traffic.

Link copied to clipboard
data class HttpRouteCorsPolicyResponse(val allowCredentials: Boolean, val allowHeaders: List<String>, val allowMethods: List<String>, val allowOriginRegexes: List<String>, val allowOrigins: List<String>, val disabled: Boolean, val exposeHeaders: List<String>, val maxAge: String)

The Specification for allowing client side cross-origin requests.

Link copied to clipboard
data class HttpRouteDestinationResponse(val serviceName: String, val weight: Int)

Specifications of a destination to which the request should be routed to.

data class HttpRouteFaultInjectionPolicyAbortResponse(val httpStatus: Int, val percentage: Int)

Specification of how client requests are aborted as part of fault injection before being sent to a destination.

data class HttpRouteFaultInjectionPolicyDelayResponse(val fixedDelay: String, val percentage: Int)

Specification of how client requests are delayed as part of fault injection before being sent to a destination.

Link copied to clipboard

The specification for fault injection introduced into traffic to test the resiliency of clients to destination service failure. As part of fault injection, when clients send requests to a destination, delays can be introduced by client proxy on a percentage of requests before sending those requests to the destination service. Similarly requests can be aborted by client proxy for a percentage of requests.

Link copied to clipboard
data class HttpRouteHeaderMatchIntegerRangeResponse(val end: Int, val start: Int)

Represents an integer value range.

Link copied to clipboard
data class HttpRouteHeaderMatchResponse(val exactMatch: String, val header: String, val invertMatch: Boolean, val prefixMatch: String, val presentMatch: Boolean, val rangeMatch: HttpRouteHeaderMatchIntegerRangeResponse, val regexMatch: String, val suffixMatch: String)

Specifies how to select a route rule based on HTTP request headers.

Link copied to clipboard
data class HttpRouteHeaderModifierResponse(val add: Map<String, String>, val remove: List<String>, val set: Map<String, String>)

The specification for modifying HTTP header in HTTP request and HTTP response.

Link copied to clipboard
data class HttpRouteQueryParameterMatchResponse(val exactMatch: String, val presentMatch: Boolean, val queryParameter: String, val regexMatch: String)

Specifications to match a query parameter in the request.

Link copied to clipboard
data class HttpRouteRedirectResponse(val hostRedirect: String, val httpsRedirect: Boolean, val pathRedirect: String, val portRedirect: Int, val prefixRewrite: String, val responseCode: String, val stripQuery: Boolean)

The specification for redirecting traffic.

Link copied to clipboard

Specifies the policy on how requests are shadowed to a separate mirrored destination service. The proxy does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host/authority header is suffixed with -shadow.

Link copied to clipboard
data class HttpRouteRetryPolicyResponse(val numRetries: Int, val perTryTimeout: String, val retryConditions: List<String>)

The specifications for retries.

Link copied to clipboard
data class HttpRouteRouteActionResponse(val corsPolicy: HttpRouteCorsPolicyResponse, val destinations: List<HttpRouteDestinationResponse>, val faultInjectionPolicy: HttpRouteFaultInjectionPolicyResponse, val redirect: HttpRouteRedirectResponse, val requestHeaderModifier: HttpRouteHeaderModifierResponse, val requestMirrorPolicy: HttpRouteRequestMirrorPolicyResponse, val responseHeaderModifier: HttpRouteHeaderModifierResponse, val retryPolicy: HttpRouteRetryPolicyResponse, val timeout: String, val urlRewrite: HttpRouteURLRewriteResponse)

The specifications for routing traffic and applying associated policies.

Link copied to clipboard
data class HttpRouteRouteMatchResponse(val fullPathMatch: String, val headers: List<HttpRouteHeaderMatchResponse>, val ignoreCase: Boolean, val prefixMatch: String, val queryParameters: List<HttpRouteQueryParameterMatchResponse>, val regexMatch: String)

RouteMatch defines specifications used to match requests. If multiple match types are set, this RouteMatch will match if ALL type of matches are matched.

Link copied to clipboard

Specifies how to match traffic and how to route traffic when traffic is matched.

Link copied to clipboard
data class HttpRouteURLRewriteResponse(val hostRewrite: String, val pathPrefixRewrite: String)

The specification for modifying the URL of the request, prior to forwarding the request to the destination.

Link copied to clipboard
data class TcpRouteRouteActionResponse(val destinations: List<TcpRouteRouteDestinationResponse>, val originalDestination: Boolean)

The specifications for routing traffic and applying associated policies.

Link copied to clipboard
data class TcpRouteRouteDestinationResponse(val serviceName: String, val weight: Int)

Describe the destination for traffic to be routed to.

Link copied to clipboard
data class TcpRouteRouteMatchResponse(val address: String, val port: String)

RouteMatch defines the predicate used to match requests to a given action. Multiple match types are "OR"ed for evaluation. If no routeMatch field is specified, this rule will unconditionally match traffic.

Link copied to clipboard

Specifies how to match traffic and how to route traffic when traffic is matched.

Link copied to clipboard

The specifications for routing traffic and applying associated policies.

Link copied to clipboard
data class TlsRouteRouteDestinationResponse(val serviceName: String, val weight: Int)

Describe the destination for traffic to be routed to.

Link copied to clipboard
data class TlsRouteRouteMatchResponse(val alpn: List<String>, val sniHost: List<String>)

RouteMatch defines the predicate used to match requests to a given action. Multiple match types are "AND"ed for evaluation. If no routeMatch field is specified, this rule will unconditionally match traffic.

Link copied to clipboard

Specifies how to match traffic and how to route traffic when traffic is matched.

Link copied to clipboard
data class TrafficPortSelectorResponse(val ports: List<String>)

Specification of a port-based selector.