Package-level declarations

Types

Link copied to clipboard
data class AbortInfoResponse(val cause: String, val projectsMissingPermission: List<String>, val resourceUri: String)

Details of the final state "abort" and associated resource.

Link copied to clipboard

Wrapper for the App Engine service version attributes.

Link copied to clipboard
data class AppEngineVersionInfoResponse(val displayName: String, val environment: String, val runtime: String, val uri: String)

For display only. Metadata associated with an App Engine version.

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.

Link copied to clipboard

Wrapper for Cloud Function attributes.

Link copied to clipboard
data class CloudFunctionInfoResponse(val displayName: String, val location: String, val uri: String, val versionId: String)

For display only. Metadata associated with a Cloud Function.

Link copied to clipboard

Wrapper for Cloud Run revision attributes.

Link copied to clipboard
data class CloudRunRevisionInfoResponse(val displayName: String, val location: String, val serviceName: String, val serviceUri: String, val uri: String)

For display only. Metadata associated with a Cloud Run revision.

Link copied to clipboard
data class CloudSQLInstanceInfoResponse(val displayName: String, val externalIp: String, val internalIp: String, val networkUri: String, val region: String, val uri: String)

For display only. Metadata associated with a Cloud SQL instance.

Link copied to clipboard
data class DeliverInfoResponse(val resourceUri: String, val target: String)

Details of the final state "deliver" and associated resource.

Link copied to clipboard
data class DropInfoResponse(val cause: String, val resourceUri: String)

Details of the final state "drop" and associated resource.

Link copied to clipboard
data class EdgeLocationResponse(val metropolitanArea: String)

Representation of a network edge location as per https://cloud.google.com/vpc/docs/edge-locations.

Link copied to clipboard
data class EndpointInfoResponse(val destinationIp: String, val destinationNetworkUri: String, val destinationPort: Int, val protocol: String, val sourceAgentUri: String, val sourceIp: String, val sourceNetworkUri: String, val sourcePort: Int)

For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model.

Link copied to clipboard
data class EndpointResponse(val appEngineVersion: AppEngineVersionEndpointResponse, val cloudFunction: CloudFunctionEndpointResponse, val cloudRunRevision: CloudRunRevisionEndpointResponse, val cloudSqlInstance: String, val forwardingRule: String, val forwardingRuleTarget: String, val gkeMasterCluster: String, val instance: String, val ipAddress: String, val loadBalancerId: String, val loadBalancerType: String, val network: String, val networkType: String, val port: Int, val project: String)

Source or destination of the Connectivity Test.

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 FirewallInfoResponse(val action: String, val direction: String, val displayName: String, val firewallRuleType: String, val networkUri: String, val policy: String, val priority: Int, val targetServiceAccounts: List<String>, val targetTags: List<String>, val uri: String)

For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a hierarchical firewall policy rule.

Link copied to clipboard
data class ForwardInfoResponse(val resourceUri: String, val target: String)

Details of the final state "forward" and associated resource.

Link copied to clipboard
data class ForwardingRuleInfoResponse(val displayName: String, val matchedPortRange: String, val matchedProtocol: String, val networkUri: String, val target: String, val uri: String, val vip: String)

For display only. Metadata associated with a Compute Engine forwarding rule.

Link copied to clipboard
data class GetConnectivityTestIamPolicyResult(val auditConfigs: List<AuditConfigResponse>, val bindings: List<BindingResponse>, val etag: String, val version: Int)
Link copied to clipboard
data class GetConnectivityTestResult(val createTime: String, val description: String, val destination: EndpointResponse, val displayName: String, val labels: Map<String, String>, val name: String, val probingDetails: ProbingDetailsResponse, val protocol: String, val reachabilityDetails: ReachabilityDetailsResponse, val relatedProjects: List<String>, val source: EndpointResponse, val updateTime: String)
Link copied to clipboard
data class GKEMasterInfoResponse(val clusterNetworkUri: String, val clusterUri: String, val externalIp: String, val internalIp: String)

For display only. Metadata associated with a Google Kubernetes Engine (GKE) cluster master.

Link copied to clipboard
data class InstanceInfoResponse(val displayName: String, val externalIp: String, val interface: String, val internalIp: String, val networkTags: List<String>, val networkUri: String, val serviceAccount: String, val uri: String)

For display only. Metadata associated with a Compute Engine instance.

