Class NetworkSecurityAsyncClient (0.9.13) 

NetworkSecurityAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.network_security_v1beta1.services.network_security.transports.base.NetworkSecurityTransport, typing.Callable[[...], google.cloud.network_security_v1beta1.services.network_security.transports.base.NetworkSecurityTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Network Security API provides resources to configure authentication and authorization policies. Refer to per API resource documentation for more information.

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
NetworkSecurityTransport 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

NetworkSecurityAsyncClient

NetworkSecurityAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.network_security_v1beta1.services.network_security.transports.base.NetworkSecurityTransport, typing.Callable[[...], google.cloud.network_security_v1beta1.services.network_security.transports.base.NetworkSecurityTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the network security async 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,NetworkSecurityTransport,Callable[..., NetworkSecurityTransport]]]

The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the NetworkSecurityTransport 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 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.

authorization_policy_path

authorization_policy_path(
    project: str, location: str, authorization_policy: str
) -> str

Returns a fully-qualified authorization_policy string.

cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> 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_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, str]]

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

client_tls_policy_path

client_tls_policy_path(project: str, location: str, client_tls_policy: str) -> str

Returns a fully-qualified client_tls_policy string.

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_authorization_policy

create_authorization_policy(
    request: typing.Optional[
        typing.Union[
            google.cloud.network_security_v1beta1.types.authorization_policy.CreateAuthorizationPolicyRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    authorization_policy: typing.Optional[
        google.cloud.network_security_v1beta1.types.authorization_policy.AuthorizationPolicy
    ] = None,
    authorization_policy_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Creates a new AuthorizationPolicy in a given project and location.

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

async def sample_create_authorization_policy():
    # Create a client
    client = network_security_v1beta1.NetworkSecurityAsyncClient()

    # Initialize request argument(s)
    authorization_policy = network_security_v1beta1.AuthorizationPolicy()
    authorization_policy.name = "name_value"
    authorization_policy.action = "DENY"

    request = network_security_v1beta1.CreateAuthorizationPolicyRequest(
        parent="parent_value",
        authorization_policy_id="authorization_policy_id_value",
        authorization_policy=authorization_policy,
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.network_security_v1beta1.types.CreateAuthorizationPolicyRequest, dict]]

The request object. Request used by the CreateAuthorizationPolicy method.
parent str

Required. The parent resource of the AuthorizationPolicy. Must be in the format projects/{project}/locations/{location}. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
authorization_policy AuthorizationPolicy

Required. AuthorizationPolicy resource to be created. This corresponds to the authorization_policy field on the request instance; if request is provided, this should not be set.
authorization_policy_id str

Required. Short name of the AuthorizationPolicy resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "authz_policy". This corresponds to the authorization_policy_id field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.api_core.operation_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be AuthorizationPolicy AuthorizationPolicy is a resource that specifies how a server should authorize incoming connections. This resource in itself does not change the configuration unless it's attached to a target https proxy or endpoint config selector resource.

create_client_tls_policy

create_client_tls_policy(
    request: typing.Optional[
        typing.Union[
            google.cloud.network_security_v1beta1.types.client_tls_policy.CreateClientTlsPolicyRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    client_tls_policy: typing.Optional[
        google.cloud.network_security_v1beta1.types.client_tls_policy.ClientTlsPolicy
    ] = None,
    client_tls_policy_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Creates a new ClientTlsPolicy in a given project and location.

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

async def sample_create_client_tls_policy():
    # Create a client
    client = network_security_v1beta1.NetworkSecurityAsyncClient()

    # Initialize request argument(s)
    client_tls_policy = network_security_v1beta1.ClientTlsPolicy()
    client_tls_policy.name = "name_value"

    request = network_security_v1beta1.CreateClientTlsPolicyRequest(
        parent="parent_value",
        client_tls_policy_id="client_tls_policy_id_value",
        client_tls_policy=client_tls_policy,
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.network_security_v1beta1.types.CreateClientTlsPolicyRequest, dict]]

The request object. Request used by the CreateClientTlsPolicy method.
parent str

Required. The parent resource of the ClientTlsPolicy. Must be in the format projects/*/locations/{location}. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
client_tls_policy ClientTlsPolicy

Required. ClientTlsPolicy resource to be created. This corresponds to the client_tls_policy field on the request instance; if request is provided, this should not be set.
client_tls_policy_id str

Required. Short name of the ClientTlsPolicy resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "client_mtls_policy". This corresponds to the client_tls_policy_id field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.api_core.operation_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be ClientTlsPolicy ClientTlsPolicy is a resource that specifies how a client should authenticate connections to backends of a service. This resource itself does not affect configuration unless it is attached to a backend service resource.

create_server_tls_policy

create_server_tls_policy(
    request: typing.Optional[
        typing.Union[
            google.cloud.network_security_v1beta1.types.server_tls_policy.CreateServerTlsPolicyRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    server_tls_policy: typing.Optional[
        google.cloud.network_security_v1beta1.types.server_tls_policy.ServerTlsPolicy
    ] = None,
    server_tls_policy_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Creates a new ServerTlsPolicy in a given project and location.

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

async def sample_create_server_tls_policy():
    # Create a client
    client = network_security_v1beta1.NetworkSecurityAsyncClient()

    # Initialize request argument(s)
    server_tls_policy = network_security_v1beta1.ServerTlsPolicy()
    server_tls_policy.name = "name_value"

    request = network_security_v1beta1.CreateServerTlsPolicyRequest(
        parent="parent_value",
        server_tls_policy_id="server_tls_policy_id_value",
        server_tls_policy=server_tls_policy,
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.network_security_v1beta1.types.CreateServerTlsPolicyRequest, dict]]

The request object. Request used by the CreateServerTlsPolicy method.
parent str

Required. The parent resource of the ServerTlsPolicy. Must be in the format projects/*/locations/{location}. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
server_tls_policy ServerTlsPolicy

Required. ServerTlsPolicy resource to be created. This corresponds to the server_tls_policy field on the request instance; if request is provided, this should not be set.
server_tls_policy_id str

Required. Short name of the ServerTlsPolicy resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "server_mtls_policy". This corresponds to the server_tls_policy_id field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.api_core.operation_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be ServerTlsPolicy ServerTlsPolicy is a resource that specifies how a server should authenticate incoming requests. This resource itself does not affect configuration unless it is attached to a target https proxy or endpoint config selector resource.

delete_authorization_policy

delete_authorization_policy(
    request: typing.Optional[
        typing.Union[
            google.cloud.network_security_v1beta1.types.authorization_policy.DeleteAuthorizationPolicyRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Deletes a single AuthorizationPolicy.

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

async def sample_delete_authorization_policy():
    # Create a client
    client = network_security_v1beta1.NetworkSecurityAsyncClient()

    # Initialize request argument(s)
    request = network_security_v1beta1.DeleteAuthorizationPolicyRequest(
        name="name_value",
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.network_security_v1beta1.types.DeleteAuthorizationPolicyRequest, dict]]

The request object. Request used by the DeleteAuthorizationPolicy method.
name str

Required. A name of the AuthorizationPolicy to delete. Must be in the format projects/{project}/locations/{location}/authorizationPolicies/*. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.api_core.operation_async.AsyncOperation 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_client_tls_policy

delete_client_tls_policy(
    request: typing.Optional[
        typing.Union[
            google.cloud.network_security_v1beta1.types.client_tls_policy.DeleteClientTlsPolicyRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Deletes a single ClientTlsPolicy.

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

async def sample_delete_client_tls_policy():
    # Create a client
    client = network_security_v1beta1.NetworkSecurityAsyncClient()

    # Initialize request argument(s)
    request = network_security_v1beta1.DeleteClientTlsPolicyRequest(
        name="name_value",
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.network_security_v1beta1.types.DeleteClientTlsPolicyRequest, dict]]

The request object. Request used by the DeleteClientTlsPolicy method.
name str

Required. A name of the ClientTlsPolicy to delete. Must be in the format projects//locations/{location}/clientTlsPolicies/. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.api_core.operation_async.AsyncOperation 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_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> 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_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, str]]

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

delete_server_tls_policy

delete_server_tls_policy(
    request: typing.Optional[
        typing.Union[
            google.cloud.network_security_v1beta1.types.server_tls_policy.DeleteServerTlsPolicyRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Deletes a single ServerTlsPolicy.

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

async def sample_delete_server_tls_policy():
    # Create a client
    client = network_security_v1beta1.NetworkSecurityAsyncClient()

    # Initialize request argument(s)
    request = network_security_v1beta1.DeleteServerTlsPolicyRequest(
        name="name_value",
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.network_security_v1beta1.types.DeleteServerTlsPolicyRequest, dict]]

The request object. Request used by the DeleteServerTlsPolicy method.
name str

Required. A name of the ServerTlsPolicy to delete. Must be in the format projects//locations/{location}/serverTlsPolicies/. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.api_core.operation_async.AsyncOperation 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); }

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
NetworkSecurityAsyncClient 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
NetworkSecurityAsyncClient 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
NetworkSecurityAsyncClient The constructed client.

get_authorization_policy

get_authorization_policy(
    request: typing.Optional[
        typing.Union[
            google.cloud.network_security_v1beta1.types.authorization_policy.GetAuthorizationPolicyRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.network_security_v1beta1.types.authorization_policy.AuthorizationPolicy
)

Gets details of a single AuthorizationPolicy.

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

async def sample_get_authorization_policy():
    # Create a client
    client = network_security_v1beta1.NetworkSecurityAsyncClient()

    # Initialize request argument(s)
    request = network_security_v1beta1.GetAuthorizationPolicyRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_authorization_policy(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.network_security_v1beta1.types.GetAuthorizationPolicyRequest, dict]]

The request object. Request used by the GetAuthorizationPolicy method.
name str

Required. A name of the AuthorizationPolicy to get. Must be in the format projects/{project}/locations/{location}/authorizationPolicies/*. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.network_security_v1beta1.types.AuthorizationPolicy AuthorizationPolicy is a resource that specifies how a server should authorize incoming connections. This resource in itself does not change the configuration unless it's attached to a target https proxy or endpoint config selector resource.

get_client_tls_policy

get_client_tls_policy(
    request: typing.Optional[
        typing.Union[
            google.cloud.network_security_v1beta1.types.client_tls_policy.GetClientTlsPolicyRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.network_security_v1beta1.types.client_tls_policy.ClientTlsPolicy

Gets details of a single ClientTlsPolicy.

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

async def sample_get_client_tls_policy():
    # Create a client
    client = network_security_v1beta1.NetworkSecurityAsyncClient()

    # Initialize request argument(s)
    request = network_security_v1beta1.GetClientTlsPolicyRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_client_tls_policy(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.network_security_v1beta1.types.GetClientTlsPolicyRequest, dict]]

The request object. Request used by the GetClientTlsPolicy method.
name str

Required. A name of the ClientTlsPolicy to get. Must be in the format projects//locations/{location}/clientTlsPolicies/. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.network_security_v1beta1.types.ClientTlsPolicy ClientTlsPolicy is a resource that specifies how a client should authenticate connections to backends of a service. This resource itself does not affect configuration unless it is attached to a backend service resource.

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_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> 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_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
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:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "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:mike@example.com="" -="" group:admins@example.com="" -="" domain:google.com="" -="" serviceaccount:my-project-id@appspot.gserviceaccount.com="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:eve@example.com="" 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_location

get_location(
    request: typing.Optional[
        google.cloud.location.locations_pb2.GetLocationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> 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_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
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,
)

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_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> 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_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
.operations_pb2.Operation An Operation object.

get_server_tls_policy

get_server_tls_policy(
    request: typing.Optional[
        typing.Union[
            google.cloud.network_security_v1beta1.types.server_tls_policy.GetServerTlsPolicyRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.network_security_v1beta1.types.server_tls_policy.ServerTlsPolicy

Gets details of a single ServerTlsPolicy.

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

async def sample_get_server_tls_policy():
    # Create a client
    client = network_security_v1beta1.NetworkSecurityAsyncClient()

    # Initialize request argument(s)
    request = network_security_v1beta1.GetServerTlsPolicyRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_server_tls_policy(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.network_security_v1beta1.types.GetServerTlsPolicyRequest, dict]]

The request object. Request used by the GetServerTlsPolicy method.
name str

Required. A name of the ServerTlsPolicy to get. Must be in the format projects//locations/{location}/serverTlsPolicies/. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.network_security_v1beta1.types.ServerTlsPolicy ServerTlsPolicy is a resource that specifies how a server should authenticate incoming requests. This resource itself does not affect configuration unless it is attached to a target https proxy or endpoint config selector resource.

get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.network_security_v1beta1.services.network_security.transports.base.NetworkSecurityTransport
]

Returns an appropriate transport class.

Parameter
Name Description
label typing.Optional[str]

The name of the desired transport. If none is provided, then the first transport in the registry is used.

list_authorization_policies

list_authorization_policies(
    request: typing.Optional[
        typing.Union[
            google.cloud.network_security_v1beta1.types.authorization_policy.ListAuthorizationPoliciesRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.network_security_v1beta1.services.network_security.pagers.ListAuthorizationPoliciesAsyncPager
)

Lists AuthorizationPolicies in a given project and location.

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

async def sample_list_authorization_policies():
    # Create a client
    client = network_security_v1beta1.NetworkSecurityAsyncClient()

    # Initialize request argument(s)
    request = network_security_v1beta1.ListAuthorizationPoliciesRequest(
        parent="parent_value",
    )

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

    # Handle the response
    async for response in page_result:
        print(response)
Parameters
Name Description
request Optional[Union[google.cloud.network_security_v1beta1.types.ListAuthorizationPoliciesRequest, dict]]

The request object. Request used with the ListAuthorizationPolicies method.
parent str

Required. The project and location from which the AuthorizationPolicies should be listed, specified in the format projects/{project}/locations/{location}. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.network_security_v1beta1.services.network_security.pagers.ListAuthorizationPoliciesAsyncPager Response returned by the ListAuthorizationPolicies method. Iterating over this object will yield results and resolve additional pages automatically.

list_client_tls_policies

list_client_tls_policies(
    request: typing.Optional[
        typing.Union[
            google.cloud.network_security_v1beta1.types.client_tls_policy.ListClientTlsPoliciesRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.network_security_v1beta1.services.network_security.pagers.ListClientTlsPoliciesAsyncPager
)

Lists ClientTlsPolicies in a given project and location.

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

async def sample_list_client_tls_policies():
    # Create a client
    client = network_security_v1beta1.NetworkSecurityAsyncClient()

    # Initialize request argument(s)
    request = network_security_v1beta1.ListClientTlsPoliciesRequest(
        parent="parent_value",
    )

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

    # Handle the response
    async for response in page_result:
        print(response)
Parameters
Name Description
request Optional[Union[google.cloud.network_security_v1beta1.types.ListClientTlsPoliciesRequest, dict]]

The request object. Request used by the ListClientTlsPolicies method.
parent str

Required. The project and location from which the ClientTlsPolicies should be listed, specified in the format projects/*/locations/{location}. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.network_security_v1beta1.services.network_security.pagers.ListClientTlsPoliciesAsyncPager Response returned by the ListClientTlsPolicies method. 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_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> 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_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
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_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> 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_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
.operations_pb2.ListOperationsResponse Response message for ListOperations method.

list_server_tls_policies

list_server_tls_policies(
    request: typing.Optional[
        typing.Union[
            google.cloud.network_security_v1beta1.types.server_tls_policy.ListServerTlsPoliciesRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.network_security_v1beta1.services.network_security.pagers.ListServerTlsPoliciesAsyncPager
)

Lists ServerTlsPolicies in a given project and location.

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

async def sample_list_server_tls_policies():
    # Create a client
    client = network_security_v1beta1.NetworkSecurityAsyncClient()

    # Initialize request argument(s)
    request = network_security_v1beta1.ListServerTlsPoliciesRequest(
        parent="parent_value",
    )

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

    # Handle the response
    async for response in page_result:
        print(response)
Parameters
Name Description
request Optional[Union[google.cloud.network_security_v1beta1.types.ListServerTlsPoliciesRequest, dict]]

The request object. Request used by the ListServerTlsPolicies method.
parent str

Required. The project and location from which the ServerTlsPolicies should be listed, specified in the format projects/*/locations/{location}. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.network_security_v1beta1.services.network_security.pagers.ListServerTlsPoliciesAsyncPager Response returned by the ListServerTlsPolicies method. Iterating over this object will yield results and resolve additional pages automatically.

parse_authorization_policy_path

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

Parses a authorization_policy path into its component segments.

parse_client_tls_policy_path

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

Parses a client_tls_policy path into its component segments.

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_server_tls_policy_path

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

Parses a server_tls_policy path into its component segments.

server_tls_policy_path

server_tls_policy_path(project: str, location: str, server_tls_policy: str) -> str

Returns a fully-qualified server_tls_policy string.

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_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> 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_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
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:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "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:mike@example.com="" -="" group:admins@example.com="" -="" domain:google.com="" -="" serviceaccount:my-project-id@appspot.gserviceaccount.com="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:eve@example.com="" 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_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> 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_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
.iam_policy_pb2.TestIamPermissionsResponse Response message for TestIamPermissions method.

update_authorization_policy

update_authorization_policy(
    request: typing.Optional[
        typing.Union[
            google.cloud.network_security_v1beta1.types.authorization_policy.UpdateAuthorizationPolicyRequest,
            dict,
        ]
    ] = None,
    *,
    authorization_policy: typing.Optional[
        google.cloud.network_security_v1beta1.types.authorization_policy.AuthorizationPolicy
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Updates the parameters of a single AuthorizationPolicy.

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

async def sample_update_authorization_policy():
    # Create a client
    client = network_security_v1beta1.NetworkSecurityAsyncClient()

    # Initialize request argument(s)
    authorization_policy = network_security_v1beta1.AuthorizationPolicy()
    authorization_policy.name = "name_value"
    authorization_policy.action = "DENY"

    request = network_security_v1beta1.UpdateAuthorizationPolicyRequest(
        authorization_policy=authorization_policy,
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.network_security_v1beta1.types.UpdateAuthorizationPolicyRequest, dict]]

The request object. Request used by the UpdateAuthorizationPolicy method.
authorization_policy AuthorizationPolicy

Required. Updated AuthorizationPolicy resource. This corresponds to the authorization_policy field on the request instance; if request is provided, this should not be set.
update_mask google.protobuf.field_mask_pb2.FieldMask

Optional. Field mask is used to specify the fields to be overwritten in the AuthorizationPolicy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. 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_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.api_core.operation_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be AuthorizationPolicy AuthorizationPolicy is a resource that specifies how a server should authorize incoming connections. This resource in itself does not change the configuration unless it's attached to a target https proxy or endpoint config selector resource.

update_client_tls_policy

update_client_tls_policy(
    request: typing.Optional[
        typing.Union[
            google.cloud.network_security_v1beta1.types.client_tls_policy.UpdateClientTlsPolicyRequest,
            dict,
        ]
    ] = None,
    *,
    client_tls_policy: typing.Optional[
        google.cloud.network_security_v1beta1.types.client_tls_policy.ClientTlsPolicy
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Updates the parameters of a single ClientTlsPolicy.

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

async def sample_update_client_tls_policy():
    # Create a client
    client = network_security_v1beta1.NetworkSecurityAsyncClient()

    # Initialize request argument(s)
    client_tls_policy = network_security_v1beta1.ClientTlsPolicy()
    client_tls_policy.name = "name_value"

    request = network_security_v1beta1.UpdateClientTlsPolicyRequest(
        client_tls_policy=client_tls_policy,
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.network_security_v1beta1.types.UpdateClientTlsPolicyRequest, dict]]

The request object. Request used by UpdateClientTlsPolicy method.
client_tls_policy ClientTlsPolicy

Required. Updated ClientTlsPolicy resource. This corresponds to the client_tls_policy field on the request instance; if request is provided, this should not be set.
update_mask google.protobuf.field_mask_pb2.FieldMask

Optional. Field mask is used to specify the fields to be overwritten in the ClientTlsPolicy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. 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_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.api_core.operation_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be ClientTlsPolicy ClientTlsPolicy is a resource that specifies how a client should authenticate connections to backends of a service. This resource itself does not affect configuration unless it is attached to a backend service resource.

update_server_tls_policy

update_server_tls_policy(
    request: typing.Optional[
        typing.Union[
            google.cloud.network_security_v1beta1.types.server_tls_policy.UpdateServerTlsPolicyRequest,
            dict,
        ]
    ] = None,
    *,
    server_tls_policy: typing.Optional[
        google.cloud.network_security_v1beta1.types.server_tls_policy.ServerTlsPolicy
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation

Updates the parameters of a single ServerTlsPolicy.

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

async def sample_update_server_tls_policy():
    # Create a client
    client = network_security_v1beta1.NetworkSecurityAsyncClient()

    # Initialize request argument(s)
    server_tls_policy = network_security_v1beta1.ServerTlsPolicy()
    server_tls_policy.name = "name_value"

    request = network_security_v1beta1.UpdateServerTlsPolicyRequest(
        server_tls_policy=server_tls_policy,
    )

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

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

    response = (await operation).result()

    # Handle the response
    print(response)
Parameters
Name Description
request Optional[Union[google.cloud.network_security_v1beta1.types.UpdateServerTlsPolicyRequest, dict]]

The request object. Request used by UpdateServerTlsPolicy method.
server_tls_policy ServerTlsPolicy

Required. Updated ServerTlsPolicy resource. This corresponds to the server_tls_policy field on the request instance; if request is provided, this should not be set.
update_mask google.protobuf.field_mask_pb2.FieldMask

Optional. Field mask is used to specify the fields to be overwritten in the ServerTlsPolicy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. 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_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.api_core.operation_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be ServerTlsPolicy ServerTlsPolicy is a resource that specifies how a server should authenticate incoming requests. This resource itself does not affect configuration unless it is attached to a target https proxy or endpoint config selector resource.