RegionBackendServicesClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.compute_v1.services.region_backend_services.transports.base.RegionBackendServicesTransport]] = 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 RegionBackendServices API.
Properties
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
RegionBackendServicesTransport | The transport used by the client instance. |
Methods
RegionBackendServicesClient
RegionBackendServicesClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.compute_v1.services.region_backend_services.transports.base.RegionBackendServicesTransport]] = 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 region backend services 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, RegionBackendServicesTransport]
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 |
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.
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.DeleteRegionBackendServiceRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
region: typing.Optional[str] = None,
backend_service: 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 regional BackendService 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_delete():
# Create a client
client = compute_v1.RegionBackendServicesClient()
# Initialize request argument(s)
request = compute_v1.DeleteRegionBackendServiceRequest(
backend_service="backend_service_value",
project="project_value",
region="region_value",
)
# Make the request
response = client.delete(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.DeleteRegionBackendServiceRequest, dict]
The request object. A request message for RegionBackendServices.Delete. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region scoping this request. This corresponds to the |
backend_service |
str
Name of the BackendService 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. |
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.DeleteRegionBackendServiceRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
region: typing.Optional[str] = None,
backend_service: 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 regional BackendService 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_delete():
# Create a client
client = compute_v1.RegionBackendServicesClient()
# Initialize request argument(s)
request = compute_v1.DeleteRegionBackendServiceRequest(
backend_service="backend_service_value",
project="project_value",
region="region_value",
)
# Make the request
response = client.delete(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.DeleteRegionBackendServiceRequest, dict]
The request object. A request message for RegionBackendServices.Delete. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region scoping this request. This corresponds to the |
backend_service |
str
Name of the BackendService 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. |
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 |
RegionBackendServicesClient | 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 |
RegionBackendServicesClient | 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 |
RegionBackendServicesClient | The constructed client. |
get
get(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.GetRegionBackendServiceRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
region: typing.Optional[str] = None,
backend_service: 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.BackendService
Returns the specified regional BackendService 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_get():
# Create a client
client = compute_v1.RegionBackendServicesClient()
# Initialize request argument(s)
request = compute_v1.GetRegionBackendServiceRequest(
backend_service="backend_service_value",
project="project_value",
region="region_value",
)
# Make the request
response = client.get(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.GetRegionBackendServiceRequest, dict]
The request object. A request message for RegionBackendServices.Get. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region scoping this request. This corresponds to the |
backend_service |
str
Name of the BackendService 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. |
Returns | |
---|---|
Type | Description |
google.cloud.compute_v1.types.BackendService | Represents a Backend Service resource. A backend service defines how Google Cloud load balancers distribute traffic. The backend service configuration contains a set of values, such as the protocol used to connect to backends, various distribution and session settings, health checks, and timeouts. These settings provide fine-grained control over how your load balancer behaves. Most of the settings have default values that allow for easy configuration if you need to get started quickly. Backend services in Google Compute Engine can be either regionally or globally scoped. \* [Global](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) \* [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/regionBackendServices) For more information, see Backend Services. |
get_health
get_health(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.GetHealthRegionBackendServiceRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
region: typing.Optional[str] = None,
backend_service: typing.Optional[str] = None,
resource_group_reference_resource: typing.Optional[
google.cloud.compute_v1.types.compute.ResourceGroupReference
] = 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.BackendServiceGroupHealth
Gets the most recent health check results for this regional BackendService.
# 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_health():
# Create a client
client = compute_v1.RegionBackendServicesClient()
# Initialize request argument(s)
request = compute_v1.GetHealthRegionBackendServiceRequest(
backend_service="backend_service_value",
project="project_value",
region="region_value",
)
# Make the request
response = client.get_health(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.GetHealthRegionBackendServiceRequest, dict]
The request object. A request message for RegionBackendServices.GetHealth. See the method description for details. |
project |
str
This corresponds to the |
region |
str
Name of the region scoping this request. This corresponds to the |
backend_service |
str
Name of the BackendService resource for which to get health. This corresponds to the |
resource_group_reference_resource |
google.cloud.compute_v1.types.ResourceGroupReference
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. |
get_iam_policy
get_iam_policy(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.GetIamPolicyRegionBackendServiceRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
region: typing.Optional[str] = None,
resource: 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.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.RegionBackendServicesClient()
# Initialize request argument(s)
request = compute_v1.GetIamPolicyRegionBackendServiceRequest(
project="project_value",
region="region_value",
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.GetIamPolicyRegionBackendServiceRequest, dict]
The request object. A request message for RegionBackendServices.GetIamPolicy. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
The name of the region for this request. This corresponds to the |
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,
)
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. |
insert
insert(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.InsertRegionBackendServiceRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
region: typing.Optional[str] = None,
backend_service_resource: typing.Optional[
google.cloud.compute_v1.types.compute.BackendService
] = 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 regional BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview.
# 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.RegionBackendServicesClient()
# Initialize request argument(s)
request = compute_v1.InsertRegionBackendServiceRequest(
project="project_value",
region="region_value",
)
# Make the request
response = client.insert(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.InsertRegionBackendServiceRequest, dict]
The request object. A request message for RegionBackendServices.Insert. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region scoping this request. This corresponds to the |
backend_service_resource |
google.cloud.compute_v1.types.BackendService
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.InsertRegionBackendServiceRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
region: typing.Optional[str] = None,
backend_service_resource: typing.Optional[
google.cloud.compute_v1.types.compute.BackendService
] = 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 regional BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview.
# 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.RegionBackendServicesClient()
# Initialize request argument(s)
request = compute_v1.InsertRegionBackendServiceRequest(
project="project_value",
region="region_value",
)
# Make the request
response = client.insert(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.InsertRegionBackendServiceRequest, dict]
The request object. A request message for RegionBackendServices.Insert. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region scoping this request. This corresponds to the |
backend_service_resource |
google.cloud.compute_v1.types.BackendService
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.ListRegionBackendServicesRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
region: 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.region_backend_services.pagers.ListPager
Retrieves the list of regional BackendService resources available to the specified project in the given region.
# 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.RegionBackendServicesClient()
# Initialize request argument(s)
request = compute_v1.ListRegionBackendServicesRequest(
project="project_value",
region="region_value",
)
# 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.ListRegionBackendServicesRequest, dict]
The request object. A request message for RegionBackendServices.List. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region scoping 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.services.region_backend_services.pagers.ListPager | Contains a list of BackendService resources. Iterating over this object will yield results and resolve additional pages automatically. |
list_usable
list_usable(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.ListUsableRegionBackendServicesRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
region: 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.region_backend_services.pagers.ListUsablePager
Retrieves an aggregated list of all usable backend services in the specified project in the given region.
# 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_usable():
# Create a client
client = compute_v1.RegionBackendServicesClient()
# Initialize request argument(s)
request = compute_v1.ListUsableRegionBackendServicesRequest(
project="project_value",
region="region_value",
)
# Make the request
page_result = client.list_usable(request=request)
# Handle the response
for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.ListUsableRegionBackendServicesRequest, dict]
The request object. A request message for RegionBackendServices.ListUsable. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region scoping this request. It must be a string that meets the requirements in RFC1035. 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.services.region_backend_services.pagers.ListUsablePager | Contains a list of usable BackendService 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) -> 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.PatchRegionBackendServiceRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
region: typing.Optional[str] = None,
backend_service: typing.Optional[str] = None,
backend_service_resource: typing.Optional[
google.cloud.compute_v1.types.compute.BackendService
] = 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 regional BackendService resource with the data included in the request. For more information, see Understanding backend services This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
# 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.RegionBackendServicesClient()
# Initialize request argument(s)
request = compute_v1.PatchRegionBackendServiceRequest(
backend_service="backend_service_value",
project="project_value",
region="region_value",
)
# Make the request
response = client.patch(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.PatchRegionBackendServiceRequest, dict]
The request object. A request message for RegionBackendServices.Patch. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region scoping this request. This corresponds to the |
backend_service |
str
Name of the BackendService resource to patch. This corresponds to the |
backend_service_resource |
google.cloud.compute_v1.types.BackendService
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.PatchRegionBackendServiceRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
region: typing.Optional[str] = None,
backend_service: typing.Optional[str] = None,
backend_service_resource: typing.Optional[
google.cloud.compute_v1.types.compute.BackendService
] = 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 regional BackendService resource with the data included in the request. For more information, see Understanding backend services This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
# 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.RegionBackendServicesClient()
# Initialize request argument(s)
request = compute_v1.PatchRegionBackendServiceRequest(
backend_service="backend_service_value",
project="project_value",
region="region_value",
)
# Make the request
response = client.patch(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.PatchRegionBackendServiceRequest, dict]
The request object. A request message for RegionBackendServices.Patch. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region scoping this request. This corresponds to the |
backend_service |
str
Name of the BackendService resource to patch. This corresponds to the |
backend_service_resource |
google.cloud.compute_v1.types.BackendService
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. |
set_iam_policy
set_iam_policy(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.SetIamPolicyRegionBackendServiceRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
region: typing.Optional[str] = None,
resource: typing.Optional[str] = None,
region_set_policy_request_resource: typing.Optional[
google.cloud.compute_v1.types.compute.RegionSetPolicyRequest
] = 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.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.RegionBackendServicesClient()
# Initialize request argument(s)
request = compute_v1.SetIamPolicyRegionBackendServiceRequest(
project="project_value",
region="region_value",
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.SetIamPolicyRegionBackendServiceRequest, dict]
The request object. A request message for RegionBackendServices.SetIamPolicy. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
The name of the region for this request. This corresponds to the |
resource |
str
Name or id of the resource for this request. This corresponds to the |
region_set_policy_request_resource |
google.cloud.compute_v1.types.RegionSetPolicyRequest
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/). |
set_security_policy
set_security_policy(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.SetSecurityPolicyRegionBackendServiceRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
region: typing.Optional[str] = None,
backend_service: typing.Optional[str] = None,
security_policy_reference_resource: typing.Optional[
google.cloud.compute_v1.types.compute.SecurityPolicyReference
] = 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
Sets the Google Cloud Armor security policy for the specified backend service. For more information, see Google Cloud Armor Overview
# 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_security_policy():
# Create a client
client = compute_v1.RegionBackendServicesClient()
# Initialize request argument(s)
request = compute_v1.SetSecurityPolicyRegionBackendServiceRequest(
backend_service="backend_service_value",
project="project_value",
region="region_value",
)
# Make the request
response = client.set_security_policy(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.SetSecurityPolicyRegionBackendServiceRequest, dict]
The request object. A request message for RegionBackendServices.SetSecurityPolicy. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region scoping this request. This corresponds to the |
backend_service |
str
Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035. This corresponds to the |
security_policy_reference_resource |
google.cloud.compute_v1.types.SecurityPolicyReference
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. |
set_security_policy_unary
set_security_policy_unary(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.SetSecurityPolicyRegionBackendServiceRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
region: typing.Optional[str] = None,
backend_service: typing.Optional[str] = None,
security_policy_reference_resource: typing.Optional[
google.cloud.compute_v1.types.compute.SecurityPolicyReference
] = 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
Sets the Google Cloud Armor security policy for the specified backend service. For more information, see Google Cloud Armor Overview
# 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_security_policy():
# Create a client
client = compute_v1.RegionBackendServicesClient()
# Initialize request argument(s)
request = compute_v1.SetSecurityPolicyRegionBackendServiceRequest(
backend_service="backend_service_value",
project="project_value",
region="region_value",
)
# Make the request
response = client.set_security_policy(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.SetSecurityPolicyRegionBackendServiceRequest, dict]
The request object. A request message for RegionBackendServices.SetSecurityPolicy. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region scoping this request. This corresponds to the |
backend_service |
str
Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035. This corresponds to the |
security_policy_reference_resource |
google.cloud.compute_v1.types.SecurityPolicyReference
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. |
test_iam_permissions
test_iam_permissions(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.TestIamPermissionsRegionBackendServiceRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
region: typing.Optional[str] = None,
resource: typing.Optional[str] = None,
test_permissions_request_resource: typing.Optional[
google.cloud.compute_v1.types.compute.TestPermissionsRequest
] = 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.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.RegionBackendServicesClient()
# Initialize request argument(s)
request = compute_v1.TestIamPermissionsRegionBackendServiceRequest(
project="project_value",
region="region_value",
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.TestIamPermissionsRegionBackendServiceRequest, dict]
The request object. A request message for RegionBackendServices.TestIamPermissions. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
The name of the region for this request. This corresponds to the |
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. |
update
update(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.UpdateRegionBackendServiceRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
region: typing.Optional[str] = None,
backend_service: typing.Optional[str] = None,
backend_service_resource: typing.Optional[
google.cloud.compute_v1.types.compute.BackendService
] = 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 regional BackendService resource with the data included in the request. For more information, see Backend services overview .
# 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_update():
# Create a client
client = compute_v1.RegionBackendServicesClient()
# Initialize request argument(s)
request = compute_v1.UpdateRegionBackendServiceRequest(
backend_service="backend_service_value",
project="project_value",
region="region_value",
)
# Make the request
response = client.update(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.UpdateRegionBackendServiceRequest, dict]
The request object. A request message for RegionBackendServices.Update. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region scoping this request. This corresponds to the |
backend_service |
str
Name of the BackendService resource to update. This corresponds to the |
backend_service_resource |
google.cloud.compute_v1.types.BackendService
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. |
update_unary
update_unary(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.UpdateRegionBackendServiceRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
region: typing.Optional[str] = None,
backend_service: typing.Optional[str] = None,
backend_service_resource: typing.Optional[
google.cloud.compute_v1.types.compute.BackendService
] = 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 regional BackendService resource with the data included in the request. For more information, see Backend services overview .
# 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_update():
# Create a client
client = compute_v1.RegionBackendServicesClient()
# Initialize request argument(s)
request = compute_v1.UpdateRegionBackendServiceRequest(
backend_service="backend_service_value",
project="project_value",
region="region_value",
)
# Make the request
response = client.update(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.UpdateRegionBackendServiceRequest, dict]
The request object. A request message for RegionBackendServices.Update. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region scoping this request. This corresponds to the |
backend_service |
str
Name of the BackendService resource to update. This corresponds to the |
backend_service_resource |
google.cloud.compute_v1.types.BackendService
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. |