Class InterceptClient (0.10.0)

Version latest

• 0.10.0 (latest)
• 0.9.21
• 0.8.0
• 0.7.2
• 0.6.1
• 0.5.0
• 0.4.2
• 0.3.2
• 0.2.0
• 0.1.5

InterceptClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.network_security_v1alpha1.services.intercept.transports.base.InterceptTransport,
            typing.Callable[
                [...],
                google.cloud.network_security_v1alpha1.services.intercept.transports.base.InterceptTransport,
            ],
        ]
    ] = None,
    client_options: typing.Optional[
        typing.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
)

Service for Third-Party Packet Intercept (TPPI). TPPI is the "in-band" flavor of the Network Security Integrations product.

Properties

api_endpoint

Return the API endpoint used by the client instance.

Returns
Type	Description
str	The API endpoint used by the client instance.

transport

Returns the transport used by the client instance.

Returns
Type	Description
InterceptTransport	The transport used by the client instance.

universe_domain

Return the universe domain used by the client instance.

Returns
Type	Description
str	The universe domain used by the client instance.

Methods

InterceptClient

InterceptClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.cloud.network_security_v1alpha1.services.intercept.transports.base.InterceptTransport,
            typing.Callable[
                [...],
                google.cloud.network_security_v1alpha1.services.intercept.transports.base.InterceptTransport,
            ],
        ]
    ] = None,
    client_options: typing.Optional[
        typing.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
)

Instantiates the intercept client.

Parameters
Name	Description
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	Optional[Union[str,InterceptTransport,Callable[..., InterceptTransport]]] The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the InterceptTransport constructor. 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. 1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "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). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide a client certificate for mTLS 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. 3. The universe_domain property can be used to override the default "googleapis.com" universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
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
Type	Description
google.auth.exceptions.MutualTLSChannelError	If mutual TLS transport creation failed for any reason.

__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

Warning: ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name	Description
request	.operations_pb2.CancelOperationRequest The request object. Request message for CancelOperation method.
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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

create_intercept_deployment

