Package Classes (0.5.22)

Service describing handlers for resources.

Service describing handlers for resources.

A pager for iterating through list_lb_route_extensions requests.

This class thinly wraps an initial ListLbRouteExtensionsResponse object, and provides an __aiter__ method to iterate through its lb_route_extensions field.

If there are more pages, the __aiter__ method will make additional ListLbRouteExtensions requests and continue to iterate through the lb_route_extensions field on the corresponding responses.

All the usual ListLbRouteExtensionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_lb_route_extensions requests.

This class thinly wraps an initial ListLbRouteExtensionsResponse object, and provides an __iter__ method to iterate through its lb_route_extensions field.

If there are more pages, the __iter__ method will make additional ListLbRouteExtensions requests and continue to iterate through the lb_route_extensions field on the corresponding responses.

All the usual ListLbRouteExtensionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_lb_traffic_extensions requests.

This class thinly wraps an initial ListLbTrafficExtensionsResponse object, and provides an __aiter__ method to iterate through its lb_traffic_extensions field.

If there are more pages, the __aiter__ method will make additional ListLbTrafficExtensions requests and continue to iterate through the lb_traffic_extensions field on the corresponding responses.

All the usual ListLbTrafficExtensionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_lb_traffic_extensions requests.

This class thinly wraps an initial ListLbTrafficExtensionsResponse object, and provides an __iter__ method to iterate through its lb_traffic_extensions field.

If there are more pages, the __iter__ method will make additional ListLbTrafficExtensions requests and continue to iterate through the lb_traffic_extensions field on the corresponding responses.

All the usual ListLbTrafficExtensionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Service describing handlers for resources.

Service describing handlers for resources.

A pager for iterating through list_endpoint_policies requests.

This class thinly wraps an initial ListEndpointPoliciesResponse object, and provides an __aiter__ method to iterate through its endpoint_policies field.

If there are more pages, the __aiter__ method will make additional ListEndpointPolicies requests and continue to iterate through the endpoint_policies field on the corresponding responses.

All the usual ListEndpointPoliciesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_endpoint_policies requests.

This class thinly wraps an initial ListEndpointPoliciesResponse object, and provides an __iter__ method to iterate through its endpoint_policies field.

If there are more pages, the __iter__ method will make additional ListEndpointPolicies requests and continue to iterate through the endpoint_policies field on the corresponding responses.

All the usual ListEndpointPoliciesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_gateway_route_views requests.

This class thinly wraps an initial ListGatewayRouteViewsResponse object, and provides an __aiter__ method to iterate through its gateway_route_views field.

If there are more pages, the __aiter__ method will make additional ListGatewayRouteViews requests and continue to iterate through the gateway_route_views field on the corresponding responses.

All the usual ListGatewayRouteViewsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_gateway_route_views requests.

This class thinly wraps an initial ListGatewayRouteViewsResponse object, and provides an __iter__ method to iterate through its gateway_route_views field.

If there are more pages, the __iter__ method will make additional ListGatewayRouteViews requests and continue to iterate through the gateway_route_views field on the corresponding responses.

All the usual ListGatewayRouteViewsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_gateways requests.

This class thinly wraps an initial ListGatewaysResponse object, and provides an __aiter__ method to iterate through its gateways field.

If there are more pages, the __aiter__ method will make additional ListGateways requests and continue to iterate through the gateways field on the corresponding responses.

All the usual ListGatewaysResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_gateways requests.

This class thinly wraps an initial ListGatewaysResponse object, and provides an __iter__ method to iterate through its gateways field.

If there are more pages, the __iter__ method will make additional ListGateways requests and continue to iterate through the gateways field on the corresponding responses.

All the usual ListGatewaysResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_grpc_routes requests.

This class thinly wraps an initial ListGrpcRoutesResponse object, and provides an __aiter__ method to iterate through its grpc_routes field.

If there are more pages, the __aiter__ method will make additional ListGrpcRoutes requests and continue to iterate through the grpc_routes field on the corresponding responses.

All the usual ListGrpcRoutesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_grpc_routes requests.

This class thinly wraps an initial ListGrpcRoutesResponse object, and provides an __iter__ method to iterate through its grpc_routes field.

If there are more pages, the __iter__ method will make additional ListGrpcRoutes requests and continue to iterate through the grpc_routes field on the corresponding responses.

All the usual ListGrpcRoutesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_http_routes requests.

This class thinly wraps an initial ListHttpRoutesResponse object, and provides an __aiter__ method to iterate through its http_routes field.

If there are more pages, the __aiter__ method will make additional ListHttpRoutes requests and continue to iterate through the http_routes field on the corresponding responses.

All the usual ListHttpRoutesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_http_routes requests.

This class thinly wraps an initial ListHttpRoutesResponse object, and provides an __iter__ method to iterate through its http_routes field.

If there are more pages, the __iter__ method will make additional ListHttpRoutes requests and continue to iterate through the http_routes field on the corresponding responses.

