Method: googleapis.aiplatform.v1.projects.locations.indexEndpoints.patch

Updates an IndexEndpoint.

Arguments

Parameters
`name`	`string` Required. Output only. The resource name of the IndexEndpoint.
`updateMask`	`string (FieldMask format)` Required. The update mask applies to the resource. See google.protobuf.FieldMask.
`region`	`string` Required. Region of the HTTP endpoint. For example, if region is set to `us-central1`, the endpoint https://us-central1-integrations.googleapis.com will be used. See service endpoints.
`body`	`object (GoogleCloudAiplatformV1IndexEndpoint)` Required.

Raised exceptions

Exceptions
`ConnectionError`	In case of a network problem (such as DNS failure or refused connection).
`HttpError`	If the response status is >= 400 (excluding 429 and 503).
`TimeoutError`	If a long-running operation takes longer to finish than the specified timeout limit.
`TypeError`	If an operation or function receives an argument of the wrong type.
`ValueError`	If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of GoogleCloudAiplatformV1IndexEndpoint.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- patch:
    call: googleapis.aiplatform.v1.projects.locations.indexEndpoints.patch
    args:
        name: ...
        updateMask: ...
        region: ...
        body:
            description: ...
            displayName: ...
            enablePrivateServiceConnect: ...
            encryptionSpec:
                kmsKeyName: ...
            etag: ...
            labels: ...
            network: ...
            privateServiceConnectConfig:
                enablePrivateServiceConnect: ...
                projectAllowlist: ...
            publicEndpointEnabled: ...
    result: patchResult

JSON

[
  {
    "patch": {
      "call": "googleapis.aiplatform.v1.projects.locations.indexEndpoints.patch",
      "args": {
        "name": "...",
        "updateMask": "...",
        "region": "...",
        "body": {
          "description": "...",
          "displayName": "...",
          "enablePrivateServiceConnect": "...",
          "encryptionSpec": {
            "kmsKeyName": "..."
          },
          "etag": "...",
          "labels": "...",
          "network": "...",
          "privateServiceConnectConfig": {
            "enablePrivateServiceConnect": "...",
            "projectAllowlist": "..."
          },
          "publicEndpointEnabled": "..."
        }
      },
      "result": "patchResult"
    }
  }
]