RoutersClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.routers.transports.base.RoutersTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)The Routers API.
Inheritance
builtins.object > RoutersClientProperties
transport
Returns the transport used by the client instance.
| Type | Description |
| RoutersTransport | The transport used by the client instance. |
Methods
RoutersClient
RoutersClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.routers.transports.base.RoutersTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)Instantiates the routers client.
| 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, RoutersTransport]
The transport to use. If set to None, a transport is chosen automatically. |
| client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. It won't take effect if a |
| 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 |
| 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!
aggregated_list
aggregated_list(request: Optional[Union[google.cloud.compute_v1.types.compute.AggregatedListRoutersRequest, dict]] = None, *, project: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Retrieves an aggregated list of routers.
| Name | Description |
| request |
Union[google.cloud.compute_v1.types.AggregatedListRoutersRequest, dict]
The request object. A request message for Routers.AggregatedList. See the method description for details. |
| project |
str
Project ID for this request. This corresponds to the |
| retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
| timeout |
float
The timeout for this request. |
| metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Type | Description |
| google.cloud.compute_v1.services.routers.pagers.AggregatedListPager | Contains a list of routers. Iterating over this object will yield results and resolve additional pages automatically. |
common_billing_account_path
common_billing_account_path(billing_account: str)Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)Returns a fully-qualified project string.
delete
delete(request: Optional[Union[google.cloud.compute_v1.types.compute.DeleteRouterRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, router: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Deletes the specified Router resource.
| Name | Description |
| request |
Union[google.cloud.compute_v1.types.DeleteRouterRequest, dict]
The request object. A request message for Routers.Delete. See the method description for details. |
| project |
str
Project ID for this request. This corresponds to the |
| region |
str
Name of the region for this request. This corresponds to the |
| router |
str
Name of the Router resource 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. |
| Type | Description |
| google.api_core.extended_operation.ExtendedOperation | An object representing a extended long-running operation. |
delete_unary
delete_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.DeleteRouterRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, router: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Deletes the specified Router resource.
| Name | Description |
| request |
Union[google.cloud.compute_v1.types.DeleteRouterRequest, dict]
The request object. A request message for Routers.Delete. See the method description for details. |
| project |
str
Project ID for this request. This corresponds to the |
| region |
str
Name of the region for this request. This corresponds to the |
| router |
str
Name of the Router resource 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. |
| 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.
| Name | Description |
| filename |
str
The path to the service account private key json file. |
| Type | Description |
| RoutersClient | 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.
| Name | Description |
| info |
dict
The service account private key info. |
| Type | Description |
| RoutersClient | 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.
| Name | Description |
| filename |
str
The path to the service account private key json file. |
| Type | Description |
| RoutersClient | The constructed client. |
get
get(request: Optional[Union[google.cloud.compute_v1.types.compute.GetRouterRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, router: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Returns the specified Router resource. Gets a list of available routers by making a list() request.
| Name | Description |
| request |
Union[google.cloud.compute_v1.types.GetRouterRequest, dict]
The request object. A request message for Routers.Get. See the method description for details. |
| project |
str
Project ID for this request. This corresponds to the |
| region |
str
Name of the region for this request. This corresponds to the |
| router |
str
Name of the Router resource to return. 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. |
| Type | Description |
| google.cloud.compute_v1.types.Router | Represents a Cloud Router resource. For more information about Cloud Router, read the Cloud Router overview. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: 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 variabel 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.
| Name | Description |
| client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
| Type | Description |
| google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
| Type | Description |
| Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
get_nat_mapping_info
get_nat_mapping_info(request: Optional[Union[google.cloud.compute_v1.types.compute.GetNatMappingInfoRoutersRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, router: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Retrieves runtime Nat mapping information of VM endpoints.
| Name | Description |
| request |
Union[google.cloud.compute_v1.types.GetNatMappingInfoRoutersRequest, dict]
The request object. A request message for Routers.GetNatMappingInfo. See the method description for details. |
| project |
str
Project ID for this request. This corresponds to the |
| region |
str
Name of the region for this request. This corresponds to the |
| router |
str
Name of the Router resource to query for Nat Mapping information of VM endpoints. 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. |
| Type | Description |
| google.cloud.compute_v1.services.routers.pagers.GetNatMappingInfoPager | Contains a list of VmEndpointNatMappings. Iterating over this object will yield results and resolve additional pages automatically. |
get_router_status
get_router_status(request: Optional[Union[google.cloud.compute_v1.types.compute.GetRouterStatusRouterRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, router: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Retrieves runtime information of the specified router.
| Name | Description |
| request |
Union[google.cloud.compute_v1.types.GetRouterStatusRouterRequest, dict]
The request object. A request message for Routers.GetRouterStatus. See the method description for details. |
| project |
str
Project ID for this request. This corresponds to the |
| region |
str
Name of the region for this request. This corresponds to the |
| router |
str
Name of the Router resource to query. 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. |
insert
insert(request: Optional[Union[google.cloud.compute_v1.types.compute.InsertRouterRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, router_resource: Optional[google.cloud.compute_v1.types.compute.Router] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Creates a Router resource in the specified project and region using the data included in the request.
| Name | Description |
| request |
Union[google.cloud.compute_v1.types.InsertRouterRequest, dict]
The request object. A request message for Routers.Insert. See the method description for details. |
| project |
str
Project ID for this request. This corresponds to the |
| region |
str
Name of the region for this request. This corresponds to the |
| router_resource |
google.cloud.compute_v1.types.Router
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. |
| Type | Description |
| google.api_core.extended_operation.ExtendedOperation | An object representing a extended long-running operation. |
insert_unary
insert_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.InsertRouterRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, router_resource: Optional[google.cloud.compute_v1.types.compute.Router] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Creates a Router resource in the specified project and region using the data included in the request.
| Name | Description |
| request |
Union[google.cloud.compute_v1.types.InsertRouterRequest, dict]
The request object. A request message for Routers.Insert. See the method description for details. |
| project |
str
Project ID for this request. This corresponds to the |
| region |
str
Name of the region for this request. This corresponds to the |
| router_resource |
google.cloud.compute_v1.types.Router
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. |
| Type | Description |
| google.api_core.extended_operation.ExtendedOperation | An object representing a extended long-running operation. |
list
list(request: Optional[Union[google.cloud.compute_v1.types.compute.ListRoutersRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Retrieves a list of Router resources available to the specified project.
| Name | Description |
| request |
Union[google.cloud.compute_v1.types.ListRoutersRequest, dict]
The request object. A request message for Routers.List. See the method description for details. |
| project |
str
Project ID for this request. This corresponds to the |
| region |
str
Name of the region 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. |
| Type | Description |
| google.cloud.compute_v1.services.routers.pagers.ListPager | Contains a list of Router resources. 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.
patch
patch(request: Optional[Union[google.cloud.compute_v1.types.compute.PatchRouterRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, router: Optional[str] = None, router_resource: Optional[google.cloud.compute_v1.types.compute.Router] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.
| Name | Description |
| request |
Union[google.cloud.compute_v1.types.PatchRouterRequest, dict]
The request object. A request message for Routers.Patch. See the method description for details. |
| project |
str
Project ID for this request. This corresponds to the |
| region |
str
Name of the region for this request. This corresponds to the |
| router |
str
Name of the Router resource to patch. This corresponds to the |
| router_resource |
google.cloud.compute_v1.types.Router
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. |
| Type | Description |
| google.api_core.extended_operation.ExtendedOperation | An object representing a extended long-running operation. |
patch_unary
patch_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.PatchRouterRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, router: Optional[str] = None, router_resource: Optional[google.cloud.compute_v1.types.compute.Router] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.
| Name | Description |
| request |
Union[google.cloud.compute_v1.types.PatchRouterRequest, dict]
The request object. A request message for Routers.Patch. See the method description for details. |
| project |
str
Project ID for this request. This corresponds to the |
| region |
str
Name of the region for this request. This corresponds to the |
| router |
str
Name of the Router resource to patch. This corresponds to the |
| router_resource |
google.cloud.compute_v1.types.Router
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. |
| Type | Description |
| google.api_core.extended_operation.ExtendedOperation | An object representing a extended long-running operation. |
preview
preview(request: Optional[Union[google.cloud.compute_v1.types.compute.PreviewRouterRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, router: Optional[str] = None, router_resource: Optional[google.cloud.compute_v1.types.compute.Router] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.
| Name | Description |
| request |
Union[google.cloud.compute_v1.types.PreviewRouterRequest, dict]
The request object. A request message for Routers.Preview. See the method description for details. |
| project |
str
Project ID for this request. This corresponds to the |
| region |
str
Name of the region for this request. This corresponds to the |
| router |
str
Name of the Router resource to query. This corresponds to the |
| router_resource |
google.cloud.compute_v1.types.Router
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. |
update
update(request: Optional[Union[google.cloud.compute_v1.types.compute.UpdateRouterRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, router: Optional[str] = None, router_resource: Optional[google.cloud.compute_v1.types.compute.Router] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload.
| Name | Description |
| request |
Union[google.cloud.compute_v1.types.UpdateRouterRequest, dict]
The request object. A request message for Routers.Update. See the method description for details. |
| project |
str
Project ID for this request. This corresponds to the |
| region |
str
Name of the region for this request. This corresponds to the |
| router |
str
Name of the Router resource to update. This corresponds to the |
| router_resource |
google.cloud.compute_v1.types.Router
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. |
| Type | Description |
| google.api_core.extended_operation.ExtendedOperation | An object representing a extended long-running operation. |
update_unary
update_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.UpdateRouterRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, router: Optional[str] = None, router_resource: Optional[google.cloud.compute_v1.types.compute.Router] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload.
| Name | Description |
| request |
Union[google.cloud.compute_v1.types.UpdateRouterRequest, dict]
The request object. A request message for Routers.Update. See the method description for details. |
| project |
str
Project ID for this request. This corresponds to the |
| region |
str
Name of the region for this request. This corresponds to the |
| router |
str
Name of the Router resource to update. This corresponds to the |
| router_resource |
google.cloud.compute_v1.types.Router
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. |
| Type | Description |
| google.api_core.extended_operation.ExtendedOperation | An object representing a extended long-running operation. |