Package types (0.7.0)

API documentation for network_services_v1.types package.

Classes

AuthzExtension

AuthzExtension is a resource that allows traffic forwarding to a callout backend service to make an authorization decision.

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.

CreateLbEdgeExtensionRequest

Message for creating a LbEdgeExtension resource.

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.

DeleteLbEdgeExtensionRequest

Message for deleting a LbEdgeExtension resource.

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.

EndpointMatcher

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

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

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.

EnvoyHeaders

EnvoyHeader configuration for Mesh and Gateway

EventType

The part of the request or response for which the extension is called.

ExtensionChain

A single extension chain wrapper that contains the match conditions and extensions to execute.

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

GatewayRouteView

GatewayRouteView defines view-only resource for Routes to a Gateway

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.

GetLbEdgeExtensionRequest

Message for getting a LbEdgeExtension resource.

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.

HttpRoute

HttpRoute is the resource defining how HTTP traffic should be routed by a Mesh or Gateway resource.

LbEdgeExtension

LbEdgeExtension is a resource that lets the extension service influence the selection of backend services and Cloud CDN cache keys by modifying request headers.

LbRouteExtension

LbRouteExtension is a resource that lets you control where traffic is routed to for a given request.

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.

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.

ListLbEdgeExtensionsRequest

Message for requesting list of LbEdgeExtension resources.

ListLbEdgeExtensionsResponse

Message for response to listing LbEdgeExtension resources.

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.

LoadBalancingScheme

Load balancing schemes supported by the LbTrafficExtension, LbRouteExtension, and LbEdgeExtension resources. For more information, refer to Backend services overview <https://cloud.google.com/load-balancing/docs/backend-service>__.

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

MeshRouteView

MeshRouteView defines view-only resource for Routes to a Mesh

OperationMetadata

Represents the metadata of the long-running operation.

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.

ServiceLbPolicy

ServiceLbPolicy holds global load balancing and traffic distribution configuration that can be applied to a BackendService.

TcpRoute

TcpRoute is the resource defining how TCP traffic should be routed by a Mesh/Gateway resource.

TlsRoute

TlsRoute defines how traffic should be routed based on SNI and other matching L3 attributes.

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.

UpdateLbEdgeExtensionRequest

Message for updating a LbEdgeExtension resource.

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.

WasmPluginVersion

A single immutable version of a WasmPlugin resource. Defines the Wasm module used and optionally its runtime config.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

WasmPluginView

Determines the information that should be returned by the server.

WireFormat

The format of communication supported by the extension.