SecurityPoliciesClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.compute_v1.services.security_policies.transports.base.SecurityPoliciesTransport, typing.Callable[[...], google.cloud.compute_v1.services.security_policies.transports.base.SecurityPoliciesTransport]]] = 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>)
The SecurityPolicies API.
Properties
api_endpoint
Return the API endpoint used by the client instance.
Returns | |
---|---|
Type | Description |
str |
The API endpoint used by the client instance. |
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
SecurityPoliciesTransport |
The transport used by the client instance. |
universe_domain
Return the universe domain used by the client instance.
Returns | |
---|---|
Type | Description |
str |
The universe domain used by the client instance. |
Methods
SecurityPoliciesClient
SecurityPoliciesClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.compute_v1.services.security_policies.transports.base.SecurityPoliciesTransport, typing.Callable[[...], google.cloud.compute_v1.services.security_policies.transports.base.SecurityPoliciesTransport]]] = 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>)
Instantiates the security policies client.
Parameters | |
---|---|
Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Optional[Union[str,SecurityPoliciesTransport,Callable[..., SecurityPoliciesTransport]]]
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 SecurityPoliciesTransport constructor. If set to None, a transport is chosen automatically. NOTE: "rest" transport functionality is currently in a beta state (preview). We welcome your feedback via an issue in this library's source repository. |
client_options |
Optional[Union[google.api_core.client_options.ClientOptions, dict]]
Custom options for the client. 1. The |
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 |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError |
If mutual TLS transport creation failed for any reason. |
__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
add_rule
add_rule(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.AddRuleSecurityPolicyRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
security_policy: typing.Optional[str] = None,
security_policy_rule_resource: typing.Optional[
google.cloud.compute_v1.types.compute.SecurityPolicyRule
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.extended_operation.ExtendedOperation
Inserts a rule into a security policy.
# 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 compute_v1
def sample_add_rule():
# Create a client
client = compute_v1.SecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1.AddRuleSecurityPolicyRequest(
project="project_value",
security_policy="security_policy_value",
)
# Make the request
response = client.add_rule(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.AddRuleSecurityPolicyRequest, dict]
The request object. A request message for SecurityPolicies.AddRule. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
security_policy |
str
Name of the security policy to update. This corresponds to the |
security_policy_rule_resource |
google.cloud.compute_v1.types.SecurityPolicyRule
The body resource for this request 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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
Returns | |
---|---|
Type | Description |
google.api_core.extended_operation.ExtendedOperation |
An object representing a extended long-running operation. |
add_rule_unary
add_rule_unary(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.AddRuleSecurityPolicyRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
security_policy: typing.Optional[str] = None,
security_policy_rule_resource: typing.Optional[
google.cloud.compute_v1.types.compute.SecurityPolicyRule
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.compute_v1.types.compute.Operation
Inserts a rule into a security policy.
# 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 compute_v1
def sample_add_rule():
# Create a client
client = compute_v1.SecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1.AddRuleSecurityPolicyRequest(
project="project_value",
security_policy="security_policy_value",
)
# Make the request
response = client.add_rule(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.AddRuleSecurityPolicyRequest, dict]
The request object. A request message for SecurityPolicies.AddRule. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
security_policy |
str
Name of the security policy to update. This corresponds to the |
security_policy_rule_resource |
google.cloud.compute_v1.types.SecurityPolicyRule
The body resource for this request 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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
Returns | |
---|---|
Type | Description |
google.api_core.extended_operation.ExtendedOperation |
An object representing a extended long-running operation. |
aggregated_list
aggregated_list(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.AggregatedListSecurityPoliciesRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.compute_v1.services.security_policies.pagers.AggregatedListPager
Retrieves the list of all SecurityPolicy resources, regional and
global, available to the specified project. To prevent failure,
Google recommends that you set the returnPartialSuccess
parameter to true
.
# 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 compute_v1
def sample_aggregated_list():
# Create a client
client = compute_v1.SecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1.AggregatedListSecurityPoliciesRequest(
project="project_value",
)
# Make the request
page_result = client.aggregated_list(request=request)
# Handle the response
for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.AggregatedListSecurityPoliciesRequest, dict]
The request object. A request message for SecurityPolicies.AggregatedList. See the method description for details. |
project |
str
Name of the project scoping this request. 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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
Returns | |
---|---|
Type | Description |
google.cloud.compute_v1.services.security_policies.pagers.AggregatedListPager |
Iterating over this object will yield results and resolve additional pages automatically. |
common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
delete
delete(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.DeleteSecurityPolicyRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
security_policy: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.extended_operation.ExtendedOperation
Deletes the specified policy.
# 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 compute_v1
def sample_delete():
# Create a client
client = compute_v1.SecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1.DeleteSecurityPolicyRequest(
project="project_value",
security_policy="security_policy_value",
)
# Make the request
response = client.delete(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.DeleteSecurityPolicyRequest, dict]
The request object. A request message for SecurityPolicies.Delete. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
security_policy |
str
Name of the security policy to delete. 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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
Returns | |
---|---|
Type | Description |
google.api_core.extended_operation.ExtendedOperation |
An object representing a extended long-running operation. |
delete_unary
delete_unary(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.DeleteSecurityPolicyRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
security_policy: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.compute_v1.types.compute.Operation
Deletes the specified policy.
# 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 compute_v1
def sample_delete():
# Create a client
client = compute_v1.SecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1.DeleteSecurityPolicyRequest(
project="project_value",
security_policy="security_policy_value",
)
# Make the request
response = client.delete(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.DeleteSecurityPolicyRequest, dict]
The request object. A request message for SecurityPolicies.Delete. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
security_policy |
str
Name of the security policy to delete. 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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
Returns | |
---|---|
Type | Description |
google.api_core.extended_operation.ExtendedOperation |
An object representing a extended long-running operation. |
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 |
SecurityPoliciesClient |
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 |
SecurityPoliciesClient |
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 |
SecurityPoliciesClient |
The constructed client. |
get
get(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.GetSecurityPolicyRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
security_policy: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.compute_v1.types.compute.SecurityPolicy
List all of the ordered rules present in a single specified policy.
# 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 compute_v1
def sample_get():
# Create a client
client = compute_v1.SecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1.GetSecurityPolicyRequest(
project="project_value",
security_policy="security_policy_value",
)
# Make the request
response = client.get(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.GetSecurityPolicyRequest, dict]
The request object. A request message for SecurityPolicies.Get. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
security_policy |
str
Name of the security policy to get. 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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
Returns | |
---|---|
Type | Description |
google.cloud.compute_v1.types.SecurityPolicy |
Represents a Google Cloud Armor security policy resource. Only external backend services that use load balancers can reference a security policy. For more information, see Google Cloud Armor security policy overview. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated. Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source
is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint
if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is "always", use the
default mTLS endpoint; if the environment variable is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
Parameter | |
---|---|
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
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_rule
get_rule(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.GetRuleSecurityPolicyRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
security_policy: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.compute_v1.types.compute.SecurityPolicyRule
Gets a rule at the specified priority.
# 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 compute_v1
def sample_get_rule():
# Create a client
client = compute_v1.SecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1.GetRuleSecurityPolicyRequest(
project="project_value",
security_policy="security_policy_value",
)
# Make the request
response = client.get_rule(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.GetRuleSecurityPolicyRequest, dict]
The request object. A request message for SecurityPolicies.GetRule. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
security_policy |
str
Name of the security policy to which the queried rule belongs. 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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
Returns | |
---|---|
Type | Description |
google.cloud.compute_v1.types.SecurityPolicyRule |
Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). |
insert
insert(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.InsertSecurityPolicyRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
security_policy_resource: typing.Optional[
google.cloud.compute_v1.types.compute.SecurityPolicy
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.extended_operation.ExtendedOperation
Creates a new policy in the specified project using the data included in the request.
# 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 compute_v1
def sample_insert():
# Create a client
client = compute_v1.SecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1.InsertSecurityPolicyRequest(
project="project_value",
)
# Make the request
response = client.insert(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.InsertSecurityPolicyRequest, dict]
The request object. A request message for SecurityPolicies.Insert. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
security_policy_resource |
google.cloud.compute_v1.types.SecurityPolicy
The body resource for this request 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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
Returns | |
---|---|
Type | Description |
google.api_core.extended_operation.ExtendedOperation |
An object representing a extended long-running operation. |
insert_unary
insert_unary(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.InsertSecurityPolicyRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
security_policy_resource: typing.Optional[
google.cloud.compute_v1.types.compute.SecurityPolicy
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.compute_v1.types.compute.Operation
Creates a new policy in the specified project using the data included in the request.
# 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 compute_v1
def sample_insert():
# Create a client
client = compute_v1.SecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1.InsertSecurityPolicyRequest(
project="project_value",
)
# Make the request
response = client.insert(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.InsertSecurityPolicyRequest, dict]
The request object. A request message for SecurityPolicies.Insert. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
security_policy_resource |
google.cloud.compute_v1.types.SecurityPolicy
The body resource for this request 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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
Returns | |
---|---|
Type | Description |
google.api_core.extended_operation.ExtendedOperation |
An object representing a extended long-running operation. |
list
list(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.ListSecurityPoliciesRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.compute_v1.services.security_policies.pagers.ListPager
List all the policies that have been configured for the specified project.
# 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 compute_v1
def sample_list():
# Create a client
client = compute_v1.SecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1.ListSecurityPoliciesRequest(
project="project_value",
)
# Make the request
page_result = client.list(request=request)
# Handle the response
for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.ListSecurityPoliciesRequest, dict]
The request object. A request message for SecurityPolicies.List. See the method description for details. |
project |
str
Project ID for this request. 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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
Returns | |
---|---|
Type | Description |
google.cloud.compute_v1.services.security_policies.pagers.ListPager |
Iterating over this object will yield results and resolve additional pages automatically. |
list_preconfigured_expression_sets
list_preconfigured_expression_sets(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.ListPreconfiguredExpressionSetsSecurityPoliciesRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.compute_v1.types.compute.SecurityPoliciesListPreconfiguredExpressionSetsResponse
)
Gets the current list of preconfigured Web Application Firewall (WAF) expressions.
# 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 compute_v1
def sample_list_preconfigured_expression_sets():
# Create a client
client = compute_v1.SecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1.ListPreconfiguredExpressionSetsSecurityPoliciesRequest(
project="project_value",
)
# Make the request
response = client.list_preconfigured_expression_sets(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.ListPreconfiguredExpressionSetsSecurityPoliciesRequest, dict]
The request object. A request message for SecurityPolicies.ListPreconfiguredExpressionSets. See the method description for details. |
project |
str
Project ID for this request. 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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
patch
patch(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.PatchSecurityPolicyRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
security_policy: typing.Optional[str] = None,
security_policy_resource: typing.Optional[
google.cloud.compute_v1.types.compute.SecurityPolicy
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.extended_operation.ExtendedOperation
Patches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.
# 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 compute_v1
def sample_patch():
# Create a client
client = compute_v1.SecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1.PatchSecurityPolicyRequest(
project="project_value",
security_policy="security_policy_value",
)
# Make the request
response = client.patch(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.PatchSecurityPolicyRequest, dict]
The request object. A request message for SecurityPolicies.Patch. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
security_policy |
str
Name of the security policy to update. This corresponds to the |
security_policy_resource |
google.cloud.compute_v1.types.SecurityPolicy
The body resource for this request 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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
Returns | |
---|---|
Type | Description |
google.api_core.extended_operation.ExtendedOperation |
An object representing a extended long-running operation. |
patch_rule
patch_rule(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.PatchRuleSecurityPolicyRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
security_policy: typing.Optional[str] = None,
security_policy_rule_resource: typing.Optional[
google.cloud.compute_v1.types.compute.SecurityPolicyRule
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.extended_operation.ExtendedOperation
Patches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask.
# 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 compute_v1
def sample_patch_rule():
# Create a client
client = compute_v1.SecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1.PatchRuleSecurityPolicyRequest(
project="project_value",
security_policy="security_policy_value",
)
# Make the request
response = client.patch_rule(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.PatchRuleSecurityPolicyRequest, dict]
The request object. A request message for SecurityPolicies.PatchRule. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
security_policy |
str
Name of the security policy to update. This corresponds to the |
security_policy_rule_resource |
google.cloud.compute_v1.types.SecurityPolicyRule
The body resource for this request 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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
Returns | |
---|---|
Type | Description |
google.api_core.extended_operation.ExtendedOperation |
An object representing a extended long-running operation. |
patch_rule_unary
patch_rule_unary(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.PatchRuleSecurityPolicyRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
security_policy: typing.Optional[str] = None,
security_policy_rule_resource: typing.Optional[
google.cloud.compute_v1.types.compute.SecurityPolicyRule
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.compute_v1.types.compute.Operation
Patches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask.
# 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 compute_v1
def sample_patch_rule():
# Create a client
client = compute_v1.SecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1.PatchRuleSecurityPolicyRequest(
project="project_value",
security_policy="security_policy_value",
)
# Make the request
response = client.patch_rule(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.PatchRuleSecurityPolicyRequest, dict]
The request object. A request message for SecurityPolicies.PatchRule. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
security_policy |
str
Name of the security policy to update. This corresponds to the |
security_policy_rule_resource |
google.cloud.compute_v1.types.SecurityPolicyRule
The body resource for this request 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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
Returns | |
---|---|
Type | Description |
google.api_core.extended_operation.ExtendedOperation |
An object representing a extended long-running operation. |
patch_unary
patch_unary(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.PatchSecurityPolicyRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
security_policy: typing.Optional[str] = None,
security_policy_resource: typing.Optional[
google.cloud.compute_v1.types.compute.SecurityPolicy
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.compute_v1.types.compute.Operation
Patches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.
# 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 compute_v1
def sample_patch():
# Create a client
client = compute_v1.SecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1.PatchSecurityPolicyRequest(
project="project_value",
security_policy="security_policy_value",
)
# Make the request
response = client.patch(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.PatchSecurityPolicyRequest, dict]
The request object. A request message for SecurityPolicies.Patch. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
security_policy |
str
Name of the security policy to update. This corresponds to the |
security_policy_resource |
google.cloud.compute_v1.types.SecurityPolicy
The body resource for this request 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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
Returns | |
---|---|
Type | Description |
google.api_core.extended_operation.ExtendedOperation |
An object representing a extended long-running operation. |
remove_rule
remove_rule(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.RemoveRuleSecurityPolicyRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
security_policy: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.extended_operation.ExtendedOperation
Deletes a rule at the specified priority.
# 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 compute_v1
def sample_remove_rule():
# Create a client
client = compute_v1.SecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1.RemoveRuleSecurityPolicyRequest(
project="project_value",
security_policy="security_policy_value",
)
# Make the request
response = client.remove_rule(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.RemoveRuleSecurityPolicyRequest, dict]
The request object. A request message for SecurityPolicies.RemoveRule. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
security_policy |
str
Name of the security policy to update. 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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
Returns | |
---|---|
Type | Description |
google.api_core.extended_operation.ExtendedOperation |
An object representing a extended long-running operation. |
remove_rule_unary
remove_rule_unary(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.RemoveRuleSecurityPolicyRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
security_policy: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.compute_v1.types.compute.Operation
Deletes a rule at the specified priority.
# 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 compute_v1
def sample_remove_rule():
# Create a client
client = compute_v1.SecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1.RemoveRuleSecurityPolicyRequest(
project="project_value",
security_policy="security_policy_value",
)
# Make the request
response = client.remove_rule(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.RemoveRuleSecurityPolicyRequest, dict]
The request object. A request message for SecurityPolicies.RemoveRule. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
security_policy |
str
Name of the security policy to update. 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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
Returns | |
---|---|
Type | Description |
google.api_core.extended_operation.ExtendedOperation |
An object representing a extended long-running operation. |
set_labels
set_labels(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.SetLabelsSecurityPolicyRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
resource: typing.Optional[str] = None,
global_set_labels_request_resource: typing.Optional[
google.cloud.compute_v1.types.compute.GlobalSetLabelsRequest
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.extended_operation.ExtendedOperation
Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation.
# 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 compute_v1
def sample_set_labels():
# Create a client
client = compute_v1.SecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1.SetLabelsSecurityPolicyRequest(
project="project_value",
resource="resource_value",
)
# Make the request
response = client.set_labels(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.SetLabelsSecurityPolicyRequest, dict]
The request object. A request message for SecurityPolicies.SetLabels. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
resource |
str
Name or id of the resource for this request. This corresponds to the |
global_set_labels_request_resource |
google.cloud.compute_v1.types.GlobalSetLabelsRequest
The body resource for this request 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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
Returns | |
---|---|
Type | Description |
google.api_core.extended_operation.ExtendedOperation |
An object representing a extended long-running operation. |
set_labels_unary
set_labels_unary(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.SetLabelsSecurityPolicyRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
resource: typing.Optional[str] = None,
global_set_labels_request_resource: typing.Optional[
google.cloud.compute_v1.types.compute.GlobalSetLabelsRequest
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.compute_v1.types.compute.Operation
Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation.
# 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 compute_v1
def sample_set_labels():
# Create a client
client = compute_v1.SecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1.SetLabelsSecurityPolicyRequest(
project="project_value",
resource="resource_value",
)
# Make the request
response = client.set_labels(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.SetLabelsSecurityPolicyRequest, dict]
The request object. A request message for SecurityPolicies.SetLabels. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
resource |
str
Name or id of the resource for this request. This corresponds to the |
global_set_labels_request_resource |
google.cloud.compute_v1.types.GlobalSetLabelsRequest
The body resource for this request 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, Union[str, bytes]]]
Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type |
Returns | |
---|---|
Type | Description |
google.api_core.extended_operation.ExtendedOperation |
An object representing a extended long-running operation. |