feat(gapic): support mTLS certificates when available (#1140)

Autogenerated gapic update
Includes:
- support for mTLS by default when the environment detects it
- support for pipelines protos

Author: daniel-sanche

.librarian/state.yaml

@@ -1,4 +1,4 @@
-image: us-central1-docker.pkg.dev/cloud-sdk-librarian-prod/images-prod/python-librarian-generator@sha256:ce48ed695c727f7e13efd1fd68f466a55a0d772c87b69158720cec39965bc8b2
+image: us-central1-docker.pkg.dev/cloud-sdk-librarian-prod/images-prod/python-librarian-generator@sha256:eec191fc4904c204cd717c79812cd66997b5559776483ee223f69c8f43e99224
 libraries:
  - id: google-cloud-firestore
 version: 2.21.0

google/cloud/firestore_admin_v1/services/__init__.py

@@ -13,3 +13,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+
+# DO NOT EDIT THIS FILE OUTSIDE OF `.librarian/generator-input`
+# The source of truth for this file is `.librarian/generator-input`

google/cloud/firestore_admin_v1/services/firestore_admin/__init__.py

@@ -13,8 +13,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-from .clientimportFirestoreAdminClient
+
+# DO NOT EDIT THIS FILE OUTSIDE OF `.librarian/generator-input`
+# The source of truth for this file is `.librarian/generator-input`
+
 from .async_clientimportFirestoreAdminAsyncClient
+from .clientimportFirestoreAdminClient
 
 __all__= (
 "FirestoreAdminClient",

google/cloud/firestore_admin_v1/services/firestore_admin/async_client.py

@@ -13,12 +13,16 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-importloggingasstd_logging
+
+# DO NOT EDIT THIS FILE OUTSIDE OF `.librarian/generator-input`
+# The source of truth for this file is `.librarian/generator-input`
+
 fromcollectionsimportOrderedDict
+importloggingasstd_logging
 importre
 fromtypingimport (
-Dict,
 Callable,
+Dict,
 Mapping,
 MutableMapping,
 MutableSequence,
@@ -29,16 +33,15 @@
 Union,
 )
 
-fromgoogle.cloud.firestore_admin_v1importgapic_versionaspackage_version
-
-fromgoogle.api_core.client_optionsimportClientOptions
 fromgoogle.api_coreimportexceptionsascore_exceptions
 fromgoogle.api_coreimportgapic_v1
 fromgoogle.api_coreimportretry_asyncasretries
+fromgoogle.api_core.client_optionsimportClientOptions
 fromgoogle.authimportcredentialsasga_credentials# type: ignore
 fromgoogle.oauth2importservice_account# type: ignore
 importgoogle.protobuf
 
+fromgoogle.cloud.firestore_admin_v1importgapic_versionaspackage_version
 
 try:
 OptionalRetry=Union[retries.AsyncRetry, gapic_v1.method._MethodDefault, None]
@@ -47,6 +50,13 @@
 
 fromgoogle.api_coreimportoperationasgac_operation# type: ignore
 fromgoogle.api_coreimportoperation_async# type: ignore
+fromgoogle.cloud.locationimportlocations_pb2# type: ignore
+fromgoogle.longrunningimportoperations_pb2# type: ignore
+fromgoogle.protobufimportduration_pb2# type: ignore
+fromgoogle.protobufimportempty_pb2# type: ignore
+fromgoogle.protobufimportfield_mask_pb2# type: ignore
+fromgoogle.protobufimporttimestamp_pb2# type: ignore
+
 fromgoogle.cloud.firestore_admin_v1.services.firestore_adminimportpagers
 fromgoogle.cloud.firestore_admin_v1.typesimportbackup
 fromgoogle.cloud.firestore_admin_v1.typesimportdatabase
@@ -60,15 +70,10 @@
 fromgoogle.cloud.firestore_admin_v1.typesimportschedule
 fromgoogle.cloud.firestore_admin_v1.typesimportuser_creds
 fromgoogle.cloud.firestore_admin_v1.typesimportuser_credsasgfa_user_creds
-fromgoogle.cloud.locationimportlocations_pb2# type: ignore
-fromgoogle.longrunningimportoperations_pb2# type: ignore
-fromgoogle.protobufimportduration_pb2# type: ignore
-fromgoogle.protobufimportempty_pb2# type: ignore
-fromgoogle.protobufimportfield_mask_pb2# type: ignore
-fromgoogle.protobufimporttimestamp_pb2# type: ignore
-from .transports.baseimportFirestoreAdminTransport, DEFAULT_CLIENT_INFO
-from .transports.grpc_asyncioimportFirestoreAdminGrpcAsyncIOTransport
+
 from .clientimportFirestoreAdminClient
+from .transports.baseimportDEFAULT_CLIENT_INFO, FirestoreAdminTransport
+from .transports.grpc_asyncioimportFirestoreAdminGrpcAsyncIOTransport
 
 try:
 fromgoogle.api_coreimportclient_logging# type: ignore

google/cloud/firestore_admin_v1/services/firestore_admin/client.py

@@ -13,15 +13,19 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+
+# DO NOT EDIT THIS FILE OUTSIDE OF `.librarian/generator-input`
+# The source of truth for this file is `.librarian/generator-input`
+
 fromcollectionsimportOrderedDict
 fromhttpimportHTTPStatus
 importjson
 importloggingasstd_logging
 importos
 importre
 fromtypingimport (
-Dict,
 Callable,
+Dict,
 Mapping,
 MutableMapping,
 MutableSequence,
@@ -34,19 +38,19 @@
 )
 importwarnings
 
-fromgoogle.cloud.firestore_admin_v1importgapic_versionaspackage_version
-
 fromgoogle.api_coreimportclient_optionsasclient_options_lib
 fromgoogle.api_coreimportexceptionsascore_exceptions
 fromgoogle.api_coreimportgapic_v1
 fromgoogle.api_coreimportretryasretries
 fromgoogle.authimportcredentialsasga_credentials# type: ignore
+fromgoogle.auth.exceptionsimportMutualTLSChannelError# type: ignore
 fromgoogle.auth.transportimportmtls# type: ignore
 fromgoogle.auth.transport.grpcimportSslCredentials# type: ignore
-fromgoogle.auth.exceptionsimportMutualTLSChannelError# type: ignore
 fromgoogle.oauth2importservice_account# type: ignore
 importgoogle.protobuf
 
+fromgoogle.cloud.firestore_admin_v1importgapic_versionaspackage_version
+
 try:
 OptionalRetry=Union[retries.Retry, gapic_v1.method._MethodDefault, None]
 exceptAttributeError: # pragma: NO COVER
@@ -63,6 +67,13 @@
 
 fromgoogle.api_coreimportoperationasgac_operation# type: ignore
 fromgoogle.api_coreimportoperation_async# type: ignore
+fromgoogle.cloud.locationimportlocations_pb2# type: ignore
+fromgoogle.longrunningimportoperations_pb2# type: ignore
+fromgoogle.protobufimportduration_pb2# type: ignore
+fromgoogle.protobufimportempty_pb2# type: ignore
+fromgoogle.protobufimportfield_mask_pb2# type: ignore
+fromgoogle.protobufimporttimestamp_pb2# type: ignore
+
 fromgoogle.cloud.firestore_admin_v1.services.firestore_adminimportpagers
 fromgoogle.cloud.firestore_admin_v1.typesimportbackup
 fromgoogle.cloud.firestore_admin_v1.typesimportdatabase
@@ -76,13 +87,8 @@
 fromgoogle.cloud.firestore_admin_v1.typesimportschedule
 fromgoogle.cloud.firestore_admin_v1.typesimportuser_creds
 fromgoogle.cloud.firestore_admin_v1.typesimportuser_credsasgfa_user_creds
-fromgoogle.cloud.locationimportlocations_pb2# type: ignore
-fromgoogle.longrunningimportoperations_pb2# type: ignore
-fromgoogle.protobufimportduration_pb2# type: ignore
-fromgoogle.protobufimportempty_pb2# type: ignore
-fromgoogle.protobufimportfield_mask_pb2# type: ignore
-fromgoogle.protobufimporttimestamp_pb2# type: ignore
-from .transports.baseimportFirestoreAdminTransport, DEFAULT_CLIENT_INFO
+
+from .transports.baseimportDEFAULT_CLIENT_INFO, FirestoreAdminTransport
 from .transports.grpcimportFirestoreAdminGrpcTransport
 from .transports.grpc_asyncioimportFirestoreAdminGrpcAsyncIOTransport
 from .transports.restimportFirestoreAdminRestTransport
@@ -198,6 +204,34 @@ def _get_default_mtls_endpoint(api_endpoint):
 _DEFAULT_ENDPOINT_TEMPLATE="firestore.{UNIVERSE_DOMAIN}"
 _DEFAULT_UNIVERSE="googleapis.com"
 
+@staticmethod
+def_use_client_cert_effective():
+"""Returns whether client certificate should be used for mTLS if the
+ google-auth version supports should_use_client_cert automatic mTLS enablement.
+
+ Alternatively, read from the GOOGLE_API_USE_CLIENT_CERTIFICATE env var.
+
+ Returns:
+ bool: whether client certificate should be used for mTLS
+ Raises:
+ ValueError: (If using a version of google-auth without should_use_client_cert and
+ GOOGLE_API_USE_CLIENT_CERTIFICATE is set to an unexpected value.)
+ """
+# check if google-auth version supports should_use_client_cert for automatic mTLS enablement
+ifhasattr(mtls, "should_use_client_cert"): # pragma: NO COVER
+returnmtls.should_use_client_cert()
+else: # pragma: NO COVER
+# if unsupported, fallback to reading from env var
+use_client_cert_str=os.getenv(
+"GOOGLE_API_USE_CLIENT_CERTIFICATE", "false"
+ ).lower()
+ifuse_client_cert_strnotin ("true", "false"):
+raiseValueError(
+"Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be"
+" either `true` or `false`"
+ )
+returnuse_client_cert_str=="true"
+
 @classmethod
 deffrom_service_account_info(cls, info: dict, *args, **kwargs):
 """Creates an instance of this client using the provided credentials
@@ -555,20 +589,16 @@ def get_mtls_endpoint_and_cert_source(
  )
 ifclient_optionsisNone:
 client_options=client_options_lib.ClientOptions()
-use_client_cert=os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false")
+use_client_cert=FirestoreAdminClient._use_client_cert_effective()
 use_mtls_endpoint=os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto")
-ifuse_client_certnotin ("true", "false"):
-raiseValueError(
-"Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`"
- )
 ifuse_mtls_endpointnotin ("auto", "never", "always"):
 raiseMutualTLSChannelError(
 "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
-ifuse_client_cert=="true":
+ifuse_client_cert:
 ifclient_options.client_cert_source:
 client_cert_source=client_options.client_cert_source
 elifmtls.has_default_client_cert_source():
@@ -600,20 +630,14 @@ def _read_environment_variables():
  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_client_cert=FirestoreAdminClient._use_client_cert_effective()
 use_mtls_endpoint=os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto").lower()
 universe_domain_env=os.getenv("GOOGLE_CLOUD_UNIVERSE_DOMAIN")
-ifuse_client_certnotin ("true", "false"):
-raiseValueError(
-"Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`"
- )
 ifuse_mtls_endpointnotin ("auto", "never", "always"):
 raiseMutualTLSChannelError(
 "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`"
  )
-returnuse_client_cert=="true", use_mtls_endpoint, universe_domain_env
+returnuse_client_cert, use_mtls_endpoint, universe_domain_env
 
 @staticmethod
 def_get_client_cert_source(provided_cert_source, use_cert_flag):

google/cloud/firestore_admin_v1/services/firestore_admin/pagers.py

@@ -13,21 +13,26 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-fromgoogle.api_coreimportgapic_v1
-fromgoogle.api_coreimportretryasretries
-fromgoogle.api_coreimportretry_asyncasretries_async
+
+# DO NOT EDIT THIS FILE OUTSIDE OF `.librarian/generator-input`
+# The source of truth for this file is `.librarian/generator-input`
+
 fromtypingimport (
 Any,
 AsyncIterator,
 Awaitable,
 Callable,
+Iterator,
+Optional,
 Sequence,
 Tuple,
-Optional,
-Iterator,
 Union,
 )
 
+fromgoogle.api_coreimportgapic_v1
+fromgoogle.api_coreimportretryasretries
+fromgoogle.api_coreimportretry_asyncasretries_async
+
 try:
 OptionalRetry=Union[retries.Retry, gapic_v1.method._MethodDefault, None]
 OptionalAsyncRetry=Union[
@@ -37,9 +42,7 @@
 OptionalRetry=Union[retries.Retry, object, None] # type: ignore
 OptionalAsyncRetry=Union[retries_async.AsyncRetry, object, None] # type: ignore
 
-fromgoogle.cloud.firestore_admin_v1.typesimportfield
-fromgoogle.cloud.firestore_admin_v1.typesimportfirestore_admin
-fromgoogle.cloud.firestore_admin_v1.typesimportindex
+fromgoogle.cloud.firestore_admin_v1.typesimportfield, firestore_admin, index
 
 
 classListIndexesPager:

google/cloud/firestore_admin_v1/services/firestore_admin/transports/README.rst

@@ -1,3 +1,6 @@
+# DO NOT EDIT THIS FILE OUTSIDE OF `.librarian/generator-input`
+# The source of truth for this file is `.librarian/generator-input`
+
 
 transport inheritance structure
 _______________________________

google/cloud/firestore_admin_v1/services/firestore_admin/transports/__init__.py

@@ -13,15 +13,17 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+
+# DO NOT EDIT THIS FILE OUTSIDE OF `.librarian/generator-input`
+# The source of truth for this file is `.librarian/generator-input`
+
 fromcollectionsimportOrderedDict
 fromtypingimportDict, Type
 
 from .baseimportFirestoreAdminTransport
 from .grpcimportFirestoreAdminGrpcTransport
 from .grpc_asyncioimportFirestoreAdminGrpcAsyncIOTransport
-from .restimportFirestoreAdminRestTransport
-from .restimportFirestoreAdminRestInterceptor
-
+from .restimportFirestoreAdminRestInterceptor, FirestoreAdminRestTransport
 
 # Compile a registry of transports.
 _transport_registry=OrderedDict() # type: Dict[str, Type[FirestoreAdminTransport]]

google/cloud/firestore_admin_v1/services/firestore_admin/transports/base.py

@@ -13,32 +13,36 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+
+# DO NOT EDIT THIS FILE OUTSIDE OF `.librarian/generator-input`
+# The source of truth for this file is `.librarian/generator-input`
+
 importabc
 fromtypingimportAwaitable, Callable, Dict, Optional, Sequence, Union
 
-fromgoogle.cloud.firestore_admin_v1importgapic_versionaspackage_version
-
-importgoogle.auth# type: ignore
 importgoogle.api_core
 fromgoogle.api_coreimportexceptionsascore_exceptions
-fromgoogle.api_coreimportgapic_v1
+fromgoogle.api_coreimportgapic_v1, operations_v1
 fromgoogle.api_coreimportretryasretries
-fromgoogle.api_coreimportoperations_v1
+importgoogle.auth# type: ignore
 fromgoogle.authimportcredentialsasga_credentials# type: ignore
+fromgoogle.cloud.locationimportlocations_pb2# type: ignore
+fromgoogle.longrunningimportoperations_pb2# type: ignore
 fromgoogle.oauth2importservice_account# type: ignore
 importgoogle.protobuf
+fromgoogle.protobufimportempty_pb2# type: ignore
 
-fromgoogle.cloud.firestore_admin_v1.typesimportbackup
-fromgoogle.cloud.firestore_admin_v1.typesimportdatabase
-fromgoogle.cloud.firestore_admin_v1.typesimportfield
-fromgoogle.cloud.firestore_admin_v1.typesimportfirestore_admin
-fromgoogle.cloud.firestore_admin_v1.typesimportindex
-fromgoogle.cloud.firestore_admin_v1.typesimportschedule
+fromgoogle.cloud.firestore_admin_v1importgapic_versionaspackage_version
+fromgoogle.cloud.firestore_admin_v1.typesimport (
+backup,
+database,
+field,
+firestore_admin,
+index,
+schedule,
+)
 fromgoogle.cloud.firestore_admin_v1.typesimportuser_creds
 fromgoogle.cloud.firestore_admin_v1.typesimportuser_credsasgfa_user_creds
-fromgoogle.cloud.locationimportlocations_pb2# type: ignore
-fromgoogle.longrunningimportoperations_pb2# type: ignore
-fromgoogle.protobufimportempty_pb2# type: ignore
 
 DEFAULT_CLIENT_INFO=gapic_v1.client_info.ClientInfo(
 gapic_version=package_version.__version__