Class ExportModelRequest.OutputConfig (3.45.0)

public static final class ExportModelRequest.OutputConfig extends GeneratedMessageV3 implements ExportModelRequest.OutputConfigOrBuilder

Output configuration for the Model export.

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ExportModelRequest.OutputConfig

Static Fields

ARTIFACT_DESTINATION_FIELD_NUMBER

public static final int ARTIFACT_DESTINATION_FIELD_NUMBER
Field Value
Type Description
int

EXPORT_FORMAT_ID_FIELD_NUMBER

public static final int EXPORT_FORMAT_ID_FIELD_NUMBER
Field Value
Type Description
int

IMAGE_DESTINATION_FIELD_NUMBER

public static final int IMAGE_DESTINATION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ExportModelRequest.OutputConfig getDefaultInstance()
Returns
Type Description
ExportModelRequest.OutputConfig

getDescriptor()

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

newBuilder()

public static ExportModelRequest.OutputConfig.Builder newBuilder()
Returns
Type Description
ExportModelRequest.OutputConfig.Builder

newBuilder(ExportModelRequest.OutputConfig prototype)

public static ExportModelRequest.OutputConfig.Builder newBuilder(ExportModelRequest.OutputConfig prototype)
Parameter
Name Description
prototype ExportModelRequest.OutputConfig
Returns
Type Description
ExportModelRequest.OutputConfig.Builder

parseDelimitedFrom(InputStream input)

public static ExportModelRequest.OutputConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExportModelRequest.OutputConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExportModelRequest.OutputConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportModelRequest.OutputConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ExportModelRequest.OutputConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ExportModelRequest.OutputConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExportModelRequest.OutputConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportModelRequest.OutputConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExportModelRequest.OutputConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ExportModelRequest.OutputConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExportModelRequest.OutputConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportModelRequest.OutputConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExportModelRequest.OutputConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ExportModelRequest.OutputConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExportModelRequest.OutputConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportModelRequest.OutputConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ExportModelRequest.OutputConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExportModelRequest.OutputConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExportModelRequest.OutputConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportModelRequest.OutputConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ExportModelRequest.OutputConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ExportModelRequest.OutputConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExportModelRequest.OutputConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportModelRequest.OutputConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ExportModelRequest.OutputConfig> parser()
Returns
Type Description
Parser<OutputConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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.v1beta1.GcsDestination artifact_destination = 3;

Returns
Type Description
GcsDestination

The artifactDestination.

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.v1beta1.GcsDestination artifact_destination = 3;

Returns
Type Description
GcsDestinationOrBuilder

getDefaultInstanceForType()

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

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.v1beta1.ContainerRegistryDestination image_destination = 4;

Returns
Type Description
ContainerRegistryDestination

The imageDestination.

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.v1beta1.ContainerRegistryDestination image_destination = 4;

Returns
Type Description
ContainerRegistryDestinationOrBuilder

getParserForType()

public Parser<ExportModelRequest.OutputConfig> getParserForType()
Returns
Type Description
Parser<OutputConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.v1beta1.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.v1beta1.ContainerRegistryDestination image_destination = 4;

Returns
Type Description
boolean

Whether the imageDestination field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ExportModelRequest.OutputConfig.Builder newBuilderForType()
Returns
Type Description
ExportModelRequest.OutputConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExportModelRequest.OutputConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ExportModelRequest.OutputConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ExportModelRequest.OutputConfig.Builder toBuilder()
Returns
Type Description
ExportModelRequest.OutputConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException