Package Classes (0.5.15)

Summary of entries of Classes for networkservices.

Classes

DepServiceAsyncClient

Service describing handlers for resources.

DepServiceClient

Service describing handlers for resources.

ListLbRouteExtensionsAsyncPager

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.

ListLbRouteExtensionsPager

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.

ListLbTrafficExtensionsAsyncPager

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.

ListLbTrafficExtensionsPager

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.

NetworkServicesAsyncClient

Service describing handlers for resources.

NetworkServicesClient

Service describing handlers for resources.

ListEndpointPoliciesAsyncPager

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.

ListEndpointPoliciesPager

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.

ListGatewaysAsyncPager

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.

ListGatewaysPager

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.

ListGrpcRoutesAsyncPager

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.

ListGrpcRoutesPager

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.

ListHttpRoutesAsyncPager

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.

ListHttpRoutesPager

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.

ListMeshesAsyncPager

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.

ListMeshesPager

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.

ListServiceBindingsAsyncPager

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.

ListServiceBindingsPager

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.

ListTcpRoutesAsyncPager

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.

ListTcpRoutesPager

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.

ListTlsRoutesAsyncPager

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.

ListTlsRoutesPager

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.

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.

CreateTcpRouteRequest

Request used by the TcpRoute method.

CreateTlsRouteRequest

Request used by the TlsRoute method.

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.

DeleteTcpRouteRequest

Request used by the DeleteTcpRoute method.

DeleteTlsRouteRequest

Request used by the DeleteTlsRoute 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

MetadataLabelMatcher

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

MetadataLabelMatchCriteria

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

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.

EndpointPolicyType

The type of endpoint policy.

LabelsEntry

The abstract base class for a message.

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.

Extension

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

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.

LabelsEntry

The abstract base class for a message.

Type

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

  • OPEN_MESH
  • SECURE_WEB_GATEWAY

GetEndpointPolicyRequest

Request used with the GetEndpointPolicy method.

GetGatewayRequest

Request used by the GetGateway 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.

GetServiceBindingRequest

Request used by the GetServiceBinding method.

GetTcpRouteRequest

Request used by the GetTcpRoute method.

GetTlsRouteRequest

Request used by the GetTlsRoute method.

GrpcRoute

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

Destination

The destination to which traffic will be routed.

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

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.

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

Abort

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

Delay

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

HeaderMatch

A match against a collection of headers.

Type

The type of match.

LabelsEntry

The abstract base class for a message.

MethodMatch

Specifies a match against a method.

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

Type

The type of the match.

RetryPolicy

The specifications for retries.

RouteAction

Specifies how to route matched traffic.

RouteMatch

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

RouteRule

Describes how to route traffic.

HttpRoute

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

CorsPolicy

The Specification for allowing client side cross-origin requests.

Destination

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

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.

Abort

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

Delay

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

HeaderMatch

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

IntegerRange

Represents an integer value range.

HeaderModifier

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

AddEntry

The abstract base class for a message.

SetEntry

The abstract base class for a message.

LabelsEntry

The abstract base class for a message.

QueryParameterMatch

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

Redirect

The specification for redirecting traffic.

ResponseCode

Supported HTTP response code.

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.

RetryPolicy

The specifications for retries.

RouteAction

The specifications for routing traffic and applying associated policies.

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.

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

RouteRule

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

URLRewrite

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

LbRouteExtension

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

LabelsEntry

The abstract base class for a message.

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.

LabelsEntry

The abstract base class for a message.

ListEndpointPoliciesRequest

Request used with the ListEndpointPolicies method.

ListEndpointPoliciesResponse

Response returned by the ListEndpointPolicies 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.

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.

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.

LoadBalancingScheme

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

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.

LabelsEntry

The abstract base class for a message.

OperationMetadata

Represents the metadata of the long-running operation.

ServiceBinding

ServiceBinding is the resource that defines a Service Directory Service to be used in a BackendService resource.

LabelsEntry

The abstract base class for a message.

TcpRoute

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

LabelsEntry

The abstract base class for a message.

RouteAction

The specifications for routing traffic and applying associated policies.

RouteDestination

Describe the destination for traffic to be routed to.

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.

RouteRule

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

TlsRoute

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

RouteAction

The specifications for routing traffic and applying associated policies.

RouteDestination

Describe the destination for traffic to be routed to.

RouteMatch

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.

RouteRule

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

TrafficPortSelector

Specification of a port-based selector.

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.

UpdateTcpRouteRequest

Request used by the UpdateTcpRoute method.

UpdateTlsRouteRequest

Request used by the UpdateTlsRoute method.

Modules

pagers

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

pagers

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