Class ModelExportOutputConfig (2.9.0)

public final class ModelExportOutputConfig extends GeneratedMessageV3 implements ModelExportOutputConfigOrBuilder

Output configuration for ModelExport Action.

Protobuf type google.cloud.automl.v1.ModelExportOutputConfig

Static Fields

GCS_DESTINATION_FIELD_NUMBER

public static final int GCS_DESTINATION_FIELD_NUMBER
Field Value
TypeDescription
int

MODEL_FORMAT_FIELD_NUMBER

public static final int MODEL_FORMAT_FIELD_NUMBER
Field Value
TypeDescription
int

PARAMS_FIELD_NUMBER

public static final int PARAMS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ModelExportOutputConfig getDefaultInstance()
Returns
TypeDescription
ModelExportOutputConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ModelExportOutputConfig.Builder newBuilder()
Returns
TypeDescription
ModelExportOutputConfig.Builder

newBuilder(ModelExportOutputConfig prototype)

public static ModelExportOutputConfig.Builder newBuilder(ModelExportOutputConfig prototype)
Parameter
NameDescription
prototypeModelExportOutputConfig
Returns
TypeDescription
ModelExportOutputConfig.Builder

parseDelimitedFrom(InputStream input)

public static ModelExportOutputConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ModelExportOutputConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ModelExportOutputConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ModelExportOutputConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ModelExportOutputConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ModelExportOutputConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ModelExportOutputConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ModelExportOutputConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ModelExportOutputConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ModelExportOutputConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ModelExportOutputConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ModelExportOutputConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ModelExportOutputConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ModelExportOutputConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ModelExportOutputConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ModelExportOutputConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ModelExportOutputConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ModelExportOutputConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ModelExportOutputConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ModelExportOutputConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ModelExportOutputConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ModelExportOutputConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ModelExportOutputConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ModelExportOutputConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ModelExportOutputConfig> parser()
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public ModelExportOutputConfig getDefaultInstanceForType()
Returns
TypeDescription
ModelExportOutputConfig

getDestinationCase()

public ModelExportOutputConfig.DestinationCase getDestinationCase()
Returns
TypeDescription
ModelExportOutputConfig.DestinationCase

getGcsDestination()

public GcsDestination getGcsDestination()

Required. 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.v1.GcsDestination gcs_destination = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
GcsDestination

The gcsDestination.

getGcsDestinationOrBuilder()

public GcsDestinationOrBuilder getGcsDestinationOrBuilder()

Required. 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.v1.GcsDestination gcs_destination = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
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". 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
TypeDescription
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". 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
TypeDescription
ByteString

The bytes for modelFormat.

getParams()

public Map<String,String> getParams()

Use #getParamsMap() instead.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
String

getParserForType()

public Parser<ModelExportOutputConfig> getParserForType()
Returns
TypeDescription
Parser<ModelExportOutputConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasGcsDestination()

public boolean hasGcsDestination()

Required. 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.v1.GcsDestination gcs_destination = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the gcsDestination field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ModelExportOutputConfig.Builder newBuilderForType()
Returns
TypeDescription
ModelExportOutputConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ModelExportOutputConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ModelExportOutputConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ModelExportOutputConfig.Builder toBuilder()
Returns
TypeDescription
ModelExportOutputConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException