Summary of entries of Methods for google-cloud-vectorsearch.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceAsyncClient
DataObjectSearchServiceAsyncClient
(
*
,
credentials
:
typing
.
Optional
[
google
.
auth
.
credentials
.
Credentials
]
=
None
,
transport
:
typing
.
Optional
[
typing
.
Union
[
str
,
google
.
cloud
.
vectorsearch_v1beta
.
services
.
data_object_search_service
.
transports
.
base
.
DataObjectSearchServiceTransport
,
typing
.
Callable
[
[
...
],
google
.
cloud
.
vectorsearch_v1beta
.
services
.
data_object_search_service
.
transports
.
base
.
DataObjectSearchServiceTransport
,
],
]
]
=
"grpc_asyncio"
,
client_options
:
typing
.
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
)
Instantiates the data object search service async client.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceAsyncClient.aggregate_data_objects
aggregate_data_objects
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object_search_service
.
AggregateDataObjectsRequest
,
dict
,
]
]
=
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
.
vectorsearch_v1beta
.
types
.
data_object_search_service
.
AggregateDataObjectsResponse
)
Aggregates data objects.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceAsyncClient.batch_search_data_objects
batch_search_data_objects
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object_search_service
.
BatchSearchDataObjectsRequest
,
dict
,
]
]
=
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
.
vectorsearch_v1beta
.
types
.
data_object_search_service
.
BatchSearchDataObjectsResponse
)
Batch searches data objects.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceAsyncClient.cancel_operation
cancel_operation
(
request
:
typing
.
Optional
[
google
.
longrunning
.
operations_pb2
.
CancelOperationRequest
]
=
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
Starts asynchronous cancellation on a long-running operation.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceAsyncClient.collection_path
collection_path
(
project
:
str
,
location
:
str
,
collection
:
str
)
-
> str
Returns a fully-qualified collection string.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceAsyncClient.common_billing_account_path
common_billing_account_path
(
billing_account
:
str
)
-
> str
Returns a fully-qualified billing_account string.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceAsyncClient.common_folder_path
common_folder_path
(
folder
:
str
)
-
> str
Returns a fully-qualified folder string.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceAsyncClient.common_location_path
common_location_path
(
project
:
str
,
location
:
str
)
-
> str
Returns a fully-qualified location string.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceAsyncClient.common_organization_path
common_organization_path
(
organization
:
str
)
-
> str
Returns a fully-qualified organization string.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceAsyncClient.common_project_path
common_project_path
(
project
:
str
)
-
> str
Returns a fully-qualified project string.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceAsyncClient.data_object_path
data_object_path
(
project
:
str
,
location
:
str
,
collection
:
str
,
dataObject
:
str
)
-
> str
Returns a fully-qualified data_object string.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceAsyncClient.delete_operation
delete_operation
(
request
:
typing
.
Optional
[
google
.
longrunning
.
operations_pb2
.
DeleteOperationRequest
]
=
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 long-running operation.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceAsyncClient.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.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceAsyncClient.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.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceAsyncClient.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.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceAsyncClient.get_location
get_location
(
request
:
typing
.
Optional
[
google
.
cloud
.
location
.
locations_pb2
.
GetLocationRequest
]
=
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
.
location
.
locations_pb2
.
Location
Gets information about a location.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceAsyncClient.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.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceAsyncClient.get_operation
get_operation
(
request
:
typing
.
Optional
[
google
.
longrunning
.
operations_pb2
.
GetOperationRequest
]
=
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
.
longrunning
.
operations_pb2
.
Operation
Gets the latest state of a long-running operation.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceAsyncClient.get_transport_class
get_transport_class
(
label
:
typing
.
Optional
[
str
]
=
None
,
)
-
> typing
.
Type
[
google
.
cloud
.
vectorsearch_v1beta
.
services
.
data_object_search_service
.
transports
.
base
.
DataObjectSearchServiceTransport
]
Returns an appropriate transport class.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceAsyncClient.list_locations
list_locations
(
request
:
typing
.
Optional
[
google
.
cloud
.
location
.
locations_pb2
.
ListLocationsRequest
]
=
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
.
location
.
locations_pb2
.
ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceAsyncClient.list_operations
list_operations
(
request
:
typing
.
Optional
[
google
.
longrunning
.
operations_pb2
.
ListOperationsRequest
]
=
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
.
longrunning
.
operations_pb2
.
ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceAsyncClient.parse_collection_path
parse_collection_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a collection path into its component segments.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceAsyncClient.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.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceAsyncClient.parse_common_folder_path
parse_common_folder_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a folder path into its component segments.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceAsyncClient.parse_common_location_path
parse_common_location_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a location path into its component segments.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceAsyncClient.parse_common_organization_path
parse_common_organization_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a organization path into its component segments.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceAsyncClient.parse_common_project_path
parse_common_project_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a project path into its component segments.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceAsyncClient.parse_data_object_path
parse_data_object_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a data_object path into its component segments.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceAsyncClient.query_data_objects
query_data_objects
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object_search_service
.
QueryDataObjectsRequest
,
dict
,
]
]
=
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
.
vectorsearch_v1beta
.
services
.
data_object_search_service
.
pagers
.
QueryDataObjectsAsyncPager
)
Queries data objects.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceAsyncClient.search_data_objects
search_data_objects
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object_search_service
.
SearchDataObjectsRequest
,
dict
,
]
]
=
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
.
vectorsearch_v1beta
.
services
.
data_object_search_service
.
pagers
.
SearchDataObjectsAsyncPager
)
Searches data objects.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceClient
DataObjectSearchServiceClient
(
*
,
credentials
:
typing
.
Optional
[
google
.
auth
.
credentials
.
Credentials
]
=
None
,
transport
:
typing
.
Optional
[
typing
.
Union
[
str
,
google
.
cloud
.
vectorsearch_v1beta
.
services
.
data_object_search_service
.
transports
.
base
.
DataObjectSearchServiceTransport
,
typing
.
Callable
[
[
...
],
google
.
cloud
.
vectorsearch_v1beta
.
services
.
data_object_search_service
.
transports
.
base
.
DataObjectSearchServiceTransport
,
],
]
]
=
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
=
google
.
api_core
.
gapic_v1
.
client_info
.
ClientInfo
)
Instantiates the data object search service client.
See more: google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceClient
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceClient.__exit__
__exit__
(
type
,
value
,
traceback
)
Releases underlying transport's resources.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceClient.aggregate_data_objects
aggregate_data_objects
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object_search_service
.
AggregateDataObjectsRequest
,
dict
,
]
]
=
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
.
vectorsearch_v1beta
.
types
.
data_object_search_service
.
AggregateDataObjectsResponse
)
Aggregates data objects.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceClient.batch_search_data_objects
batch_search_data_objects
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object_search_service
.
BatchSearchDataObjectsRequest
,
dict
,
]
]
=
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
.
vectorsearch_v1beta
.
types
.
data_object_search_service
.
BatchSearchDataObjectsResponse
)
Batch searches data objects.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceClient.cancel_operation
cancel_operation
(
request
:
typing
.
Optional
[
google
.
longrunning
.
operations_pb2
.
CancelOperationRequest
]
=
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
Starts asynchronous cancellation on a long-running operation.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceClient.collection_path
collection_path
(
project
:
str
,
location
:
str
,
collection
:
str
)
-
> str
Returns a fully-qualified collection string.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceClient.common_billing_account_path
common_billing_account_path
(
billing_account
:
str
)
-
> str
Returns a fully-qualified billing_account string.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceClient.common_folder_path
common_folder_path
(
folder
:
str
)
-
> str
Returns a fully-qualified folder string.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceClient.common_location_path
common_location_path
(
project
:
str
,
location
:
str
)
-
> str
Returns a fully-qualified location string.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceClient.common_organization_path
common_organization_path
(
organization
:
str
)
-
> str
Returns a fully-qualified organization string.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceClient.common_project_path
common_project_path
(
project
:
str
)
-
> str
Returns a fully-qualified project string.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceClient.data_object_path
data_object_path
(
project
:
str
,
location
:
str
,
collection
:
str
,
dataObject
:
str
)
-
> str
Returns a fully-qualified data_object string.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceClient.delete_operation
delete_operation
(
request
:
typing
.
Optional
[
google
.
longrunning
.
operations_pb2
.
DeleteOperationRequest
]
=
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 long-running operation.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceClient.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.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceClient.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.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceClient.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.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceClient.get_location
get_location
(
request
:
typing
.
Optional
[
google
.
cloud
.
location
.
locations_pb2
.
GetLocationRequest
]
=
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
.
location
.
locations_pb2
.
Location
Gets information about a location.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceClient.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.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceClient.get_operation
get_operation
(
request
:
typing
.
Optional
[
google
.
longrunning
.
operations_pb2
.
GetOperationRequest
]
=
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
.
longrunning
.
operations_pb2
.
Operation
Gets the latest state of a long-running operation.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceClient.list_locations
list_locations
(
request
:
typing
.
Optional
[
google
.
cloud
.
location
.
locations_pb2
.
ListLocationsRequest
]
=
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
.
location
.
locations_pb2
.
ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceClient.list_operations
list_operations
(
request
:
typing
.
Optional
[
google
.
longrunning
.
operations_pb2
.
ListOperationsRequest
]
=
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
.
longrunning
.
operations_pb2
.
ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceClient.parse_collection_path
parse_collection_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a collection path into its component segments.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceClient.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.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceClient.parse_common_folder_path
parse_common_folder_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a folder path into its component segments.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceClient.parse_common_location_path
parse_common_location_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a location path into its component segments.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceClient.parse_common_organization_path
parse_common_organization_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a organization path into its component segments.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceClient.parse_common_project_path
parse_common_project_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a project path into its component segments.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceClient.parse_data_object_path
parse_data_object_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a data_object path into its component segments.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceClient.query_data_objects
query_data_objects
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object_search_service
.
QueryDataObjectsRequest
,
dict
,
]
]
=
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
.
vectorsearch_v1beta
.
services
.
data_object_search_service
.
pagers
.
QueryDataObjectsPager
)
Queries data objects.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.DataObjectSearchServiceClient.search_data_objects
search_data_objects
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object_search_service
.
SearchDataObjectsRequest
,
dict
,
]
]
=
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
.
vectorsearch_v1beta
.
services
.
data_object_search_service
.
pagers
.
SearchDataObjectsPager
)
Searches data objects.
google.cloud.vectorsearch_v1beta.services.data_object_search_service.pagers.QueryDataObjectsAsyncPager
QueryDataObjectsAsyncPager
(
method
:
typing
.
Callable
[
[
...
],
typing
.
Awaitable
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object_search_service
.
QueryDataObjectsResponse
],
],
request
:
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object_search_service
.
QueryDataObjectsRequest
,
response
:
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object_search_service
.
QueryDataObjectsResponse
,
*
,
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.vectorsearch_v1beta.services.data_object_search_service.pagers.QueryDataObjectsPager
QueryDataObjectsPager
(
method
:
typing
.
Callable
[
[
...
],
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object_search_service
.
QueryDataObjectsResponse
,
],
request
:
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object_search_service
.
QueryDataObjectsRequest
,
response
:
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object_search_service
.
QueryDataObjectsResponse
,
*
,
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.vectorsearch_v1beta.services.data_object_search_service.pagers.QueryDataObjectsPager
google.cloud.vectorsearch_v1beta.services.data_object_search_service.pagers.SearchDataObjectsAsyncPager
SearchDataObjectsAsyncPager
(
method
:
typing
.
Callable
[
[
...
],
typing
.
Awaitable
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object_search_service
.
SearchDataObjectsResponse
],
],
request
:
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object_search_service
.
SearchDataObjectsRequest
,
response
:
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object_search_service
.
SearchDataObjectsResponse
,
*
,
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.vectorsearch_v1beta.services.data_object_search_service.pagers.SearchDataObjectsPager
SearchDataObjectsPager
(
method
:
typing
.
Callable
[
[
...
],
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object_search_service
.
SearchDataObjectsResponse
,
],
request
:
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object_search_service
.
SearchDataObjectsRequest
,
response
:
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object_search_service
.
SearchDataObjectsResponse
,
*
,
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.vectorsearch_v1beta.services.data_object_search_service.pagers.SearchDataObjectsPager
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceAsyncClient
DataObjectServiceAsyncClient
(
*
,
credentials
:
typing
.
Optional
[
google
.
auth
.
credentials
.
Credentials
]
=
None
,
transport
:
typing
.
Optional
[
typing
.
Union
[
str
,
google
.
cloud
.
vectorsearch_v1beta
.
services
.
data_object_service
.
transports
.
base
.
DataObjectServiceTransport
,
typing
.
Callable
[
[
...
],
google
.
cloud
.
vectorsearch_v1beta
.
services
.
data_object_service
.
transports
.
base
.
DataObjectServiceTransport
,
],
]
]
=
"grpc_asyncio"
,
client_options
:
typing
.
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
)
Instantiates the data object service async client.
See more: google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceAsyncClient
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceAsyncClient.batch_create_data_objects
batch_create_data_objects
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object_service
.
BatchCreateDataObjectsRequest
,
dict
,
]
]
=
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
.
vectorsearch_v1beta
.
types
.
data_object_service
.
BatchCreateDataObjectsResponse
)
Creates a batch of dataObjects.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceAsyncClient.batch_delete_data_objects
batch_delete_data_objects
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object_service
.
BatchDeleteDataObjectsRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
requests
:
typing
.
Optional
[
typing
.
MutableSequence
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object_service
.
DeleteDataObjectRequest
]
]
=
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 dataObjects in a batch.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceAsyncClient.batch_update_data_objects
batch_update_data_objects
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object_service
.
BatchUpdateDataObjectsRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
requests
:
typing
.
Optional
[
typing
.
MutableSequence
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object_service
.
UpdateDataObjectRequest
]
]
=
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
.
vectorsearch_v1beta
.
types
.
data_object_service
.
BatchUpdateDataObjectsResponse
)
Updates dataObjects in a batch.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceAsyncClient.cancel_operation
cancel_operation
(
request
:
typing
.
Optional
[
google
.
longrunning
.
operations_pb2
.
CancelOperationRequest
]
=
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
Starts asynchronous cancellation on a long-running operation.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceAsyncClient.collection_path
collection_path
(
project
:
str
,
location
:
str
,
collection
:
str
)
-
> str
Returns a fully-qualified collection string.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceAsyncClient.common_billing_account_path
common_billing_account_path
(
billing_account
:
str
)
-
> str
Returns a fully-qualified billing_account string.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceAsyncClient.common_folder_path
common_folder_path
(
folder
:
str
)
-
> str
Returns a fully-qualified folder string.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceAsyncClient.common_location_path
common_location_path
(
project
:
str
,
location
:
str
)
-
> str
Returns a fully-qualified location string.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceAsyncClient.common_organization_path
common_organization_path
(
organization
:
str
)
-
> str
Returns a fully-qualified organization string.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceAsyncClient.common_project_path
common_project_path
(
project
:
str
)
-
> str
Returns a fully-qualified project string.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceAsyncClient.create_data_object
create_data_object
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object_service
.
CreateDataObjectRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
data_object
:
typing
.
Optional
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object
.
DataObject
]
=
None
,
data_object_id
:
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
.
vectorsearch_v1beta
.
types
.
data_object
.
DataObject
Creates a dataObject.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceAsyncClient.data_object_path
data_object_path
(
project
:
str
,
location
:
str
,
collection
:
str
,
dataObject
:
str
)
-
> str
Returns a fully-qualified data_object string.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceAsyncClient.delete_data_object
delete_data_object
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object_service
.
DeleteDataObjectRequest
,
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 dataObject.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceAsyncClient.delete_operation
delete_operation
(
request
:
typing
.
Optional
[
google
.
longrunning
.
operations_pb2
.
DeleteOperationRequest
]
=
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 long-running operation.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceAsyncClient.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.vectorsearch_v1beta.services.data_object_service.DataObjectServiceAsyncClient.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.vectorsearch_v1beta.services.data_object_service.DataObjectServiceAsyncClient.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.vectorsearch_v1beta.services.data_object_service.DataObjectServiceAsyncClient.get_data_object
get_data_object
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object_service
.
GetDataObjectRequest
,
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
.
vectorsearch_v1beta
.
types
.
data_object
.
DataObject
Gets a data object.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceAsyncClient.get_location
get_location
(
request
:
typing
.
Optional
[
google
.
cloud
.
location
.
locations_pb2
.
GetLocationRequest
]
=
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
.
location
.
locations_pb2
.
Location
Gets information about a location.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceAsyncClient.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.vectorsearch_v1beta.services.data_object_service.DataObjectServiceAsyncClient.get_operation
get_operation
(
request
:
typing
.
Optional
[
google
.
longrunning
.
operations_pb2
.
GetOperationRequest
]
=
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
.
longrunning
.
operations_pb2
.
Operation
Gets the latest state of a long-running operation.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceAsyncClient.get_transport_class
get_transport_class
(
label
:
typing
.
Optional
[
str
]
=
None
,
)
-
> typing
.
Type
[
google
.
cloud
.
vectorsearch_v1beta
.
services
.
data_object_service
.
transports
.
base
.
DataObjectServiceTransport
]
Returns an appropriate transport class.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceAsyncClient.list_locations
list_locations
(
request
:
typing
.
Optional
[
google
.
cloud
.
location
.
locations_pb2
.
ListLocationsRequest
]
=
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
.
location
.
locations_pb2
.
ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceAsyncClient.list_operations
list_operations
(
request
:
typing
.
Optional
[
google
.
longrunning
.
operations_pb2
.
ListOperationsRequest
]
=
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
.
longrunning
.
operations_pb2
.
ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceAsyncClient.parse_collection_path
parse_collection_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a collection path into its component segments.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceAsyncClient.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.vectorsearch_v1beta.services.data_object_service.DataObjectServiceAsyncClient.parse_common_folder_path
parse_common_folder_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a folder path into its component segments.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceAsyncClient.parse_common_location_path
parse_common_location_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a location path into its component segments.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceAsyncClient.parse_common_organization_path
parse_common_organization_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a organization path into its component segments.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceAsyncClient.parse_common_project_path
parse_common_project_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a project path into its component segments.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceAsyncClient.parse_data_object_path
parse_data_object_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a data_object path into its component segments.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceAsyncClient.update_data_object
update_data_object
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object_service
.
UpdateDataObjectRequest
,
dict
,
]
]
=
None
,
*
,
data_object
:
typing
.
Optional
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object
.
DataObject
]
=
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
.
vectorsearch_v1beta
.
types
.
data_object
.
DataObject
Updates a dataObject.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceClient
DataObjectServiceClient
(
*
,
credentials
:
typing
.
Optional
[
google
.
auth
.
credentials
.
Credentials
]
=
None
,
transport
:
typing
.
Optional
[
typing
.
Union
[
str
,
google
.
cloud
.
vectorsearch_v1beta
.
services
.
data_object_service
.
transports
.
base
.
DataObjectServiceTransport
,
typing
.
Callable
[
[
...
],
google
.
cloud
.
vectorsearch_v1beta
.
services
.
data_object_service
.
transports
.
base
.
DataObjectServiceTransport
,
],
]
]
=
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
=
google
.
api_core
.
gapic_v1
.
client_info
.
ClientInfo
)
Instantiates the data object service client.
See more: google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceClient
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceClient.__exit__
__exit__
(
type
,
value
,
traceback
)
Releases underlying transport's resources.
See more: google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceClient. exit
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceClient.batch_create_data_objects
batch_create_data_objects
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object_service
.
BatchCreateDataObjectsRequest
,
dict
,
]
]
=
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
.
vectorsearch_v1beta
.
types
.
data_object_service
.
BatchCreateDataObjectsResponse
)
Creates a batch of dataObjects.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceClient.batch_delete_data_objects
batch_delete_data_objects
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object_service
.
BatchDeleteDataObjectsRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
requests
:
typing
.
Optional
[
typing
.
MutableSequence
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object_service
.
DeleteDataObjectRequest
]
]
=
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 dataObjects in a batch.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceClient.batch_update_data_objects
batch_update_data_objects
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object_service
.
BatchUpdateDataObjectsRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
requests
:
typing
.
Optional
[
typing
.
MutableSequence
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object_service
.
UpdateDataObjectRequest
]
]
=
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
.
vectorsearch_v1beta
.
types
.
data_object_service
.
BatchUpdateDataObjectsResponse
)
Updates dataObjects in a batch.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceClient.cancel_operation
cancel_operation
(
request
:
typing
.
Optional
[
google
.
longrunning
.
operations_pb2
.
CancelOperationRequest
]
=
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
Starts asynchronous cancellation on a long-running operation.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceClient.collection_path
collection_path
(
project
:
str
,
location
:
str
,
collection
:
str
)
-
> str
Returns a fully-qualified collection string.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceClient.common_billing_account_path
common_billing_account_path
(
billing_account
:
str
)
-
> str
Returns a fully-qualified billing_account string.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceClient.common_folder_path
common_folder_path
(
folder
:
str
)
-
> str
Returns a fully-qualified folder string.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceClient.common_location_path
common_location_path
(
project
:
str
,
location
:
str
)
-
> str
Returns a fully-qualified location string.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceClient.common_organization_path
common_organization_path
(
organization
:
str
)
-
> str
Returns a fully-qualified organization string.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceClient.common_project_path
common_project_path
(
project
:
str
)
-
> str
Returns a fully-qualified project string.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceClient.create_data_object
create_data_object
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object_service
.
CreateDataObjectRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
data_object
:
typing
.
Optional
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object
.
DataObject
]
=
None
,
data_object_id
:
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
.
vectorsearch_v1beta
.
types
.
data_object
.
DataObject
Creates a dataObject.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceClient.data_object_path
data_object_path
(
project
:
str
,
location
:
str
,
collection
:
str
,
dataObject
:
str
)
-
> str
Returns a fully-qualified data_object string.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceClient.delete_data_object
delete_data_object
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object_service
.
DeleteDataObjectRequest
,
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 dataObject.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceClient.delete_operation
delete_operation
(
request
:
typing
.
Optional
[
google
.
longrunning
.
operations_pb2
.
DeleteOperationRequest
]
=
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 long-running operation.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceClient.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.vectorsearch_v1beta.services.data_object_service.DataObjectServiceClient.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.vectorsearch_v1beta.services.data_object_service.DataObjectServiceClient.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.vectorsearch_v1beta.services.data_object_service.DataObjectServiceClient.get_data_object
get_data_object
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object_service
.
GetDataObjectRequest
,
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
.
vectorsearch_v1beta
.
types
.
data_object
.
DataObject
Gets a data object.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceClient.get_location
get_location
(
request
:
typing
.
Optional
[
google
.
cloud
.
location
.
locations_pb2
.
GetLocationRequest
]
=
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
.
location
.
locations_pb2
.
Location
Gets information about a location.
See more: google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceClient.get_location
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceClient.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.vectorsearch_v1beta.services.data_object_service.DataObjectServiceClient.get_operation
get_operation
(
request
:
typing
.
Optional
[
google
.
longrunning
.
operations_pb2
.
GetOperationRequest
]
=
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
.
longrunning
.
operations_pb2
.
Operation
Gets the latest state of a long-running operation.
See more: google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceClient.get_operation
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceClient.list_locations
list_locations
(
request
:
typing
.
Optional
[
google
.
cloud
.
location
.
locations_pb2
.
ListLocationsRequest
]
=
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
.
location
.
locations_pb2
.
ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceClient.list_locations
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceClient.list_operations
list_operations
(
request
:
typing
.
Optional
[
google
.
longrunning
.
operations_pb2
.
ListOperationsRequest
]
=
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
.
longrunning
.
operations_pb2
.
ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceClient.parse_collection_path
parse_collection_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a collection path into its component segments.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceClient.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.vectorsearch_v1beta.services.data_object_service.DataObjectServiceClient.parse_common_folder_path
parse_common_folder_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a folder path into its component segments.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceClient.parse_common_location_path
parse_common_location_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a location path into its component segments.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceClient.parse_common_organization_path
parse_common_organization_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a organization path into its component segments.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceClient.parse_common_project_path
parse_common_project_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a project path into its component segments.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceClient.parse_data_object_path
parse_data_object_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a data_object path into its component segments.
google.cloud.vectorsearch_v1beta.services.data_object_service.DataObjectServiceClient.update_data_object
update_data_object
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object_service
.
UpdateDataObjectRequest
,
dict
,
]
]
=
None
,
*
,
data_object
:
typing
.
Optional
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
data_object
.
DataObject
]
=
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
.
vectorsearch_v1beta
.
types
.
data_object
.
DataObject
Updates a dataObject.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceAsyncClient
VectorSearchServiceAsyncClient
(
*
,
credentials
:
typing
.
Optional
[
google
.
auth
.
credentials
.
Credentials
]
=
None
,
transport
:
typing
.
Optional
[
typing
.
Union
[
str
,
google
.
cloud
.
vectorsearch_v1beta
.
services
.
vector_search_service
.
transports
.
base
.
VectorSearchServiceTransport
,
typing
.
Callable
[
[
...
],
google
.
cloud
.
vectorsearch_v1beta
.
services
.
vector_search_service
.
transports
.
base
.
VectorSearchServiceTransport
,
],
]
]
=
"grpc_asyncio"
,
client_options
:
typing
.
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
)
Instantiates the vector search service async client.
See more: google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceAsyncClient
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceAsyncClient.cancel_operation
cancel_operation
(
request
:
typing
.
Optional
[
google
.
longrunning
.
operations_pb2
.
CancelOperationRequest
]
=
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
Starts asynchronous cancellation on a long-running operation.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceAsyncClient.collection_path
collection_path
(
project
:
str
,
location
:
str
,
collection
:
str
)
-
> str
Returns a fully-qualified collection string.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceAsyncClient.common_billing_account_path
common_billing_account_path
(
billing_account
:
str
)
-
> str
Returns a fully-qualified billing_account string.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceAsyncClient.common_folder_path
common_folder_path
(
folder
:
str
)
-
> str
Returns a fully-qualified folder string.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceAsyncClient.common_location_path
common_location_path
(
project
:
str
,
location
:
str
)
-
> str
Returns a fully-qualified location string.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceAsyncClient.common_organization_path
common_organization_path
(
organization
:
str
)
-
> str
Returns a fully-qualified organization string.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceAsyncClient.common_project_path
common_project_path
(
project
:
str
)
-
> str
Returns a fully-qualified project string.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceAsyncClient.create_collection
create_collection
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
CreateCollectionRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
collection
:
typing
.
Optional
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
Collection
]
=
None
,
collection_id
:
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
.
api_core
.
operation_async
.
AsyncOperation
Creates a new Collection in a given project and location.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceAsyncClient.create_index
create_index
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
CreateIndexRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
index
:
typing
.
Optional
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
Index
]
=
None
,
index_id
:
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
.
api_core
.
operation_async
.
AsyncOperation
Creates a new Index in a given project and location.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceAsyncClient.delete_collection
delete_collection
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
DeleteCollectionRequest
,
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
.
api_core
.
operation_async
.
AsyncOperation
Deletes a single Collection.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceAsyncClient.delete_index
delete_index
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
DeleteIndexRequest
,
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
.
api_core
.
operation_async
.
AsyncOperation
Deletes a single Index.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceAsyncClient.delete_operation
delete_operation
(
request
:
typing
.
Optional
[
google
.
longrunning
.
operations_pb2
.
DeleteOperationRequest
]
=
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 long-running operation.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceAsyncClient.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.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceAsyncClient.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.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceAsyncClient.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.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceAsyncClient.get_collection
get_collection
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
GetCollectionRequest
,
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
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
Collection
Gets details of a single Collection.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceAsyncClient.get_index
get_index
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
GetIndexRequest
,
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
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
Index
Gets details of a single Index.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceAsyncClient.get_location
get_location
(
request
:
typing
.
Optional
[
google
.
cloud
.
location
.
locations_pb2
.
GetLocationRequest
]
=
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
.
location
.
locations_pb2
.
Location
Gets information about a location.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceAsyncClient.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.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceAsyncClient.get_operation
get_operation
(
request
:
typing
.
Optional
[
google
.
longrunning
.
operations_pb2
.
GetOperationRequest
]
=
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
.
longrunning
.
operations_pb2
.
Operation
Gets the latest state of a long-running operation.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceAsyncClient.get_transport_class
get_transport_class
(
label
:
typing
.
Optional
[
str
]
=
None
,
)
-
> typing
.
Type
[
google
.
cloud
.
vectorsearch_v1beta
.
services
.
vector_search_service
.
transports
.
base
.
VectorSearchServiceTransport
]
Returns an appropriate transport class.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceAsyncClient.import_data_objects
import_data_objects
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
ImportDataObjectsRequest
,
dict
,
]
]
=
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
Initiates a Long-Running Operation to import DataObjects into a Collection.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceAsyncClient.index_path
index_path
(
project
:
str
,
location
:
str
,
collection
:
str
,
index
:
str
)
-
> str
Returns a fully-qualified index string.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceAsyncClient.list_collections
list_collections
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
ListCollectionsRequest
,
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
.
vectorsearch_v1beta
.
services
.
vector_search_service
.
pagers
.
ListCollectionsAsyncPager
)
Lists Collections in a given project and location.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceAsyncClient.list_indexes
list_indexes
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
ListIndexesRequest
,
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
.
vectorsearch_v1beta
.
services
.
vector_search_service
.
pagers
.
ListIndexesAsyncPager
)
Lists Indexes in a given project and location.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceAsyncClient.list_locations
list_locations
(
request
:
typing
.
Optional
[
google
.
cloud
.
location
.
locations_pb2
.
ListLocationsRequest
]
=
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
.
location
.
locations_pb2
.
ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceAsyncClient.list_operations
list_operations
(
request
:
typing
.
Optional
[
google
.
longrunning
.
operations_pb2
.
ListOperationsRequest
]
=
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
.
longrunning
.
operations_pb2
.
ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceAsyncClient.parse_collection_path
parse_collection_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a collection path into its component segments.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceAsyncClient.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.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceAsyncClient.parse_common_folder_path
parse_common_folder_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a folder path into its component segments.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceAsyncClient.parse_common_location_path
parse_common_location_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a location path into its component segments.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceAsyncClient.parse_common_organization_path
parse_common_organization_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a organization path into its component segments.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceAsyncClient.parse_common_project_path
parse_common_project_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a project path into its component segments.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceAsyncClient.parse_index_path
parse_index_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a index path into its component segments.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceAsyncClient.update_collection
update_collection
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
UpdateCollectionRequest
,
dict
,
]
]
=
None
,
*
,
collection
:
typing
.
Optional
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
Collection
]
=
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
.
api_core
.
operation_async
.
AsyncOperation
Updates the parameters of a single Collection.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient
VectorSearchServiceClient
(
*
,
credentials
:
typing
.
Optional
[
google
.
auth
.
credentials
.
Credentials
]
=
None
,
transport
:
typing
.
Optional
[
typing
.
Union
[
str
,
google
.
cloud
.
vectorsearch_v1beta
.
services
.
vector_search_service
.
transports
.
base
.
VectorSearchServiceTransport
,
typing
.
Callable
[
[
...
],
google
.
cloud
.
vectorsearch_v1beta
.
services
.
vector_search_service
.
transports
.
base
.
VectorSearchServiceTransport
,
],
]
]
=
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
=
google
.
api_core
.
gapic_v1
.
client_info
.
ClientInfo
)
Instantiates the vector search service client.
See more: google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient.__exit__
__exit__
(
type
,
value
,
traceback
)
Releases underlying transport's resources.
See more: google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient. exit
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient.cancel_operation
cancel_operation
(
request
:
typing
.
Optional
[
google
.
longrunning
.
operations_pb2
.
CancelOperationRequest
]
=
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
Starts asynchronous cancellation on a long-running operation.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient.collection_path
collection_path
(
project
:
str
,
location
:
str
,
collection
:
str
)
-
> str
Returns a fully-qualified collection string.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient.common_billing_account_path
common_billing_account_path
(
billing_account
:
str
)
-
> str
Returns a fully-qualified billing_account string.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient.common_folder_path
common_folder_path
(
folder
:
str
)
-
> str
Returns a fully-qualified folder string.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient.common_location_path
common_location_path
(
project
:
str
,
location
:
str
)
-
> str
Returns a fully-qualified location string.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient.common_organization_path
common_organization_path
(
organization
:
str
)
-
> str
Returns a fully-qualified organization string.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient.common_project_path
common_project_path
(
project
:
str
)
-
> str
Returns a fully-qualified project string.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient.create_collection
create_collection
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
CreateCollectionRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
collection
:
typing
.
Optional
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
Collection
]
=
None
,
collection_id
:
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
.
api_core
.
operation
.
Operation
Creates a new Collection in a given project and location.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient.create_index
create_index
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
CreateIndexRequest
,
dict
,
]
]
=
None
,
*
,
parent
:
typing
.
Optional
[
str
]
=
None
,
index
:
typing
.
Optional
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
Index
]
=
None
,
index_id
:
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
.
api_core
.
operation
.
Operation
Creates a new Index in a given project and location.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient.delete_collection
delete_collection
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
DeleteCollectionRequest
,
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
.
api_core
.
operation
.
Operation
Deletes a single Collection.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient.delete_index
delete_index
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
DeleteIndexRequest
,
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
.
api_core
.
operation
.
Operation
Deletes a single Index.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient.delete_operation
delete_operation
(
request
:
typing
.
Optional
[
google
.
longrunning
.
operations_pb2
.
DeleteOperationRequest
]
=
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 long-running operation.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient.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.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient.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.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient.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.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient.get_collection
get_collection
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
GetCollectionRequest
,
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
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
Collection
Gets details of a single Collection.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient.get_index
get_index
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
GetIndexRequest
,
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
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
Index
Gets details of a single Index.
See more: google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient.get_index
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient.get_location
get_location
(
request
:
typing
.
Optional
[
google
.
cloud
.
location
.
locations_pb2
.
GetLocationRequest
]
=
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
.
location
.
locations_pb2
.
Location
Gets information about a location.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient.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.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient.get_operation
get_operation
(
request
:
typing
.
Optional
[
google
.
longrunning
.
operations_pb2
.
GetOperationRequest
]
=
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
.
longrunning
.
operations_pb2
.
Operation
Gets the latest state of a long-running operation.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient.import_data_objects
import_data_objects
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
ImportDataObjectsRequest
,
dict
,
]
]
=
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
Initiates a Long-Running Operation to import DataObjects into a Collection.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient.index_path
index_path
(
project
:
str
,
location
:
str
,
collection
:
str
,
index
:
str
)
-
> str
Returns a fully-qualified index string.
See more: google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient.index_path
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient.list_collections
list_collections
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
ListCollectionsRequest
,
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
.
vectorsearch_v1beta
.
services
.
vector_search_service
.
pagers
.
ListCollectionsPager
)
Lists Collections in a given project and location.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient.list_indexes
list_indexes
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
ListIndexesRequest
,
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
.
vectorsearch_v1beta
.
services
.
vector_search_service
.
pagers
.
ListIndexesPager
)
Lists Indexes in a given project and location.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient.list_locations
list_locations
(
request
:
typing
.
Optional
[
google
.
cloud
.
location
.
locations_pb2
.
ListLocationsRequest
]
=
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
.
location
.
locations_pb2
.
ListLocationsResponse
Lists information about the supported locations for this service.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient.list_operations
list_operations
(
request
:
typing
.
Optional
[
google
.
longrunning
.
operations_pb2
.
ListOperationsRequest
]
=
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
.
longrunning
.
operations_pb2
.
ListOperationsResponse
Lists operations that match the specified filter in the request.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient.parse_collection_path
parse_collection_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a collection path into its component segments.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient.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.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient.parse_common_folder_path
parse_common_folder_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a folder path into its component segments.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient.parse_common_location_path
parse_common_location_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a location path into its component segments.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient.parse_common_organization_path
parse_common_organization_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a organization path into its component segments.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient.parse_common_project_path
parse_common_project_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parse a project path into its component segments.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient.parse_index_path
parse_index_path
(
path
:
str
)
-
> typing
.
Dict
[
str
,
str
]
Parses a index path into its component segments.
google.cloud.vectorsearch_v1beta.services.vector_search_service.VectorSearchServiceClient.update_collection
update_collection
(
request
:
typing
.
Optional
[
typing
.
Union
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
UpdateCollectionRequest
,
dict
,
]
]
=
None
,
*
,
collection
:
typing
.
Optional
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
Collection
]
=
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
.
api_core
.
operation
.
Operation
Updates the parameters of a single Collection.
google.cloud.vectorsearch_v1beta.services.vector_search_service.pagers.ListCollectionsAsyncPager
ListCollectionsAsyncPager
(
method
:
typing
.
Callable
[
[
...
],
typing
.
Awaitable
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
ListCollectionsResponse
],
],
request
:
google
.
cloud
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
ListCollectionsRequest
,
response
:
google
.
cloud
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
ListCollectionsResponse
,
*
,
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.vectorsearch_v1beta.services.vector_search_service.pagers.ListCollectionsAsyncPager
google.cloud.vectorsearch_v1beta.services.vector_search_service.pagers.ListCollectionsPager
ListCollectionsPager
(
method
:
typing
.
Callable
[
[
...
],
google
.
cloud
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
ListCollectionsResponse
,
],
request
:
google
.
cloud
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
ListCollectionsRequest
,
response
:
google
.
cloud
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
ListCollectionsResponse
,
*
,
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.vectorsearch_v1beta.services.vector_search_service.pagers.ListCollectionsPager
google.cloud.vectorsearch_v1beta.services.vector_search_service.pagers.ListIndexesAsyncPager
ListIndexesAsyncPager
(
method
:
typing
.
Callable
[
[
...
],
typing
.
Awaitable
[
google
.
cloud
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
ListIndexesResponse
],
],
request
:
google
.
cloud
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
ListIndexesRequest
,
response
:
google
.
cloud
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
ListIndexesResponse
,
*
,
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.vectorsearch_v1beta.services.vector_search_service.pagers.ListIndexesAsyncPager
google.cloud.vectorsearch_v1beta.services.vector_search_service.pagers.ListIndexesPager
ListIndexesPager
(
method
:
typing
.
Callable
[
[
...
],
google
.
cloud
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
ListIndexesResponse
,
],
request
:
google
.
cloud
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
ListIndexesRequest
,
response
:
google
.
cloud
.
vectorsearch_v1beta
.
types
.
vectorsearch_service
.
ListIndexesResponse
,
*
,
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.vectorsearch_v1beta.services.vector_search_service.pagers.ListIndexesPager

