google-cloud-privilegedaccessmanager 0.4.1__tar.gz → 0.4.2__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {google_cloud_privilegedaccessmanager-0.4.1/google_cloud_privilegedaccessmanager.egg-info → google_cloud_privilegedaccessmanager-0.4.2}/PKG-INFO +5 -5
- {google_cloud_privilegedaccessmanager-0.4.1 → google_cloud_privilegedaccessmanager-0.4.2}/google/cloud/privilegedaccessmanager/gapic_version.py +1 -1
- google_cloud_privilegedaccessmanager-0.4.2/google/cloud/privilegedaccessmanager_v1/__init__.py +101 -0
- google_cloud_privilegedaccessmanager-0.4.2/google/cloud/privilegedaccessmanager_v1/_compat.py +262 -0
- {google_cloud_privilegedaccessmanager-0.4.1 → google_cloud_privilegedaccessmanager-0.4.2}/google/cloud/privilegedaccessmanager_v1/gapic_version.py +1 -1
- {google_cloud_privilegedaccessmanager-0.4.1 → google_cloud_privilegedaccessmanager-0.4.2}/google/cloud/privilegedaccessmanager_v1/services/privileged_access_manager/async_client.py +1 -3
- {google_cloud_privilegedaccessmanager-0.4.1 → google_cloud_privilegedaccessmanager-0.4.2}/google/cloud/privilegedaccessmanager_v1/services/privileged_access_manager/client.py +24 -165
- {google_cloud_privilegedaccessmanager-0.4.1 → google_cloud_privilegedaccessmanager-0.4.2}/google/cloud/privilegedaccessmanager_v1/services/privileged_access_manager/transports/base.py +1 -3
- {google_cloud_privilegedaccessmanager-0.4.1 → google_cloud_privilegedaccessmanager-0.4.2}/google/cloud/privilegedaccessmanager_v1/services/privileged_access_manager/transports/rest.py +173 -178
- {google_cloud_privilegedaccessmanager-0.4.1 → google_cloud_privilegedaccessmanager-0.4.2}/google/cloud/privilegedaccessmanager_v1/services/privileged_access_manager/transports/rest_base.py +0 -545
- {google_cloud_privilegedaccessmanager-0.4.1 → google_cloud_privilegedaccessmanager-0.4.2/google_cloud_privilegedaccessmanager.egg-info}/PKG-INFO +5 -5
- {google_cloud_privilegedaccessmanager-0.4.1 → google_cloud_privilegedaccessmanager-0.4.2}/google_cloud_privilegedaccessmanager.egg-info/SOURCES.txt +2 -0
- google_cloud_privilegedaccessmanager-0.4.2/google_cloud_privilegedaccessmanager.egg-info/requires.txt +8 -0
- {google_cloud_privilegedaccessmanager-0.4.1 → google_cloud_privilegedaccessmanager-0.4.2}/setup.py +8 -5
- google_cloud_privilegedaccessmanager-0.4.2/tests/unit/gapic/privilegedaccessmanager_v1/test_compat.py +429 -0
- {google_cloud_privilegedaccessmanager-0.4.1 → google_cloud_privilegedaccessmanager-0.4.2}/tests/unit/gapic/privilegedaccessmanager_v1/test_privileged_access_manager.py +191 -647
- google_cloud_privilegedaccessmanager-0.4.1/google/cloud/privilegedaccessmanager_v1/__init__.py +0 -173
- google_cloud_privilegedaccessmanager-0.4.1/google_cloud_privilegedaccessmanager.egg-info/requires.txt +0 -11
- {google_cloud_privilegedaccessmanager-0.4.1 → google_cloud_privilegedaccessmanager-0.4.2}/LICENSE +0 -0
- {google_cloud_privilegedaccessmanager-0.4.1 → google_cloud_privilegedaccessmanager-0.4.2}/MANIFEST.in +0 -0
- {google_cloud_privilegedaccessmanager-0.4.1 → google_cloud_privilegedaccessmanager-0.4.2}/README.rst +0 -0
- {google_cloud_privilegedaccessmanager-0.4.1 → google_cloud_privilegedaccessmanager-0.4.2}/google/cloud/privilegedaccessmanager/__init__.py +0 -0
- {google_cloud_privilegedaccessmanager-0.4.1 → google_cloud_privilegedaccessmanager-0.4.2}/google/cloud/privilegedaccessmanager/py.typed +0 -0
- {google_cloud_privilegedaccessmanager-0.4.1 → google_cloud_privilegedaccessmanager-0.4.2}/google/cloud/privilegedaccessmanager_v1/gapic_metadata.json +0 -0
- {google_cloud_privilegedaccessmanager-0.4.1 → google_cloud_privilegedaccessmanager-0.4.2}/google/cloud/privilegedaccessmanager_v1/py.typed +0 -0
- {google_cloud_privilegedaccessmanager-0.4.1 → google_cloud_privilegedaccessmanager-0.4.2}/google/cloud/privilegedaccessmanager_v1/services/__init__.py +0 -0
- {google_cloud_privilegedaccessmanager-0.4.1 → google_cloud_privilegedaccessmanager-0.4.2}/google/cloud/privilegedaccessmanager_v1/services/privileged_access_manager/__init__.py +0 -0
- {google_cloud_privilegedaccessmanager-0.4.1 → google_cloud_privilegedaccessmanager-0.4.2}/google/cloud/privilegedaccessmanager_v1/services/privileged_access_manager/pagers.py +0 -0
- {google_cloud_privilegedaccessmanager-0.4.1 → google_cloud_privilegedaccessmanager-0.4.2}/google/cloud/privilegedaccessmanager_v1/services/privileged_access_manager/transports/__init__.py +0 -0
- {google_cloud_privilegedaccessmanager-0.4.1 → google_cloud_privilegedaccessmanager-0.4.2}/google/cloud/privilegedaccessmanager_v1/services/privileged_access_manager/transports/grpc.py +0 -0
- {google_cloud_privilegedaccessmanager-0.4.1 → google_cloud_privilegedaccessmanager-0.4.2}/google/cloud/privilegedaccessmanager_v1/services/privileged_access_manager/transports/grpc_asyncio.py +0 -0
- {google_cloud_privilegedaccessmanager-0.4.1 → google_cloud_privilegedaccessmanager-0.4.2}/google/cloud/privilegedaccessmanager_v1/types/__init__.py +0 -0
- {google_cloud_privilegedaccessmanager-0.4.1 → google_cloud_privilegedaccessmanager-0.4.2}/google/cloud/privilegedaccessmanager_v1/types/privilegedaccessmanager.py +0 -0
- {google_cloud_privilegedaccessmanager-0.4.1 → google_cloud_privilegedaccessmanager-0.4.2}/google_cloud_privilegedaccessmanager.egg-info/dependency_links.txt +0 -0
- {google_cloud_privilegedaccessmanager-0.4.1 → google_cloud_privilegedaccessmanager-0.4.2}/google_cloud_privilegedaccessmanager.egg-info/not-zip-safe +0 -0
- {google_cloud_privilegedaccessmanager-0.4.1 → google_cloud_privilegedaccessmanager-0.4.2}/google_cloud_privilegedaccessmanager.egg-info/top_level.txt +0 -0
- {google_cloud_privilegedaccessmanager-0.4.1 → google_cloud_privilegedaccessmanager-0.4.2}/setup.cfg +0 -0
- {google_cloud_privilegedaccessmanager-0.4.1 → google_cloud_privilegedaccessmanager-0.4.2}/tests/__init__.py +0 -0
- {google_cloud_privilegedaccessmanager-0.4.1 → google_cloud_privilegedaccessmanager-0.4.2}/tests/unit/__init__.py +0 -0
- {google_cloud_privilegedaccessmanager-0.4.1 → google_cloud_privilegedaccessmanager-0.4.2}/tests/unit/gapic/__init__.py +0 -0
- {google_cloud_privilegedaccessmanager-0.4.1 → google_cloud_privilegedaccessmanager-0.4.2}/tests/unit/gapic/privilegedaccessmanager_v1/__init__.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: google-cloud-privilegedaccessmanager
|
|
3
|
-
Version: 0.4.
|
|
3
|
+
Version: 0.4.2
|
|
4
4
|
Summary: Google Cloud Privilegedaccessmanager API client library
|
|
5
5
|
Home-page: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-privilegedaccessmanager
|
|
6
6
|
Author: Google LLC
|
|
@@ -17,17 +17,17 @@ Classifier: Programming Language :: Python :: 3.11
|
|
|
17
17
|
Classifier: Programming Language :: Python :: 3.12
|
|
18
18
|
Classifier: Programming Language :: Python :: 3.13
|
|
19
19
|
Classifier: Programming Language :: Python :: 3.14
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.15
|
|
20
21
|
Classifier: Operating System :: OS Independent
|
|
21
22
|
Classifier: Topic :: Internet
|
|
22
23
|
Requires-Python: >=3.10
|
|
23
24
|
License-File: LICENSE
|
|
24
|
-
Requires-Dist: google-api-core[grpc]<3.0.0,>=2.
|
|
25
|
+
Requires-Dist: google-api-core[grpc]<3.0.0,>=2.28.0
|
|
25
26
|
Requires-Dist: google-auth!=2.24.0,!=2.25.0,<3.0.0,>=2.14.1
|
|
26
27
|
Requires-Dist: grpcio<2.0.0,>=1.59.0
|
|
27
28
|
Requires-Dist: grpcio<2.0.0,>=1.75.1; python_version >= "3.14"
|
|
28
|
-
Requires-Dist: proto-plus<2.0.0,>=1.
|
|
29
|
-
Requires-Dist:
|
|
30
|
-
Requires-Dist: protobuf<8.0.0,>=4.25.8
|
|
29
|
+
Requires-Dist: proto-plus<2.0.0,>=1.26.1
|
|
30
|
+
Requires-Dist: protobuf<8.0.0,>=6.33.5
|
|
31
31
|
Dynamic: author
|
|
32
32
|
Dynamic: author-email
|
|
33
33
|
Dynamic: classifier
|
google_cloud_privilegedaccessmanager-0.4.2/google/cloud/privilegedaccessmanager_v1/__init__.py
ADDED
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
# -*- coding: utf-8 -*-
|
|
2
|
+
# Copyright 2026 Google LLC
|
|
3
|
+
#
|
|
4
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
# you may not use this file except in compliance with the License.
|
|
6
|
+
# You may obtain a copy of the License at
|
|
7
|
+
#
|
|
8
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
#
|
|
10
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
# See the License for the specific language governing permissions and
|
|
14
|
+
# limitations under the License.
|
|
15
|
+
#
|
|
16
|
+
import google.api_core as api_core
|
|
17
|
+
|
|
18
|
+
from google.cloud.privilegedaccessmanager_v1 import gapic_version as package_version
|
|
19
|
+
|
|
20
|
+
__version__ = package_version.__version__
|
|
21
|
+
|
|
22
|
+
# PEP 0810: Explicit Lazy Imports
|
|
23
|
+
# Python 3.15+ natively intercepts and defers these imports.
|
|
24
|
+
# Developers can disable this behavior and force eager imports.
|
|
25
|
+
# For more information, see:
|
|
26
|
+
# https://docs.python.org/3.15/library/sys.html#sys.set_lazy_imports_filter
|
|
27
|
+
# Older Python versions safely ignore this variable.
|
|
28
|
+
__lazy_modules__ = {
|
|
29
|
+
"google.cloud.privilegedaccessmanager_v1.services.privileged_access_manager",
|
|
30
|
+
"google.cloud.privilegedaccessmanager_v1.types.privilegedaccessmanager",
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
from .services.privileged_access_manager import (
|
|
35
|
+
PrivilegedAccessManagerAsyncClient,
|
|
36
|
+
PrivilegedAccessManagerClient,
|
|
37
|
+
)
|
|
38
|
+
from .types.privilegedaccessmanager import (
|
|
39
|
+
AccessControlEntry,
|
|
40
|
+
ApprovalWorkflow,
|
|
41
|
+
ApproveGrantRequest,
|
|
42
|
+
CheckOnboardingStatusRequest,
|
|
43
|
+
CheckOnboardingStatusResponse,
|
|
44
|
+
CreateEntitlementRequest,
|
|
45
|
+
CreateGrantRequest,
|
|
46
|
+
DeleteEntitlementRequest,
|
|
47
|
+
DenyGrantRequest,
|
|
48
|
+
Entitlement,
|
|
49
|
+
GetEntitlementRequest,
|
|
50
|
+
GetGrantRequest,
|
|
51
|
+
Grant,
|
|
52
|
+
Justification,
|
|
53
|
+
ListEntitlementsRequest,
|
|
54
|
+
ListEntitlementsResponse,
|
|
55
|
+
ListGrantsRequest,
|
|
56
|
+
ListGrantsResponse,
|
|
57
|
+
ManualApprovals,
|
|
58
|
+
OperationMetadata,
|
|
59
|
+
PrivilegedAccess,
|
|
60
|
+
RevokeGrantRequest,
|
|
61
|
+
SearchEntitlementsRequest,
|
|
62
|
+
SearchEntitlementsResponse,
|
|
63
|
+
SearchGrantsRequest,
|
|
64
|
+
SearchGrantsResponse,
|
|
65
|
+
UpdateEntitlementRequest,
|
|
66
|
+
)
|
|
67
|
+
|
|
68
|
+
__all__ = (
|
|
69
|
+
"PrivilegedAccessManagerAsyncClient",
|
|
70
|
+
"AccessControlEntry",
|
|
71
|
+
"ApprovalWorkflow",
|
|
72
|
+
"ApproveGrantRequest",
|
|
73
|
+
"CheckOnboardingStatusRequest",
|
|
74
|
+
"CheckOnboardingStatusResponse",
|
|
75
|
+
"CreateEntitlementRequest",
|
|
76
|
+
"CreateGrantRequest",
|
|
77
|
+
"DeleteEntitlementRequest",
|
|
78
|
+
"DenyGrantRequest",
|
|
79
|
+
"Entitlement",
|
|
80
|
+
"GetEntitlementRequest",
|
|
81
|
+
"GetGrantRequest",
|
|
82
|
+
"Grant",
|
|
83
|
+
"Justification",
|
|
84
|
+
"ListEntitlementsRequest",
|
|
85
|
+
"ListEntitlementsResponse",
|
|
86
|
+
"ListGrantsRequest",
|
|
87
|
+
"ListGrantsResponse",
|
|
88
|
+
"ManualApprovals",
|
|
89
|
+
"OperationMetadata",
|
|
90
|
+
"PrivilegedAccess",
|
|
91
|
+
"PrivilegedAccessManagerClient",
|
|
92
|
+
"RevokeGrantRequest",
|
|
93
|
+
"SearchEntitlementsRequest",
|
|
94
|
+
"SearchEntitlementsResponse",
|
|
95
|
+
"SearchGrantsRequest",
|
|
96
|
+
"SearchGrantsResponse",
|
|
97
|
+
"UpdateEntitlementRequest",
|
|
98
|
+
)
|
|
99
|
+
|
|
100
|
+
api_core.check_python_version("google.cloud.privilegedaccessmanager_v1")
|
|
101
|
+
api_core.check_dependency_versions("google.cloud.privilegedaccessmanager_v1")
|
|
@@ -0,0 +1,262 @@
|
|
|
1
|
+
# -*- coding: utf-8 -*-
|
|
2
|
+
# Copyright 2026 Google LLC
|
|
3
|
+
#
|
|
4
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
# you may not use this file except in compliance with the License.
|
|
6
|
+
# You may obtain a copy of the License at
|
|
7
|
+
#
|
|
8
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
#
|
|
10
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
# See the License for the specific language governing permissions and
|
|
14
|
+
# limitations under the License.
|
|
15
|
+
#
|
|
16
|
+
"""A compatibility module for older versions of google-api-core."""
|
|
17
|
+
|
|
18
|
+
import json
|
|
19
|
+
import os
|
|
20
|
+
from typing import Any, Dict, List, Optional, Tuple
|
|
21
|
+
from urllib.parse import urlparse, urlunparse
|
|
22
|
+
|
|
23
|
+
from google.api_core import path_template
|
|
24
|
+
from google.api_core.universe import EmptyUniverseError
|
|
25
|
+
from google.auth.exceptions import MutualTLSChannelError
|
|
26
|
+
from google.protobuf import json_format
|
|
27
|
+
|
|
28
|
+
try:
|
|
29
|
+
# note: `#type: ignore` is added because the return type for `should_use_client_cert`
|
|
30
|
+
# is different than that of the fallback implementation below. This will be removed once
|
|
31
|
+
# we bump the minimum supported version of google-auth.
|
|
32
|
+
from google.auth.transport.mtls import should_use_client_cert # type: ignore
|
|
33
|
+
except ImportError: # pragma: NO COVER
|
|
34
|
+
|
|
35
|
+
def should_use_client_cert():
|
|
36
|
+
"""Returns whether client certificate should be used for mTLS."""
|
|
37
|
+
use_client_cert = os.getenv(
|
|
38
|
+
"GOOGLE_API_USE_CLIENT_CERTIFICATE", "false"
|
|
39
|
+
).lower()
|
|
40
|
+
if use_client_cert not in ("true", "false"):
|
|
41
|
+
raise ValueError(
|
|
42
|
+
"Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be"
|
|
43
|
+
" either `true` or `false`"
|
|
44
|
+
)
|
|
45
|
+
return use_client_cert == "true"
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
def read_environment_variables():
|
|
49
|
+
"""Returns the environment variables used by the client.
|
|
50
|
+
|
|
51
|
+
Returns:
|
|
52
|
+
Tuple[bool, str, str]: returns the GOOGLE_API_USE_CLIENT_CERTIFICATE,
|
|
53
|
+
GOOGLE_API_USE_MTLS_ENDPOINT, and GOOGLE_CLOUD_UNIVERSE_DOMAIN environment variables.
|
|
54
|
+
|
|
55
|
+
Raises:
|
|
56
|
+
ValueError: If GOOGLE_API_USE_CLIENT_CERTIFICATE is not
|
|
57
|
+
any of ["true", "false"].
|
|
58
|
+
google.auth.exceptions.MutualTLSChannelError: If GOOGLE_API_USE_MTLS_ENDPOINT
|
|
59
|
+
is not any of ["auto", "never", "always"].
|
|
60
|
+
"""
|
|
61
|
+
use_client_cert = should_use_client_cert()
|
|
62
|
+
use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto").lower()
|
|
63
|
+
universe_domain_env = os.getenv("GOOGLE_CLOUD_UNIVERSE_DOMAIN")
|
|
64
|
+
if use_mtls_endpoint not in ("auto", "never", "always"):
|
|
65
|
+
raise MutualTLSChannelError(
|
|
66
|
+
"Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`,"
|
|
67
|
+
" `auto` or `always`"
|
|
68
|
+
)
|
|
69
|
+
return use_client_cert, use_mtls_endpoint, universe_domain_env
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
DEFAULT_UNIVERSE = "googleapis.com"
|
|
73
|
+
|
|
74
|
+
try:
|
|
75
|
+
from google.api_core.universe import get_default_mtls_endpoint
|
|
76
|
+
except ImportError: # pragma: NO COVER
|
|
77
|
+
|
|
78
|
+
def get_default_mtls_endpoint(api_endpoint: Optional[str]) -> Optional[str]:
|
|
79
|
+
"""Converts api endpoint to mTLS endpoint.
|
|
80
|
+
|
|
81
|
+
Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to
|
|
82
|
+
"*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively.
|
|
83
|
+
Other URLs (including those that do not match these domain suffixes or
|
|
84
|
+
already contain '.mtls.') are passed through as-is.
|
|
85
|
+
|
|
86
|
+
Args:
|
|
87
|
+
api_endpoint (Optional[str]): the api endpoint to convert.
|
|
88
|
+
|
|
89
|
+
Returns:
|
|
90
|
+
Optional[str]: converted mTLS api endpoint.
|
|
91
|
+
"""
|
|
92
|
+
if not api_endpoint or ".mtls." in api_endpoint.lower():
|
|
93
|
+
return api_endpoint
|
|
94
|
+
|
|
95
|
+
has_scheme = "://" in api_endpoint
|
|
96
|
+
if not has_scheme:
|
|
97
|
+
parsed = urlparse("//" + api_endpoint)
|
|
98
|
+
else:
|
|
99
|
+
parsed = urlparse(api_endpoint)
|
|
100
|
+
|
|
101
|
+
host = parsed.hostname
|
|
102
|
+
if not host:
|
|
103
|
+
return api_endpoint
|
|
104
|
+
|
|
105
|
+
port = f":{parsed.port}" if parsed.port else ""
|
|
106
|
+
|
|
107
|
+
lowered_host = host.lower()
|
|
108
|
+
suffix_sandbox = ".sandbox.googleapis.com"
|
|
109
|
+
suffix_google = ".googleapis.com"
|
|
110
|
+
if lowered_host.endswith(suffix_sandbox):
|
|
111
|
+
new_host = host[: -len(suffix_sandbox)] + ".mtls.sandbox.googleapis.com"
|
|
112
|
+
elif lowered_host.endswith(suffix_google):
|
|
113
|
+
new_host = host[: -len(suffix_google)] + ".mtls.googleapis.com"
|
|
114
|
+
else:
|
|
115
|
+
return api_endpoint
|
|
116
|
+
|
|
117
|
+
netloc = new_host + port
|
|
118
|
+
new_parsed = parsed._replace(netloc=netloc)
|
|
119
|
+
|
|
120
|
+
if not has_scheme:
|
|
121
|
+
return urlunparse(new_parsed)[2:]
|
|
122
|
+
else:
|
|
123
|
+
return urlunparse(new_parsed)
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
try:
|
|
127
|
+
from google.api_core.universe import get_api_endpoint
|
|
128
|
+
except ImportError: # pragma: NO COVER
|
|
129
|
+
|
|
130
|
+
def get_api_endpoint(
|
|
131
|
+
api_override: Optional[str],
|
|
132
|
+
universe_domain: str,
|
|
133
|
+
default_universe: str,
|
|
134
|
+
default_mtls_endpoint: Optional[str],
|
|
135
|
+
default_endpoint_template: str,
|
|
136
|
+
use_mtls: bool,
|
|
137
|
+
) -> str:
|
|
138
|
+
"""Return the API endpoint used by the client.
|
|
139
|
+
|
|
140
|
+
Args:
|
|
141
|
+
api_override (Optional[str]): The API endpoint override. If specified,
|
|
142
|
+
this is always returned.
|
|
143
|
+
universe_domain (str): The universe domain used by the client.
|
|
144
|
+
default_universe (str): The default universe domain.
|
|
145
|
+
default_mtls_endpoint (Optional[str]): The default mTLS endpoint.
|
|
146
|
+
default_endpoint_template (str): The default endpoint template containing
|
|
147
|
+
a placeholder `{UNIVERSE_DOMAIN}`.
|
|
148
|
+
use_mtls (bool): Whether to use the mTLS endpoint.
|
|
149
|
+
|
|
150
|
+
Returns:
|
|
151
|
+
str: The API endpoint to be used by the client.
|
|
152
|
+
|
|
153
|
+
Raises:
|
|
154
|
+
google.auth.exceptions.MutualTLSChannelError: If mTLS is requested but
|
|
155
|
+
not supported in the configured universe domain.
|
|
156
|
+
ValueError: If mTLS is requested but no mTLS endpoint is available.
|
|
157
|
+
"""
|
|
158
|
+
if api_override is not None:
|
|
159
|
+
return api_override
|
|
160
|
+
|
|
161
|
+
if use_mtls:
|
|
162
|
+
if universe_domain.lower() != default_universe.lower():
|
|
163
|
+
raise MutualTLSChannelError(
|
|
164
|
+
f"mTLS is not supported in any universe other than {default_universe}."
|
|
165
|
+
)
|
|
166
|
+
if not default_mtls_endpoint:
|
|
167
|
+
raise ValueError("mTLS endpoint is not available.")
|
|
168
|
+
return default_mtls_endpoint
|
|
169
|
+
else:
|
|
170
|
+
return default_endpoint_template.format(UNIVERSE_DOMAIN=universe_domain)
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
try:
|
|
174
|
+
from google.api_core.universe import get_universe_domain
|
|
175
|
+
except ImportError: # pragma: NO COVER
|
|
176
|
+
|
|
177
|
+
def get_universe_domain(
|
|
178
|
+
*potential_universes: Optional[str],
|
|
179
|
+
default_universe: str,
|
|
180
|
+
) -> str:
|
|
181
|
+
"""Return the universe domain used by the client.
|
|
182
|
+
|
|
183
|
+
Args:
|
|
184
|
+
*potential_universes (Optional[str]): Potential universe domains in order of preference.
|
|
185
|
+
default_universe (str): The default universe domain.
|
|
186
|
+
|
|
187
|
+
Returns:
|
|
188
|
+
str: The universe domain to be used by the client.
|
|
189
|
+
|
|
190
|
+
Raises:
|
|
191
|
+
EmptyUniverseError: If the resolved universe domain is an empty string.
|
|
192
|
+
"""
|
|
193
|
+
resolved = next(
|
|
194
|
+
(x.strip() for x in potential_universes if x is not None),
|
|
195
|
+
default_universe,
|
|
196
|
+
)
|
|
197
|
+
|
|
198
|
+
if not resolved:
|
|
199
|
+
raise EmptyUniverseError()
|
|
200
|
+
return resolved
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
try:
|
|
204
|
+
from google.api_core.rest_helpers import transcode_request # type: ignore
|
|
205
|
+
except ImportError: # pragma: NO COVER
|
|
206
|
+
|
|
207
|
+
def transcode_request(
|
|
208
|
+
http_options: List[Dict[str, str]],
|
|
209
|
+
request: Any,
|
|
210
|
+
required_fields_default_values: Optional[Dict[str, Any]] = None,
|
|
211
|
+
rest_numeric_enums: bool = False,
|
|
212
|
+
) -> Tuple[Dict[str, Any], Optional[str], Dict[str, Any]]:
|
|
213
|
+
"""Transcodes a request into HTTP method, URI, body, and query parameters.
|
|
214
|
+
|
|
215
|
+
Args:
|
|
216
|
+
http_options (List[Dict[str, str]]): List of HTTP transcoding rules.
|
|
217
|
+
request (Any): The protobuf or proto-plus request message.
|
|
218
|
+
required_fields_default_values (Optional[Dict[str, Any]]): Dictionary
|
|
219
|
+
of required fields default values to merge into query parameters if missing.
|
|
220
|
+
rest_numeric_enums (bool): Whether to encode enums as integers.
|
|
221
|
+
|
|
222
|
+
Returns:
|
|
223
|
+
Tuple[Dict[str, Any], Optional[str], Dict[str, Any]]: A tuple containing:
|
|
224
|
+
- The raw transcoded request dictionary (containing keys like 'uri', 'method').
|
|
225
|
+
- The serialized request body JSON string, or None if no body.
|
|
226
|
+
- The query parameters dictionary.
|
|
227
|
+
"""
|
|
228
|
+
if request is None:
|
|
229
|
+
raise TypeError("request cannot be None")
|
|
230
|
+
|
|
231
|
+
# Convert proto-plus message to its underlying protobuf message if needed
|
|
232
|
+
pb_request = getattr(request, "_pb", request)
|
|
233
|
+
|
|
234
|
+
transcoded_request = path_template.transcode(http_options, pb_request)
|
|
235
|
+
|
|
236
|
+
body_json = None
|
|
237
|
+
if transcoded_request.get("body") is not None:
|
|
238
|
+
body_json = json_format.MessageToJson(
|
|
239
|
+
transcoded_request["body"],
|
|
240
|
+
use_integers_for_enums=rest_numeric_enums,
|
|
241
|
+
)
|
|
242
|
+
|
|
243
|
+
query_params_json = {}
|
|
244
|
+
if transcoded_request.get("query_params") is not None:
|
|
245
|
+
query_params_json = json.loads(
|
|
246
|
+
json_format.MessageToJson(
|
|
247
|
+
transcoded_request["query_params"],
|
|
248
|
+
use_integers_for_enums=rest_numeric_enums,
|
|
249
|
+
)
|
|
250
|
+
)
|
|
251
|
+
|
|
252
|
+
# If required_fields_default_values is provided, we merge default values for missing
|
|
253
|
+
# required fields into the query parameters.
|
|
254
|
+
if required_fields_default_values:
|
|
255
|
+
for k, v in required_fields_default_values.items():
|
|
256
|
+
if k not in query_params_json:
|
|
257
|
+
query_params_json[k] = v
|
|
258
|
+
|
|
259
|
+
if rest_numeric_enums:
|
|
260
|
+
query_params_json["$alt"] = "json;enum-encoding=int"
|
|
261
|
+
|
|
262
|
+
return transcoded_request, body_json, query_params_json
|
|
@@ -2281,9 +2281,7 @@ class PrivilegedAccessManagerAsyncClient:
|
|
|
2281
2281
|
DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
|
|
2282
2282
|
gapic_version=package_version.__version__
|
|
2283
2283
|
)
|
|
2284
|
-
|
|
2285
|
-
if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER
|
|
2286
|
-
DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__
|
|
2284
|
+
DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__
|
|
2287
2285
|
|
|
2288
2286
|
|
|
2289
2287
|
__all__ = ("PrivilegedAccessManagerAsyncClient",)
|
|
@@ -46,6 +46,13 @@ from google.auth.transport.grpc import SslCredentials # type: ignore
|
|
|
46
46
|
from google.oauth2 import service_account # type: ignore
|
|
47
47
|
|
|
48
48
|
from google.cloud.privilegedaccessmanager_v1 import gapic_version as package_version
|
|
49
|
+
from google.cloud.privilegedaccessmanager_v1._compat import (
|
|
50
|
+
get_api_endpoint,
|
|
51
|
+
get_default_mtls_endpoint,
|
|
52
|
+
get_universe_domain,
|
|
53
|
+
read_environment_variables,
|
|
54
|
+
should_use_client_cert,
|
|
55
|
+
)
|
|
49
56
|
|
|
50
57
|
try:
|
|
51
58
|
OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None]
|
|
@@ -140,77 +147,13 @@ class PrivilegedAccessManagerClient(metaclass=PrivilegedAccessManagerClientMeta)
|
|
|
140
147
|
over.
|
|
141
148
|
"""
|
|
142
149
|
|
|
143
|
-
@staticmethod
|
|
144
|
-
def _get_default_mtls_endpoint(api_endpoint) -> Optional[str]:
|
|
145
|
-
"""Converts api endpoint to mTLS endpoint.
|
|
146
|
-
|
|
147
|
-
Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to
|
|
148
|
-
"*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively.
|
|
149
|
-
Args:
|
|
150
|
-
api_endpoint (Optional[str]): the api endpoint to convert.
|
|
151
|
-
Returns:
|
|
152
|
-
Optional[str]: converted mTLS api endpoint.
|
|
153
|
-
"""
|
|
154
|
-
if not api_endpoint:
|
|
155
|
-
return api_endpoint
|
|
156
|
-
|
|
157
|
-
mtls_endpoint_re = re.compile(
|
|
158
|
-
r"(?P<name>[^.]+)(?P<mtls>\.mtls)?(?P<sandbox>\.sandbox)?(?P<googledomain>\.googleapis\.com)?"
|
|
159
|
-
)
|
|
160
|
-
|
|
161
|
-
m = mtls_endpoint_re.match(api_endpoint)
|
|
162
|
-
if m is None:
|
|
163
|
-
# Could not parse api_endpoint; return as-is.
|
|
164
|
-
return api_endpoint
|
|
165
|
-
|
|
166
|
-
name, mtls, sandbox, googledomain = m.groups()
|
|
167
|
-
if mtls or not googledomain:
|
|
168
|
-
return api_endpoint
|
|
169
|
-
|
|
170
|
-
if sandbox:
|
|
171
|
-
return api_endpoint.replace(
|
|
172
|
-
"sandbox.googleapis.com", "mtls.sandbox.googleapis.com"
|
|
173
|
-
)
|
|
174
|
-
|
|
175
|
-
return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com")
|
|
176
|
-
|
|
177
150
|
# Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead.
|
|
178
151
|
DEFAULT_ENDPOINT = "privilegedaccessmanager.googleapis.com"
|
|
179
|
-
DEFAULT_MTLS_ENDPOINT =
|
|
180
|
-
DEFAULT_ENDPOINT
|
|
181
|
-
)
|
|
152
|
+
DEFAULT_MTLS_ENDPOINT = get_default_mtls_endpoint(DEFAULT_ENDPOINT)
|
|
182
153
|
|
|
183
154
|
_DEFAULT_ENDPOINT_TEMPLATE = "privilegedaccessmanager.{UNIVERSE_DOMAIN}"
|
|
184
155
|
_DEFAULT_UNIVERSE = "googleapis.com"
|
|
185
156
|
|
|
186
|
-
@staticmethod
|
|
187
|
-
def _use_client_cert_effective():
|
|
188
|
-
"""Returns whether client certificate should be used for mTLS if the
|
|
189
|
-
google-auth version supports should_use_client_cert automatic mTLS enablement.
|
|
190
|
-
|
|
191
|
-
Alternatively, read from the GOOGLE_API_USE_CLIENT_CERTIFICATE env var.
|
|
192
|
-
|
|
193
|
-
Returns:
|
|
194
|
-
bool: whether client certificate should be used for mTLS
|
|
195
|
-
Raises:
|
|
196
|
-
ValueError: (If using a version of google-auth without should_use_client_cert and
|
|
197
|
-
GOOGLE_API_USE_CLIENT_CERTIFICATE is set to an unexpected value.)
|
|
198
|
-
"""
|
|
199
|
-
# check if google-auth version supports should_use_client_cert for automatic mTLS enablement
|
|
200
|
-
if hasattr(mtls, "should_use_client_cert"): # pragma: NO COVER
|
|
201
|
-
return mtls.should_use_client_cert()
|
|
202
|
-
else: # pragma: NO COVER
|
|
203
|
-
# if unsupported, fallback to reading from env var
|
|
204
|
-
use_client_cert_str = os.getenv(
|
|
205
|
-
"GOOGLE_API_USE_CLIENT_CERTIFICATE", "false"
|
|
206
|
-
).lower()
|
|
207
|
-
if use_client_cert_str not in ("true", "false"):
|
|
208
|
-
raise ValueError(
|
|
209
|
-
"Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be"
|
|
210
|
-
" either `true` or `false`"
|
|
211
|
-
)
|
|
212
|
-
return use_client_cert_str == "true"
|
|
213
|
-
|
|
214
157
|
@classmethod
|
|
215
158
|
def from_service_account_info(cls, info: dict, *args, **kwargs):
|
|
216
159
|
"""Creates an instance of this client using the provided credentials
|
|
@@ -424,7 +367,7 @@ class PrivilegedAccessManagerClient(metaclass=PrivilegedAccessManagerClientMeta)
|
|
|
424
367
|
)
|
|
425
368
|
if client_options is None:
|
|
426
369
|
client_options = client_options_lib.ClientOptions()
|
|
427
|
-
use_client_cert =
|
|
370
|
+
use_client_cert = should_use_client_cert()
|
|
428
371
|
use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto")
|
|
429
372
|
if use_mtls_endpoint not in ("auto", "never", "always"):
|
|
430
373
|
raise MutualTLSChannelError(
|
|
@@ -445,35 +388,12 @@ class PrivilegedAccessManagerClient(metaclass=PrivilegedAccessManagerClientMeta)
|
|
|
445
388
|
elif use_mtls_endpoint == "always" or (
|
|
446
389
|
use_mtls_endpoint == "auto" and client_cert_source
|
|
447
390
|
):
|
|
448
|
-
api_endpoint = cls.DEFAULT_MTLS_ENDPOINT
|
|
391
|
+
api_endpoint = cls.DEFAULT_MTLS_ENDPOINT # type: ignore
|
|
449
392
|
else:
|
|
450
393
|
api_endpoint = cls.DEFAULT_ENDPOINT
|
|
451
394
|
|
|
452
395
|
return api_endpoint, client_cert_source
|
|
453
396
|
|
|
454
|
-
@staticmethod
|
|
455
|
-
def _read_environment_variables():
|
|
456
|
-
"""Returns the environment variables used by the client.
|
|
457
|
-
|
|
458
|
-
Returns:
|
|
459
|
-
Tuple[bool, str, str]: returns the GOOGLE_API_USE_CLIENT_CERTIFICATE,
|
|
460
|
-
GOOGLE_API_USE_MTLS_ENDPOINT, and GOOGLE_CLOUD_UNIVERSE_DOMAIN environment variables.
|
|
461
|
-
|
|
462
|
-
Raises:
|
|
463
|
-
ValueError: If GOOGLE_API_USE_CLIENT_CERTIFICATE is not
|
|
464
|
-
any of ["true", "false"].
|
|
465
|
-
google.auth.exceptions.MutualTLSChannelError: If GOOGLE_API_USE_MTLS_ENDPOINT
|
|
466
|
-
is not any of ["auto", "never", "always"].
|
|
467
|
-
"""
|
|
468
|
-
use_client_cert = PrivilegedAccessManagerClient._use_client_cert_effective()
|
|
469
|
-
use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto").lower()
|
|
470
|
-
universe_domain_env = os.getenv("GOOGLE_CLOUD_UNIVERSE_DOMAIN")
|
|
471
|
-
if use_mtls_endpoint not in ("auto", "never", "always"):
|
|
472
|
-
raise MutualTLSChannelError(
|
|
473
|
-
"Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`"
|
|
474
|
-
)
|
|
475
|
-
return use_client_cert, use_mtls_endpoint, universe_domain_env
|
|
476
|
-
|
|
477
397
|
@staticmethod
|
|
478
398
|
def _get_client_cert_source(provided_cert_source, use_cert_flag):
|
|
479
399
|
"""Return the client cert source to be used by the client.
|
|
@@ -493,67 +413,6 @@ class PrivilegedAccessManagerClient(metaclass=PrivilegedAccessManagerClientMeta)
|
|
|
493
413
|
client_cert_source = mtls.default_client_cert_source()
|
|
494
414
|
return client_cert_source
|
|
495
415
|
|
|
496
|
-
@staticmethod
|
|
497
|
-
def _get_api_endpoint(
|
|
498
|
-
api_override, client_cert_source, universe_domain, use_mtls_endpoint
|
|
499
|
-
) -> str:
|
|
500
|
-
"""Return the API endpoint used by the client.
|
|
501
|
-
|
|
502
|
-
Args:
|
|
503
|
-
api_override (str): The API endpoint override. If specified, this is always
|
|
504
|
-
the return value of this function and the other arguments are not used.
|
|
505
|
-
client_cert_source (bytes): The client certificate source used by the client.
|
|
506
|
-
universe_domain (str): The universe domain used by the client.
|
|
507
|
-
use_mtls_endpoint (str): How to use the mTLS endpoint, which depends also on the other parameters.
|
|
508
|
-
Possible values are "always", "auto", or "never".
|
|
509
|
-
|
|
510
|
-
Returns:
|
|
511
|
-
str: The API endpoint to be used by the client.
|
|
512
|
-
"""
|
|
513
|
-
if api_override is not None:
|
|
514
|
-
api_endpoint = api_override
|
|
515
|
-
elif use_mtls_endpoint == "always" or (
|
|
516
|
-
use_mtls_endpoint == "auto" and client_cert_source
|
|
517
|
-
):
|
|
518
|
-
_default_universe = PrivilegedAccessManagerClient._DEFAULT_UNIVERSE
|
|
519
|
-
if universe_domain != _default_universe:
|
|
520
|
-
raise MutualTLSChannelError(
|
|
521
|
-
f"mTLS is not supported in any universe other than {_default_universe}."
|
|
522
|
-
)
|
|
523
|
-
api_endpoint = PrivilegedAccessManagerClient.DEFAULT_MTLS_ENDPOINT
|
|
524
|
-
else:
|
|
525
|
-
api_endpoint = (
|
|
526
|
-
PrivilegedAccessManagerClient._DEFAULT_ENDPOINT_TEMPLATE.format(
|
|
527
|
-
UNIVERSE_DOMAIN=universe_domain
|
|
528
|
-
)
|
|
529
|
-
)
|
|
530
|
-
return api_endpoint
|
|
531
|
-
|
|
532
|
-
@staticmethod
|
|
533
|
-
def _get_universe_domain(
|
|
534
|
-
client_universe_domain: Optional[str], universe_domain_env: Optional[str]
|
|
535
|
-
) -> str:
|
|
536
|
-
"""Return the universe domain used by the client.
|
|
537
|
-
|
|
538
|
-
Args:
|
|
539
|
-
client_universe_domain (Optional[str]): The universe domain configured via the client options.
|
|
540
|
-
universe_domain_env (Optional[str]): The universe domain configured via the "GOOGLE_CLOUD_UNIVERSE_DOMAIN" environment variable.
|
|
541
|
-
|
|
542
|
-
Returns:
|
|
543
|
-
str: The universe domain to be used by the client.
|
|
544
|
-
|
|
545
|
-
Raises:
|
|
546
|
-
ValueError: If the universe domain is an empty string.
|
|
547
|
-
"""
|
|
548
|
-
universe_domain = PrivilegedAccessManagerClient._DEFAULT_UNIVERSE
|
|
549
|
-
if client_universe_domain is not None:
|
|
550
|
-
universe_domain = client_universe_domain
|
|
551
|
-
elif universe_domain_env is not None:
|
|
552
|
-
universe_domain = universe_domain_env
|
|
553
|
-
if len(universe_domain.strip()) == 0:
|
|
554
|
-
raise ValueError("Universe Domain cannot be an empty string.")
|
|
555
|
-
return universe_domain
|
|
556
|
-
|
|
557
416
|
def _validate_universe_domain(self):
|
|
558
417
|
"""Validates client's and credentials' universe domains are consistent.
|
|
559
418
|
|
|
@@ -687,15 +546,17 @@ class PrivilegedAccessManagerClient(metaclass=PrivilegedAccessManagerClientMeta)
|
|
|
687
546
|
universe_domain_opt = getattr(self._client_options, "universe_domain", None)
|
|
688
547
|
|
|
689
548
|
self._use_client_cert, self._use_mtls_endpoint, self._universe_domain_env = (
|
|
690
|
-
|
|
549
|
+
read_environment_variables()
|
|
691
550
|
)
|
|
692
551
|
self._client_cert_source = (
|
|
693
552
|
PrivilegedAccessManagerClient._get_client_cert_source(
|
|
694
553
|
self._client_options.client_cert_source, self._use_client_cert
|
|
695
554
|
)
|
|
696
555
|
)
|
|
697
|
-
self._universe_domain =
|
|
698
|
-
universe_domain_opt,
|
|
556
|
+
self._universe_domain = get_universe_domain(
|
|
557
|
+
universe_domain_opt,
|
|
558
|
+
self._universe_domain_env,
|
|
559
|
+
default_universe=PrivilegedAccessManagerClient._DEFAULT_UNIVERSE,
|
|
699
560
|
)
|
|
700
561
|
self._api_endpoint: str = "" # updated below, depending on `transport`
|
|
701
562
|
|
|
@@ -730,14 +591,14 @@ class PrivilegedAccessManagerClient(metaclass=PrivilegedAccessManagerClientMeta)
|
|
|
730
591
|
self._transport = cast(PrivilegedAccessManagerTransport, transport)
|
|
731
592
|
self._api_endpoint = self._transport.host
|
|
732
593
|
|
|
733
|
-
self._api_endpoint = (
|
|
734
|
-
self.
|
|
735
|
-
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
)
|
|
594
|
+
self._api_endpoint = self._api_endpoint or get_api_endpoint(
|
|
595
|
+
api_override=self._client_options.api_endpoint,
|
|
596
|
+
universe_domain=self._universe_domain,
|
|
597
|
+
default_universe=PrivilegedAccessManagerClient._DEFAULT_UNIVERSE,
|
|
598
|
+
default_mtls_endpoint=PrivilegedAccessManagerClient.DEFAULT_MTLS_ENDPOINT,
|
|
599
|
+
default_endpoint_template=PrivilegedAccessManagerClient._DEFAULT_ENDPOINT_TEMPLATE,
|
|
600
|
+
use_mtls=self._use_mtls_endpoint == "always"
|
|
601
|
+
or (self._use_mtls_endpoint == "auto" and self._client_cert_source),
|
|
741
602
|
)
|
|
742
603
|
|
|
743
604
|
if not transport_provided:
|
|
@@ -2719,8 +2580,6 @@ class PrivilegedAccessManagerClient(metaclass=PrivilegedAccessManagerClientMeta)
|
|
|
2719
2580
|
DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
|
|
2720
2581
|
gapic_version=package_version.__version__
|
|
2721
2582
|
)
|
|
2722
|
-
|
|
2723
|
-
if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER
|
|
2724
|
-
DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__
|
|
2583
|
+
DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__
|
|
2725
2584
|
|
|
2726
2585
|
__all__ = ("PrivilegedAccessManagerClient",)
|