All the usual ListHttpRoutesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_mesh_route_views requests.

This class thinly wraps an initial ListMeshRouteViewsResponse object, and provides an __aiter__ method to iterate through its mesh_route_views field.

If there are more pages, the __aiter__ method will make additional ListMeshRouteViews requests and continue to iterate through the mesh_route_views field on the corresponding responses.

All the usual ListMeshRouteViewsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_mesh_route_views requests.

This class thinly wraps an initial ListMeshRouteViewsResponse object, and provides an __iter__ method to iterate through its mesh_route_views field.

If there are more pages, the __iter__ method will make additional ListMeshRouteViews requests and continue to iterate through the mesh_route_views field on the corresponding responses.

All the usual ListMeshRouteViewsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_meshes requests.

This class thinly wraps an initial ListMeshesResponse object, and provides an __aiter__ method to iterate through its meshes field.

If there are more pages, the __aiter__ method will make additional ListMeshes requests and continue to iterate through the meshes field on the corresponding responses.

All the usual ListMeshesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_meshes requests.

This class thinly wraps an initial ListMeshesResponse object, and provides an __iter__ method to iterate through its meshes field.

If there are more pages, the __iter__ method will make additional ListMeshes requests and continue to iterate through the meshes field on the corresponding responses.

All the usual ListMeshesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_service_bindings requests.

This class thinly wraps an initial ListServiceBindingsResponse object, and provides an __aiter__ method to iterate through its service_bindings field.

If there are more pages, the __aiter__ method will make additional ListServiceBindings requests and continue to iterate through the service_bindings field on the corresponding responses.

All the usual ListServiceBindingsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_service_bindings requests.

This class thinly wraps an initial ListServiceBindingsResponse object, and provides an __iter__ method to iterate through its service_bindings field.

If there are more pages, the __iter__ method will make additional ListServiceBindings requests and continue to iterate through the service_bindings field on the corresponding responses.

All the usual ListServiceBindingsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_service_lb_policies requests.

This class thinly wraps an initial ListServiceLbPoliciesResponse object, and provides an __aiter__ method to iterate through its service_lb_policies field.

If there are more pages, the __aiter__ method will make additional ListServiceLbPolicies requests and continue to iterate through the service_lb_policies field on the corresponding responses.

All the usual ListServiceLbPoliciesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_service_lb_policies requests.

This class thinly wraps an initial ListServiceLbPoliciesResponse object, and provides an __iter__ method to iterate through its service_lb_policies field.

If there are more pages, the __iter__ method will make additional ListServiceLbPolicies requests and continue to iterate through the service_lb_policies field on the corresponding responses.

All the usual ListServiceLbPoliciesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_tcp_routes requests.

This class thinly wraps an initial ListTcpRoutesResponse object, and provides an __aiter__ method to iterate through its tcp_routes field.

If there are more pages, the __aiter__ method will make additional ListTcpRoutes requests and continue to iterate through the tcp_routes field on the corresponding responses.

All the usual ListTcpRoutesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_tcp_routes requests.

This class thinly wraps an initial ListTcpRoutesResponse object, and provides an __iter__ method to iterate through its tcp_routes field.

If there are more pages, the __iter__ method will make additional ListTcpRoutes requests and continue to iterate through the tcp_routes field on the corresponding responses.

All the usual ListTcpRoutesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_tls_routes requests.

This class thinly wraps an initial ListTlsRoutesResponse object, and provides an __aiter__ method to iterate through its tls_routes field.

If there are more pages, the __aiter__ method will make additional ListTlsRoutes requests and continue to iterate through the tls_routes field on the corresponding responses.

All the usual ListTlsRoutesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_tls_routes requests.

This class thinly wraps an initial ListTlsRoutesResponse object, and provides an __iter__ method to iterate through its tls_routes field.

If there are more pages, the __iter__ method will make additional ListTlsRoutes requests and continue to iterate through the tls_routes field on the corresponding responses.

All the usual ListTlsRoutesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Request used with the CreateEndpointPolicy method.

Request used by the CreateGateway method.

Request used by the CreateGrpcRoute method.

Request used by the HttpRoute method.

Message for creating a LbRouteExtension resource.

Message for creating a LbTrafficExtension resource.

Request used by the CreateMesh method.

Request used by the ServiceBinding method.

Request used by the ServiceLbPolicy method.

Request used by the TcpRoute method.

Request used by the TlsRoute method.

Request used with the DeleteEndpointPolicy method.

Request used by the DeleteGateway method.

Request used by the DeleteGrpcRoute method.

Request used by the DeleteHttpRoute method.

Message for deleting a LbRouteExtension resource.

Message for deleting a LbTrafficExtension resource.

Request used by the DeleteMesh method.

Request used by the DeleteServiceBinding method.

Request used by the DeleteServiceLbPolicy method.

Request used by the DeleteTcpRoute method.

Request used by the DeleteTlsRoute method.

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

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

Possible criteria values that define logic of how matching is made.

