Class ExportModelRequest.OutputConfig.Builder (3.44.0)

public static final class ExportModelRequest.OutputConfig.Builder extends GeneratedMessageV3.Builder<ExportModelRequest.OutputConfig.Builder> implements ExportModelRequest.OutputConfigOrBuilder

Output configuration for the Model export.

Protobuf type google.cloud.aiplatform.v1.ExportModelRequest.OutputConfig

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ExportModelRequest.OutputConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ExportModelRequest.OutputConfig.Builder
Overrides

build()

public ExportModelRequest.OutputConfig build()
Returns
Type Description
ExportModelRequest.OutputConfig

buildPartial()

public ExportModelRequest.OutputConfig buildPartial()
Returns
Type Description
ExportModelRequest.OutputConfig

clear()

public ExportModelRequest.OutputConfig.Builder clear()
Returns
Type Description
ExportModelRequest.OutputConfig.Builder
Overrides

clearArtifactDestination()

public ExportModelRequest.OutputConfig.Builder clearArtifactDestination()

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.

.google.cloud.aiplatform.v1.GcsDestination artifact_destination = 3;

Returns
Type Description
ExportModelRequest.OutputConfig.Builder

clearExportFormatId()

public ExportModelRequest.OutputConfig.Builder clearExportFormatId()

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.

string export_format_id = 1;

Returns
Type Description
ExportModelRequest.OutputConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ExportModelRequest.OutputConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ExportModelRequest.OutputConfig.Builder
Overrides

clearImageDestination()

public ExportModelRequest.OutputConfig.Builder clearImageDestination()

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.

.google.cloud.aiplatform.v1.ContainerRegistryDestination image_destination = 4;

Returns
Type Description
ExportModelRequest.OutputConfig.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public ExportModelRequest.OutputConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ExportModelRequest.OutputConfig.Builder
Overrides

clone()

public ExportModelRequest.OutputConfig.Builder clone()
Returns
Type Description
ExportModelRequest.OutputConfig.Builder
Overrides

getArtifactDestination()

public GcsDestination 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.

.google.cloud.aiplatform.v1.GcsDestination artifact_destination = 3;

Returns
Type Description
GcsDestination

The artifactDestination.

getArtifactDestinationBuilder()

public GcsDestination.Builder getArtifactDestinationBuilder()

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.

.google.cloud.aiplatform.v1.GcsDestination artifact_destination = 3;

Returns
Type Description
GcsDestination.Builder

getArtifactDestinationOrBuilder()

public GcsDestinationOrBuilder getArtifactDestinationOrBuilder()

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.

.google.cloud.aiplatform.v1.GcsDestination artifact_destination = 3;

Returns
Type Description
GcsDestinationOrBuilder

getDefaultInstanceForType()

public ExportModelRequest.OutputConfig getDefaultInstanceForType()
Returns
Type Description
ExportModelRequest.OutputConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getExportFormatId()

public String 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.

string export_format_id = 1;

Returns
Type Description
String

The exportFormatId.

getExportFormatIdBytes()

public ByteString getExportFormatIdBytes()

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.

string export_format_id = 1;

Returns
Type Description
ByteString

The bytes for exportFormatId.

getImageDestination()

public ContainerRegistryDestination 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.

.google.cloud.aiplatform.v1.ContainerRegistryDestination image_destination = 4;

Returns
Type Description
ContainerRegistryDestination

The imageDestination.

getImageDestinationBuilder()

public ContainerRegistryDestination.Builder getImageDestinationBuilder()

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.

.google.cloud.aiplatform.v1.ContainerRegistryDestination image_destination = 4;

Returns
Type Description
ContainerRegistryDestination.Builder

getImageDestinationOrBuilder()

public ContainerRegistryDestinationOrBuilder getImageDestinationOrBuilder()

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.

.google.cloud.aiplatform.v1.ContainerRegistryDestination image_destination = 4;

Returns
Type Description
ContainerRegistryDestinationOrBuilder

hasArtifactDestination()

public boolean hasArtifactDestination()

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.

.google.cloud.aiplatform.v1.GcsDestination artifact_destination = 3;

