As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Source code for google.cloud.compute_v1.services.target_https_proxies.client

# -*- coding: utf-8 -*-
# Copyright 2024 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
from collections import OrderedDict
import functools
import os
import re
from typing import (
    Callable,
    Dict,
    Mapping,
    MutableMapping,
    MutableSequence,
    Optional,
    Sequence,
    Tuple,
    Type,
    Union,
    cast,
)
import warnings

from google.api_core import client_options as client_options_lib
from google.api_core import exceptions as core_exceptions
from google.api_core import extended_operation, gapic_v1
from google.api_core import retry as retries
from google.auth import credentials as ga_credentials  # type: ignore
from google.auth.exceptions import MutualTLSChannelError  # type: ignore
from google.auth.transport import mtls  # type: ignore
from google.auth.transport.grpc import SslCredentials  # type: ignore
from google.oauth2 import service_account  # type: ignore

from google.cloud.compute_v1 import gapic_version as package_version

try:
    OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None]
except AttributeError:  # pragma: NO COVER
    OptionalRetry = Union[retries.Retry, object, None]  # type: ignore

from google.api_core import extended_operation  # type: ignore

from google.cloud.compute_v1.services.target_https_proxies import pagers
from google.cloud.compute_v1.types import compute

from .transports.base import DEFAULT_CLIENT_INFO, TargetHttpsProxiesTransport
from .transports.rest import TargetHttpsProxiesRestTransport


class TargetHttpsProxiesClientMeta(type):
    """Metaclass for the TargetHttpsProxies client.

    This provides class-level methods for building and retrieving
    support objects (e.g. transport) without polluting the client instance
    objects.
    """

    _transport_registry = (
        OrderedDict()
    )  # type: Dict[str, Type[TargetHttpsProxiesTransport]]
    _transport_registry["rest"] = TargetHttpsProxiesRestTransport

    def get_transport_class(
        cls,
        label: Optional[str] = None,
    ) -> Type[TargetHttpsProxiesTransport]:
        """Returns an appropriate transport class.

        Args:
            label: The name of the desired transport. If none is
                provided, then the first transport in the registry is used.

        Returns:
            The transport class to use.
        """
        # If a specific transport is requested, return that one.
        if label:
            return cls._transport_registry[label]

        # No transport is requested; return the default (that is, the first one
        # in the dictionary).
        return next(iter(cls._transport_registry.values()))


