Resource: IndexEndpoint
Message representing IndexEndpoint resource. ImageIndexes are deployed into it.
| JSON representation |
|---|
{ "name" : string , "displayName" : string , "description" : string , "deployedIndex" : { object ( |
name
string
Output only. Resource name of the IndexEndpoint. Format: projects/{project}/locations/{location}/indexEndpoints/{indexEndpointId}
displayName
string
Optional. Display name of the IndexEndpoint. Can be up to 32 characters long.
description
string
Optional. Description of the IndexEndpoint. Can be up to 25000 characters long.
deployedIndex
object (
DeployedIndex
)
Output only. The Index deployed in this IndexEndpoint.
state
enum (
State
)
Output only. IndexEndpoint state.
labels
map (key: string, value: string)
Optional. The labels applied to a resource must meet the following requirements:
- Each resource can have multiple labels, up to a maximum of 64.
- Each label must be a key-value pair.
- Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
- Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
- The key portion of a label must be unique. However, you can use the same key with multiple resources.
- Keys must start with a lowercase letter or international character.
See Google Cloud Document for more details.
An object containing a list of "key": value
pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }
.
createTime
string (
Timestamp
format)
Output only. Create timestamp.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z"
and "2014-10-02T15:01:23.045123456Z"
.
updateTime
string (
Timestamp
format)
Output only. Update timestamp.
A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z"
and "2014-10-02T15:01:23.045123456Z"
.
DeployedIndex
A deployment of an Index.
| JSON representation |
|---|
{ "index" : string } |
| Fields | |
|---|---|
index
|
Required. Name of the deployed Index. Format: |
State
IndexEndpoint stage.
| Enums | |
|---|---|
STATE_UNSPECIFIED
|
The default value. Should not be used. |
CREATING
|
State CREATING. |
CREATED
|
State CREATED. |
UPDATING
|
State UPDATING. |
FAILED
|
State FAILED. |
Methods |
|
|---|---|
|
Creates an IndexEndpoint. |
|
Deletes an IndexEndpoint. |
|
Deploys an Index to IndexEndpoint. |
|
Gets an IndexEndpoint. |
|
Lists all IndexEndpoints in a project. |
|
Updates an IndexEndpoint. |
|
Search a deployed index endpoint (IMAGE corpus type only). |
|
Undeploys an Index from IndexEndpoint. |
