Class FirewallsClient (1.12.0)

Version 1.12.0

• 1.22.0 (latest)
• 1.21.0
• 1.20.1
• 1.19.2
• 1.18.0
• 1.17.0
• 1.16.1
• 1.15.0
• 1.14.1
• 1.13.0
• 1.12.1
• 1.11.0
• 1.10.1
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.1
• 1.5.2
• 1.4.0
• 1.3.2
• 1.2.0
• 1.1.0
• 1.0.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.2
• 0.3.0
• 0.2.1
• 0.1.0

FirewallsClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.compute_v1.services.firewalls.transports.base.FirewallsTransport]] = 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 Firewalls API.

Properties

transport

Returns the transport used by the client instance.

Returns
Type	Description
FirewallsTransport	The transport used by the client instance.

Methods

FirewallsClient

FirewallsClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.compute_v1.services.firewalls.transports.base.FirewallsTransport]] = 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 firewalls 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, FirewallsTransport] The transport to use. 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. 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.
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 None, then default info will be used. Generally, you only need to set this if you're developing your own client library.

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.

Warning: ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

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.DeleteFirewallRequest, dict]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    firewall: typing.Optional[str] = None,
    retry: typing.Union[
        google.api_core.retry.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 firewall.

Parameters
Name	Description
request	Union[google.cloud.compute_v1.types.DeleteFirewallRequest, dict] The request object. A request message for Firewalls.Delete. See the method description for details.
project	str Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
firewall	str Name of the firewall rule to delete. This corresponds to the firewall field on the request instance; if request is provided, this should not be set.
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.DeleteFirewallRequest, dict]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    firewall: typing.Optional[str] = None,
    retry: typing.Union[
        google.api_core.retry.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 firewall.

Parameters
Name	Description
request	Union[google.cloud.compute_v1.types.DeleteFirewallRequest, dict] The request object. A request message for Firewalls.Delete. See the method description for details.
project	str Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
firewall	str Name of the firewall rule to delete. This corresponds to the firewall field on the request instance; if request is provided, this should not be set.
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
FirewallsClient	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
FirewallsClient	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
FirewallsClient	The constructed client.

get

get(
    request: typing.Optional[
        typing.Union[google.cloud.compute_v1.types.compute.GetFirewallRequest, dict]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    firewall: typing.Optional[str] = None,
    retry: typing.Union[
        google.api_core.retry.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.Firewall

Returns the specified firewall.

Parameters
Name	Description
request	Union[google.cloud.compute_v1.types.GetFirewallRequest, dict] The request object. A request message for Firewalls.Get. See the method description for details.
project	str Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
firewall	str Name of the firewall rule to return. This corresponds to the firewall field on the request instance; if request is provided, this should not be set.
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.Firewall	Represents a Firewall Rule resource. Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment 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 api_endpoint and client_cert_source properties may be used in this method.

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.

insert

insert(
    request: typing.Optional[
        typing.Union[google.cloud.compute_v1.types.compute.InsertFirewallRequest, dict]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    firewall_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.Firewall
    ] = None,
    retry: typing.Union[
        google.api_core.retry.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 firewall rule in the specified project using the data included in the request.

Parameters
Name	Description
request	Union[google.cloud.compute_v1.types.InsertFirewallRequest, dict] The request object. A request message for Firewalls.Insert. See the method description for details.
project	str Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
firewall_resource	google.cloud.compute_v1.types.Firewall The body resource for this request This corresponds to the firewall_resource field on the request instance; if request is provided, this should not be set.
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.InsertFirewallRequest, dict]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    firewall_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.Firewall
    ] = None,
    retry: typing.Union[
        google.api_core.retry.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 firewall rule in the specified project using the data included in the request.

Parameters
Name	Description
request	Union[google.cloud.compute_v1.types.InsertFirewallRequest, dict] The request object. A request message for Firewalls.Insert. See the method description for details.
project	str Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
firewall_resource	google.cloud.compute_v1.types.Firewall The body resource for this request This corresponds to the firewall_resource field on the request instance; if request is provided, this should not be set.
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.ListFirewallsRequest, dict]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    retry: typing.Union[
        google.api_core.retry.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.firewalls.pagers.ListPager

Retrieves the list of firewall rules available to the specified project.

Parameters
Name	Description
request	Union[google.cloud.compute_v1.types.ListFirewallsRequest, dict] The request object. A request message for Firewalls.List. See the method description for details.
project	str Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
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.firewalls.pagers.ListPager	Contains a list of firewalls. Iterating over this object will yield results and resolve additional pages automatically.

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.PatchFirewallRequest, dict]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    firewall: typing.Optional[str] = None,
    firewall_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.Firewall
    ] = None,
    retry: typing.Union[
        google.api_core.retry.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

Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
Name	Description
request	Union[google.cloud.compute_v1.types.PatchFirewallRequest, dict] The request object. A request message for Firewalls.Patch. See the method description for details.
project	str Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
firewall	str Name of the firewall rule to patch. This corresponds to the firewall field on the request instance; if request is provided, this should not be set.
firewall_resource	google.cloud.compute_v1.types.Firewall The body resource for this request This corresponds to the firewall_resource field on the request instance; if request is provided, this should not be set.
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.PatchFirewallRequest, dict]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    firewall: typing.Optional[str] = None,
    firewall_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.Firewall
    ] = None,
    retry: typing.Union[
        google.api_core.retry.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

Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
Name	Description
request	Union[google.cloud.compute_v1.types.PatchFirewallRequest, dict] The request object. A request message for Firewalls.Patch. See the method description for details.
project	str Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
firewall	str Name of the firewall rule to patch. This corresponds to the firewall field on the request instance; if request is provided, this should not be set.
firewall_resource	google.cloud.compute_v1.types.Firewall The body resource for this request This corresponds to the firewall_resource field on the request instance; if request is provided, this should not be set.
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.

update

update(
    request: typing.Optional[
        typing.Union[google.cloud.compute_v1.types.compute.UpdateFirewallRequest, dict]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    firewall: typing.Optional[str] = None,
    firewall_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.Firewall
    ] = None,
    retry: typing.Union[
        google.api_core.retry.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

Updates the specified firewall rule with the data included in the request. Note that all fields will be updated if using PUT, even fields that are not specified. To update individual fields, please use PATCH instead.

Parameters
Name	Description
request	Union[google.cloud.compute_v1.types.UpdateFirewallRequest, dict] The request object. A request message for Firewalls.Update. See the method description for details.
project	str Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
firewall	str Name of the firewall rule to update. This corresponds to the firewall field on the request instance; if request is provided, this should not be set.
firewall_resource	google.cloud.compute_v1.types.Firewall The body resource for this request This corresponds to the firewall_resource field on the request instance; if request is provided, this should not be set.
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.

update_unary

update_unary(
    request: typing.Optional[
        typing.Union[google.cloud.compute_v1.types.compute.UpdateFirewallRequest, dict]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    firewall: typing.Optional[str] = None,
    firewall_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.Firewall
    ] = None,
    retry: typing.Union[
        google.api_core.retry.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

Updates the specified firewall rule with the data included in the request. Note that all fields will be updated if using PUT, even fields that are not specified. To update individual fields, please use PATCH instead.

Parameters
Name	Description
request	Union[google.cloud.compute_v1.types.UpdateFirewallRequest, dict] The request object. A request message for Firewalls.Update. See the method description for details.
project	str Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.
firewall	str Name of the firewall rule to update. This corresponds to the firewall field on the request instance; if request is provided, this should not be set.
firewall_resource	google.cloud.compute_v1.types.Firewall The body resource for this request This corresponds to the firewall_resource field on the request instance; if request is provided, this should not be set.
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.