NetworkSecurityAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.network_security_v1.services.network_security.transports.base.NetworkSecurityTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)Network Security API provides resources to configure authentication and authorization policies. Refer to per API resource documentation for more information.
Properties
transport
Returns the transport used by the client instance.
| Returns | |
|---|---|
| Type | Description |
NetworkSecurityTransport | The transport used by the client instance. |
Methods
NetworkSecurityAsyncClient
NetworkSecurityAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.network_security_v1.services.network_security.transports.base.NetworkSecurityTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)Instantiates the network security client.
| Parameters | |
|---|---|
| Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str,
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
ClientOptions
Custom options for the client. It won't take effect if a |
| Exceptions | |
|---|---|
| Type | Description |
google.auth.exceptions.MutualTlsChannelError | If mutual TLS transport creation failed for any reason. |
authorization_policy_path
authorization_policy_path(project: str, location: str, authorization_policy: str)Returns a fully-qualified authorization_policy string.
client_tls_policy_path
client_tls_policy_path(project: str, location: str, client_tls_policy: str)Returns a fully-qualified client_tls_policy string.
common_billing_account_path
common_billing_account_path(billing_account: str)Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)Returns a fully-qualified project string.
create_authorization_policy
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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Creates a new AuthorizationPolicy in a given project and location.
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 | |
|---|---|
| Name | Description |
request |
Union[google.cloud.network_security_v1.types.CreateAuthorizationPolicyRequest, dict]
The request object. Request used by the CreateAuthorizationPolicy method. |
parent |
Required. The parent resource of the AuthorizationPolicy. Must be in the format |
authorization_policy |
AuthorizationPolicy
Required. AuthorizationPolicy resource to be created. This corresponds to the |
authorization_policy_id |
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 |
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 | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be AuthorizationPolicy AuthorizationPolicy is a resource that specifies how a server should authorize incoming connections. This resource in itself does not change the configuration unless it's attached to a target https proxy or endpoint config selector resource. |
create_client_tls_policy
create_client_tls_policy(request: 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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Creates a new ClientTlsPolicy in a given project and location.
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 | |
|---|---|
| Name | Description |
request |
Union[google.cloud.network_security_v1.types.CreateClientTlsPolicyRequest, dict]
The request object. Request used by the CreateClientTlsPolicy method. |
parent |
Required. The parent resource of the ClientTlsPolicy. Must be in the format |
client_tls_policy |
ClientTlsPolicy
Required. ClientTlsPolicy resource to be created. This corresponds to the |
client_tls_policy_id |
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 |
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 | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be ClientTlsPolicy ClientTlsPolicy is a resource that specifies how a client should authenticate connections to backends of a service. This resource itself does not affect configuration unless it is attached to a backend service resource. |
create_server_tls_policy
create_server_tls_policy(request: 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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Creates a new ServerTlsPolicy in a given project and location.
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 | |
|---|---|
| Name | Description |
request |
Union[google.cloud.network_security_v1.types.CreateServerTlsPolicyRequest, dict]
The request object. Request used by the CreateServerTlsPolicy method. |
parent |
Required. The parent resource of the ServerTlsPolicy. Must be in the format |
server_tls_policy |
ServerTlsPolicy
Required. ServerTlsPolicy resource to be created. This corresponds to the |
server_tls_policy_id |
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 |
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 | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be ServerTlsPolicy ServerTlsPolicy is a resource that specifies how a server should authenticate incoming requests. This resource itself does not affect configuration unless it is attached to a target https proxy or endpoint config selector resource. |
delete_authorization_policy
delete_authorization_policy(request: Optional[Union[google.cloud.network_security_v1.types.authorization_policy.DeleteAuthorizationPolicyRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Deletes a single AuthorizationPolicy.
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 | |
|---|---|
| Name | Description |
request |
Union[google.cloud.network_security_v1.types.DeleteAuthorizationPolicyRequest, dict]
The request object. Request used by the DeleteAuthorizationPolicy method. |
name |
Required. A name of the AuthorizationPolicy to delete. Must be in the format |
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 | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
delete_client_tls_policy
delete_client_tls_policy(request: Optional[Union[google.cloud.network_security_v1.types.client_tls_policy.DeleteClientTlsPolicyRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Deletes a single ClientTlsPolicy.
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 | |
|---|---|
| Name | Description |
request |
Union[google.cloud.network_security_v1.types.DeleteClientTlsPolicyRequest, dict]
The request object. Request used by the DeleteClientTlsPolicy method. |
name |
Required. A name of the ClientTlsPolicy to delete. Must be in the format |
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 | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
delete_server_tls_policy
delete_server_tls_policy(request: Optional[Union[google.cloud.network_security_v1.types.server_tls_policy.DeleteServerTlsPolicyRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Deletes a single ServerTlsPolicy.
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 | |
|---|---|
| Name | Description |
request |
Union[google.cloud.network_security_v1.types.DeleteServerTlsPolicyRequest, dict]
The request object. Request used by the DeleteServerTlsPolicy method. |
name |
Required. A name of the ServerTlsPolicy to delete. Must be in the format |
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 | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Parameter | |
|---|---|
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Returns | |
|---|---|
| Type | Description |
NetworkSecurityAsyncClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)Creates an instance of this client using the provided credentials info.
| Parameter | |
|---|---|
| Name | Description |
info |
dict
The service account private key info. |
| Returns | |
|---|---|
| Type | Description |
NetworkSecurityAsyncClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Parameter | |
|---|---|
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Returns | |
|---|---|
| Type | Description |
NetworkSecurityAsyncClient | The constructed client. |
get_authorization_policy
get_authorization_policy(request: Optional[Union[google.cloud.network_security_v1.types.authorization_policy.GetAuthorizationPolicyRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Gets details of a single AuthorizationPolicy.
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 | |
|---|---|
| Name | Description |
request |
Union[google.cloud.network_security_v1.types.GetAuthorizationPolicyRequest, dict]
The request object. Request used by the GetAuthorizationPolicy method. |
name |
Required. A name of the AuthorizationPolicy to get. Must be in the format |
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 | |
|---|---|
| Type | Description |
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. |
get_client_tls_policy
get_client_tls_policy(request: Optional[Union[google.cloud.network_security_v1.types.client_tls_policy.GetClientTlsPolicyRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Gets details of a single ClientTlsPolicy.
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 | |
|---|---|
| Name | Description |
request |
Union[google.cloud.network_security_v1.types.GetClientTlsPolicyRequest, dict]
The request object. Request used by the GetClientTlsPolicy method. |
name |
Required. A name of the ClientTlsPolicy to get. Must be in the format |
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 | |
|---|---|
| Type | Description |
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. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the
default mTLS endpoint; if the environment variabel is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
| Parameter | |
|---|---|
| Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
| Exceptions | |
|---|---|
| Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
| Returns | |
|---|---|
| Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
get_server_tls_policy
get_server_tls_policy(request: Optional[Union[google.cloud.network_security_v1.types.server_tls_policy.GetServerTlsPolicyRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Gets details of a single ServerTlsPolicy.
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 | |
|---|---|
| Name | Description |
request |
Union[google.cloud.network_security_v1.types.GetServerTlsPolicyRequest, dict]
The request object. Request used by the GetServerTlsPolicy method. |
name |
Required. A name of the ServerTlsPolicy to get. Must be in the format |
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 | |
|---|---|
| Type | Description |
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. |
get_transport_class
get_transport_class()Returns an appropriate transport class.
list_authorization_policies
list_authorization_policies(request: Optional[Union[google.cloud.network_security_v1.types.authorization_policy.ListAuthorizationPoliciesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists AuthorizationPolicies in a given project and location.
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 | |
|---|---|
| Name | Description |
request |
Union[google.cloud.network_security_v1.types.ListAuthorizationPoliciesRequest, dict]
The request object. Request used with the ListAuthorizationPolicies method. |
parent |
Required. The project and location from which the AuthorizationPolicies should be listed, specified in the format |
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 | |
|---|---|
| Type | Description |
google.cloud.network_security_v1.services.network_security.pagers.ListAuthorizationPoliciesAsyncPager | Response returned by the ListAuthorizationPolicies method. Iterating over this object will yield results and resolve additional pages automatically. |
list_client_tls_policies
list_client_tls_policies(request: Optional[Union[google.cloud.network_security_v1.types.client_tls_policy.ListClientTlsPoliciesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists ClientTlsPolicies in a given project and location.
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 | |
|---|---|
| Name | Description |
request |
Union[google.cloud.network_security_v1.types.ListClientTlsPoliciesRequest, dict]
The request object. Request used by the ListClientTlsPolicies method. |
parent |
Required. The project and location from which the ClientTlsPolicies should be listed, specified in the format |
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 | |
|---|---|
| Type | Description |
google.cloud.network_security_v1.services.network_security.pagers.ListClientTlsPoliciesAsyncPager | Response returned by the ListClientTlsPolicies method. Iterating over this object will yield results and resolve additional pages automatically. |
list_server_tls_policies
list_server_tls_policies(request: Optional[Union[google.cloud.network_security_v1.types.server_tls_policy.ListServerTlsPoliciesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists ServerTlsPolicies in a given project and location.
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 | |
|---|---|
| Name | Description |
request |
Union[google.cloud.network_security_v1.types.ListServerTlsPoliciesRequest, dict]
The request object. Request used by the ListServerTlsPolicies method. |
parent |
Required. The project and location from which the ServerTlsPolicies should be listed, specified in the format |
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 | |
|---|---|
| Type | Description |
google.cloud.network_security_v1.services.network_security.pagers.ListServerTlsPoliciesAsyncPager | Response returned by the ListServerTlsPolicies method. Iterating over this object will yield results and resolve additional pages automatically. |
parse_authorization_policy_path
parse_authorization_policy_path(path: str)Parses a authorization_policy path into its component segments.
parse_client_tls_policy_path
parse_client_tls_policy_path(path: str)Parses a client_tls_policy path into its component segments.
parse_common_billing_account_path
parse_common_billing_account_path(path: str)Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)Parse a project path into its component segments.
parse_server_tls_policy_path
parse_server_tls_policy_path(path: str)Parses a server_tls_policy path into its component segments.
server_tls_policy_path
server_tls_policy_path(project: str, location: str, server_tls_policy: str)Returns a fully-qualified server_tls_policy string.
update_authorization_policy
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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Updates the parameters of a single AuthorizationPolicy.
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 | |
|---|---|
| Name | Description |
request |
Union[google.cloud.network_security_v1.types.UpdateAuthorizationPolicyRequest, dict]
The request object. Request used by the UpdateAuthorizationPolicy method. |
authorization_policy |
AuthorizationPolicy
Required. Updated AuthorizationPolicy resource. This corresponds to the |
update_mask |
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 |
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 | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be AuthorizationPolicy AuthorizationPolicy is a resource that specifies how a server should authorize incoming connections. This resource in itself does not change the configuration unless it's attached to a target https proxy or endpoint config selector resource. |
update_client_tls_policy
update_client_tls_policy(request: 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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Updates the parameters of a single ClientTlsPolicy.
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 | |
|---|---|
| Name | Description |
request |
Union[google.cloud.network_security_v1.types.UpdateClientTlsPolicyRequest, dict]
The request object. Request used by UpdateClientTlsPolicy method. |
client_tls_policy |
ClientTlsPolicy
Required. Updated ClientTlsPolicy resource. This corresponds to the |
update_mask |
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 |
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 | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be ClientTlsPolicy ClientTlsPolicy is a resource that specifies how a client should authenticate connections to backends of a service. This resource itself does not affect configuration unless it is attached to a backend service resource. |
update_server_tls_policy
update_server_tls_policy(request: 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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Updates the parameters of a single ServerTlsPolicy.
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 | |
|---|---|
| Name | Description |
request |
Union[google.cloud.network_security_v1.types.UpdateServerTlsPolicyRequest, dict]
The request object. Request used by UpdateServerTlsPolicy method. |
server_tls_policy |
ServerTlsPolicy
Required. Updated ServerTlsPolicy resource. This corresponds to the |
update_mask |
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 |
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 | |
|---|---|
| Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be ServerTlsPolicy ServerTlsPolicy is a resource that specifies how a server should authenticate incoming requests. This resource itself does not affect configuration unless it is attached to a target https proxy or endpoint config selector resource. |