Class: Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::Deploy

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

Overview

Model metadata that is needed for UploadModel or DeployModel/CreateEndpoint requests.

Defined Under Namespace

Classes: DeployMetadata

Instance Attribute Summary collapse

Instance Attribute Details

#artifact_uri ⇒ ::String

Returns Optional. The path to the directory containing the Model artifact and any of its supporting files.

Returns:

  • (::String) —

    Optional. The path to the directory containing the Model artifact and any of its supporting files.



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'proto_docs/google/cloud/aiplatform/v1/publisher_model.rb', line 259

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

  # Metadata information about the deployment for managing deployment
  # config.
  # @!attribute [rw] labels
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Optional. Labels for the deployment. For managing deployment config
  #     like verifying, source of deployment config, etc.
  # @!attribute [rw] sample_request
  #   @return [::String]
  #     Optional. Sample request for deployed endpoint.
  class DeployMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

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

#automatic_resources ⇒ ::Google::Cloud::AIPlatform::V1::AutomaticResources

Returns A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.

Note: The following fields are mutually exclusive: automatic_resources, dedicated_resources, shared_resources. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::AIPlatform::V1::AutomaticResources) —

    A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.

    Note: The following fields are mutually exclusive: automatic_resources, dedicated_resources, shared_resources. If a field in that set is populated, all other fields in the set will automatically be cleared.



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'proto_docs/google/cloud/aiplatform/v1/publisher_model.rb', line 259

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

  # Metadata information about the deployment for managing deployment
  # config.
  # @!attribute [rw] labels
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Optional. Labels for the deployment. For managing deployment config
  #     like verifying, source of deployment config, etc.
  # @!attribute [rw] sample_request
  #   @return [::String]
  #     Optional. Sample request for deployed endpoint.
  class DeployMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

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

#container_spec ⇒ ::Google::Cloud::AIPlatform::V1::ModelContainerSpec

Returns Optional. The specification of the container that is to be used when deploying this Model in Vertex AI. Not present for Large Models.

Returns:



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'proto_docs/google/cloud/aiplatform/v1/publisher_model.rb', line 259

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

  # Metadata information about the deployment for managing deployment
  # config.
  # @!attribute [rw] labels
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Optional. Labels for the deployment. For managing deployment config
  #     like verifying, source of deployment config, etc.
  # @!attribute [rw] sample_request
  #   @return [::String]
  #     Optional. Sample request for deployed endpoint.
  class DeployMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

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

#dedicated_resources ⇒ ::Google::Cloud::AIPlatform::V1::DedicatedResources

Returns A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration.

Note: The following fields are mutually exclusive: dedicated_resources, automatic_resources, shared_resources. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::AIPlatform::V1::DedicatedResources) —

    A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration.

    Note: The following fields are mutually exclusive: dedicated_resources, automatic_resources, shared_resources. If a field in that set is populated, all other fields in the set will automatically be cleared.



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'proto_docs/google/cloud/aiplatform/v1/publisher_model.rb', line 259

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

  # Metadata information about the deployment for managing deployment
  # config.
  # @!attribute [rw] labels
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Optional. Labels for the deployment. For managing deployment config
  #     like verifying, source of deployment config, etc.
  # @!attribute [rw] sample_request
  #   @return [::String]
  #     Optional. Sample request for deployed endpoint.
  class DeployMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

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

#deploy_metadata ⇒ ::Google::Cloud::AIPlatform::V1::PublisherModel::CallToAction::Deploy::DeployMetadata

Returns Optional. Metadata information about this deployment config.

Returns:



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'proto_docs/google/cloud/aiplatform/v1/publisher_model.rb', line 259

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

  # Metadata information about the deployment for managing deployment
  # config.
  # @!attribute [rw] labels
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Optional. Labels for the deployment. For managing deployment config
  #     like verifying, source of deployment config, etc.
  # @!attribute [rw] sample_request
  #   @return [::String]
  #     Optional. Sample request for deployed endpoint.
  class DeployMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

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

#deploy_task_name ⇒ ::String

