Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Endpoint

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

Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1Endpoint

Returns a new instance of GoogleCloudAiplatformV1Endpoint.



5532
5533
5534
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 5532

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

Instance Attribute Details

#create_time ⇒ String

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

Returns:

  • (String) 


5435
5436
5437
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 5435

def create_time
  @create_time
end

#deployed_models ⇒ Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DeployedModel>

Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService. UndeployModel respectively. Corresponds to the JSON property deployedModels

Returns:



5442
5443
5444
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 5442

def deployed_models
  @deployed_models
end

#description ⇒ String

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

Returns:

  • (String) 


5447
5448
5449
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 5447

def description
  @description
end

#display_name ⇒ String

Required. The display name of the Endpoint. 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) 


5453
5454
5455
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 5453

def display_name
  @display_name
end

#enable_private_service_connect ⇒ Boolean Also known as: enable_private_service_connect?

Deprecated: If true, expose the Endpoint 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) 


5459
5460
5461
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 5459

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:



5466
5467
5468
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 5466

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) 


5472
5473
5474
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 5472

def etag
  @etag
end

#labels ⇒ Hash<String,String>

The labels with user-defined metadata to organize your Endpoints. 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>) 


5481
5482
5483
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 5481

def labels
  @labels
end

#model_deployment_monitoring_job ⇒ String

Output only. Resource name of the Model Monitoring job associated with this Endpoint if monitoring is enabled by JobService. CreateModelDeploymentMonitoringJob. Format: projects/project/locations/ location/modelDeploymentMonitoringJobs/model_deployment_monitoring_job` Corresponds to the JSON propertymodelDeploymentMonitoringJob`

Returns:

  • (String) 


5489
5490
5491
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 5489

def model_deployment_monitoring_job
  @model_deployment_monitoring_job
end

#name ⇒ String

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

Returns:

  • (String) 


5494
5495
5496
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 5494

def name
  @name
end

#network ⇒ String

Optional. The full name of the Google Compute Engine network to which the Endpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. Only one of the fields, network or enable_private_service_connect, can be set. Format: projects/project/global/networks/network. Where projectis a project number, as in `12345`, andnetwork`is network name. Corresponds to the JSON propertynetwork`

Returns:

  • (String) 


5506
5507
5508
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 5506

def network
  @network
end

#predict_request_response_logging_config ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PredictRequestResponseLoggingConfig

Configuration for logging request-response to a BigQuery table. Corresponds to the JSON property predictRequestResponseLoggingConfig

Returns:



5511
5512
5513
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 5511

def predict_request_response_logging_config
  @predict_request_response_logging_config
end

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

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

Returns:



5516
5517
5518
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 5516

def private_service_connect_config
  @private_service_connect_config
end

#traffic_split ⇒ Hash<String,Fixnum>

A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment. Corresponds to the JSON property trafficSplit

Returns:

  • (Hash<String,Fixnum>) 


5525
5526
5527
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 5525

def traffic_split
  @traffic_split
end

#update_time ⇒ String

Output only. Timestamp when this Endpoint was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


5530
5531
5532
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 5530

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 5537

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @deployed_models = args[:deployed_models] if args.key?(:deployed_models)
  @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)
  @model_deployment_monitoring_job = args[:model_deployment_monitoring_job] if args.key?(:model_deployment_monitoring_job)
  @name = args[:name] if args.key?(:name)
  @network = args[:network] if args.key?(:network)
  @predict_request_response_logging_config = args[:predict_request_response_logging_config] if args.key?(:predict_request_response_logging_config)
  @private_service_connect_config = args[:private_service_connect_config] if args.key?(:private_service_connect_config)
  @traffic_split = args[:traffic_split] if args.key?(:traffic_split)
  @update_time = args[:update_time] if args.key?(:update_time)
end