AssetServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.asset_v1p4beta1.services.asset_service.transports.base.AssetServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Asset service definition.
Properties
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
AssetServiceTransport |
The transport used by the client instance. |
Methods
AssetServiceAsyncClient
AssetServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.asset_v1p4beta1.services.asset_service.transports.base.AssetServiceTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiates the asset service client.
Parameters | |
---|---|
Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str,
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
ClientOptions
Custom options for the client. It won't take effect if a |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTlsChannelError |
If mutual TLS transport creation failed for any reason. |
analyze_iam_policy
analyze_iam_policy(
request: typing.Optional[
typing.Union[
google.cloud.asset_v1p4beta1.types.asset_service.AnalyzeIamPolicyRequest,
dict,
]
] = None,
*,
retry: typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Optional[float] = None,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.asset_v1p4beta1.types.asset_service.AnalyzeIamPolicyResponse
Analyzes IAM policies based on the specified request. Returns a list of xref_IamPolicyAnalysisResult matching the request.
from google.cloud import asset_v1p4beta1
async def sample_analyze_iam_policy():
# Create a client
client = asset_v1p4beta1.AssetServiceAsyncClient()
# Initialize request argument(s)
analysis_query = asset_v1p4beta1.IamPolicyAnalysisQuery()
analysis_query.parent = "parent_value"
request = asset_v1p4beta1.AnalyzeIamPolicyRequest(
analysis_query=analysis_query,
)
# Make the request
response = await client.analyze_iam_policy(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.asset_v1p4beta1.types.AnalyzeIamPolicyRequest, dict]
The request object. A request message for AssetService.AnalyzeIamPolicy. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.asset_v1p4beta1.types.AnalyzeIamPolicyResponse |
A response message for AssetService.AnalyzeIamPolicy. |
common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
export_iam_policy_analysis
export_iam_policy_analysis(
request: typing.Optional[
typing.Union[
google.cloud.asset_v1p4beta1.types.asset_service.ExportIamPolicyAnalysisRequest,
dict,
]
] = None,
*,
retry: typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Optional[float] = None,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation_async.AsyncOperation
Exports IAM policy analysis based on the specified request. This
API implements the
google.longrunning.Operation][google.longrunning.Operation]
API
allowing you to keep track of the export. The metadata contains
the request to help callers to map responses to requests.
from google.cloud import asset_v1p4beta1
async def sample_export_iam_policy_analysis():
# Create a client
client = asset_v1p4beta1.AssetServiceAsyncClient()
# Initialize request argument(s)
analysis_query = asset_v1p4beta1.IamPolicyAnalysisQuery()
analysis_query.parent = "parent_value"
output_config = asset_v1p4beta1.IamPolicyAnalysisOutputConfig()
output_config.gcs_destination.uri = "uri_value"
request = asset_v1p4beta1.ExportIamPolicyAnalysisRequest(
analysis_query=analysis_query,
output_config=output_config,
)
# Make the request
operation = client.export_iam_policy_analysis(request=request)
print("Waiting for operation to complete...")
response = await operation.result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.asset_v1p4beta1.types.ExportIamPolicyAnalysisRequest, dict]
The request object. A request message for AssetService.ExportIamPolicyAnalysis. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation |
An object representing a long-running operation. The result type for the operation will be ExportIamPolicyAnalysisResponse The export IAM policy analysis response. This message is returned by the [google.longrunning.Operations.GetOperation][] method in the returned [google.longrunning.Operation.response][] field. |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
AssetServiceAsyncClient |
The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
Parameter | |
---|---|
Name | Description |
info |
dict
The service account private key info. |
Returns | |
---|---|
Type | Description |
AssetServiceAsyncClient |
The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
AssetServiceAsyncClient |
The constructed client. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source
is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint
if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is "always", use the
default mTLS endpoint; if the environment variabel is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
Parameter | |
---|---|
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError |
If any errors happen. |
Returns | |
---|---|
Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] |
returns the API endpoint and the client cert source to use. |
get_transport_class
get_transport_class() -> (
typing.Type[
google.cloud.asset_v1p4beta1.services.asset_service.transports.base.AssetServiceTransport
]
)
Returns an appropriate transport class.
Parameter | |
---|---|
Name | Description |
label |
str
The name of the desired transport. If none is provided, then the first transport in the registry is used. |
parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.