Link copied to clipboard
data class LatencyDistributionResponse(val latencyPercentiles: List<LatencyPercentileResponse>)

Describes measured latency distribution.

Link copied to clipboard
data class LatencyPercentileResponse(val latencyMicros: String, val percent: Int)

Latency percentile rank and value.

Link copied to clipboard
data class LoadBalancerBackendResponse(val displayName: String, val healthCheckAllowingFirewallRules: List<String>, val healthCheckBlockingFirewallRules: List<String>, val healthCheckFirewallState: String, val uri: String)

For display only. Metadata associated with a specific load balancer backend.

Link copied to clipboard
data class LoadBalancerInfoResponse(val backendType: String, val backendUri: String, val backends: List<LoadBalancerBackendResponse>, val healthCheckUri: String, val loadBalancerType: String)

For display only. Metadata associated with a load balancer.

Link copied to clipboard
data class NetworkInfoResponse(val displayName: String, val matchedIpRange: String, val uri: String)

For display only. Metadata associated with a Compute Engine network.

Link copied to clipboard
data class ProbingDetailsResponse(val abortCause: String, val destinationEgressLocation: EdgeLocationResponse, val endpointInfo: EndpointInfoResponse, val error: StatusResponse, val probingLatency: LatencyDistributionResponse, val result: String, val sentProbeCount: Int, val successfulProbeCount: Int, val verifyTime: String)

Results of active probing from the last run of the test.

Link copied to clipboard
data class ReachabilityDetailsResponse(val error: StatusResponse, val result: String, val traces: List<TraceResponse>, val verifyTime: String)

Results of the configuration analysis from the last run of the test.

Link copied to clipboard
data class RouteInfoResponse(val destIpRange: String, val destPortRanges: List<String>, val displayName: String, val instanceTags: List<String>, val networkUri: String, val nextHop: String, val nextHopType: String, val priority: Int, val protocols: List<String>, val routeType: String, val srcIpRange: String, val srcPortRanges: List<String>, val uri: String)

For display only. Metadata associated with a Compute Engine route.

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 StepResponse(val abort: AbortInfoResponse, val appEngineVersion: AppEngineVersionInfoResponse, val causesDrop: Boolean, val cloudFunction: CloudFunctionInfoResponse, val cloudRunRevision: CloudRunRevisionInfoResponse, val cloudSqlInstance: CloudSQLInstanceInfoResponse, val deliver: DeliverInfoResponse, val description: String, val drop: DropInfoResponse, val endpoint: EndpointInfoResponse, val firewall: FirewallInfoResponse, val forward: ForwardInfoResponse, val forwardingRule: ForwardingRuleInfoResponse, val gkeMaster: GKEMasterInfoResponse, val instance: InstanceInfoResponse, val loadBalancer: LoadBalancerInfoResponse, val network: NetworkInfoResponse, val project: String, val route: RouteInfoResponse, val state: String, val vpcConnector: VpcConnectorInfoResponse, val vpnGateway: VpnGatewayInfoResponse, val vpnTunnel: VpnTunnelInfoResponse)

A simulated forwarding path is composed of multiple steps. Each step has a well-defined state and an associated configuration.

Link copied to clipboard
data class TraceResponse(val endpointInfo: EndpointInfoResponse, val steps: List<StepResponse>)

Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). `` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) `` @property endpointInfo Derived from the source and destination endpoints definition specified by user request, and validated by the data plane model. If there are multiple traces starting from different source locations, then the endpoint_info may be different between traces. @property steps A trace of a test contains multiple steps from the initial state to the final state (delivered, dropped, forwarded, or aborted). The steps are ordered by the processing sequence within the simulated network state machine. It is critical to preserve the order of the steps and avoid reordering or sorting them.

Link copied to clipboard
data class VpcConnectorInfoResponse(val displayName: String, val location: String, val uri: String)

For display only. Metadata associated with a VPC connector.

Link copied to clipboard
data class VpnGatewayInfoResponse(val displayName: String, val ipAddress: String, val networkUri: String, val region: String, val uri: String, val vpnTunnelUri: String)

For display only. Metadata associated with a Compute Engine VPN gateway.

Link copied to clipboard
data class VpnTunnelInfoResponse(val displayName: String, val networkUri: String, val region: String, val remoteGateway: String, val remoteGatewayIp: String, val routingType: String, val sourceGateway: String, val sourceGatewayIp: String, val uri: String)

For display only. Metadata associated with a Compute Engine VPN tunnel.