Class AssetServiceClient (1.2.0) 

AssetServiceClient(
    transport=None,
    channel=None,
    credentials=None,
    client_config=None,
    client_info=None,
    client_options=None,
)

Asset service definition.

Methods

AssetServiceClient

AssetServiceClient(
    transport=None,
    channel=None,
    credentials=None,
    client_config=None,
    client_info=None,
    client_options=None,
)

Constructor.

Parameters
NameDescription
channel grpc.Channel

DEPRECATED. A Channel instance through which to make calls. This argument is mutually exclusive with credentials; providing both will raise an exception.

credentials google.auth.credentials.Credentials

The authorization credentials to attach to requests. These credentials identify this application to the service. If none are specified, the client will attempt to ascertain the credentials from the environment. This argument is mutually exclusive with providing a transport instance to transport; doing so will raise an exception.

client_config dict

DEPRECATED. A dictionary of call options for each method. If not specified, the default configuration is used.

client_info google.api_core.gapic_v1.client_info.ClientInfo

The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own client library.

client_options Union[dict, google.api_core.client_options.ClientOptions]

Client options used to set user options on the client. API Endpoint should be set through client_options.

analyze_iam_policy

analyze_iam_policy(analysis_query, options_=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Analyzes IAM policies based on the specified request. Returns a list of IamPolicyAnalysisResult matching the request.

.. rubric:: Example

from google.cloud import asset_v1p4beta1

client = asset_v1p4beta1.AssetServiceClient()

TODO: Initialize analysis_query:

analysis_query = {}

response = client.analyze_iam_policy(analysis_query)

Parameters
NameDescription
analysis_query Union[dict, IamPolicyAnalysisQuery]

Required. The request query. If a dict is provided, it must be of the same form as the protobuf message IamPolicyAnalysisQuery

options_ Union[dict, Options]

Optional. The request options. If a dict is provided, it must be of the same form as the protobuf message Options

retry Optional[google.api_core.retry.Retry]

A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

timeout Optional[float]

The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

metadata Optional[Sequence[Tuple[str, str]]]

Additional metadata that is provided to the method.

Exceptions
TypeDescription
google.api_core.exceptions.GoogleAPICallErrorIf the request failed for any reason.
google.api_core.exceptions.RetryErrorIf the request failed due to a retryable error and retry attempts failed.
ValueErrorIf the parameters are invalid.

export_iam_policy_analysis

export_iam_policy_analysis(analysis_query, output_config, options_=None, retry=<_MethodDefault._DEFAULT_VALUE: <object object>>, timeout=<_MethodDefault._DEFAULT_VALUE: <object object>>, metadata=None)

Exports IAM policy analysis based on the specified request. This API implements the 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.

.. rubric:: Example

from google.cloud import asset_v1p4beta1

client = asset_v1p4beta1.AssetServiceClient()

TODO: Initialize analysis_query:

analysis_query = {}

TODO: Initialize output_config:

output_config = {}

response = client.export_iam_policy_analysis(analysis_query, output_config)

def callback(operation_future): ... # Handle result. ... result = operation_future.result()

response.add_done_callback(callback)

Handle metadata.

metadata = response.metadata()

Parameters
NameDescription
analysis_query Union[dict, IamPolicyAnalysisQuery]

Required. The request query. If a dict is provided, it must be of the same form as the protobuf message IamPolicyAnalysisQuery

output_config Union[dict, IamPolicyAnalysisOutputConfig]

Required. Output configuration indicating where the results will be output to. If a dict is provided, it must be of the same form as the protobuf message IamPolicyAnalysisOutputConfig

options_ Union[dict, Options]

Optional. The request options. If a dict is provided, it must be of the same form as the protobuf message Options

retry Optional[google.api_core.retry.Retry]

A retry object used to retry requests. If None is specified, requests will be retried using a default configuration.

timeout Optional[float]

The amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.

metadata Optional[Sequence[Tuple[str, str]]]

Additional metadata that is provided to the method.

Exceptions
TypeDescription
google.api_core.exceptions.GoogleAPICallErrorIf the request failed for any reason.
google.api_core.exceptions.RetryErrorIf the request failed due to a retryable error and retry attempts failed.
ValueErrorIf the parameters are invalid.

from_service_account_file

from_service_account_file(filename, *args, **kwargs)

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

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
AssetServiceClientThe constructed client.

from_service_account_json

from_service_account_json(filename, *args, **kwargs)

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

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
AssetServiceClientThe constructed client.