Defines a name-pair value for a single label.

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.

The type of endpoint policy.

The abstract base class for a message.

EnvoyHeader configuration for Mesh and Gateway

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

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

A single extension in the chain to execute for the matching request.

Conditions under which this chain is invoked for a request.

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

The types of IP version for the gateway. Possible values are:

• IPV4
• IPV6

The abstract base class for a message.

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

The type of the customer-managed gateway. Possible values are:

• OPEN_MESH
• SECURE_WEB_GATEWAY

GatewayRouteView defines view-only resource for Routes to a Gateway

Request used with the GetEndpointPolicy method.

Request used by the GetGateway method.

Request used with the GetGatewayRouteView method.

Request used by the GetGrpcRoute method.

Request used by the GetHttpRoute method.

Message for getting a LbRouteExtension resource.

Message for getting a LbTrafficExtension resource.

Request used by the GetMesh method.

Request used with the GetMeshRouteView method.

Request used by the GetServiceBinding method.

Request used by the GetServiceLbPolicy method.

Request used by the GetTcpRoute method.

Request used by the GetTlsRoute method.

GrpcRoute is the resource defining how gRPC traffic routed by a Mesh or Gateway resource is routed.

The destination to which traffic will be routed.

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

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.

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

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

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

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

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

A match against a collection of headers.

The type of match.

The abstract base class for a message.

Specifies a match against a method.

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

The type of the match.

The specifications for retries. Specifies one or more conditions for which this retry rule applies. Valid values are:

Specifies how to route matched traffic.

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

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

Describes how to route traffic.

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 is the resource defining how HTTP traffic should be routed by a Mesh or Gateway resource.

The Specification for allowing client side cross-origin requests.

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

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.

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

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

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

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

Represents an integer value range.

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

The abstract base class for a message.

The abstract base class for a message.

Static HTTP response object to be returned.

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

The abstract base class for a message.

Specifications to match a query parameter in the request.

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

The specification for redirecting traffic.

Supported HTTP response code.

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.

The specifications for retries.

The specifications for routing traffic and applying associated policies.

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

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

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

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.

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

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

The abstract base class for a message.

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.

The abstract base class for a message.

Request used with the ListEndpointPolicies method.

Response returned by the ListEndpointPolicies method.

Request used with the ListGatewayRouteViews method.

Response returned by the ListGatewayRouteViews method.

Request used with the ListGateways method.

Response returned by the ListGateways method.

Request used with the ListGrpcRoutes method.

Response returned by the ListGrpcRoutes method.

Request used with the ListHttpRoutes method.

Response returned by the ListHttpRoutes method.

Message for requesting list of LbRouteExtension resources.

Message for response to listing LbRouteExtension resources.

Message for requesting list of LbTrafficExtension resources.

Message for response to listing LbTrafficExtension resources.

Request used with the ListMeshRouteViews method.

Response returned by the ListMeshRouteViews method.

Request used with the ListMeshes method.

Response returned by the ListMeshes method.

Request used with the ListServiceBindings method.

Response returned by the ListServiceBindings method.

Request used with the ListServiceLbPolicies method.

Response returned by the ListServiceLbPolicies method.

Request used with the ListTcpRoutes method.

Response returned by the ListTcpRoutes method.

Request used with the ListTlsRoutes method.

Response returned by the ListTlsRoutes method.

Load balancing schemes supported by the LbTrafficExtension resource and LbRouteExtension resource. For more information, refer to Choosing a load balancer <https://cloud.google.com/load-balancing/docs/backend-service>__.

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

The abstract base class for a message.

MeshRouteView defines view-only resource for Routes to a Mesh

Represents the metadata of the long-running operation.

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.

The abstract base class for a message.

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

Option to specify if an unhealthy IG/NEG should be considered for global load balancing and traffic routing.

Option to specify health based failover behavior. This is not related to Network load balancer FailoverPolicy.

The abstract base class for a message.

The global load balancing algorithm to be used.

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

The abstract base class for a message.

The specifications for routing traffic and applying associated policies.

Describe the destination for traffic to be routed to.

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.

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

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

The abstract base class for a message.

The specifications for routing traffic and applying associated policies.

Describe the destination for traffic to be routed to.

RouteMatch defines the predicate used to match requests to a given action. Multiple match types are "AND"ed for evaluation.

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

Specification of a port-based selector.

Request used with the UpdateEndpointPolicy method.

Request used by the UpdateGateway method.

Request used by the UpdateGrpcRoute method.

Request used by the UpdateHttpRoute method.

Message for updating a LbRouteExtension resource.

Message for updating a LbTrafficExtension resource.

Request used by the UpdateMesh method.

Request used by the UpdateServiceBinding method.

Request used by the UpdateServiceLbPolicy method.

Request used by the UpdateTcpRoute method.

Request used by the UpdateTlsRoute method.

API documentation for network_services_v1.services.dep_service.pagers module.

API documentation for network_services_v1.services.network_services.pagers module.