Class BackendServicesClient (1.15.0)

Version 1.15.0

• 1.22.0 (latest)
• 1.21.0
• 1.20.1
• 1.19.2
• 1.18.0
• 1.17.0
• 1.16.1
• 1.15.0
• 1.14.1
• 1.13.0
• 1.12.1
• 1.11.0
• 1.10.1
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.1
• 1.5.2
• 1.4.0
• 1.3.2
• 1.2.0
• 1.1.0
• 1.0.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.2
• 0.3.0
• 0.2.1
• 0.1.0

BackendServicesClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.compute_v1.services.backend_services.transports.base.BackendServicesTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

The BackendServices API.

Properties

transport

Returns the transport used by the client instance.

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

Methods

BackendServicesClient

BackendServicesClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.compute_v1.services.backend_services.transports.base.BackendServicesTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the 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. NOTE: "rest" transport functionality is currently in a beta state (preview). We welcome your feedback via an issue in this library's source repository.
client_options	Optional[Union[google.api_core.client_options.ClientOptions, dict]] Custom options for the client. It won't take effect if a 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.

__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

Warning: ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

add_signed_url_key

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

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

# 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_add_signed_url_key():
    # Create a client
    client = compute_v1.BackendServicesClient()

    # Initialize request argument(s)
    request = compute_v1.AddSignedUrlKeyBackendServiceRequest(
        backend_service="backend_service_value",
        project="project_value",
    )

    # Make the request
    response = client.add_signed_url_key(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.compute_v1.types.AddSignedUrlKeyBackendServiceRequest, dict] 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.api_core.extended_operation.ExtendedOperation	An object representing a extended long-running operation.

add_signed_url_key_unary

add_signed_url_key_unary(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.AddSignedUrlKeyBackendServiceRequest,
            dict,
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    backend_service: typing.Optional[str] = None,
    signed_url_key_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.SignedUrlKey
    ] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.Operation

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

# 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_add_signed_url_key():
    # Create a client
    client = compute_v1.BackendServicesClient()

    # Initialize request argument(s)
    request = compute_v1.AddSignedUrlKeyBackendServiceRequest(
        backend_service="backend_service_value",
        project="project_value",
    )

    # Make the request
    response = client.add_signed_url_key(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.compute_v1.types.AddSignedUrlKeyBackendServiceRequest, dict] 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.api_core.extended_operation.ExtendedOperation	An object representing a extended long-running operation.

aggregated_list

