Class BackendServicesClient (0.2.1)

BackendServicesClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.backend_services.transports.base.BackendServicesTransport]] = 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 BackendServices API.

Properties

transport

Return the transport used by the client instance.

Returns
Type	Description
`BackendServicesTransport`	The transport used by the client instance.

Methods

BackendServicesClient

BackendServicesClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.backend_services.transports.base.BackendServicesTransport]] = 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>)

Instantiate the 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, BackendServicesTransport]` 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
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If mutual TLS transport creation failed for any reason.

add_signed_url_key

add_signed_url_key(request: Optional[google.cloud.compute_v1.types.compute.AddSignedUrlKeyBackendServiceRequest] = None, *, project: Optional[str] = None, backend_service: Optional[str] = None, signed_url_key_resource: Optional[google.cloud.compute_v1.types.compute.SignedUrlKey] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Adds a key for validating requests with signed URLs for this backend service.

Parameters
Name	Description
`request`	`google.cloud.compute_v1.types.AddSignedUrlKeyBackendServiceRequest` The request object. A request message for BackendServices.AddSignedUrlKey. 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.
`backend_service`	`str` Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035. This corresponds to the `backend_service` field on the `request` instance; if `request` is provided, this should not be set.
`signed_url_key_resource`	`google.cloud.compute_v1.types.SignedUrlKey` The body resource for this request This corresponds to the `signed_url_key_resource` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

google.cloud.compute_v1.types.Operation Represents an Operation resource. Google Compute Engine has three Operation resources: - [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) \* [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) \* [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

aggregated_list

aggregated_list(request: Optional[google.cloud.compute_v1.types.compute.AggregatedListBackendServicesRequest] = None, *, project: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Retrieves the list of all BackendService resources, regional and global, available to the specified project.

Parameters
Name	Description
`request`	`google.cloud.compute_v1.types.AggregatedListBackendServicesRequest` The request object. A request message for BackendServices.AggregatedList. See the method description for details.
`project`	`str` Name of the project scoping this request. This corresponds to the `project` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.compute_v1.services.backend_services.pagers.AggregatedListPager`	Contains a list of BackendServicesScopedList. Iterating over this object will yield results and resolve additional pages automatically.

common_billing_account_path

common_billing_account_path(billing_account: str)

Return a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Return a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Return a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Return a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Return a fully-qualified project string.

delete

delete(request: Optional[google.cloud.compute_v1.types.compute.DeleteBackendServiceRequest] = None, *, project: Optional[str] = None, backend_service: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes the specified BackendService resource.

Parameters
Name	Description
`request`	`google.cloud.compute_v1.types.DeleteBackendServiceRequest` The request object. A request message for BackendServices.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.
`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

Type Description

delete_signed_url_key

delete_signed_url_key(request: Optional[google.cloud.compute_v1.types.compute.DeleteSignedUrlKeyBackendServiceRequest] = None, *, project: Optional[str] = None, backend_service: Optional[str] = None, key_name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a key for validating requests with signed URLs for this backend service.

Parameters
Name	Description
`request`	`google.cloud.compute_v1.types.DeleteSignedUrlKeyBackendServiceRequest` The request object. A request message for BackendServices.DeleteSignedUrlKey. 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.
`backend_service`	`str` Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035. This corresponds to the `backend_service` field on the `request` instance; if `request` is provided, this should not be set.
`key_name`	`str` The name of the Signed URL Key to delete. This corresponds to the `key_name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

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

get

get(request: Optional[google.cloud.compute_v1.types.compute.GetBackendServiceRequest] = None, *, project: Optional[str] = None, backend_service: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns the specified BackendService resource. Gets a list of available backend services.

Parameters
Name	Description
`request`	`google.cloud.compute_v1.types.GetBackendServiceRequest` The request object. A request message for BackendServices.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.
`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

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](/compute/docs/reference/rest/{$api_version}/backendServices) \* [Regional](/compute/docs/reference/rest/{$api_version}/regionBackendServices) For more information, see Backend Services. (== resource_for {$api_version}.backendService ==)

get_health

get_health(request: Optional[google.cloud.compute_v1.types.compute.GetHealthBackendServiceRequest] = None, *, project: Optional[str] = None, backend_service: Optional[str] = None, resource_group_reference_resource: Optional[google.cloud.compute_v1.types.compute.ResourceGroupReference] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets the most recent health check results for this BackendService. Example request body:

{ "group": "/zones/us-east1-b/instanceGroups/lb-backend- example" }

Parameters
Name	Description
`request`	`google.cloud.compute_v1.types.GetHealthBackendServiceRequest` The request object. A request message for BackendServices.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.
`backend_service`	`str` Name of the BackendService resource to which the queried instance belongs. 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.

insert

insert(request: Optional[google.cloud.compute_v1.types.compute.InsertBackendServiceRequest] = None, *, project: Optional[str] = None, backend_service_resource: Optional[google.cloud.compute_v1.types.compute.BackendService] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview.

Parameters
Name	Description
`request`	`google.cloud.compute_v1.types.InsertBackendServiceRequest` The request object. A request message for BackendServices.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.
`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

Type Description

list

list(request: Optional[google.cloud.compute_v1.types.compute.ListBackendServicesRequest] = None, *, project: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Retrieves the list of BackendService resources available to the specified project.

Parameters
Name	Description
`request`	`google.cloud.compute_v1.types.ListBackendServicesRequest` The request object. A request message for BackendServices.List. See the method description for details.
`project`	`str` Project ID for this request. This corresponds to the `project` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns
Type	Description
`google.cloud.compute_v1.services.backend_services.pagers.ListPager`	Contains 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[google.cloud.compute_v1.types.compute.PatchBackendServiceRequest] = None, *, project: Optional[str] = None, backend_service: Optional[str] = None, backend_service_resource: Optional[google.cloud.compute_v1.types.compute.BackendService] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Patches the specified BackendService resource with the data included in the request. For more information, see Backend services overview. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Parameters
Name	Description
`request`	`google.cloud.compute_v1.types.PatchBackendServiceRequest` The request object. A request message for BackendServices.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.
`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

Type Description

set_security_policy

set_security_policy(request: Optional[google.cloud.compute_v1.types.compute.SetSecurityPolicyBackendServiceRequest] = None, *, project: Optional[str] = None, backend_service: Optional[str] = None, security_policy_reference_resource: Optional[google.cloud.compute_v1.types.compute.SecurityPolicyReference] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Sets the security policy for the specified backend service.

Parameters
Name	Description
`request`	`google.cloud.compute_v1.types.SetSecurityPolicyBackendServiceRequest` The request object. A request message for BackendServices.SetSecurityPolicy. 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.
`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 `backend_service` field on the `request` instance; if `request` is provided, this should not be set.
`security_policy_reference_resource`	`google.cloud.compute_v1.types.SecurityPolicyReference` The body resource for this request This corresponds to the `security_policy_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.

Returns

Type Description

update

update(request: Optional[google.cloud.compute_v1.types.compute.UpdateBackendServiceRequest] = None, *, project: Optional[str] = None, backend_service: Optional[str] = None, backend_service_resource: Optional[google.cloud.compute_v1.types.compute.BackendService] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates the specified BackendService resource with the data included in the request. For more information, see Backend services overview.

Parameters
Name	Description
`request`	`google.cloud.compute_v1.types.UpdateBackendServiceRequest` The request object. A request message for BackendServices.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.
`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

Type Description