IndexEndpointService¶

async delete_index_endpoint(request: Optional[Union[DeleteIndexEndpointRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[AsyncRetry, _MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → AsyncOperation[source]¶

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_v1

async def sample_delete_index_endpoint():
    # Create a client
    client = aiplatform_v1.IndexEndpointServiceAsyncClient()

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

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

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

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters:

request (Optional[Union[google.cloud.aiplatform_v1.types.DeleteIndexEndpointRequest, dict]]) – The request object. Request message for [IndexEndpointService.DeleteIndexEndpoint][google.cloud.aiplatform.v1.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_async.AsyncRetry) – 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:

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);

}

Return type:

async delete_operation(request: Optional[DeleteOperationRequest] = None, *, retry: Optional[Union[AsyncRetry, _MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

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:

request (DeleteOperationRequest) – The request object. Request message for DeleteOperation method.
retry (google.api_core.retry_async.AsyncRetry) – 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:

None

async deploy_index(request: Optional[Union[DeployIndexRequest, dict]] = None, *, index_endpoint: Optional[str] = None, deployed_index: Optional[DeployedIndex] = None, retry: Optional[Union[AsyncRetry, _MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → AsyncOperation[source]¶

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_v1

async def sample_deploy_index():
    # Create a client
    client = aiplatform_v1.IndexEndpointServiceAsyncClient()

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

    request = aiplatform_v1.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 = (await operation).result()

    # Handle the response
    print(response)

Parameters:

request (Optional[Union[google.cloud.aiplatform_v1.types.DeployIndexRequest, dict]]) – The request object. Request message for [IndexEndpointService.DeployIndex][google.cloud.aiplatform.v1.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_v1.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_async.AsyncRetry) – 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:

An object representing a long-running operation.

The result type for the operation will be google.cloud.aiplatform_v1.types.DeployIndexResponse Response message for: [IndexEndpointService.DeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.DeployIndex].

Return type:

IndexEndpointServiceAsyncClient

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

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

Parameters:

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns:

The constructed client.

Return type:

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

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

Parameters:

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns:

The constructed client.

Return type:

IndexEndpointServiceAsyncClient

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

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

Parameters:

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns:

The constructed client.

Return type:

IndexEndpointServiceAsyncClient

async get_iam_policy(request: Optional[GetIamPolicyRequest] = None, *, retry: Optional[Union[AsyncRetry, _MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → Policy[source]¶

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:

request (GetIamPolicyRequest) – The request object. Request message for GetIamPolicy method.
retry (google.api_core.retry_async.AsyncRetry) – 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:

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.

Return type:

Policy

async get_index_endpoint(request: Optional[Union[GetIndexEndpointRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[AsyncRetry, _MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → IndexEndpoint[source]¶

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_v1

async def sample_get_index_endpoint():
    # Create a client
    client = aiplatform_v1.IndexEndpointServiceAsyncClient()

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

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

    # Handle the response
    print(response)

Parameters:

request (Optional[Union[google.cloud.aiplatform_v1.types.GetIndexEndpointRequest, dict]]) – The request object. Request message for [IndexEndpointService.GetIndexEndpoint][google.cloud.aiplatform.v1.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_async.AsyncRetry) – 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:

Indexes are deployed into it. An IndexEndpoint can have multiple DeployedIndexes.

Return type:

google.cloud.aiplatform_v1.services.index_endpoint_service.pagers.ListIndexEndpointsAsyncPager

async get_location(request: Optional[GetLocationRequest] = None, *, retry: Optional[Union[AsyncRetry, _MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → Location[source]¶

Gets information about a location.

Parameters:

request (GetLocationRequest) – The request object. Request message for GetLocation method.
retry (google.api_core.retry_async.AsyncRetry) – 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:

Location object.

Return type:

Location

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[ClientOptions] = None)[source]¶

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 variable 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.

Parameters:

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.

Returns:

returns the API endpoint and the: client cert source to use.

Return type:

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises:

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

async get_operation(request: Optional[GetOperationRequest] = None, *, retry: Optional[Union[AsyncRetry, _MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → Operation[source]¶

Gets the latest state of a long-running operation.

Parameters:

request (GetOperationRequest) – The request object. Request message for GetOperation method.
retry (google.api_core.retry_async.AsyncRetry) – 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:

An Operation object.

Return type:

Operation

classmethod get_transport_class(label: Optional[str] = None) → Type[IndexEndpointServiceTransport]¶

Returns an appropriate transport class.

Parameters:: label – The name of the desired transport. If none is provided, then the first transport in the registry is used.
Returns:: The transport class to use.

static index_endpoint_path(project: str, location: str, index_endpoint: str) → str¶: Returns a fully-qualified index_endpoint string.

static index_path(project: str, location: str, index: str) → str¶: Returns a fully-qualified index string.

async list_index_endpoints(request: Optional[Union[ListIndexEndpointsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[AsyncRetry, _MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → ListIndexEndpointsAsyncPager[source]¶

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_v1

async def sample_list_index_endpoints():
    # Create a client
    client = aiplatform_v1.IndexEndpointServiceAsyncClient()

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

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

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

Parameters:

request (Optional[Union[google.cloud.aiplatform_v1.types.ListIndexEndpointsRequest, dict]]) – The request object. Request message for [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1.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_async.AsyncRetry) – 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:

Response message for: [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints].

Iterating over this object will yield results and resolve additional pages automatically.

Return type:

async list_locations(request: Optional[ListLocationsRequest] = None, *, retry: Optional[Union[AsyncRetry, _MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → ListLocationsResponse[source]¶

Lists information about the supported locations for this service.

Parameters:

request (ListLocationsRequest) – The request object. Request message for ListLocations method.
retry (google.api_core.retry_async.AsyncRetry) – 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:

Response message for ListLocations method.

Return type:

ListLocationsResponse

async list_operations(request: Optional[ListOperationsRequest] = None, *, retry: Optional[Union[AsyncRetry, _MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → ListOperationsResponse[source]¶

Lists operations that match the specified filter in the request.

Parameters:

request (ListOperationsRequest) – The request object. Request message for ListOperations method.
retry (google.api_core.retry_async.AsyncRetry) – 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:

Response message for ListOperations method.

Return type:

ListOperationsResponse

async mutate_deployed_index(request: Optional[Union[MutateDeployedIndexRequest, dict]] = None, *, index_endpoint: Optional[str] = None, deployed_index: Optional[DeployedIndex] = None, retry: Optional[Union[AsyncRetry, _MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → AsyncOperation[source]¶

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_v1

async def sample_mutate_deployed_index():
    # Create a client
    client = aiplatform_v1.IndexEndpointServiceAsyncClient()

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

    request = aiplatform_v1.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 = (await operation).result()

    # Handle the response
    print(response)

Parameters:

request (Optional[Union[google.cloud.aiplatform_v1.types.MutateDeployedIndexRequest, dict]]) – The request object. Request message for [IndexEndpointService.MutateDeployedIndex][google.cloud.aiplatform.v1.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_v1.types.DeployedIndex) –
Required. The DeployedIndex to be updated within the IndexEndpoint. Currently, the updatable fields are [DeployedIndex.automatic_resources][google.cloud.aiplatform.v1.DeployedIndex.automatic_resources] and [DeployedIndex.dedicated_resources][google.cloud.aiplatform.v1.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_async.AsyncRetry) – 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:

An object representing a long-running operation.

The result type for the operation will be google.cloud.aiplatform_v1.types.MutateDeployedIndexResponse Response message for: [IndexEndpointService.MutateDeployedIndex][google.cloud.aiplatform.v1.IndexEndpointService.MutateDeployedIndex].

Return type:

static parse_common_billing_account_path(path: str) → Dict[str, str]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str]¶: Parse a project path into its component segments.

static parse_index_endpoint_path(path: str) → Dict[str, str]¶: Parses a index_endpoint path into its component segments.

static parse_index_path(path: str) → Dict[str, str]¶: Parses a index path into its component segments.

static parse_reservation_path(path: str) → Dict[str, str]¶: Parses a reservation path into its component segments.

static reservation_path(project_id_or_number: str, zone: str, reservation_name: str) → str¶: Returns a fully-qualified reservation string.

async set_iam_policy(request: Optional[SetIamPolicyRequest] = None, *, retry: Optional[Union[AsyncRetry, _MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → Policy[source]¶

Sets the IAM access control policy on the specified function.

Replaces any existing policy.

Parameters:

request (SetIamPolicyRequest) – The request object. Request message for SetIamPolicy method.
retry (google.api_core.retry_async.AsyncRetry) – 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:

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.

Return type:

Policy

async test_iam_permissions(request: Optional[TestIamPermissionsRequest] = None, *, retry: Optional[Union[AsyncRetry, _MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → TestIamPermissionsResponse[source]¶

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:

request (TestIamPermissionsRequest) – The request object. Request message for TestIamPermissions method.
retry (google.api_core.retry_async.AsyncRetry) – 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:

Response message for TestIamPermissions method.

Return type:

TestIamPermissionsResponse

property transport: IndexEndpointServiceTransport¶

Returns the transport used by the client instance.

Returns:: The transport used by the client instance.
Return type:: IndexEndpointServiceTransport

async undeploy_index(request: Optional[Union[UndeployIndexRequest, dict]] = None, *, index_endpoint: Optional[str] = None, deployed_index_id: Optional[str] = None, retry: Optional[Union[AsyncRetry, _MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → AsyncOperation[source]¶

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_v1

async def sample_undeploy_index():
    # Create a client
    client = aiplatform_v1.IndexEndpointServiceAsyncClient()

    # Initialize request argument(s)
    request = aiplatform_v1.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 = (await operation).result()

    # Handle the response
    print(response)

Parameters:

request (Optional[Union[google.cloud.aiplatform_v1.types.UndeployIndexRequest, dict]]) – The request object. Request message for [IndexEndpointService.UndeployIndex][google.cloud.aiplatform.v1.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_async.AsyncRetry) – 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:

An object representing a long-running operation.

The result type for the operation will be google.cloud.aiplatform_v1.types.UndeployIndexResponse Response message for: [IndexEndpointService.UndeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.UndeployIndex].

Return type:

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns:

The universe domain used: by the client instance.

Return type:

str

async update_index_endpoint(request: Optional[Union[UpdateIndexEndpointRequest, dict]] = None, *, index_endpoint: Optional[IndexEndpoint] = None, update_mask: Optional[FieldMask] = None, retry: Optional[Union[AsyncRetry, _MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → IndexEndpoint[source]¶

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_v1

async def sample_update_index_endpoint():
    # Create a client
    client = aiplatform_v1.IndexEndpointServiceAsyncClient()

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

    request = aiplatform_v1.UpdateIndexEndpointRequest(
        index_endpoint=index_endpoint,
    )

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

    # Handle the response
    print(response)

Parameters:

request (Optional[Union[google.cloud.aiplatform_v1.types.UpdateIndexEndpointRequest, dict]]) – The request object. Request message for [IndexEndpointService.UpdateIndexEndpoint][google.cloud.aiplatform.v1.IndexEndpointService.UpdateIndexEndpoint].
index_endpoint (google.cloud.aiplatform_v1.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_async.AsyncRetry) – 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:

Indexes are deployed into it. An IndexEndpoint can have multiple DeployedIndexes.

Return type:

async wait_operation(request: Optional[WaitOperationRequest] = None, *, retry: Optional[Union[AsyncRetry, _MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → Operation[source]¶

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:

request (WaitOperationRequest) – The request object. Request message for WaitOperation method.
retry (google.api_core.retry_async.AsyncRetry) – 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:

An Operation object.

Return type:

Operation

class google.cloud.aiplatform_v1.services.index_endpoint_service.IndexEndpointServiceClient(*, credentials: ~typing.Optional[~google.auth.credentials.Credentials] = None, transport: ~typing.Optional[~typing.Union[str, ~google.cloud.aiplatform_v1.services.index_endpoint_service.transports.base.IndexEndpointServiceTransport, ~typing.Callable[[...], ~google.cloud.aiplatform_v1.services.index_endpoint_service.transports.base.IndexEndpointServiceTransport]]] = 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 object>)[source]¶

A service for managing Vertex AI’s IndexEndpoints.

Instantiates the index endpoint service client.

Parameters:

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 (Optional[Union[str,IndexEndpointServiceTransport,Callable[..., IndexEndpointServiceTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the IndexEndpointServiceTransport constructor. If set to None, a transport is chosen automatically.
client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –
Custom options for the client.

1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “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).

2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS 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.

3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
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.

Raises:

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

__exit__(type, value, traceback)[source]¶: Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

property api_endpoint¶

Return the API endpoint used by the client instance.

Returns:: The API endpoint used by the client instance.
Return type:: str

cancel_operation(request: Optional[CancelOperationRequest] = None, *, retry: Optional[Union[Retry, _MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

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:

request (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.

Returns:

None

static common_billing_account_path(billing_account: str) → str[source]¶: Returns a fully-qualified billing_account string.

static common_folder_path(folder: str) → str[source]¶: Returns a fully-qualified folder string.

static common_location_path(project: str, location: str) → str[source]¶: Returns a fully-qualified location string.

static common_organization_path(organization: str) → str[source]¶: Returns a fully-qualified organization string.

static common_project_path(project: str) → str[source]¶: Returns a fully-qualified project string.

create_index_endpoint(request: Optional[Union[CreateIndexEndpointRequest, dict]] = None, *, parent: Optional[str] = None, index_endpoint: Optional[IndexEndpoint] = None, retry: Optional[Union[Retry, _MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → Operation[source]¶

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_v1

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

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

    request = aiplatform_v1.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:

request (Union[google.cloud.aiplatform_v1.types.CreateIndexEndpointRequest, dict]) – The request object. Request message for [IndexEndpointService.CreateIndexEndpoint][google.cloud.aiplatform.v1.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_v1.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:

An object representing a long-running operation.

The result type for the operation will be google.cloud.aiplatform_v1.types.IndexEndpoint Indexes are deployed into it. An IndexEndpoint can have multiple: DeployedIndexes.

Return type:

delete_index_endpoint(request: Optional[Union[DeleteIndexEndpointRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[Retry, _MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → Operation[source]¶

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_v1

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

    # Initialize request argument(s)
    request = aiplatform_v1.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:

request (Union[google.cloud.aiplatform_v1.types.DeleteIndexEndpointRequest, dict]) – The request object. Request message for [IndexEndpointService.DeleteIndexEndpoint][google.cloud.aiplatform.v1.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:

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);

}

Return type:

delete_operation(request: Optional[DeleteOperationRequest] = None, *, retry: Optional[Union[Retry, _MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → None[source]¶

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:

request (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.

Returns:

None

deploy_index(request: Optional[Union[DeployIndexRequest, dict]] = None, *, index_endpoint: Optional[str] = None, deployed_index: Optional[DeployedIndex] = None, retry: Optional[Union[Retry, _MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → Operation[source]¶

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_v1

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

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

    request = aiplatform_v1.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:

request (Union[google.cloud.aiplatform_v1.types.DeployIndexRequest, dict]) – The request object. Request message for [IndexEndpointService.DeployIndex][google.cloud.aiplatform.v1.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_v1.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:

An object representing a long-running operation.

The result type for the operation will be google.cloud.aiplatform_v1.types.DeployIndexResponse Response message for: [IndexEndpointService.DeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.DeployIndex].

Return type:

IndexEndpointServiceClient

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶

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

Parameters:

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns:

The constructed client.

Return type:

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶

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

Parameters:

info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns:

The constructed client.

Return type:

IndexEndpointServiceClient

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

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

Parameters:

filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.

Returns:

The constructed client.

Return type:

IndexEndpointServiceClient

get_iam_policy(request: Optional[GetIamPolicyRequest] = None, *, retry: Optional[Union[Retry, _MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → Policy[source]¶

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:

request (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:

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.

Return type:

Policy

get_index_endpoint(request: Optional[Union[GetIndexEndpointRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[Retry, _MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → IndexEndpoint[source]¶

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_v1

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

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

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

    # Handle the response
    print(response)

Parameters:

request (Union[google.cloud.aiplatform_v1.types.GetIndexEndpointRequest, dict]) – The request object. Request message for [IndexEndpointService.GetIndexEndpoint][google.cloud.aiplatform.v1.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:

Indexes are deployed into it. An IndexEndpoint can have multiple DeployedIndexes.

Return type:

google.cloud.aiplatform_v1.services.index_endpoint_service.pagers.ListIndexEndpointsPager

get_location(request: Optional[GetLocationRequest] = None, *, retry: Optional[Union[Retry, _MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → Location[source]¶

Gets information about a location.

Parameters:

request (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:

Location object.

Return type:

Location

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[ClientOptions] = None)[source]¶

Deprecated. 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 variable 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.

Parameters:

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.

Returns:

returns the API endpoint and the: client cert source to use.

Return type:

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises:

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

get_operation(request: Optional[GetOperationRequest] = None, *, retry: Optional[Union[Retry, _MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → Operation[source]¶

Gets the latest state of a long-running operation.

Parameters:

request (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:

An Operation object.

Return type:

Operation

static index_endpoint_path(project: str, location: str, index_endpoint: str) → str[source]¶: Returns a fully-qualified index_endpoint string.

static index_path(project: str, location: str, index: str) → str[source]¶: Returns a fully-qualified index string.

list_index_endpoints(request: Optional[Union[ListIndexEndpointsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[Retry, _MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → ListIndexEndpointsPager[source]¶

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_v1

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

    # Initialize request argument(s)
    request = aiplatform_v1.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:

request (Union[google.cloud.aiplatform_v1.types.ListIndexEndpointsRequest, dict]) – The request object. Request message for [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1.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:

Response message for: [IndexEndpointService.ListIndexEndpoints][google.cloud.aiplatform.v1.IndexEndpointService.ListIndexEndpoints].

Iterating over this object will yield results and resolve additional pages automatically.

Return type:

list_locations(request: Optional[ListLocationsRequest] = None, *, retry: Optional[Union[Retry, _MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → ListLocationsResponse[source]¶

Lists information about the supported locations for this service.

Parameters:

request (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:

Response message for ListLocations method.

Return type:

ListLocationsResponse

list_operations(request: Optional[ListOperationsRequest] = None, *, retry: Optional[Union[Retry, _MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → ListOperationsResponse[source]¶

Lists operations that match the specified filter in the request.

Parameters:

request (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:

Response message for ListOperations method.

Return type:

ListOperationsResponse

mutate_deployed_index(request: Optional[Union[MutateDeployedIndexRequest, dict]] = None, *, index_endpoint: Optional[str] = None, deployed_index: Optional[DeployedIndex] = None, retry: Optional[Union[Retry, _MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → Operation[source]¶

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_v1

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

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

    request = aiplatform_v1.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:

request (Union[google.cloud.aiplatform_v1.types.MutateDeployedIndexRequest, dict]) – The request object. Request message for [IndexEndpointService.MutateDeployedIndex][google.cloud.aiplatform.v1.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_v1.types.DeployedIndex) –
Required. The DeployedIndex to be updated within the IndexEndpoint. Currently, the updatable fields are [DeployedIndex.automatic_resources][google.cloud.aiplatform.v1.DeployedIndex.automatic_resources] and [DeployedIndex.dedicated_resources][google.cloud.aiplatform.v1.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:

An object representing a long-running operation.

The result type for the operation will be google.cloud.aiplatform_v1.types.MutateDeployedIndexResponse Response message for: [IndexEndpointService.MutateDeployedIndex][google.cloud.aiplatform.v1.IndexEndpointService.MutateDeployedIndex].

Return type:

static parse_common_billing_account_path(path: str) → Dict[str, str][source]¶: Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str) → Dict[str, str][source]¶: Parse a folder path into its component segments.

static parse_common_location_path(path: str) → Dict[str, str][source]¶: Parse a location path into its component segments.

static parse_common_organization_path(path: str) → Dict[str, str][source]¶: Parse a organization path into its component segments.

static parse_common_project_path(path: str) → Dict[str, str][source]¶: Parse a project path into its component segments.

static parse_index_endpoint_path(path: str) → Dict[str, str][source]¶: Parses a index_endpoint path into its component segments.

static parse_index_path(path: str) → Dict[str, str][source]¶: Parses a index path into its component segments.

static parse_reservation_path(path: str) → Dict[str, str][source]¶: Parses a reservation path into its component segments.

static reservation_path(project_id_or_number: str, zone: str, reservation_name: str) → str[source]¶: Returns a fully-qualified reservation string.

set_iam_policy(request: Optional[SetIamPolicyRequest] = None, *, retry: Optional[Union[Retry, _MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → Policy[source]¶

Sets the IAM access control policy on the specified function.

Replaces any existing policy.

Parameters:

request (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:

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.

Return type:

Policy

test_iam_permissions(request: Optional[TestIamPermissionsRequest] = None, *, retry: Optional[Union[Retry, _MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → TestIamPermissionsResponse[source]¶

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:

request (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:

Response message for TestIamPermissions method.

Return type:

TestIamPermissionsResponse

property transport: IndexEndpointServiceTransport¶

Returns the transport used by the client instance.

Returns:

The transport used by the client: instance.

Return type:

IndexEndpointServiceTransport

undeploy_index(request: Optional[Union[UndeployIndexRequest, dict]] = None, *, index_endpoint: Optional[str] = None, deployed_index_id: Optional[str] = None, retry: Optional[Union[Retry, _MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → Operation[source]¶

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_v1

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

    # Initialize request argument(s)
    request = aiplatform_v1.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:

request (Union[google.cloud.aiplatform_v1.types.UndeployIndexRequest, dict]) – The request object. Request message for [IndexEndpointService.UndeployIndex][google.cloud.aiplatform.v1.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:

An object representing a long-running operation.

The result type for the operation will be google.cloud.aiplatform_v1.types.UndeployIndexResponse Response message for: [IndexEndpointService.UndeployIndex][google.cloud.aiplatform.v1.IndexEndpointService.UndeployIndex].

Return type:

property universe_domain: str¶

Return the universe domain used by the client instance.

Returns:: The universe domain used by the client instance.
Return type:: str

update_index_endpoint(request: Optional[Union[UpdateIndexEndpointRequest, dict]] = None, *, index_endpoint: Optional[IndexEndpoint] = None, update_mask: Optional[FieldMask] = None, retry: Optional[Union[Retry, _MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → IndexEndpoint[source]¶

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_v1

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

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

    request = aiplatform_v1.UpdateIndexEndpointRequest(
        index_endpoint=index_endpoint,
    )

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

    # Handle the response
    print(response)

Parameters:

request (Union[google.cloud.aiplatform_v1.types.UpdateIndexEndpointRequest, dict]) – The request object. Request message for [IndexEndpointService.UpdateIndexEndpoint][google.cloud.aiplatform.v1.IndexEndpointService.UpdateIndexEndpoint].
index_endpoint (google.cloud.aiplatform_v1.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:

Indexes are deployed into it. An IndexEndpoint can have multiple DeployedIndexes.

Return type: