Class IndexEndpointServiceClient (1.18.2)

IndexEndpointServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.aiplatform_v1beta1.services.index_endpoint_service.transports.base.IndexEndpointServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

A service for managing Vertex AI's IndexEndpoints.

Inheritance

builtins.object > IndexEndpointServiceClient

Properties

transport

Returns the transport used by the client instance.

Returns

Type	Description
IndexEndpointServiceTransport	The transport used by the client instance.

Methods

IndexEndpointServiceClient

IndexEndpointServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.aiplatform_v1beta1.services.index_endpoint_service.transports.base.IndexEndpointServiceTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the 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	`google.api_core.client_options.ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.
client_info	`google.api_core.gapic_v1.client_info.ClientInfo` The client info used to send a user-agent string along with API requests. If `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions

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

exit

__exit__(type, value, traceback)

Releases underlying transport's resources.

cancel_operation

cancel_operation(request: Optional[google.longrunning.operations_pb2.CancelOperationRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters

Name	Description
request	`.operations_pb2.CancelOperationRequest` The request object. Request message for `CancelOperation` method.
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.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

create_index_endpoint

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

Creates an IndexEndpoint.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import aiplatform_v1beta1

def sample_create_index_endpoint():
    # Create a client
    client = aiplatform_v1beta1.IndexEndpointServiceClient()

    # Initialize request argument(s)
    index_endpoint = aiplatform_v1beta1.IndexEndpoint()
    index_endpoint.display_name = "display_name_value"

    request = aiplatform_v1beta1.CreateIndexEndpointRequest(
        parent="parent_value",
        index_endpoint=index_endpoint,
    )

    # Make the request
    operation = client.create_index_endpoint(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.aiplatform_v1beta1.types.CreateIndexEndpointRequest, dict]` 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	`google.cloud.aiplatform_v1beta1.types.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.Operation	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[Union[google.cloud.aiplatform_v1beta1.types.index_endpoint_service.DeleteIndexEndpointRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes an IndexEndpoint.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import aiplatform_v1beta1

def sample_delete_index_endpoint():
    # Create a client
    client = aiplatform_v1beta1.IndexEndpointServiceClient()

    # Initialize request argument(s)
    request = aiplatform_v1beta1.DeleteIndexEndpointRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_index_endpoint(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.aiplatform_v1beta1.types.DeleteIndexEndpointRequest, dict]` 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.Operation 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); }

delete_operation

delete_operation(request: Optional[google.longrunning.operations_pb2.DeleteOperationRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters

Name	Description
request	`.operations_pb2.DeleteOperationRequest` The request object. Request message for `DeleteOperation` method.
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.

deploy_index

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

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import aiplatform_v1beta1

def sample_deploy_index():
    # Create a client
    client = aiplatform_v1beta1.IndexEndpointServiceClient()

    # Initialize request argument(s)
    deployed_index = aiplatform_v1beta1.DeployedIndex()
    deployed_index.id = "id_value"
    deployed_index.index = "index_value"

    request = aiplatform_v1beta1.DeployIndexRequest(
        index_endpoint="index_endpoint_value",
        deployed_index=deployed_index,
    )

    # Make the request
    operation = client.deploy_index(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.aiplatform_v1beta1.types.DeployIndexRequest, dict]` 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	`google.cloud.aiplatform_v1beta1.types.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.Operation	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
IndexEndpointServiceClient	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
IndexEndpointServiceClient	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
IndexEndpointServiceClient	The constructed client.

get_iam_policy

get_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets the IAM access control policy for a function.

Returns an empty policy if the function exists and does not have a policy set.

Parameters

Name	Description
request	`.iam_policy_pb2.GetIamPolicyRequest` The request object. Request message for `GetIamPolicy` method.
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

.policy_pb2.Policy Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** :: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ]="" }="" **yaml="" example**="" ::="" bindings:="" -="" members:="" -="" user:mike@example.com="" -="" group:admins@example.com="" -="" domain:google.com="" -="" serviceaccount:my-project-id@appspot.gserviceaccount.com="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:eve@example.com="" role:="" roles/resourcemanager.organizationviewer="" condition:="" title:="" expirable="" access="" description:="" does="" not="" grant="" access="" after="" sep="" 2020="" expression:="" request.time="">< timestamp('2020-10-01t00:00:00.000z')="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the="">IAM developer's guide __.

get_index_endpoint

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

Gets an IndexEndpoint.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import aiplatform_v1beta1

def sample_get_index_endpoint():
    # Create a client
    client = aiplatform_v1beta1.IndexEndpointServiceClient()

    # Initialize request argument(s)
    request = aiplatform_v1beta1.GetIndexEndpointRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Parameters

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

get_location(request: Optional[google.cloud.location.locations_pb2.GetLocationRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets information about a location.

Parameters

Name	Description
request	`.location_pb2.GetLocationRequest` The request object. Request message for `GetLocation` method.
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
`.location_pb2.Location`	Location object.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variabel is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter

Name	Description
client_options	`google.api_core.client_options.ClientOptions` Custom options for the client. Only the `api_endpoint` and `client_cert_source` properties may be used in this method.

Exceptions

Type	Description
google.auth.exceptions.MutualTLSChannelError	If any errors happen.

Returns

Type	Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]]	returns the API endpoint and the client cert source to use.

get_operation

get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets the latest state of a long-running operation.

Parameters

Name	Description
request	`.operations_pb2.GetOperationRequest` The request object. Request message for `GetOperation` method.
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
`.operations_pb2.Operation`	An `Operation` object.

index_endpoint_path

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

Returns a fully-qualified index_endpoint string.

index_path

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

Returns a fully-qualified index string.

list_index_endpoints

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

Lists IndexEndpoints in a Location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import aiplatform_v1beta1

def sample_list_index_endpoints():
    # Create a client
    client = aiplatform_v1beta1.IndexEndpointServiceClient()

    # Initialize request argument(s)
    request = aiplatform_v1beta1.ListIndexEndpointsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_index_endpoints(request=request)

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

Parameters

Name	Description
request	`Union[google.cloud.aiplatform_v1beta1.types.ListIndexEndpointsRequest, dict]` 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.ListIndexEndpointsPager	Response message for IndexEndpointService.ListIndexEndpoints. Iterating over this object will yield results and resolve additional pages automatically.

list_locations

list_locations(request: Optional[google.cloud.location.locations_pb2.ListLocationsRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists information about the supported locations for this service.

Parameters

Name	Description
request	`.location_pb2.ListLocationsRequest` The request object. Request message for `ListLocations` method.
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
`.location_pb2.ListLocationsResponse`	Response message for `ListLocations` method.

list_operations

list_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists operations that match the specified filter in the request.

Parameters

Name	Description
request	`.operations_pb2.ListOperationsRequest` The request object. Request message for `ListOperations` method.
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
`.operations_pb2.ListOperationsResponse`	Response message for `ListOperations` method.

mutate_deployed_index

mutate_deployed_index(request: Optional[Union[google.cloud.aiplatform_v1beta1.types.index_endpoint_service.MutateDeployedIndexRequest, dict]] = None, *, index_endpoint: Optional[str] = None, deployed_index: Optional[google.cloud.aiplatform_v1beta1.types.index_endpoint.DeployedIndex] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Update an existing DeployedIndex under an IndexEndpoint.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import aiplatform_v1beta1

def sample_mutate_deployed_index():
    # Create a client
    client = aiplatform_v1beta1.IndexEndpointServiceClient()

    # Initialize request argument(s)
    deployed_index = aiplatform_v1beta1.DeployedIndex()
    deployed_index.id = "id_value"
    deployed_index.index = "index_value"

    request = aiplatform_v1beta1.MutateDeployedIndexRequest(
        index_endpoint="index_endpoint_value",
        deployed_index=deployed_index,
    )

    # Make the request
    operation = client.mutate_deployed_index(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.aiplatform_v1beta1.types.MutateDeployedIndexRequest, dict]` The request object. Request message for IndexEndpointService.MutateDeployedIndex.
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	`google.cloud.aiplatform_v1beta1.types.DeployedIndex` Required. The DeployedIndex to be updated within the IndexEndpoint. Currently, the updatable fields are `DeployedIndex][automatic_resources]` and `DeployedIndex][dedicated_resources]` 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.Operation	An object representing a long-running operation. The result type for the operation will be MutateDeployedIndexResponse Response message for IndexEndpointService.MutateDeployedIndex.

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)

Parses a index_endpoint path into its component segments.

parse_index_path

parse_index_path(path: str)

Parses a index path into its component segments.

set_iam_policy

set_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Sets the IAM access control policy on the specified function.

Replaces any existing policy.

Parameters

Name	Description
request	`.iam_policy_pb2.SetIamPolicyRequest` The request object. Request message for `SetIamPolicy` method.
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

test_iam_permissions

test_iam_permissions(request: Optional[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Tests the specified IAM permissions against the IAM access control policy for a function.

If the function does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Parameters

Name	Description
request	`.iam_policy_pb2.TestIamPermissionsRequest` The request object. Request message for `TestIamPermissions` method.
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
`.iam_policy_pb2.TestIamPermissionsResponse`	Response message for `TestIamPermissions` method.

undeploy_index

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

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import aiplatform_v1beta1

def sample_undeploy_index():
    # Create a client
    client = aiplatform_v1beta1.IndexEndpointServiceClient()

    # Initialize request argument(s)
    request = aiplatform_v1beta1.UndeployIndexRequest(
        index_endpoint="index_endpoint_value",
        deployed_index_id="deployed_index_id_value",
    )

    # Make the request
    operation = client.undeploy_index(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.aiplatform_v1beta1.types.UndeployIndexRequest, dict]` 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.Operation	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[Union[google.cloud.aiplatform_v1beta1.types.index_endpoint_service.UpdateIndexEndpointRequest, dict]] = None, *, index_endpoint: Optional[google.cloud.aiplatform_v1beta1.types.index_endpoint.IndexEndpoint] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates an IndexEndpoint.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import aiplatform_v1beta1

def sample_update_index_endpoint():
    # Create a client
    client = aiplatform_v1beta1.IndexEndpointServiceClient()

    # Initialize request argument(s)
    index_endpoint = aiplatform_v1beta1.IndexEndpoint()
    index_endpoint.display_name = "display_name_value"

    request = aiplatform_v1beta1.UpdateIndexEndpointRequest(
        index_endpoint=index_endpoint,
    )

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

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.aiplatform_v1beta1.types.UpdateIndexEndpointRequest, dict]` The request object. Request message for IndexEndpointService.UpdateIndexEndpoint.
index_endpoint	`google.cloud.aiplatform_v1beta1.types.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 `google.protobuf.FieldMask][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.

wait_operation

wait_operation(request: Optional[google.longrunning.operations_pb2.WaitOperationRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.

If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters

Name	Description
request	`.operations_pb2.WaitOperationRequest` The request object. Request message for `WaitOperation` method.
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
`.operations_pb2.Operation`	An `Operation` object.