IndexEndpoint class

Creates an IndexEndpoint. Auto-naming is currently not supported for this resource.

Constructors

IndexEndpoint(String name, {IndexEndpointArgs? args, CustomResourceOptions? options})

Creates a new IndexEndpoint. name The Pulumi resource name. args Arguments used to configure this IndexEndpoint. The set of arguments for IndexEndpoint. options Resource options controlling this resource's behavior.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

Timestamp when this IndexEndpoint was created.

late, final

deployedIndexes ↔ Output<List<Map<String, dynamic>>>

The indexes deployed in this endpoint.

late, final

description ↔ Output<String>

The description of the IndexEndpoint.

late, final

displayName ↔ Output<String>

The display name of the IndexEndpoint. The name can be up to 128 characters long and can consist of any UTF-8 characters.

late, final

enablePrivateServiceConnect ↔ Output<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.

late, final

encryptionSpec ↔ Output<GoogleCloudAiplatformV1EncryptionSpecResponse>

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.

late, final

etag ↔ Output<String>

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

labels ↔ Output<Map<String, String>>

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.

late, final

location ↔ Output<String>

late, final

name ↔ Output<String>

The resource name of the IndexEndpoint.

late, final

network ↔ Output<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.

late, final

privateServiceConnectConfig ↔ Output<GoogleCloudAiplatformV1PrivateServiceConnectConfigResponse>

Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive.

late, final

project ↔ Output<String>

late, final

publicEndpointDomainName ↔ Output<String>

If public_endpoint_enabled is true, this field will be populated with the domain name to use for this index endpoint.

late, final

publicEndpointEnabled ↔ Output<bool>

Optional. If true, the deployed index will be accessible through public endpoint.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

updateTime ↔ Output<String>

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.

late, final

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited