Class AssetServiceAsyncClient (2.0.0)

AssetServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.asset_v1.services.asset_service.transports.base.AssetServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-asset/.nox/docfx/lib/python3.8/site-packages/google/api_core/client_options.py'> = None)

Asset service definition.

Inheritance

builtins.object > AssetServiceAsyncClient

Methods

AssetServiceAsyncClient

AssetServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.asset_v1.services.asset_service.transports.base.AssetServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-asset/.nox/docfx/lib/python3.8/site-packages/google/api_core/client_options.py'> = None)

Instantiate the asset service client.

Parameters
NameDescription
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, `.AssetServiceTransport`]

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 transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint, this is the default value for the environment variable) and "auto" (auto switch to the default mTLS endpoint if client SSL credentials is present). However, the api_endpoint property takes precedence if provided. (2) The client_cert_source property is used to provide client SSL credentials for mutual TLS transport. If not provided, the default SSL credentials will be used if present.

Exceptions
TypeDescription
google.auth.exceptions.MutualTlsChannelErrorIf mutual TLS transport creation failed for any reason.

batch_get_assets_history

batch_get_assets_history(request: Optional[google.cloud.asset_v1.types.asset_service.BatchGetAssetsHistoryRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Batch gets the update history of assets that overlap a time window. For IAM_POLICY content, this API outputs history when the asset and its attached IAM POLICY both exist. This can create gaps in the output history. Otherwise, this API outputs history with asset in both non-delete or deleted status. If a specified asset does not exist, this API returns an INVALID_ARGUMENT error.

Parameters
NameDescription
request `.asset_service.BatchGetAssetsHistoryRequest`

The request object. Batch get assets history request.

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
TypeDescription
`.asset_service.BatchGetAssetsHistoryResponse`Batch get assets history response.

create_feed

create_feed(request: Optional[google.cloud.asset_v1.types.asset_service.CreateFeedRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a feed in a parent project/folder/organization to listen to its asset updates.

Parameters
NameDescription
request `.asset_service.CreateFeedRequest`

The request object. Create asset feed request.

parent `str`

Required. The name of the project/folder/organization where this feed should be created in. It can only be an organization number (such as "organizations/123"), a folder number (such as "folders/123"), a project ID (such as "projects/my-project-id")", or a project number (such as "projects/12345"). This corresponds to the parent 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
TypeDescription
`.asset_service.Feed`An asset feed used to export asset updates to a destinations. An asset feed filter controls what updates are exported. The asset feed must be created within a project, organization, or folder. Supported destinations are: Pub/Sub topics.

delete_feed

delete_feed(request: Optional[google.cloud.asset_v1.types.asset_service.DeleteFeedRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes an asset feed.

Parameters
NameDescription
request `.asset_service.DeleteFeedRequest`

The request object.

name `str`

Required. The name of the feed and it must be in the format of: projects/project_number/feeds/feed_id folders/folder_number/feeds/feed_id organizations/organization_number/feeds/feed_id This corresponds to the name 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.

export_assets

export_assets(request: Optional[google.cloud.asset_v1.types.asset_service.ExportAssetsRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Exports assets with time and resource types to a given Cloud Storage location/BigQuery table. For Cloud Storage location destinations, the output format is newline-delimited JSON. Each line represents a xref_google.cloud.asset.v1.Asset in the JSON format; for BigQuery table destinations, the output table stores the fields in asset proto as columns. This API implements the google.longrunning.Operation][google.longrunning.Operation] API , which allows you to keep track of the export. We recommend intervals of at least 2 seconds with exponential retry to poll the export operation result. For regular-size resource parent, the export operation usually finishes within 5 minutes.

Parameters
NameDescription
request `.asset_service.ExportAssetsRequest`

The request object. Export asset request.

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
TypeDescription
`.operation_async.AsyncOperation`An object representing a long-running operation. The result type for the operation will be ```.asset_service.ExportAssetsResponse```: The export asset response. This message is returned by the `google.longrunning.Operations.GetOperation][google.longrunning.Operations.GetOperation]` method in the returned `google.longrunning.Operation.response][google.longrunning.Operation.response]` field.

feed_path

feed_path(project: str, feed: str)

Return a fully-qualified feed string.

from_service_account_file

from_service_account_file(filename: str, *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
{@api.name}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
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
{@api.name}The constructed client.

get_feed

get_feed(request: Optional[google.cloud.asset_v1.types.asset_service.GetFeedRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets details about an asset feed.

Parameters
NameDescription
request `.asset_service.GetFeedRequest`

The request object. Get asset feed request.

name `str`

Required. The name of the Feed and it must be in the format of: projects/project_number/feeds/feed_id folders/folder_number/feeds/feed_id organizations/organization_number/feeds/feed_id This corresponds to the name 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
TypeDescription
`.asset_service.Feed`An asset feed used to export asset updates to a destinations. An asset feed filter controls what updates are exported. The asset feed must be created within a project, organization, or folder. Supported destinations are: Pub/Sub topics.

get_transport_class

get_transport_class()

Return an appropriate transport class.

list_feeds

list_feeds(request: Optional[google.cloud.asset_v1.types.asset_service.ListFeedsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists all asset feeds in a parent project/folder/organization.

Parameters
NameDescription
request `.asset_service.ListFeedsRequest`

The request object. List asset feeds request.

parent `str`

Required. The parent project/folder/organization whose feeds are to be listed. It can only be using project/folder/organization number (such as "folders/12345")", or a project ID (such as "projects/my-project-id"). This corresponds to the parent 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.

search_all_iam_policies

search_all_iam_policies(request: Optional[google.cloud.asset_v1.types.asset_service.SearchAllIamPoliciesRequest] = None, *, scope: Optional[str] = None, query: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Searches all the IAM policies within the given accessible scope (e.g., a project, a folder or an organization). Callers should have cloud.assets.SearchAllIamPolicies permission upon the requested scope, otherwise the request will be rejected.

Parameters
NameDescription
request `.asset_service.SearchAllIamPoliciesRequest`

The request object. Search all IAM policies request.

scope `str`

Required. A scope can be a project, a folder or an organization. The search is limited to the IAM policies within the scope. The allowed values are: - projects/{PROJECT_ID} - projects/{PROJECT_NUMBER} - folders/{FOLDER_NUMBER} - organizations/{ORGANIZATION_NUMBER} This corresponds to the scope field on the request instance; if request is provided, this should not be set.

query `str`

Optional. The query statement. An empty query can be specified to search all the IAM policies within the given scope. Examples: - policy : "amy@gmail.com" to find Cloud IAM policy bindings that specify user "amy@gmail.com". - policy : "roles/compute.admin" to find Cloud IAM policy bindings that specify the Compute Admin role. - policy.role.permissions : "storage.buckets.update" to find Cloud IAM policy bindings that specify a role containing "storage.buckets.update" permission. - resource : "organizations/123" to find Cloud IAM policy bindings that are set on "organizations/123". - (resource : ("organizations/123" OR "folders/1234") AND policy : "amy") to find Cloud IAM policy bindings that are set on "organizations/123" or "folders/1234", and also specify user "amy". See how to construct a query <https://cloud.google.com/asset-inventory/docs/searching-iam-policies#how_to_construct_a_query>__ for more details. This corresponds to the query 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
TypeDescription
`.pagers.SearchAllIamPoliciesAsyncPager`Search all IAM policies response. Iterating over this object will yield results and resolve additional pages automatically.

search_all_resources

search_all_resources(request: Optional[google.cloud.asset_v1.types.asset_service.SearchAllResourcesRequest] = None, *, scope: Optional[str] = None, query: Optional[str] = None, asset_types: Optional[Sequence[str]] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Searches all the resources within the given accessible scope (e.g., a project, a folder or an organization). Callers should have cloud.assets.SearchAllResources permission upon the requested scope, otherwise the request will be rejected.

Parameters
NameDescription
request `.asset_service.SearchAllResourcesRequest`

The request object. Search all resources request.

scope `str`

Required. A scope can be a project, a folder or an organization. The search is limited to the resources within the scope. The allowed values are: - projects/{PROJECT_ID} - projects/{PROJECT_NUMBER} - folders/{FOLDER_NUMBER} - organizations/{ORGANIZATION_NUMBER} This corresponds to the scope field on the request instance; if request is provided, this should not be set.

query `str`

Optional. The query statement. An empty query can be specified to search all the resources of certain asset_types within the given scope. Examples: - name : "Important" to find Cloud resources whose name contains "Important" as a word. - displayName : "Impor*" to find Cloud resources whose display name contains "Impor" as a word prefix. - description : "*por*" to find Cloud resources whose description contains "por" as a substring. - location : "us-west*" to find Cloud resources whose location is prefixed with "us-west". - labels : "prod" to find Cloud resources whose labels contain "prod" as a key or value. - labels.env : "prod" to find Cloud resources which have a label "env" and its value is "prod". - labels.env : * to find Cloud resources which have a label "env". - "Important" to find Cloud resources which contain "Important" as a word in any of the searchable fields. - "Impor*" to find Cloud resources which contain "Impor" as a word prefix in any of the searchable fields. - "*por*" to find Cloud resources which contain "por" as a substring in any of the searchable fields. - ("Important" AND location : ("us-west1" OR "global")) to find Cloud resources which contain "Important" as a word in any of the searchable fields and are also located in the "us-west1" region or the "global" location. See how to construct a query <https://cloud.google.com/asset-inventory/docs/searching-resources#how_to_construct_a_query>__ for more details. This corresponds to the query field on the request instance; if request is provided, this should not be set.

asset_types :class:`Sequence[str]`

Optional. A list of asset types that this request searches for. If empty, it will search all the searchable asset types <https://cloud.google.com/asset-inventory/docs/supported-asset-types#searchable_asset_types>__. This corresponds to the asset_types 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
TypeDescription
`.pagers.SearchAllResourcesAsyncPager`Search all resources response. Iterating over this object will yield results and resolve additional pages automatically.

update_feed

update_feed(request: Optional[google.cloud.asset_v1.types.asset_service.UpdateFeedRequest] = None, *, feed: Optional[google.cloud.asset_v1.types.asset_service.Feed] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates an asset feed configuration.

Parameters
NameDescription
request `.asset_service.UpdateFeedRequest`

The request object. Update asset feed request.

feed `.asset_service.Feed`

Required. The new values of feed details. It must match an existing feed and the field name must be in the format of: projects/project_number/feeds/feed_id or folders/folder_number/feeds/feed_id or organizations/organization_number/feeds/feed_id. This corresponds to the feed 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
TypeDescription
`.asset_service.Feed`An asset feed used to export asset updates to a destinations. An asset feed filter controls what updates are exported. The asset feed must be created within a project, organization, or folder. Supported destinations are: Pub/Sub topics.