[docs]class TargetHttpsProxiesClient(metaclass=TargetHttpsProxiesClientMeta): """The TargetHttpsProxies API.""" @staticmethod def _get_default_mtls_endpoint(api_endpoint): """Converts api endpoint to mTLS endpoint. Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. Args: api_endpoint (Optional[str]): the api endpoint to convert. Returns: str: converted mTLS api endpoint. """ if not api_endpoint: return api_endpoint mtls_endpoint_re = re.compile( r"(?P<name>[^.]+)(?P<mtls>\.mtls)?(?P<sandbox>\.sandbox)?(?P<googledomain>\.googleapis\.com)?" ) m = mtls_endpoint_re.match(api_endpoint) name, mtls, sandbox, googledomain = m.groups() if mtls or not googledomain: return api_endpoint if sandbox: return api_endpoint.replace( "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" ) return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead. DEFAULT_ENDPOINT = "compute.googleapis.com" DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore DEFAULT_ENDPOINT ) _DEFAULT_ENDPOINT_TEMPLATE = "compute.{UNIVERSE_DOMAIN}" _DEFAULT_UNIVERSE = "googleapis.com"
[docs] @classmethod def from_service_account_info(cls, info: dict, *args, **kwargs): """Creates an instance of this client using the provided credentials info. Args: 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: TargetHttpsProxiesClient: The constructed client. """ credentials = service_account.Credentials.from_service_account_info(info) kwargs["credentials"] = credentials return cls(*args, **kwargs)
[docs] @classmethod def from_service_account_file(cls, filename: str, *args, **kwargs): """Creates an instance of this client using the provided credentials file. Args: 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: TargetHttpsProxiesClient: The constructed client. """ credentials = service_account.Credentials.from_service_account_file(filename) kwargs["credentials"] = credentials return cls(*args, **kwargs)
from_service_account_json = from_service_account_file @property def transport(self) -> TargetHttpsProxiesTransport: """Returns the transport used by the client instance. Returns: TargetHttpsProxiesTransport: The transport used by the client instance. """ return self._transport
[docs] @staticmethod def common_billing_account_path( billing_account: str, ) -> str: """Returns a fully-qualified billing_account string.""" return "billingAccounts/{billing_account}".format( billing_account=billing_account, )
[docs] @staticmethod def parse_common_billing_account_path(path: str) -> Dict[str, str]: """Parse a billing_account path into its component segments.""" m = re.match(r"^billingAccounts/(?P<billing_account>.+?)$", path) return m.groupdict() if m else {}
[docs] @staticmethod def common_folder_path( folder: str, ) -> str: """Returns a fully-qualified folder string.""" return "folders/{folder}".format( folder=folder, )
[docs] @staticmethod def parse_common_folder_path(path: str) -> Dict[str, str]: """Parse a folder path into its component segments.""" m = re.match(r"^folders/(?P<folder>.+?)$", path) return m.groupdict() if m else {}
[docs] @staticmethod def common_organization_path( organization: str, ) -> str: """Returns a fully-qualified organization string.""" return "organizations/{organization}".format( organization=organization, )
[docs] @staticmethod def parse_common_organization_path(path: str) -> Dict[str, str]: """Parse a organization path into its component segments.""" m = re.match(r"^organizations/(?P<organization>.+?)$", path) return m.groupdict() if m else {}
[docs] @staticmethod def common_project_path( project: str, ) -> str: """Returns a fully-qualified project string.""" return "projects/{project}".format( project=project, )
[docs] @staticmethod def parse_common_project_path(path: str) -> Dict[str, str]: """Parse a project path into its component segments.""" m = re.match(r"^projects/(?P<project>.+?)$", path) return m.groupdict() if m else {}
[docs] @staticmethod def common_location_path( project: str, location: str, ) -> str: """Returns a fully-qualified location string.""" return "projects/{project}/locations/{location}".format( project=project, location=location, )
[docs] @staticmethod def parse_common_location_path(path: str) -> Dict[str, str]: """Parse a location path into its component segments.""" m = re.match(r"^projects/(?P<project>.+?)/locations/(?P<location>.+?)$", path) return m.groupdict() if m else {}
[docs] @classmethod def get_mtls_endpoint_and_cert_source( cls, client_options: Optional[client_options_lib.ClientOptions] = None ): """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. Args: 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: Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the client cert source to use. Raises: google.auth.exceptions.MutualTLSChannelError: If any errors happen. """ warnings.warn( "get_mtls_endpoint_and_cert_source is deprecated. Use the api_endpoint property instead.", DeprecationWarning, ) if client_options is None: client_options = client_options_lib.ClientOptions() use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") if use_client_cert not in ("true", "false"): raise ValueError( "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" ) if use_mtls_endpoint not in ("auto", "never", "always"): raise MutualTLSChannelError( "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" ) # Figure out the client cert source to use. client_cert_source = None if use_client_cert == "true": if client_options.client_cert_source: client_cert_source = client_options.client_cert_source elif mtls.has_default_client_cert_source(): client_cert_source = mtls.default_client_cert_source() # Figure out which api endpoint to use. if client_options.api_endpoint is not None: api_endpoint = client_options.api_endpoint elif use_mtls_endpoint == "always" or ( use_mtls_endpoint == "auto" and client_cert_source ): api_endpoint = cls.DEFAULT_MTLS_ENDPOINT else: api_endpoint = cls.DEFAULT_ENDPOINT return api_endpoint, client_cert_source
@staticmethod def _read_environment_variables(): """Returns the environment variables used by the client. Returns: Tuple[bool, str, str]: returns the GOOGLE_API_USE_CLIENT_CERTIFICATE, GOOGLE_API_USE_MTLS_ENDPOINT, and GOOGLE_CLOUD_UNIVERSE_DOMAIN environment variables. Raises: ValueError: If GOOGLE_API_USE_CLIENT_CERTIFICATE is not any of ["true", "false"]. google.auth.exceptions.MutualTLSChannelError: If GOOGLE_API_USE_MTLS_ENDPOINT is not any of ["auto", "never", "always"]. """ use_client_cert = os.getenv( "GOOGLE_API_USE_CLIENT_CERTIFICATE", "false" ).lower() use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto").lower() universe_domain_env = os.getenv("GOOGLE_CLOUD_UNIVERSE_DOMAIN") if use_client_cert not in ("true", "false"): raise ValueError( "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" ) if use_mtls_endpoint not in ("auto", "never", "always"): raise MutualTLSChannelError( "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" ) return use_client_cert == "true", use_mtls_endpoint, universe_domain_env @staticmethod def _get_client_cert_source(provided_cert_source, use_cert_flag): """Return the client cert source to be used by the client. Args: provided_cert_source (bytes): The client certificate source provided. use_cert_flag (bool): A flag indicating whether to use the client certificate. Returns: bytes or None: The client cert source to be used by the client. """ client_cert_source = None if use_cert_flag: if provided_cert_source: client_cert_source = provided_cert_source elif mtls.has_default_client_cert_source(): client_cert_source = mtls.default_client_cert_source() return client_cert_source @staticmethod def _get_api_endpoint( api_override, client_cert_source, universe_domain, use_mtls_endpoint ): """Return the API endpoint used by the client. Args: api_override (str): The API endpoint override. If specified, this is always the return value of this function and the other arguments are not used. client_cert_source (bytes): The client certificate source used by the client. universe_domain (str): The universe domain used by the client. use_mtls_endpoint (str): How to use the mTLS endpoint, which depends also on the other parameters. Possible values are "always", "auto", or "never". Returns: str: The API endpoint to be used by the client. """ if api_override is not None: api_endpoint = api_override elif use_mtls_endpoint == "always" or ( use_mtls_endpoint == "auto" and client_cert_source ): _default_universe = TargetHttpsProxiesClient._DEFAULT_UNIVERSE if universe_domain != _default_universe: raise MutualTLSChannelError( f"mTLS is not supported in any universe other than {_default_universe}." ) api_endpoint = TargetHttpsProxiesClient.DEFAULT_MTLS_ENDPOINT else: api_endpoint = TargetHttpsProxiesClient._DEFAULT_ENDPOINT_TEMPLATE.format( UNIVERSE_DOMAIN=universe_domain ) return api_endpoint @staticmethod def _get_universe_domain( client_universe_domain: Optional[str], universe_domain_env: Optional[str] ) -> str: """Return the universe domain used by the client. Args: client_universe_domain (Optional[str]): The universe domain configured via the client options. universe_domain_env (Optional[str]): The universe domain configured via the "GOOGLE_CLOUD_UNIVERSE_DOMAIN" environment variable. Returns: str: The universe domain to be used by the client. Raises: ValueError: If the universe domain is an empty string. """ universe_domain = TargetHttpsProxiesClient._DEFAULT_UNIVERSE if client_universe_domain is not None: universe_domain = client_universe_domain elif universe_domain_env is not None: universe_domain = universe_domain_env if len(universe_domain.strip()) == 0: raise ValueError("Universe Domain cannot be an empty string.") return universe_domain def _validate_universe_domain(self): """Validates client's and credentials' universe domains are consistent. Returns: bool: True iff the configured universe domain is valid. Raises: ValueError: If the configured universe domain is not valid. """ # NOTE (b/349488459): universe validation is disabled until further notice. return True @property def api_endpoint(self): """Return the API endpoint used by the client instance. Returns: str: The API endpoint used by the client instance. """ return self._api_endpoint @property def universe_domain(self) -> str: """Return the universe domain used by the client instance. Returns: str: The universe domain used by the client instance. """ return self._universe_domain def __init__( self, *, credentials: Optional[ga_credentials.Credentials] = None, transport: Optional[ Union[ str, TargetHttpsProxiesTransport, Callable[..., TargetHttpsProxiesTransport], ] ] = None, client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, ) -> None: """Instantiates the target https proxies client. Args: 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,TargetHttpsProxiesTransport,Callable[..., TargetHttpsProxiesTransport]]]): 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 TargetHttpsProxiesTransport 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 when ``transport`` is not explicitly provided. Only if this property is not set and ``transport`` 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 the ``api_endpoint`` property still takes precedence; and ``universe_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. """ self._client_options = client_options if isinstance(self._client_options, dict): self._client_options = client_options_lib.from_dict(self._client_options) if self._client_options is None: self._client_options = client_options_lib.ClientOptions() self._client_options = cast( client_options_lib.ClientOptions, self._client_options ) universe_domain_opt = getattr(self._client_options, "universe_domain", None) ( self._use_client_cert, self._use_mtls_endpoint, self._universe_domain_env, ) = TargetHttpsProxiesClient._read_environment_variables() self._client_cert_source = TargetHttpsProxiesClient._get_client_cert_source( self._client_options.client_cert_source, self._use_client_cert ) self._universe_domain = TargetHttpsProxiesClient._get_universe_domain( universe_domain_opt, self._universe_domain_env ) self._api_endpoint = None # updated below, depending on `transport` # Initialize the universe domain validation. self._is_universe_domain_valid = False api_key_value = getattr(self._client_options, "api_key", None) if api_key_value and credentials: raise ValueError( "client_options.api_key and credentials are mutually exclusive" ) # Save or instantiate the transport. # Ordinarily, we provide the transport, but allowing a custom transport # instance provides an extensibility point for unusual situations. transport_provided = isinstance(transport, TargetHttpsProxiesTransport) if transport_provided: # transport is a TargetHttpsProxiesTransport instance. if credentials or self._client_options.credentials_file or api_key_value: raise ValueError( "When providing a transport instance, " "provide its credentials directly." ) if self._client_options.scopes: raise ValueError( "When providing a transport instance, provide its scopes " "directly." ) self._transport = cast(TargetHttpsProxiesTransport, transport) self._api_endpoint = self._transport.host self._api_endpoint = ( self._api_endpoint or TargetHttpsProxiesClient._get_api_endpoint( self._client_options.api_endpoint, self._client_cert_source, self._universe_domain, self._use_mtls_endpoint, ) ) if not transport_provided: import google.auth._default # type: ignore if api_key_value and hasattr( google.auth._default, "get_api_key_credentials" ): credentials = google.auth._default.get_api_key_credentials( api_key_value ) transport_init: Union[ Type[TargetHttpsProxiesTransport], Callable[..., TargetHttpsProxiesTransport], ] = ( TargetHttpsProxiesClient.get_transport_class(transport) if isinstance(transport, str) or transport is None else cast(Callable[..., TargetHttpsProxiesTransport], transport) ) # initialize with the provided callable or the passed in class self._transport = transport_init( credentials=credentials, credentials_file=self._client_options.credentials_file, host=self._api_endpoint, scopes=self._client_options.scopes, client_cert_source_for_mtls=self._client_cert_source, quota_project_id=self._client_options.quota_project_id, client_info=client_info, always_use_jwt_access=True, api_audience=self._client_options.api_audience, )
[docs] def aggregated_list( self, request: Optional[ Union[compute.AggregatedListTargetHttpsProxiesRequest, dict] ] = None, *, project: Optional[str] = None, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = (), ) -> pagers.AggregatedListPager: r"""Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the ``returnPartialSuccess`` parameter to ``true``. .. code-block:: python # 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.TargetHttpsProxiesClient() # Initialize request argument(s) request = compute_v1.AggregatedListTargetHttpsProxiesRequest( project="project_value", ) # Make the request page_result = client.aggregated_list(request=request) # Handle the response for response in page_result: print(response) Args: request (Union[google.cloud.compute_v1.types.AggregatedListTargetHttpsProxiesRequest, dict]): The request object. A request message for TargetHttpsProxies.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: google.cloud.compute_v1.services.target_https_proxies.pagers.AggregatedListPager: Iterating over this object will yield results and resolve additional pages automatically. """ # Create or coerce a protobuf request object. # - Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any([project]) if request is not None and has_flattened_params: raise ValueError( "If the `request` argument is set, then none of " "the individual field arguments should be set." ) # - Use the request object if provided (there's no risk of modifying the input as # there are no flattened fields), or create one. if not isinstance(request, compute.AggregatedListTargetHttpsProxiesRequest): request = compute.AggregatedListTargetHttpsProxiesRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if project is not None: request.project = project # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = self._transport._wrapped_methods[self._transport.aggregated_list] # Certain fields should be provided within the metadata header; # add these here. metadata = tuple(metadata) + ( gapic_v1.routing_header.to_grpc_metadata((("project", request.project),)), ) # Validate the universe domain. self._validate_universe_domain() # Send the request. response = rpc( request, retry=retry, timeout=timeout, metadata=metadata, ) # This method is paged; wrap the response in a pager, which provides # an `__iter__` convenience method. response = pagers.AggregatedListPager( method=rpc, request=request, response=response, retry=retry, timeout=timeout, metadata=metadata, ) # Done; return the response. return response
[docs] def delete_unary( self, request: Optional[Union[compute.DeleteTargetHttpsProxyRequest, dict]] = None, *, project: Optional[str] = None, target_https_proxy: Optional[str] = None, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = (), ) -> compute.Operation: r"""Deletes the specified TargetHttpsProxy resource. .. code-block:: python # 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.TargetHttpsProxiesClient() # Initialize request argument(s) request = compute_v1.DeleteTargetHttpsProxyRequest( project="project_value", target_https_proxy="target_https_proxy_value", ) # Make the request response = client.delete(request=request) # Handle the response print(response) Args: request (Union[google.cloud.compute_v1.types.DeleteTargetHttpsProxyRequest, dict]): The request object. A request message for TargetHttpsProxies.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. target_https_proxy (str): Name of the TargetHttpsProxy resource to delete. This corresponds to the ``target_https_proxy`` 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: google.api_core.extended_operation.ExtendedOperation: An object representing a extended long-running operation. """ # Create or coerce a protobuf request object. # - Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any([project, target_https_proxy]) if request is not None and has_flattened_params: raise ValueError( "If the `request` argument is set, then none of " "the individual field arguments should be set." ) # - Use the request object if provided (there's no risk of modifying the input as # there are no flattened fields), or create one. if not isinstance(request, compute.DeleteTargetHttpsProxyRequest): request = compute.DeleteTargetHttpsProxyRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if project is not None: request.project = project if target_https_proxy is not None: request.target_https_proxy = target_https_proxy # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = self._transport._wrapped_methods[self._transport.delete] # Certain fields should be provided within the metadata header; # add these here. metadata = tuple(metadata) + ( gapic_v1.routing_header.to_grpc_metadata( ( ("project", request.project), ("target_https_proxy", request.target_https_proxy), ) ), ) # Validate the universe domain. self._validate_universe_domain() # Send the request. response = rpc( request, retry=retry, timeout=timeout, metadata=metadata, ) # Done; return the response. return response
[docs] def delete( self, request: Optional[Union[compute.DeleteTargetHttpsProxyRequest, dict]] = None, *, project: Optional[str] = None, target_https_proxy: Optional[str] = None, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = (), ) -> extended_operation.ExtendedOperation: r"""Deletes the specified TargetHttpsProxy resource. .. code-block:: python # 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.TargetHttpsProxiesClient() # Initialize request argument(s) request = compute_v1.DeleteTargetHttpsProxyRequest( project="project_value", target_https_proxy="target_https_proxy_value", ) # Make the request response = client.delete(request=request) # Handle the response print(response) Args: request (Union[google.cloud.compute_v1.types.DeleteTargetHttpsProxyRequest, dict]): The request object. A request message for TargetHttpsProxies.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. target_https_proxy (str): Name of the TargetHttpsProxy resource to delete. This corresponds to the ``target_https_proxy`` 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: google.api_core.extended_operation.ExtendedOperation: An object representing a extended long-running operation. """ # Create or coerce a protobuf request object. # - Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any([project, target_https_proxy]) if request is not None and has_flattened_params: raise ValueError( "If the `request` argument is set, then none of " "the individual field arguments should be set." ) # - Use the request object if provided (there's no risk of modifying the input as # there are no flattened fields), or create one. if not isinstance(request, compute.DeleteTargetHttpsProxyRequest): request = compute.DeleteTargetHttpsProxyRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if project is not None: request.project = project if target_https_proxy is not None: request.target_https_proxy = target_https_proxy # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = self._transport._wrapped_methods[self._transport.delete] # Certain fields should be provided within the metadata header; # add these here. metadata = tuple(metadata) + ( gapic_v1.routing_header.to_grpc_metadata( ( ("project", request.project), ("target_https_proxy", request.target_https_proxy), ) ), ) # Validate the universe domain. self._validate_universe_domain() # Send the request. response = rpc( request, retry=retry, timeout=timeout, metadata=metadata, ) operation_service = self._transport._global_operations_client operation_request = compute.GetGlobalOperationRequest() operation_request.project = request.project operation_request.operation = response.name get_operation = functools.partial(operation_service.get, operation_request) # Cancel is not part of extended operations yet. cancel_operation = lambda: None # Note: this class is an implementation detail to provide a uniform # set of names for certain fields in the extended operation proto message. # See google.api_core.extended_operation.ExtendedOperation for details # on these properties and the expected interface. class _CustomOperation(extended_operation.ExtendedOperation): @property def error_message(self): return self._extended_operation.http_error_message @property def error_code(self): return self._extended_operation.http_error_status_code response = _CustomOperation.make(get_operation, cancel_operation, response) # Done; return the response. return response
[docs] def get( self, request: Optional[Union[compute.GetTargetHttpsProxyRequest, dict]] = None, *, project: Optional[str] = None, target_https_proxy: Optional[str] = None, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = (), ) -> compute.TargetHttpsProxy: r"""Returns the specified TargetHttpsProxy resource. .. code-block:: python # 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.TargetHttpsProxiesClient() # Initialize request argument(s) request = compute_v1.GetTargetHttpsProxyRequest( project="project_value", target_https_proxy="target_https_proxy_value", ) # Make the request response = client.get(request=request) # Handle the response print(response) Args: request (Union[google.cloud.compute_v1.types.GetTargetHttpsProxyRequest, dict]): The request object. A request message for TargetHttpsProxies.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. target_https_proxy (str): Name of the TargetHttpsProxy resource to return. This corresponds to the ``target_https_proxy`` 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: google.cloud.compute_v1.types.TargetHttpsProxy: Represents a Target HTTPS Proxy resource. Google Compute Engine has two Target HTTPS Proxy resources: \* [Global](/compute/docs/reference/rest/v1/targetHttpsProxies) \* [Regional](/compute/docs/reference/rest/v1/regionTargetHttpsProxies) A target HTTPS proxy is a component of GCP HTTPS load balancers. \* targetHttpProxies are used by global external Application Load Balancers, classic Application Load Balancers, cross-region internal Application Load Balancers, and Traffic Director. \* regionTargetHttpProxies are used by regional internal Application Load Balancers and regional external Application Load Balancers. Forwarding rules reference a target HTTPS proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. """ # Create or coerce a protobuf request object. # - Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any([project, target_https_proxy]) if request is not None and has_flattened_params: raise ValueError( "If the `request` argument is set, then none of " "the individual field arguments should be set." ) # - Use the request object if provided (there's no risk of modifying the input as # there are no flattened fields), or create one. if not isinstance(request, compute.GetTargetHttpsProxyRequest): request = compute.GetTargetHttpsProxyRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if project is not None: request.project = project if target_https_proxy is not None: request.target_https_proxy = target_https_proxy # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = self._transport._wrapped_methods[self._transport.get] # Certain fields should be provided within the metadata header; # add these here. metadata = tuple(metadata) + ( gapic_v1.routing_header.to_grpc_metadata( ( ("project", request.project), ("target_https_proxy", request.target_https_proxy), ) ), ) # Validate the universe domain. self._validate_universe_domain() # Send the request. response = rpc( request, retry=retry, timeout=timeout, metadata=metadata, ) # Done; return the response. return response
[docs] def insert_unary( self, request: Optional[Union[compute.InsertTargetHttpsProxyRequest, dict]] = None, *, project: Optional[str] = None, target_https_proxy_resource: Optional[compute.TargetHttpsProxy] = None, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = (), ) -> compute.Operation: r"""Creates a TargetHttpsProxy resource in the specified project using the data included in the request. .. code-block:: python # 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.TargetHttpsProxiesClient() # Initialize request argument(s) request = compute_v1.InsertTargetHttpsProxyRequest( project="project_value", ) # Make the request response = client.insert(request=request) # Handle the response print(response) Args: request (Union[google.cloud.compute_v1.types.InsertTargetHttpsProxyRequest, dict]): The request object. A request message for TargetHttpsProxies.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. target_https_proxy_resource (google.cloud.compute_v1.types.TargetHttpsProxy): The body resource for this request This corresponds to the ``target_https_proxy_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: google.api_core.extended_operation.ExtendedOperation: An object representing a extended long-running operation. """ # Create or coerce a protobuf request object. # - Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any([project, target_https_proxy_resource]) if request is not None and has_flattened_params: raise ValueError( "If the `request` argument is set, then none of " "the individual field arguments should be set." ) # - Use the request object if provided (there's no risk of modifying the input as # there are no flattened fields), or create one. if not isinstance(request, compute.InsertTargetHttpsProxyRequest): request = compute.InsertTargetHttpsProxyRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if project is not None: request.project = project if target_https_proxy_resource is not None: request.target_https_proxy_resource = target_https_proxy_resource # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = self._transport._wrapped_methods[self._transport.insert] # Certain fields should be provided within the metadata header; # add these here. metadata = tuple(metadata) + ( gapic_v1.routing_header.to_grpc_metadata((("project", request.project),)), ) # Validate the universe domain. self._validate_universe_domain() # Send the request. response = rpc( request, retry=retry, timeout=timeout, metadata=metadata, ) # Done; return the response. return response
[docs] def insert( self, request: Optional[Union[compute.InsertTargetHttpsProxyRequest, dict]] = None, *, project: Optional[str] = None, target_https_proxy_resource: Optional[compute.TargetHttpsProxy] = None, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = (), ) -> extended_operation.ExtendedOperation: r"""Creates a TargetHttpsProxy resource in the specified project using the data included in the request. .. code-block:: python # 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.TargetHttpsProxiesClient() # Initialize request argument(s) request = compute_v1.InsertTargetHttpsProxyRequest( project="project_value", ) # Make the request response = client.insert(request=request) # Handle the response print(response) Args: request (Union[google.cloud.compute_v1.types.InsertTargetHttpsProxyRequest, dict]): The request object. A request message for TargetHttpsProxies.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. target_https_proxy_resource (google.cloud.compute_v1.types.TargetHttpsProxy): The body resource for this request This corresponds to the ``target_https_proxy_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: google.api_core.extended_operation.ExtendedOperation: An object representing a extended long-running operation. """ # Create or coerce a protobuf request object. # - Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any([project, target_https_proxy_resource]) if request is not None and has_flattened_params: raise ValueError( "If the `request` argument is set, then none of " "the individual field arguments should be set." ) # - Use the request object if provided (there's no risk of modifying the input as # there are no flattened fields), or create one. if not isinstance(request, compute.InsertTargetHttpsProxyRequest): request = compute.InsertTargetHttpsProxyRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if project is not None: request.project = project if target_https_proxy_resource is not None: request.target_https_proxy_resource = target_https_proxy_resource # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = self._transport._wrapped_methods[self._transport.insert] # Certain fields should be provided within the metadata header; # add these here. metadata = tuple(metadata) + ( gapic_v1.routing_header.to_grpc_metadata((("project", request.project),)), ) # Validate the universe domain. self._validate_universe_domain() # Send the request. response = rpc( request, retry=retry, timeout=timeout, metadata=metadata, ) operation_service = self._transport._global_operations_client operation_request = compute.GetGlobalOperationRequest() operation_request.project = request.project operation_request.operation = response.name get_operation = functools.partial(operation_service.get, operation_request) # Cancel is not part of extended operations yet. cancel_operation = lambda: None # Note: this class is an implementation detail to provide a uniform # set of names for certain fields in the extended operation proto message. # See google.api_core.extended_operation.ExtendedOperation for details # on these properties and the expected interface. class _CustomOperation(extended_operation.ExtendedOperation): @property def error_message(self): return self._extended_operation.http_error_message @property def error_code(self): return self._extended_operation.http_error_status_code response = _CustomOperation.make(get_operation, cancel_operation, response) # Done; return the response. return response
[docs] def list( self, request: Optional[Union[compute.ListTargetHttpsProxiesRequest, dict]] = None, *, project: Optional[str] = None, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = (), ) -> pagers.ListPager: r"""Retrieves the list of TargetHttpsProxy resources available to the specified project. .. code-block:: python # 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.TargetHttpsProxiesClient() # Initialize request argument(s) request = compute_v1.ListTargetHttpsProxiesRequest( project="project_value", ) # Make the request page_result = client.list(request=request) # Handle the response for response in page_result: print(response) Args: request (Union[google.cloud.compute_v1.types.ListTargetHttpsProxiesRequest, dict]): The request object. A request message for TargetHttpsProxies.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: google.cloud.compute_v1.services.target_https_proxies.pagers.ListPager: Contains a list of TargetHttpsProxy resources. Iterating over this object will yield results and resolve additional pages automatically. """ # Create or coerce a protobuf request object. # - Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any([project]) if request is not None and has_flattened_params: raise ValueError( "If the `request` argument is set, then none of " "the individual field arguments should be set." ) # - Use the request object if provided (there's no risk of modifying the input as # there are no flattened fields), or create one. if not isinstance(request, compute.ListTargetHttpsProxiesRequest): request = compute.ListTargetHttpsProxiesRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if project is not None: request.project = project # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = self._transport._wrapped_methods[self._transport.list] # Certain fields should be provided within the metadata header; # add these here. metadata = tuple(metadata) + ( gapic_v1.routing_header.to_grpc_metadata((("project", request.project),)), ) # Validate the universe domain. self._validate_universe_domain() # Send the request. response = rpc( request, retry=retry, timeout=timeout, metadata=metadata, ) # This method is paged; wrap the response in a pager, which provides # an `__iter__` convenience method. response = pagers.ListPager( method=rpc, request=request, response=response, retry=retry, timeout=timeout, metadata=metadata, ) # Done; return the response. return response
[docs] def patch_unary( self, request: Optional[Union[compute.PatchTargetHttpsProxyRequest, dict]] = None, *, project: Optional[str] = None, target_https_proxy: Optional[str] = None, target_https_proxy_resource: Optional[compute.TargetHttpsProxy] = None, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = (), ) -> compute.Operation: r"""Patches the specified TargetHttpsProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. .. code-block:: python # 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.TargetHttpsProxiesClient() # Initialize request argument(s) request = compute_v1.PatchTargetHttpsProxyRequest( project="project_value", target_https_proxy="target_https_proxy_value", ) # Make the request response = client.patch(request=request) # Handle the response print(response) Args: request (Union[google.cloud.compute_v1.types.PatchTargetHttpsProxyRequest, dict]): The request object. A request message for TargetHttpsProxies.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. target_https_proxy (str): Name of the TargetHttpsProxy resource to patch. This corresponds to the ``target_https_proxy`` field on the ``request`` instance; if ``request`` is provided, this should not be set. target_https_proxy_resource (google.cloud.compute_v1.types.TargetHttpsProxy): The body resource for this request This corresponds to the ``target_https_proxy_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: google.api_core.extended_operation.ExtendedOperation: An object representing a extended long-running operation. """ # Create or coerce a protobuf request object. # - Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any( [project, target_https_proxy, target_https_proxy_resource] ) if request is not None and has_flattened_params: raise ValueError( "If the `request` argument is set, then none of " "the individual field arguments should be set." ) # - Use the request object if provided (there's no risk of modifying the input as # there are no flattened fields), or create one. if not isinstance(request, compute.PatchTargetHttpsProxyRequest): request = compute.PatchTargetHttpsProxyRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if project is not None: request.project = project if target_https_proxy is not None: request.target_https_proxy = target_https_proxy if target_https_proxy_resource is not None: request.target_https_proxy_resource = target_https_proxy_resource # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = self._transport._wrapped_methods[self._transport.patch] # Certain fields should be provided within the metadata header; # add these here. metadata = tuple(metadata) + ( gapic_v1.routing_header.to_grpc_metadata( ( ("project", request.project), ("target_https_proxy", request.target_https_proxy), ) ), ) # Validate the universe domain. self._validate_universe_domain() # Send the request. response = rpc( request, retry=retry, timeout=timeout, metadata=metadata, ) # Done; return the response. return response
[docs] def patch( self, request: Optional[Union[compute.PatchTargetHttpsProxyRequest, dict]] = None, *, project: Optional[str] = None, target_https_proxy: Optional[str] = None, target_https_proxy_resource: Optional[compute.TargetHttpsProxy] = None, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = (), ) -> extended_operation.ExtendedOperation: r"""Patches the specified TargetHttpsProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. .. code-block:: python # 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.TargetHttpsProxiesClient() # Initialize request argument(s) request = compute_v1.PatchTargetHttpsProxyRequest( project="project_value", target_https_proxy="target_https_proxy_value", ) # Make the request response = client.patch(request=request) # Handle the response print(response) Args: request (Union[google.cloud.compute_v1.types.PatchTargetHttpsProxyRequest, dict]): The request object. A request message for TargetHttpsProxies.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. target_https_proxy (str): Name of the TargetHttpsProxy resource to patch. This corresponds to the ``target_https_proxy`` field on the ``request`` instance; if ``request`` is provided, this should not be set. target_https_proxy_resource (google.cloud.compute_v1.types.TargetHttpsProxy): The body resource for this request This corresponds to the ``target_https_proxy_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: google.api_core.extended_operation.ExtendedOperation: An object representing a extended long-running operation. """ # Create or coerce a protobuf request object. # - Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any( [project, target_https_proxy, target_https_proxy_resource] ) if request is not None and has_flattened_params: raise ValueError( "If the `request` argument is set, then none of " "the individual field arguments should be set." ) # - Use the request object if provided (there's no risk of modifying the input as # there are no flattened fields), or create one. if not isinstance(request, compute.PatchTargetHttpsProxyRequest): request = compute.PatchTargetHttpsProxyRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if project is not None: request.project = project if target_https_proxy is not None: request.target_https_proxy = target_https_proxy if target_https_proxy_resource is not None: request.target_https_proxy_resource = target_https_proxy_resource # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = self._transport._wrapped_methods[self._transport.patch] # Certain fields should be provided within the metadata header; # add these here. metadata = tuple(metadata) + ( gapic_v1.routing_header.to_grpc_metadata( ( ("project", request.project), ("target_https_proxy", request.target_https_proxy), ) ), ) # Validate the universe domain. self._validate_universe_domain() # Send the request. response = rpc( request, retry=retry, timeout=timeout, metadata=metadata, ) operation_service = self._transport._global_operations_client operation_request = compute.GetGlobalOperationRequest() operation_request.project = request.project operation_request.operation = response.name get_operation = functools.partial(operation_service.get, operation_request) # Cancel is not part of extended operations yet. cancel_operation = lambda: None # Note: this class is an implementation detail to provide a uniform # set of names for certain fields in the extended operation proto message. # See google.api_core.extended_operation.ExtendedOperation for details # on these properties and the expected interface. class _CustomOperation(extended_operation.ExtendedOperation): @property def error_message(self): return self._extended_operation.http_error_message @property def error_code(self): return self._extended_operation.http_error_status_code response = _CustomOperation.make(get_operation, cancel_operation, response) # Done; return the response. return response
[docs] def set_certificate_map_unary( self, request: Optional[ Union[compute.SetCertificateMapTargetHttpsProxyRequest, dict] ] = None, *, project: Optional[str] = None, target_https_proxy: Optional[str] = None, target_https_proxies_set_certificate_map_request_resource: Optional[ compute.TargetHttpsProxiesSetCertificateMapRequest ] = None, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = (), ) -> compute.Operation: r"""Changes the Certificate Map for TargetHttpsProxy. .. code-block:: python # 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_certificate_map(): # Create a client client = compute_v1.TargetHttpsProxiesClient() # Initialize request argument(s) request = compute_v1.SetCertificateMapTargetHttpsProxyRequest( project="project_value", target_https_proxy="target_https_proxy_value", ) # Make the request response = client.set_certificate_map(request=request) # Handle the response print(response) Args: request (Union[google.cloud.compute_v1.types.SetCertificateMapTargetHttpsProxyRequest, dict]): The request object. A request message for TargetHttpsProxies.SetCertificateMap. 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. target_https_proxy (str): Name of the TargetHttpsProxy resource whose CertificateMap is to be set. The name must be 1-63 characters long, and comply with RFC1035. This corresponds to the ``target_https_proxy`` field on the ``request`` instance; if ``request`` is provided, this should not be set. target_https_proxies_set_certificate_map_request_resource (google.cloud.compute_v1.types.TargetHttpsProxiesSetCertificateMapRequest): The body resource for this request This corresponds to the ``target_https_proxies_set_certificate_map_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: google.api_core.extended_operation.ExtendedOperation: An object representing a extended long-running operation. """ # Create or coerce a protobuf request object. # - Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any( [ project, target_https_proxy, target_https_proxies_set_certificate_map_request_resource, ] ) if request is not None and has_flattened_params: raise ValueError( "If the `request` argument is set, then none of " "the individual field arguments should be set." ) # - Use the request object if provided (there's no risk of modifying the input as # there are no flattened fields), or create one. if not isinstance(request, compute.SetCertificateMapTargetHttpsProxyRequest): request = compute.SetCertificateMapTargetHttpsProxyRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if project is not None: request.project = project if target_https_proxy is not None: request.target_https_proxy = target_https_proxy if target_https_proxies_set_certificate_map_request_resource is not None: request.target_https_proxies_set_certificate_map_request_resource = ( target_https_proxies_set_certificate_map_request_resource ) # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = self._transport._wrapped_methods[self._transport.set_certificate_map] # Certain fields should be provided within the metadata header; # add these here. metadata = tuple(metadata) + ( gapic_v1.routing_header.to_grpc_metadata( ( ("project", request.project), ("target_https_proxy", request.target_https_proxy), ) ), ) # Validate the universe domain. self._validate_universe_domain() # Send the request. response = rpc( request, retry=retry, timeout=timeout, metadata=metadata, ) # Done; return the response. return response
[docs] def set_certificate_map( self, request: Optional[ Union[compute.SetCertificateMapTargetHttpsProxyRequest, dict] ] = None, *, project: Optional[str] = None, target_https_proxy: Optional[str] = None, target_https_proxies_set_certificate_map_request_resource: Optional[ compute.TargetHttpsProxiesSetCertificateMapRequest ] = None, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = (), ) -> extended_operation.ExtendedOperation: r"""Changes the Certificate Map for TargetHttpsProxy. .. code-block:: python # 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_certificate_map(): # Create a client client = compute_v1.TargetHttpsProxiesClient() # Initialize request argument(s) request = compute_v1.SetCertificateMapTargetHttpsProxyRequest( project="project_value", target_https_proxy="target_https_proxy_value", ) # Make the request response = client.set_certificate_map(request=request) # Handle the response print(response) Args: request (Union[google.cloud.compute_v1.types.SetCertificateMapTargetHttpsProxyRequest, dict]): The request object. A request message for TargetHttpsProxies.SetCertificateMap. 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. target_https_proxy (str): Name of the TargetHttpsProxy resource whose CertificateMap is to be set. The name must be 1-63 characters long, and comply with RFC1035. This corresponds to the ``target_https_proxy`` field on the ``request`` instance; if ``request`` is provided, this should not be set. target_https_proxies_set_certificate_map_request_resource (google.cloud.compute_v1.types.TargetHttpsProxiesSetCertificateMapRequest): The body resource for this request This corresponds to the ``target_https_proxies_set_certificate_map_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: google.api_core.extended_operation.ExtendedOperation: An object representing a extended long-running operation. """ # Create or coerce a protobuf request object. # - Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any( [ project, target_https_proxy, target_https_proxies_set_certificate_map_request_resource, ] ) if request is not None and has_flattened_params: raise ValueError( "If the `request` argument is set, then none of " "the individual field arguments should be set." ) # - Use the request object if provided (there's no risk of modifying the input as # there are no flattened fields), or create one. if not isinstance(request, compute.SetCertificateMapTargetHttpsProxyRequest): request = compute.SetCertificateMapTargetHttpsProxyRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if project is not None: request.project = project if target_https_proxy is not None: request.target_https_proxy = target_https_proxy if target_https_proxies_set_certificate_map_request_resource is not None: request.target_https_proxies_set_certificate_map_request_resource = ( target_https_proxies_set_certificate_map_request_resource ) # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = self._transport._wrapped_methods[self._transport.set_certificate_map] # Certain fields should be provided within the metadata header; # add these here. metadata = tuple(metadata) + ( gapic_v1.routing_header.to_grpc_metadata( ( ("project", request.project), ("target_https_proxy", request.target_https_proxy), ) ), ) # Validate the universe domain. self._validate_universe_domain() # Send the request. response = rpc( request, retry=retry, timeout=timeout, metadata=metadata, ) operation_service = self._transport._global_operations_client operation_request = compute.GetGlobalOperationRequest() operation_request.project = request.project operation_request.operation = response.name get_operation = functools.partial(operation_service.get, operation_request) # Cancel is not part of extended operations yet. cancel_operation = lambda: None # Note: this class is an implementation detail to provide a uniform # set of names for certain fields in the extended operation proto message. # See google.api_core.extended_operation.ExtendedOperation for details # on these properties and the expected interface. class _CustomOperation(extended_operation.ExtendedOperation): @property def error_message(self): return self._extended_operation.http_error_message @property def error_code(self): return self._extended_operation.http_error_status_code response = _CustomOperation.make(get_operation, cancel_operation, response) # Done; return the response. return response
[docs] def set_quic_override_unary( self, request: Optional[ Union[compute.SetQuicOverrideTargetHttpsProxyRequest, dict] ] = None, *, project: Optional[str] = None, target_https_proxy: Optional[str] = None, target_https_proxies_set_quic_override_request_resource: Optional[ compute.TargetHttpsProxiesSetQuicOverrideRequest ] = None, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = (), ) -> compute.Operation: r"""Sets the QUIC override policy for TargetHttpsProxy. .. code-block:: python # 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_quic_override(): # Create a client client = compute_v1.TargetHttpsProxiesClient() # Initialize request argument(s) request = compute_v1.SetQuicOverrideTargetHttpsProxyRequest( project="project_value", target_https_proxy="target_https_proxy_value", ) # Make the request response = client.set_quic_override(request=request) # Handle the response print(response) Args: request (Union[google.cloud.compute_v1.types.SetQuicOverrideTargetHttpsProxyRequest, dict]): The request object. A request message for TargetHttpsProxies.SetQuicOverride. 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. target_https_proxy (str): Name of the TargetHttpsProxy resource to set the QUIC override policy for. The name should conform to RFC1035. This corresponds to the ``target_https_proxy`` field on the ``request`` instance; if ``request`` is provided, this should not be set. target_https_proxies_set_quic_override_request_resource (google.cloud.compute_v1.types.TargetHttpsProxiesSetQuicOverrideRequest): The body resource for this request This corresponds to the ``target_https_proxies_set_quic_override_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: google.api_core.extended_operation.ExtendedOperation: An object representing a extended long-running operation. """ # Create or coerce a protobuf request object. # - Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any( [ project, target_https_proxy, target_https_proxies_set_quic_override_request_resource, ] ) if request is not None and has_flattened_params: raise ValueError( "If the `request` argument is set, then none of " "the individual field arguments should be set." ) # - Use the request object if provided (there's no risk of modifying the input as # there are no flattened fields), or create one. if not isinstance(request, compute.SetQuicOverrideTargetHttpsProxyRequest): request = compute.SetQuicOverrideTargetHttpsProxyRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if project is not None: request.project = project if target_https_proxy is not None: request.target_https_proxy = target_https_proxy if target_https_proxies_set_quic_override_request_resource is not None: request.target_https_proxies_set_quic_override_request_resource = ( target_https_proxies_set_quic_override_request_resource ) # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = self._transport._wrapped_methods[self._transport.set_quic_override] # Certain fields should be provided within the metadata header; # add these here. metadata = tuple(metadata) + ( gapic_v1.routing_header.to_grpc_metadata( ( ("project", request.project), ("target_https_proxy", request.target_https_proxy), ) ), ) # Validate the universe domain. self._validate_universe_domain() # Send the request. response = rpc( request, retry=retry, timeout=timeout, metadata=metadata, ) # Done; return the response. return response
[docs] def set_quic_override( self, request: Optional[ Union[compute.SetQuicOverrideTargetHttpsProxyRequest, dict] ] = None, *, project: Optional[str] = None, target_https_proxy: Optional[str] = None, target_https_proxies_set_quic_override_request_resource: Optional[ compute.TargetHttpsProxiesSetQuicOverrideRequest ] = None, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = (), ) -> extended_operation.ExtendedOperation: r"""Sets the QUIC override policy for TargetHttpsProxy. .. code-block:: python # 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_quic_override(): # Create a client client = compute_v1.TargetHttpsProxiesClient() # Initialize request argument(s) request = compute_v1.SetQuicOverrideTargetHttpsProxyRequest( project="project_value", target_https_proxy="target_https_proxy_value", ) # Make the request response = client.set_quic_override(request=request) # Handle the response print(response) Args: request (Union[google.cloud.compute_v1.types.SetQuicOverrideTargetHttpsProxyRequest, dict]): The request object. A request message for TargetHttpsProxies.SetQuicOverride. 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. target_https_proxy (str): Name of the TargetHttpsProxy resource to set the QUIC override policy for. The name should conform to RFC1035. This corresponds to the ``target_https_proxy`` field on the ``request`` instance; if ``request`` is provided, this should not be set. target_https_proxies_set_quic_override_request_resource (google.cloud.compute_v1.types.TargetHttpsProxiesSetQuicOverrideRequest): The body resource for this request This corresponds to the ``target_https_proxies_set_quic_override_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: google.api_core.extended_operation.ExtendedOperation: An object representing a extended long-running operation. """ # Create or coerce a protobuf request object. # - Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any( [ project, target_https_proxy, target_https_proxies_set_quic_override_request_resource, ] ) if request is not None and has_flattened_params: raise ValueError( "If the `request` argument is set, then none of " "the individual field arguments should be set." ) # - Use the request object if provided (there's no risk of modifying the input as # there are no flattened fields), or create one. if not isinstance(request, compute.SetQuicOverrideTargetHttpsProxyRequest): request = compute.SetQuicOverrideTargetHttpsProxyRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if project is not None: request.project = project if target_https_proxy is not None: request.target_https_proxy = target_https_proxy if target_https_proxies_set_quic_override_request_resource is not None: request.target_https_proxies_set_quic_override_request_resource = ( target_https_proxies_set_quic_override_request_resource ) # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = self._transport._wrapped_methods[self._transport.set_quic_override] # Certain fields should be provided within the metadata header; # add these here. metadata = tuple(metadata) + ( gapic_v1.routing_header.to_grpc_metadata( ( ("project", request.project), ("target_https_proxy", request.target_https_proxy), ) ), ) # Validate the universe domain. self._validate_universe_domain() # Send the request. response = rpc( request, retry=retry, timeout=timeout, metadata=metadata, ) operation_service = self._transport._global_operations_client operation_request = compute.GetGlobalOperationRequest() operation_request.project = request.project operation_request.operation = response.name get_operation = functools.partial(operation_service.get, operation_request) # Cancel is not part of extended operations yet. cancel_operation = lambda: None # Note: this class is an implementation detail to provide a uniform # set of names for certain fields in the extended operation proto message. # See google.api_core.extended_operation.ExtendedOperation for details # on these properties and the expected interface. class _CustomOperation(extended_operation.ExtendedOperation): @property def error_message(self): return self._extended_operation.http_error_message @property def error_code(self): return self._extended_operation.http_error_status_code response = _CustomOperation.make(get_operation, cancel_operation, response) # Done; return the response. return response
[docs] def set_ssl_certificates_unary( self, request: Optional[ Union[compute.SetSslCertificatesTargetHttpsProxyRequest, dict] ] = None, *, project: Optional[str] = None, target_https_proxy: Optional[str] = None, target_https_proxies_set_ssl_certificates_request_resource: Optional[ compute.TargetHttpsProxiesSetSslCertificatesRequest ] = None, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = (), ) -> compute.Operation: r"""Replaces SslCertificates for TargetHttpsProxy. .. code-block:: python # 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_ssl_certificates(): # Create a client client = compute_v1.TargetHttpsProxiesClient() # Initialize request argument(s) request = compute_v1.SetSslCertificatesTargetHttpsProxyRequest( project="project_value", target_https_proxy="target_https_proxy_value", ) # Make the request response = client.set_ssl_certificates(request=request) # Handle the response print(response) Args: request (Union[google.cloud.compute_v1.types.SetSslCertificatesTargetHttpsProxyRequest, dict]): The request object. A request message for TargetHttpsProxies.SetSslCertificates. 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. target_https_proxy (str): Name of the TargetHttpsProxy resource to set an SslCertificates resource for. This corresponds to the ``target_https_proxy`` field on the ``request`` instance; if ``request`` is provided, this should not be set. target_https_proxies_set_ssl_certificates_request_resource (google.cloud.compute_v1.types.TargetHttpsProxiesSetSslCertificatesRequest): The body resource for this request This corresponds to the ``target_https_proxies_set_ssl_certificates_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: google.api_core.extended_operation.ExtendedOperation: An object representing a extended long-running operation. """ # Create or coerce a protobuf request object. # - Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any( [ project, target_https_proxy, target_https_proxies_set_ssl_certificates_request_resource, ] ) if request is not None and has_flattened_params: raise ValueError( "If the `request` argument is set, then none of " "the individual field arguments should be set." ) # - Use the request object if provided (there's no risk of modifying the input as # there are no flattened fields), or create one. if not isinstance(request, compute.SetSslCertificatesTargetHttpsProxyRequest): request = compute.SetSslCertificatesTargetHttpsProxyRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if project is not None: request.project = project if target_https_proxy is not None: request.target_https_proxy = target_https_proxy if target_https_proxies_set_ssl_certificates_request_resource is not None: request.target_https_proxies_set_ssl_certificates_request_resource = ( target_https_proxies_set_ssl_certificates_request_resource ) # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = self._transport._wrapped_methods[self._transport.set_ssl_certificates] # Certain fields should be provided within the metadata header; # add these here. metadata = tuple(metadata) + ( gapic_v1.routing_header.to_grpc_metadata( ( ("project", request.project), ("target_https_proxy", request.target_https_proxy), ) ), ) # Validate the universe domain. self._validate_universe_domain() # Send the request. response = rpc( request, retry=retry, timeout=timeout, metadata=metadata, ) # Done; return the response. return response
[docs] def set_ssl_certificates( self, request: Optional[ Union[compute.SetSslCertificatesTargetHttpsProxyRequest, dict] ] = None, *, project: Optional[str] = None, target_https_proxy: Optional[str] = None, target_https_proxies_set_ssl_certificates_request_resource: Optional[ compute.TargetHttpsProxiesSetSslCertificatesRequest ] = None, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = (), ) -> extended_operation.ExtendedOperation: r"""Replaces SslCertificates for TargetHttpsProxy. .. code-block:: python # 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_ssl_certificates(): # Create a client client = compute_v1.TargetHttpsProxiesClient() # Initialize request argument(s) request = compute_v1.SetSslCertificatesTargetHttpsProxyRequest( project="project_value", target_https_proxy="target_https_proxy_value", ) # Make the request response = client.set_ssl_certificates(request=request) # Handle the response print(response) Args: request (Union[google.cloud.compute_v1.types.SetSslCertificatesTargetHttpsProxyRequest, dict]): The request object. A request message for TargetHttpsProxies.SetSslCertificates. 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. target_https_proxy (str): Name of the TargetHttpsProxy resource to set an SslCertificates resource for. This corresponds to the ``target_https_proxy`` field on the ``request`` instance; if ``request`` is provided, this should not be set. target_https_proxies_set_ssl_certificates_request_resource (google.cloud.compute_v1.types.TargetHttpsProxiesSetSslCertificatesRequest): The body resource for this request This corresponds to the ``target_https_proxies_set_ssl_certificates_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: google.api_core.extended_operation.ExtendedOperation: An object representing a extended long-running operation. """ # Create or coerce a protobuf request object. # - Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any( [ project, target_https_proxy, target_https_proxies_set_ssl_certificates_request_resource, ] ) if request is not None and has_flattened_params: raise ValueError( "If the `request` argument is set, then none of " "the individual field arguments should be set." ) # - Use the request object if provided (there's no risk of modifying the input as # there are no flattened fields), or create one. if not isinstance(request, compute.SetSslCertificatesTargetHttpsProxyRequest): request = compute.SetSslCertificatesTargetHttpsProxyRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if project is not None: request.project = project if target_https_proxy is not None: request.target_https_proxy = target_https_proxy if target_https_proxies_set_ssl_certificates_request_resource is not None: request.target_https_proxies_set_ssl_certificates_request_resource = ( target_https_proxies_set_ssl_certificates_request_resource ) # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = self._transport._wrapped_methods[self._transport.set_ssl_certificates] # Certain fields should be provided within the metadata header; # add these here. metadata = tuple(metadata) + ( gapic_v1.routing_header.to_grpc_metadata( ( ("project", request.project), ("target_https_proxy", request.target_https_proxy), ) ), ) # Validate the universe domain. self._validate_universe_domain() # Send the request. response = rpc( request, retry=retry, timeout=timeout, metadata=metadata, ) operation_service = self._transport._global_operations_client operation_request = compute.GetGlobalOperationRequest() operation_request.project = request.project operation_request.operation = response.name get_operation = functools.partial(operation_service.get, operation_request) # Cancel is not part of extended operations yet. cancel_operation = lambda: None # Note: this class is an implementation detail to provide a uniform # set of names for certain fields in the extended operation proto message. # See google.api_core.extended_operation.ExtendedOperation for details # on these properties and the expected interface. class _CustomOperation(extended_operation.ExtendedOperation): @property def error_message(self): return self._extended_operation.http_error_message @property def error_code(self): return self._extended_operation.http_error_status_code response = _CustomOperation.make(get_operation, cancel_operation, response) # Done; return the response. return response
[docs] def set_ssl_policy_unary( self, request: Optional[ Union[compute.SetSslPolicyTargetHttpsProxyRequest, dict] ] = None, *, project: Optional[str] = None, target_https_proxy: Optional[str] = None, ssl_policy_reference_resource: Optional[compute.SslPolicyReference] = None, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = (), ) -> compute.Operation: r"""Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends. .. code-block:: python # 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_ssl_policy(): # Create a client client = compute_v1.TargetHttpsProxiesClient() # Initialize request argument(s) request = compute_v1.SetSslPolicyTargetHttpsProxyRequest( project="project_value", target_https_proxy="target_https_proxy_value", ) # Make the request response = client.set_ssl_policy(request=request) # Handle the response print(response) Args: request (Union[google.cloud.compute_v1.types.SetSslPolicyTargetHttpsProxyRequest, dict]): The request object. A request message for TargetHttpsProxies.SetSslPolicy. 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. target_https_proxy (str): Name of the TargetHttpsProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035. This corresponds to the ``target_https_proxy`` field on the ``request`` instance; if ``request`` is provided, this should not be set. ssl_policy_reference_resource (google.cloud.compute_v1.types.SslPolicyReference): The body resource for this request This corresponds to the ``ssl_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: google.api_core.extended_operation.ExtendedOperation: An object representing a extended long-running operation. """ # Create or coerce a protobuf request object. # - Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any( [project, target_https_proxy, ssl_policy_reference_resource] ) if request is not None and has_flattened_params: raise ValueError( "If the `request` argument is set, then none of " "the individual field arguments should be set." ) # - Use the request object if provided (there's no risk of modifying the input as # there are no flattened fields), or create one. if not isinstance(request, compute.SetSslPolicyTargetHttpsProxyRequest): request = compute.SetSslPolicyTargetHttpsProxyRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if project is not None: request.project = project if target_https_proxy is not None: request.target_https_proxy = target_https_proxy if ssl_policy_reference_resource is not None: request.ssl_policy_reference_resource = ssl_policy_reference_resource # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = self._transport._wrapped_methods[self._transport.set_ssl_policy] # Certain fields should be provided within the metadata header; # add these here. metadata = tuple(metadata) + ( gapic_v1.routing_header.to_grpc_metadata( ( ("project", request.project), ("target_https_proxy", request.target_https_proxy), ) ), ) # Validate the universe domain. self._validate_universe_domain() # Send the request. response = rpc( request, retry=retry, timeout=timeout, metadata=metadata, ) # Done; return the response. return response
[docs] def set_ssl_policy( self, request: Optional[ Union[compute.SetSslPolicyTargetHttpsProxyRequest, dict] ] = None, *, project: Optional[str] = None, target_https_proxy: Optional[str] = None, ssl_policy_reference_resource: Optional[compute.SslPolicyReference] = None, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = (), ) -> extended_operation.ExtendedOperation: r"""Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends. .. code-block:: python # 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_ssl_policy(): # Create a client client = compute_v1.TargetHttpsProxiesClient() # Initialize request argument(s) request = compute_v1.SetSslPolicyTargetHttpsProxyRequest( project="project_value", target_https_proxy="target_https_proxy_value", ) # Make the request response = client.set_ssl_policy(request=request) # Handle the response print(response) Args: request (Union[google.cloud.compute_v1.types.SetSslPolicyTargetHttpsProxyRequest, dict]): The request object. A request message for TargetHttpsProxies.SetSslPolicy. 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. target_https_proxy (str): Name of the TargetHttpsProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035. This corresponds to the ``target_https_proxy`` field on the ``request`` instance; if ``request`` is provided, this should not be set. ssl_policy_reference_resource (google.cloud.compute_v1.types.SslPolicyReference): The body resource for this request This corresponds to the ``ssl_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: google.api_core.extended_operation.ExtendedOperation: An object representing a extended long-running operation. """ # Create or coerce a protobuf request object. # - Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any( [project, target_https_proxy, ssl_policy_reference_resource] ) if request is not None and has_flattened_params: raise ValueError( "If the `request` argument is set, then none of " "the individual field arguments should be set." ) # - Use the request object if provided (there's no risk of modifying the input as # there are no flattened fields), or create one. if not isinstance(request, compute.SetSslPolicyTargetHttpsProxyRequest): request = compute.SetSslPolicyTargetHttpsProxyRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if project is not None: request.project = project if target_https_proxy is not None: request.target_https_proxy = target_https_proxy if ssl_policy_reference_resource is not None: request.ssl_policy_reference_resource = ssl_policy_reference_resource # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = self._transport._wrapped_methods[self._transport.set_ssl_policy] # Certain fields should be provided within the metadata header; # add these here. metadata = tuple(metadata) + ( gapic_v1.routing_header.to_grpc_metadata( ( ("project", request.project), ("target_https_proxy", request.target_https_proxy), ) ), ) # Validate the universe domain. self._validate_universe_domain() # Send the request. response = rpc( request, retry=retry, timeout=timeout, metadata=metadata, ) operation_service = self._transport._global_operations_client operation_request = compute.GetGlobalOperationRequest() operation_request.project = request.project operation_request.operation = response.name get_operation = functools.partial(operation_service.get, operation_request) # Cancel is not part of extended operations yet. cancel_operation = lambda: None # Note: this class is an implementation detail to provide a uniform # set of names for certain fields in the extended operation proto message. # See google.api_core.extended_operation.ExtendedOperation for details # on these properties and the expected interface. class _CustomOperation(extended_operation.ExtendedOperation): @property def error_message(self): return self._extended_operation.http_error_message @property def error_code(self): return self._extended_operation.http_error_status_code response = _CustomOperation.make(get_operation, cancel_operation, response) # Done; return the response. return response
[docs] def set_url_map_unary( self, request: Optional[Union[compute.SetUrlMapTargetHttpsProxyRequest, dict]] = None, *, project: Optional[str] = None, target_https_proxy: Optional[str] = None, url_map_reference_resource: Optional[compute.UrlMapReference] = None, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = (), ) -> compute.Operation: r"""Changes the URL map for TargetHttpsProxy. .. code-block:: python # 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_url_map(): # Create a client client = compute_v1.TargetHttpsProxiesClient() # Initialize request argument(s) request = compute_v1.SetUrlMapTargetHttpsProxyRequest( project="project_value", target_https_proxy="target_https_proxy_value", ) # Make the request response = client.set_url_map(request=request) # Handle the response print(response) Args: request (Union[google.cloud.compute_v1.types.SetUrlMapTargetHttpsProxyRequest, dict]): The request object. A request message for TargetHttpsProxies.SetUrlMap. 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. target_https_proxy (str): Name of the TargetHttpsProxy resource whose URL map is to be set. This corresponds to the ``target_https_proxy`` field on the ``request`` instance; if ``request`` is provided, this should not be set. url_map_reference_resource (google.cloud.compute_v1.types.UrlMapReference): The body resource for this request This corresponds to the ``url_map_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: google.api_core.extended_operation.ExtendedOperation: An object representing a extended long-running operation. """ # Create or coerce a protobuf request object. # - Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any( [project, target_https_proxy, url_map_reference_resource] ) if request is not None and has_flattened_params: raise ValueError( "If the `request` argument is set, then none of " "the individual field arguments should be set." ) # - Use the request object if provided (there's no risk of modifying the input as # there are no flattened fields), or create one. if not isinstance(request, compute.SetUrlMapTargetHttpsProxyRequest): request = compute.SetUrlMapTargetHttpsProxyRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if project is not None: request.project = project if target_https_proxy is not None: request.target_https_proxy = target_https_proxy if url_map_reference_resource is not None: request.url_map_reference_resource = url_map_reference_resource # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = self._transport._wrapped_methods[self._transport.set_url_map] # Certain fields should be provided within the metadata header; # add these here. metadata = tuple(metadata) + ( gapic_v1.routing_header.to_grpc_metadata( ( ("project", request.project), ("target_https_proxy", request.target_https_proxy), ) ), ) # Validate the universe domain. self._validate_universe_domain() # Send the request. response = rpc( request, retry=retry, timeout=timeout, metadata=metadata, ) # Done; return the response. return response
[docs] def set_url_map( self, request: Optional[Union[compute.SetUrlMapTargetHttpsProxyRequest, dict]] = None, *, project: Optional[str] = None, target_https_proxy: Optional[str] = None, url_map_reference_resource: Optional[compute.UrlMapReference] = None, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = (), ) -> extended_operation.ExtendedOperation: r"""Changes the URL map for TargetHttpsProxy. .. code-block:: python # 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_url_map(): # Create a client client = compute_v1.TargetHttpsProxiesClient() # Initialize request argument(s) request = compute_v1.SetUrlMapTargetHttpsProxyRequest( project="project_value", target_https_proxy="target_https_proxy_value", ) # Make the request response = client.set_url_map(request=request) # Handle the response print(response) Args: request (Union[google.cloud.compute_v1.types.SetUrlMapTargetHttpsProxyRequest, dict]): The request object. A request message for TargetHttpsProxies.SetUrlMap. 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. target_https_proxy (str): Name of the TargetHttpsProxy resource whose URL map is to be set. This corresponds to the ``target_https_proxy`` field on the ``request`` instance; if ``request`` is provided, this should not be set. url_map_reference_resource (google.cloud.compute_v1.types.UrlMapReference): The body resource for this request This corresponds to the ``url_map_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: google.api_core.extended_operation.ExtendedOperation: An object representing a extended long-running operation. """ # Create or coerce a protobuf request object. # - Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any( [project, target_https_proxy, url_map_reference_resource] ) if request is not None and has_flattened_params: raise ValueError( "If the `request` argument is set, then none of " "the individual field arguments should be set." ) # - Use the request object if provided (there's no risk of modifying the input as # there are no flattened fields), or create one. if not isinstance(request, compute.SetUrlMapTargetHttpsProxyRequest): request = compute.SetUrlMapTargetHttpsProxyRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if project is not None: request.project = project if target_https_proxy is not None: request.target_https_proxy = target_https_proxy if url_map_reference_resource is not None: request.url_map_reference_resource = url_map_reference_resource # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = self._transport._wrapped_methods[self._transport.set_url_map] # Certain fields should be provided within the metadata header; # add these here. metadata = tuple(metadata) + ( gapic_v1.routing_header.to_grpc_metadata( ( ("project", request.project), ("target_https_proxy", request.target_https_proxy), ) ), ) # Validate the universe domain. self._validate_universe_domain() # Send the request. response = rpc( request, retry=retry, timeout=timeout, metadata=metadata, ) operation_service = self._transport._global_operations_client operation_request = compute.GetGlobalOperationRequest() operation_request.project = request.project operation_request.operation = response.name get_operation = functools.partial(operation_service.get, operation_request) # Cancel is not part of extended operations yet. cancel_operation = lambda: None # Note: this class is an implementation detail to provide a uniform # set of names for certain fields in the extended operation proto message. # See google.api_core.extended_operation.ExtendedOperation for details # on these properties and the expected interface. class _CustomOperation(extended_operation.ExtendedOperation): @property def error_message(self): return self._extended_operation.http_error_message @property def error_code(self): return self._extended_operation.http_error_status_code response = _CustomOperation.make(get_operation, cancel_operation, response) # Done; return the response. return response
def __enter__(self) -> "TargetHttpsProxiesClient": return self
[docs] def __exit__(self, 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! """ self.transport.close()
DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( gapic_version=package_version.__version__ ) __all__ = ("TargetHttpsProxiesClient",)