As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

NetworkSecurity¶

class google.cloud.network_security_v1.services.network_security.NetworkSecurityAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.network_security_v1.services.network_security.transports.base.NetworkSecurityTransport, typing.Callable[[...], google.cloud.network_security_v1.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>)[source]¶

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

Instantiates the network security async client.

Parameters

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.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

static authorization_policy_path(project: str, location: str, authorization_policy: str) → str¶: Returns a fully-qualified authorization_policy string.

async cancel_operation(request: Optional[google.longrunning.operations_pb2.CancelOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

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

request (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.

Returns

None

static client_tls_policy_path(project: str, location: str, client_tls_policy: str) → str¶: Returns a fully-qualified client_tls_policy string.

static common_billing_account_path(billing_account: str) → str¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str¶: Returns a fully-qualified project string.

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

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_v1

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

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

    request = network_security_v1.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

request (Optional[Union[google.cloud.network_security_v1.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 (google.cloud.network_security_v1.types.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

An object representing a long-running operation.

The result type for the operation will be google.cloud.network_security_v1.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.

Return type

google.api_core.operation_async.AsyncOperation

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

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_v1

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

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

    request = network_security_v1.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

request (Optional[Union[google.cloud.network_security_v1.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 (google.cloud.network_security_v1.types.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

An object representing a long-running operation.

The result type for the operation will be google.cloud.network_security_v1.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.

Return type

google.api_core.operation_async.AsyncOperation

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

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_v1

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

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

    request = network_security_v1.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

request (Optional[Union[google.cloud.network_security_v1.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 (google.cloud.network_security_v1.types.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

An object representing a long-running operation.

The result type for the operation will be google.cloud.network_security_v1.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.

Return type

google.api_core.operation_async.AsyncOperation

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

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_v1

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

    # Initialize request argument(s)
    request = network_security_v1.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

request (Optional[Union[google.cloud.network_security_v1.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

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);

}

Return type

google.api_core.operation_async.AsyncOperation

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

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_v1

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

    # Initialize request argument(s)
    request = network_security_v1.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

request (Optional[Union[google.cloud.network_security_v1.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

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);

}

Return type

google.api_core.operation_async.AsyncOperation

async delete_operation(request: Optional[google.longrunning.operations_pb2.DeleteOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

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

request (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.

Returns

None

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

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_v1

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

    # Initialize request argument(s)
    request = network_security_v1.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

request (Optional[Union[google.cloud.network_security_v1.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

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);

}

Return type

google.api_core.operation_async.AsyncOperation

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

NetworkSecurityAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

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

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

NetworkSecurityAsyncClient

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

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

NetworkSecurityAsyncClient

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

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_v1

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

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

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.network_security_v1.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

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.

Return type

google.cloud.network_security_v1.types.AuthorizationPolicy

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

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_v1

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

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

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.network_security_v1.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

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.

Return type

google.cloud.network_security_v1.types.ClientTlsPolicy

async get_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.iam.v1.policy_pb2.Policy[source]¶

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

request (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

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.

Return type

Policy

async get_location(request: Optional[google.cloud.location.locations_pb2.GetLocationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.Location[source]¶

Gets information about a location.

Parameters

request (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

Location object.

Return type

Location

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

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.

Parameters

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.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

async get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.Operation[source]¶

Gets the latest state of a long-running operation.

Parameters

request (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

An Operation object.

Return type

Operation

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

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_v1

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

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

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

    # Handle the response
    print(response)

Parameters

request (Optional[Union[google.cloud.network_security_v1.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

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.

Return type

google.cloud.network_security_v1.types.ServerTlsPolicy

classmethod get_transport_class(label: Optional[str] = None) → Type[google.cloud.network_security_v1.services.network_security.transports.base.NetworkSecurityTransport]¶

Returns an appropriate transport class.

Parameters: label – The name of the desired transport. If none is provided, then the first transport in the registry is used.
Returns: The transport class to use.

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

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_v1

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

    # Initialize request argument(s)
    request = network_security_v1.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

request (Optional[Union[google.cloud.network_security_v1.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

Response returned by the ListAuthorizationPolicies method. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.network_security_v1.services.network_security.pagers.ListAuthorizationPoliciesAsyncPager

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

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_v1

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

    # Initialize request argument(s)
    request = network_security_v1.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

request (Optional[Union[google.cloud.network_security_v1.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

Response returned by the ListClientTlsPolicies method. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.network_security_v1.services.network_security.pagers.ListClientTlsPoliciesAsyncPager

async list_locations(request: Optional[google.cloud.location.locations_pb2.ListLocationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.location.locations_pb2.ListLocationsResponse[source]¶

Lists information about the supported locations for this service.

Parameters

request (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

Response message for ListLocations method.

Return type

ListLocationsResponse

async list_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.longrunning.operations_pb2.ListOperationsResponse[source]¶

Lists operations that match the specified filter in the request.

Parameters

request (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

Response message for ListOperations method.

Return type

ListOperationsResponse

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

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_v1

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

    # Initialize request argument(s)
    request = network_security_v1.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

request (Optional[Union[google.cloud.network_security_v1.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

Response returned by the ListServerTlsPolicies method. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.network_security_v1.services.network_security.pagers.ListServerTlsPoliciesAsyncPager

static parse_authorization_policy_path(path: str) → Dict[str, str]¶: Parses a authorization_policy path into its component segments.

static parse_client_tls_policy_path(path: str) → Dict[str, str]¶: Parses a client_tls_policy path into its component segments.

static parse_common_billing_account_path(path: str) → Dict[str, str]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str]¶: Parse a project path into its component segments.

static parse_server_tls_policy_path(path: str) → Dict[str, str]¶: Parses a server_tls_policy path into its component segments.

static server_tls_policy_path(project: str, location: str, server_tls_policy: str) → str¶: Returns a fully-qualified server_tls_policy string.

async set_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.iam.v1.policy_pb2.Policy[source]¶

Sets the IAM access control policy on the specified function.

Replaces any existing policy.

Parameters

request (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

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.

Return type

Policy

async test_iam_permissions(request: Optional[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse[source]¶

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

request (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

Response message for TestIamPermissions method.

Return type

TestIamPermissionsResponse

property transport: google.cloud.network_security_v1.services.network_security.transports.base.NetworkSecurityTransport¶

Returns the transport used by the client instance.

Returns: The transport used by the client instance.
Return type: NetworkSecurityTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns

The universe domain used: by the client instance.

Return type

str

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

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_v1

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

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

    request = network_security_v1.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

request (Optional[Union[google.cloud.network_security_v1.types.UpdateAuthorizationPolicyRequest, dict]]) – The request object. Request used by the UpdateAuthorizationPolicy method.
authorization_policy (google.cloud.network_security_v1.types.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

An object representing a long-running operation.

The result type for the operation will be google.cloud.network_security_v1.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.

Return type

google.api_core.operation_async.AsyncOperation

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

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_v1

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

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

    request = network_security_v1.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

request (Optional[Union[google.cloud.network_security_v1.types.UpdateClientTlsPolicyRequest, dict]]) – The request object. Request used by UpdateClientTlsPolicy method.
client_tls_policy (google.cloud.network_security_v1.types.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

An object representing a long-running operation.

The result type for the operation will be google.cloud.network_security_v1.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.

Return type

google.api_core.operation_async.AsyncOperation

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

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_v1

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

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

    request = network_security_v1.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

request (Optional[Union[google.cloud.network_security_v1.types.UpdateServerTlsPolicyRequest, dict]]) – The request object. Request used by UpdateServerTlsPolicy method.
server_tls_policy (google.cloud.network_security_v1.types.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

An object representing a long-running operation.

The result type for the operation will be google.cloud.network_security_v1.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.

Return type

google.api_core.operation_async.AsyncOperation

class google.cloud.network_security_v1.services.network_security.NetworkSecurityClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.network_security_v1.services.network_security.transports.base.NetworkSecurityTransport, typing.Callable[[...], google.cloud.network_security_v1.services.network_security.transports.base.NetworkSecurityTransport]]] = 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 object>)[source]¶

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

Instantiates the network security client.

Parameters

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

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]¶: 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!

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns: The API endpoint used by the client instance.
Return type: str

static authorization_policy_path(project: str, location: str, authorization_policy: str) → str[source]¶: Returns a fully-qualified authorization_policy string.

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

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

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

Returns

None

static client_tls_policy_path(project: str, location: str, client_tls_policy: str) → str[source]¶: Returns a fully-qualified client_tls_policy string.

static common_billing_account_path(billing_account: str) → str[source]¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str[source]¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str[source]¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str[source]¶: Returns a fully-qualified project string.

create_authorization_policy(request: Optional[Union[google.cloud.network_security_v1.types.authorization_policy.CreateAuthorizationPolicyRequest, dict]] = None, *, parent: Optional[str] = None, authorization_policy: Optional[google.cloud.network_security_v1.types.authorization_policy.AuthorizationPolicy] = None, authorization_policy_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

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_v1

def sample_create_authorization_policy():
    # Create a client
    client = network_security_v1.NetworkSecurityClient()

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

    request = network_security_v1.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 = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.network_security_v1.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 (google.cloud.network_security_v1.types.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.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.network_security_v1.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.

Return type

google.api_core.operation.Operation

create_client_tls_policy(request: Optional[Union[google.cloud.network_security_v1.types.client_tls_policy.CreateClientTlsPolicyRequest, dict]] = None, *, parent: Optional[str] = None, client_tls_policy: Optional[google.cloud.network_security_v1.types.client_tls_policy.ClientTlsPolicy] = None, client_tls_policy_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

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_v1

def sample_create_client_tls_policy():
    # Create a client
    client = network_security_v1.NetworkSecurityClient()

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

    request = network_security_v1.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 = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.network_security_v1.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 (google.cloud.network_security_v1.types.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.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.network_security_v1.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.

Return type

google.api_core.operation.Operation

create_server_tls_policy(request: Optional[Union[google.cloud.network_security_v1.types.server_tls_policy.CreateServerTlsPolicyRequest, dict]] = None, *, parent: Optional[str] = None, server_tls_policy: Optional[google.cloud.network_security_v1.types.server_tls_policy.ServerTlsPolicy] = None, server_tls_policy_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

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_v1

def sample_create_server_tls_policy():
    # Create a client
    client = network_security_v1.NetworkSecurityClient()

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

    request = network_security_v1.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 = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.network_security_v1.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 (google.cloud.network_security_v1.types.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.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.network_security_v1.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.

Return type

google.api_core.operation.Operation

delete_authorization_policy(request: Optional[Union[google.cloud.network_security_v1.types.authorization_policy.DeleteAuthorizationPolicyRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

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_v1

def sample_delete_authorization_policy():
    # Create a client
    client = network_security_v1.NetworkSecurityClient()

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

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.network_security_v1.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.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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);

}

Return type

google.api_core.operation.Operation

delete_client_tls_policy(request: Optional[Union[google.cloud.network_security_v1.types.client_tls_policy.DeleteClientTlsPolicyRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

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_v1

def sample_delete_client_tls_policy():
    # Create a client
    client = network_security_v1.NetworkSecurityClient()

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

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.network_security_v1.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.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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);

}

Return type

google.api_core.operation.Operation

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

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

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

Returns

None

delete_server_tls_policy(request: Optional[Union[google.cloud.network_security_v1.types.server_tls_policy.DeleteServerTlsPolicyRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

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_v1

def sample_delete_server_tls_policy():
    # Create a client
    client = network_security_v1.NetworkSecurityClient()

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

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.network_security_v1.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.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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);

}

Return type

google.api_core.operation.Operation

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

NetworkSecurityClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

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

Parameters

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

NetworkSecurityClient

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

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

Parameters

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

NetworkSecurityClient

get_authorization_policy(request: Optional[Union[google.cloud.network_security_v1.types.authorization_policy.GetAuthorizationPolicyRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.network_security_v1.types.authorization_policy.AuthorizationPolicy[source]¶

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_v1

def sample_get_authorization_policy():
    # Create a client
    client = network_security_v1.NetworkSecurityClient()

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

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.network_security_v1.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.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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.

Return type

google.cloud.network_security_v1.types.AuthorizationPolicy

get_client_tls_policy(request: Optional[Union[google.cloud.network_security_v1.types.client_tls_policy.GetClientTlsPolicyRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.network_security_v1.types.client_tls_policy.ClientTlsPolicy[source]¶

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_v1

def sample_get_client_tls_policy():
    # Create a client
    client = network_security_v1.NetworkSecurityClient()

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

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.network_security_v1.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.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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.

Return type

google.cloud.network_security_v1.types.ClientTlsPolicy

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

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

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

Returns

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.

Return type

Policy

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

Gets information about a location.

Parameters

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

Returns

Location object.

Return type

Location

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶

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.

Parameters

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.

Returns

returns the API endpoint and the: client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

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

Gets the latest state of a long-running operation.

Parameters

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

Returns

An Operation object.

Return type

Operation

get_server_tls_policy(request: Optional[Union[google.cloud.network_security_v1.types.server_tls_policy.GetServerTlsPolicyRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.network_security_v1.types.server_tls_policy.ServerTlsPolicy[source]¶

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_v1

def sample_get_server_tls_policy():
    # Create a client
    client = network_security_v1.NetworkSecurityClient()

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

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

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.network_security_v1.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.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

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.

Return type

google.cloud.network_security_v1.types.ServerTlsPolicy

list_authorization_policies(request: Optional[Union[google.cloud.network_security_v1.types.authorization_policy.ListAuthorizationPoliciesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.network_security_v1.services.network_security.pagers.ListAuthorizationPoliciesPager[source]¶

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_v1

def sample_list_authorization_policies():
    # Create a client
    client = network_security_v1.NetworkSecurityClient()

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

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

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

Parameters

request (Union[google.cloud.network_security_v1.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.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response returned by the ListAuthorizationPolicies method. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.network_security_v1.services.network_security.pagers.ListAuthorizationPoliciesPager

list_client_tls_policies(request: Optional[Union[google.cloud.network_security_v1.types.client_tls_policy.ListClientTlsPoliciesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.network_security_v1.services.network_security.pagers.ListClientTlsPoliciesPager[source]¶

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_v1

def sample_list_client_tls_policies():
    # Create a client
    client = network_security_v1.NetworkSecurityClient()

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

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

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

Parameters

request (Union[google.cloud.network_security_v1.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.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response returned by the ListClientTlsPolicies method. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.network_security_v1.services.network_security.pagers.ListClientTlsPoliciesPager

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

Lists information about the supported locations for this service.

Parameters

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

Returns

Response message for ListLocations method.

Return type

ListLocationsResponse

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

Lists operations that match the specified filter in the request.

Parameters

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

Returns

Response message for ListOperations method.

Return type

ListOperationsResponse

list_server_tls_policies(request: Optional[Union[google.cloud.network_security_v1.types.server_tls_policy.ListServerTlsPoliciesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.network_security_v1.services.network_security.pagers.ListServerTlsPoliciesPager[source]¶

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_v1

def sample_list_server_tls_policies():
    # Create a client
    client = network_security_v1.NetworkSecurityClient()

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

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

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

Parameters

request (Union[google.cloud.network_security_v1.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.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

Response returned by the ListServerTlsPolicies method. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.network_security_v1.services.network_security.pagers.ListServerTlsPoliciesPager

static parse_authorization_policy_path(path: str) → Dict[str, str][source]¶: Parses a authorization_policy path into its component segments.

static parse_client_tls_policy_path(path: str) → Dict[str, str][source]¶: Parses a client_tls_policy path into its component segments.

static parse_common_billing_account_path(path: str) → Dict[str, str][source]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str][source]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str][source]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str][source]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str][source]¶: Parse a project path into its component segments.

static parse_server_tls_policy_path(path: str) → Dict[str, str][source]¶: Parses a server_tls_policy path into its component segments.

static server_tls_policy_path(project: str, location: str, server_tls_policy: str) → str[source]¶: Returns a fully-qualified server_tls_policy string.

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

Sets the IAM access control policy on the specified function.

Replaces any existing policy.

Parameters

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

Returns

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.

Return type

Policy

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

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

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

Returns

Response message for TestIamPermissions method.

Return type

TestIamPermissionsResponse

property transport: google.cloud.network_security_v1.services.network_security.transports.base.NetworkSecurityTransport¶

Returns the transport used by the client instance.

Returns

The transport used by the client: instance.

Return type

NetworkSecurityTransport

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns: The universe domain used by the client instance.
Return type: str

update_authorization_policy(request: Optional[Union[google.cloud.network_security_v1.types.authorization_policy.UpdateAuthorizationPolicyRequest, dict]] = None, *, authorization_policy: Optional[google.cloud.network_security_v1.types.authorization_policy.AuthorizationPolicy] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

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_v1

def sample_update_authorization_policy():
    # Create a client
    client = network_security_v1.NetworkSecurityClient()

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

    request = network_security_v1.UpdateAuthorizationPolicyRequest(
        authorization_policy=authorization_policy,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.network_security_v1.types.UpdateAuthorizationPolicyRequest, dict]) – The request object. Request used by the UpdateAuthorizationPolicy method.
authorization_policy (google.cloud.network_security_v1.types.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.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.network_security_v1.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.

Return type

google.api_core.operation.Operation

update_client_tls_policy(request: Optional[Union[google.cloud.network_security_v1.types.client_tls_policy.UpdateClientTlsPolicyRequest, dict]] = None, *, client_tls_policy: Optional[google.cloud.network_security_v1.types.client_tls_policy.ClientTlsPolicy] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

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_v1

def sample_update_client_tls_policy():
    # Create a client
    client = network_security_v1.NetworkSecurityClient()

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

    request = network_security_v1.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 = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.network_security_v1.types.UpdateClientTlsPolicyRequest, dict]) – The request object. Request used by UpdateClientTlsPolicy method.
client_tls_policy (google.cloud.network_security_v1.types.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.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.network_security_v1.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.

Return type

google.api_core.operation.Operation

update_server_tls_policy(request: Optional[Union[google.cloud.network_security_v1.types.server_tls_policy.UpdateServerTlsPolicyRequest, dict]] = None, *, server_tls_policy: Optional[google.cloud.network_security_v1.types.server_tls_policy.ServerTlsPolicy] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation[source]¶

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_v1

def sample_update_server_tls_policy():
    # Create a client
    client = network_security_v1.NetworkSecurityClient()

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

    request = network_security_v1.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 = operation.result()

    # Handle the response
    print(response)

Parameters

request (Union[google.cloud.network_security_v1.types.UpdateServerTlsPolicyRequest, dict]) – The request object. Request used by UpdateServerTlsPolicy method.
server_tls_policy (google.cloud.network_security_v1.types.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.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.network_security_v1.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.

Return type

google.api_core.operation.Operation

class google.cloud.network_security_v1.services.network_security.pagers.ListAuthorizationPoliciesAsyncPager(method: Callable[[...], Awaitable[google.cloud.network_security_v1.types.authorization_policy.ListAuthorizationPoliciesResponse]], request: google.cloud.network_security_v1.types.authorization_policy.ListAuthorizationPoliciesRequest, response: google.cloud.network_security_v1.types.authorization_policy.ListAuthorizationPoliciesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_authorization_policies requests.

This class thinly wraps an initial google.cloud.network_security_v1.types.ListAuthorizationPoliciesResponse object, and provides an __aiter__ method to iterate through its authorization_policies field.

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

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

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.network_security_v1.types.ListAuthorizationPoliciesRequest) – The initial request object.
response (google.cloud.network_security_v1.types.ListAuthorizationPoliciesResponse) – The initial response object.
retry (google.api_core.retry.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.

class google.cloud.network_security_v1.services.network_security.pagers.ListAuthorizationPoliciesPager(method: Callable[[...], google.cloud.network_security_v1.types.authorization_policy.ListAuthorizationPoliciesResponse], request: google.cloud.network_security_v1.types.authorization_policy.ListAuthorizationPoliciesRequest, response: google.cloud.network_security_v1.types.authorization_policy.ListAuthorizationPoliciesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_authorization_policies requests.

This class thinly wraps an initial google.cloud.network_security_v1.types.ListAuthorizationPoliciesResponse object, and provides an __iter__ method to iterate through its authorization_policies field.

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

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

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.network_security_v1.types.ListAuthorizationPoliciesRequest) – The initial request object.
response (google.cloud.network_security_v1.types.ListAuthorizationPoliciesResponse) – The initial response object.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.cloud.network_security_v1.services.network_security.pagers.ListClientTlsPoliciesAsyncPager(method: Callable[[...], Awaitable[google.cloud.network_security_v1.types.client_tls_policy.ListClientTlsPoliciesResponse]], request: google.cloud.network_security_v1.types.client_tls_policy.ListClientTlsPoliciesRequest, response: google.cloud.network_security_v1.types.client_tls_policy.ListClientTlsPoliciesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_client_tls_policies requests.

This class thinly wraps an initial google.cloud.network_security_v1.types.ListClientTlsPoliciesResponse object, and provides an __aiter__ method to iterate through its client_tls_policies field.

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

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

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.network_security_v1.types.ListClientTlsPoliciesRequest) – The initial request object.
response (google.cloud.network_security_v1.types.ListClientTlsPoliciesResponse) – The initial response object.
retry (google.api_core.retry.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.

class google.cloud.network_security_v1.services.network_security.pagers.ListClientTlsPoliciesPager(method: Callable[[...], google.cloud.network_security_v1.types.client_tls_policy.ListClientTlsPoliciesResponse], request: google.cloud.network_security_v1.types.client_tls_policy.ListClientTlsPoliciesRequest, response: google.cloud.network_security_v1.types.client_tls_policy.ListClientTlsPoliciesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_client_tls_policies requests.

This class thinly wraps an initial google.cloud.network_security_v1.types.ListClientTlsPoliciesResponse object, and provides an __iter__ method to iterate through its client_tls_policies field.

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

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

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.network_security_v1.types.ListClientTlsPoliciesRequest) – The initial request object.
response (google.cloud.network_security_v1.types.ListClientTlsPoliciesResponse) – The initial response object.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

class google.cloud.network_security_v1.services.network_security.pagers.ListServerTlsPoliciesAsyncPager(method: Callable[[...], Awaitable[google.cloud.network_security_v1.types.server_tls_policy.ListServerTlsPoliciesResponse]], request: google.cloud.network_security_v1.types.server_tls_policy.ListServerTlsPoliciesRequest, response: google.cloud.network_security_v1.types.server_tls_policy.ListServerTlsPoliciesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_server_tls_policies requests.

This class thinly wraps an initial google.cloud.network_security_v1.types.ListServerTlsPoliciesResponse object, and provides an __aiter__ method to iterate through its server_tls_policies field.

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

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

Instantiates the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.network_security_v1.types.ListServerTlsPoliciesRequest) – The initial request object.
response (google.cloud.network_security_v1.types.ListServerTlsPoliciesResponse) – The initial response object.
retry (google.api_core.retry.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.

class google.cloud.network_security_v1.services.network_security.pagers.ListServerTlsPoliciesPager(method: Callable[[...], google.cloud.network_security_v1.types.server_tls_policy.ListServerTlsPoliciesResponse], request: google.cloud.network_security_v1.types.server_tls_policy.ListServerTlsPoliciesRequest, response: google.cloud.network_security_v1.types.server_tls_policy.ListServerTlsPoliciesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶

A pager for iterating through list_server_tls_policies requests.

This class thinly wraps an initial google.cloud.network_security_v1.types.ListServerTlsPoliciesResponse object, and provides an __iter__ method to iterate through its server_tls_policies field.

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

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

Instantiate the pager.

Parameters

method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.network_security_v1.types.ListServerTlsPoliciesRequest) – The initial request object.
response (google.cloud.network_security_v1.types.ListServerTlsPoliciesResponse) – The initial response object.
retry (google.api_core.retry.Retry) – Designation of what errors, if any, should be retried.
timeout (float) – The timeout for this request.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.

NetworkSecurity¶

google-cloud-network-security

Navigation

Related Topics