Classes
AddressName
Resource name for the Address
resource.
AuthorizationPolicyName
Resource name for the AuthorizationPolicy
resource.
AuthzExtension
AuthzExtension
is a resource that allows traffic forwarding
to a callout backend service to make an authorization decision.
AuthzExtensionName
Resource name for the AuthzExtension
resource.
BackendServiceName
Resource name for the BackendService
resource.
CertificateName
Resource name for the Certificate
resource.
ClientTlsPolicyName
Resource name for the ClientTlsPolicy
resource.
CreateAuthzExtensionRequest
Message for creating a AuthzExtension
resource.
CreateEndpointPolicyRequest
Request used with the CreateEndpointPolicy method.
CreateGatewayRequest
Request used by the CreateGateway method.
CreateGrpcRouteRequest
Request used by the CreateGrpcRoute method.
CreateHttpRouteRequest
Request used by the HttpRoute method.
CreateLbRouteExtensionRequest
Message for creating a LbRouteExtension
resource.
CreateLbTrafficExtensionRequest
Message for creating a LbTrafficExtension
resource.
CreateMeshRequest
Request used by the CreateMesh method.
CreateServiceBindingRequest
Request used by the ServiceBinding method.
CreateServiceLbPolicyRequest
Request used by the ServiceLbPolicy method.
CreateTcpRouteRequest
Request used by the TcpRoute method.
CreateTlsRouteRequest
Request used by the TlsRoute method.
CreateWasmPluginRequest
Request used by the CreateWasmPlugin
method.
CreateWasmPluginVersionRequest
Request used by the CreateWasmPluginVersion
method.
DeleteAuthzExtensionRequest
Message for deleting a AuthzExtension
resource.
DeleteEndpointPolicyRequest
Request used with the DeleteEndpointPolicy method.
DeleteGatewayRequest
Request used by the DeleteGateway method.
DeleteGrpcRouteRequest
Request used by the DeleteGrpcRoute method.
DeleteHttpRouteRequest
Request used by the DeleteHttpRoute method.
DeleteLbRouteExtensionRequest
Message for deleting a LbRouteExtension
resource.
DeleteLbTrafficExtensionRequest
Message for deleting a LbTrafficExtension
resource.
DeleteMeshRequest
Request used by the DeleteMesh method.
DeleteServiceBindingRequest
Request used by the DeleteServiceBinding method.
DeleteServiceLbPolicyRequest
Request used by the DeleteServiceLbPolicy method.
DeleteTcpRouteRequest
Request used by the DeleteTcpRoute method.
DeleteTlsRouteRequest
Request used by the DeleteTlsRoute method.
DeleteWasmPluginRequest
Request used by the DeleteWasmPlugin
method.
DeleteWasmPluginVersionRequest
Request used by the DeleteWasmPluginVersion
method.
DepService
Service describing handlers for resources.
DepService.DepServiceBase
Base class for server-side implementations of DepService
DepService.DepServiceClient
Client for DepService
DepServiceClient
DepService client wrapper, for convenient use.
DepServiceClientBuilder
Builder class for DepServiceClient to provide simple configuration of credentials, endpoint etc.
DepServiceClientImpl
DepService client wrapper implementation, for convenient use.
DepServiceSettings
Settings for DepServiceClient instances.
EndpointMatcher
A definition of a matcher that selects endpoints to which the policies should be applied.
EndpointMatcher.Types
Container for nested types declared in the EndpointMatcher message type.
EndpointMatcher.Types.MetadataLabelMatcher
The matcher that is based on node metadata presented by xDS clients.
EndpointMatcher.Types.MetadataLabelMatcher.Types
Container for nested types declared in the MetadataLabelMatcher message type.
EndpointMatcher.Types.MetadataLabelMatcher.Types.MetadataLabels
Defines a name-pair value for a single label.
EndpointPolicy
EndpointPolicy is a resource that helps apply desired configuration on the endpoints that match specific criteria. For example, this resource can be used to apply "authentication config" an all endpoints that serve on port 8080.
EndpointPolicy.Types
Container for nested types declared in the EndpointPolicy message type.
EndpointPolicyName
Resource name for the EndpointPolicy
resource.
ExtensionChain
A single extension chain wrapper that contains the match conditions and extensions to execute.
ExtensionChain.Types
Container for nested types declared in the ExtensionChain message type.
ExtensionChain.Types.Extension
A single extension in the chain to execute for the matching request.
ExtensionChain.Types.MatchCondition
Conditions under which this chain is invoked for a request.
Gateway
Gateway represents the configuration for a proxy, typically a load balancer. It captures the ip:port over which the services are exposed by the proxy, along with any policy configurations. Routes have reference to to Gateways to dictate how requests should be routed by this Gateway.
Gateway.Types
Container for nested types declared in the Gateway message type.
GatewayName
Resource name for the Gateway
resource.
GatewayRouteView
GatewayRouteView defines view-only resource for Routes to a Gateway
GatewayRouteViewName
Resource name for the GatewayRouteView
resource.
GatewaySecurityPolicyName
Resource name for the GatewaySecurityPolicy
resource.
GetAuthzExtensionRequest
Message for getting a AuthzExtension
resource.
GetEndpointPolicyRequest
Request used with the GetEndpointPolicy method.
GetGatewayRequest
Request used by the GetGateway method.
GetGatewayRouteViewRequest
Request used with the GetGatewayRouteView method.
GetGrpcRouteRequest
Request used by the GetGrpcRoute method.
GetHttpRouteRequest
Request used by the GetHttpRoute method.
GetLbRouteExtensionRequest
Message for getting a LbRouteExtension
resource.
GetLbTrafficExtensionRequest
Message for getting a LbTrafficExtension
resource.
GetMeshRequest
Request used by the GetMesh method.
GetMeshRouteViewRequest
Request used with the GetMeshRouteView method.
GetServiceBindingRequest
Request used by the GetServiceBinding method.
GetServiceLbPolicyRequest
Request used by the GetServiceLbPolicy method.
GetTcpRouteRequest
Request used by the GetTcpRoute method.
GetTlsRouteRequest
Request used by the GetTlsRoute method.
GetWasmPluginRequest
Request used by the GetWasmPlugin
method.
GetWasmPluginVersionRequest
Request used by the GetWasmPluginVersion
method.
GrpcRoute
GrpcRoute is the resource defining how gRPC traffic routed by a Mesh or Gateway resource is routed.
GrpcRoute.Types
Container for nested types declared in the GrpcRoute message type.
GrpcRoute.Types.Destination
The destination to which traffic will be routed.
GrpcRoute.Types.FaultInjectionPolicy
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.
GrpcRoute.Types.FaultInjectionPolicy.Types
Container for nested types declared in the FaultInjectionPolicy message type.
GrpcRoute.Types.FaultInjectionPolicy.Types.Abort
Specification of how client requests are aborted as part of fault injection before being sent to a destination.
GrpcRoute.Types.FaultInjectionPolicy.Types.Delay
Specification of how client requests are delayed as part of fault injection before being sent to a destination.
GrpcRoute.Types.HeaderMatch
A match against a collection of headers.
GrpcRoute.Types.HeaderMatch.Types
Container for nested types declared in the HeaderMatch message type.
GrpcRoute.Types.MethodMatch
Specifies a match against a method.
GrpcRoute.Types.MethodMatch.Types
Container for nested types declared in the MethodMatch message type.
GrpcRoute.Types.RetryPolicy
The specifications for retries. Specifies one or more conditions for which this retry rule applies. Valid values are:
GrpcRoute.Types.RouteAction
Specifies how to route matched traffic.
GrpcRoute.Types.RouteMatch
Criteria for matching traffic. A RouteMatch will be considered to match when all supplied fields match.
GrpcRoute.Types.RouteRule
Describes how to route traffic.
GrpcRoute.Types.StatefulSessionAffinityPolicy
The specification for cookie-based stateful session affinity where the date plane supplies a “session cookie” with the name "GSSA" which encodes a specific destination host and each request containing that cookie will be directed to that host as long as the destination host remains up and healthy.
The gRPC proxyless mesh library or sidecar proxy will manage the session cookie but the client application code is responsible for copying the cookie from each RPC in the session to the next.
GrpcRouteName
Resource name for the GrpcRoute
resource.
HttpRoute
HttpRoute is the resource defining how HTTP traffic should be routed by a Mesh or Gateway resource.
HttpRoute.Types
Container for nested types declared in the HttpRoute message type.
HttpRoute.Types.CorsPolicy
The Specification for allowing client side cross-origin requests.
HttpRoute.Types.Destination
Specifications of a destination to which the request should be routed to.
HttpRoute.Types.FaultInjectionPolicy
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.
HttpRoute.Types.FaultInjectionPolicy.Types
Container for nested types declared in the FaultInjectionPolicy message type.
HttpRoute.Types.FaultInjectionPolicy.Types.Abort
Specification of how client requests are aborted as part of fault injection before being sent to a destination.
HttpRoute.Types.FaultInjectionPolicy.Types.Delay
Specification of how client requests are delayed as part of fault injection before being sent to a destination.
HttpRoute.Types.HeaderMatch
Specifies how to select a route rule based on HTTP request headers.
HttpRoute.Types.HeaderMatch.Types
Container for nested types declared in the HeaderMatch message type.
HttpRoute.Types.HeaderMatch.Types.IntegerRange
Represents an integer value range.
HttpRoute.Types.HeaderModifier
The specification for modifying HTTP header in HTTP request and HTTP response.
HttpRoute.Types.HttpDirectResponse
Static HTTP response object to be returned.
HttpRoute.Types.QueryParameterMatch
Specifications to match a query parameter in the request.
HttpRoute.Types.Redirect
The specification for redirecting traffic.
HttpRoute.Types.Redirect.Types
Container for nested types declared in the Redirect message type.
HttpRoute.Types.RequestMirrorPolicy
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. Mirroring is currently not supported for Cloud Run destinations.
HttpRoute.Types.RetryPolicy
The specifications for retries.
HttpRoute.Types.RouteAction
The specifications for routing traffic and applying associated policies.
HttpRoute.Types.RouteMatch
RouteMatch defines specifications used to match requests. If multiple match types are set, this RouteMatch will match if ALL type of matches are matched.
HttpRoute.Types.RouteRule
Specifies how to match traffic and how to route traffic when traffic is matched.
HttpRoute.Types.StatefulSessionAffinityPolicy
The specification for cookie-based stateful session affinity where the date plane supplies a “session cookie” with the name "GSSA" which encodes a specific destination host and each request containing that cookie will be directed to that host as long as the destination host remains up and healthy.
The gRPC proxyless mesh library or sidecar proxy will manage the session cookie but the client application code is responsible for copying the cookie from each RPC in the session to the next.
HttpRoute.Types.URLRewrite
The specification for modifying the URL of the request, prior to forwarding the request to the destination.
HttpRouteName
Resource name for the HttpRoute
resource.
LbRouteExtension
LbRouteExtension
is a resource that lets you control where traffic is
routed to for a given request.
LbRouteExtensionName
Resource name for the LbRouteExtension
resource.
LbTrafficExtension
LbTrafficExtension
is a resource that lets the extension service modify the
headers and payloads of both requests and responses without impacting the
choice of backend services or any other security policies associated with the
backend service.
LbTrafficExtensionName
Resource name for the LbTrafficExtension
resource.
ListAuthzExtensionsRequest
Message for requesting list of AuthzExtension
resources.
ListAuthzExtensionsResponse
Message for response to listing AuthzExtension
resources.
ListEndpointPoliciesRequest
Request used with the ListEndpointPolicies method.
ListEndpointPoliciesResponse
Response returned by the ListEndpointPolicies method.
ListGatewayRouteViewsRequest
Request used with the ListGatewayRouteViews method.
ListGatewayRouteViewsResponse
Response returned by the ListGatewayRouteViews method.
ListGatewaysRequest
Request used with the ListGateways method.
ListGatewaysResponse
Response returned by the ListGateways method.
ListGrpcRoutesRequest
Request used with the ListGrpcRoutes method.
ListGrpcRoutesResponse
Response returned by the ListGrpcRoutes method.
ListHttpRoutesRequest
Request used with the ListHttpRoutes method.
ListHttpRoutesResponse
Response returned by the ListHttpRoutes method.
ListLbRouteExtensionsRequest
Message for requesting list of LbRouteExtension
resources.
ListLbRouteExtensionsResponse
Message for response to listing LbRouteExtension
resources.
ListLbTrafficExtensionsRequest
Message for requesting list of LbTrafficExtension
resources.
ListLbTrafficExtensionsResponse
Message for response to listing LbTrafficExtension
resources.
ListMeshRouteViewsRequest
Request used with the ListMeshRouteViews method.
ListMeshRouteViewsResponse
Response returned by the ListMeshRouteViews method.
ListMeshesRequest
Request used with the ListMeshes method.
ListMeshesResponse
Response returned by the ListMeshes method.
ListServiceBindingsRequest
Request used with the ListServiceBindings method.
ListServiceBindingsResponse
Response returned by the ListServiceBindings method.
ListServiceLbPoliciesRequest
Request used with the ListServiceLbPolicies method.
ListServiceLbPoliciesResponse
Response returned by the ListServiceLbPolicies method.
ListTcpRoutesRequest
Request used with the ListTcpRoutes method.
ListTcpRoutesResponse
Response returned by the ListTcpRoutes method.
ListTlsRoutesRequest
Request used with the ListTlsRoutes method.
ListTlsRoutesResponse
Response returned by the ListTlsRoutes method.
ListWasmPluginVersionsRequest
Request used with the ListWasmPluginVersions
method.
ListWasmPluginVersionsResponse
Response returned by the ListWasmPluginVersions
method.
ListWasmPluginsRequest
Request used with the ListWasmPlugins
method.
ListWasmPluginsResponse
Response returned by the ListWasmPlugins
method.
Mesh
Mesh represents a logical configuration grouping for workload to workload communication within a service mesh. Routes that point to mesh dictate how requests are routed within this logical mesh boundary.
MeshName
Resource name for the Mesh
resource.
MeshRouteView
MeshRouteView defines view-only resource for Routes to a Mesh
MeshRouteViewName
Resource name for the MeshRouteView
resource.
NetworkName
Resource name for the Network
resource.
NetworkServices
Service describing handlers for resources.
NetworkServices.NetworkServicesBase
Base class for server-side implementations of NetworkServices
NetworkServices.NetworkServicesClient
Client for NetworkServices
NetworkServicesClient
NetworkServices client wrapper, for convenient use.
NetworkServicesClientBuilder
Builder class for NetworkServicesClient to provide simple configuration of credentials, endpoint etc.
NetworkServicesClientImpl
NetworkServices client wrapper implementation, for convenient use.
NetworkServicesSettings
Settings for NetworkServicesClient instances.
OperationMetadata
Represents the metadata of the long-running operation.
ServerTlsPolicyName
Resource name for the ServerTlsPolicy
resource.
ServiceAttachmentName
Resource name for the ServiceAttachment
resource.
ServiceBinding
ServiceBinding can be used to:
- Bind a Service Directory Service to be used in a BackendService resource. This feature will be deprecated soon.
- Bind a Private Service Connect producer service to be used in consumer Cloud Service Mesh or Application Load Balancers.
- Bind a Cloud Run service to be used in consumer Cloud Service Mesh or Application Load Balancers.
ServiceBindingName
Resource name for the ServiceBinding
resource.
ServiceLbPolicy
ServiceLbPolicy holds global load balancing and traffic distribution configuration that can be applied to a BackendService.
ServiceLbPolicy.Types
Container for nested types declared in the ServiceLbPolicy message type.
ServiceLbPolicy.Types.AutoCapacityDrain
Option to specify if an unhealthy IG/NEG should be considered for global load balancing and traffic routing.
ServiceLbPolicy.Types.FailoverConfig
Option to specify health based failover behavior. This is not related to Network load balancer FailoverPolicy.
ServiceLbPolicyName
Resource name for the ServiceLbPolicy
resource.
ServiceName
Resource name for the Service
resource.
SubnetworkName
Resource name for the Subnetwork
resource.
TcpRoute
TcpRoute is the resource defining how TCP traffic should be routed by a Mesh/Gateway resource.
TcpRoute.Types
Container for nested types declared in the TcpRoute message type.
TcpRoute.Types.RouteAction
The specifications for routing traffic and applying associated policies.
TcpRoute.Types.RouteDestination
Describe the destination for traffic to be routed to.
TcpRoute.Types.RouteMatch
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.
TcpRoute.Types.RouteRule
Specifies how to match traffic and how to route traffic when traffic is matched.
TcpRouteName
Resource name for the TcpRoute
resource.
TlsRoute
TlsRoute defines how traffic should be routed based on SNI and other matching L3 attributes.
TlsRoute.Types
Container for nested types declared in the TlsRoute message type.
TlsRoute.Types.RouteAction
The specifications for routing traffic and applying associated policies.
TlsRoute.Types.RouteDestination
Describe the destination for traffic to be routed to.
TlsRoute.Types.RouteMatch
RouteMatch defines the predicate used to match requests to a given action. Multiple match types are "AND"ed for evaluation.
TlsRoute.Types.RouteRule
Specifies how to match traffic and how to route traffic when traffic is matched.
TlsRouteName
Resource name for the TlsRoute
resource.
TrafficPortSelector
Specification of a port-based selector.
UpdateAuthzExtensionRequest
Message for updating a AuthzExtension
resource.
UpdateEndpointPolicyRequest
Request used with the UpdateEndpointPolicy method.
UpdateGatewayRequest
Request used by the UpdateGateway method.
UpdateGrpcRouteRequest
Request used by the UpdateGrpcRoute method.
UpdateHttpRouteRequest
Request used by the UpdateHttpRoute method.
UpdateLbRouteExtensionRequest
Message for updating a LbRouteExtension
resource.
UpdateLbTrafficExtensionRequest
Message for updating a LbTrafficExtension
resource.
UpdateMeshRequest
Request used by the UpdateMesh method.
UpdateServiceBindingRequest
Request used by the UpdateServiceBinding method.
UpdateServiceLbPolicyRequest
Request used by the UpdateServiceLbPolicy method.
UpdateTcpRouteRequest
Request used by the UpdateTcpRoute method.
UpdateTlsRouteRequest
Request used by the UpdateTlsRoute method.
UpdateWasmPluginRequest
Request used by the UpdateWasmPlugin
method.
WasmPlugin
WasmPlugin
is a resource representing a service executing
a customer-provided Wasm module.
WasmPlugin.Types
Container for nested types declared in the WasmPlugin message type.
WasmPlugin.Types.LogConfig
Specifies the logging options for the activity performed by this plugin. If logging is enabled, plugin logs are exported to Cloud Logging.
WasmPlugin.Types.LogConfig.Types
Container for nested types declared in the LogConfig message type.
WasmPlugin.Types.UsedBy
Defines a resource that uses the WasmPlugin
resource.
WasmPlugin.Types.VersionDetails
Details of a WasmPluginVersion
resource to be inlined in the
WasmPlugin
resource.
WasmPluginName
Resource name for the WasmPlugin
resource.
WasmPluginVersion
A single immutable version of a WasmPlugin
resource.
Defines the Wasm module used and optionally its runtime config.
WasmPluginVersionName
Resource name for the WasmPluginVersion
resource.
Enums
AddressName.ResourceNameType
The possible contents of AddressName.
AuthorizationPolicyName.ResourceNameType
The possible contents of AuthorizationPolicyName.
AuthzExtensionName.ResourceNameType
The possible contents of AuthzExtensionName.
BackendServiceName.ResourceNameType
The possible contents of BackendServiceName.
CertificateName.ResourceNameType
The possible contents of CertificateName.
ClientTlsPolicyName.ResourceNameType
The possible contents of ClientTlsPolicyName.
EndpointMatcher.MatcherTypeOneofCase
Enum of possible cases for the "matcher_type" oneof.
EndpointMatcher.Types.MetadataLabelMatcher.Types.MetadataLabelMatchCriteria
Possible criteria values that define logic of how matching is made.
EndpointPolicy.Types.EndpointPolicyType
The type of endpoint policy.
EndpointPolicyName.ResourceNameType
The possible contents of EndpointPolicyName.
EnvoyHeaders
EnvoyHeader configuration for Mesh and Gateway
EventType
The part of the request or response for which the extension is called.
Gateway.Types.IpVersion
The types of IP version for the gateway. Possible values are:
- IPV4
- IPV6
Gateway.Types.RoutingMode
The routing mode of the Gateway, to determine how the Gateway routes traffic. Today, this field only applies to Gateways of type SECURE_WEB_GATEWAY. Possible values are:
- EXPLICIT_ROUTING_MODE
- NEXT_HOP_ROUTING_MODE
Gateway.Types.Type
The type of the customer-managed gateway. Possible values are:
- OPEN_MESH
- SECURE_WEB_GATEWAY
GatewayName.ResourceNameType
The possible contents of GatewayName.
GatewayRouteViewName.ResourceNameType
The possible contents of GatewayRouteViewName.
GatewaySecurityPolicyName.ResourceNameType
The possible contents of GatewaySecurityPolicyName.
GrpcRoute.Types.Destination.DestinationTypeOneofCase
Enum of possible cases for the "destination_type" oneof.
GrpcRoute.Types.HeaderMatch.Types.Type
The type of match.
GrpcRoute.Types.MethodMatch.Types.Type
The type of the match.
GrpcRouteName.ResourceNameType
The possible contents of GrpcRouteName.
HttpRoute.Types.HeaderMatch.MatchTypeOneofCase
Enum of possible cases for the "MatchType" oneof.
HttpRoute.Types.HttpDirectResponse.HttpBodyOneofCase
Enum of possible cases for the "HttpBody" oneof.
HttpRoute.Types.QueryParameterMatch.MatchTypeOneofCase
Enum of possible cases for the "MatchType" oneof.
HttpRoute.Types.Redirect.Types.ResponseCode
Supported HTTP response code.
HttpRoute.Types.RouteMatch.PathMatchOneofCase
Enum of possible cases for the "PathMatch" oneof.
HttpRouteName.ResourceNameType
The possible contents of HttpRouteName.
LbRouteExtensionName.ResourceNameType
The possible contents of LbRouteExtensionName.
LbTrafficExtensionName.ResourceNameType
The possible contents of LbTrafficExtensionName.
LoadBalancingScheme
Load balancing schemes supported by the LbTrafficExtension
,
LbRouteExtension
, and LbEdgeExtension
resources.
For more information, refer to Backend services
overview.
MeshName.ResourceNameType
The possible contents of MeshName.
MeshRouteViewName.ResourceNameType
The possible contents of MeshRouteViewName.
NetworkName.ResourceNameType
The possible contents of NetworkName.
ServerTlsPolicyName.ResourceNameType
The possible contents of ServerTlsPolicyName.
ServiceAttachmentName.ResourceNameType
The possible contents of ServiceAttachmentName.
ServiceBindingName.ResourceNameType
The possible contents of ServiceBindingName.
ServiceLbPolicy.Types.LoadBalancingAlgorithm
The global load balancing algorithm to be used.
ServiceLbPolicyName.ResourceNameType
The possible contents of ServiceLbPolicyName.
ServiceName.ResourceNameType
The possible contents of ServiceName.
SubnetworkName.ResourceNameType
The possible contents of SubnetworkName.
TcpRouteName.ResourceNameType
The possible contents of TcpRouteName.
TlsRouteName.ResourceNameType
The possible contents of TlsRouteName.
WasmPlugin.Types.LogConfig.Types.LogLevel
Possible values to specify the lowest level of logs to be exported to Cloud Logging.
WasmPlugin.Types.VersionDetails.PluginConfigSourceOneofCase
Enum of possible cases for the "plugin_config_source" oneof.
WasmPluginName.ResourceNameType
The possible contents of WasmPluginName.
WasmPluginVersion.PluginConfigSourceOneofCase
Enum of possible cases for the "plugin_config_source" oneof.
WasmPluginVersionName.ResourceNameType
The possible contents of WasmPluginVersionName.
WasmPluginView
Determines the information that should be returned by the server.
WireFormat
The format of communication supported by the extension.