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.



14556
14557
14558
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 14556

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) 


14455
14456
14457
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 14455

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:



14460
14461
14462
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 14460

def deployed_indexes
  @deployed_indexes
end

#description ⇒ String

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

Returns:

  • (String) 


14465
14466
14467
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 14465

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) 


14471
14472
14473
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 14471

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) 


14478
14479
14480
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 14478

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:



14485
14486
14487
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 14485

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) 


14491
14492
14493
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 14491

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>) 


14500
14501
14502
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 14500

def labels
  @labels
end

#name ⇒ String

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

Returns:

  • (String) 


14505
14506
14507
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 14505

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) 


14517
14518
14519
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 14517

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:



14522
14523
14524
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 14522

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) 


14528
14529
14530
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 14528

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) 


14534
14535
14536
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 14534

def public_endpoint_enabled
  @public_endpoint_enabled
end

#satisfies_pzi ⇒ Boolean Also known as: satisfies_pzi?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzi

Returns:

  • (Boolean) 


14540
14541
14542
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 14540

def satisfies_pzi
  @satisfies_pzi
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


14546
14547
14548
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 14546

def satisfies_pzs
  @satisfies_pzs
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) 


14554
14555
14556
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 14554

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



14561
14562
14563
14564
14565
14566
14567
14568
14569
14570
14571
14572
14573
14574
14575
14576
14577
14578
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 14561

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)
  @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @update_time = args[:update_time] if args.key?(:update_time)
end