- 1.35.0 (latest)
- 1.34.0
- 1.33.0
- 1.32.1
- 1.31.0
- 1.30.0
- 1.26.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.1
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.0
- 1.0.0
- 0.39.0
- 0.38.0
- 0.37.1
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.2
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.13.0
- 0.12.0
- 0.11.1
- 0.10.0
Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class IndexEndpoint.
Indexes are deployed into it. An IndexEndpoint can have multiple DeployedIndexes.
Generated from protobuf message google.cloud.aiplatform.v1.IndexEndpoint
Namespace
Google \ Cloud \ AIPlatform \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. The resource name of the IndexEndpoint.
↳ display_name
string
Required. The display name of the IndexEndpoint. The name can be up to 128 characters long and can consist of any UTF-8 characters.
↳ description
string
The description of the IndexEndpoint.
↳ deployed_indexes
array< Google\Cloud\AIPlatform\V1\DeployedIndex
>
Output only. The indexes deployed in this endpoint.
↳ etag
string
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
↳ labels
array| Google\Protobuf\Internal\MapField
The labels with user-defined metadata to organize your IndexEndpoints. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
↳ create_time
↳ update_time
Google\Protobuf\Timestamp
Output only. Timestamp when this IndexEndpoint was last updated. This timestamp is not updated when the endpoint's DeployedIndexes are updated, e.g. due to updates of the original Indexes they are the deployments of.
↳ network
string
Optional. The full name of the Google Compute Engine network
to which the IndexEndpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. network
and private_service_connect_config
are mutually exclusive. Format
: projects/{project}/global/networks/{network}
. Where {project} is a project number, as in '12345', and {network} is network name.
↳ enable_private_service_connect
bool
Optional. Deprecated: If true, expose the IndexEndpoint via private service connect. Only one of the fields, network or enable_private_service_connect , can be set.
↳ private_service_connect_config
Google\Cloud\AIPlatform\V1\PrivateServiceConnectConfig
Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive.
↳ public_endpoint_enabled
bool
Optional. If true, the deployed index will be accessible through public endpoint.
↳ public_endpoint_domain_name
string
Output only. If public_endpoint_enabled is true, this field will be populated with the domain name to use for this index endpoint.
↳ encryption_spec
Google\Cloud\AIPlatform\V1\EncryptionSpec
Immutable. Customer-managed encryption key spec for an IndexEndpoint. If set, this IndexEndpoint and all sub-resources of this IndexEndpoint will be secured by this key.
↳ satisfies_pzs
bool
Output only. Reserved for future use.
↳ satisfies_pzi
bool
Output only. Reserved for future use.
getName
Output only. The resource name of the IndexEndpoint.
string
setName
Output only. The resource name of the IndexEndpoint.
var
string
$this
getDisplayName
Required. The display name of the IndexEndpoint.
The name can be up to 128 characters long and can consist of any UTF-8 characters.
string
setDisplayName
Required. The display name of the IndexEndpoint.
The name can be up to 128 characters long and can consist of any UTF-8 characters.
var
string
$this
getDescription
The description of the IndexEndpoint.
string
setDescription
The description of the IndexEndpoint.
var
string
$this
getDeployedIndexes
Output only. The indexes deployed in this endpoint.
setDeployedIndexes
Output only. The indexes deployed in this endpoint.
$this
getEtag
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
string
setEtag
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
var
string
$this
getLabels
The labels with user-defined metadata to organize your IndexEndpoints.
Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
setLabels
The labels with user-defined metadata to organize your IndexEndpoints.
Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
$this
getCreateTime
Output only. Timestamp when this IndexEndpoint was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp when this IndexEndpoint was created.
$this
getUpdateTime
Output only. Timestamp when this IndexEndpoint was last updated.
This timestamp is not updated when the endpoint's DeployedIndexes are updated, e.g. due to updates of the original Indexes they are the deployments of.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Timestamp when this IndexEndpoint was last updated.
This timestamp is not updated when the endpoint's DeployedIndexes are updated, e.g. due to updates of the original Indexes they are the deployments of.
$this
getNetwork
Optional. The full name of the Google Compute Engine network to which the IndexEndpoint should be peered.
Private services access must already be configured for the network. If left
unspecified, the Endpoint is not peered with any network. network
and private_service_connect_config
are mutually exclusive. Format
: projects/{project}/global/networks/{network}
.
Where {project} is a project number, as in '12345', and {network} is
network name.
string
setNetwork
Optional. The full name of the Google Compute Engine network to which the IndexEndpoint should be peered.
Private services access must already be configured for the network. If left
unspecified, the Endpoint is not peered with any network. network
and private_service_connect_config
are mutually exclusive. Format
: projects/{project}/global/networks/{network}
.
Where {project} is a project number, as in '12345', and {network} is
network name.
var
string
$this
getEnablePrivateServiceConnect
Optional. Deprecated: If true, expose the IndexEndpoint via private service connect.
Only one of the fields, network or enable_private_service_connect , can be set.
bool
setEnablePrivateServiceConnect
Optional. Deprecated: If true, expose the IndexEndpoint via private service connect.
Only one of the fields, network or enable_private_service_connect , can be set.
var
bool
$this
getPrivateServiceConnectConfig
Optional. Configuration for private service connect.
network and private_service_connect_config are mutually exclusive.
hasPrivateServiceConnectConfig
clearPrivateServiceConnectConfig
setPrivateServiceConnectConfig
Optional. Configuration for private service connect.
network and private_service_connect_config are mutually exclusive.
$this
getPublicEndpointEnabled
Optional. If true, the deployed index will be accessible through public endpoint.
bool
setPublicEndpointEnabled
Optional. If true, the deployed index will be accessible through public endpoint.
var
bool
$this
getPublicEndpointDomainName
Output only. If public_endpoint_enabled is true, this field will be populated with the domain name to use for this index endpoint.
string
setPublicEndpointDomainName
Output only. If public_endpoint_enabled is true, this field will be populated with the domain name to use for this index endpoint.
var
string
$this
getEncryptionSpec
Immutable. Customer-managed encryption key spec for an IndexEndpoint. If set, this IndexEndpoint and all sub-resources of this IndexEndpoint will be secured by this key.
hasEncryptionSpec
clearEncryptionSpec
setEncryptionSpec
Immutable. Customer-managed encryption key spec for an IndexEndpoint. If set, this IndexEndpoint and all sub-resources of this IndexEndpoint will be secured by this key.
$this
getSatisfiesPzs
Output only. Reserved for future use.
bool
setSatisfiesPzs
Output only. Reserved for future use.
var
bool
$this
getSatisfiesPzi
Output only. Reserved for future use.
bool
setSatisfiesPzi
Output only. Reserved for future use.
var
bool
$this
