Class RegionBackendServicesClient (1.5.0)

RegionBackendServicesClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.region_backend_services.transports.base.RegionBackendServicesTransport]] = 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 RegionBackendServices API.

Inheritance

builtins.object > RegionBackendServicesClient

Properties

transport

Returns the transport used by the client instance.

Returns
TypeDescription
RegionBackendServicesTransportThe transport used by the client instance.

Methods

RegionBackendServicesClient

RegionBackendServicesClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.region_backend_services.transports.base.RegionBackendServicesTransport]] = 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 region backend services client.

Parameters
NameDescription
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.

client_options google.api_core.client_options.ClientOptions

Custom options for the client. It won't take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.

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
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf 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)

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.DeleteRegionBackendServiceRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, backend_service: 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 regional BackendService resource.

Parameters
NameDescription
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 project field on the request instance; if request is provided, this should not be set.

region str

Name of the region scoping this request. This corresponds to the region field on the request instance; if request is provided, this should not be set.

backend_service str

Name of the BackendService resource to delete. This corresponds to the backend_service 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
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

delete_unary

delete_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.DeleteRegionBackendServiceRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, backend_service: 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 regional BackendService resource.

Parameters
NameDescription
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 project field on the request instance; if request is provided, this should not be set.

region str

Name of the region scoping this request. This corresponds to the region field on the request instance; if request is provided, this should not be set.

backend_service str

Name of the BackendService resource to delete. This corresponds to the backend_service 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
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn 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
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
RegionBackendServicesClientThe 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
NameDescription
info dict

The service account private key info.

Returns
TypeDescription
RegionBackendServicesClientThe 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
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
RegionBackendServicesClientThe constructed client.

get

get(request: Optional[Union[google.cloud.compute_v1.types.compute.GetRegionBackendServiceRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, backend_service: 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 regional BackendService resource.

Parameters
NameDescription
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 project field on the request instance; if request is provided, this should not be set.

region str

Name of the region scoping this request. This corresponds to the region field on the request instance; if request is provided, this should not be set.

backend_service str

Name of the BackendService resource to return. This corresponds to the backend_service 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
TypeDescription
google.cloud.compute_v1.types.BackendServiceRepresents 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: Optional[Union[google.cloud.compute_v1.types.compute.GetHealthRegionBackendServiceRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, backend_service: Optional[str] = None, resource_group_reference_resource: Optional[google.cloud.compute_v1.types.compute.ResourceGroupReference] = 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]] = ())

Gets the most recent health check results for this regional BackendService.

Parameters
NameDescription
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 project field on the request instance; if request is provided, this should not be set.

region str

Name of the region scoping this request. This corresponds to the region field on the request instance; if request is provided, this should not be set.

backend_service str

Name of the BackendService resource for which to get health. This corresponds to the backend_service field on the request instance; if request is provided, this should not be set.

resource_group_reference_resource google.cloud.compute_v1.types.ResourceGroupReference

The body resource for this request This corresponds to the resource_group_reference_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.

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.

Parameter
NameDescription
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
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf any errors happen.
Returns
TypeDescription
Tuple[str, Callable[[], Tuple[bytes, bytes]]]returns the API endpoint and the client cert source to use.

insert

insert(request: Optional[Union[google.cloud.compute_v1.types.compute.InsertRegionBackendServiceRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, backend_service_resource: Optional[google.cloud.compute_v1.types.compute.BackendService] = 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 regional BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview.

Parameters
NameDescription
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 project field on the request instance; if request is provided, this should not be set.

region str

Name of the region scoping this request. This corresponds to the region field on the request instance; if request is provided, this should not be set.

backend_service_resource google.cloud.compute_v1.types.BackendService

The body resource for this request This corresponds to the backend_service_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
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

insert_unary

insert_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.InsertRegionBackendServiceRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, backend_service_resource: Optional[google.cloud.compute_v1.types.compute.BackendService] = 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 regional BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview.

Parameters
NameDescription
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 project field on the request instance; if request is provided, this should not be set.

region str

Name of the region scoping this request. This corresponds to the region field on the request instance; if request is provided, this should not be set.

backend_service_resource google.cloud.compute_v1.types.BackendService

The body resource for this request This corresponds to the backend_service_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
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

list

list(request: Optional[Union[google.cloud.compute_v1.types.compute.ListRegionBackendServicesRequest, 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 the list of regional BackendService resources available to the specified project in the given region.

Parameters
NameDescription
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 project field on the request instance; if request is provided, this should not be set.

region str

Name of the region scoping this request. This corresponds to the region 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
TypeDescription
google.cloud.compute_v1.services.region_backend_services.pagers.ListPagerContains a list of 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)

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.PatchRegionBackendServiceRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, backend_service: Optional[str] = None, backend_service_resource: Optional[google.cloud.compute_v1.types.compute.BackendService] = 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 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.

Parameters
NameDescription
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 project field on the request instance; if request is provided, this should not be set.

region str

Name of the region scoping this request. This corresponds to the region field on the request instance; if request is provided, this should not be set.

backend_service str

Name of the BackendService resource to patch. This corresponds to the backend_service field on the request instance; if request is provided, this should not be set.

backend_service_resource google.cloud.compute_v1.types.BackendService

The body resource for this request This corresponds to the backend_service_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
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

patch_unary

patch_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.PatchRegionBackendServiceRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, backend_service: Optional[str] = None, backend_service_resource: Optional[google.cloud.compute_v1.types.compute.BackendService] = 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 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.

Parameters
NameDescription
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 project field on the request instance; if request is provided, this should not be set.

region str

Name of the region scoping this request. This corresponds to the region field on the request instance; if request is provided, this should not be set.

backend_service str

Name of the BackendService resource to patch. This corresponds to the backend_service field on the request instance; if request is provided, this should not be set.

backend_service_resource google.cloud.compute_v1.types.BackendService

The body resource for this request This corresponds to the backend_service_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
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

update

update(request: Optional[Union[google.cloud.compute_v1.types.compute.UpdateRegionBackendServiceRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, backend_service: Optional[str] = None, backend_service_resource: Optional[google.cloud.compute_v1.types.compute.BackendService] = 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 regional BackendService resource with the data included in the request. For more information, see Backend services overview .

Parameters
NameDescription
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 project field on the request instance; if request is provided, this should not be set.

region str

Name of the region scoping this request. This corresponds to the region field on the request instance; if request is provided, this should not be set.

backend_service str

Name of the BackendService resource to update. This corresponds to the backend_service field on the request instance; if request is provided, this should not be set.

backend_service_resource google.cloud.compute_v1.types.BackendService

The body resource for this request This corresponds to the backend_service_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
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

update_unary

update_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.UpdateRegionBackendServiceRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, backend_service: Optional[str] = None, backend_service_resource: Optional[google.cloud.compute_v1.types.compute.BackendService] = 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 regional BackendService resource with the data included in the request. For more information, see Backend services overview .

Parameters
NameDescription
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 project field on the request instance; if request is provided, this should not be set.

region str

Name of the region scoping this request. This corresponds to the region field on the request instance; if request is provided, this should not be set.

backend_service str

Name of the BackendService resource to update. This corresponds to the backend_service field on the request instance; if request is provided, this should not be set.

backend_service_resource google.cloud.compute_v1.types.BackendService

The body resource for this request This corresponds to the backend_service_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
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.