Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Endpoint

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1beta1/classes.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb,
lib/google/apis/aiplatform_v1beta1/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) ⇒ GoogleCloudAiplatformV1beta1Endpoint

Returns a new instance of GoogleCloudAiplatformV1beta1Endpoint.



4432
4433
4434
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4432

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) 


4340
4341
4342
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4340

def create_time
  @create_time
end

#deployed_models ⇒ Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1DeployedModel>

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:



4347
4348
4349
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4347

def deployed_models
  @deployed_models
end

#description ⇒ String

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

Returns:

  • (String) 


4352
4353
4354
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4352

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) 


4358
4359
4360
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4358

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) 


4364
4365
4366
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4364

def enable_private_service_connect
  @enable_private_service_connect
end

#encryption_spec ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EncryptionSpec

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

Returns:



4371
4372
4373
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4371

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) 


4377
4378
4379
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4377

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


4386
4387
4388
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4386

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) 


4394
4395
4396
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4394

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) 


4399
4400
4401
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4399

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) 


4411
4412
4413
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4411

def network
  @network
end

#predict_request_response_logging_config ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PredictRequestResponseLoggingConfig

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

Returns:



4416
4417
4418
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4416

def predict_request_response_logging_config
  @predict_request_response_logging_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>) 


4425
4426
4427
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4425

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) 


4430
4431
4432
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4430

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 4437

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