RegionBackendServices¶
- class google.cloud.compute_v1.services.region_backend_services.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, typing.Callable[[...], 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>)[source]¶
The RegionBackendServices API.
Instantiates the region backend services client.
- Parameters
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 (Optional[Union[str,RegionBackendServicesTransport,Callable[..., RegionBackendServicesTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the RegionBackendServicesTransport constructor. 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.
1. The
api_endpoint
property can be used to override the default endpoint provided by the client whentransport
is not explicitly provided. Only if this property is not set andtransport
was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “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).2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the
client_cert_source
property can be used to provide a client certificate for mTLS 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.3. The
universe_domain
property can be used to override the default “googleapis.com” universe. Note that theapi_endpoint
property still takes precedence; anduniverse_domain
is currently not supported for mTLS.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.
- Raises
google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.
- __exit__(type, value, traceback)[source]¶
Releases underlying transport’s resources.
Warning
ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!
- property api_endpoint¶
Return the API endpoint used by the client instance.
- Returns
The API endpoint used by the client instance.
- Return type
- static common_billing_account_path(billing_account: str) str [source]¶
Returns a fully-qualified billing_account string.
- static common_location_path(project: str, location: str) str [source]¶
Returns a fully-qualified location string.
- static common_organization_path(organization: str) str [source]¶
Returns a fully-qualified organization string.
- 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.extended_operation.ExtendedOperation [source]¶
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
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 therequest
instance; ifrequest
is provided, this should not be set.region (str) –
Name of the region scoping this request.
This corresponds to the
region
field on therequest
instance; ifrequest
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 therequest
instance; ifrequest
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
An object representing a extended long-running operation.
- Return type
google.api_core.extended_operation.ExtendedOperation
- 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.compute_v1.types.compute.Operation [source]¶
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
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 therequest
instance; ifrequest
is provided, this should not be set.region (str) –
Name of the region scoping this request.
This corresponds to the
region
field on therequest
instance; ifrequest
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 therequest
instance; ifrequest
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
An object representing a extended long-running operation.
- Return type
google.api_core.extended_operation.ExtendedOperation
- classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
info.
- Parameters
info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_json(filename: str, *args, **kwargs)¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.compute_v1.types.compute.BackendService [source]¶
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
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 therequest
instance; ifrequest
is provided, this should not be set.region (str) –
Name of the region scoping this request.
This corresponds to the
region
field on therequest
instance; ifrequest
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 therequest
instance; ifrequest
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
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.
- Return type
- 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.compute_v1.types.compute.BackendServiceGroupHealth [source]¶
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
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 therequest
instance; ifrequest
is provided, this should not be set.region (str) –
Name of the region scoping this request.
This corresponds to the
region
field on therequest
instance; ifrequest
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 therequest
instance; ifrequest
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 therequest
instance; ifrequest
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.
- Return type
- get_iam_policy(request: Optional[Union[google.cloud.compute_v1.types.compute.GetIamPolicyRegionBackendServiceRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, resource: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.compute_v1.types.compute.Policy [source]¶
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
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
project
field on therequest
instance; ifrequest
is provided, this should not be set.region (str) –
The name of the region for this request.
This corresponds to the
region
field on therequest
instance; ifrequest
is provided, this should not be set.resource (str) –
Name or id of the resource for this request.
This corresponds to the
resource
field on therequest
instance; ifrequest
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
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:
` { "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:` 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: 3
` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).- Return type
- classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶
Deprecated. 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.
- Parameters
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.
- Returns
- returns the API endpoint and the
client cert source to use.
- Return type
- Raises
google.auth.exceptions.MutualTLSChannelError – If any errors happen.
- 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.extended_operation.ExtendedOperation [source]¶
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
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 therequest
instance; ifrequest
is provided, this should not be set.region (str) –
Name of the region scoping this request.
This corresponds to the
region
field on therequest
instance; ifrequest
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 therequest
instance; ifrequest
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
An object representing a extended long-running operation.
- Return type
google.api_core.extended_operation.ExtendedOperation
- 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.compute_v1.types.compute.Operation [source]¶
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
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 therequest
instance; ifrequest
is provided, this should not be set.region (str) –
Name of the region scoping this request.
This corresponds to the
region
field on therequest
instance; ifrequest
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 therequest
instance; ifrequest
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
An object representing a extended long-running operation.
- Return type
google.api_core.extended_operation.ExtendedOperation
- list(request: Optional[Union[google.cloud.compute_v1.types.compute.ListRegionBackendServicesRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.compute_v1.services.region_backend_services.pagers.ListPager [source]¶
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
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 therequest
instance; ifrequest
is provided, this should not be set.region (str) –
Name of the region scoping this request.
This corresponds to the
region
field on therequest
instance; ifrequest
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
Contains a list of BackendService resources. Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.compute_v1.services.region_backend_services.pagers.ListPager
- list_usable(request: Optional[Union[google.cloud.compute_v1.types.compute.ListUsableRegionBackendServicesRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.compute_v1.services.region_backend_services.pagers.ListUsablePager [source]¶
Retrieves a 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
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
project
field on therequest
instance; ifrequest
is provided, this should not be set.region (str) –
Name of the region scoping this request. It must be a string that meets the requirements in RFC1035.
This corresponds to the
region
field on therequest
instance; ifrequest
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
Contains a list of usable BackendService resources. Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.compute_v1.services.region_backend_services.pagers.ListUsablePager
- static parse_common_billing_account_path(path: str) Dict[str, str] [source]¶
Parse a billing_account path into its component segments.
- static parse_common_folder_path(path: str) Dict[str, str] [source]¶
Parse a folder path into its component segments.
- static parse_common_location_path(path: str) Dict[str, str] [source]¶
Parse a location path into its component segments.
- static parse_common_organization_path(path: str) Dict[str, str] [source]¶
Parse a organization path into its component segments.
- static parse_common_project_path(path: str) Dict[str, str] [source]¶
Parse a project path into its component segments.
- 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.extended_operation.ExtendedOperation [source]¶
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
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 therequest
instance; ifrequest
is provided, this should not be set.region (str) –
Name of the region scoping this request.
This corresponds to the
region
field on therequest
instance; ifrequest
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 therequest
instance; ifrequest
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 therequest
instance; ifrequest
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
An object representing a extended long-running operation.
- Return type
google.api_core.extended_operation.ExtendedOperation
- 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.compute_v1.types.compute.Operation [source]¶
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
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 therequest
instance; ifrequest
is provided, this should not be set.region (str) –
Name of the region scoping this request.
This corresponds to the
region
field on therequest
instance; ifrequest
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 therequest
instance; ifrequest
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 therequest
instance; ifrequest
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
An object representing a extended long-running operation.
- Return type
google.api_core.extended_operation.ExtendedOperation
- set_iam_policy(request: Optional[Union[google.cloud.compute_v1.types.compute.SetIamPolicyRegionBackendServiceRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, resource: Optional[str] = None, region_set_policy_request_resource: Optional[google.cloud.compute_v1.types.compute.RegionSetPolicyRequest] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.compute_v1.types.compute.Policy [source]¶
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
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
project
field on therequest
instance; ifrequest
is provided, this should not be set.region (str) –
The name of the region for this request.
This corresponds to the
region
field on therequest
instance; ifrequest
is provided, this should not be set.resource (str) –
Name or id of the resource for this request.
This corresponds to the
resource
field on therequest
instance; ifrequest
is provided, this should not be set.region_set_policy_request_resource (google.cloud.compute_v1.types.RegionSetPolicyRequest) – The body resource for this request This corresponds to the
region_set_policy_request_resource
field on therequest
instance; ifrequest
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
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:
` { "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:` 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: 3
` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).- Return type
- set_security_policy(request: Optional[Union[google.cloud.compute_v1.types.compute.SetSecurityPolicyRegionBackendServiceRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, backend_service: Optional[str] = None, security_policy_reference_resource: Optional[google.cloud.compute_v1.types.compute.SecurityPolicyReference] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.extended_operation.ExtendedOperation [source]¶
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
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
project
field on therequest
instance; ifrequest
is provided, this should not be set.region (str) –
Name of the region scoping this request.
This corresponds to the
region
field on therequest
instance; ifrequest
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 therequest
instance; ifrequest
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 therequest
instance; ifrequest
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
An object representing a extended long-running operation.
- Return type
google.api_core.extended_operation.ExtendedOperation
- set_security_policy_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.SetSecurityPolicyRegionBackendServiceRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, backend_service: Optional[str] = None, security_policy_reference_resource: Optional[google.cloud.compute_v1.types.compute.SecurityPolicyReference] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.compute_v1.types.compute.Operation [source]¶
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
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
project
field on therequest
instance; ifrequest
is provided, this should not be set.region (str) –
Name of the region scoping this request.
This corresponds to the
region
field on therequest
instance; ifrequest
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 therequest
instance; ifrequest
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 therequest
instance; ifrequest
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
An object representing a extended long-running operation.
- Return type
google.api_core.extended_operation.ExtendedOperation
- test_iam_permissions(request: Optional[Union[google.cloud.compute_v1.types.compute.TestIamPermissionsRegionBackendServiceRequest, dict]] = None, *, project: Optional[str] = None, region: Optional[str] = None, resource: Optional[str] = None, test_permissions_request_resource: Optional[google.cloud.compute_v1.types.compute.TestPermissionsRequest] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.compute_v1.types.compute.TestPermissionsResponse [source]¶
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
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
project
field on therequest
instance; ifrequest
is provided, this should not be set.region (str) –
The name of the region for this request.
This corresponds to the
region
field on therequest
instance; ifrequest
is provided, this should not be set.resource (str) –
Name or id of the resource for this request.
This corresponds to the
resource
field on therequest
instance; ifrequest
is provided, this should not be set.test_permissions_request_resource (google.cloud.compute_v1.types.TestPermissionsRequest) – The body resource for this request This corresponds to the
test_permissions_request_resource
field on therequest
instance; ifrequest
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.
- Return type
- property transport: google.cloud.compute_v1.services.region_backend_services.transports.base.RegionBackendServicesTransport¶
Returns the transport used by the client instance.
- Returns
- The transport used by the client
instance.
- Return type
RegionBackendServicesTransport
- property universe_domain: str¶
Return the universe domain used by the client instance.
- Returns
The universe domain used by the client instance.
- Return type
- 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.extended_operation.ExtendedOperation [source]¶
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
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 therequest
instance; ifrequest
is provided, this should not be set.region (str) –
Name of the region scoping this request.
This corresponds to the
region
field on therequest
instance; ifrequest
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 therequest
instance; ifrequest
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 therequest
instance; ifrequest
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
An object representing a extended long-running operation.
- Return type
google.api_core.extended_operation.ExtendedOperation
- 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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.compute_v1.types.compute.Operation [source]¶
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
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 therequest
instance; ifrequest
is provided, this should not be set.region (str) –
Name of the region scoping this request.
This corresponds to the
region
field on therequest
instance; ifrequest
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 therequest
instance; ifrequest
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 therequest
instance; ifrequest
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
An object representing a extended long-running operation.
- Return type
google.api_core.extended_operation.ExtendedOperation
- class google.cloud.compute_v1.services.region_backend_services.pagers.ListPager(method: Callable[[...], google.cloud.compute_v1.types.compute.BackendServiceList], request: google.cloud.compute_v1.types.compute.ListRegionBackendServicesRequest, response: google.cloud.compute_v1.types.compute.BackendServiceList, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list
requests.This class thinly wraps an initial
google.cloud.compute_v1.types.BackendServiceList
object, and provides an__iter__
method to iterate through itsitems
field.If there are more pages, the
__iter__
method will make additionalList
requests and continue to iterate through theitems
field on the corresponding responses.All the usual
google.cloud.compute_v1.types.BackendServiceList
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiate the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.compute_v1.types.ListRegionBackendServicesRequest) – The initial request object.
response (google.cloud.compute_v1.types.BackendServiceList) – The initial response object.
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.
- class google.cloud.compute_v1.services.region_backend_services.pagers.ListUsablePager(method: Callable[[...], google.cloud.compute_v1.types.compute.BackendServiceListUsable], request: google.cloud.compute_v1.types.compute.ListUsableRegionBackendServicesRequest, response: google.cloud.compute_v1.types.compute.BackendServiceListUsable, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_usable
requests.This class thinly wraps an initial
google.cloud.compute_v1.types.BackendServiceListUsable
object, and provides an__iter__
method to iterate through itsitems
field.If there are more pages, the
__iter__
method will make additionalListUsable
requests and continue to iterate through theitems
field on the corresponding responses.All the usual
google.cloud.compute_v1.types.BackendServiceListUsable
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiate the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.compute_v1.types.ListUsableRegionBackendServicesRequest) – The initial request object.
response (google.cloud.compute_v1.types.BackendServiceListUsable) – The initial response object.
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.