Google Cloud Ai Platform V1 Client - Class OutputConfig (0.38.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class OutputConfig.

Output configuration for the Model export.

Generated from protobuf message google.cloud.aiplatform.v1.ExportModelRequest.OutputConfig

Namespace

Google \ Cloud \ AIPlatform \ V1 \ ExportModelRequest

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ export_format_id string

The ID of the format in which the Model must be exported. Each Model lists the export formats it supports. If no value is provided here, then the first from the list of the Model's supported formats is used by default.

↳ artifact_destination Google\Cloud\AIPlatform\V1\GcsDestination

The Cloud Storage location where the Model artifact is to be written to. Under the directory given as the destination a new one with name "model-export-<model-display-name>-<timestamp-of-export-call>", where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format, will be created. Inside, the Model and any of its supporting files will be written. This field should only be set when the exportableContent field of the [Model.supported_export_formats] object contains ARTIFACT.

↳ image_destination Google\Cloud\AIPlatform\V1\ContainerRegistryDestination

The Google Container Registry or Artifact Registry uri where the Model container image will be copied to. This field should only be set when the exportableContent field of the [Model.supported_export_formats] object contains IMAGE.

getExportFormatId

The ID of the format in which the Model must be exported. Each Model lists the export formats it supports. If no value is provided here, then the first from the list of the Model's supported formats is used by default.

Returns
Type Description
string

setExportFormatId

The ID of the format in which the Model must be exported. Each Model lists the export formats it supports. If no value is provided here, then the first from the list of the Model's supported formats is used by default.

Parameter
Name Description
var string
Returns
Type Description
$this

getArtifactDestination

The Cloud Storage location where the Model artifact is to be written to. Under the directory given as the destination a new one with name "model-export-<model-display-name>-<timestamp-of-export-call>", where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format, will be created. Inside, the Model and any of its supporting files will be written.

This field should only be set when the exportableContent field of the [Model.supported_export_formats] object contains ARTIFACT.

Returns
Type Description
Google\Cloud\AIPlatform\V1\GcsDestination|null

hasArtifactDestination

clearArtifactDestination

setArtifactDestination

The Cloud Storage location where the Model artifact is to be written to. Under the directory given as the destination a new one with name "model-export-<model-display-name>-<timestamp-of-export-call>", where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format, will be created. Inside, the Model and any of its supporting files will be written.

This field should only be set when the exportableContent field of the [Model.supported_export_formats] object contains ARTIFACT.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\GcsDestination
Returns
Type Description
$this

getImageDestination

The Google Container Registry or Artifact Registry uri where the Model container image will be copied to.

This field should only be set when the exportableContent field of the [Model.supported_export_formats] object contains IMAGE.

Returns
Type Description
Google\Cloud\AIPlatform\V1\ContainerRegistryDestination|null

hasImageDestination

clearImageDestination

setImageDestination

The Google Container Registry or Artifact Registry uri where the Model container image will be copied to.

This field should only be set when the exportableContent field of the [Model.supported_export_formats] object contains IMAGE.

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\ContainerRegistryDestination
Returns
Type Description
$this