Returns
Type Description
boolean

Whether the artifactDestination field is set.

hasImageDestination()

public boolean hasImageDestination()

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.

.google.cloud.aiplatform.v1.ContainerRegistryDestination image_destination = 4;

Returns
Type Description
boolean

Whether the imageDestination field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeArtifactDestination(GcsDestination value)

public ExportModelRequest.OutputConfig.Builder mergeArtifactDestination(GcsDestination value)

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.

.google.cloud.aiplatform.v1.GcsDestination artifact_destination = 3;

Parameter
Name Description
value GcsDestination
Returns
Type Description
ExportModelRequest.OutputConfig.Builder

mergeFrom(ExportModelRequest.OutputConfig other)

public ExportModelRequest.OutputConfig.Builder mergeFrom(ExportModelRequest.OutputConfig other)
Parameter
Name Description
other ExportModelRequest.OutputConfig
Returns
Type Description
ExportModelRequest.OutputConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ExportModelRequest.OutputConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportModelRequest.OutputConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ExportModelRequest.OutputConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ExportModelRequest.OutputConfig.Builder
Overrides

mergeImageDestination(ContainerRegistryDestination value)

public ExportModelRequest.OutputConfig.Builder mergeImageDestination(ContainerRegistryDestination value)

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.

.google.cloud.aiplatform.v1.ContainerRegistryDestination image_destination = 4;

Parameter
Name Description
value ContainerRegistryDestination
Returns
Type Description
ExportModelRequest.OutputConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ExportModelRequest.OutputConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ExportModelRequest.OutputConfig.Builder
Overrides

setArtifactDestination(GcsDestination value)

public ExportModelRequest.OutputConfig.Builder setArtifactDestination(GcsDestination value)

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.

.google.cloud.aiplatform.v1.GcsDestination artifact_destination = 3;

Parameter
Name Description
value GcsDestination
Returns
Type Description
ExportModelRequest.OutputConfig.Builder

setArtifactDestination(GcsDestination.Builder builderForValue)

public ExportModelRequest.OutputConfig.Builder setArtifactDestination(GcsDestination.Builder builderForValue)

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.

.google.cloud.aiplatform.v1.GcsDestination artifact_destination = 3;

Parameter
Name Description
builderForValue GcsDestination.Builder
Returns
Type Description
ExportModelRequest.OutputConfig.Builder

setExportFormatId(String value)

public ExportModelRequest.OutputConfig.Builder setExportFormatId(String value)

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.

string export_format_id = 1;

Parameter
Name Description
value String

The exportFormatId to set.

Returns
Type Description
ExportModelRequest.OutputConfig.Builder

This builder for chaining.

setExportFormatIdBytes(ByteString value)

public ExportModelRequest.OutputConfig.Builder setExportFormatIdBytes(ByteString value)

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.

string export_format_id = 1;

Parameter
Name Description
value ByteString

The bytes for exportFormatId to set.

Returns
Type Description
ExportModelRequest.OutputConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ExportModelRequest.OutputConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ExportModelRequest.OutputConfig.Builder
Overrides

setImageDestination(ContainerRegistryDestination value)

public ExportModelRequest.OutputConfig.Builder setImageDestination(ContainerRegistryDestination value)

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.

.google.cloud.aiplatform.v1.ContainerRegistryDestination image_destination = 4;

Parameter
Name Description
value ContainerRegistryDestination
Returns
Type Description
ExportModelRequest.OutputConfig.Builder

setImageDestination(ContainerRegistryDestination.Builder builderForValue)

public ExportModelRequest.OutputConfig.Builder setImageDestination(ContainerRegistryDestination.Builder builderForValue)

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.

.google.cloud.aiplatform.v1.ContainerRegistryDestination image_destination = 4;

Parameter
Name Description
builderForValue ContainerRegistryDestination.Builder
Returns
Type Description
ExportModelRequest.OutputConfig.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ExportModelRequest.OutputConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ExportModelRequest.OutputConfig.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ExportModelRequest.OutputConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ExportModelRequest.OutputConfig.Builder
Overrides