FirewallPoliciesClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.compute_v1.services.firewall_policies.transports.base.FirewallPoliciesTransport, typing.Callable[[...], google.cloud.compute_v1.services.firewall_policies.transports.base.FirewallPoliciesTransport]]] = 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 FirewallPolicies 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 |
FirewallPoliciesTransport |
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
FirewallPoliciesClient
FirewallPoliciesClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.compute_v1.services.firewall_policies.transports.base.FirewallPoliciesTransport, typing.Callable[[...], google.cloud.compute_v1.services.firewall_policies.transports.base.FirewallPoliciesTransport]]] = 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 firewall 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,FirewallPoliciesTransport,Callable[..., FirewallPoliciesTransport]]]
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 FirewallPoliciesTransport 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_v1.types.compute.AddAssociationFirewallPolicyRequest,
dict,
]
] = None,
*,
firewall_policy: typing.Optional[str] = None,
firewall_policy_association_resource: typing.Optional[
google.cloud.compute_v1.types.compute.FirewallPolicyAssociation
] = 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, str]] = ()
) -> google.api_core.extended_operation.ExtendedOperation
Inserts an association for the specified firewall 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_association():
# Create a client
client = compute_v1.FirewallPoliciesClient()
# Initialize request argument(s)
request = compute_v1.AddAssociationFirewallPolicyRequest(
firewall_policy="firewall_policy_value",
)
# Make the request
response = client.add_association(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.AddAssociationFirewallPolicyRequest, dict]
The request object. A request message for FirewallPolicies.AddAssociation. See the method description for details. |
firewall_policy |
str
Name of the firewall policy to update. This corresponds to the |
firewall_policy_association_resource |
google.cloud.compute_v1.types.FirewallPolicyAssociation
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, str]]
Strings which should be sent along with the request as metadata. |
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_v1.types.compute.AddAssociationFirewallPolicyRequest,
dict,
]
] = None,
*,
firewall_policy: typing.Optional[str] = None,
firewall_policy_association_resource: typing.Optional[
google.cloud.compute_v1.types.compute.FirewallPolicyAssociation
] = 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, str]] = ()
) -> google.cloud.compute_v1.types.compute.Operation
Inserts an association for the specified firewall 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_association():
# Create a client
client = compute_v1.FirewallPoliciesClient()
# Initialize request argument(s)
request = compute_v1.AddAssociationFirewallPolicyRequest(
firewall_policy="firewall_policy_value",
)
# Make the request
response = client.add_association(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.AddAssociationFirewallPolicyRequest, dict]
The request object. A request message for FirewallPolicies.AddAssociation. See the method description for details. |
firewall_policy |
str
Name of the firewall policy to update. This corresponds to the |
firewall_policy_association_resource |
google.cloud.compute_v1.types.FirewallPolicyAssociation
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, str]]
Strings which should be sent along with the request as metadata. |
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_v1.types.compute.AddRuleFirewallPolicyRequest, dict
]
] = None,
*,
firewall_policy: typing.Optional[str] = None,
firewall_policy_rule_resource: typing.Optional[
google.cloud.compute_v1.types.compute.FirewallPolicyRule
] = 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, str]] = ()
) -> google.api_core.extended_operation.ExtendedOperation
Inserts a rule into a firewall 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.FirewallPoliciesClient()
# Initialize request argument(s)
request = compute_v1.AddRuleFirewallPolicyRequest(
firewall_policy="firewall_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.AddRuleFirewallPolicyRequest, dict]
The request object. A request message for FirewallPolicies.AddRule. See the method description for details. |
firewall_policy |
str
Name of the firewall policy to update. This corresponds to the |
firewall_policy_rule_resource |
google.cloud.compute_v1.types.FirewallPolicyRule
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, str]]
Strings which should be sent along with the request as metadata. |
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.AddRuleFirewallPolicyRequest, dict
]
] = None,
*,
firewall_policy: typing.Optional[str] = None,
firewall_policy_rule_resource: typing.Optional[
google.cloud.compute_v1.types.compute.FirewallPolicyRule
] = 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, str]] = ()
) -> google.cloud.compute_v1.types.compute.Operation
Inserts a rule into a firewall 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.FirewallPoliciesClient()
# Initialize request argument(s)
request = compute_v1.AddRuleFirewallPolicyRequest(
firewall_policy="firewall_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.AddRuleFirewallPolicyRequest, dict]
The request object. A request message for FirewallPolicies.AddRule. See the method description for details. |
firewall_policy |
str
Name of the firewall policy to update. This corresponds to the |
firewall_policy_rule_resource |
google.cloud.compute_v1.types.FirewallPolicyRule
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, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.extended_operation.ExtendedOperation |
An object representing a extended long-running operation. |
clone_rules
clone_rules(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.CloneRulesFirewallPolicyRequest, dict
]
] = None,
*,
firewall_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, str]] = ()
) -> google.api_core.extended_operation.ExtendedOperation
Copies rules to the specified firewall 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_clone_rules():
# Create a client
client = compute_v1.FirewallPoliciesClient()
# Initialize request argument(s)
request = compute_v1.CloneRulesFirewallPolicyRequest(
firewall_policy="firewall_policy_value",
)
# Make the request
response = client.clone_rules(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.CloneRulesFirewallPolicyRequest, dict]
The request object. A request message for FirewallPolicies.CloneRules. See the method description for details. |
firewall_policy |
str
Name of the firewall 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, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.extended_operation.ExtendedOperation |
An object representing a extended long-running operation. |
clone_rules_unary
clone_rules_unary(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.CloneRulesFirewallPolicyRequest, dict
]
] = None,
*,
firewall_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, str]] = ()
) -> google.cloud.compute_v1.types.compute.Operation
Copies rules to the specified firewall 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_clone_rules():
# Create a client
client = compute_v1.FirewallPoliciesClient()
# Initialize request argument(s)
request = compute_v1.CloneRulesFirewallPolicyRequest(
firewall_policy="firewall_policy_value",
)
# Make the request
response = client.clone_rules(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.CloneRulesFirewallPolicyRequest, dict]
The request object. A request message for FirewallPolicies.CloneRules. See the method description for details. |
firewall_policy |
str
Name of the firewall 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, str]]
Strings which should be sent along with the request as metadata. |
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.
delete
delete(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.DeleteFirewallPolicyRequest, dict
]
] = None,
*,
firewall_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, str]] = ()
) -> 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.FirewallPoliciesClient()
# Initialize request argument(s)
request = compute_v1.DeleteFirewallPolicyRequest(
firewall_policy="firewall_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.DeleteFirewallPolicyRequest, dict]
The request object. A request message for FirewallPolicies.Delete. See the method description for details. |
firewall_policy |
str
Name of the firewall 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, str]]
Strings which should be sent along with the request as metadata. |
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.DeleteFirewallPolicyRequest, dict
]
] = None,
*,
firewall_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, str]] = ()
) -> 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.FirewallPoliciesClient()
# Initialize request argument(s)
request = compute_v1.DeleteFirewallPolicyRequest(
firewall_policy="firewall_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.DeleteFirewallPolicyRequest, dict]
The request object. A request message for FirewallPolicies.Delete. See the method description for details. |
firewall_policy |
str
Name of the firewall 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, str]]
Strings which should be sent along with the request as metadata. |
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 |
FirewallPoliciesClient |
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 |
FirewallPoliciesClient |
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 |
FirewallPoliciesClient |
The constructed client. |
get
get(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.GetFirewallPolicyRequest, dict
]
] = None,
*,
firewall_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, str]] = ()
) -> google.cloud.compute_v1.types.compute.FirewallPolicy
Returns the specified firewall 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.FirewallPoliciesClient()
# Initialize request argument(s)
request = compute_v1.GetFirewallPolicyRequest(
firewall_policy="firewall_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.GetFirewallPolicyRequest, dict]
The request object. A request message for FirewallPolicies.Get. See the method description for details. |
firewall_policy |
str
Name of the firewall 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, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.compute_v1.types.FirewallPolicy |
Represents a Firewall Policy resource. |
get_association
get_association(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.GetAssociationFirewallPolicyRequest,
dict,
]
] = None,
*,
firewall_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, str]] = ()
) -> google.cloud.compute_v1.types.compute.FirewallPolicyAssociation
Gets an association with the specified name.
# 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_association():
# Create a client
client = compute_v1.FirewallPoliciesClient()
# Initialize request argument(s)
request = compute_v1.GetAssociationFirewallPolicyRequest(
firewall_policy="firewall_policy_value",
)
# Make the request
response = client.get_association(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.GetAssociationFirewallPolicyRequest, dict]
The request object. A request message for FirewallPolicies.GetAssociation. See the method description for details. |
firewall_policy |
str
Name of the firewall 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, str]]
Strings which should be sent along with the request as metadata. |
get_iam_policy
get_iam_policy(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.GetIamPolicyFirewallPolicyRequest,
dict,
]
] = None,
*,
resource: 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, str]] = ()
) -> google.cloud.compute_v1.types.compute.Policy
Gets the access control policy for a resource. May be empty if no such policy or resource exists.
# 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_iam_policy():
# Create a client
client = compute_v1.FirewallPoliciesClient()
# Initialize request argument(s)
request = compute_v1.GetIamPolicyFirewallPolicyRequest(
resource="resource_value",
)
# Make the request
response = client.get_iam_policy(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.GetIamPolicyFirewallPolicyRequest, dict]
The request object. A request message for FirewallPolicies.GetIamPolicy. See the method description for details. |
resource |
str
Name or id of the 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, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.compute_v1.types.Policy |
An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](\ https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** :literal:\ { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ],="" "etag":="" "bwwwja0yfja=", " version":="" 3="">\ \ **YAML example:** :literal:\ bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01t00:00:00.000z')="" etag:="" bwwwja0yfja="version:">\ \ For a description of IAM and its features, see the [IAM documentation](\ https://cloud.google.com/iam/docs/). |
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.GetRuleFirewallPolicyRequest, dict
]
] = None,
*,
firewall_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, str]] = ()
) -> google.cloud.compute_v1.types.compute.FirewallPolicyRule
Gets a rule of 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.FirewallPoliciesClient()
# Initialize request argument(s)
request = compute_v1.GetRuleFirewallPolicyRequest(
firewall_policy="firewall_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.GetRuleFirewallPolicyRequest, dict]
The request object. A request message for FirewallPolicies.GetRule. See the method description for details. |
firewall_policy |
str
Name of the firewall 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, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.compute_v1.types.FirewallPolicyRule |
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.InsertFirewallPolicyRequest, dict
]
] = None,
*,
parent_id: typing.Optional[str] = None,
firewall_policy_resource: typing.Optional[
google.cloud.compute_v1.types.compute.FirewallPolicy
] = 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, str]] = ()
) -> 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.FirewallPoliciesClient()
# Initialize request argument(s)
request = compute_v1.InsertFirewallPolicyRequest(
parent_id="parent_id_value",
)
# Make the request
response = client.insert(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.InsertFirewallPolicyRequest, dict]
The request object. A request message for FirewallPolicies.Insert. See the method description for details. |
parent_id |
str
Parent ID for this request. The ID can be either be "folders/[FOLDER_ID]" if the parent is a folder or "organizations/[ORGANIZATION_ID]" if the parent is an organization. This corresponds to the |
firewall_policy_resource |
google.cloud.compute_v1.types.FirewallPolicy
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, str]]
Strings which should be sent along with the request as metadata. |
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.InsertFirewallPolicyRequest, dict
]
] = None,
*,
parent_id: typing.Optional[str] = None,
firewall_policy_resource: typing.Optional[
google.cloud.compute_v1.types.compute.FirewallPolicy
] = 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, str]] = ()
) -> 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.FirewallPoliciesClient()
# Initialize request argument(s)
request = compute_v1.InsertFirewallPolicyRequest(
parent_id="parent_id_value",
)
# Make the request
response = client.insert(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.InsertFirewallPolicyRequest, dict]
The request object. A request message for FirewallPolicies.Insert. See the method description for details. |
parent_id |
str
Parent ID for this request. The ID can be either be "folders/[FOLDER_ID]" if the parent is a folder or "organizations/[ORGANIZATION_ID]" if the parent is an organization. This corresponds to the |
firewall_policy_resource |
google.cloud.compute_v1.types.FirewallPolicy
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, str]]
Strings which should be sent along with the request as metadata. |
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.ListFirewallPoliciesRequest, 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, str]] = ()
) -> google.cloud.compute_v1.services.firewall_policies.pagers.ListPager
Lists all the policies that have been configured for the specified folder or organization.
# 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.FirewallPoliciesClient()
# Initialize request argument(s)
request = compute_v1.ListFirewallPoliciesRequest(
)
# 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.ListFirewallPoliciesRequest, dict]
The request object. A request message for FirewallPolicies.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, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.compute_v1.services.firewall_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_v1.types.compute.ListAssociationsFirewallPolicyRequest,
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, str]] = ()
) -> google.cloud.compute_v1.types.compute.FirewallPoliciesListAssociationsResponse
Lists associations of a specified target, i.e., organization or folder.
# 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_associations():
# Create a client
client = compute_v1.FirewallPoliciesClient()
# Initialize request argument(s)
request = compute_v1.ListAssociationsFirewallPolicyRequest(
)
# Make the request
response = client.list_associations(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.ListAssociationsFirewallPolicyRequest, dict]
The request object. A request message for FirewallPolicies.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, str]]
Strings which should be sent along with the request as metadata. |
move
move(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.MoveFirewallPolicyRequest, dict
]
] = None,
*,
firewall_policy: typing.Optional[str] = None,
parent_id: 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, str]] = ()
) -> google.api_core.extended_operation.ExtendedOperation
Moves the specified firewall 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_move():
# Create a client
client = compute_v1.FirewallPoliciesClient()
# Initialize request argument(s)
request = compute_v1.MoveFirewallPolicyRequest(
firewall_policy="firewall_policy_value",
parent_id="parent_id_value",
)
# Make the request
response = client.move(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.MoveFirewallPolicyRequest, dict]
The request object. A request message for FirewallPolicies.Move. See the method description for details. |
firewall_policy |
str
Name of the firewall policy to update. This corresponds to the |
parent_id |
str
The new parent of the firewall policy. The ID can be either be "folders/[FOLDER_ID]" if the parent is a folder or "organizations/[ORGANIZATION_ID]" if the parent is an organization. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.extended_operation.ExtendedOperation |
An object representing a extended long-running operation. |
move_unary
move_unary(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.MoveFirewallPolicyRequest, dict
]
] = None,
*,
firewall_policy: typing.Optional[str] = None,
parent_id: 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, str]] = ()
) -> google.cloud.compute_v1.types.compute.Operation
Moves the specified firewall 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_move():
# Create a client
client = compute_v1.FirewallPoliciesClient()
# Initialize request argument(s)
request = compute_v1.MoveFirewallPolicyRequest(
firewall_policy="firewall_policy_value",
parent_id="parent_id_value",
)
# Make the request
response = client.move(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.MoveFirewallPolicyRequest, dict]
The request object. A request message for FirewallPolicies.Move. See the method description for details. |
firewall_policy |
str
Name of the firewall policy to update. This corresponds to the |
parent_id |
str
The new parent of the firewall policy. The ID can be either be "folders/[FOLDER_ID]" if the parent is a folder or "organizations/[ORGANIZATION_ID]" if the parent is an organization. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.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_v1.types.compute.PatchFirewallPolicyRequest, dict
]
] = None,
*,
firewall_policy: typing.Optional[str] = None,
firewall_policy_resource: typing.Optional[
google.cloud.compute_v1.types.compute.FirewallPolicy
] = 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, str]] = ()
) -> google.api_core.extended_operation.ExtendedOperation
Patches the specified policy with 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_patch():
# Create a client
client = compute_v1.FirewallPoliciesClient()
# Initialize request argument(s)
request = compute_v1.PatchFirewallPolicyRequest(
firewall_policy="firewall_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.PatchFirewallPolicyRequest, dict]
The request object. A request message for FirewallPolicies.Patch. See the method description for details. |
firewall_policy |
str
Name of the firewall policy to update. This corresponds to the |
firewall_policy_resource |
google.cloud.compute_v1.types.FirewallPolicy
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, str]]
Strings which should be sent along with the request as metadata. |
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.PatchRuleFirewallPolicyRequest, dict
]
] = None,
*,
firewall_policy: typing.Optional[str] = None,
firewall_policy_rule_resource: typing.Optional[
google.cloud.compute_v1.types.compute.FirewallPolicyRule
] = 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, str]] = ()
) -> google.api_core.extended_operation.ExtendedOperation
Patches a rule of 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_patch_rule():
# Create a client
client = compute_v1.FirewallPoliciesClient()
# Initialize request argument(s)
request = compute_v1.PatchRuleFirewallPolicyRequest(
firewall_policy="firewall_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.PatchRuleFirewallPolicyRequest, dict]
The request object. A request message for FirewallPolicies.PatchRule. See the method description for details. |
firewall_policy |
str
Name of the firewall policy to update. This corresponds to the |
firewall_policy_rule_resource |
google.cloud.compute_v1.types.FirewallPolicyRule
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, str]]
Strings which should be sent along with the request as metadata. |
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.PatchRuleFirewallPolicyRequest, dict
]
] = None,
*,
firewall_policy: typing.Optional[str] = None,
firewall_policy_rule_resource: typing.Optional[
google.cloud.compute_v1.types.compute.FirewallPolicyRule
] = 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, str]] = ()
) -> google.cloud.compute_v1.types.compute.Operation
Patches a rule of 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_patch_rule():
# Create a client
client = compute_v1.FirewallPoliciesClient()
# Initialize request argument(s)
request = compute_v1.PatchRuleFirewallPolicyRequest(
firewall_policy="firewall_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.PatchRuleFirewallPolicyRequest, dict]
The request object. A request message for FirewallPolicies.PatchRule. See the method description for details. |
firewall_policy |
str
Name of the firewall policy to update. This corresponds to the |
firewall_policy_rule_resource |
google.cloud.compute_v1.types.FirewallPolicyRule
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, str]]
Strings which should be sent along with the request as metadata. |
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.PatchFirewallPolicyRequest, dict
]
] = None,
*,
firewall_policy: typing.Optional[str] = None,
firewall_policy_resource: typing.Optional[
google.cloud.compute_v1.types.compute.FirewallPolicy
] = 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, str]] = ()
) -> google.cloud.compute_v1.types.compute.Operation
Patches the specified policy with 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_patch():
# Create a client
client = compute_v1.FirewallPoliciesClient()
# Initialize request argument(s)
request = compute_v1.PatchFirewallPolicyRequest(
firewall_policy="firewall_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.PatchFirewallPolicyRequest, dict]
The request object. A request message for FirewallPolicies.Patch. See the method description for details. |
firewall_policy |
str
Name of the firewall policy to update. This corresponds to the |
firewall_policy_resource |
google.cloud.compute_v1.types.FirewallPolicy
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, str]]
Strings which should be sent along with the request as metadata. |
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_v1.types.compute.RemoveAssociationFirewallPolicyRequest,
dict,
]
] = None,
*,
firewall_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, str]] = ()
) -> google.api_core.extended_operation.ExtendedOperation
Removes an association for the specified firewall 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_remove_association():
# Create a client
client = compute_v1.FirewallPoliciesClient()
# Initialize request argument(s)
request = compute_v1.RemoveAssociationFirewallPolicyRequest(
firewall_policy="firewall_policy_value",
)
# Make the request
response = client.remove_association(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.RemoveAssociationFirewallPolicyRequest, dict]
The request object. A request message for FirewallPolicies.RemoveAssociation. See the method description for details. |
firewall_policy |
str
Name of the firewall 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, str]]
Strings which should be sent along with the request as metadata. |
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_v1.types.compute.RemoveAssociationFirewallPolicyRequest,
dict,
]
] = None,
*,
firewall_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, str]] = ()
) -> google.cloud.compute_v1.types.compute.Operation
Removes an association for the specified firewall 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_remove_association():
# Create a client
client = compute_v1.FirewallPoliciesClient()
# Initialize request argument(s)
request = compute_v1.RemoveAssociationFirewallPolicyRequest(
firewall_policy="firewall_policy_value",
)
# Make the request
response = client.remove_association(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.RemoveAssociationFirewallPolicyRequest, dict]
The request object. A request message for FirewallPolicies.RemoveAssociation. See the method description for details. |
firewall_policy |
str
Name of the firewall 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, str]]
Strings which should be sent along with the request as metadata. |
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.RemoveRuleFirewallPolicyRequest, dict
]
] = None,
*,
firewall_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, str]] = ()
) -> google.api_core.extended_operation.ExtendedOperation
Deletes a rule of 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.FirewallPoliciesClient()
# Initialize request argument(s)
request = compute_v1.RemoveRuleFirewallPolicyRequest(
firewall_policy="firewall_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.RemoveRuleFirewallPolicyRequest, dict]
The request object. A request message for FirewallPolicies.RemoveRule. See the method description for details. |
firewall_policy |
str
Name of the firewall 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, str]]
Strings which should be sent along with the request as metadata. |
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.RemoveRuleFirewallPolicyRequest, dict
]
] = None,
*,
firewall_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, str]] = ()
) -> google.cloud.compute_v1.types.compute.Operation
Deletes a rule of 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.FirewallPoliciesClient()
# Initialize request argument(s)
request = compute_v1.RemoveRuleFirewallPolicyRequest(
firewall_policy="firewall_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.RemoveRuleFirewallPolicyRequest, dict]
The request object. A request message for FirewallPolicies.RemoveRule. See the method description for details. |
firewall_policy |
str
Name of the firewall 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, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.extended_operation.ExtendedOperation |
An object representing a extended long-running operation. |
set_iam_policy
set_iam_policy(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.SetIamPolicyFirewallPolicyRequest,
dict,
]
] = None,
*,
resource: typing.Optional[str] = None,
global_organization_set_policy_request_resource: typing.Optional[
google.cloud.compute_v1.types.compute.GlobalOrganizationSetPolicyRequest
] = 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, str]] = ()
) -> google.cloud.compute_v1.types.compute.Policy
Sets the access control policy on the specified resource. Replaces any existing 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_set_iam_policy():
# Create a client
client = compute_v1.FirewallPoliciesClient()
# Initialize request argument(s)
request = compute_v1.SetIamPolicyFirewallPolicyRequest(
resource="resource_value",
)
# Make the request
response = client.set_iam_policy(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.SetIamPolicyFirewallPolicyRequest, dict]
The request object. A request message for FirewallPolicies.SetIamPolicy. See the method description for details. |
resource |
str
Name or id of the resource for this request. This corresponds to the |
global_organization_set_policy_request_resource |
google.cloud.compute_v1.types.GlobalOrganizationSetPolicyRequest
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, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.compute_v1.types.Policy |
An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](\ https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** :literal:\ { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ],="" "etag":="" "bwwwja0yfja=", " version":="" 3="">\ \ **YAML example:** :literal:\ bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01t00:00:00.000z')="" etag:="" bwwwja0yfja="version:">\ \ For a description of IAM and its features, see the [IAM documentation](\ https://cloud.google.com/iam/docs/). |
test_iam_permissions
test_iam_permissions(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.TestIamPermissionsFirewallPolicyRequest,
dict,
]
] = None,
*,
resource: typing.Optional[str] = None,
test_permissions_request_resource: typing.Optional[
google.cloud.compute_v1.types.compute.TestPermissionsRequest
] = 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, str]] = ()
) -> google.cloud.compute_v1.types.compute.TestPermissionsResponse
Returns permissions that a caller has on the specified resource.
# 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_test_iam_permissions():
# Create a client
client = compute_v1.FirewallPoliciesClient()
# Initialize request argument(s)
request = compute_v1.TestIamPermissionsFirewallPolicyRequest(
resource="resource_value",
)
# Make the request
response = client.test_iam_permissions(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.TestIamPermissionsFirewallPolicyRequest, dict]
The request object. A request message for FirewallPolicies.TestIamPermissions. See the method description for details. |
resource |
str
Name or id of the resource for this request. This corresponds to the |
test_permissions_request_resource |
google.cloud.compute_v1.types.TestPermissionsRequest
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, str]]
Strings which should be sent along with the request as metadata. |