Class ModelExportOutputConfig (2.46.0) 

public final class ModelExportOutputConfig extends GeneratedMessageV3 implements ModelExportOutputConfigOrBuilder

Output configuration for ModelExport Action.

Protobuf type google.cloud.automl.v1beta1.ModelExportOutputConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ModelExportOutputConfig

Static Fields

GCR_DESTINATION_FIELD_NUMBER

public static final int GCR_DESTINATION_FIELD_NUMBER
Field Value
Type Description
int

GCS_DESTINATION_FIELD_NUMBER

public static final int GCS_DESTINATION_FIELD_NUMBER
Field Value
Type Description
int

MODEL_FORMAT_FIELD_NUMBER

public static final int MODEL_FORMAT_FIELD_NUMBER
Field Value
Type Description
int

PARAMS_FIELD_NUMBER

public static final int PARAMS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ModelExportOutputConfig getDefaultInstance()
Returns
Type Description
ModelExportOutputConfig

getDescriptor()

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

newBuilder()

public static ModelExportOutputConfig.Builder newBuilder()
Returns
Type Description
ModelExportOutputConfig.Builder

newBuilder(ModelExportOutputConfig prototype)

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

parseDelimitedFrom(InputStream input)

public static ModelExportOutputConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ModelExportOutputConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static ModelExportOutputConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ModelExportOutputConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static ModelExportOutputConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ModelExportOutputConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static ModelExportOutputConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ModelExportOutputConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static ModelExportOutputConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ModelExportOutputConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<ModelExportOutputConfig> parser()
Returns
Type Description
Parser<ModelExportOutputConfig>

Methods

containsParams(String key)

public boolean containsParams(String key)

Additional model-type and format specific parameters describing the requirements for the to be exported model files, any string must be up to 25000 characters long.

  • For docker format: cpu_architecture - (string) "x86_64" (default). gpu_architecture - (string) "none" (default), "nvidia".

map<string, string> params = 2;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ModelExportOutputConfig getDefaultInstanceForType()
Returns
Type Description
ModelExportOutputConfig

getDestinationCase()

public ModelExportOutputConfig.DestinationCase getDestinationCase()
Returns
Type Description
ModelExportOutputConfig.DestinationCase

getGcrDestination()

public GcrDestination getGcrDestination()

The GCR location where model image is to be pushed to. This location may only be set for the following model formats: "docker".

The model image will be created under the given URI.

.google.cloud.automl.v1beta1.GcrDestination gcr_destination = 3;

Returns
Type Description
GcrDestination

The gcrDestination.

getGcrDestinationOrBuilder()

public GcrDestinationOrBuilder getGcrDestinationOrBuilder()

The GCR location where model image is to be pushed to. This location may only be set for the following model formats: "docker".

The model image will be created under the given URI.

.google.cloud.automl.v1beta1.GcrDestination gcr_destination = 3;

Returns
Type Description
GcrDestinationOrBuilder

getGcsDestination()

public GcsDestination getGcsDestination()

The Google Cloud Storage location where the model is to be written to. This location may only be set for the following model formats: "tflite", "edgetpu_tflite", "tf_saved_model", "tf_js", "core_ml".

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.

.google.cloud.automl.v1beta1.GcsDestination gcs_destination = 1;

Returns
Type Description
GcsDestination

The gcsDestination.

getGcsDestinationOrBuilder()

public GcsDestinationOrBuilder getGcsDestinationOrBuilder()

The Google Cloud Storage location where the model is to be written to. This location may only be set for the following model formats: "tflite", "edgetpu_tflite", "tf_saved_model", "tf_js", "core_ml".

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.

.google.cloud.automl.v1beta1.GcsDestination gcs_destination = 1;

Returns
Type Description
GcsDestinationOrBuilder

getModelFormat()

public String getModelFormat()