create_intercept_deployment(
    request: typing.Optional[
        typing.Union[
            google.cloud.network_security_v1alpha1.types.intercept.CreateInterceptDeploymentRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    intercept_deployment: typing.Optional[
        google.cloud.network_security_v1alpha1.types.intercept.InterceptDeployment
    ] = None,
    intercept_deployment_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Creates a deployment in a given project and location. See https://google.aip.dev/133.

# 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 network_security_v1alpha1

def sample_create_intercept_deployment():
    # Create a client
    client = network_security_v1alpha1.InterceptClient()

    # Initialize request argument(s)
    intercept_deployment = network_security_v1alpha1.InterceptDeployment()
    intercept_deployment.forwarding_rule = "forwarding_rule_value"
    intercept_deployment.intercept_deployment_group = "intercept_deployment_group_value"

    request = network_security_v1alpha1.CreateInterceptDeploymentRequest(
        parent="parent_value",
        intercept_deployment_id="intercept_deployment_id_value",
        intercept_deployment=intercept_deployment,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.network_security_v1alpha1.types.CreateInterceptDeploymentRequest, dict] The request object. Request message for CreateInterceptDeployment.
parent	str Required. The parent resource where this deployment will be created. Format: projects/{project}/locations/{location} This corresponds to the parent field on the request instance; if request is provided, this should not be set.
intercept_deployment	google.cloud.network_security_v1alpha1.types.InterceptDeployment Required. The deployment to create. This corresponds to the intercept_deployment field on the request instance; if request is provided, this should not be set.
intercept_deployment_id	str Required. The ID to use for the new deployment, which will become the final component of the deployment's resource name. This corresponds to the intercept_deployment_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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be InterceptDeployment A deployment represents a zonal intercept backend ready to accept GENEVE-encapsulated traffic, e.g. a zonal instance group fronted by an internal passthrough load balancer. Deployments are always part of a global deployment group which represents a global intercept service.

create_intercept_deployment_group

create_intercept_deployment_group(
    request: typing.Optional[
        typing.Union[
            google.cloud.network_security_v1alpha1.types.intercept.CreateInterceptDeploymentGroupRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    intercept_deployment_group: typing.Optional[
        google.cloud.network_security_v1alpha1.types.intercept.InterceptDeploymentGroup
    ] = None,
    intercept_deployment_group_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Creates a deployment group in a given project and location. See https://google.aip.dev/133.

# 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 network_security_v1alpha1

def sample_create_intercept_deployment_group():
    # Create a client
    client = network_security_v1alpha1.InterceptClient()

    # Initialize request argument(s)
    intercept_deployment_group = network_security_v1alpha1.InterceptDeploymentGroup()
    intercept_deployment_group.network = "network_value"

    request = network_security_v1alpha1.CreateInterceptDeploymentGroupRequest(
        parent="parent_value",
        intercept_deployment_group_id="intercept_deployment_group_id_value",
        intercept_deployment_group=intercept_deployment_group,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.network_security_v1alpha1.types.CreateInterceptDeploymentGroupRequest, dict] The request object. Request message for CreateInterceptDeploymentGroup.
parent	str Required. The parent resource where this deployment group will be created. Format: projects/{project}/locations/{location} This corresponds to the parent field on the request instance; if request is provided, this should not be set.
intercept_deployment_group	google.cloud.network_security_v1alpha1.types.InterceptDeploymentGroup Required. The deployment group to create. This corresponds to the intercept_deployment_group field on the request instance; if request is provided, this should not be set.
intercept_deployment_group_id	str Required. The ID to use for the new deployment group, which will become the final component of the deployment group's resource name. This corresponds to the intercept_deployment_group_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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be InterceptDeploymentGroup A deployment group aggregates many zonal intercept backends (deployments) into a single global intercept service. Consumers can connect this service using an endpoint group.

create_intercept_endpoint_group

create_intercept_endpoint_group(
    request: typing.Optional[
        typing.Union[
            google.cloud.network_security_v1alpha1.types.intercept.CreateInterceptEndpointGroupRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    intercept_endpoint_group: typing.Optional[
        google.cloud.network_security_v1alpha1.types.intercept.InterceptEndpointGroup
    ] = None,
    intercept_endpoint_group_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Creates an endpoint group in a given project and location. See https://google.aip.dev/133.

# 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 network_security_v1alpha1

def sample_create_intercept_endpoint_group():
    # Create a client
    client = network_security_v1alpha1.InterceptClient()

    # Initialize request argument(s)
    intercept_endpoint_group = network_security_v1alpha1.InterceptEndpointGroup()
    intercept_endpoint_group.intercept_deployment_group = "intercept_deployment_group_value"

    request = network_security_v1alpha1.CreateInterceptEndpointGroupRequest(
        parent="parent_value",
        intercept_endpoint_group_id="intercept_endpoint_group_id_value",
        intercept_endpoint_group=intercept_endpoint_group,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.network_security_v1alpha1.types.CreateInterceptEndpointGroupRequest, dict] The request object. Request message for CreateInterceptEndpointGroup.
parent	str Required. The parent resource where this endpoint group will be created. Format: projects/{project}/locations/{location} This corresponds to the parent field on the request instance; if request is provided, this should not be set.
intercept_endpoint_group	google.cloud.network_security_v1alpha1.types.InterceptEndpointGroup Required. The endpoint group to create. This corresponds to the intercept_endpoint_group field on the request instance; if request is provided, this should not be set.
intercept_endpoint_group_id	str Required. The ID to use for the endpoint group, which will become the final component of the endpoint group's resource name. This corresponds to the intercept_endpoint_group_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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be InterceptEndpointGroup An endpoint group is a consumer frontend for a deployment group (backend). In order to configure intercept for a network, consumers must create: - An association between their network and the endpoint group. - A security profile that points to the endpoint group. - A firewall rule that references the security profile (group).

create_intercept_endpoint_group_association

create_intercept_endpoint_group_association(
    request: typing.Optional[
        typing.Union[
            google.cloud.network_security_v1alpha1.types.intercept.CreateInterceptEndpointGroupAssociationRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    intercept_endpoint_group_association: typing.Optional[
        google.cloud.network_security_v1alpha1.types.intercept.InterceptEndpointGroupAssociation
    ] = None,
    intercept_endpoint_group_association_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Creates an association in a given project and location. See https://google.aip.dev/133.

# 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 network_security_v1alpha1

def sample_create_intercept_endpoint_group_association():
    # Create a client
    client = network_security_v1alpha1.InterceptClient()

    # Initialize request argument(s)
    intercept_endpoint_group_association = network_security_v1alpha1.InterceptEndpointGroupAssociation()
    intercept_endpoint_group_association.intercept_endpoint_group = "intercept_endpoint_group_value"
    intercept_endpoint_group_association.network = "network_value"

    request = network_security_v1alpha1.CreateInterceptEndpointGroupAssociationRequest(
        parent="parent_value",
        intercept_endpoint_group_association=intercept_endpoint_group_association,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.network_security_v1alpha1.types.CreateInterceptEndpointGroupAssociationRequest, dict] The request object. Request message for CreateInterceptEndpointGroupAssociation.
parent	str Required. The parent resource where this association will be created. Format: projects/{project}/locations/{location} This corresponds to the parent field on the request instance; if request is provided, this should not be set.
intercept_endpoint_group_association	google.cloud.network_security_v1alpha1.types.InterceptEndpointGroupAssociation Required. The association to create. This corresponds to the intercept_endpoint_group_association field on the request instance; if request is provided, this should not be set.
intercept_endpoint_group_association_id	str Optional. The ID to use for the new association, which will become the final component of the endpoint group's resource name. If not provided, the server will generate a unique ID. This corresponds to the intercept_endpoint_group_association_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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be InterceptEndpointGroupAssociation An endpoint group association represents a link between a network and an endpoint group in the organization. Creating an association creates the networking infrastructure linking the network to the endpoint group, but does not enable intercept by itself. To enable intercept, the user must also create a network firewall policy containing intercept rules and associate it with the network.

delete_intercept_deployment

delete_intercept_deployment(
    request: typing.Optional[
        typing.Union[
            google.cloud.network_security_v1alpha1.types.intercept.DeleteInterceptDeploymentRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Deletes a deployment. See https://google.aip.dev/135.

# 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 network_security_v1alpha1

def sample_delete_intercept_deployment():
    # Create a client
    client = network_security_v1alpha1.InterceptClient()

    # Initialize request argument(s)
    request = network_security_v1alpha1.DeleteInterceptDeploymentRequest(
        name="name_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.network_security_v1alpha1.types.DeleteInterceptDeploymentRequest, dict] The request object. Request message for DeleteInterceptDeployment.
name	str Required. Name of the resource 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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	An 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); }

delete_intercept_deployment_group

delete_intercept_deployment_group(
    request: typing.Optional[
        typing.Union[
            google.cloud.network_security_v1alpha1.types.intercept.DeleteInterceptDeploymentGroupRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Deletes a deployment group. See https://google.aip.dev/135.

# 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 network_security_v1alpha1

def sample_delete_intercept_deployment_group():
    # Create a client
    client = network_security_v1alpha1.InterceptClient()

    # Initialize request argument(s)
    request = network_security_v1alpha1.DeleteInterceptDeploymentGroupRequest(
        name="name_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.network_security_v1alpha1.types.DeleteInterceptDeploymentGroupRequest, dict] The request object. Request message for DeleteInterceptDeploymentGroup.
name	str Required. The deployment group 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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	An 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); }

delete_intercept_endpoint_group

delete_intercept_endpoint_group(
    request: typing.Optional[
        typing.Union[
            google.cloud.network_security_v1alpha1.types.intercept.DeleteInterceptEndpointGroupRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Deletes an endpoint group. See https://google.aip.dev/135.

# 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 network_security_v1alpha1

def sample_delete_intercept_endpoint_group():
    # Create a client
    client = network_security_v1alpha1.InterceptClient()

    # Initialize request argument(s)
    request = network_security_v1alpha1.DeleteInterceptEndpointGroupRequest(
        name="name_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.network_security_v1alpha1.types.DeleteInterceptEndpointGroupRequest, dict] The request object. Request message for DeleteInterceptEndpointGroup.
name	str Required. The endpoint group 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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	An 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); }

delete_intercept_endpoint_group_association

delete_intercept_endpoint_group_association(
    request: typing.Optional[
        typing.Union[
            google.cloud.network_security_v1alpha1.types.intercept.DeleteInterceptEndpointGroupAssociationRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Deletes an association. See https://google.aip.dev/135.

# 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 network_security_v1alpha1

def sample_delete_intercept_endpoint_group_association():
    # Create a client
    client = network_security_v1alpha1.InterceptClient()

    # Initialize request argument(s)
    request = network_security_v1alpha1.DeleteInterceptEndpointGroupAssociationRequest(
        name="name_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.network_security_v1alpha1.types.DeleteInterceptEndpointGroupAssociationRequest, dict] The request object. Request message for DeleteInterceptEndpointGroupAssociation.
name	str Required. The association 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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	An 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); }

delete_operation

delete_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.DeleteOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name	Description
request	.operations_pb2.DeleteOperationRequest The request object. Request message for DeleteOperation method.
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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

forwarding_rule_path

forwarding_rule_path(project: str, forwarding_rule: str) -> str

Returns a fully-qualified forwarding_rule string.

from_service_account_file

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

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

Parameter
Name	Description
filename	str The path to the service account private key json file.

Returns
Type	Description
InterceptClient	The 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
Name	Description
info	dict The service account private key info.

Returns
Type	Description
InterceptClient	The 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
Name	Description
filename	str The path to the service account private key json file.

Returns
Type	Description
InterceptClient	The constructed client.

get_iam_policy

get_iam_policy(
    request: typing.Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.iam.v1.policy_pb2.Policy

Gets the IAM access control policy for a function.

Returns an empty policy if the function exists and does not have a policy set.

Parameters
Name	Description
request	.iam_policy_pb2.GetIamPolicyRequest The request object. Request message for GetIamPolicy method.
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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
.policy_pb2.Policy	Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** :: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[e-mail]", "group:[e-mail]", "domain:google.com", "serviceAccount:[e-mail]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:[e-mail]"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ]="" }="" **yaml="" example**="" ::="" bindings:="" -="" members:="" -="" user:[e-mail]="" -="" group:[e-mail]="" -="" domain:google.com="" -="" serviceaccount:[e-mail]="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:[e-mail]="" role:="" roles/resourcemanager.organizationviewer="" condition:="" title:="" expirable="" access="" description:="" does="" not="" grant="" access="" after="" sep="" 2020="" expression:="" request.time="">< timestamp('2020-10-01t00:00:00.000z')="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the="">IAM developer's guide __.

get_intercept_deployment

get_intercept_deployment(
    request: typing.Optional[
        typing.Union[
            google.cloud.network_security_v1alpha1.types.intercept.GetInterceptDeploymentRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.network_security_v1alpha1.types.intercept.InterceptDeployment

Gets a specific deployment. See https://google.aip.dev/131.

# 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 network_security_v1alpha1

def sample_get_intercept_deployment():
    # Create a client
    client = network_security_v1alpha1.InterceptClient()

    # Initialize request argument(s)
    request = network_security_v1alpha1.GetInterceptDeploymentRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.network_security_v1alpha1.types.GetInterceptDeploymentRequest, dict] The request object. Request message for GetInterceptDeployment.
name	str Required. The name of the deployment to retrieve. Format: projects/{project}/locations/{location}/interceptDeployments/{intercept_deployment} 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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.cloud.network_security_v1alpha1.types.InterceptDeployment	A deployment represents a zonal intercept backend ready to accept GENEVE-encapsulated traffic, e.g. a zonal instance group fronted by an internal passthrough load balancer. Deployments are always part of a global deployment group which represents a global intercept service.

get_intercept_deployment_group

get_intercept_deployment_group(
    request: typing.Optional[
        typing.Union[
            google.cloud.network_security_v1alpha1.types.intercept.GetInterceptDeploymentGroupRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.network_security_v1alpha1.types.intercept.InterceptDeploymentGroup

Gets a specific deployment group. See https://google.aip.dev/131.

# 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 network_security_v1alpha1

def sample_get_intercept_deployment_group():
    # Create a client
    client = network_security_v1alpha1.InterceptClient()

    # Initialize request argument(s)
    request = network_security_v1alpha1.GetInterceptDeploymentGroupRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.network_security_v1alpha1.types.GetInterceptDeploymentGroupRequest, dict] The request object. Request message for GetInterceptDeploymentGroup.
name	str Required. The name of the deployment group to retrieve. Format: projects/{project}/locations/{location}/interceptDeploymentGroups/{intercept_deployment_group} 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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.cloud.network_security_v1alpha1.types.InterceptDeploymentGroup	A deployment group aggregates many zonal intercept backends (deployments) into a single global intercept service. Consumers can connect this service using an endpoint group.

get_intercept_endpoint_group

get_intercept_endpoint_group(
    request: typing.Optional[
        typing.Union[
            google.cloud.network_security_v1alpha1.types.intercept.GetInterceptEndpointGroupRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.network_security_v1alpha1.types.intercept.InterceptEndpointGroup

Gets a specific endpoint group. See https://google.aip.dev/131.

# 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 network_security_v1alpha1

def sample_get_intercept_endpoint_group():
    # Create a client
    client = network_security_v1alpha1.InterceptClient()

    # Initialize request argument(s)
    request = network_security_v1alpha1.GetInterceptEndpointGroupRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.network_security_v1alpha1.types.GetInterceptEndpointGroupRequest, dict] The request object. Request message for GetInterceptEndpointGroup.
name	str Required. The name of the endpoint group to retrieve. Format: projects/{project}/locations/{location}/interceptEndpointGroups/{intercept_endpoint_group} 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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.cloud.network_security_v1alpha1.types.InterceptEndpointGroup	An endpoint group is a consumer frontend for a deployment group (backend). In order to configure intercept for a network, consumers must create: - An association between their network and the endpoint group. - A security profile that points to the endpoint group. - A firewall rule that references the security profile (group).

get_intercept_endpoint_group_association

get_intercept_endpoint_group_association(
    request: typing.Optional[
        typing.Union[
            google.cloud.network_security_v1alpha1.types.intercept.GetInterceptEndpointGroupAssociationRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.network_security_v1alpha1.types.intercept.InterceptEndpointGroupAssociation
)

Gets a specific association. See https://google.aip.dev/131.

# 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 network_security_v1alpha1

def sample_get_intercept_endpoint_group_association():
    # Create a client
    client = network_security_v1alpha1.InterceptClient()

    # Initialize request argument(s)
    request = network_security_v1alpha1.GetInterceptEndpointGroupAssociationRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.network_security_v1alpha1.types.GetInterceptEndpointGroupAssociationRequest, dict] The request object. Request message for GetInterceptEndpointGroupAssociation.
name	str Required. The name of the association to retrieve. Format: projects/{project}/locations/{location}/interceptEndpointGroupAssociations/{intercept_endpoint_group_association} 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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.cloud.network_security_v1alpha1.types.InterceptEndpointGroupAssociation	An endpoint group association represents a link between a network and an endpoint group in the organization. Creating an association creates the networking infrastructure linking the network to the endpoint group, but does not enable intercept by itself. To enable intercept, the user must also create a network firewall policy containing intercept rules and associate it with the network.

get_location

get_location(
    request: typing.Optional[
        google.cloud.location.locations_pb2.GetLocationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.Location

Gets information about a location.

Parameters
Name	Description
request	.location_pb2.GetLocationRequest The request object. Request message for GetLocation method.
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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
.location_pb2.Location	Location object.

get_mtls_endpoint_and_cert_source

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

Deprecated. 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 variable 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
Name	Description
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
Type	Description
google.auth.exceptions.MutualTLSChannelError	If any errors happen.

Returns
Type	Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]]	returns the API endpoint and the client cert source to use.

get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

Parameters
Name	Description
request	.operations_pb2.GetOperationRequest The request object. Request message for GetOperation method.
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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
.operations_pb2.Operation	An Operation object.

intercept_deployment_group_path

intercept_deployment_group_path(
    project: str, location: str, intercept_deployment_group: str
) -> str

Returns a fully-qualified intercept_deployment_group string.

intercept_deployment_path

intercept_deployment_path(
    project: str, location: str, intercept_deployment: str
) -> str

Returns a fully-qualified intercept_deployment string.

intercept_endpoint_group_association_path

intercept_endpoint_group_association_path(
    project: str, location: str, intercept_endpoint_group_association: str
) -> str

Returns a fully-qualified intercept_endpoint_group_association string.

intercept_endpoint_group_path

intercept_endpoint_group_path(
    project: str, location: str, intercept_endpoint_group: str
) -> str

Returns a fully-qualified intercept_endpoint_group string.

list_intercept_deployment_groups

list_intercept_deployment_groups(
    request: typing.Optional[
        typing.Union[
            google.cloud.network_security_v1alpha1.types.intercept.ListInterceptDeploymentGroupsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.network_security_v1alpha1.services.intercept.pagers.ListInterceptDeploymentGroupsPager
)

Lists deployment groups in a given project and location. See https://google.aip.dev/132.

# 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 network_security_v1alpha1

def sample_list_intercept_deployment_groups():
    # Create a client
    client = network_security_v1alpha1.InterceptClient()

    # Initialize request argument(s)
    request = network_security_v1alpha1.ListInterceptDeploymentGroupsRequest(
        parent="parent_value",
    )

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

    # Handle the response
    for response in page_result:
        print(response)

Parameters
Name	Description
request	Union[google.cloud.network_security_v1alpha1.types.ListInterceptDeploymentGroupsRequest, dict] The request object. Request message for ListInterceptDeploymentGroups.
parent	str Required. The parent, which owns this collection of deployment groups. Example: projects/123456789/locations/global. See https://google.aip.dev/132 for more details. 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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.cloud.network_security_v1alpha1.services.intercept.pagers.ListInterceptDeploymentGroupsPager	Response message for ListInterceptDeploymentGroups. Iterating over this object will yield results and resolve additional pages automatically.

list_intercept_deployments

list_intercept_deployments(
    request: typing.Optional[
        typing.Union[
            google.cloud.network_security_v1alpha1.types.intercept.ListInterceptDeploymentsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.network_security_v1alpha1.services.intercept.pagers.ListInterceptDeploymentsPager
)

Lists deployments in a given project and location. See https://google.aip.dev/132.

# 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 network_security_v1alpha1

def sample_list_intercept_deployments():
    # Create a client
    client = network_security_v1alpha1.InterceptClient()

    # Initialize request argument(s)
    request = network_security_v1alpha1.ListInterceptDeploymentsRequest(
        parent="parent_value",
    )

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

    # Handle the response
    for response in page_result:
        print(response)

Parameters
Name	Description
request	Union[google.cloud.network_security_v1alpha1.types.ListInterceptDeploymentsRequest, dict] The request object. Request message for ListInterceptDeployments.
parent	str Required. The parent, which owns this collection of deployments. Example: projects/123456789/locations/us-central1-a. See https://google.aip.dev/132 for more details. 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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.cloud.network_security_v1alpha1.services.intercept.pagers.ListInterceptDeploymentsPager	Response message for ListInterceptDeployments. Iterating over this object will yield results and resolve additional pages automatically.

list_intercept_endpoint_group_associations

list_intercept_endpoint_group_associations(
    request: typing.Optional[
        typing.Union[
            google.cloud.network_security_v1alpha1.types.intercept.ListInterceptEndpointGroupAssociationsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.network_security_v1alpha1.services.intercept.pagers.ListInterceptEndpointGroupAssociationsPager
)

Lists associations in a given project and location. See https://google.aip.dev/132.

# 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 network_security_v1alpha1

def sample_list_intercept_endpoint_group_associations():
    # Create a client
    client = network_security_v1alpha1.InterceptClient()

    # Initialize request argument(s)
    request = network_security_v1alpha1.ListInterceptEndpointGroupAssociationsRequest(
        parent="parent_value",
    )

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

    # Handle the response
    for response in page_result:
        print(response)

Parameters
Name	Description
request	Union[google.cloud.network_security_v1alpha1.types.ListInterceptEndpointGroupAssociationsRequest, dict] The request object. Request message for ListInterceptEndpointGroupAssociations.
parent	str Required. The parent, which owns this collection of associations. Example: projects/123456789/locations/global. See https://google.aip.dev/132 for more details. 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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.cloud.network_security_v1alpha1.services.intercept.pagers.ListInterceptEndpointGroupAssociationsPager	Response message for ListInterceptEndpointGroupAssociations. Iterating over this object will yield results and resolve additional pages automatically.

list_intercept_endpoint_groups

list_intercept_endpoint_groups(
    request: typing.Optional[
        typing.Union[
            google.cloud.network_security_v1alpha1.types.intercept.ListInterceptEndpointGroupsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.network_security_v1alpha1.services.intercept.pagers.ListInterceptEndpointGroupsPager
)

Lists endpoint groups in a given project and location. See https://google.aip.dev/132.

# 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 network_security_v1alpha1

def sample_list_intercept_endpoint_groups():
    # Create a client
    client = network_security_v1alpha1.InterceptClient()

    # Initialize request argument(s)
    request = network_security_v1alpha1.ListInterceptEndpointGroupsRequest(
        parent="parent_value",
    )

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

    # Handle the response
    for response in page_result:
        print(response)

Parameters
Name	Description
request	Union[google.cloud.network_security_v1alpha1.types.ListInterceptEndpointGroupsRequest, dict] The request object. Request message for ListInterceptEndpointGroups.
parent	str Required. The parent, which owns this collection of endpoint groups. Example: projects/123456789/locations/global. See https://google.aip.dev/132 for more details. 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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.cloud.network_security_v1alpha1.services.intercept.pagers.ListInterceptEndpointGroupsPager	Response message for ListInterceptEndpointGroups. Iterating over this object will yield results and resolve additional pages automatically.

list_locations

list_locations(
    request: typing.Optional[
        google.cloud.location.locations_pb2.ListLocationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse

Lists information about the supported locations for this service.

Parameters
Name	Description
request	.location_pb2.ListLocationsRequest The request object. Request message for ListLocations method.
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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
.location_pb2.ListLocationsResponse	Response message for ListLocations method.

list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

Parameters
Name	Description
request	.operations_pb2.ListOperationsRequest The request object. Request message for ListOperations method.
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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
.operations_pb2.ListOperationsResponse	Response message for ListOperations method.

network_path

network_path(project: str, network: str) -> str

Returns a fully-qualified network string.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

parse_forwarding_rule_path

parse_forwarding_rule_path(path: str) -> typing.Dict[str, str]

Parses a forwarding_rule path into its component segments.

parse_intercept_deployment_group_path

parse_intercept_deployment_group_path(path: str) -> typing.Dict[str, str]

Parses a intercept_deployment_group path into its component segments.

parse_intercept_deployment_path

parse_intercept_deployment_path(path: str) -> typing.Dict[str, str]

Parses a intercept_deployment path into its component segments.

parse_intercept_endpoint_group_association_path

parse_intercept_endpoint_group_association_path(path: str) -> typing.Dict[str, str]

Parses a intercept_endpoint_group_association path into its component segments.

parse_intercept_endpoint_group_path

parse_intercept_endpoint_group_path(path: str) -> typing.Dict[str, str]

Parses a intercept_endpoint_group path into its component segments.

parse_network_path

parse_network_path(path: str) -> typing.Dict[str, str]

Parses a network path into its component segments.

set_iam_policy

set_iam_policy(
    request: typing.Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.iam.v1.policy_pb2.Policy

Sets the IAM access control policy on the specified function.

Replaces any existing policy.

Parameters
Name	Description
request	.iam_policy_pb2.SetIamPolicyRequest The request object. Request message for SetIamPolicy method.
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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
.policy_pb2.Policy	Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** :: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[e-mail]", "group:[e-mail]", "domain:google.com", "serviceAccount:[e-mail]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:[e-mail]"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ]="" }="" **yaml="" example**="" ::="" bindings:="" -="" members:="" -="" user:[e-mail]="" -="" group:[e-mail]="" -="" domain:google.com="" -="" serviceaccount:[e-mail]="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:[e-mail]="" role:="" roles/resourcemanager.organizationviewer="" condition:="" title:="" expirable="" access="" description:="" does="" not="" grant="" access="" after="" sep="" 2020="" expression:="" request.time="">< timestamp('2020-10-01t00:00:00.000z')="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the="">IAM developer's guide __.

test_iam_permissions

test_iam_permissions(
    request: typing.Optional[
        google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse

Tests the specified IAM permissions against the IAM access control policy for a function.

If the function does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Parameters
Name	Description
request	.iam_policy_pb2.TestIamPermissionsRequest The request object. Request message for TestIamPermissions method.
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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
.iam_policy_pb2.TestIamPermissionsResponse	Response message for TestIamPermissions method.

update_intercept_deployment

update_intercept_deployment(
    request: typing.Optional[
        typing.Union[
            google.cloud.network_security_v1alpha1.types.intercept.UpdateInterceptDeploymentRequest,
            dict,
        ]
    ] = None,
    *,
    intercept_deployment: typing.Optional[
        google.cloud.network_security_v1alpha1.types.intercept.InterceptDeployment
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Updates a deployment. See https://google.aip.dev/134.

# 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 network_security_v1alpha1

def sample_update_intercept_deployment():
    # Create a client
    client = network_security_v1alpha1.InterceptClient()

    # Initialize request argument(s)
    intercept_deployment = network_security_v1alpha1.InterceptDeployment()
    intercept_deployment.forwarding_rule = "forwarding_rule_value"
    intercept_deployment.intercept_deployment_group = "intercept_deployment_group_value"

    request = network_security_v1alpha1.UpdateInterceptDeploymentRequest(
        intercept_deployment=intercept_deployment,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.network_security_v1alpha1.types.UpdateInterceptDeploymentRequest, dict] The request object. Request message for UpdateInterceptDeployment.
intercept_deployment	google.cloud.network_security_v1alpha1.types.InterceptDeployment Required. The deployment to update. This corresponds to the intercept_deployment field on the request instance; if request is provided, this should not be set.
update_mask	google.protobuf.field_mask_pb2.FieldMask Optional. The list of fields to update. Fields are specified relative to the deployment (e.g. description; not intercept_deployment.description). See https://google.aip.dev/161 for more details. This corresponds to the update_mask 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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be InterceptDeployment A deployment represents a zonal intercept backend ready to accept GENEVE-encapsulated traffic, e.g. a zonal instance group fronted by an internal passthrough load balancer. Deployments are always part of a global deployment group which represents a global intercept service.

update_intercept_deployment_group

update_intercept_deployment_group(
    request: typing.Optional[
        typing.Union[
            google.cloud.network_security_v1alpha1.types.intercept.UpdateInterceptDeploymentGroupRequest,
            dict,
        ]
    ] = None,
    *,
    intercept_deployment_group: typing.Optional[
        google.cloud.network_security_v1alpha1.types.intercept.InterceptDeploymentGroup
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Updates a deployment group. See https://google.aip.dev/134.

# 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 network_security_v1alpha1

def sample_update_intercept_deployment_group():
    # Create a client
    client = network_security_v1alpha1.InterceptClient()

    # Initialize request argument(s)
    intercept_deployment_group = network_security_v1alpha1.InterceptDeploymentGroup()
    intercept_deployment_group.network = "network_value"

    request = network_security_v1alpha1.UpdateInterceptDeploymentGroupRequest(
        intercept_deployment_group=intercept_deployment_group,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.network_security_v1alpha1.types.UpdateInterceptDeploymentGroupRequest, dict] The request object. Request message for UpdateInterceptDeploymentGroup.
intercept_deployment_group	google.cloud.network_security_v1alpha1.types.InterceptDeploymentGroup Required. The deployment group to update. This corresponds to the intercept_deployment_group field on the request instance; if request is provided, this should not be set.
update_mask	google.protobuf.field_mask_pb2.FieldMask Optional. The list of fields to update. Fields are specified relative to the deployment group (e.g. description; not intercept_deployment_group.description). See https://google.aip.dev/161 for more details. This corresponds to the update_mask 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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be InterceptDeploymentGroup A deployment group aggregates many zonal intercept backends (deployments) into a single global intercept service. Consumers can connect this service using an endpoint group.

update_intercept_endpoint_group

update_intercept_endpoint_group(
    request: typing.Optional[
        typing.Union[
            google.cloud.network_security_v1alpha1.types.intercept.UpdateInterceptEndpointGroupRequest,
            dict,
        ]
    ] = None,
    *,
    intercept_endpoint_group: typing.Optional[
        google.cloud.network_security_v1alpha1.types.intercept.InterceptEndpointGroup
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Updates an endpoint group. See https://google.aip.dev/134.

# 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 network_security_v1alpha1

def sample_update_intercept_endpoint_group():
    # Create a client
    client = network_security_v1alpha1.InterceptClient()

    # Initialize request argument(s)
    intercept_endpoint_group = network_security_v1alpha1.InterceptEndpointGroup()
    intercept_endpoint_group.intercept_deployment_group = "intercept_deployment_group_value"

    request = network_security_v1alpha1.UpdateInterceptEndpointGroupRequest(
        intercept_endpoint_group=intercept_endpoint_group,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.network_security_v1alpha1.types.UpdateInterceptEndpointGroupRequest, dict] The request object. Request message for UpdateInterceptEndpointGroup.
intercept_endpoint_group	google.cloud.network_security_v1alpha1.types.InterceptEndpointGroup Required. The endpoint group to update. This corresponds to the intercept_endpoint_group field on the request instance; if request is provided, this should not be set.
update_mask	google.protobuf.field_mask_pb2.FieldMask Optional. The list of fields to update. Fields are specified relative to the endpoint group (e.g. description; not intercept_endpoint_group.description). See https://google.aip.dev/161 for more details. This corresponds to the update_mask 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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be InterceptEndpointGroup An endpoint group is a consumer frontend for a deployment group (backend). In order to configure intercept for a network, consumers must create: - An association between their network and the endpoint group. - A security profile that points to the endpoint group. - A firewall rule that references the security profile (group).

update_intercept_endpoint_group_association

update_intercept_endpoint_group_association(
    request: typing.Optional[
        typing.Union[
            google.cloud.network_security_v1alpha1.types.intercept.UpdateInterceptEndpointGroupAssociationRequest,
            dict,
        ]
    ] = None,
    *,
    intercept_endpoint_group_association: typing.Optional[
        google.cloud.network_security_v1alpha1.types.intercept.InterceptEndpointGroupAssociation
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Updates an association. See https://google.aip.dev/134.

# 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 network_security_v1alpha1

def sample_update_intercept_endpoint_group_association():
    # Create a client
    client = network_security_v1alpha1.InterceptClient()

    # Initialize request argument(s)
    intercept_endpoint_group_association = network_security_v1alpha1.InterceptEndpointGroupAssociation()
    intercept_endpoint_group_association.intercept_endpoint_group = "intercept_endpoint_group_value"
    intercept_endpoint_group_association.network = "network_value"

    request = network_security_v1alpha1.UpdateInterceptEndpointGroupAssociationRequest(
        intercept_endpoint_group_association=intercept_endpoint_group_association,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.network_security_v1alpha1.types.UpdateInterceptEndpointGroupAssociationRequest, dict] The request object. Request message for UpdateInterceptEndpointGroupAssociation.
intercept_endpoint_group_association	google.cloud.network_security_v1alpha1.types.InterceptEndpointGroupAssociation Required. The association to update. This corresponds to the intercept_endpoint_group_association field on the request instance; if request is provided, this should not be set.
update_mask	google.protobuf.field_mask_pb2.FieldMask Optional. The list of fields to update. Fields are specified relative to the association (e.g. description; not intercept_endpoint_group_association.description). See https://google.aip.dev/161 for more details. This corresponds to the update_mask 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, Union[str, bytes]]] Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type	Description
google.api_core.operation.Operation	An object representing a long-running operation. The result type for the operation will be InterceptEndpointGroupAssociation An endpoint group association represents a link between a network and an endpoint group in the organization. Creating an association creates the networking infrastructure linking the network to the endpoint group, but does not enable intercept by itself. To enable intercept, the user must also create a network firewall policy containing intercept rules and associate it with the network.