Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1IndexEndpoint

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1/classes.rb,
lib/google/apis/aiplatform_v1/representations.rb,
lib/google/apis/aiplatform_v1/representations.rb

Overview

Indexes are deployed into it. An IndexEndpoint can have multiple DeployedIndexes.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1IndexEndpoint

Returns a new instance of GoogleCloudAiplatformV1IndexEndpoint.



7777
7778
7779
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 7777

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#create_time ⇒ String

Output only. Timestamp when this IndexEndpoint was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


7688
7689
7690
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 7688

def create_time
  @create_time
end

#deployed_indexes ⇒ Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DeployedIndex>

Output only. The indexes deployed in this endpoint. Corresponds to the JSON property deployedIndexes

Returns:



7693
7694
7695
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 7693

def deployed_indexes
  @deployed_indexes
end

#description ⇒ String

The description of the IndexEndpoint. Corresponds to the JSON property description

Returns:

  • (String) 


7698
7699
7700
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 7698

def description
  @description
end

#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. Corresponds to the JSON property displayName

Returns:

  • (String) 


7704
7705
7706
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 7704

def display_name
  @display_name
end

#enable_private_service_connect ⇒ Boolean Also known as: enable_private_service_connect?

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. Corresponds to the JSON property enablePrivateServiceConnect

Returns:

  • (Boolean) 


7711
7712
7713
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 7711

def enable_private_service_connect
  @enable_private_service_connect
end

#encryption_spec ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EncryptionSpec

Represents a customer-managed encryption key spec that can be applied to a top- level resource. Corresponds to the JSON property encryptionSpec

Returns:



7718
7719
7720
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 7718

def encryption_spec
  @encryption_spec
end

#etag ⇒ String

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

Returns:

  • (String) 


7724
7725
7726
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 7724

def etag
  @etag
end

#labels ⇒ Hash<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. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


7733
7734
7735
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 7733

def labels
  @labels
end

#name ⇒ String

Output only. The resource name of the IndexEndpoint. Corresponds to the JSON property name

Returns:

  • (String) 


7738
7739
7740
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 7738

def name
  @name
end

#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 projectis a project number, as in '12345', andnetworkis network name. Corresponds to the JSON propertynetwork`

Returns:

  • (String) 


7750
7751
7752
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 7750

def network
  @network
end

#private_service_connect_config ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PrivateServiceConnectConfig

Represents configuration for private service connect. Corresponds to the JSON property privateServiceConnectConfig

Returns:



7755
7756
7757
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 7755

def private_service_connect_config
  @private_service_connect_config
end

#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. Corresponds to the JSON property publicEndpointDomainName

Returns:

  • (String) 


7761
7762
7763
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 7761

def public_endpoint_domain_name
  @public_endpoint_domain_name
end

#public_endpoint_enabled ⇒ Boolean Also known as: public_endpoint_enabled?

Optional. If true, the deployed index will be accessible through public endpoint. Corresponds to the JSON property publicEndpointEnabled

Returns:

  • (Boolean) 


7767
7768
7769
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 7767

def public_endpoint_enabled
  @public_endpoint_enabled
end

#update_time ⇒ String

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. Corresponds to the JSON property updateTime

Returns:

  • (String) 


7775
7776
7777
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 7775

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 7782

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @deployed_indexes = args[:deployed_indexes] if args.key?(:deployed_indexes)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @enable_private_service_connect = args[:enable_private_service_connect] if args.key?(:enable_private_service_connect)
  @encryption_spec = args[:encryption_spec] if args.key?(:encryption_spec)
  @etag = args[:etag] if args.key?(:etag)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @network = args[:network] if args.key?(:network)
  @private_service_connect_config = args[:private_service_connect_config] if args.key?(:private_service_connect_config)
  @public_endpoint_domain_name = args[:public_endpoint_domain_name] if args.key?(:public_endpoint_domain_name)
  @public_endpoint_enabled = args[:public_endpoint_enabled] if args.key?(:public_endpoint_enabled)
  @update_time = args[:update_time] if args.key?(:update_time)
end