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.
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. Resource name of the IndexEndpoint. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint_id}
↳ 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
↳ 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
↳ update_time
↳ 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}
string
setName
Output only. Resource name of the IndexEndpoint.
Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint_id}
var
string
$this
getDisplayName
Optional. Display name of the IndexEndpoint. Can be up to 32 characters long.
string
setDisplayName
Optional. Display name of the IndexEndpoint. Can be up to 32 characters long.
var
string
$this
getDescription
Optional. Description of the IndexEndpoint. Can be up to 25000 characters long.
string
setDescription
Optional. Description of the IndexEndpoint. Can be up to 25000 characters long.
var
string
$this
getDeployedIndex
Output only. The Index deployed in this IndexEndpoint.
hasDeployedIndex
clearDeployedIndex
setDeployedIndex
Output only. The Index deployed in this IndexEndpoint.
$this
getState
Output only. IndexEndpoint state.
setState
Output only. IndexEndpoint state.
$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.
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.
$this
getCreateTime
Output only. Create timestamp.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Create timestamp.
$this
getUpdateTime
Output only. Update timestamp.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Update timestamp.
$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.
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.
var
bool
$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.
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.
var
bool
$this
