Class: Google::Cloud::AIPlatform::V1::UndeployModelRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/endpoint_service.rb

Overview

Request message for EndpointService.UndeployModel.

Defined Under Namespace

Classes: TrafficSplitEntry

Instance Attribute Summary collapse

Instance Attribute Details

#deployed_model_id ⇒ ::String

Returns Required. The ID of the DeployedModel to be undeployed from the Endpoint.

Returns:

  • (::String) —

    Required. The ID of the DeployedModel to be undeployed from the Endpoint.



286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'proto_docs/google/cloud/aiplatform/v1/endpoint_service.rb', line 286

class UndeployModelRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Integer]
  class TrafficSplitEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#endpoint ⇒ ::String

Returns Required. The name of the Endpoint resource from which to undeploy a Model. Format: projects/{project}/locations/{location}/endpoints/{endpoint}.

Returns:

  • (::String) —

    Required. The name of the Endpoint resource from which to undeploy a Model. Format: projects/{project}/locations/{location}/endpoints/{endpoint}



286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'proto_docs/google/cloud/aiplatform/v1/endpoint_service.rb', line 286

class UndeployModelRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Integer]
  class TrafficSplitEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#traffic_split ⇒ ::Google::Protobuf::Map{::String => ::Integer}

Returns If this field is provided, then the Endpoint's traffic_split will be overwritten with it. If last DeployedModel is being undeployed from the Endpoint, the [Endpoint.traffic_split] will always end up empty when this call returns. A DeployedModel will be successfully undeployed only if it doesn't have any traffic assigned to it when this method executes, or if this field unassigns any traffic to it.

Returns:

  • (::Google::Protobuf::Map{::String => ::Integer}) —

    If this field is provided, then the Endpoint's traffic_split will be overwritten with it. If last DeployedModel is being undeployed from the Endpoint, the [Endpoint.traffic_split] will always end up empty when this call returns. A DeployedModel will be successfully undeployed only if it doesn't have any traffic assigned to it when this method executes, or if this field unassigns any traffic to it.



286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'proto_docs/google/cloud/aiplatform/v1/endpoint_service.rb', line 286

class UndeployModelRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Integer]
  class TrafficSplitEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end