Class IndexEndpointServiceAsyncClient (0.9.0)

IndexEndpointServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.aiplatform_v1beta1.services.index_endpoint_service.transports.base.IndexEndpointServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-aiplatform/.nox/docfx/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

A service for managing AI Platform's IndexEndpoints.

Inheritance

builtins.object > IndexEndpointServiceAsyncClient

Properties

transport

Return the transport used by the client instance.

Returns
Type Description
IndexEndpointServiceTransport The transport used by the client instance.

Methods

IndexEndpointServiceAsyncClient

IndexEndpointServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.aiplatform_v1beta1.services.index_endpoint_service.transports.base.IndexEndpointServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-aiplatform/.nox/docfx/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiate the index endpoint service client.

Parameters
Name Description
credentials Optional[google.auth.credentials.Credentials]

The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

transport Union[str, `.IndexEndpointServiceTransport`]

The transport to use. If set to None, a transport is chosen automatically.

client_options ClientOptions

Custom options for the client. It won't take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.

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

common_billing_account_path

common_billing_account_path(billing_account: str)

Return a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Return a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Return a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Return a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Return a fully-qualified project string.

create_index_endpoint

create_index_endpoint(request: Optional[google.cloud.aiplatform_v1beta1.types.index_endpoint_service.CreateIndexEndpointRequest] = None, *, parent: Optional[str] = None, index_endpoint: Optional[google.cloud.aiplatform_v1beta1.types.index_endpoint.IndexEndpoint] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates an IndexEndpoint.

Parameters
Name Description
request CreateIndexEndpointRequest

The request object. Request message for IndexEndpointService.CreateIndexEndpoint.

parent `str`

Required. The resource name of the Location to create the IndexEndpoint in. Format: projects/{project}/locations/{location} This corresponds to the parent field on the request instance; if request is provided, this should not be set.

index_endpoint IndexEndpoint

Required. The IndexEndpoint to create. This corresponds to the index_endpoint field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.api_core.operation_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be IndexEndpoint Indexes are deployed into it. An IndexEndpoint can have multiple DeployedIndexes.

delete_index_endpoint

delete_index_endpoint(request: Optional[google.cloud.aiplatform_v1beta1.types.index_endpoint_service.DeleteIndexEndpointRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes an IndexEndpoint.

Parameters
Name Description
request DeleteIndexEndpointRequest

The request object. Request message for IndexEndpointService.DeleteIndexEndpoint.

name `str`

Required. The name of the IndexEndpoint resource to be deleted. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint} This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.api_core.operation_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be `google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.

deploy_index

deploy_index(request: Optional[google.cloud.aiplatform_v1beta1.types.index_endpoint_service.DeployIndexRequest] = None, *, index_endpoint: Optional[str] = None, deployed_index: Optional[google.cloud.aiplatform_v1beta1.types.index_endpoint.DeployedIndex] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed.

Parameters
Name Description
request DeployIndexRequest

The request object. Request message for IndexEndpointService.DeployIndex.

index_endpoint `str`

Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint} This corresponds to the index_endpoint field on the request instance; if request is provided, this should not be set.

deployed_index DeployedIndex

Required. The DeployedIndex to be created within the IndexEndpoint. This corresponds to the deployed_index field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.api_core.operation_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be DeployIndexResponse Response message for IndexEndpointService.DeployIndex.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name Description
filename str

The path to the service account private key json file.

Returns
Type Description
IndexEndpointServiceAsyncClient The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter
Name Description
info dict

The service account private key info.

Returns
Type Description
IndexEndpointServiceAsyncClient The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name Description
filename str

The path to the service account private key json file.

Returns
Type Description
IndexEndpointServiceAsyncClient The constructed client.

get_index_endpoint

get_index_endpoint(request: Optional[google.cloud.aiplatform_v1beta1.types.index_endpoint_service.GetIndexEndpointRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets an IndexEndpoint.

Parameters
Name Description
request GetIndexEndpointRequest

The request object. Request message for IndexEndpointService.GetIndexEndpoint

name `str`

Required. The name of the IndexEndpoint resource. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint} This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.aiplatform_v1beta1.types.IndexEndpoint Indexes are deployed into it. An IndexEndpoint can have multiple DeployedIndexes.

get_transport_class

get_transport_class()

Return an appropriate transport class.

index_endpoint_path

index_endpoint_path(project: str, location: str, index_endpoint: str)

Return a fully-qualified index_endpoint string.

index_path

index_path(project: str, location: str, index: str)

Return a fully-qualified index string.

list_index_endpoints

list_index_endpoints(request: Optional[google.cloud.aiplatform_v1beta1.types.index_endpoint_service.ListIndexEndpointsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists IndexEndpoints in a Location.

Parameters
Name Description
request ListIndexEndpointsRequest

The request object. Request message for IndexEndpointService.ListIndexEndpoints.

parent `str`

Required. The resource name of the Location from which to list the IndexEndpoints. Format: projects/{project}/locations/{location} This corresponds to the parent field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.aiplatform_v1beta1.services.index_endpoint_service.pagers.ListIndexEndpointsAsyncPager Response message for IndexEndpointService.ListIndexEndpoints. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_index_endpoint_path

parse_index_endpoint_path(path: str)

Parse a index_endpoint path into its component segments.

parse_index_path

parse_index_path(path: str)

Parse a index path into its component segments.

undeploy_index

undeploy_index(request: Optional[google.cloud.aiplatform_v1beta1.types.index_endpoint_service.UndeployIndexRequest] = None, *, index_endpoint: Optional[str] = None, deployed_index_id: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.

Parameters
Name Description
request UndeployIndexRequest

The request object. Request message for IndexEndpointService.UndeployIndex.

index_endpoint `str`

Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint} This corresponds to the index_endpoint field on the request instance; if request is provided, this should not be set.

deployed_index_id `str`

Required. The ID of the DeployedIndex to be undeployed from the IndexEndpoint. This corresponds to the deployed_index_id field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.api_core.operation_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be UndeployIndexResponse Response message for IndexEndpointService.UndeployIndex.

update_index_endpoint

update_index_endpoint(request: Optional[google.cloud.aiplatform_v1beta1.types.index_endpoint_service.UpdateIndexEndpointRequest] = None, *, index_endpoint: Optional[google.cloud.aiplatform_v1beta1.types.index_endpoint.IndexEndpoint] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates an IndexEndpoint.

Parameters
Name Description
request UpdateIndexEndpointRequest

The request object. Request message for IndexEndpointService.UpdateIndexEndpoint.

index_endpoint IndexEndpoint

Required. The IndexEndpoint which replaces the resource on the server. This corresponds to the index_endpoint field on the request instance; if request is provided, this should not be set.

update_mask `google.protobuf.field_mask_pb2.FieldMask`

Required. The update mask applies to the resource. See FieldMask <https://tinyurl.com/protobufs/google.protobuf#fieldmask>__. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.aiplatform_v1beta1.types.IndexEndpoint Indexes are deployed into it. An IndexEndpoint can have multiple DeployedIndexes.