OrganizationSecurityPoliciesClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.compute_v1beta.services.organization_security_policies.transports.base.OrganizationSecurityPoliciesTransport, typing.Callable[[...], google.cloud.compute_v1beta.services.organization_security_policies.transports.base.OrganizationSecurityPoliciesTransport]]] = 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 OrganizationSecurityPolicies 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 |
OrganizationSecurityPoliciesTransport |
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
OrganizationSecurityPoliciesClient
OrganizationSecurityPoliciesClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.compute_v1beta.services.organization_security_policies.transports.base.OrganizationSecurityPoliciesTransport, typing.Callable[[...], google.cloud.compute_v1beta.services.organization_security_policies.transports.base.OrganizationSecurityPoliciesTransport]]] = 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 organization 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,OrganizationSecurityPoliciesTransport,Callable[..., OrganizationSecurityPoliciesTransport]]]
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 OrganizationSecurityPoliciesTransport 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_association
add_association(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1beta.types.compute.AddAssociationOrganizationSecurityPolicyRequest,
dict,
]
] = None,
*,
security_policy: typing.Optional[str] = None,
security_policy_association_resource: typing.Optional[
google.cloud.compute_v1beta.types.compute.SecurityPolicyAssociation
] = 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 an association for the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.addAssociation instead if possible.
# 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_v1beta
def sample_add_association():
# Create a client
client = compute_v1beta.OrganizationSecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1beta.AddAssociationOrganizationSecurityPolicyRequest(
security_policy="security_policy_value",
)
# Make the request
response = client.add_association(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1beta.types.AddAssociationOrganizationSecurityPolicyRequest, dict]
The request object. A request message for OrganizationSecurityPolicies.AddAssociation. See the method description for details. |
security_policy |
str
Name of the security policy to update. This corresponds to the |
security_policy_association_resource |
google.cloud.compute_v1beta.types.SecurityPolicyAssociation
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_association_unary
add_association_unary(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1beta.types.compute.AddAssociationOrganizationSecurityPolicyRequest,
dict,
]
] = None,
*,
security_policy: typing.Optional[str] = None,
security_policy_association_resource: typing.Optional[
google.cloud.compute_v1beta.types.compute.SecurityPolicyAssociation
] = 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_v1beta.types.compute.Operation
Inserts an association for the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.addAssociation instead if possible.
# 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_v1beta
def sample_add_association():
# Create a client
client = compute_v1beta.OrganizationSecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1beta.AddAssociationOrganizationSecurityPolicyRequest(
security_policy="security_policy_value",
)
# Make the request
response = client.add_association(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1beta.types.AddAssociationOrganizationSecurityPolicyRequest, dict]
The request object. A request message for OrganizationSecurityPolicies.AddAssociation. See the method description for details. |
security_policy |
str
Name of the security policy to update. This corresponds to the |
security_policy_association_resource |
google.cloud.compute_v1beta.types.SecurityPolicyAssociation
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
add_rule(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1beta.types.compute.AddRuleOrganizationSecurityPolicyRequest,
dict,
]
] = None,
*,
security_policy: typing.Optional[str] = None,
security_policy_rule_resource: typing.Optional[
google.cloud.compute_v1beta.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_v1beta
def sample_add_rule():
# Create a client
client = compute_v1beta.OrganizationSecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1beta.AddRuleOrganizationSecurityPolicyRequest(
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_v1beta.types.AddRuleOrganizationSecurityPolicyRequest, dict]
The request object. A request message for OrganizationSecurityPolicies.AddRule. See the method description for details. |
security_policy |
str
Name of the security policy to update. This corresponds to the |
security_policy_rule_resource |
google.cloud.compute_v1beta.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_v1beta.types.compute.AddRuleOrganizationSecurityPolicyRequest,
dict,
]
] = None,
*,
security_policy: typing.Optional[str] = None,
security_policy_rule_resource: typing.Optional[
google.cloud.compute_v1beta.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_v1beta.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_v1beta
def sample_add_rule():
# Create a client
client = compute_v1beta.OrganizationSecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1beta.AddRuleOrganizationSecurityPolicyRequest(
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_v1beta.types.AddRuleOrganizationSecurityPolicyRequest, dict]
The request object. A request message for OrganizationSecurityPolicies.AddRule. See the method description for details. |
security_policy |
str
Name of the security policy to update. This corresponds to the |
security_policy_rule_resource |
google.cloud.compute_v1beta.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. |
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.
copy_rules
copy_rules(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1beta.types.compute.CopyRulesOrganizationSecurityPolicyRequest,
dict,
]
] = 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
Copies rules to the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.copyRules 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_v1beta
def sample_copy_rules():
# Create a client
client = compute_v1beta.OrganizationSecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1beta.CopyRulesOrganizationSecurityPolicyRequest(
security_policy="security_policy_value",
)
# Make the request
response = client.copy_rules(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1beta.types.CopyRulesOrganizationSecurityPolicyRequest, dict]
The request object. A request message for OrganizationSecurityPolicies.CopyRules. See the method description for details. |
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. |
copy_rules_unary
copy_rules_unary(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1beta.types.compute.CopyRulesOrganizationSecurityPolicyRequest,
dict,
]
] = 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_v1beta.types.compute.Operation
Copies rules to the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.copyRules 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_v1beta
def sample_copy_rules():
# Create a client
client = compute_v1beta.OrganizationSecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1beta.CopyRulesOrganizationSecurityPolicyRequest(
security_policy="security_policy_value",
)
# Make the request
response = client.copy_rules(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1beta.types.CopyRulesOrganizationSecurityPolicyRequest, dict]
The request object. A request message for OrganizationSecurityPolicies.CopyRules. See the method description for details. |
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. |
delete
delete(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1beta.types.compute.DeleteOrganizationSecurityPolicyRequest,
dict,
]
] = 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. Use of this API to remove firewall policies is deprecated. Use firewallPolicies.delete 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_v1beta
def sample_delete():
# Create a client
client = compute_v1beta.OrganizationSecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1beta.DeleteOrganizationSecurityPolicyRequest(
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_v1beta.types.DeleteOrganizationSecurityPolicyRequest, dict]
The request object. A request message for OrganizationSecurityPolicies.Delete. See the method description for details. |
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_v1beta.types.compute.DeleteOrganizationSecurityPolicyRequest,
dict,
]
] = 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_v1beta.types.compute.Operation
Deletes the specified policy. Use of this API to remove firewall policies is deprecated. Use firewallPolicies.delete 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_v1beta
def sample_delete():
# Create a client
client = compute_v1beta.OrganizationSecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1beta.DeleteOrganizationSecurityPolicyRequest(
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_v1beta.types.DeleteOrganizationSecurityPolicyRequest, dict]
The request object. A request message for OrganizationSecurityPolicies.Delete. See the method description for details. |
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 |
OrganizationSecurityPoliciesClient |
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 |
OrganizationSecurityPoliciesClient |
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 |
OrganizationSecurityPoliciesClient |
The constructed client. |
get
get(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1beta.types.compute.GetOrganizationSecurityPolicyRequest,
dict,
]
] = 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_v1beta.types.compute.SecurityPolicy
List all of the ordered rules present in a single specified policy. Use of this API to read firewall policies is deprecated. Use firewallPolicies.get 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_v1beta
def sample_get():
# Create a client
client = compute_v1beta.OrganizationSecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1beta.GetOrganizationSecurityPolicyRequest(
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_v1beta.types.GetOrganizationSecurityPolicyRequest, dict]
The request object. A request message for OrganizationSecurityPolicies.Get. See the method description for details. |
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_v1beta.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_association
get_association(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1beta.types.compute.GetAssociationOrganizationSecurityPolicyRequest,
dict,
]
] = 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_v1beta.types.compute.SecurityPolicyAssociation
Gets an association with the specified name. Use of this API to read firewall policies is deprecated. Use firewallPolicies.getAssociation instead if possible.
# 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_v1beta
def sample_get_association():
# Create a client
client = compute_v1beta.OrganizationSecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1beta.GetAssociationOrganizationSecurityPolicyRequest(
security_policy="security_policy_value",
)
# Make the request
response = client.get_association(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1beta.types.GetAssociationOrganizationSecurityPolicyRequest, dict]
The request object. A request message for OrganizationSecurityPolicies.GetAssociation. See the method description for details. |
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 |
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_v1beta.types.compute.GetRuleOrganizationSecurityPolicyRequest,
dict,
]
] = 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_v1beta.types.compute.SecurityPolicyRule
Gets a rule at the specified priority. Use of this API to read firewall policies is deprecated. Use firewallPolicies.getRule 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_v1beta
def sample_get_rule():
# Create a client
client = compute_v1beta.OrganizationSecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1beta.GetRuleOrganizationSecurityPolicyRequest(
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_v1beta.types.GetRuleOrganizationSecurityPolicyRequest, dict]
The request object. A request message for OrganizationSecurityPolicies.GetRule. See the method description for details. |
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_v1beta.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_v1beta.types.compute.InsertOrganizationSecurityPolicyRequest,
dict,
]
] = None,
*,
security_policy_resource: typing.Optional[
google.cloud.compute_v1beta.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. Use of this API to insert firewall policies is deprecated. Use firewallPolicies.insert 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_v1beta
def sample_insert():
# Create a client
client = compute_v1beta.OrganizationSecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1beta.InsertOrganizationSecurityPolicyRequest(
)
# Make the request
response = client.insert(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1beta.types.InsertOrganizationSecurityPolicyRequest, dict]
The request object. A request message for OrganizationSecurityPolicies.Insert. See the method description for details. |
security_policy_resource |
google.cloud.compute_v1beta.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_v1beta.types.compute.InsertOrganizationSecurityPolicyRequest,
dict,
]
] = None,
*,
security_policy_resource: typing.Optional[
google.cloud.compute_v1beta.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_v1beta.types.compute.Operation
Creates a new policy in the specified project using the data included in the request. Use of this API to insert firewall policies is deprecated. Use firewallPolicies.insert 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_v1beta
def sample_insert():
# Create a client
client = compute_v1beta.OrganizationSecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1beta.InsertOrganizationSecurityPolicyRequest(
)
# Make the request
response = client.insert(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1beta.types.InsertOrganizationSecurityPolicyRequest, dict]
The request object. A request message for OrganizationSecurityPolicies.Insert. See the method description for details. |
security_policy_resource |
google.cloud.compute_v1beta.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_v1beta.types.compute.ListOrganizationSecurityPoliciesRequest,
dict,
]
] = 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_v1beta.services.organization_security_policies.pagers.ListPager
)
List all the policies that have been configured for the specified project. Use of this API to read firewall policies is deprecated. Use firewallPolicies.list 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_v1beta
def sample_list():
# Create a client
client = compute_v1beta.OrganizationSecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1beta.ListOrganizationSecurityPoliciesRequest(
)
# 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_v1beta.types.ListOrganizationSecurityPoliciesRequest, dict]
The request object. A request message for OrganizationSecurityPolicies.List. See the method description for details. |
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_v1beta.services.organization_security_policies.pagers.ListPager |
Iterating over this object will yield results and resolve additional pages automatically. |
list_associations
list_associations(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1beta.types.compute.ListAssociationsOrganizationSecurityPolicyRequest,
dict,
]
] = 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_v1beta.types.compute.OrganizationSecurityPoliciesListAssociationsResponse
)
Lists associations of a specified target, i.e., organization or folder. Use of this API to read firewall policies is deprecated. Use firewallPolicies.listAssociations instead if possible.
# 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_v1beta
def sample_list_associations():
# Create a client
client = compute_v1beta.OrganizationSecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1beta.ListAssociationsOrganizationSecurityPolicyRequest(
)
# Make the request
response = client.list_associations(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1beta.types.ListAssociationsOrganizationSecurityPolicyRequest, dict]
The request object. A request message for OrganizationSecurityPolicies.ListAssociations. See the method description for details. |
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 |
list_preconfigured_expression_sets
list_preconfigured_expression_sets(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1beta.types.compute.ListPreconfiguredExpressionSetsOrganizationSecurityPoliciesRequest,
dict,
]
] = 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_v1beta.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_v1beta
def sample_list_preconfigured_expression_sets():
# Create a client
client = compute_v1beta.OrganizationSecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1beta.ListPreconfiguredExpressionSetsOrganizationSecurityPoliciesRequest(
)
# Make the request
response = client.list_preconfigured_expression_sets(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1beta.types.ListPreconfiguredExpressionSetsOrganizationSecurityPoliciesRequest, dict]
The request object. A request message for OrganizationSecurityPolicies.ListPreconfiguredExpressionSets. See the method description for details. |
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 |
move
move(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1beta.types.compute.MoveOrganizationSecurityPolicyRequest,
dict,
]
] = 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
Moves the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.move 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_v1beta
def sample_move():
# Create a client
client = compute_v1beta.OrganizationSecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1beta.MoveOrganizationSecurityPolicyRequest(
security_policy="security_policy_value",
)
# Make the request
response = client.move(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1beta.types.MoveOrganizationSecurityPolicyRequest, dict]
The request object. A request message for OrganizationSecurityPolicies.Move. See the method description for details. |
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. |
move_unary
move_unary(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1beta.types.compute.MoveOrganizationSecurityPolicyRequest,
dict,
]
] = 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_v1beta.types.compute.Operation
Moves the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.move 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_v1beta
def sample_move():
# Create a client
client = compute_v1beta.OrganizationSecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1beta.MoveOrganizationSecurityPolicyRequest(
security_policy="security_policy_value",
)
# Make the request
response = client.move(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1beta.types.MoveOrganizationSecurityPolicyRequest, dict]
The request object. A request message for OrganizationSecurityPolicies.Move. See the method description for details. |
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. |
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_v1beta.types.compute.PatchOrganizationSecurityPolicyRequest,
dict,
]
] = None,
*,
security_policy: typing.Optional[str] = None,
security_policy_resource: typing.Optional[
google.cloud.compute_v1beta.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. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patch 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_v1beta
def sample_patch():
# Create a client
client = compute_v1beta.OrganizationSecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1beta.PatchOrganizationSecurityPolicyRequest(
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_v1beta.types.PatchOrganizationSecurityPolicyRequest, dict]
The request object. A request message for OrganizationSecurityPolicies.Patch. See the method description for details. |
security_policy |
str
Name of the security policy to update. This corresponds to the |
security_policy_resource |
google.cloud.compute_v1beta.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_v1beta.types.compute.PatchRuleOrganizationSecurityPolicyRequest,
dict,
]
] = None,
*,
security_policy: typing.Optional[str] = None,
security_policy_rule_resource: typing.Optional[
google.cloud.compute_v1beta.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. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patchRule 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_v1beta
def sample_patch_rule():
# Create a client
client = compute_v1beta.OrganizationSecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1beta.PatchRuleOrganizationSecurityPolicyRequest(
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_v1beta.types.PatchRuleOrganizationSecurityPolicyRequest, dict]
The request object. A request message for OrganizationSecurityPolicies.PatchRule. See the method description for details. |
security_policy |
str
Name of the security policy to update. This corresponds to the |
security_policy_rule_resource |
google.cloud.compute_v1beta.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_v1beta.types.compute.PatchRuleOrganizationSecurityPolicyRequest,
dict,
]
] = None,
*,
security_policy: typing.Optional[str] = None,
security_policy_rule_resource: typing.Optional[
google.cloud.compute_v1beta.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_v1beta.types.compute.Operation
Patches a rule at the specified priority. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patchRule 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_v1beta
def sample_patch_rule():
# Create a client
client = compute_v1beta.OrganizationSecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1beta.PatchRuleOrganizationSecurityPolicyRequest(
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_v1beta.types.PatchRuleOrganizationSecurityPolicyRequest, dict]
The request object. A request message for OrganizationSecurityPolicies.PatchRule. See the method description for details. |
security_policy |
str
Name of the security policy to update. This corresponds to the |
security_policy_rule_resource |
google.cloud.compute_v1beta.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_v1beta.types.compute.PatchOrganizationSecurityPolicyRequest,
dict,
]
] = None,
*,
security_policy: typing.Optional[str] = None,
security_policy_resource: typing.Optional[
google.cloud.compute_v1beta.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_v1beta.types.compute.Operation
Patches the specified policy with the data included in the request. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.patch 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_v1beta
def sample_patch():
# Create a client
client = compute_v1beta.OrganizationSecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1beta.PatchOrganizationSecurityPolicyRequest(
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_v1beta.types.PatchOrganizationSecurityPolicyRequest, dict]
The request object. A request message for OrganizationSecurityPolicies.Patch. See the method description for details. |
security_policy |
str
Name of the security policy to update. This corresponds to the |
security_policy_resource |
google.cloud.compute_v1beta.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_association
remove_association(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1beta.types.compute.RemoveAssociationOrganizationSecurityPolicyRequest,
dict,
]
] = 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
Removes an association for the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.removeAssociation instead if possible.
# 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_v1beta
def sample_remove_association():
# Create a client
client = compute_v1beta.OrganizationSecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1beta.RemoveAssociationOrganizationSecurityPolicyRequest(
security_policy="security_policy_value",
)
# Make the request
response = client.remove_association(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1beta.types.RemoveAssociationOrganizationSecurityPolicyRequest, dict]
The request object. A request message for OrganizationSecurityPolicies.RemoveAssociation. See the method description for details. |
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_association_unary
remove_association_unary(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1beta.types.compute.RemoveAssociationOrganizationSecurityPolicyRequest,
dict,
]
] = 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_v1beta.types.compute.Operation
Removes an association for the specified security policy. Use of this API to modify firewall policies is deprecated. Use firewallPolicies.removeAssociation instead if possible.
# 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_v1beta
def sample_remove_association():
# Create a client
client = compute_v1beta.OrganizationSecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1beta.RemoveAssociationOrganizationSecurityPolicyRequest(
security_policy="security_policy_value",
)
# Make the request
response = client.remove_association(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1beta.types.RemoveAssociationOrganizationSecurityPolicyRequest, dict]
The request object. A request message for OrganizationSecurityPolicies.RemoveAssociation. See the method description for details. |
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
remove_rule(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1beta.types.compute.RemoveRuleOrganizationSecurityPolicyRequest,
dict,
]
] = 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_v1beta
def sample_remove_rule():
# Create a client
client = compute_v1beta.OrganizationSecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1beta.RemoveRuleOrganizationSecurityPolicyRequest(
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_v1beta.types.RemoveRuleOrganizationSecurityPolicyRequest, dict]
The request object. A request message for OrganizationSecurityPolicies.RemoveRule. See the method description for details. |
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_v1beta.types.compute.RemoveRuleOrganizationSecurityPolicyRequest,
dict,
]
] = 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_v1beta.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_v1beta
def sample_remove_rule():
# Create a client
client = compute_v1beta.OrganizationSecurityPoliciesClient()
# Initialize request argument(s)
request = compute_v1beta.RemoveRuleOrganizationSecurityPolicyRequest(
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_v1beta.types.RemoveRuleOrganizationSecurityPolicyRequest, dict]
The request object. A request message for OrganizationSecurityPolicies.RemoveRule. See the method description for details. |
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. |