Reference documentation and code samples for the Google Cloud Vision Ai V1 Client class IndexEndpoint.
Message representing IndexEndpoint resource. Indexes are deployed into it.
Generated from protobuf message google.cloud.visionai.v1.IndexEndpoint
Namespace
Google \ Cloud \ VisionAI \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. Resource name of the IndexEndpoint. Format: |
↳ display_name |
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. |
↳ deployed_index |
DeployedIndex
Output only. The Index deployed in this IndexEndpoint. |
↳ state |
int
Output only. IndexEndpoint state. |
↳ labels |
array|Google\Protobuf\Internal\MapField
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. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Create timestamp. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. Update timestamp. |
↳ satisfies_pzs |
bool
Output only. This boolean field is only set for projects that have Physical Zone Separation enabled via an Org Policy constraint. It is set to true when the index endpoint is a valid zone separated index endpoint and false if it isn't. |
↳ satisfies_pzi |
bool
Output only. This boolean field is only set for projects that have Physical Zone Isolation enabled via an Org Policy constraint. It is set to true when the index endpoint is a valid zone isolated index endpoint and false if it isn't. |
getName
Output only. Resource name of the IndexEndpoint.
Format:
projects/{project}/locations/{location}/indexEndpoints/{index_endpoint_id}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Output only. Resource name of the IndexEndpoint.
Format:
projects/{project}/locations/{location}/indexEndpoints/{index_endpoint_id}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Optional. Display name of the IndexEndpoint. Can be up to 32 characters long.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Optional. Display name of the IndexEndpoint. Can be up to 32 characters long.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. Description of the IndexEndpoint. Can be up to 25000 characters long.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. Description of the IndexEndpoint. Can be up to 25000 characters long.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDeployedIndex
Output only. The Index deployed in this IndexEndpoint.
| Returns | |
|---|---|
| Type | Description |
DeployedIndex|null |
|
hasDeployedIndex
clearDeployedIndex
setDeployedIndex
Output only. The Index deployed in this IndexEndpoint.
| Parameter | |
|---|---|
| Name | Description |
var |
DeployedIndex
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. IndexEndpoint state.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type State. |
setState
Output only. IndexEndpoint state.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type State. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabels
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setLabels
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. Create timestamp.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. Create timestamp.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. Update timestamp.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Update timestamp.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSatisfiesPzs
Output only. This boolean field is only set for projects that have Physical Zone Separation enabled via an Org Policy constraint. It is set to true when the index endpoint is a valid zone separated index endpoint and false if it isn't.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasSatisfiesPzs
clearSatisfiesPzs
setSatisfiesPzs
Output only. This boolean field is only set for projects that have Physical Zone Separation enabled via an Org Policy constraint. It is set to true when the index endpoint is a valid zone separated index endpoint and false if it isn't.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSatisfiesPzi
Output only. This boolean field is only set for projects that have Physical Zone Isolation enabled via an Org Policy constraint. It is set to true when the index endpoint is a valid zone isolated index endpoint and false if it isn't.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasSatisfiesPzi
clearSatisfiesPzi
setSatisfiesPzi
Output only. This boolean field is only set for projects that have Physical Zone Isolation enabled via an Org Policy constraint. It is set to true when the index endpoint is a valid zone isolated index endpoint and false if it isn't.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|