Class PolicyBasedRoutingServiceClient (1.5.0)

PolicyBasedRoutingServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.networkconnectivity_v1.services.policy_based_routing_service.transports.base.PolicyBasedRoutingServiceTransport]] = None, client_options: Optional[Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Policy-Based Routing allows GCP customers to specify flexibile routing policies for Layer 4 traffic traversing through the connected service.

Properties

transport

Returns the transport used by the client instance.

Returns
TypeDescription
PolicyBasedRoutingServiceTransportThe transport used by the client instance.

Methods

PolicyBasedRoutingServiceClient

PolicyBasedRoutingServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.networkconnectivity_v1.services.policy_based_routing_service.transports.base.PolicyBasedRoutingServiceTransport]] = None, client_options: Optional[Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the policy based routing service client.

Parameters
NameDescription
credentials Optional[google.auth.credentials.Credentials]

The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

transport Union[str, PolicyBasedRoutingServiceTransport]

The transport to use. If set to None, a transport is chosen automatically.

client_options Optional[Union[google.api_core.client_options.ClientOptions, dict]]

Custom options for the client. It won't take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.

client_info google.api_core.gapic_v1.client_info.ClientInfo

The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf mutual TLS transport creation failed for any reason.

__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

create_policy_based_route

create_policy_based_route(request: Optional[Union[google.cloud.networkconnectivity_v1.types.policy_based_routing.CreatePolicyBasedRouteRequest, dict]] = None, *, parent: Optional[str] = None, policy_based_route: Optional[google.cloud.networkconnectivity_v1.types.policy_based_routing.PolicyBasedRoute] = None, policy_based_route_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Creates a new PolicyBasedRoute in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import networkconnectivity_v1

def sample_create_policy_based_route():
    # Create a client
    client = networkconnectivity_v1.PolicyBasedRoutingServiceClient()

    # Initialize request argument(s)
    policy_based_route = networkconnectivity_v1.PolicyBasedRoute()
    policy_based_route.next_hop_ilb_ip = "next_hop_ilb_ip_value"
    policy_based_route.network = "network_value"
    policy_based_route.filter.protocol_version = "IPV4"

    request = networkconnectivity_v1.CreatePolicyBasedRouteRequest(
        parent="parent_value",
        policy_based_route=policy_based_route,
    )

    # Make the request
    operation = client.create_policy_based_route(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.networkconnectivity_v1.types.CreatePolicyBasedRouteRequest, dict]

The request object. Request for [PolicyBasedRouting.CreatePolicyBasedRoute][] method.

parent str

Required. The parent resource's name of the PolicyBasedRoute. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

policy_based_route google.cloud.networkconnectivity_v1.types.PolicyBasedRoute

Required. Initial values for a new Policy Based Route. This corresponds to the policy_based_route field on the request instance; if request is provided, this should not be set.

policy_based_route_id str

Optional. Unique id for the Policy Based Route to create. This corresponds to the policy_based_route_id field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be PolicyBasedRoute Policy Based Routes (PBR) are more powerful routes that allows GCP customers to route their L4 network traffic based on not just destination IP, but also source IP, protocol and more. A PBR always take precedence when it conflicts with other types of routes. Next id: 19

delete_policy_based_route

delete_policy_based_route(request: Optional[Union[google.cloud.networkconnectivity_v1.types.policy_based_routing.DeletePolicyBasedRouteRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Deletes a single PolicyBasedRoute.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import networkconnectivity_v1

def sample_delete_policy_based_route():
    # Create a client
    client = networkconnectivity_v1.PolicyBasedRoutingServiceClient()

    # Initialize request argument(s)
    request = networkconnectivity_v1.DeletePolicyBasedRouteRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_policy_based_route(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.networkconnectivity_v1.types.DeletePolicyBasedRouteRequest, dict]

The request object. Request for [PolicyBasedRouting.DeletePolicyBasedRoute][] method.

name str

Required. Name of the PolicyBasedRoute resource to delete. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.operation.OperationAn object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
PolicyBasedRoutingServiceClientThe constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter
NameDescription
info dict

The service account private key info.

Returns
TypeDescription
PolicyBasedRoutingServiceClientThe constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
PolicyBasedRoutingServiceClientThe constructed client.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variabel is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
NameDescription
client_options google.api_core.client_options.ClientOptions

Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Exceptions
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf any errors happen.
Returns
TypeDescription
Tuple[str, Callable[[], Tuple[bytes, bytes]]]returns the API endpoint and the client cert source to use.

get_policy_based_route

get_policy_based_route(request: Optional[Union[google.cloud.networkconnectivity_v1.types.policy_based_routing.GetPolicyBasedRouteRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Gets details of a single PolicyBasedRoute.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import networkconnectivity_v1

def sample_get_policy_based_route():
    # Create a client
    client = networkconnectivity_v1.PolicyBasedRoutingServiceClient()

    # Initialize request argument(s)
    request = networkconnectivity_v1.GetPolicyBasedRouteRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_policy_based_route(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.networkconnectivity_v1.types.GetPolicyBasedRouteRequest, dict]

The request object. Request for [PolicyBasedRouting.GetPolicyBasedRoute][] method.

name str

Required. Name of the PolicyBasedRoute resource to get. This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.networkconnectivity_v1.types.PolicyBasedRoutePolicy Based Routes (PBR) are more powerful routes that allows GCP customers to route their L4 network traffic based on not just destination IP, but also source IP, protocol and more. A PBR always take precedence when it conflicts with other types of routes. Next id: 19

list_policy_based_routes

list_policy_based_routes(request: Optional[Union[google.cloud.networkconnectivity_v1.types.policy_based_routing.ListPolicyBasedRoutesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Lists PolicyBasedRoutes in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import networkconnectivity_v1

def sample_list_policy_based_routes():
    # Create a client
    client = networkconnectivity_v1.PolicyBasedRoutingServiceClient()

    # Initialize request argument(s)
    request = networkconnectivity_v1.ListPolicyBasedRoutesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_policy_based_routes(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
NameDescription
request Union[google.cloud.networkconnectivity_v1.types.ListPolicyBasedRoutesRequest, dict]

The request object. Request for [PolicyBasedRouting.ListPolicyBasedRoutes][] method.

parent str

Required. The parent resource's name. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.networkconnectivity_v1.services.policy_based_routing_service.pagers.ListPolicyBasedRoutesPagerResponse for [PolicyBasedRouting.ListPolicyBasedRoutes][] method. Iterating over this object will yield results and resolve additional pages automatically.

network_path

network_path(project: str, resource_id: str)

Returns a fully-qualified network string.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_network_path

parse_network_path(path: str)

Parses a network path into its component segments.

parse_policy_based_route_path

parse_policy_based_route_path(path: str)

Parses a policy_based_route path into its component segments.

policy_based_route_path

policy_based_route_path(project: str, location: str, policy_based_route: str)

Returns a fully-qualified policy_based_route string.