Class FirewallAsyncClient (0.1.0)

FirewallAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.appengine_admin_v1.services.firewall.transports.base.FirewallTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-appengine-admin/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Firewall resources are used to define a collection of access control rules for an Application. Each rule is defined with a position which specifies the rule's order in the sequence of rules, an IP range to be matched against requests, and an action to take upon matching requests. Every request is evaluated against the Firewall rules in priority order. Processesing stops at the first rule which matches the request's IP address. A final rule always specifies an action that applies to all remaining IP addresses. The default final rule for a newly-created application will be set to "allow" if not otherwise specified by the user.

Properties

transport

Return the transport used by the client instance.

Returns

Type	Description
`FirewallTransport`	The transport used by the client instance.

Methods

FirewallAsyncClient

FirewallAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.appengine_admin_v1.services.firewall.transports.base.FirewallTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-appengine-admin/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiate the firewall client.

Parameters

Name	Description
`credentials`	`Optional[google.auth.credentials.Credentials]` The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
`transport`	`Union[str, .FirewallTransport]` The transport to use. If set to None, a transport is chosen automatically.
`client_options`	`ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.

Exceptions

Type	Description
`google.auth.exceptions.MutualTlsChannelError`	If mutual TLS transport creation failed for any reason.

batch_update_ingress_rules

batch_update_ingress_rules(request: Optional[google.cloud.appengine_admin_v1.types.appengine.BatchUpdateIngressRulesRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Replaces the entire firewall ruleset in one bulk operation. This overrides and replaces the rules of an existing firewall with the new rules.

If the final rule does not match traffic with the '*' wildcard IP range, then an "allow all" rule is explicitly added to the end of the list.

Parameters

Name	Description
`request`	`BatchUpdateIngressRulesRequest` The request object. Request message for `Firewall.BatchUpdateIngressRules`.
`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.appengine_admin_v1.types.BatchUpdateIngressRulesResponse`	Response message for Firewall.UpdateAllIngressRules.

common_billing_account_path

common_billing_account_path(billing_account: str)

Return a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Return a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Return a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Return a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Return a fully-qualified project string.

create_ingress_rule

create_ingress_rule(request: Optional[google.cloud.appengine_admin_v1.types.appengine.CreateIngressRuleRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a firewall rule for the application.

Parameters

Name	Description
`request`	`CreateIngressRuleRequest` The request object. Request message for `Firewall.CreateIngressRule`.
`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.appengine_admin_v1.types.FirewallRule`	A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.

delete_ingress_rule

delete_ingress_rule(request: Optional[google.cloud.appengine_admin_v1.types.appengine.DeleteIngressRuleRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes the specified firewall rule.

Parameters

Name	Description
`request`	`DeleteIngressRuleRequest` The request object. Request message for `Firewall.DeleteIngressRule`.
`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.

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
`FirewallAsyncClient`	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
`FirewallAsyncClient`	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
`FirewallAsyncClient`	The constructed client.

get_ingress_rule

get_ingress_rule(request: Optional[google.cloud.appengine_admin_v1.types.appengine.GetIngressRuleRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets the specified firewall rule.

Parameters

Name	Description
`request`	`GetIngressRuleRequest` The request object. Request message for `Firewall.GetIngressRule`.
`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.appengine_admin_v1.types.FirewallRule`	A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.

get_transport_class

get_transport_class()

Return an appropriate transport class.

list_ingress_rules

list_ingress_rules(request: Optional[google.cloud.appengine_admin_v1.types.appengine.ListIngressRulesRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists the firewall rules of an application.

Parameters

Name	Description
`request`	`ListIngressRulesRequest` The request object. Request message for `Firewall.ListIngressRules`.
`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.appengine_admin_v1.services.firewall.pagers.ListIngressRulesAsyncPager`	Response message for Firewall.ListIngressRules. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

update_ingress_rule

update_ingress_rule(request: Optional[google.cloud.appengine_admin_v1.types.appengine.UpdateIngressRuleRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates the specified firewall rule.

Parameters

Name	Description
`request`	`UpdateIngressRuleRequest` The request object. Request message for `Firewall.UpdateIngressRule`.
`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.appengine_admin_v1.types.FirewallRule`	A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.