Class AssetServiceClient (3.9.0)

AssetServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.asset_v1p2beta1.services.asset_service.transports.base.AssetServiceTransport]] = None, client_options: 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.

Inheritance

builtins.object > AssetServiceClient

Properties

transport

Returns the transport used by the client instance.

Returns

Type	Description
AssetServiceTransport	The transport used by the client instance.

Methods

AssetServiceClient

AssetServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.asset_v1p2beta1.services.asset_service.transports.base.AssetServiceTransport]] = None, client_options: 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, AssetServiceTransport]` The transport to use. If set to None, a transport is chosen automatically.
client_options	`google.api_core.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_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be 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.

Exceptions

Type	Description
google.auth.exceptions.MutualTLSChannelError	If mutual TLS transport creation failed for any reason.

exit

__exit__(type, value, traceback)

Releases underlying transport's resources.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

create_feed

create_feed(request: Optional[Union[google.cloud.asset_v1p2beta1.types.asset_service.CreateFeedRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <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.

from google.cloud import asset_v1p2beta1

def sample_create_feed():
    # Create a client
    client = asset_v1p2beta1.AssetServiceClient()

    # Initialize request argument(s)
    feed = asset_v1p2beta1.Feed()
    feed.name = "name_value"

    request = asset_v1p2beta1.CreateFeedRequest(
        parent="parent_value",
        feed_id="feed_id_value",
        feed=feed,
    )

    # Make the request
    response = client.create_feed(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.asset_v1p2beta1.types.CreateFeedRequest, dict]` 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

Type	Description
google.cloud.asset_v1p2beta1.types.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: Cloud Pub/Sub topics.

delete_feed

delete_feed(request: Optional[Union[google.cloud.asset_v1p2beta1.types.asset_service.DeleteFeedRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes an asset feed.

from google.cloud import asset_v1p2beta1

def sample_delete_feed():
    # Create a client
    client = asset_v1p2beta1.AssetServiceClient()

    # Initialize request argument(s)
    request = asset_v1p2beta1.DeleteFeedRequest(
        name="name_value",
    )

    # Make the request
    client.delete_feed(request=request)

Parameters

Name	Description
request	`Union[google.cloud.asset_v1p2beta1.types.DeleteFeedRequest, dict]` 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.

feed_path

feed_path(project: str, feed: str)

Returns 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

Name	Description
filename	`str` The path to the service account private key json file.

Returns

Type	Description
AssetServiceClient	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
AssetServiceClient	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
AssetServiceClient	The constructed client.

get_feed

get_feed(request: Optional[Union[google.cloud.asset_v1p2beta1.types.asset_service.GetFeedRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets details about an asset feed.

from google.cloud import asset_v1p2beta1

def sample_get_feed():
    # Create a client
    client = asset_v1p2beta1.AssetServiceClient()

    # Initialize request argument(s)
    request = asset_v1p2beta1.GetFeedRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_feed(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.asset_v1p2beta1.types.GetFeedRequest, dict]` 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

Type	Description
google.cloud.asset_v1p2beta1.types.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: Cloud Pub/Sub topics.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: 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 `api_endpoint` and `client_cert_source` properties may be used in this method.

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.

list_feeds

list_feeds(request: Optional[Union[google.cloud.asset_v1p2beta1.types.asset_service.ListFeedsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

from google.cloud import asset_v1p2beta1

def sample_list_feeds():
    # Create a client
    client = asset_v1p2beta1.AssetServiceClient()

    # Initialize request argument(s)
    request = asset_v1p2beta1.ListFeedsRequest(
        parent="parent_value",
    )

    # Make the request
    response = client.list_feeds(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.asset_v1p2beta1.types.ListFeedsRequest, dict]` 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.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_feed_path

parse_feed_path(path: str)

Parses a feed path into its component segments.

update_feed

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

Updates an asset feed configuration.

from google.cloud import asset_v1p2beta1

def sample_update_feed():
    # Create a client
    client = asset_v1p2beta1.AssetServiceClient()

    # Initialize request argument(s)
    feed = asset_v1p2beta1.Feed()
    feed.name = "name_value"

    request = asset_v1p2beta1.UpdateFeedRequest(
        feed=feed,
    )

    # Make the request
    response = client.update_feed(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.asset_v1p2beta1.types.UpdateFeedRequest, dict]` The request object. Update asset feed request.
feed	`google.cloud.asset_v1p2beta1.types.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

Type	Description
google.cloud.asset_v1p2beta1.types.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: Cloud Pub/Sub topics.