Returns Optional. The name of the deploy task (e.g., "text to image generation").

Returns:

  • (::String) —

    Optional. The name of the deploy task (e.g., "text to image generation").



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'proto_docs/google/cloud/aiplatform/v1/publisher_model.rb', line 259

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

  # Metadata information about the deployment for managing deployment
  # config.
  # @!attribute [rw] labels
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Optional. Labels for the deployment. For managing deployment config
  #     like verifying, source of deployment config, etc.
  # @!attribute [rw] sample_request
  #   @return [::String]
  #     Optional. Sample request for deployed endpoint.
  class DeployMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

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

#large_model_reference ⇒ ::Google::Cloud::AIPlatform::V1::LargeModelReference

Returns Optional. Large model reference. When this is set, model_artifact_spec is not needed.

Returns:



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'proto_docs/google/cloud/aiplatform/v1/publisher_model.rb', line 259

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

  # Metadata information about the deployment for managing deployment
  # config.
  # @!attribute [rw] labels
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Optional. Labels for the deployment. For managing deployment config
  #     like verifying, source of deployment config, etc.
  # @!attribute [rw] sample_request
  #   @return [::String]
  #     Optional. Sample request for deployed endpoint.
  class DeployMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

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

#model_display_name ⇒ ::String

Returns Optional. Default model display name.

Returns:

  • (::String) —

    Optional. Default model display name.



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'proto_docs/google/cloud/aiplatform/v1/publisher_model.rb', line 259

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

  # Metadata information about the deployment for managing deployment
  # config.
  # @!attribute [rw] labels
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Optional. Labels for the deployment. For managing deployment config
  #     like verifying, source of deployment config, etc.
  # @!attribute [rw] sample_request
  #   @return [::String]
  #     Optional. Sample request for deployed endpoint.
  class DeployMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

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

#public_artifact_uri ⇒ ::String

Returns Optional. The signed URI for ephemeral Cloud Storage access to model artifact.

Returns:

  • (::String) —

    Optional. The signed URI for ephemeral Cloud Storage access to model artifact.



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'proto_docs/google/cloud/aiplatform/v1/publisher_model.rb', line 259

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

  # Metadata information about the deployment for managing deployment
  # config.
  # @!attribute [rw] labels
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Optional. Labels for the deployment. For managing deployment config
  #     like verifying, source of deployment config, etc.
  # @!attribute [rw] sample_request
  #   @return [::String]
  #     Optional. Sample request for deployed endpoint.
  class DeployMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

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

#shared_resources ⇒ ::String

Returns The resource name of the shared DeploymentResourcePool to deploy on. Format: projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}

Note: The following fields are mutually exclusive: shared_resources, dedicated_resources, automatic_resources. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::String) —

    The resource name of the shared DeploymentResourcePool to deploy on. Format: projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}

    Note: The following fields are mutually exclusive: shared_resources, dedicated_resources, automatic_resources. If a field in that set is populated, all other fields in the set will automatically be cleared.



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'proto_docs/google/cloud/aiplatform/v1/publisher_model.rb', line 259

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

  # Metadata information about the deployment for managing deployment
  # config.
  # @!attribute [rw] labels
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Optional. Labels for the deployment. For managing deployment config
  #     like verifying, source of deployment config, etc.
  # @!attribute [rw] sample_request
  #   @return [::String]
  #     Optional. Sample request for deployed endpoint.
  class DeployMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

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

#title ⇒ ::String

Returns Required. The title of the regional resource reference.

Returns:

  • (::String) —

    Required. The title of the regional resource reference.



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'proto_docs/google/cloud/aiplatform/v1/publisher_model.rb', line 259

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

  # Metadata information about the deployment for managing deployment
  # config.
  # @!attribute [rw] labels
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Optional. Labels for the deployment. For managing deployment config
  #     like verifying, source of deployment config, etc.
  # @!attribute [rw] sample_request
  #   @return [::String]
  #     Optional. Sample request for deployed endpoint.
  class DeployMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

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