Class FeaturestoreOnlineServingServiceAsyncClient (1.11.0)

Version 1.11.0

• 1.74.0 (latest)
• 1.73.0
• 1.72.0
• 1.71.1
• 1.70.0
• 1.69.0
• 1.68.0
• 1.67.1
• 1.66.0
• 1.65.0
• 1.63.0
• 1.62.0
• 1.60.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.1
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.39.0
• 1.38.1
• 1.37.0
• 1.36.4
• 1.35.0
• 1.34.0
• 1.33.1
• 1.32.0
• 1.31.1
• 1.30.1
• 1.29.0
• 1.28.1
• 1.27.1
• 1.26.1
• 1.25.0
• 1.24.1
• 1.23.0
• 1.22.1
• 1.21.0
• 1.20.0
• 1.19.1
• 1.18.3
• 1.17.1
• 1.16.1
• 1.15.1
• 1.14.0
• 1.13.1
• 1.12.1
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.1
• 1.7.1
• 1.6.2
• 1.5.0
• 1.4.3
• 1.3.0
• 1.2.0
• 1.1.1
• 1.0.1
• 0.9.0
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.1
• 0.4.0
• 0.3.1

FeaturestoreOnlineServingServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.transports.base.FeaturestoreOnlineServingServiceTransport] = 'grpc_asyncio', 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>)

A service for serving online feature values.

Inheritance

builtins.object > FeaturestoreOnlineServingServiceAsyncClient

Properties

transport

Returns the transport used by the client instance.

Returns

Type	Description
FeaturestoreOnlineServingServiceTransport	The transport used by the client instance.

Methods

FeaturestoreOnlineServingServiceAsyncClient

FeaturestoreOnlineServingServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.aiplatform_v1beta1.services.featurestore_online_serving_service.transports.base.FeaturestoreOnlineServingServiceTransport] = 'grpc_asyncio', 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 featurestore online serving 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, `.FeaturestoreOnlineServingServiceTransport`] 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_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.

Exceptions

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

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.

entity_type_path

entity_type_path(project: str, location: str, featurestore: str, entity_type: str)

Returns a fully-qualified entity_type 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
FeaturestoreOnlineServingServiceAsyncClient	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
FeaturestoreOnlineServingServiceAsyncClient	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
FeaturestoreOnlineServingServiceAsyncClient	The constructed client.

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.

get_transport_class

get_transport_class()

Returns an appropriate transport class.

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_entity_type_path

parse_entity_type_path(path: str)

Parses a entity_type path into its component segments.

read_feature_values

read_feature_values(request: Optional[Union[google.cloud.aiplatform_v1beta1.types.featurestore_online_service.ReadFeatureValuesRequest, dict]] = None, *, entity_type: 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]] = ())

Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.

from google.cloud import aiplatform_v1beta1

def sample_read_feature_values():
    # Create a client
    client = aiplatform_v1beta1.FeaturestoreOnlineServingServiceClient()

    # Initialize request argument(s)
    feature_selector = aiplatform_v1beta1.FeatureSelector()
    feature_selector.id_matcher.ids = ['ids_value_1', 'ids_value_2']

    request = aiplatform_v1beta1.ReadFeatureValuesRequest(
        entity_type="entity_type_value",
        entity_id="entity_id_value",
        feature_selector=feature_selector,
    )

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

    # Handle the response
    print(response)

Parameters

Name	Description
request	Union[google.cloud.aiplatform_v1beta1.types.ReadFeatureValuesRequest, dict] The request object. Request message for FeaturestoreOnlineServingService.ReadFeatureValues.
entity_type	`str` Required. The resource name of the EntityType for the entity being read. Value format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be user. This corresponds to the entity_type 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.aiplatform_v1beta1.types.ReadFeatureValuesResponse	Response message for FeaturestoreOnlineServingService.ReadFeatureValues.

streaming_read_feature_values

streaming_read_feature_values(request: Optional[Union[google.cloud.aiplatform_v1beta1.types.featurestore_online_service.StreamingReadFeatureValuesRequest, dict]] = None, *, entity_type: 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]] = ())

Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses.

from google.cloud import aiplatform_v1beta1

def sample_streaming_read_feature_values():
    # Create a client
    client = aiplatform_v1beta1.FeaturestoreOnlineServingServiceClient()

    # Initialize request argument(s)
    feature_selector = aiplatform_v1beta1.FeatureSelector()
    feature_selector.id_matcher.ids = ['ids_value_1', 'ids_value_2']

    request = aiplatform_v1beta1.StreamingReadFeatureValuesRequest(
        entity_type="entity_type_value",
        entity_ids=['entity_ids_value_1', 'entity_ids_value_2'],
        feature_selector=feature_selector,
    )

    # Make the request
    stream = client.streaming_read_feature_values(request=request)

    # Handle the response
    for response in stream:
        print(response)

Parameters

Name	Description
request	Union[google.cloud.aiplatform_v1beta1.types.StreamingReadFeatureValuesRequest, dict] The request object. Request message for [FeaturestoreOnlineServingService.StreamingFeatureValuesRead][].
entity_type	`str` Required. The resource name of the entities' type. Value format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be user. This corresponds to the entity_type 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
AsyncIterable[google.cloud.aiplatform_v1beta1.types.ReadFeatureValuesResponse]	Response message for FeaturestoreOnlineServingService.ReadFeatureValues.