The format in which the model must be exported. The available, and default, formats depend on the problem and model type (if given problem and type combination doesn't have a format listed, it means its models are not exportable):

  • For Image Classification mobile-low-latency-1, mobile-versatile-1, mobile-high-accuracy-1: "tflite" (default), "edgetpu_tflite", "tf_saved_model", "tf_js", "docker".

  • For Image Classification mobile-core-ml-low-latency-1, mobile-core-ml-versatile-1, mobile-core-ml-high-accuracy-1: "core_ml" (default).

  • For Image Object Detection mobile-low-latency-1, mobile-versatile-1, mobile-high-accuracy-1: "tflite", "tf_saved_model", "tf_js".

  • For Video Classification cloud, "tf_saved_model".

  • For Video Object Tracking cloud, "tf_saved_model".

  • For Video Object Tracking mobile-versatile-1: "tflite", "edgetpu_tflite", "tf_saved_model", "docker".

  • For Video Object Tracking mobile-coral-versatile-1: "tflite", "edgetpu_tflite", "docker".

  • For Video Object Tracking mobile-coral-low-latency-1: "tflite", "edgetpu_tflite", "docker".

  • For Video Object Tracking mobile-jetson-versatile-1: "tf_saved_model", "docker".

  • For Tables: "docker".

    Formats description:

  • tflite - Used for Android mobile devices.

  • edgetpu_tflite - Used for Edge TPU devices.
  • tf_saved_model - A tensorflow model in SavedModel format.
  • tf_js - A TensorFlow.js model that can be used in the browser and in Node.js using JavaScript.

  • docker - Used for Docker containers. Use the params field to customize the container. The container is verified to work correctly on ubuntu 16.04 operating system. See more at containers

    quickstart

  • core_ml - Used for iOS mobile devices.

string model_format = 4;

Returns
Type Description
String

The modelFormat.

getModelFormatBytes()

public ByteString getModelFormatBytes()

The format in which the model must be exported. The available, and default, formats depend on the problem and model type (if given problem and type combination doesn't have a format listed, it means its models are not exportable):

  • For Image Classification mobile-low-latency-1, mobile-versatile-1, mobile-high-accuracy-1: "tflite" (default), "edgetpu_tflite", "tf_saved_model", "tf_js", "docker".

  • For Image Classification mobile-core-ml-low-latency-1, mobile-core-ml-versatile-1, mobile-core-ml-high-accuracy-1: "core_ml" (default).

  • For Image Object Detection mobile-low-latency-1, mobile-versatile-1, mobile-high-accuracy-1: "tflite", "tf_saved_model", "tf_js".

  • For Video Classification cloud, "tf_saved_model".

  • For Video Object Tracking cloud, "tf_saved_model".

  • For Video Object Tracking mobile-versatile-1: "tflite", "edgetpu_tflite", "tf_saved_model", "docker".

  • For Video Object Tracking mobile-coral-versatile-1: "tflite", "edgetpu_tflite", "docker".

  • For Video Object Tracking mobile-coral-low-latency-1: "tflite", "edgetpu_tflite", "docker".

  • For Video Object Tracking mobile-jetson-versatile-1: "tf_saved_model", "docker".

  • For Tables: "docker".

    Formats description:

  • tflite - Used for Android mobile devices.

  • edgetpu_tflite - Used for Edge TPU devices.
  • tf_saved_model - A tensorflow model in SavedModel format.
  • tf_js - A TensorFlow.js model that can be used in the browser and in Node.js using JavaScript.

  • docker - Used for Docker containers. Use the params field to customize the container. The container is verified to work correctly on ubuntu 16.04 operating system. See more at containers

    quickstart

  • core_ml - Used for iOS mobile devices.

string model_format = 4;

Returns
Type Description
ByteString

The bytes for modelFormat.

getParams() (deprecated)

public Map<String,String> getParams()

Use #getParamsMap() instead.

Returns
Type Description
Map<String,String>

getParamsCount()

public int getParamsCount()

Additional model-type and format specific parameters describing the requirements for the to be exported model files, any string must be up to 25000 characters long.

  • For docker format: cpu_architecture - (string) "x86_64" (default). gpu_architecture - (string) "none" (default), "nvidia".

map<string, string> params = 2;

Returns
Type Description
int

getParamsMap()

public Map<String,String> getParamsMap()

Additional model-type and format specific parameters describing the requirements for the to be exported model files, any string must be up to 25000 characters long.

  • For docker format: cpu_architecture - (string) "x86_64" (default). gpu_architecture - (string) "none" (default), "nvidia".

map<string, string> params = 2;

Returns
Type Description
Map<String,String>

getParamsOrDefault(String key, String defaultValue)

public String getParamsOrDefault(String key, String defaultValue)

Additional model-type and format specific parameters describing the requirements for the to be exported model files, any string must be up to 25000 characters long.

  • For docker format: cpu_architecture - (string) "x86_64" (default). gpu_architecture - (string) "none" (default), "nvidia".

map<string, string> params = 2;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getParamsOrThrow(String key)

public String getParamsOrThrow(String key)

Additional model-type and format specific parameters describing the requirements for the to be exported model files, any string must be up to 25000 characters long.

  • For docker format: cpu_architecture - (string) "x86_64" (default). gpu_architecture - (string) "none" (default), "nvidia".

map<string, string> params = 2;

Parameter
Name Description
key String
Returns
Type Description
String

getParserForType()

public Parser<ModelExportOutputConfig> getParserForType()
Returns
Type Description
Parser<ModelExportOutputConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasGcrDestination()

public boolean hasGcrDestination()

The GCR location where model image is to be pushed to. This location may only be set for the following model formats: "docker".

The model image will be created under the given URI.

.google.cloud.automl.v1beta1.GcrDestination gcr_destination = 3;

Returns
Type Description
boolean

Whether the gcrDestination field is set.

hasGcsDestination()

public boolean hasGcsDestination()

The Google Cloud Storage location where the model is to be written to. This location may only be set for the following model formats: "tflite", "edgetpu_tflite", "tf_saved_model", "tf_js", "core_ml".

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.

.google.cloud.automl.v1beta1.GcsDestination gcs_destination = 1;

Returns
Type Description
boolean

Whether the gcsDestination field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ModelExportOutputConfig.Builder newBuilderForType()
Returns
Type Description
ModelExportOutputConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public ModelExportOutputConfig.Builder toBuilder()
Returns
Type Description
ModelExportOutputConfig.Builder

writeTo(CodedOutputStream output)

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