aggregated_list(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.AggregatedListBackendServicesRequest,
            dict,
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.services.backend_services.pagers.AggregatedListPager

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

# 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_aggregated_list():
    # Create a client
    client = compute_v1.BackendServicesClient()

    # Initialize request argument(s)
    request = compute_v1.AggregatedListBackendServicesRequest(
        project="project_value",
    )

    # Make the request
    page_result = client.aggregated_list(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters
Name	Description
request	Union[google.cloud.compute_v1.types.AggregatedListBackendServicesRequest, dict] 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) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

delete

delete(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.DeleteBackendServiceRequest, dict
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    backend_service: typing.Optional[str] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.extended_operation.ExtendedOperation

Deletes the specified 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.BackendServicesClient()

    # Initialize request argument(s)
    request = compute_v1.DeleteBackendServiceRequest(
        backend_service="backend_service_value",
        project="project_value",
    )

    # Make the request
    response = client.delete(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.compute_v1.types.DeleteBackendServiceRequest, dict] 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
google.api_core.extended_operation.ExtendedOperation	An object representing a extended long-running operation.

delete_signed_url_key

delete_signed_url_key(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.DeleteSignedUrlKeyBackendServiceRequest,
            dict,
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    backend_service: typing.Optional[str] = None,
    key_name: typing.Optional[str] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.extended_operation.ExtendedOperation

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

# 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_signed_url_key():
    # Create a client
    client = compute_v1.BackendServicesClient()

    # Initialize request argument(s)
    request = compute_v1.DeleteSignedUrlKeyBackendServiceRequest(
        backend_service="backend_service_value",
        key_name="key_name_value",
        project="project_value",
    )

    # Make the request
    response = client.delete_signed_url_key(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.compute_v1.types.DeleteSignedUrlKeyBackendServiceRequest, dict] 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
google.api_core.extended_operation.ExtendedOperation	An object representing a extended long-running operation.

delete_signed_url_key_unary

delete_signed_url_key_unary(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.DeleteSignedUrlKeyBackendServiceRequest,
            dict,
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    backend_service: typing.Optional[str] = None,
    key_name: typing.Optional[str] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.Operation

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

# 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_signed_url_key():
    # Create a client
    client = compute_v1.BackendServicesClient()

    # Initialize request argument(s)
    request = compute_v1.DeleteSignedUrlKeyBackendServiceRequest(
        backend_service="backend_service_value",
        key_name="key_name_value",
        project="project_value",
    )

    # Make the request
    response = client.delete_signed_url_key(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.compute_v1.types.DeleteSignedUrlKeyBackendServiceRequest, dict] 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
google.api_core.extended_operation.ExtendedOperation	An object representing a extended long-running operation.

delete_unary

delete_unary(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.DeleteBackendServiceRequest, dict
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    backend_service: typing.Optional[str] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.Operation

Deletes the specified 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.BackendServicesClient()

    # Initialize request argument(s)
    request = compute_v1.DeleteBackendServiceRequest(
        backend_service="backend_service_value",
        project="project_value",
    )

    # Make the request
    response = client.delete(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.compute_v1.types.DeleteBackendServiceRequest, dict] 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
google.api_core.extended_operation.ExtendedOperation	An object representing a extended long-running operation.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
filename	str The path to the service account private key json file.

Returns
Type	Description
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: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.GetBackendServiceRequest, dict
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    backend_service: typing.Optional[str] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.BackendService

Returns the specified 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.BackendServicesClient()

    # Initialize request argument(s)
    request = compute_v1.GetBackendServiceRequest(
        backend_service="backend_service_value",
        project="project_value",
    )

    # Make the request
    response = client.get(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.compute_v1.types.GetBackendServiceRequest, dict] 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](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) \* [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/regionBackendServices) For more information, see Backend Services.

get_health

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

Gets the most recent health check results for this BackendService. Example request body: { "group": "/zones/us-east1-b/instanceGroups/lb-backend-example" }

# 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.BackendServicesClient()

    # Initialize request argument(s)
    request = compute_v1.GetHealthBackendServiceRequest(
        backend_service="backend_service_value",
        project="project_value",
    )

    # Make the request
    response = client.get_health(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.compute_v1.types.GetHealthBackendServiceRequest, dict] 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.

get_iam_policy

get_iam_policy(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.GetIamPolicyBackendServiceRequest,
            dict,
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    resource: typing.Optional[str] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.Policy

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_get_iam_policy():
    # Create a client
    client = compute_v1.BackendServicesClient()

    # Initialize request argument(s)
    request = compute_v1.GetIamPolicyBackendServiceRequest(
        project="project_value",
        resource="resource_value",
    )

    # Make the request
    response = client.get_iam_policy(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.compute_v1.types.GetIamPolicyBackendServiceRequest, dict] The request object. A request message for BackendServices.GetIamPolicy. 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.
resource	str Name or id of the resource for this request. This corresponds to the 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.Policy	An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](\ https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** :literal:\ { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[e-mail]", "group:[e-mail]", "domain:google.com", "serviceAccount:[e-mail]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[e-mail]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ],="" "etag":="" "bwwwja0yfja=", " version":="" 3="">\ \ **YAML example:** :literal:\ bindings: - members: - user:[e-mail] - group:[e-mail] - domain:google.com - serviceAccount:[e-mail] role: roles/resourcemanager.organizationAdmin - members: - user:[e-mail] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01t00:00:00.000z')="" etag:="" bwwwja0yfja="version:">\ \ For a description of IAM and its features, see the [IAM documentation](\ https://cloud.google.com/iam/docs/).

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
Name	Description
client_options	google.api_core.client_options.ClientOptions Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Exceptions
Type	Description
google.auth.exceptions.MutualTLSChannelError	If any errors happen.

Returns
Type	Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]]	returns the API endpoint and the client cert source to use.

insert

insert(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.InsertBackendServiceRequest, dict
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    backend_service_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.BackendService
    ] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.extended_operation.ExtendedOperation

Creates a 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.BackendServicesClient()

    # Initialize request argument(s)
    request = compute_v1.InsertBackendServiceRequest(
        project="project_value",
    )

    # Make the request
    response = client.insert(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.compute_v1.types.InsertBackendServiceRequest, dict] 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
google.api_core.extended_operation.ExtendedOperation	An object representing a extended long-running operation.

insert_unary

insert_unary(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.InsertBackendServiceRequest, dict
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    backend_service_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.BackendService
    ] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.Operation

Creates a 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.BackendServicesClient()

    # Initialize request argument(s)
    request = compute_v1.InsertBackendServiceRequest(
        project="project_value",
    )

    # Make the request
    response = client.insert(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.compute_v1.types.InsertBackendServiceRequest, dict] 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
google.api_core.extended_operation.ExtendedOperation	An object representing a extended long-running operation.

list

list(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.ListBackendServicesRequest, dict
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.services.backend_services.pagers.ListPager

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

# 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.BackendServicesClient()

    # Initialize request argument(s)
    request = compute_v1.ListBackendServicesRequest(
        project="project_value",
    )

    # Make the request
    page_result = client.list(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters
Name	Description
request	Union[google.cloud.compute_v1.types.ListBackendServicesRequest, dict] 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.

list_usable

list_usable(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.ListUsableBackendServicesRequest, dict
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.services.backend_services.pagers.ListUsablePager

Retrieves an aggregated list of all usable backend services in the specified project.

# 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.BackendServicesClient()

    # Initialize request argument(s)
    request = compute_v1.ListUsableBackendServicesRequest(
        project="project_value",
    )

    # Make the request
    page_result = client.list_usable(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters
Name	Description
request	Union[google.cloud.compute_v1.types.ListUsableBackendServicesRequest, dict] The request object. A request message for BackendServices.ListUsable. 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.ListUsablePager	Contains a list of usable BackendService resources. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

patch

patch(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.PatchBackendServiceRequest, dict
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    backend_service: typing.Optional[str] = None,
    backend_service_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.BackendService
    ] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.extended_operation.ExtendedOperation

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.

# 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.BackendServicesClient()

    # Initialize request argument(s)
    request = compute_v1.PatchBackendServiceRequest(
        backend_service="backend_service_value",
        project="project_value",
    )

    # Make the request
    response = client.patch(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.compute_v1.types.PatchBackendServiceRequest, dict] 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
google.api_core.extended_operation.ExtendedOperation	An object representing a extended long-running operation.

patch_unary

patch_unary(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.PatchBackendServiceRequest, dict
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    backend_service: typing.Optional[str] = None,
    backend_service_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.BackendService
    ] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.Operation

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.

# 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.BackendServicesClient()

    # Initialize request argument(s)
    request = compute_v1.PatchBackendServiceRequest(
        backend_service="backend_service_value",
        project="project_value",
    )

    # Make the request
    response = client.patch(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.compute_v1.types.PatchBackendServiceRequest, dict] 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
google.api_core.extended_operation.ExtendedOperation	An object representing a extended long-running operation.

set_edge_security_policy

set_edge_security_policy(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.SetEdgeSecurityPolicyBackendServiceRequest,
            dict,
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    backend_service: typing.Optional[str] = None,
    security_policy_reference_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.SecurityPolicyReference
    ] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.extended_operation.ExtendedOperation

Sets the edge security policy for the specified backend service.

# 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_edge_security_policy():
    # Create a client
    client = compute_v1.BackendServicesClient()

    # Initialize request argument(s)
    request = compute_v1.SetEdgeSecurityPolicyBackendServiceRequest(
        backend_service="backend_service_value",
        project="project_value",
    )

    # Make the request
    response = client.set_edge_security_policy(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.compute_v1.types.SetEdgeSecurityPolicyBackendServiceRequest, dict] The request object. A request message for BackendServices.SetEdgeSecurityPolicy. 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 edge 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
google.api_core.extended_operation.ExtendedOperation	An object representing a extended long-running operation.

set_edge_security_policy_unary

set_edge_security_policy_unary(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.SetEdgeSecurityPolicyBackendServiceRequest,
            dict,
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    backend_service: typing.Optional[str] = None,
    security_policy_reference_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.SecurityPolicyReference
    ] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.Operation

Sets the edge security policy for the specified backend service.

# 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_edge_security_policy():
    # Create a client
    client = compute_v1.BackendServicesClient()

    # Initialize request argument(s)
    request = compute_v1.SetEdgeSecurityPolicyBackendServiceRequest(
        backend_service="backend_service_value",
        project="project_value",
    )

    # Make the request
    response = client.set_edge_security_policy(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.compute_v1.types.SetEdgeSecurityPolicyBackendServiceRequest, dict] The request object. A request message for BackendServices.SetEdgeSecurityPolicy. 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 edge 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
google.api_core.extended_operation.ExtendedOperation	An object representing a extended long-running operation.

set_iam_policy

set_iam_policy(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.SetIamPolicyBackendServiceRequest,
            dict,
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    resource: typing.Optional[str] = None,
    global_set_policy_request_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.GlobalSetPolicyRequest
    ] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.Policy

Sets the access control policy on the specified resource. Replaces any existing policy.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_set_iam_policy():
    # Create a client
    client = compute_v1.BackendServicesClient()

    # Initialize request argument(s)
    request = compute_v1.SetIamPolicyBackendServiceRequest(
        project="project_value",
        resource="resource_value",
    )

    # Make the request
    response = client.set_iam_policy(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.compute_v1.types.SetIamPolicyBackendServiceRequest, dict] The request object. A request message for BackendServices.SetIamPolicy. 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.
resource	str Name or id of the resource for this request. This corresponds to the resource field on the request instance; if request is provided, this should not be set.
global_set_policy_request_resource	google.cloud.compute_v1.types.GlobalSetPolicyRequest The body resource for this request This corresponds to the global_set_policy_request_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.Policy	An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](\ https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** :literal:\ { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[e-mail]", "group:[e-mail]", "domain:google.com", "serviceAccount:[e-mail]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[e-mail]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ],="" "etag":="" "bwwwja0yfja=", " version":="" 3="">\ \ **YAML example:** :literal:\ bindings: - members: - user:[e-mail] - group:[e-mail] - domain:google.com - serviceAccount:[e-mail] role: roles/resourcemanager.organizationAdmin - members: - user:[e-mail] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01t00:00:00.000z')="" etag:="" bwwwja0yfja="version:">\ \ For a description of IAM and its features, see the [IAM documentation](\ https://cloud.google.com/iam/docs/).

set_security_policy

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

Sets the Google Cloud Armor security policy for the specified backend service. For more information, see Google Cloud Armor Overview

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_set_security_policy():
    # Create a client
    client = compute_v1.BackendServicesClient()

    # Initialize request argument(s)
    request = compute_v1.SetSecurityPolicyBackendServiceRequest(
        backend_service="backend_service_value",
        project="project_value",
    )

    # Make the request
    response = client.set_security_policy(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.compute_v1.types.SetSecurityPolicyBackendServiceRequest, dict] 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
google.api_core.extended_operation.ExtendedOperation	An object representing a extended long-running operation.

set_security_policy_unary

set_security_policy_unary(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.SetSecurityPolicyBackendServiceRequest,
            dict,
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    backend_service: typing.Optional[str] = None,
    security_policy_reference_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.SecurityPolicyReference
    ] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.Operation

Sets the Google Cloud Armor security policy for the specified backend service. For more information, see Google Cloud Armor Overview

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_set_security_policy():
    # Create a client
    client = compute_v1.BackendServicesClient()

    # Initialize request argument(s)
    request = compute_v1.SetSecurityPolicyBackendServiceRequest(
        backend_service="backend_service_value",
        project="project_value",
    )

    # Make the request
    response = client.set_security_policy(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.compute_v1.types.SetSecurityPolicyBackendServiceRequest, dict] 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
google.api_core.extended_operation.ExtendedOperation	An object representing a extended long-running operation.

test_iam_permissions

test_iam_permissions(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.TestIamPermissionsBackendServiceRequest,
            dict,
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    resource: typing.Optional[str] = None,
    test_permissions_request_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.TestPermissionsRequest
    ] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.TestPermissionsResponse

Returns permissions that a caller has on the specified resource.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1

def sample_test_iam_permissions():
    # Create a client
    client = compute_v1.BackendServicesClient()

    # Initialize request argument(s)
    request = compute_v1.TestIamPermissionsBackendServiceRequest(
        project="project_value",
        resource="resource_value",
    )

    # Make the request
    response = client.test_iam_permissions(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.compute_v1.types.TestIamPermissionsBackendServiceRequest, dict] The request object. A request message for BackendServices.TestIamPermissions. 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.
resource	str Name or id of the resource for this request. This corresponds to the resource field on the request instance; if request 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 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.

update

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

Updates the specified 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.BackendServicesClient()

    # Initialize request argument(s)
    request = compute_v1.UpdateBackendServiceRequest(
        backend_service="backend_service_value",
        project="project_value",
    )

    # Make the request
    response = client.update(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.compute_v1.types.UpdateBackendServiceRequest, dict] 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
google.api_core.extended_operation.ExtendedOperation	An object representing a extended long-running operation.

update_unary

update_unary(
    request: typing.Optional[
        typing.Union[
            google.cloud.compute_v1.types.compute.UpdateBackendServiceRequest, dict
        ]
    ] = None,
    *,
    project: typing.Optional[str] = None,
    backend_service: typing.Optional[str] = None,
    backend_service_resource: typing.Optional[
        google.cloud.compute_v1.types.compute.BackendService
    ] = None,
    retry: typing.Union[
        google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.Operation

Updates the specified 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.BackendServicesClient()

    # Initialize request argument(s)
    request = compute_v1.UpdateBackendServiceRequest(
        backend_service="backend_service_value",
        project="project_value",
    )

    # Make the request
    response = client.update(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
request	Union[google.cloud.compute_v1.types.UpdateBackendServiceRequest, dict] 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
google.api_core.extended_operation.ExtendedOperation	An object representing a extended long-running operation.