Summary of entries of Methods for recommendationengine.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceAsyncClient
CatalogServiceAsyncClient
(
*
,
credentials
:
typing
.
Optional
[
google
.
auth
.
credentials
.
Credentials
]
=
None
,
transport
:
typing
.
Optional
[
typing
.
Union
[
str
,
google
.
cloud
.
recommendationengine_v1beta1
.
services
.
catalog_service
.
transports
.
base
.
CatalogServiceTransport
,
typing
.
Callable
[[
...
],
google
.
cloud
.
recommendationengine_v1beta1
.
services
.
catalog_service
.
transports
.
base
.
CatalogServiceTransport
]]]
=
'grpc_asyncio'
,
client_options
:
typing
.
Optional
[
google
.
api_core
.
client_options
.
ClientOptions
]
=
None
,
client_info
:
google
.
api_core
.
gapic_v1
.
client_info
.
ClientInfo
=
Instantiates the catalog service async client.
See more: google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceAsyncClient
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceAsyncClient.catalog_item_path_path
catalog_item_path_path
(
project
:
str
,
location
:
str
,
catalog
:
str
,
catalog_item_path
:
str
)
-
> str
Returns a fully-qualified catalog_item_path string.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceAsyncClient.catalog_path
catalog_path
(
project
:
str
,
location
:
str
,
catalog
:
str
)
-
> str
Returns a fully-qualified catalog string.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceAsyncClient.common_billing_account_path
common_billing_account_path
(
billing_account
:
str
)
-
> str
Returns a fully-qualified billing_account string.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceAsyncClient.common_folder_path
common_folder_path
(
folder
:
str
)
-
> str
Returns a fully-qualified folder string.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceAsyncClient.common_location_path
common_location_path
(
project
:
str
,
location
:
str
)
-
> str
Returns a fully-qualified location string.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceAsyncClient.common_organization_path
common_organization_path
(
organization
:
str
)
-
> str
Returns a fully-qualified organization string.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceAsyncClient.common_project_path
common_project_path
(
project
:
str
)
-
> str
Returns a fully-qualified project string.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceAsyncClient.create_catalog_item
create_catalog_item
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
catalog_service
.
CreateCatalogItemRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
catalog_item
:
typing
.
Optional
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
catalog
.
CatalogItem
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
-
> google
.
cloud
.
recommendationengine_v1beta1
.
types
.
catalog
.
CatalogItem
Creates a catalog item.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceAsyncClient.delete_catalog_item
delete_catalog_item
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
catalog_service
.
DeleteCatalogItemRequest
,
dict
,
]
]
=
None
,
*
,
name
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
-
> None
Deletes a catalog item.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceAsyncClient.from_service_account_file
from_service_account_file
(
filename
:
str
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials file.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceAsyncClient.from_service_account_info
from_service_account_info
(
info
:
dict
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials info.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceAsyncClient.from_service_account_json
from_service_account_json
(
filename
:
str
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials file.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceAsyncClient.get_catalog_item
get_catalog_item
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
catalog_service
.
GetCatalogItemRequest
,
dict
,
]
]
=
None
,
*
,
name
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
-
> google
.
cloud
.
recommendationengine_v1beta1
.
types
.
catalog
.
CatalogItem
Gets a specific catalog item.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceAsyncClient.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.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceAsyncClient.get_transport_class
get_transport_class
(
label
:
typing
.
Optional
[
str
]
=
None
,
)
-
> typing
.
Type
[
google
.
cloud
.
recommendationengine_v1beta1
.
services
.
catalog_service
.
transports
.
base
.
CatalogServiceTransport
]
Returns an appropriate transport class.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceAsyncClient.import_catalog_items
import_catalog_items
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
import_
.
ImportCatalogItemsRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
request_id
:
typing
.
Optional
[
str
]
=
None
,
input_config
:
typing
.
Optional
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
import_
.
InputConfig
]
=
None
,
errors_config
:
typing
.
Optional
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
import_
.
ImportErrorsConfig
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
-
> google
.
api_core
.
operation_async
.
AsyncOperation
Bulk import of multiple catalog items.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceAsyncClient.list_catalog_items
list_catalog_items
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
catalog_service
.
ListCatalogItemsRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
filter
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
-
> (
google
.
cloud
.
recommendationengine_v1beta1
.
services
.
catalog_service
.
pagers
.
ListCatalogItemsAsyncPager
)
Gets a list of catalog items.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceAsyncClient.parse_catalog_item_path_path
parse_catalog_item_path_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a catalog_item_path path into its component segments.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceAsyncClient.parse_catalog_path
parse_catalog_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a catalog path into its component segments.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceAsyncClient.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.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceAsyncClient.parse_common_folder_path
parse_common_folder_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a folder path into its component segments.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceAsyncClient.parse_common_location_path
parse_common_location_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a location path into its component segments.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceAsyncClient.parse_common_organization_path
parse_common_organization_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a organization path into its component segments.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceAsyncClient.parse_common_project_path
parse_common_project_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a project path into its component segments.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceAsyncClient.update_catalog_item
update_catalog_item
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
catalog_service
.
UpdateCatalogItemRequest
,
dict
,
]
]
=
None
,
*
,
name
:
typing
.
Optional
[
str
]
=
None
,
catalog_item
:
typing
.
Optional
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
catalog
.
CatalogItem
]
=
None
,
update_mask
:
typing
.
Optional
[
google
.
protobuf
.
field_mask_pb2
.
FieldMask
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
-
> google
.
cloud
.
recommendationengine_v1beta1
.
types
.
catalog
.
CatalogItem
Updates a catalog item.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceClient
CatalogServiceClient
(
*
,
credentials
:
typing
.
Optional
[
google
.
auth
.
credentials
.
Credentials
]
=
None
,
transport
:
typing
.
Optional
[
typing
.
Union
[
str
,
google
.
cloud
.
recommendationengine_v1beta1
.
services
.
catalog_service
.
transports
.
base
.
CatalogServiceTransport
,
typing
.
Callable
[[
...
],
google
.
cloud
.
recommendationengine_v1beta1
.
services
.
catalog_service
.
transports
.
base
.
CatalogServiceTransport
]]]
=
None
,
client_options
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
client_options
.
ClientOptions
,
dict
]]
=
None
,
client_info
:
google
.
api_core
.
gapic_v1
.
client_info
.
ClientInfo
=
Instantiates the catalog service client.
See more: google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceClient
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceClient.__exit__
__exit__
(
type
,
value
,
traceback
)
Releases underlying transport's resources.
See more: google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceClient. exit
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceClient.catalog_item_path_path
catalog_item_path_path
(
project
:
str
,
location
:
str
,
catalog
:
str
,
catalog_item_path
:
str
)
-
> str
Returns a fully-qualified catalog_item_path string.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceClient.catalog_path
catalog_path
(
project
:
str
,
location
:
str
,
catalog
:
str
)
-
> str
Returns a fully-qualified catalog string.
See more: google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceClient.catalog_path
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceClient.common_billing_account_path
common_billing_account_path
(
billing_account
:
str
)
-
> str
Returns a fully-qualified billing_account string.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceClient.common_folder_path
common_folder_path
(
folder
:
str
)
-
> str
Returns a fully-qualified folder string.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceClient.common_location_path
common_location_path
(
project
:
str
,
location
:
str
)
-
> str
Returns a fully-qualified location string.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceClient.common_organization_path
common_organization_path
(
organization
:
str
)
-
> str
Returns a fully-qualified organization string.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceClient.common_project_path
common_project_path
(
project
:
str
)
-
> str
Returns a fully-qualified project string.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceClient.create_catalog_item
create_catalog_item
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
catalog_service
.
CreateCatalogItemRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
catalog_item
:
typing
.
Optional
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
catalog
.
CatalogItem
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
-
> google
.
cloud
.
recommendationengine_v1beta1
.
types
.
catalog
.
CatalogItem
Creates a catalog item.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceClient.delete_catalog_item
delete_catalog_item
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
catalog_service
.
DeleteCatalogItemRequest
,
dict
,
]
]
=
None
,
*
,
name
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
-
> None
Deletes a catalog item.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceClient.from_service_account_file
from_service_account_file
(
filename
:
str
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials file.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceClient.from_service_account_info
from_service_account_info
(
info
:
dict
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials info.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceClient.from_service_account_json
from_service_account_json
(
filename
:
str
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials file.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceClient.get_catalog_item
get_catalog_item
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
catalog_service
.
GetCatalogItemRequest
,
dict
,
]
]
=
None
,
*
,
name
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
-
> google
.
cloud
.
recommendationengine_v1beta1
.
types
.
catalog
.
CatalogItem
Gets a specific catalog item.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source
(
client_options
:
typing
.
Optional
[
google
.
api_core
.
client_options
.
ClientOptions
]
=
None
,
)
Deprecated.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceClient.import_catalog_items
import_catalog_items
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
import_
.
ImportCatalogItemsRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
request_id
:
typing
.
Optional
[
str
]
=
None
,
input_config
:
typing
.
Optional
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
import_
.
InputConfig
]
=
None
,
errors_config
:
typing
.
Optional
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
import_
.
ImportErrorsConfig
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
-
> google
.
api_core
.
operation
.
Operation
Bulk import of multiple catalog items.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceClient.list_catalog_items
list_catalog_items
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
catalog_service
.
ListCatalogItemsRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
filter
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
-
> (
google
.
cloud
.
recommendationengine_v1beta1
.
services
.
catalog_service
.
pagers
.
ListCatalogItemsPager
)
Gets a list of catalog items.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceClient.parse_catalog_item_path_path
parse_catalog_item_path_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a catalog_item_path path into its component segments.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceClient.parse_catalog_path
parse_catalog_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a catalog path into its component segments.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceClient.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.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceClient.parse_common_folder_path
parse_common_folder_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a folder path into its component segments.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceClient.parse_common_location_path
parse_common_location_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a location path into its component segments.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceClient.parse_common_organization_path
parse_common_organization_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a organization path into its component segments.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceClient.parse_common_project_path
parse_common_project_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a project path into its component segments.
google.cloud.recommendationengine_v1beta1.services.catalog_service.CatalogServiceClient.update_catalog_item
update_catalog_item
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
catalog_service
.
UpdateCatalogItemRequest
,
dict
,
]
]
=
None
,
*
,
name
:
typing
.
Optional
[
str
]
=
None
,
catalog_item
:
typing
.
Optional
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
catalog
.
CatalogItem
]
=
None
,
update_mask
:
typing
.
Optional
[
google
.
protobuf
.
field_mask_pb2
.
FieldMask
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
-
> google
.
cloud
.
recommendationengine_v1beta1
.
types
.
catalog
.
CatalogItem
Updates a catalog item.
google.cloud.recommendationengine_v1beta1.services.catalog_service.pagers.ListCatalogItemsAsyncPager
ListCatalogItemsAsyncPager
(
method
:
typing
.
Callable
[
[
...
],
typing
.
Awaitable
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
catalog_service
.
ListCatalogItemsResponse
],
],
request
:
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
catalog_service
.
ListCatalogItemsRequest
,
response
:
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
catalog_service
.
ListCatalogItemsResponse
,
*
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
Instantiates the pager.
See more: google.cloud.recommendationengine_v1beta1.services.catalog_service.pagers.ListCatalogItemsAsyncPager
google.cloud.recommendationengine_v1beta1.services.catalog_service.pagers.ListCatalogItemsPager
ListCatalogItemsPager
(
method
:
typing
.
Callable
[
[
...
],
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
catalog_service
.
ListCatalogItemsResponse
,
],
request
:
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
catalog_service
.
ListCatalogItemsRequest
,
response
:
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
catalog_service
.
ListCatalogItemsResponse
,
*
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
Instantiate the pager.
See more: google.cloud.recommendationengine_v1beta1.services.catalog_service.pagers.ListCatalogItemsPager
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryAsyncClient
PredictionApiKeyRegistryAsyncClient
(
*
,
credentials
:
typing
.
Optional
[
google
.
auth
.
credentials
.
Credentials
]
=
None
,
transport
:
typing
.
Optional
[
typing
.
Union
[
str
,
google
.
cloud
.
recommendationengine_v1beta1
.
services
.
prediction_api_key_registry
.
transports
.
base
.
PredictionApiKeyRegistryTransport
,
typing
.
Callable
[[
...
],
google
.
cloud
.
recommendationengine_v1beta1
.
services
.
prediction_api_key_registry
.
transports
.
base
.
PredictionApiKeyRegistryTransport
]]]
=
'grpc_asyncio'
,
client_options
:
typing
.
Optional
[
google
.
api_core
.
client_options
.
ClientOptions
]
=
None
,
client_info
:
google
.
api_core
.
gapic_v1
.
client_info
.
ClientInfo
=
Instantiates the prediction api key registry async client.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryAsyncClient.common_billing_account_path
common_billing_account_path
(
billing_account
:
str
)
-
> str
Returns a fully-qualified billing_account string.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryAsyncClient.common_folder_path
common_folder_path
(
folder
:
str
)
-
> str
Returns a fully-qualified folder string.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryAsyncClient.common_location_path
common_location_path
(
project
:
str
,
location
:
str
)
-
> str
Returns a fully-qualified location string.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryAsyncClient.common_organization_path
common_organization_path
(
organization
:
str
)
-
> str
Returns a fully-qualified organization string.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryAsyncClient.common_project_path
common_project_path
(
project
:
str
)
-
> str
Returns a fully-qualified project string.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryAsyncClient.create_prediction_api_key_registration
create_prediction_api_key_registration
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
prediction_apikey_registry_service
.
CreatePredictionApiKeyRegistrationRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
prediction_api_key_registration
:
typing
.
Optional
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
prediction_apikey_registry_service
.
PredictionApiKeyRegistration
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
-
> (
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
prediction_apikey_registry_service
.
PredictionApiKeyRegistration
)
Register an API key for use with predict method.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryAsyncClient.delete_prediction_api_key_registration
delete_prediction_api_key_registration
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
prediction_apikey_registry_service
.
DeletePredictionApiKeyRegistrationRequest
,
dict
,
]
]
=
None
,
*
,
name
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
-
> None
Unregister an apiKey from using for predict method.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryAsyncClient.event_store_path
event_store_path
(
project
:
str
,
location
:
str
,
catalog
:
str
,
event_store
:
str
)
-
> str
Returns a fully-qualified event_store string.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryAsyncClient.from_service_account_file
from_service_account_file
(
filename
:
str
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials file.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryAsyncClient.from_service_account_info
from_service_account_info
(
info
:
dict
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials info.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryAsyncClient.from_service_account_json
from_service_account_json
(
filename
:
str
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials file.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryAsyncClient.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.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryAsyncClient.get_transport_class
get_transport_class
(
label
:
typing
.
Optional
[
str
]
=
None
,
)
-
> typing
.
Type
[
google
.
cloud
.
recommendationengine_v1beta1
.
services
.
prediction_api_key_registry
.
transports
.
base
.
PredictionApiKeyRegistryTransport
]
Returns an appropriate transport class.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryAsyncClient.list_prediction_api_key_registrations
list_prediction_api_key_registrations
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
prediction_apikey_registry_service
.
ListPredictionApiKeyRegistrationsRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
-
> (
google
.
cloud
.
recommendationengine_v1beta1
.
services
.
prediction_api_key_registry
.
pagers
.
ListPredictionApiKeyRegistrationsAsyncPager
)
List the registered apiKeys for use with predict method.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryAsyncClient.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.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryAsyncClient.parse_common_folder_path
parse_common_folder_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a folder path into its component segments.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryAsyncClient.parse_common_location_path
parse_common_location_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a location path into its component segments.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryAsyncClient.parse_common_organization_path
parse_common_organization_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a organization path into its component segments.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryAsyncClient.parse_common_project_path
parse_common_project_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a project path into its component segments.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryAsyncClient.parse_event_store_path
parse_event_store_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a event_store path into its component segments.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryAsyncClient.parse_prediction_api_key_registration_path
parse_prediction_api_key_registration_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a prediction_api_key_registration path into its component segments.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryAsyncClient.prediction_api_key_registration_path
prediction_api_key_registration_path
(
project
:
str
,
location
:
str
,
catalog
:
str
,
event_store
:
str
,
prediction_api_key_registration
:
str
,
)
-
> str
Returns a fully-qualified prediction_api_key_registration string.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryClient
PredictionApiKeyRegistryClient
(
*
,
credentials
:
typing
.
Optional
[
google
.
auth
.
credentials
.
Credentials
]
=
None
,
transport
:
typing
.
Optional
[
typing
.
Union
[
str
,
google
.
cloud
.
recommendationengine_v1beta1
.
services
.
prediction_api_key_registry
.
transports
.
base
.
PredictionApiKeyRegistryTransport
,
typing
.
Callable
[[
...
],
google
.
cloud
.
recommendationengine_v1beta1
.
services
.
prediction_api_key_registry
.
transports
.
base
.
PredictionApiKeyRegistryTransport
]]]
=
None
,
client_options
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
client_options
.
ClientOptions
,
dict
]]
=
None
,
client_info
:
google
.
api_core
.
gapic_v1
.
client_info
.
ClientInfo
=
Instantiates the prediction api key registry client.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryClient.__exit__
__exit__
(
type
,
value
,
traceback
)
Releases underlying transport's resources.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryClient.common_billing_account_path
common_billing_account_path
(
billing_account
:
str
)
-
> str
Returns a fully-qualified billing_account string.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryClient.common_folder_path
common_folder_path
(
folder
:
str
)
-
> str
Returns a fully-qualified folder string.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryClient.common_location_path
common_location_path
(
project
:
str
,
location
:
str
)
-
> str
Returns a fully-qualified location string.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryClient.common_organization_path
common_organization_path
(
organization
:
str
)
-
> str
Returns a fully-qualified organization string.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryClient.common_project_path
common_project_path
(
project
:
str
)
-
> str
Returns a fully-qualified project string.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryClient.create_prediction_api_key_registration
create_prediction_api_key_registration
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
prediction_apikey_registry_service
.
CreatePredictionApiKeyRegistrationRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
prediction_api_key_registration
:
typing
.
Optional
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
prediction_apikey_registry_service
.
PredictionApiKeyRegistration
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
-
> (
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
prediction_apikey_registry_service
.
PredictionApiKeyRegistration
)
Register an API key for use with predict method.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryClient.delete_prediction_api_key_registration
delete_prediction_api_key_registration
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
prediction_apikey_registry_service
.
DeletePredictionApiKeyRegistrationRequest
,
dict
,
]
]
=
None
,
*
,
name
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
-
> None
Unregister an apiKey from using for predict method.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryClient.event_store_path
event_store_path
(
project
:
str
,
location
:
str
,
catalog
:
str
,
event_store
:
str
)
-
> str
Returns a fully-qualified event_store string.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryClient.from_service_account_file
from_service_account_file
(
filename
:
str
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials file.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryClient.from_service_account_info
from_service_account_info
(
info
:
dict
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials info.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryClient.from_service_account_json
from_service_account_json
(
filename
:
str
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials file.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source
(
client_options
:
typing
.
Optional
[
google
.
api_core
.
client_options
.
ClientOptions
]
=
None
,
)
Deprecated.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryClient.list_prediction_api_key_registrations
list_prediction_api_key_registrations
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
prediction_apikey_registry_service
.
ListPredictionApiKeyRegistrationsRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
-
> (
google
.
cloud
.
recommendationengine_v1beta1
.
services
.
prediction_api_key_registry
.
pagers
.
ListPredictionApiKeyRegistrationsPager
)
List the registered apiKeys for use with predict method.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryClient.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.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryClient.parse_common_folder_path
parse_common_folder_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a folder path into its component segments.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryClient.parse_common_location_path
parse_common_location_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a location path into its component segments.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryClient.parse_common_organization_path
parse_common_organization_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a organization path into its component segments.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryClient.parse_common_project_path
parse_common_project_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a project path into its component segments.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryClient.parse_event_store_path
parse_event_store_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a event_store path into its component segments.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryClient.parse_prediction_api_key_registration_path
parse_prediction_api_key_registration_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a prediction_api_key_registration path into its component segments.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.PredictionApiKeyRegistryClient.prediction_api_key_registration_path
prediction_api_key_registration_path
(
project
:
str
,
location
:
str
,
catalog
:
str
,
event_store
:
str
,
prediction_api_key_registration
:
str
,
)
-
> str
Returns a fully-qualified prediction_api_key_registration string.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.pagers.ListPredictionApiKeyRegistrationsAsyncPager
ListPredictionApiKeyRegistrationsAsyncPager
(
method
:
typing
.
Callable
[
[
...
],
typing
.
Awaitable
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
prediction_apikey_registry_service
.
ListPredictionApiKeyRegistrationsResponse
],
],
request
:
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
prediction_apikey_registry_service
.
ListPredictionApiKeyRegistrationsRequest
,
response
:
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
prediction_apikey_registry_service
.
ListPredictionApiKeyRegistrationsResponse
,
*
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
Instantiates the pager.
google.cloud.recommendationengine_v1beta1.services.prediction_api_key_registry.pagers.ListPredictionApiKeyRegistrationsPager
ListPredictionApiKeyRegistrationsPager
(
method
:
typing
.
Callable
[
[
...
],
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
prediction_apikey_registry_service
.
ListPredictionApiKeyRegistrationsResponse
,
],
request
:
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
prediction_apikey_registry_service
.
ListPredictionApiKeyRegistrationsRequest
,
response
:
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
prediction_apikey_registry_service
.
ListPredictionApiKeyRegistrationsResponse
,
*
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
Instantiate the pager.
google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceAsyncClient
PredictionServiceAsyncClient
(
*
,
credentials
:
typing
.
Optional
[
google
.
auth
.
credentials
.
Credentials
]
=
None
,
transport
:
typing
.
Optional
[
typing
.
Union
[
str
,
google
.
cloud
.
recommendationengine_v1beta1
.
services
.
prediction_service
.
transports
.
base
.
PredictionServiceTransport
,
typing
.
Callable
[[
...
],
google
.
cloud
.
recommendationengine_v1beta1
.
services
.
prediction_service
.
transports
.
base
.
PredictionServiceTransport
]]]
=
'grpc_asyncio'
,
client_options
:
typing
.
Optional
[
google
.
api_core
.
client_options
.
ClientOptions
]
=
None
,
client_info
:
google
.
api_core
.
gapic_v1
.
client_info
.
ClientInfo
=
Instantiates the prediction service async client.
See more: google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceAsyncClient
google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceAsyncClient.common_billing_account_path
common_billing_account_path
(
billing_account
:
str
)
-
> str
Returns a fully-qualified billing_account string.
google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceAsyncClient.common_folder_path
common_folder_path
(
folder
:
str
)
-
> str
Returns a fully-qualified folder string.
google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceAsyncClient.common_location_path
common_location_path
(
project
:
str
,
location
:
str
)
-
> str
Returns a fully-qualified location string.
google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceAsyncClient.common_organization_path
common_organization_path
(
organization
:
str
)
-
> str
Returns a fully-qualified organization string.
google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceAsyncClient.common_project_path
common_project_path
(
project
:
str
)
-
> str
Returns a fully-qualified project string.
google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceAsyncClient.from_service_account_file
from_service_account_file
(
filename
:
str
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials file.
google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceAsyncClient.from_service_account_info
from_service_account_info
(
info
:
dict
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials info.
google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceAsyncClient.from_service_account_json
from_service_account_json
(
filename
:
str
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials file.
google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceAsyncClient.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.
google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceAsyncClient.get_transport_class
get_transport_class
(
label
:
typing
.
Optional
[
str
]
=
None
,
)
-
> typing
.
Type
[
google
.
cloud
.
recommendationengine_v1beta1
.
services
.
prediction_service
.
transports
.
base
.
PredictionServiceTransport
]
Returns an appropriate transport class.
google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceAsyncClient.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.
google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceAsyncClient.parse_common_folder_path
parse_common_folder_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a folder path into its component segments.
google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceAsyncClient.parse_common_location_path
parse_common_location_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a location path into its component segments.
google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceAsyncClient.parse_common_organization_path
parse_common_organization_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a organization path into its component segments.
google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceAsyncClient.parse_common_project_path
parse_common_project_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a project path into its component segments.
google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceAsyncClient.parse_placement_path
parse_placement_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a placement path into its component segments.
google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceAsyncClient.placement_path
placement_path
(
project
:
str
,
location
:
str
,
catalog
:
str
,
event_store
:
str
,
placement
:
str
)
-
> str
Returns a fully-qualified placement string.
google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceAsyncClient.predict
predict
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
prediction_service
.
PredictRequest
,
dict
,
]
]
=
None
,
*
,
name
:
typing
.
Optional
[
str
]
=
None
,
user_event
:
typing
.
Optional
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
user_event
.
UserEvent
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
-
> (
google
.
cloud
.
recommendationengine_v1beta1
.
services
.
prediction_service
.
pagers
.
PredictAsyncPager
)
Makes a recommendation prediction.
google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceClient
PredictionServiceClient
(
*
,
credentials
:
typing
.
Optional
[
google
.
auth
.
credentials
.
Credentials
]
=
None
,
transport
:
typing
.
Optional
[
typing
.
Union
[
str
,
google
.
cloud
.
recommendationengine_v1beta1
.
services
.
prediction_service
.
transports
.
base
.
PredictionServiceTransport
,
typing
.
Callable
[[
...
],
google
.
cloud
.
recommendationengine_v1beta1
.
services
.
prediction_service
.
transports
.
base
.
PredictionServiceTransport
]]]
=
None
,
client_options
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
client_options
.
ClientOptions
,
dict
]]
=
None
,
client_info
:
google
.
api_core
.
gapic_v1
.
client_info
.
ClientInfo
=
Instantiates the prediction service client.
See more: google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceClient
google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceClient.__exit__
__exit__
(
type
,
value
,
traceback
)
Releases underlying transport's resources.
See more: google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceClient. exit
google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceClient.common_billing_account_path
common_billing_account_path
(
billing_account
:
str
)
-
> str
Returns a fully-qualified billing_account string.
google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceClient.common_folder_path
common_folder_path
(
folder
:
str
)
-
> str
Returns a fully-qualified folder string.
google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceClient.common_location_path
common_location_path
(
project
:
str
,
location
:
str
)
-
> str
Returns a fully-qualified location string.
google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceClient.common_organization_path
common_organization_path
(
organization
:
str
)
-
> str
Returns a fully-qualified organization string.
google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceClient.common_project_path
common_project_path
(
project
:
str
)
-
> str
Returns a fully-qualified project string.
google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceClient.from_service_account_file
from_service_account_file
(
filename
:
str
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials file.
google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceClient.from_service_account_info
from_service_account_info
(
info
:
dict
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials info.
google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceClient.from_service_account_json
from_service_account_json
(
filename
:
str
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials file.
google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source
(
client_options
:
typing
.
Optional
[
google
.
api_core
.
client_options
.
ClientOptions
]
=
None
,
)
Deprecated.
google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceClient.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.
google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceClient.parse_common_folder_path
parse_common_folder_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a folder path into its component segments.
google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceClient.parse_common_location_path
parse_common_location_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a location path into its component segments.
google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceClient.parse_common_organization_path
parse_common_organization_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a organization path into its component segments.
google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceClient.parse_common_project_path
parse_common_project_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a project path into its component segments.
google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceClient.parse_placement_path
parse_placement_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a placement path into its component segments.
google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceClient.placement_path
placement_path
(
project
:
str
,
location
:
str
,
catalog
:
str
,
event_store
:
str
,
placement
:
str
)
-
> str
Returns a fully-qualified placement string.
google.cloud.recommendationengine_v1beta1.services.prediction_service.PredictionServiceClient.predict
predict
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
prediction_service
.
PredictRequest
,
dict
,
]
]
=
None
,
*
,
name
:
typing
.
Optional
[
str
]
=
None
,
user_event
:
typing
.
Optional
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
user_event
.
UserEvent
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
-
> (
google
.
cloud
.
recommendationengine_v1beta1
.
services
.
prediction_service
.
pagers
.
PredictPager
)
Makes a recommendation prediction.
google.cloud.recommendationengine_v1beta1.services.prediction_service.pagers.PredictAsyncPager
PredictAsyncPager
(
method
:
typing
.
Callable
[
[
...
],
typing
.
Awaitable
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
prediction_service
.
PredictResponse
],
],
request
:
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
prediction_service
.
PredictRequest
,
response
:
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
prediction_service
.
PredictResponse
,
*
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
Instantiates the pager.
See more: google.cloud.recommendationengine_v1beta1.services.prediction_service.pagers.PredictAsyncPager
google.cloud.recommendationengine_v1beta1.services.prediction_service.pagers.PredictPager
PredictPager
(
method
:
typing
.
Callable
[
[
...
],
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
prediction_service
.
PredictResponse
,
],
request
:
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
prediction_service
.
PredictRequest
,
response
:
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
prediction_service
.
PredictResponse
,
*
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
Instantiate the pager.
See more: google.cloud.recommendationengine_v1beta1.services.prediction_service.pagers.PredictPager
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceAsyncClient
UserEventServiceAsyncClient
(
*
,
credentials
:
typing
.
Optional
[
google
.
auth
.
credentials
.
Credentials
]
=
None
,
transport
:
typing
.
Optional
[
typing
.
Union
[
str
,
google
.
cloud
.
recommendationengine_v1beta1
.
services
.
user_event_service
.
transports
.
base
.
UserEventServiceTransport
,
typing
.
Callable
[[
...
],
google
.
cloud
.
recommendationengine_v1beta1
.
services
.
user_event_service
.
transports
.
base
.
UserEventServiceTransport
]]]
=
'grpc_asyncio'
,
client_options
:
typing
.
Optional
[
google
.
api_core
.
client_options
.
ClientOptions
]
=
None
,
client_info
:
google
.
api_core
.
gapic_v1
.
client_info
.
ClientInfo
=
Instantiates the user event service async client.
See more: google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceAsyncClient
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceAsyncClient.collect_user_event
collect_user_event
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
user_event_service
.
CollectUserEventRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
user_event
:
typing
.
Optional
[
str
]
=
None
,
uri
:
typing
.
Optional
[
str
]
=
None
,
ets
:
typing
.
Optional
[
int
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
-
> google
.
api
.
httpbody_pb2
.
HttpBody
Writes a single user event from the browser.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceAsyncClient.common_billing_account_path
common_billing_account_path
(
billing_account
:
str
)
-
> str
Returns a fully-qualified billing_account string.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceAsyncClient.common_folder_path
common_folder_path
(
folder
:
str
)
-
> str
Returns a fully-qualified folder string.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceAsyncClient.common_location_path
common_location_path
(
project
:
str
,
location
:
str
)
-
> str
Returns a fully-qualified location string.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceAsyncClient.common_organization_path
common_organization_path
(
organization
:
str
)
-
> str
Returns a fully-qualified organization string.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceAsyncClient.common_project_path
common_project_path
(
project
:
str
)
-
> str
Returns a fully-qualified project string.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceAsyncClient.event_store_path
event_store_path
(
project
:
str
,
location
:
str
,
catalog
:
str
,
event_store
:
str
)
-
> str
Returns a fully-qualified event_store string.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceAsyncClient.from_service_account_file
from_service_account_file
(
filename
:
str
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials file.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceAsyncClient.from_service_account_info
from_service_account_info
(
info
:
dict
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials info.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceAsyncClient.from_service_account_json
from_service_account_json
(
filename
:
str
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials file.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceAsyncClient.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.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceAsyncClient.get_transport_class
get_transport_class
(
label
:
typing
.
Optional
[
str
]
=
None
,
)
-
> typing
.
Type
[
google
.
cloud
.
recommendationengine_v1beta1
.
services
.
user_event_service
.
transports
.
base
.
UserEventServiceTransport
]
Returns an appropriate transport class.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceAsyncClient.import_user_events
import_user_events
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
import_
.
ImportUserEventsRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
request_id
:
typing
.
Optional
[
str
]
=
None
,
input_config
:
typing
.
Optional
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
import_
.
InputConfig
]
=
None
,
errors_config
:
typing
.
Optional
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
import_
.
ImportErrorsConfig
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
-
> google
.
api_core
.
operation_async
.
AsyncOperation
Bulk import of User events.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceAsyncClient.list_user_events
list_user_events
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
user_event_service
.
ListUserEventsRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
filter
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
-
> (
google
.
cloud
.
recommendationengine_v1beta1
.
services
.
user_event_service
.
pagers
.
ListUserEventsAsyncPager
)
Gets a list of user events within a time range, with potential filtering.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceAsyncClient.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.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceAsyncClient.parse_common_folder_path
parse_common_folder_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a folder path into its component segments.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceAsyncClient.parse_common_location_path
parse_common_location_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a location path into its component segments.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceAsyncClient.parse_common_organization_path
parse_common_organization_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a organization path into its component segments.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceAsyncClient.parse_common_project_path
parse_common_project_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a project path into its component segments.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceAsyncClient.parse_event_store_path
parse_event_store_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a event_store path into its component segments.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceAsyncClient.purge_user_events
purge_user_events
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
user_event_service
.
PurgeUserEventsRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
filter
:
typing
.
Optional
[
str
]
=
None
,
force
:
typing
.
Optional
[
bool
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
-
> google
.
api_core
.
operation_async
.
AsyncOperation
Deletes permanently all user events specified by the filter provided.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceAsyncClient.write_user_event
write_user_event
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
user_event_service
.
WriteUserEventRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
user_event
:
typing
.
Optional
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
user_event
.
UserEvent
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
-
> google
.
cloud
.
recommendationengine_v1beta1
.
types
.
user_event
.
UserEvent
Writes a single user event.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceClient
UserEventServiceClient
(
*
,
credentials
:
typing
.
Optional
[
google
.
auth
.
credentials
.
Credentials
]
=
None
,
transport
:
typing
.
Optional
[
typing
.
Union
[
str
,
google
.
cloud
.
recommendationengine_v1beta1
.
services
.
user_event_service
.
transports
.
base
.
UserEventServiceTransport
,
typing
.
Callable
[[
...
],
google
.
cloud
.
recommendationengine_v1beta1
.
services
.
user_event_service
.
transports
.
base
.
UserEventServiceTransport
]]]
=
None
,
client_options
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
client_options
.
ClientOptions
,
dict
]]
=
None
,
client_info
:
google
.
api_core
.
gapic_v1
.
client_info
.
ClientInfo
=
Instantiates the user event service client.
See more: google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceClient
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceClient.__exit__
__exit__
(
type
,
value
,
traceback
)
Releases underlying transport's resources.
See more: google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceClient. exit
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceClient.collect_user_event
collect_user_event
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
user_event_service
.
CollectUserEventRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
user_event
:
typing
.
Optional
[
str
]
=
None
,
uri
:
typing
.
Optional
[
str
]
=
None
,
ets
:
typing
.
Optional
[
int
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
-
> google
.
api
.
httpbody_pb2
.
HttpBody
Writes a single user event from the browser.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceClient.common_billing_account_path
common_billing_account_path
(
billing_account
:
str
)
-
> str
Returns a fully-qualified billing_account string.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceClient.common_folder_path
common_folder_path
(
folder
:
str
)
-
> str
Returns a fully-qualified folder string.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceClient.common_location_path
common_location_path
(
project
:
str
,
location
:
str
)
-
> str
Returns a fully-qualified location string.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceClient.common_organization_path
common_organization_path
(
organization
:
str
)
-
> str
Returns a fully-qualified organization string.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceClient.common_project_path
common_project_path
(
project
:
str
)
-
> str
Returns a fully-qualified project string.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceClient.event_store_path
event_store_path
(
project
:
str
,
location
:
str
,
catalog
:
str
,
event_store
:
str
)
-
> str
Returns a fully-qualified event_store string.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceClient.from_service_account_file
from_service_account_file
(
filename
:
str
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials file.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceClient.from_service_account_info
from_service_account_info
(
info
:
dict
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials info.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceClient.from_service_account_json
from_service_account_json
(
filename
:
str
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials file.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source
(
client_options
:
typing
.
Optional
[
google
.
api_core
.
client_options
.
ClientOptions
]
=
None
,
)
Deprecated.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceClient.import_user_events
import_user_events
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
import_
.
ImportUserEventsRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
request_id
:
typing
.
Optional
[
str
]
=
None
,
input_config
:
typing
.
Optional
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
import_
.
InputConfig
]
=
None
,
errors_config
:
typing
.
Optional
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
import_
.
ImportErrorsConfig
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
-
> google
.
api_core
.
operation
.
Operation
Bulk import of User events.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceClient.list_user_events
list_user_events
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
user_event_service
.
ListUserEventsRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
filter
:
typing
.
Optional
[
str
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
-
> (
google
.
cloud
.
recommendationengine_v1beta1
.
services
.
user_event_service
.
pagers
.
ListUserEventsPager
)
Gets a list of user events within a time range, with potential filtering.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceClient.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.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceClient.parse_common_folder_path
parse_common_folder_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a folder path into its component segments.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceClient.parse_common_location_path
parse_common_location_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a location path into its component segments.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceClient.parse_common_organization_path
parse_common_organization_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a organization path into its component segments.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceClient.parse_common_project_path
parse_common_project_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a project path into its component segments.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceClient.parse_event_store_path
parse_event_store_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a event_store path into its component segments.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceClient.purge_user_events
purge_user_events
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
user_event_service
.
PurgeUserEventsRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
filter
:
typing
.
Optional
[
str
]
=
None
,
force
:
typing
.
Optional
[
bool
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
-
> google
.
api_core
.
operation
.
Operation
Deletes permanently all user events specified by the filter provided.
google.cloud.recommendationengine_v1beta1.services.user_event_service.UserEventServiceClient.write_user_event
write_user_event
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
user_event_service
.
WriteUserEventRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
user_event
:
typing
.
Optional
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
user_event
.
UserEvent
]
=
None
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
-
> google
.
cloud
.
recommendationengine_v1beta1
.
types
.
user_event
.
UserEvent
Writes a single user event.
google.cloud.recommendationengine_v1beta1.services.user_event_service.pagers.ListUserEventsAsyncPager
ListUserEventsAsyncPager
(
method
:
typing
.
Callable
[
[
...
],
typing
.
Awaitable
[
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
user_event_service
.
ListUserEventsResponse
],
],
request
:
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
user_event_service
.
ListUserEventsRequest
,
response
:
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
user_event_service
.
ListUserEventsResponse
,
*
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary_async
.
AsyncRetry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
Instantiates the pager.
google.cloud.recommendationengine_v1beta1.services.user_event_service.pagers.ListUserEventsPager
ListUserEventsPager
(
method
:
typing
.
Callable
[
[
...
],
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
user_event_service
.
ListUserEventsResponse
,
],
request
:
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
user_event_service
.
ListUserEventsRequest
,
response
:
google
.
cloud
.
recommendationengine_v1beta1
.
types
.
user_event_service
.
ListUserEventsResponse
,
*
,
retry
:
typing
.
Optional
[
typing
.
Union
[
google
.
api_core
.
retry
.
retry_unary
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
,
]
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
timeout
:
typing
.
Union
[
float
,
object
]
=
_MethodDefault
.
_DEFAULT_VALUE
,
metadata
:
typing
.
Sequence
[
typing
.
Tuple
[
str
,
typing
.
Union
[
str
,
bytes
]]]
=
()
)
Instantiate the pager.
See more: google.cloud.recommendationengine_v1beta1.services.user_event_service.pagers.ListUserEventsPager